eventespresso / event-espresso-core

core/CPTs/EE_CPT_Strategy.core.php

Indentation +343 added lines, -343 removed lines

@@ -16,347 +16,347 @@
  */
 class EE_CPT_Strategy extends EE_Base
 {
-    private static ?EE_CPT_Strategy $_instance = null;
-
-    protected ?EEM_CPT_Base $CPT_model = null;
-
-    /**
-     * @var CptQueryModifier[]
-     */
-    protected array $query_modifier = [];
-
-    /**
-     * the current page, if it utilizes CPTs
-     */
-    protected array $CPT = [];
-
-    /**
-     * return value from CustomPostTypeDefinitions::getDefinitions()
-     */
-    protected array $_CPTs = [];
-
-    protected array $_CPT_taxonomies = [];
-
-    protected array $_CPT_terms = [];
-
-    protected array $_CPT_endpoints = [];
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CustomPostTypeDefinitions|null $custom_post_types
-     * @param CustomTaxonomyDefinitions|null $taxonomies
-     * @return EE_CPT_Strategy
-     */
-    public static function instance(
-        CustomPostTypeDefinitions $custom_post_types = null,
-        CustomTaxonomyDefinitions $taxonomies = null
-    ): EE_CPT_Strategy {
-        // check if class object is instantiated
-        if (
-            ! self::$_instance instanceof EE_CPT_Strategy
-            && $custom_post_types instanceof CustomPostTypeDefinitions
-            && $taxonomies instanceof CustomTaxonomyDefinitions
-        ) {
-            self::$_instance = new self($custom_post_types, $taxonomies);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param CustomPostTypeDefinitions $custom_post_types
-     * @param CustomTaxonomyDefinitions $taxonomies
-     */
-    protected function __construct(
-        CustomPostTypeDefinitions $custom_post_types,
-        CustomTaxonomyDefinitions $taxonomies
-    ) {
-        // get CPT data
-        $this->_CPTs           = $custom_post_types->getDefinitions();
-        $this->_CPT_endpoints  = $this->_set_CPT_endpoints();
-        $this->_CPT_taxonomies = $taxonomies->getCustomTaxonomyDefinitions();
-        add_action('pre_get_posts', [$this, 'pre_get_posts'], 5);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_CPT_endpoints(): array
-    {
-        return $this->_CPT_endpoints;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_CPT_taxonomies(): array
-    {
-        return $this->_CPT_taxonomies;
-    }
-
-
-    /**
-     * add CPT "slugs" to array of default espresso "pages"
-     *
-     * @return array
-     */
-    private function _set_CPT_endpoints(): array
-    {
-        $_CPT_endpoints = [];
-        foreach ($this->_CPTs as $CPT_type => $CPT) {
-            if (isset($CPT['plural_slug'])) {
-                $_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
-            }
-        }
-        return $_CPT_endpoints;
-    }
-
-
-    public function wpQueryPostType(?WP_Query $wp_query): string
-    {
-        if (! $wp_query instanceof WP_Query) {
-            return '';
-        }
-        // cuz WP_Query is a mess and doesn't always have the post_type set in the same place
-        $post_type = $wp_query->query->post_type ?? '';
-        $post_type = $wp_query->query['post_type'] ?? $post_type;
-        $post_type = $wp_query->query_vars['post_type'] ?? $post_type;
-        return is_array($post_type) ? (string) reset($post_type) : (string) $post_type;
-    }
-
-
-    public function isEspressoPostType(WP_Query $wp_query): bool
-    {
-        $post_type = $this->wpQueryPostType($wp_query);
-        return isset($this->_CPTs[ $post_type ]);
-    }
-
-
-    /**
-     * If this query (not just "main" queries (ie, for WP's infamous "loop")) is for an EE CPT, then we want to
-     * supercharge the get_posts query to add our EE stuff (like joining to our tables, selecting extra columns, and
-     * adding EE objects to the post to facilitate further querying of related data etc)
-     *
-     * @param WP_Query $wp_query
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pre_get_posts(WP_Query $wp_query)
-    {
-        // add our conditionals
-        $this->_set_EE_tags_on_WP_Query($wp_query);
-        // check for terms
-        $this->_set_post_type_for_terms($wp_query);
-        // make sure paging is always set
-        $this->_set_paging($wp_query);
-        // is a taxonomy set ?
-        $this->_set_CPT_taxonomies_on_WP_Query($wp_query);
-        // loop thru post_types if set
-        $this->_process_WP_Query_post_types($wp_query);
-    }
-
-
-    /**
-     * @param WP_Query $wp_query
-     * @return void
-     */
-    private function _set_EE_tags_on_WP_Query(WP_Query $wp_query)
-    {
-        $wp_query->is_espresso_event_single   = false;
-        $wp_query->is_espresso_event_archive  = false;
-        $wp_query->is_espresso_event_taxonomy = false;
-        $wp_query->is_espresso_venue_single   = false;
-        $wp_query->is_espresso_venue_archive  = false;
-        $wp_query->is_espresso_venue_taxonomy = false;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_CPT_terms()
-    {
-        if (empty($this->_CPT_terms)) {
-            $terms = EEM_Term::instance()->get_all_CPT_post_tags();
-            foreach ($terms as $term) {
-                if ($term instanceof EE_Term) {
-                    $this->_CPT_terms[ $term->slug() ] = $term;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param WP_Query $wp_query
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_post_type_for_terms(WP_Query $wp_query)
-    {
-        // is a tag set ?
-        if (! isset($wp_query->query['tag'])) {
-            return;
-        }
-        // get term for tag
-        $term = EEM_Term::instance()->get_post_tag_for_event_or_venue($wp_query->query['tag']);
-        // verify the term
-        if (! $term instanceof EE_Term) {
-            return;
-        }
-        // set post_type from term
-        $term->post_type = (array) apply_filters(
-            'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
-            array_merge(['post', 'page'], $term->post_type),
-            $term
-        );
-        // if a post type is already set
-        if (isset($wp_query->query_vars['post_type'])) {
-            // add to existing array
-            $term->post_type = array_merge((array) $wp_query->query_vars['post_type'], $term->post_type);
-        }
-        // just set post_type to our CPT
-        $wp_query->set('post_type', array_unique($term->post_type));
-    }
-
-
-    /**
-     * @param WP_Query $wp_query
-     * @return void
-     */
-    public function _set_paging(WP_Query $wp_query)
-    {
-        if ($wp_query->is_main_query() && apply_filters('FHEE__EE_CPT_Strategy___set_paging', true)) {
-            $page  = get_query_var('page') ? get_query_var('page') : null;
-            $paged = get_query_var('paged') ? get_query_var('paged') : $page;
-            $wp_query->set('paged', $paged);
-        }
-    }
-
-
-    /**
-     * @param WP_Query $wp_query
-     */
-    protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $wp_query)
-    {
-        // is a taxonomy set ?
-        if (! $wp_query->is_tax) {
-            return;
-        }
-        // loop thru our taxonomies
-        foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
-            // check if one of our taxonomies is set as a query var
-            if (! isset($wp_query->query[ $CPT_taxonomy ])) {
-                continue;
-            }
-            // but which CPT does that correspond to??? hmmm... guess we gotta go looping
-            foreach ($this->_CPTs as $post_type => $CPT) {
-                // verify our CPT has args, is public and has taxonomies set
-                if (
-                    ! isset($CPT['args']['public'])
-                    || ! $CPT['args']['public']
-                    || empty($CPT['args']['taxonomies'])
-                    || ! in_array($CPT_taxonomy, $CPT['args']['taxonomies'], true)
-                ) {
-                    continue;
-                }
-                // if so, then add this CPT post_type to the current query's array of post_types'
-                $wp_query->query_vars['post_type']   = isset($wp_query->query_vars['post_type'])
-                    ? (array) $wp_query->query_vars['post_type']
-                    : [];
-                $wp_query->query_vars['post_type'][] = $post_type;
-                switch ($post_type) {
-                    case EspressoPostType::EVENTS:
-                        $wp_query->is_espresso_event_taxonomy = true;
-                        break;
-
-                    case EspressoPostType::VENUES:
-                        $wp_query->is_espresso_venue_taxonomy = true;
-                        break;
-
-                    default:
-                        do_action(
-                            'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
-                            $wp_query,
-                            $this
-                        );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param WP_Query $wp_query
-     */
-    protected function _process_WP_Query_post_types(WP_Query $wp_query)
-    {
-        if (! isset($wp_query->query_vars['post_type'])) {
-            return;
-        }
-        // loop thru post_types as array
-        foreach ((array) $wp_query->query_vars['post_type'] as $post_type) {
-            // is current query for an EE CPT ?
-            if (! isset($this->_CPTs[ $post_type ])) {
-                continue;
-            }
-            // is EE on or off ?
-            if (MaintenanceStatus::isNotDisabled()) {
-                // reroute CPT template view to maintenance_mode.template.php
-                if (! has_filter('template_include', ['EE_Maintenance_Mode', 'template_include'])) {
-                    add_filter('template_include', ['EE_Maintenance_Mode', 'template_include'], 99999);
-                }
-                if (has_filter('the_content', [EE_Maintenance_Mode::instance(), 'the_content'])) {
-                    add_filter('the_content', [$this, 'inject_EE_shortcode_placeholder'], 1);
-                }
-                return;
-            }
-            $this->_generate_CptQueryModifier($wp_query, $post_type);
-        }
-    }
-
-
-    /**
-     * @param WP_Query $wp_query
-     * @param string   $post_type
-     */
-    protected function _generate_CptQueryModifier(WP_Query $wp_query, string $post_type)
-    {
-        if (
-            isset($this->query_modifier[ $post_type ])
-            && $this->query_modifier[ $post_type ] instanceof CptQueryModifier
-        ) {
-            return;
-        }
-        $this->query_modifier[ $post_type ] = LoaderFactory::getLoader()->getShared(
-            CptQueryModifier::class,
-            [
-                $post_type,
-                $this->_CPTs[ $post_type ],
-                $wp_query,
-            ]
-        );
-        $this->_CPT_taxonomies              = $this->query_modifier[ $post_type ]->taxonomies();
-    }
-
-
-    /**
-     * inject_EE_shortcode_placeholder
-     * in order to display the M-Mode notice on our CPT routes,
-     * we need to first inject what looks like one of our shortcodes,
-     * so that it can be replaced with the actual M-Mode notice
-     *
-     * @return string
-     */
-    public function inject_EE_shortcode_placeholder(): string
-    {
-        return '[ESPRESSO_';
-    }
+	private static ?EE_CPT_Strategy $_instance = null;
+
+	protected ?EEM_CPT_Base $CPT_model = null;
+
+	/**
+	 * @var CptQueryModifier[]
+	 */
+	protected array $query_modifier = [];
+
+	/**
+	 * the current page, if it utilizes CPTs
+	 */
+	protected array $CPT = [];
+
+	/**
+	 * return value from CustomPostTypeDefinitions::getDefinitions()
+	 */
+	protected array $_CPTs = [];
+
+	protected array $_CPT_taxonomies = [];
+
+	protected array $_CPT_terms = [];
+
+	protected array $_CPT_endpoints = [];
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CustomPostTypeDefinitions|null $custom_post_types
+	 * @param CustomTaxonomyDefinitions|null $taxonomies
+	 * @return EE_CPT_Strategy
+	 */
+	public static function instance(
+		CustomPostTypeDefinitions $custom_post_types = null,
+		CustomTaxonomyDefinitions $taxonomies = null
+	): EE_CPT_Strategy {
+		// check if class object is instantiated
+		if (
+			! self::$_instance instanceof EE_CPT_Strategy
+			&& $custom_post_types instanceof CustomPostTypeDefinitions
+			&& $taxonomies instanceof CustomTaxonomyDefinitions
+		) {
+			self::$_instance = new self($custom_post_types, $taxonomies);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param CustomPostTypeDefinitions $custom_post_types
+	 * @param CustomTaxonomyDefinitions $taxonomies
+	 */
+	protected function __construct(
+		CustomPostTypeDefinitions $custom_post_types,
+		CustomTaxonomyDefinitions $taxonomies
+	) {
+		// get CPT data
+		$this->_CPTs           = $custom_post_types->getDefinitions();
+		$this->_CPT_endpoints  = $this->_set_CPT_endpoints();
+		$this->_CPT_taxonomies = $taxonomies->getCustomTaxonomyDefinitions();
+		add_action('pre_get_posts', [$this, 'pre_get_posts'], 5);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_CPT_endpoints(): array
+	{
+		return $this->_CPT_endpoints;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_CPT_taxonomies(): array
+	{
+		return $this->_CPT_taxonomies;
+	}
+
+
+	/**
+	 * add CPT "slugs" to array of default espresso "pages"
+	 *
+	 * @return array
+	 */
+	private function _set_CPT_endpoints(): array
+	{
+		$_CPT_endpoints = [];
+		foreach ($this->_CPTs as $CPT_type => $CPT) {
+			if (isset($CPT['plural_slug'])) {
+				$_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
+			}
+		}
+		return $_CPT_endpoints;
+	}
+
+
+	public function wpQueryPostType(?WP_Query $wp_query): string
+	{
+		if (! $wp_query instanceof WP_Query) {
+			return '';
+		}
+		// cuz WP_Query is a mess and doesn't always have the post_type set in the same place
+		$post_type = $wp_query->query->post_type ?? '';
+		$post_type = $wp_query->query['post_type'] ?? $post_type;
+		$post_type = $wp_query->query_vars['post_type'] ?? $post_type;
+		return is_array($post_type) ? (string) reset($post_type) : (string) $post_type;
+	}
+
+
+	public function isEspressoPostType(WP_Query $wp_query): bool
+	{
+		$post_type = $this->wpQueryPostType($wp_query);
+		return isset($this->_CPTs[ $post_type ]);
+	}
+
+
+	/**
+	 * If this query (not just "main" queries (ie, for WP's infamous "loop")) is for an EE CPT, then we want to
+	 * supercharge the get_posts query to add our EE stuff (like joining to our tables, selecting extra columns, and
+	 * adding EE objects to the post to facilitate further querying of related data etc)
+	 *
+	 * @param WP_Query $wp_query
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pre_get_posts(WP_Query $wp_query)
+	{
+		// add our conditionals
+		$this->_set_EE_tags_on_WP_Query($wp_query);
+		// check for terms
+		$this->_set_post_type_for_terms($wp_query);
+		// make sure paging is always set
+		$this->_set_paging($wp_query);
+		// is a taxonomy set ?
+		$this->_set_CPT_taxonomies_on_WP_Query($wp_query);
+		// loop thru post_types if set
+		$this->_process_WP_Query_post_types($wp_query);
+	}
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 * @return void
+	 */
+	private function _set_EE_tags_on_WP_Query(WP_Query $wp_query)
+	{
+		$wp_query->is_espresso_event_single   = false;
+		$wp_query->is_espresso_event_archive  = false;
+		$wp_query->is_espresso_event_taxonomy = false;
+		$wp_query->is_espresso_venue_single   = false;
+		$wp_query->is_espresso_venue_archive  = false;
+		$wp_query->is_espresso_venue_taxonomy = false;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_CPT_terms()
+	{
+		if (empty($this->_CPT_terms)) {
+			$terms = EEM_Term::instance()->get_all_CPT_post_tags();
+			foreach ($terms as $term) {
+				if ($term instanceof EE_Term) {
+					$this->_CPT_terms[ $term->slug() ] = $term;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_post_type_for_terms(WP_Query $wp_query)
+	{
+		// is a tag set ?
+		if (! isset($wp_query->query['tag'])) {
+			return;
+		}
+		// get term for tag
+		$term = EEM_Term::instance()->get_post_tag_for_event_or_venue($wp_query->query['tag']);
+		// verify the term
+		if (! $term instanceof EE_Term) {
+			return;
+		}
+		// set post_type from term
+		$term->post_type = (array) apply_filters(
+			'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
+			array_merge(['post', 'page'], $term->post_type),
+			$term
+		);
+		// if a post type is already set
+		if (isset($wp_query->query_vars['post_type'])) {
+			// add to existing array
+			$term->post_type = array_merge((array) $wp_query->query_vars['post_type'], $term->post_type);
+		}
+		// just set post_type to our CPT
+		$wp_query->set('post_type', array_unique($term->post_type));
+	}
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 * @return void
+	 */
+	public function _set_paging(WP_Query $wp_query)
+	{
+		if ($wp_query->is_main_query() && apply_filters('FHEE__EE_CPT_Strategy___set_paging', true)) {
+			$page  = get_query_var('page') ? get_query_var('page') : null;
+			$paged = get_query_var('paged') ? get_query_var('paged') : $page;
+			$wp_query->set('paged', $paged);
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 */
+	protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $wp_query)
+	{
+		// is a taxonomy set ?
+		if (! $wp_query->is_tax) {
+			return;
+		}
+		// loop thru our taxonomies
+		foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
+			// check if one of our taxonomies is set as a query var
+			if (! isset($wp_query->query[ $CPT_taxonomy ])) {
+				continue;
+			}
+			// but which CPT does that correspond to??? hmmm... guess we gotta go looping
+			foreach ($this->_CPTs as $post_type => $CPT) {
+				// verify our CPT has args, is public and has taxonomies set
+				if (
+					! isset($CPT['args']['public'])
+					|| ! $CPT['args']['public']
+					|| empty($CPT['args']['taxonomies'])
+					|| ! in_array($CPT_taxonomy, $CPT['args']['taxonomies'], true)
+				) {
+					continue;
+				}
+				// if so, then add this CPT post_type to the current query's array of post_types'
+				$wp_query->query_vars['post_type']   = isset($wp_query->query_vars['post_type'])
+					? (array) $wp_query->query_vars['post_type']
+					: [];
+				$wp_query->query_vars['post_type'][] = $post_type;
+				switch ($post_type) {
+					case EspressoPostType::EVENTS:
+						$wp_query->is_espresso_event_taxonomy = true;
+						break;
+
+					case EspressoPostType::VENUES:
+						$wp_query->is_espresso_venue_taxonomy = true;
+						break;
+
+					default:
+						do_action(
+							'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
+							$wp_query,
+							$this
+						);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 */
+	protected function _process_WP_Query_post_types(WP_Query $wp_query)
+	{
+		if (! isset($wp_query->query_vars['post_type'])) {
+			return;
+		}
+		// loop thru post_types as array
+		foreach ((array) $wp_query->query_vars['post_type'] as $post_type) {
+			// is current query for an EE CPT ?
+			if (! isset($this->_CPTs[ $post_type ])) {
+				continue;
+			}
+			// is EE on or off ?
+			if (MaintenanceStatus::isNotDisabled()) {
+				// reroute CPT template view to maintenance_mode.template.php
+				if (! has_filter('template_include', ['EE_Maintenance_Mode', 'template_include'])) {
+					add_filter('template_include', ['EE_Maintenance_Mode', 'template_include'], 99999);
+				}
+				if (has_filter('the_content', [EE_Maintenance_Mode::instance(), 'the_content'])) {
+					add_filter('the_content', [$this, 'inject_EE_shortcode_placeholder'], 1);
+				}
+				return;
+			}
+			$this->_generate_CptQueryModifier($wp_query, $post_type);
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 * @param string   $post_type
+	 */
+	protected function _generate_CptQueryModifier(WP_Query $wp_query, string $post_type)
+	{
+		if (
+			isset($this->query_modifier[ $post_type ])
+			&& $this->query_modifier[ $post_type ] instanceof CptQueryModifier
+		) {
+			return;
+		}
+		$this->query_modifier[ $post_type ] = LoaderFactory::getLoader()->getShared(
+			CptQueryModifier::class,
+			[
+				$post_type,
+				$this->_CPTs[ $post_type ],
+				$wp_query,
+			]
+		);
+		$this->_CPT_taxonomies              = $this->query_modifier[ $post_type ]->taxonomies();
+	}
+
+
+	/**
+	 * inject_EE_shortcode_placeholder
+	 * in order to display the M-Mode notice on our CPT routes,
+	 * we need to first inject what looks like one of our shortcodes,
+	 * so that it can be replaced with the actual M-Mode notice
+	 *
+	 * @return string
+	 */
+	public function inject_EE_shortcode_placeholder(): string
+	{
+		return '[ESPRESSO_';
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -108,7 +108,7 @@ 
         $_CPT_endpoints = [];
         foreach ($this->_CPTs as $CPT_type => $CPT) {
             if (isset($CPT['plural_slug'])) {
-                $_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
+                $_CPT_endpoints [(string) $CPT['plural_slug']] = $CPT_type;
             }
         }
         return $_CPT_endpoints;
@@ -117,7 +117,7 @@ 
 
     public function wpQueryPostType(?WP_Query $wp_query): string
     {
-        if (! $wp_query instanceof WP_Query) {
+        if ( ! $wp_query instanceof WP_Query) {
             return '';
         }
         // cuz WP_Query is a mess and doesn't always have the post_type set in the same place
@@ -131,7 +131,7 @@ 
     public function isEspressoPostType(WP_Query $wp_query): bool
     {
         $post_type = $this->wpQueryPostType($wp_query);
-        return isset($this->_CPTs[ $post_type ]);
+        return isset($this->_CPTs[$post_type]);
     }
 
 
@@ -186,7 +186,7 @@ 
             $terms = EEM_Term::instance()->get_all_CPT_post_tags();
             foreach ($terms as $term) {
                 if ($term instanceof EE_Term) {
-                    $this->_CPT_terms[ $term->slug() ] = $term;
+                    $this->_CPT_terms[$term->slug()] = $term;
                 }
             }
         }
@@ -202,13 +202,13 @@ 
     private function _set_post_type_for_terms(WP_Query $wp_query)
     {
         // is a tag set ?
-        if (! isset($wp_query->query['tag'])) {
+        if ( ! isset($wp_query->query['tag'])) {
             return;
         }
         // get term for tag
         $term = EEM_Term::instance()->get_post_tag_for_event_or_venue($wp_query->query['tag']);
         // verify the term
-        if (! $term instanceof EE_Term) {
+        if ( ! $term instanceof EE_Term) {
             return;
         }
         // set post_type from term
@@ -247,13 +247,13 @@ 
     protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $wp_query)
     {
         // is a taxonomy set ?
-        if (! $wp_query->is_tax) {
+        if ( ! $wp_query->is_tax) {
             return;
         }
         // loop thru our taxonomies
         foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
             // check if one of our taxonomies is set as a query var
-            if (! isset($wp_query->query[ $CPT_taxonomy ])) {
+            if ( ! isset($wp_query->query[$CPT_taxonomy])) {
                 continue;
             }
             // but which CPT does that correspond to??? hmmm... guess we gotta go looping
@@ -283,7 +283,7 @@ 
 
                     default:
                         do_action(
-                            'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
+                            'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_'.$post_type.'_post_type',
                             $wp_query,
                             $this
                         );
@@ -298,19 +298,19 @@ 
      */
     protected function _process_WP_Query_post_types(WP_Query $wp_query)
     {
-        if (! isset($wp_query->query_vars['post_type'])) {
+        if ( ! isset($wp_query->query_vars['post_type'])) {
             return;
         }
         // loop thru post_types as array
         foreach ((array) $wp_query->query_vars['post_type'] as $post_type) {
             // is current query for an EE CPT ?
-            if (! isset($this->_CPTs[ $post_type ])) {
+            if ( ! isset($this->_CPTs[$post_type])) {
                 continue;
             }
             // is EE on or off ?
             if (MaintenanceStatus::isNotDisabled()) {
                 // reroute CPT template view to maintenance_mode.template.php
-                if (! has_filter('template_include', ['EE_Maintenance_Mode', 'template_include'])) {
+                if ( ! has_filter('template_include', ['EE_Maintenance_Mode', 'template_include'])) {
                     add_filter('template_include', ['EE_Maintenance_Mode', 'template_include'], 99999);
                 }
                 if (has_filter('the_content', [EE_Maintenance_Mode::instance(), 'the_content'])) {
@@ -330,20 +330,20 @@ 
     protected function _generate_CptQueryModifier(WP_Query $wp_query, string $post_type)
     {
         if (
-            isset($this->query_modifier[ $post_type ])
-            && $this->query_modifier[ $post_type ] instanceof CptQueryModifier
+            isset($this->query_modifier[$post_type])
+            && $this->query_modifier[$post_type] instanceof CptQueryModifier
         ) {
             return;
         }
-        $this->query_modifier[ $post_type ] = LoaderFactory::getLoader()->getShared(
+        $this->query_modifier[$post_type] = LoaderFactory::getLoader()->getShared(
             CptQueryModifier::class,
             [
                 $post_type,
-                $this->_CPTs[ $post_type ],
+                $this->_CPTs[$post_type],
                 $wp_query,
             ]
         );
-        $this->_CPT_taxonomies              = $this->query_modifier[ $post_type ]->taxonomies();
+        $this->_CPT_taxonomies = $this->query_modifier[$post_type]->taxonomies();
     }
 
 

core/EE_Cron_Tasks.core.php

Indentation +581 added lines, -581 removed lines

@@ -15,588 +15,588 @@
  */
 class EE_Cron_Tasks extends EE_Base
 {
-    /**
-     * WordPress doesn't allow duplicate crons within 10 minutes of the original,
-     * so we'll set our retry time for just over 10 minutes to avoid that
-     */
-    const reschedule_timeout = 605;
-
-
-    private static ?EE_Cron_Tasks $_instance = null;
-
-
-    public static function instance(): ?EE_Cron_Tasks
-    {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function __construct()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // verify that WP Cron is enabled
-        if (
-            defined('DISABLE_WP_CRON')
-            && DISABLE_WP_CRON
-            && is_admin()
-            && ! get_option('ee_disabled_wp_cron_check')
-        ) {
-            /**
-             * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
-             * config is loaded.
-             * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
-             * wanting to not have this functionality can just register its own action at a priority after this one to
-             * reverse any changes.
-             */
-            add_action(
-                'AHEE__EE_System__load_core_configuration__complete',
-                function () {
-                    EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
-                    EE_Registry::instance()->NET_CFG->update_config(true, false);
-                    add_option('ee_disabled_wp_cron_check', 1, '', false);
-                }
-            );
-        }
-        // UPDATE TRANSACTION WITH PAYMENT
-        add_action(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-            array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
-            10,
-            2
-        );
-        // ABANDONED / EXPIRED TRANSACTION CHECK
-        add_action(
-            'AHEE__EE_Cron_Tasks__expired_transaction_check',
-            array('EE_Cron_Tasks', 'expired_transaction_check')
-        );
-        // CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
-        add_action(
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-            array('EE_Cron_Tasks', 'clean_out_junk_transactions')
-        );
-        // logging
-        add_action(
-            'AHEE__EE_System__load_core_configuration__complete',
-            array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
-        );
-        EE_Registry::instance()->load_lib('Messages_Scheduler');
-        // clean out old gateway logs
-        add_action(
-            'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
-            array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
-        );
-    }
-
-    public static function log_scheduled_ee_crons(): void
-    {
-        $ee_crons = array(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-        );
-        $crons = (array) get_option('cron');
-        foreach ($crons as $cron) {
-            /** @var array[] $cron */
-            foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
-                    do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[ $ee_cron ] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
-                            do_action(
-                                'AHEE_log',
-                                __CLASS__,
-                                __FUNCTION__,
-                                print_r($ee_cron_details['args'], true),
-                                "$ee_cron args"
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * reschedule_cron_for_transactions_if_maintenance_mode
-     * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
-     *
-     * @param string $cron_task
-     * @param array  $TXN_IDs
-     * @return bool
-     * @throws DomainException
-     */
-    public static function reschedule_cron_for_transactions_if_maintenance_mode(string $cron_task, array $TXN_IDs): bool
-    {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
-                    $cron_task
-                )
-            );
-        }
-        // reschedule the cron if we can't hit the db right now
-        if (DbStatus::isOffline()) {
-            foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
-                // ensure $additional_vars is an array
-                $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
-                // reset cron job for the TXN
-                call_user_func_array(
-                    array('EE_Cron_Tasks', $cron_task),
-                    array_merge(
-                        array(
-                            time() + (10 * MINUTE_IN_SECONDS),
-                            $TXN_ID,
-                        ),
-                        $additional_vars
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-
-    /****************  UPDATE TRANSACTION WITH PAYMENT ****************/
-
-
-    /**
-     * array of TXN IDs and the payment
-     *
-     * @var array
-     */
-    protected static array $_update_transactions_with_payment = array();
-
-
-    /**
-     * schedule_update_transaction_with_payment
-     * sets a wp_schedule_single_event() for updating any TXNs that may
-     * require updating due to recently received payments
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function schedule_update_transaction_with_payment(
-        int $timestamp,
-        int $TXN_ID,
-        int $PAY_ID
-    ): void {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // validate $TXN_ID and $timestamp
-        $TXN_ID = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-                array($TXN_ID, $PAY_ID)
-            );
-        }
-    }
-
-
-    /**
-     * setup_update_for_transaction_with_payment
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
-     * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
-     * The passed TXN_ID and associated payment gets added to an array, and then
-     * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
-     * 'shutdown' which will actually handle the processing of any
-     * transactions requiring updating, because doing so now would be too early
-     * and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function setup_update_for_transaction_with_payment(int $TXN_ID = 0, int $PAY_ID = 0): void
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'update_transaction_with_payment'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * update_transaction_with_payment
-     * loops through the self::$_abandoned_transactions array
-     * and attempts to finalize any TXNs that have not been completed
-     * but have had their sessions expired, most likely due to a user not
-     * returning from an off-site payment gateway
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function update_transaction_with_payment(): void
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
+	/**
+	 * WordPress doesn't allow duplicate crons within 10 minutes of the original,
+	 * so we'll set our retry time for just over 10 minutes to avoid that
+	 */
+	const reschedule_timeout = 605;
+
+
+	private static ?EE_Cron_Tasks $_instance = null;
+
+
+	public static function instance(): ?EE_Cron_Tasks
+	{
+		if (! self::$_instance instanceof EE_Cron_Tasks) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function __construct()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// verify that WP Cron is enabled
+		if (
+			defined('DISABLE_WP_CRON')
+			&& DISABLE_WP_CRON
+			&& is_admin()
+			&& ! get_option('ee_disabled_wp_cron_check')
+		) {
+			/**
+			 * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
+			 * config is loaded.
+			 * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
+			 * wanting to not have this functionality can just register its own action at a priority after this one to
+			 * reverse any changes.
+			 */
+			add_action(
+				'AHEE__EE_System__load_core_configuration__complete',
+				function () {
+					EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
+					EE_Registry::instance()->NET_CFG->update_config(true, false);
+					add_option('ee_disabled_wp_cron_check', 1, '', false);
+				}
+			);
+		}
+		// UPDATE TRANSACTION WITH PAYMENT
+		add_action(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+			array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
+			10,
+			2
+		);
+		// ABANDONED / EXPIRED TRANSACTION CHECK
+		add_action(
+			'AHEE__EE_Cron_Tasks__expired_transaction_check',
+			array('EE_Cron_Tasks', 'expired_transaction_check')
+		);
+		// CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
+		add_action(
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+			array('EE_Cron_Tasks', 'clean_out_junk_transactions')
+		);
+		// logging
+		add_action(
+			'AHEE__EE_System__load_core_configuration__complete',
+			array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
+		);
+		EE_Registry::instance()->load_lib('Messages_Scheduler');
+		// clean out old gateway logs
+		add_action(
+			'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
+			array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
+		);
+	}
+
+	public static function log_scheduled_ee_crons(): void
+	{
+		$ee_crons = array(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+		);
+		$crons = (array) get_option('cron');
+		foreach ($crons as $cron) {
+			/** @var array[] $cron */
+			foreach ($ee_crons as $ee_cron) {
+				if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
+					do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
+					foreach ($cron[ $ee_cron ] as $ee_cron_details) {
+						if (! empty($ee_cron_details['args'])) {
+							do_action(
+								'AHEE_log',
+								__CLASS__,
+								__FUNCTION__,
+								print_r($ee_cron_details['args'], true),
+								"$ee_cron args"
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * reschedule_cron_for_transactions_if_maintenance_mode
+	 * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
+	 *
+	 * @param string $cron_task
+	 * @param array  $TXN_IDs
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function reschedule_cron_for_transactions_if_maintenance_mode(string $cron_task, array $TXN_IDs): bool
+	{
+		if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
+					$cron_task
+				)
+			);
+		}
+		// reschedule the cron if we can't hit the db right now
+		if (DbStatus::isOffline()) {
+			foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
+				// ensure $additional_vars is an array
+				$additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
+				// reset cron job for the TXN
+				call_user_func_array(
+					array('EE_Cron_Tasks', $cron_task),
+					array_merge(
+						array(
+							time() + (10 * MINUTE_IN_SECONDS),
+							$TXN_ID,
+						),
+						$additional_vars
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+
+	/****************  UPDATE TRANSACTION WITH PAYMENT ****************/
+
+
+	/**
+	 * array of TXN IDs and the payment
+	 *
+	 * @var array
+	 */
+	protected static array $_update_transactions_with_payment = array();
+
+
+	/**
+	 * schedule_update_transaction_with_payment
+	 * sets a wp_schedule_single_event() for updating any TXNs that may
+	 * require updating due to recently received payments
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function schedule_update_transaction_with_payment(
+		int $timestamp,
+		int $TXN_ID,
+		int $PAY_ID
+	): void {
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// validate $TXN_ID and $timestamp
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+				array($TXN_ID, $PAY_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * setup_update_for_transaction_with_payment
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
+	 * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
+	 * The passed TXN_ID and associated payment gets added to an array, and then
+	 * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
+	 * 'shutdown' which will actually handle the processing of any
+	 * transactions requiring updating, because doing so now would be too early
+	 * and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function setup_update_for_transaction_with_payment(int $TXN_ID = 0, int $PAY_ID = 0): void
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if (absint($TXN_ID)) {
+			self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'update_transaction_with_payment'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * update_transaction_with_payment
+	 * loops through the self::$_abandoned_transactions array
+	 * and attempts to finalize any TXNs that have not been completed
+	 * but have had their sessions expired, most likely due to a user not
+	 * returning from an off-site payment gateway
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function update_transaction_with_payment(): void
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
 // are there any TXNs that need cleaning up ?
-            empty(self::$_update_transactions_with_payment)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_update_transaction_with_payment',
-                self::$_update_transactions_with_payment
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Payment_Processor $payment_processor */
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        // set revisit flag for payment processor
-        $payment_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
-            // reschedule the cron if we can't hit the db right now
-            if (DbStatus::isOffline()) {
-                // reset cron job for updating the TXN
-                EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                    time() + EE_Cron_Tasks::reschedule_timeout,
-                    $TXN_ID,
-                    $PAY_ID
-                );
-                continue;
-            }
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            // verify transaction
-            if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
-                // now try to update the TXN with any payments
-                $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
-            }
-            unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
-
-
-    /*****************  EXPIRED TRANSACTION CHECK *****************/
-
-
-    /**
-     * array of TXN IDs
-     *
-     * @var array
-     */
-    protected static array $_expired_transactions = array();
-
-
-    /**
-     * schedule_expired_transaction_check
-     * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_expired_transaction_check(
-        int $timestamp,
-        int $TXN_ID
-    ): void {
-        // validate $TXN_ID and $timestamp
-        $TXN_ID = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__expired_transaction_check',
-                array($TXN_ID)
-            );
-        }
-    }
-
-
-    /**
-     * expired_transaction_check
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
-     * which is utilized by wp_schedule_single_event()
-     * in \EED_Single_Page_Checkout::_initialize_transaction().
-     * The passed TXN_ID gets added to an array, and then the
-     * process_expired_transactions() function is hooked into
-     * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
-     * processing of any failed transactions, because doing so now would be
-     * too early and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     */
-    public static function expired_transaction_check(int $TXN_ID = 0): void
-    {
-        if (absint($TXN_ID)) {
-            self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'process_expired_transactions'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * process_expired_transactions
-     * loops through the self::$_expired_transactions array and processes any failed TXNs
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws DomainException
-     * @throws RuntimeException
-     */
-    public static function process_expired_transactions(): void
-    {
-        if (
+			empty(self::$_update_transactions_with_payment)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_update_transaction_with_payment',
+				self::$_update_transactions_with_payment
+			)
+		) {
+			return;
+		}
+		/** @type EE_Payment_Processor $payment_processor */
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		// set revisit flag for payment processor
+		$payment_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
+			// reschedule the cron if we can't hit the db right now
+			if (DbStatus::isOffline()) {
+				// reset cron job for updating the TXN
+				EE_Cron_Tasks::schedule_update_transaction_with_payment(
+					time() + EE_Cron_Tasks::reschedule_timeout,
+					$TXN_ID,
+					$PAY_ID
+				);
+				continue;
+			}
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			// verify transaction
+			if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
+				// now try to update the TXN with any payments
+				$payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
+			}
+			unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
+
+
+	/*****************  EXPIRED TRANSACTION CHECK *****************/
+
+
+	/**
+	 * array of TXN IDs
+	 *
+	 * @var array
+	 */
+	protected static array $_expired_transactions = array();
+
+
+	/**
+	 * schedule_expired_transaction_check
+	 * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_expired_transaction_check(
+		int $timestamp,
+		int $TXN_ID
+	): void {
+		// validate $TXN_ID and $timestamp
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__expired_transaction_check',
+				array($TXN_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * expired_transaction_check
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
+	 * which is utilized by wp_schedule_single_event()
+	 * in \EED_Single_Page_Checkout::_initialize_transaction().
+	 * The passed TXN_ID gets added to an array, and then the
+	 * process_expired_transactions() function is hooked into
+	 * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
+	 * processing of any failed transactions, because doing so now would be
+	 * too early and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 */
+	public static function expired_transaction_check(int $TXN_ID = 0): void
+	{
+		if (absint($TXN_ID)) {
+			self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'process_expired_transactions'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * process_expired_transactions
+	 * loops through the self::$_expired_transactions array and processes any failed TXNs
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws DomainException
+	 * @throws RuntimeException
+	 */
+	public static function process_expired_transactions(): void
+	{
+		if (
 // are there any TXNs that need cleaning up ?
-            empty(self::$_expired_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_expired_transactions
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag for txn processor
-        $transaction_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_expired_transactions as $TXN_ID) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            // verify transaction and whether it is failed or not
-            if ($transaction instanceof EE_Transaction) {
-                switch ($transaction->status_ID()) {
-                    // Completed TXNs
-                    case EEM_Transaction::complete_status_code:
-                        // Don't update the transaction/registrations if the Primary Registration is Not Approved.
-                        $primary_registration = $transaction->primary_registration();
-                        if (
-                            $primary_registration instanceof EE_Registration
-                            && $primary_registration->status_ID() !== RegStatus::AWAITING_REVIEW
-                        ) {
-                            /** @type EE_Transaction_Processor $transaction_processor */
-                            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-                            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                                $transaction,
-                                $transaction->last_payment()
-                            );
-                            do_action(
-                                'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
-                                $transaction
-                            );
-                        }
-                        break;
-                    // Overpaid TXNs
-                    case EEM_Transaction::overpaid_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Incomplete TXNs
-                    case EEM_Transaction::incomplete_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-                            $transaction
-                        );
-                        // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
-                        break;
-                    // Abandoned TXNs
-                    case EEM_Transaction::abandoned_status_code:
-                        // run hook before updating transaction, primarily so
-                        // EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-                            $transaction
-                        );
-                        // don't finalize the TXN if it has already been completed
-                        if ($transaction->all_reg_steps_completed() !== true) {
-                            /** @type EE_Payment_Processor $payment_processor */
-                            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                            // let's simulate an IPN here which will trigger any notifications that need to go out
-                            $payment_processor->update_txn_based_on_payment(
-                                $transaction,
-                                $transaction->last_payment(),
-                                true,
-                                true
-                            );
-                        }
-                        break;
-                    // Failed TXNs
-                    case EEM_Transaction::failed_status_code:
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-                            $transaction
-                        );
-                        // todo :
-                        // perform garbage collection here and remove clean_out_junk_transactions()
-                        // $registrations = $transaction->registrations();
-                        // if (! empty($registrations)) {
-                        //     foreach ($registrations as $registration) {
-                        //         if ($registration instanceof EE_Registration) {
-                        //             $delete_registration = true;
-                        //             if ($registration->attendee() instanceof EE_Attendee) {
-                        //                 $delete_registration = false;
-                        //             }
-                        //             if ($delete_registration) {
-                        //                 $registration->delete_permanently();
-                        //                 $registration->delete_related_permanently();
-                        //             }
-                        //         }
-                        //     }
-                        // }
-                        break;
-                }
-            }
-            unset(self::$_expired_transactions[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /*************  END OF EXPIRED TRANSACTION CHECK  *************/
-
-
-    /************* START CLEAN UP BOT TRANSACTIONS **********************/
-
-
-    /**
-     * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
-     * which is setup during activation to run on an hourly cron
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     * @throws ReflectionException
-     */
-    public static function clean_out_junk_transactions(): void
-    {
-        if (DbStatus::isOnline()) {
-            EED_Ticket_Sales_Monitor::reset_reservation_counts();
-            EEM_Transaction::instance()->delete_junk_transactions();
-            EEM_Registration::instance()->delete_registrations_with_no_transaction();
-            EEM_Line_Item::instance()->delete_line_items_with_no_transaction();
-        }
-    }
-
-
-    /**
-     * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public static function clean_out_old_gateway_logs(): void
-    {
-        if (DbStatus::isOnline()) {
-            $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-            $time_diff_for_comparison = apply_filters(
-                'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-' . $reg_config->gateway_log_lifespan
-            );
-            EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
-        }
-    }
-
-
-    /*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
-
-
-    /**
-     * @var array
-     */
-    protected static array $_abandoned_transactions = array();
-
-
-    /**
-     * @param int $timestamp
-     * @param int $TXN_ID
-     *@deprecated
-     */
-    public static function schedule_finalize_abandoned_transactions_check(int $timestamp, int $TXN_ID): void
-    {
-        EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
-    }
-
-
-    /**
-     * @param int $TXN_ID
-     *@deprecated
-     */
-    public static function check_for_abandoned_transactions(int $TXN_ID = 0): void
-    {
-        EE_Cron_Tasks::expired_transaction_check($TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function finalize_abandoned_transactions(): void
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
+			empty(self::$_expired_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_expired_transactions
+			)
+		) {
+			return;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag for txn processor
+		$transaction_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_expired_transactions as $TXN_ID) {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			// verify transaction and whether it is failed or not
+			if ($transaction instanceof EE_Transaction) {
+				switch ($transaction->status_ID()) {
+					// Completed TXNs
+					case EEM_Transaction::complete_status_code:
+						// Don't update the transaction/registrations if the Primary Registration is Not Approved.
+						$primary_registration = $transaction->primary_registration();
+						if (
+							$primary_registration instanceof EE_Registration
+							&& $primary_registration->status_ID() !== RegStatus::AWAITING_REVIEW
+						) {
+							/** @type EE_Transaction_Processor $transaction_processor */
+							$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+							$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+								$transaction,
+								$transaction->last_payment()
+							);
+							do_action(
+								'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
+								$transaction
+							);
+						}
+						break;
+					// Overpaid TXNs
+					case EEM_Transaction::overpaid_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
+							$transaction
+						);
+						break;
+					// Incomplete TXNs
+					case EEM_Transaction::incomplete_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+							$transaction
+						);
+						// todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
+						break;
+					// Abandoned TXNs
+					case EEM_Transaction::abandoned_status_code:
+						// run hook before updating transaction, primarily so
+						// EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+							$transaction
+						);
+						// don't finalize the TXN if it has already been completed
+						if ($transaction->all_reg_steps_completed() !== true) {
+							/** @type EE_Payment_Processor $payment_processor */
+							$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+							// let's simulate an IPN here which will trigger any notifications that need to go out
+							$payment_processor->update_txn_based_on_payment(
+								$transaction,
+								$transaction->last_payment(),
+								true,
+								true
+							);
+						}
+						break;
+					// Failed TXNs
+					case EEM_Transaction::failed_status_code:
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+							$transaction
+						);
+						// todo :
+						// perform garbage collection here and remove clean_out_junk_transactions()
+						// $registrations = $transaction->registrations();
+						// if (! empty($registrations)) {
+						//     foreach ($registrations as $registration) {
+						//         if ($registration instanceof EE_Registration) {
+						//             $delete_registration = true;
+						//             if ($registration->attendee() instanceof EE_Attendee) {
+						//                 $delete_registration = false;
+						//             }
+						//             if ($delete_registration) {
+						//                 $registration->delete_permanently();
+						//                 $registration->delete_related_permanently();
+						//             }
+						//         }
+						//     }
+						// }
+						break;
+				}
+			}
+			unset(self::$_expired_transactions[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/*************  END OF EXPIRED TRANSACTION CHECK  *************/
+
+
+	/************* START CLEAN UP BOT TRANSACTIONS **********************/
+
+
+	/**
+	 * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
+	 * which is setup during activation to run on an hourly cron
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 * @throws ReflectionException
+	 */
+	public static function clean_out_junk_transactions(): void
+	{
+		if (DbStatus::isOnline()) {
+			EED_Ticket_Sales_Monitor::reset_reservation_counts();
+			EEM_Transaction::instance()->delete_junk_transactions();
+			EEM_Registration::instance()->delete_registrations_with_no_transaction();
+			EEM_Line_Item::instance()->delete_line_items_with_no_transaction();
+		}
+	}
+
+
+	/**
+	 * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public static function clean_out_old_gateway_logs(): void
+	{
+		if (DbStatus::isOnline()) {
+			$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+			$time_diff_for_comparison = apply_filters(
+				'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
+				'-' . $reg_config->gateway_log_lifespan
+			);
+			EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
+		}
+	}
+
+
+	/*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
+
+
+	/**
+	 * @var array
+	 */
+	protected static array $_abandoned_transactions = array();
+
+
+	/**
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 *@deprecated
+	 */
+	public static function schedule_finalize_abandoned_transactions_check(int $timestamp, int $TXN_ID): void
+	{
+		EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
+	}
+
+
+	/**
+	 * @param int $TXN_ID
+	 *@deprecated
+	 */
+	public static function check_for_abandoned_transactions(int $TXN_ID = 0): void
+	{
+		EE_Cron_Tasks::expired_transaction_check($TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function finalize_abandoned_transactions(): void
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
 // are there any TXNs that need cleaning up ?
-            empty(self::$_abandoned_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_abandoned_transactions
-            )
-        ) {
-            return;
-        }
-        // combine our arrays of transaction IDs
-        self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
-        // and deal with abandoned transactions here now...
-        EE_Cron_Tasks::process_expired_transactions();
-    }
-
-
-    /*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
+			empty(self::$_abandoned_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_abandoned_transactions
+			)
+		) {
+			return;
+		}
+		// combine our arrays of transaction IDs
+		self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
+		// and deal with abandoned transactions here now...
+		EE_Cron_Tasks::process_expired_transactions();
+	}
+
+
+	/*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
 }

core/domain/services/capabilities/FeatureFlag.php

Indentation +176 added lines, -176 removed lines

@@ -11,192 +11,192 @@
 class FeatureFlag
 {
 
-    /**
-     * Whether to use the New Event Editor (EDTR) or continue using the legacy Event Editor
-     * deafult: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs
-     */
-    public const  USE_ADVANCED_EVENT_EDITOR = 'ee_advanced_event_editor';
+	/**
+	 * Whether to use the New Event Editor (EDTR) or continue using the legacy Event Editor
+	 * deafult: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs
+	 */
+	public const  USE_ADVANCED_EVENT_EDITOR = 'ee_advanced_event_editor';
 
-    /**
-     * Whether to enable the Bulk Edit feature in the Advanced Event Editor (EDTR)
-     * default: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs
-     */
-    public const  USE_EVENT_EDITOR_BULK_EDIT = 'ee_event_editor_bulk_edit';
+	/**
+	 * Whether to enable the Bulk Edit feature in the Advanced Event Editor (EDTR)
+	 * default: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs
+	 */
+	public const  USE_EVENT_EDITOR_BULK_EDIT = 'ee_event_editor_bulk_edit';
 
-    /**
-     * Whether to enable the new Default Ticket Manager in the EDTR
-     * default: Enabled
-     */
-    public const  USE_DEFAULT_TICKET_MANAGER = 'use_default_ticket_manager';
+	/**
+	 * Whether to enable the new Default Ticket Manager in the EDTR
+	 * default: Enabled
+	 */
+	public const  USE_DEFAULT_TICKET_MANAGER = 'use_default_ticket_manager';
 
-    /**
-     * Whether to enable the Rich Text Editor for the Event Description field in the EDTR or use tinymce
-     * default: Disabled
-     */
-    public const  USE_EVENT_DESCRIPTION_RTE = 'use_event_description_rte';
+	/**
+	 * Whether to enable the Rich Text Editor for the Event Description field in the EDTR or use tinymce
+	 * default: Disabled
+	 */
+	public const  USE_EVENT_DESCRIPTION_RTE = 'use_event_description_rte';
 
-    /**
-     * Whether to enable the Rich Text Editor for all other RTE fields in the EDTR
-     * default: Disabled
-     */
-    public const  USE_EXPERIMENTAL_RTE = 'use_experimental_rte';
+	/**
+	 * Whether to enable the Rich Text Editor for all other RTE fields in the EDTR
+	 * default: Disabled
+	 */
+	public const  USE_EXPERIMENTAL_RTE = 'use_experimental_rte';
 
-    /**
-     * Whether to enable the new Registration Form Builder in the EDTR
-     * or continue using the legacy Question Groups and Registration Form admin pages
-     * default: Disabled
-     */
-    public const  USE_REG_FORM_BUILDER = 'use_reg_form_builder';
+	/**
+	 * Whether to enable the new Registration Form Builder in the EDTR
+	 * or continue using the legacy Question Groups and Registration Form admin pages
+	 * default: Disabled
+	 */
+	public const  USE_REG_FORM_BUILDER = 'use_reg_form_builder';
 
-    /**
-     * Whether to enable the new Registration Options meta box in the EDTR
-     * or continue using the legacy Event Registration Options
-     * default: Disabled
-     */
-    public const  USE_REG_OPTIONS_META_BOX = 'use_reg_options_meta_box';
+	/**
+	 * Whether to enable the new Registration Options meta box in the EDTR
+	 * or continue using the legacy Event Registration Options
+	 * default: Disabled
+	 */
+	public const  USE_REG_OPTIONS_META_BOX = 'use_reg_options_meta_box';
 
-    /**
-     * Whether to enable the new Single Page Checkout form refactor changes
-     * default: Disabled
-     *
-     * @since 5.0.18.p
-     */
-    public const  USE_SPCO_FORM_REFACTOR = 'use_spco_form_refactor';
+	/**
+	 * Whether to enable the new Single Page Checkout form refactor changes
+	 * default: Disabled
+	 *
+	 * @since 5.0.18.p
+	 */
+	public const  USE_SPCO_FORM_REFACTOR = 'use_spco_form_refactor';
 
-    /**
-     * Whether to enable the new Reg Form Ticket Questions functionality
-     * default: Disabled
-     */
-    public const  USE_REG_FORM_TICKET_QUESTIONS = 'use_reg_form_ticket_questions';
+	/**
+	 * Whether to enable the new Reg Form Ticket Questions functionality
+	 * default: Disabled
+	 */
+	public const  USE_REG_FORM_TICKET_QUESTIONS = 'use_reg_form_ticket_questions';
 
-    /**
-     * Whether to use the EDD Plugin Licensing system to manage licenses for the EE plugins
-     * default: Disabled
-     */
-    public const USE_EDD_PLUGIN_LICENSING = 'use_edd_plugin_licensing';
+	/**
+	 * Whether to use the EDD Plugin Licensing system to manage licenses for the EE plugins
+	 * default: Disabled
+	 */
+	public const USE_EDD_PLUGIN_LICENSING = 'use_edd_plugin_licensing';
 
-    /**
-     * Whether to use the new Datetime Status Controls in the EDTR
-     * default: Disabled
-     */
-    public const USE_DATETIME_STATUS_CONTROLS = 'use_datetime_status_controls';
+	/**
+	 * Whether to use the new Datetime Status Controls in the EDTR
+	 * default: Disabled
+	 */
+	public const USE_DATETIME_STATUS_CONTROLS = 'use_datetime_status_controls';
 
 
-    public static function getFormOptions(): array
-    {
-        return [
-            FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => [
-                'name'            => esc_html__('Event Editor Bulk Edit', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Event Editor Bulk Edit', 'event_espresso'),
-                'help_text'       => sprintf(
-                    esc_html__(
-                        'Whether to enable the Bulk Edit feature in the Advanced Event Editor (EDTR).%1$s%2$sPLEASE NOTE: Bulk Editing is ALWAYS enabled if the Recurring Events Manager add-on is active.%3$s%1$s default: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    '<strong>',
-                    '</strong>'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => [
-                'name'            => esc_html__('Default Ticket Manager', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Default Ticket Manager', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Default Ticket Manager in the EDTR. default: Enabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => [
-                'name'            => esc_html__('Event Description RTE', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Rich Text Editor for Event Description', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the Rich Text Editor for the Event Description field in the EDTR or use tinymce. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_EXPERIMENTAL_RTE          => [
-                'name'            => esc_html__('Rich Text Editor', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Rich Text Editor for other RTE fields', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the Rich Text Editor for all other RTE fields in the EDTR. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_REG_FORM_BUILDER          => [
-                'name'            => esc_html__('Registration Form Builder', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Registration Form Builder', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Registration Form Builder in the EDTR or continue using the legacy Question Groups and Registration Form admin pages. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_REG_OPTIONS_META_BOX      => [
-                'name'            => esc_html__('Registration Options', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Registration Options', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Registration Options meta box in the EDTR or continue using the legacy Event Registration Options. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_SPCO_FORM_REFACTOR        => [
-                'name'            => esc_html__('SPCO Form Refactor', 'event_espresso'),
-                'html_label_text' => esc_html__('Use SPCO Form Refactor', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Single Page Checkout form refactor changes or continue using the legacy Single Page Checkout form. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => [
-                'name'            => esc_html__('Reg Form Ticket Questions', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Reg Form Ticket Questions', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to enable the new Reg Form Ticket Questions functionality. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-            FeatureFlag::USE_EDD_PLUGIN_LICENSING      => [
-                'name'            => esc_html__('EDD Plugin Licensing', 'event_espresso'),
-                'html_label_text' => esc_html__('Use EDD Plugin Licensing', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to use the EDD Plugin Licensing system to manage licenses for the EE plugins. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => defined('EE_USE_EDD_PLUGIN_LICENSING') && EE_USE_EDD_PLUGIN_LICENSING,
-                'overridden_by'      => defined('EE_USE_EDD_PLUGIN_LICENSING') && EE_USE_EDD_PLUGIN_LICENSING
-                    ? sprintf(
-                        esc_html__('%1$sCurrently overriden by the %2$s constant in wp-config.php%3$s', 'event_espresso'),
-                        '<br><span class="ee-status--warning">',
-                        'EE_USE_EDD_PLUGIN_LICENSING',
-                        '</span>'
-                    )
-                    : '',
-            ],
-            FeatureFlag::USE_DATETIME_STATUS_CONTROLS  => [
-                'name'            => esc_html__('Datetime Status Controls', 'event_espresso'),
-                'html_label_text' => esc_html__('Use Datetime Status Controls', 'event_espresso'),
-                'help_text'       => esc_html__(
-                    'Whether to use the new Datetime Status Controls in the EDTR. default: Disabled',
-                    'event_espresso'
-                ),
-                'overridden'      => false,
-                'overridden_by'   => '',
-            ],
-        ];
-    }
+	public static function getFormOptions(): array
+	{
+		return [
+			FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => [
+				'name'            => esc_html__('Event Editor Bulk Edit', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Event Editor Bulk Edit', 'event_espresso'),
+				'help_text'       => sprintf(
+					esc_html__(
+						'Whether to enable the Bulk Edit feature in the Advanced Event Editor (EDTR).%1$s%2$sPLEASE NOTE: Bulk Editing is ALWAYS enabled if the Recurring Events Manager add-on is active.%3$s%1$s default: Enabled for Caffeinated sites, disabled for Decaf or Multisite installs',
+						'event_espresso'
+					),
+					'<br/>',
+					'<strong>',
+					'</strong>'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => [
+				'name'            => esc_html__('Default Ticket Manager', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Default Ticket Manager', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Default Ticket Manager in the EDTR. default: Enabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => [
+				'name'            => esc_html__('Event Description RTE', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Rich Text Editor for Event Description', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the Rich Text Editor for the Event Description field in the EDTR or use tinymce. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_EXPERIMENTAL_RTE          => [
+				'name'            => esc_html__('Rich Text Editor', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Rich Text Editor for other RTE fields', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the Rich Text Editor for all other RTE fields in the EDTR. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_REG_FORM_BUILDER          => [
+				'name'            => esc_html__('Registration Form Builder', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Registration Form Builder', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Registration Form Builder in the EDTR or continue using the legacy Question Groups and Registration Form admin pages. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_REG_OPTIONS_META_BOX      => [
+				'name'            => esc_html__('Registration Options', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Registration Options', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Registration Options meta box in the EDTR or continue using the legacy Event Registration Options. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_SPCO_FORM_REFACTOR        => [
+				'name'            => esc_html__('SPCO Form Refactor', 'event_espresso'),
+				'html_label_text' => esc_html__('Use SPCO Form Refactor', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Single Page Checkout form refactor changes or continue using the legacy Single Page Checkout form. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => [
+				'name'            => esc_html__('Reg Form Ticket Questions', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Reg Form Ticket Questions', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to enable the new Reg Form Ticket Questions functionality. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+			FeatureFlag::USE_EDD_PLUGIN_LICENSING      => [
+				'name'            => esc_html__('EDD Plugin Licensing', 'event_espresso'),
+				'html_label_text' => esc_html__('Use EDD Plugin Licensing', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to use the EDD Plugin Licensing system to manage licenses for the EE plugins. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => defined('EE_USE_EDD_PLUGIN_LICENSING') && EE_USE_EDD_PLUGIN_LICENSING,
+				'overridden_by'      => defined('EE_USE_EDD_PLUGIN_LICENSING') && EE_USE_EDD_PLUGIN_LICENSING
+					? sprintf(
+						esc_html__('%1$sCurrently overriden by the %2$s constant in wp-config.php%3$s', 'event_espresso'),
+						'<br><span class="ee-status--warning">',
+						'EE_USE_EDD_PLUGIN_LICENSING',
+						'</span>'
+					)
+					: '',
+			],
+			FeatureFlag::USE_DATETIME_STATUS_CONTROLS  => [
+				'name'            => esc_html__('Datetime Status Controls', 'event_espresso'),
+				'html_label_text' => esc_html__('Use Datetime Status Controls', 'event_espresso'),
+				'help_text'       => esc_html__(
+					'Whether to use the new Datetime Status Controls in the EDTR. default: Disabled',
+					'event_espresso'
+				),
+				'overridden'      => false,
+				'overridden_by'   => '',
+			],
+		];
+	}
 }

core/domain/services/capabilities/FeatureFlagsConfig.php

Indentation +163 added lines, -163 removed lines

@@ -17,167 +17,167 @@
  */
 class FeatureFlagsConfig extends JsonDataWordpressOption
 {
-    /**
-     * WP option name for saving the Feature Flags configuration
-     */
-    private const OPTION_NAME = 'ee_feature_flags';
-
-    /**
-     * use FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT instead
-     * this hasn't been deleted because it's used in the REM add-on
-     *
-     * @deprecated 5.0.18.p
-     */
-    public const  USE_EVENT_EDITOR_BULK_EDIT = FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT;
-
-
-
-    protected Domain $domain;
-
-    private ?stdClass $feature_flags = null;
-
-
-    public function __construct(Domain $domain, JsonDataHandler $json_data_handler)
-    {
-        $this->domain = $domain;
-        parent::__construct($json_data_handler, FeatureFlagsConfig::OPTION_NAME, $this->getDefaultFeatureFlagOptions());
-    }
-
-
-    /**
-     * see the FeatureFlag::USE_* constants for descriptions of each feature flag and their default values
-     *
-     * @return stdClass
-     */
-    public function getDefaultFeatureFlagOptions(): stdClass
-    {
-        return (object) [
-            FeatureFlag::USE_ADVANCED_EVENT_EDITOR     => $this->domain->isCaffeinated() && ! $this->domain->isMultiSite(),
-            FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => true,
-            FeatureFlag::USE_EDD_PLUGIN_LICENSING      => defined('EE_USE_EDD_PLUGIN_LICENSING') && EE_USE_EDD_PLUGIN_LICENSING,
-            FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => false,
-            FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => $this->domain->isCaffeinated() && ! $this->domain->isMultiSite(),
-            FeatureFlag::USE_EXPERIMENTAL_RTE          => false,
-            FeatureFlag::USE_REG_FORM_BUILDER          => false,
-            FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => false,
-            FeatureFlag::USE_REG_OPTIONS_META_BOX      => false,
-            FeatureFlag::USE_SPCO_FORM_REFACTOR        => false,
-        ];
-    }
-
-
-    /**
-     * feature flags that absolutely must be enabled/disabled based on hard-coded conditions
-     *
-     * @return stdClass
-     * @since 5.0.20.p
-     */
-    public function getOverrides(): stdClass
-    {
-        $overrides = [];
-        if (defined('EE_USE_EDD_PLUGIN_LICENSING')) {
-            $overrides[FeatureFlag::USE_EDD_PLUGIN_LICENSING] = EE_USE_EDD_PLUGIN_LICENSING;
-        }
-        return (object) $overrides;
-    }
-
-
-    /**
-     * @return stdClass
-     */
-    public function getFeatureFlags(): stdClass
-    {
-        if ($this->feature_flags) {
-            return $this->feature_flags;
-        }
-        $default_options = $this->getDefaultFeatureFlagOptions();
-        if (apply_filters('FHEE__FeatureFlagsConfig__getFeatureFlags__use_default_feature_flags', true)) {
-            $this->feature_flags = $default_options;
-            return $this->feature_flags;
-        }
-        $this->feature_flags = $this->getAll();
-        $overrides = $this->getOverrides();
-        // ensure that all feature flags are set
-        foreach ($default_options as $key => $value) {
-            // if the feature flag is not set, use the default value
-            if (!isset($this->feature_flags->$key)) {
-                $this->feature_flags->$key = $value;
-            }
-            // ensure that all overrides are set
-            if (isset($overrides->$key)) {
-                $this->feature_flags->$key = $overrides->$key;
-            }
-        }
-        return $this->feature_flags;
-    }
-
-
-    public function saveFeatureFlagsConfig(?stdClass $feature_flags = null): int
-    {
-        $feature_flags = $feature_flags ?? $this->feature_flags;
-        return $this->updateOption($feature_flags);
-    }
-
-
-    /**
-     * enables a feature flag, ex:
-     * $this->enableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
-     *
-     * @param string $feature_flag the feature flag to enable. One of the FeatureFlag::USE_* constants
-     * @param bool   $add_if_missing
-     * @param bool   $save
-     * @return int
-     */
-    public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
-    {
-        if (! $this->feature_flags) {
-            $this->getFeatureFlags();
-        }
-        if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
-                return WordPressOption::UPDATE_ERROR;
-        }
-        $this->feature_flags->{$feature_flag} = true;
-        // if feature flag is the advanced event editor or bulk edit options
-        // then only enabled if the site is Caffeinated and not MultiSite
-        if (
-            $feature_flag === FeatureFlag::USE_ADVANCED_EVENT_EDITOR
-            || $feature_flag === FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT
-        ) {
-            $this->feature_flags->{$feature_flag} = $this->domain->isCaffeinated() && ! $this->domain->isMultiSite();
-        }
-        if ($save) {
-            return $this->saveFeatureFlagsConfig($this->feature_flags);
-        }
-        return WordPressOption::UPDATE_NONE;
-    }
-
-
-    /**
-     * disables a feature flag, ex:
-     * $this->disableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
-     *
-     * @param string $feature_flag the feature flag to disable. One of the FeatureFlag::USE_* constants
-     * @param bool   $save
-     * @return int
-     */
-    public function disableFeatureFlag(string $feature_flag, bool $save = true): int
-    {
-        if (! $this->feature_flags) {
-            $this->getFeatureFlags();
-        }
-        if (! property_exists($this->feature_flags, $feature_flag)) {
-            return WordPressOption::UPDATE_ERROR;
-        }
-        $this->feature_flags->{$feature_flag} = false;
-        if ($save) {
-            return $this->saveFeatureFlagsConfig($this->feature_flags);
-        }
-        return WordPressOption::UPDATE_NONE;
-    }
-
-
-    public function getFeatureFlagsFormOptions(): ?array
-    {
-        return FeatureFlag::getFormOptions();
-    }
+	/**
+	 * WP option name for saving the Feature Flags configuration
+	 */
+	private const OPTION_NAME = 'ee_feature_flags';
+
+	/**
+	 * use FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT instead
+	 * this hasn't been deleted because it's used in the REM add-on
+	 *
+	 * @deprecated 5.0.18.p
+	 */
+	public const  USE_EVENT_EDITOR_BULK_EDIT = FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT;
+
+
+
+	protected Domain $domain;
+
+	private ?stdClass $feature_flags = null;
+
+
+	public function __construct(Domain $domain, JsonDataHandler $json_data_handler)
+	{
+		$this->domain = $domain;
+		parent::__construct($json_data_handler, FeatureFlagsConfig::OPTION_NAME, $this->getDefaultFeatureFlagOptions());
+	}
+
+
+	/**
+	 * see the FeatureFlag::USE_* constants for descriptions of each feature flag and their default values
+	 *
+	 * @return stdClass
+	 */
+	public function getDefaultFeatureFlagOptions(): stdClass
+	{
+		return (object) [
+			FeatureFlag::USE_ADVANCED_EVENT_EDITOR     => $this->domain->isCaffeinated() && ! $this->domain->isMultiSite(),
+			FeatureFlag::USE_DEFAULT_TICKET_MANAGER    => true,
+			FeatureFlag::USE_EDD_PLUGIN_LICENSING      => defined('EE_USE_EDD_PLUGIN_LICENSING') && EE_USE_EDD_PLUGIN_LICENSING,
+			FeatureFlag::USE_EVENT_DESCRIPTION_RTE     => false,
+			FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT    => $this->domain->isCaffeinated() && ! $this->domain->isMultiSite(),
+			FeatureFlag::USE_EXPERIMENTAL_RTE          => false,
+			FeatureFlag::USE_REG_FORM_BUILDER          => false,
+			FeatureFlag::USE_REG_FORM_TICKET_QUESTIONS => false,
+			FeatureFlag::USE_REG_OPTIONS_META_BOX      => false,
+			FeatureFlag::USE_SPCO_FORM_REFACTOR        => false,
+		];
+	}
+
+
+	/**
+	 * feature flags that absolutely must be enabled/disabled based on hard-coded conditions
+	 *
+	 * @return stdClass
+	 * @since 5.0.20.p
+	 */
+	public function getOverrides(): stdClass
+	{
+		$overrides = [];
+		if (defined('EE_USE_EDD_PLUGIN_LICENSING')) {
+			$overrides[FeatureFlag::USE_EDD_PLUGIN_LICENSING] = EE_USE_EDD_PLUGIN_LICENSING;
+		}
+		return (object) $overrides;
+	}
+
+
+	/**
+	 * @return stdClass
+	 */
+	public function getFeatureFlags(): stdClass
+	{
+		if ($this->feature_flags) {
+			return $this->feature_flags;
+		}
+		$default_options = $this->getDefaultFeatureFlagOptions();
+		if (apply_filters('FHEE__FeatureFlagsConfig__getFeatureFlags__use_default_feature_flags', true)) {
+			$this->feature_flags = $default_options;
+			return $this->feature_flags;
+		}
+		$this->feature_flags = $this->getAll();
+		$overrides = $this->getOverrides();
+		// ensure that all feature flags are set
+		foreach ($default_options as $key => $value) {
+			// if the feature flag is not set, use the default value
+			if (!isset($this->feature_flags->$key)) {
+				$this->feature_flags->$key = $value;
+			}
+			// ensure that all overrides are set
+			if (isset($overrides->$key)) {
+				$this->feature_flags->$key = $overrides->$key;
+			}
+		}
+		return $this->feature_flags;
+	}
+
+
+	public function saveFeatureFlagsConfig(?stdClass $feature_flags = null): int
+	{
+		$feature_flags = $feature_flags ?? $this->feature_flags;
+		return $this->updateOption($feature_flags);
+	}
+
+
+	/**
+	 * enables a feature flag, ex:
+	 * $this->enableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
+	 *
+	 * @param string $feature_flag the feature flag to enable. One of the FeatureFlag::USE_* constants
+	 * @param bool   $add_if_missing
+	 * @param bool   $save
+	 * @return int
+	 */
+	public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
+	{
+		if (! $this->feature_flags) {
+			$this->getFeatureFlags();
+		}
+		if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
+				return WordPressOption::UPDATE_ERROR;
+		}
+		$this->feature_flags->{$feature_flag} = true;
+		// if feature flag is the advanced event editor or bulk edit options
+		// then only enabled if the site is Caffeinated and not MultiSite
+		if (
+			$feature_flag === FeatureFlag::USE_ADVANCED_EVENT_EDITOR
+			|| $feature_flag === FeatureFlag::USE_EVENT_EDITOR_BULK_EDIT
+		) {
+			$this->feature_flags->{$feature_flag} = $this->domain->isCaffeinated() && ! $this->domain->isMultiSite();
+		}
+		if ($save) {
+			return $this->saveFeatureFlagsConfig($this->feature_flags);
+		}
+		return WordPressOption::UPDATE_NONE;
+	}
+
+
+	/**
+	 * disables a feature flag, ex:
+	 * $this->disableFeatureFlag(FeatureFlag::USE_ADVANCED_EVENT_EDITOR);
+	 *
+	 * @param string $feature_flag the feature flag to disable. One of the FeatureFlag::USE_* constants
+	 * @param bool   $save
+	 * @return int
+	 */
+	public function disableFeatureFlag(string $feature_flag, bool $save = true): int
+	{
+		if (! $this->feature_flags) {
+			$this->getFeatureFlags();
+		}
+		if (! property_exists($this->feature_flags, $feature_flag)) {
+			return WordPressOption::UPDATE_ERROR;
+		}
+		$this->feature_flags->{$feature_flag} = false;
+		if ($save) {
+			return $this->saveFeatureFlagsConfig($this->feature_flags);
+		}
+		return WordPressOption::UPDATE_NONE;
+	}
+
+
+	public function getFeatureFlagsFormOptions(): ?array
+	{
+		return FeatureFlag::getFormOptions();
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -100,7 +100,7 @@ 
         // ensure that all feature flags are set
         foreach ($default_options as $key => $value) {
             // if the feature flag is not set, use the default value
-            if (!isset($this->feature_flags->$key)) {
+            if ( ! isset($this->feature_flags->$key)) {
                 $this->feature_flags->$key = $value;
             }
             // ensure that all overrides are set
@@ -130,10 +130,10 @@ 
      */
     public function enableFeatureFlag(string $feature_flag, bool $add_if_missing = false, bool $save = true): int
     {
-        if (! $this->feature_flags) {
+        if ( ! $this->feature_flags) {
             $this->getFeatureFlags();
         }
-        if (! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
+        if ( ! property_exists($this->feature_flags, $feature_flag) && ! $add_if_missing) {
                 return WordPressOption::UPDATE_ERROR;
         }
         $this->feature_flags->{$feature_flag} = true;
@@ -162,10 +162,10 @@ 
      */
     public function disableFeatureFlag(string $feature_flag, bool $save = true): int
     {
-        if (! $this->feature_flags) {
+        if ( ! $this->feature_flags) {
             $this->getFeatureFlags();
         }
-        if (! property_exists($this->feature_flags, $feature_flag)) {
+        if ( ! property_exists($this->feature_flags, $feature_flag)) {
             return WordPressOption::UPDATE_ERROR;
         }
         $this->feature_flags->{$feature_flag} = false;

core/domain/services/admin/events/default_settings/AdvancedEditorAdminFormSection.php

Indentation +72 added lines, -72 removed lines

@@ -37,82 +37,82 @@
  */
 class AdvancedEditorAdminFormSection
 {
-    protected  EE_Admin_Config $admin_config;
+	protected  EE_Admin_Config $admin_config;
 
 
-    /**
-     * AdvancedEditorAdminForm constructor.
-     *
-     * @param EE_Admin_Config $admin_config
-     */
-    public function __construct(EE_Admin_Config $admin_config)
-    {
-        $this->admin_config = $admin_config;
-        add_filter(
-            'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-            [$this, 'mergeFormSubsections']
-        );
-        add_action(
-            'AHEE__Events_Admin_Page___update_default_event_settings',
-            [$this, 'updateAdminFormSettings'],
-            10,
-            2
-        );
-    }
+	/**
+	 * AdvancedEditorAdminForm constructor.
+	 *
+	 * @param EE_Admin_Config $admin_config
+	 */
+	public function __construct(EE_Admin_Config $admin_config)
+	{
+		$this->admin_config = $admin_config;
+		add_filter(
+			'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+			[$this, 'mergeFormSubsections']
+		);
+		add_action(
+			'AHEE__Events_Admin_Page___update_default_event_settings',
+			[$this, 'updateAdminFormSettings'],
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * @param array $default_event_settings_form_subsections
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function mergeFormSubsections(array $default_event_settings_form_subsections): array
-    {
-        return [
-                   'new_features_section_header' => new EE_Form_Section_HTML(
-                       EEH_HTML::h2(
-                           esc_html__('New Feature', 'event_espresso'),
-                           '',
-                           'ee-admin-settings-hdr ee-admin-settings-hdr--new-feature'
-                       )
-                   ),
-                   'use_advanced_editor'     => new EE_Select_Input(
-                       apply_filters(
-                           'FHEE__Events_Admin_Page___default_event_settings_form__advanced_editor_input_answer_options',
-                           [
-                               esc_html__('Legacy Editor', 'event_espresso'),
-                               esc_html__('Advanced Editor', 'event_espresso'),
-                           ]
-                       ),
-                       apply_filters(
-                           'FHEE__Events_Admin_Page___default_event_settings_form__advanced_editor_input_settings',
-                           [
-                               'default'         => $this->admin_config->useAdvancedEditor(),
-                               'html_label_text' => esc_html__('Activate Advanced Editor?', 'event_espresso'),
-                               'html_help_text'  => sprintf(
-                                   esc_html__(
-                                       'Controls whether the Event Espresso Event Editor continues to use the existing legacy editor that functions like the typical older WordPress admin you are used to,%1$sor uses the new Advanced Editor with a more powerful and easier to use interface. This may be automatically turned on in order to utilize advanced features from new addons.',
-                                       'event_espresso'
-                                   ),
-                                   '<br />'
-                               ),
-                               'html_class'      => 'ee-input-width--small',
-                           ]
-                       )
-                   ),
-               ] + $default_event_settings_form_subsections;
-    }
+	/**
+	 * @param array $default_event_settings_form_subsections
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function mergeFormSubsections(array $default_event_settings_form_subsections): array
+	{
+		return [
+				   'new_features_section_header' => new EE_Form_Section_HTML(
+					   EEH_HTML::h2(
+						   esc_html__('New Feature', 'event_espresso'),
+						   '',
+						   'ee-admin-settings-hdr ee-admin-settings-hdr--new-feature'
+					   )
+				   ),
+				   'use_advanced_editor'     => new EE_Select_Input(
+					   apply_filters(
+						   'FHEE__Events_Admin_Page___default_event_settings_form__advanced_editor_input_answer_options',
+						   [
+							   esc_html__('Legacy Editor', 'event_espresso'),
+							   esc_html__('Advanced Editor', 'event_espresso'),
+						   ]
+					   ),
+					   apply_filters(
+						   'FHEE__Events_Admin_Page___default_event_settings_form__advanced_editor_input_settings',
+						   [
+							   'default'         => $this->admin_config->useAdvancedEditor(),
+							   'html_label_text' => esc_html__('Activate Advanced Editor?', 'event_espresso'),
+							   'html_help_text'  => sprintf(
+								   esc_html__(
+									   'Controls whether the Event Espresso Event Editor continues to use the existing legacy editor that functions like the typical older WordPress admin you are used to,%1$sor uses the new Advanced Editor with a more powerful and easier to use interface. This may be automatically turned on in order to utilize advanced features from new addons.',
+									   'event_espresso'
+								   ),
+								   '<br />'
+							   ),
+							   'html_class'      => 'ee-input-width--small',
+						   ]
+					   )
+				   ),
+			   ] + $default_event_settings_form_subsections;
+	}
 
 
-    /**
-     * @param array     $valid_data
-     * @param EE_Config $config
-     * @since 5.0.0.p
-     */
-    public function updateAdminFormSettings(array $valid_data, EE_Config $config)
-    {
-        $config->admin->setUseAdvancedEditor(
-            $valid_data['use_advanced_editor'] ?? false
-        );
-    }
+	/**
+	 * @param array     $valid_data
+	 * @param EE_Config $config
+	 * @since 5.0.0.p
+	 */
+	public function updateAdminFormSettings(array $valid_data, EE_Config $config)
+	{
+		$config->admin->setUseAdvancedEditor(
+			$valid_data['use_advanced_editor'] ?? false
+		);
+	}
 }

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

Indentation +412 added lines, -412 removed lines

@@ -23,416 +23,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'
-            ? RegStatus::INCOMPLETE
-            : ['!=', RegStatus::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'
+			? RegStatus::INCOMPLETE
+			: ['!=', RegStatus::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]];
+	}
 }

core/domain/services/admin/AdminToolBar.php

Indentation +821 added lines, -821 removed lines

@@ -20,825 +20,825 @@
  */
 class AdminToolBar
 {
-    private ?WP_Admin_Bar   $admin_bar        = null;
-
-    private EE_Capabilities $capabilities;
-
-    private string          $events_admin_url = '';
-
-    private string          $menu_class       = 'espresso_menu_item_class';
-
-    private string          $reg_admin_url    = '';
-
-
-    /**
-     * AdminToolBar constructor.
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-        add_action('admin_bar_menu', [$this, 'espressoToolbarItems'], 100);
-        $this->enqueueAssets();
-    }
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
-    {
-        // if it's an AJAX request, or user is NOT an admin, or in full M-Mode
-        if (
-            (defined('DOING_AJAX') && DOING_AJAX)
-            || ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-            || MaintenanceStatus::isFullSite()
-        ) {
-            return;
-        }
-        $this->admin_bar = $admin_bar;
-        // we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        // because they're only defined in each of their respective constructors
-        // and this might be a frontend request, in which case they aren't available
-        $this->events_admin_url = admin_url('admin.php?page=espresso_events');
-        $this->reg_admin_url    = admin_url('admin.php?page=espresso_registrations');
-        // now let's add all the menu items
-        $this->addTopLevelMenu();
-        $this->addEventsSubMenu();
-        $this->addEventsAddEditHeader();
-        $this->addEventsAddNew();
-        $this->addEventsEditCurrentEvent();
-        $this->addEventsViewHeader();
-        $this->addEventsViewAll();
-        $this->addEventsViewToday();
-        $this->addEventsViewThisMonth();
-        $this->addRegistrationSubMenu();
-        $this->addRegistrationOverviewToday();
-        $this->addRegistrationOverviewTodayApproved();
-        $this->addRegistrationOverviewTodayPendingPayment();
-        $this->addRegistrationOverviewTodayNotApproved();
-        $this->addRegistrationOverviewTodayCancelled();
-        $this->addRegistrationOverviewThisMonth();
-        $this->addRegistrationOverviewThisMonthApproved();
-        $this->addRegistrationOverviewThisMonthPending();
-        $this->addRegistrationOverviewThisMonthNotApproved();
-        $this->addRegistrationOverviewThisMonthCancelled();
-        $this->addExtensionsAndServices();
-        $this->addFontSizeSubMenu();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function enqueueAssets()
-    {
-        wp_register_style(
-            'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
-            ['dashicons'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-admin-toolbar');
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addTopLevelMenu()
-    {
-        $this->admin_bar->add_menu(
-            [
-                'id'    => 'espresso-toolbar',
-                'title' => '<span class="ab-icon ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                           . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                           . '</span>',
-                'href'  => $this->events_admin_url,
-                'meta'  => [
-                    'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsSubMenu()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Events', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => [
-                        'title'  => esc_html__('Events', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddEditHeader()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-view'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-add-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('Add / Edit', 'event_espresso'),
-                    'href'   => '',
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddNew()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_edit_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-new'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-new',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Add New', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        ['action' => 'create_new'],
-                        $this->events_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Add New', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsEditCurrentEvent()
-    {
-        if (is_single() && (get_post_type() === EspressoPostType::EVENTS)) {
-            // Current post
-            global $post;
-            if (
-                $this->capabilities->current_user_can(
-                    'ee_edit_event',
-                    'ee_admin_bar_menu_espresso-toolbar-events-edit',
-                    $post->ID
-                )
-            ) {
-                $this->admin_bar->add_menu(
-                    [
-                        'id'     => 'espresso-toolbar-events-edit',
-                        'parent' => 'espresso-toolbar-events',
-                        'title'  => '<span class="ee-toolbar-icon"></span>'
-                                    . esc_html__('Edit Event', 'event_espresso'),
-                        'href'   => EEH_URL::add_query_args_and_nonce(
-                            [
-                                'action' => 'edit',
-                                'post'   => $post->ID,
-                            ],
-                            $this->events_admin_url
-                        ),
-                        'meta'   => [
-                            'title'  => esc_html__('Edit Event', 'event_espresso'),
-                            'target' => '',
-                            'class'  => $this->menu_class,
-                        ],
-                    ]
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewHeader()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-view'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-view',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('View', 'event_espresso'),
-                    'href'   => '',
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewAll()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-all'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-all',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('All', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => [
-                        'title'  => esc_html__('All', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewToday()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-today'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-today',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Today', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action' => 'default',
-                            'status' => 'today',
-                        ],
-                        $this->events_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewThisMonth()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_events',
-                'ee_admin_bar_menu_espresso-toolbar-events-month'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-events-month',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('This Month', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action' => 'default',
-                            'status' => 'month',
-                        ],
-                        $this->events_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationSubMenu()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Registrations', 'event_espresso'),
-                    'href'   => $this->reg_admin_url,
-                    'meta'   => [
-                        'title'  => esc_html__('Registrations', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewToday()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('Today', 'event_espresso'),
-                    'href'   => '',
-                    'meta'   => [
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => RegStatus::APPROVED,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayPendingPayment()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => RegStatus::PENDING_PAYMENT,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Pending Payment', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayNotApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => RegStatus::AWAITING_REVIEW,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayCancelled()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => RegStatus::CANCELLED,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonth()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('This Month', 'event_espresso'),
-                    'href'   => '', // EEH_URL::add_query_args_and_nonce(
-                    //     array(
-                    //         'action' => 'default',
-                    //         'status' => 'month'
-                    //     ),
-                    //     $this->reg_admin_url
-                    // ),
-                    'meta'   => [
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => RegStatus::APPROVED,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthPending()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => RegStatus::PENDING_PAYMENT,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Pending', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthNotApproved()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => RegStatus::AWAITING_REVIEW,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthCancelled()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_registrations',
-                'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        [
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => RegStatus::CANCELLED,
-                        ],
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addExtensionsAndServices()
-    {
-        if (
-            $this->capabilities->current_user_can(
-                'ee_read_ee',
-                'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
-            )
-        ) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => 'espresso-toolbar-extensions-and-services',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Extensions & Services', 'event_espresso'),
-                    'href'   => admin_url('admin.php?page=espresso_packages'),
-                    'meta'   => [
-                        'title'  => esc_html__('Extensions & Services', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addFontSizeSubMenu()
-    {
-        if (! is_admin()) {
-            return;
-        }
-        $this->admin_bar->add_menu(
-            [
-                'id'     => 'espresso-toolbar-font-size',
-                'parent' => 'espresso-toolbar',
-                'title'  => '<span class="ee-toolbar-icon"></span>'
-                            . esc_html__('Set Font Size', 'event_espresso'),
-                'href'   => '',
-                'meta'   => [
-                    'title'  => esc_html__('Set Font Size', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $this->menu_class,
-                ],
-            ]
-        );
-
-        $settings_admin_url = admin_url('admin.php?page=espresso_general_settings');
-
-        $font_sizes = [
-            'tiny'    => AdminFontSize::FONT_SIZE_TINY,
-            'smaller' => AdminFontSize::FONT_SIZE_SMALLER,
-            'small'   => AdminFontSize::FONT_SIZE_SMALL,
-            'default' => AdminFontSize::FONT_SIZE_DEFAULT,
-            'big'     => AdminFontSize::FONT_SIZE_BIG,
-            'bigger'  => AdminFontSize::FONT_SIZE_BIGGER,
-        ];
-
-        foreach ($font_sizes as $font_size => $value) {
-            $this->admin_bar->add_menu(
-                [
-                    'id'     => "espresso-toolbar-set-font-size-$font_size",
-                    'parent' => 'espresso-toolbar-font-size',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . sprintf(
-                                    /* translators: Font Size Small */
-                                    esc_html__('Font Size %1$s', 'event_espresso'),
-                                    ucwords($font_size)
-                                ),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        ['action' => 'set_font_size', 'font_size' => $value],
-                        $settings_admin_url
-                    ),
-                    'meta'   => [
-                        'title'  => esc_html__('increases or decreases the Event Espresso admin font size', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ],
-                ]
-            );
-        }
-    }
+	private ?WP_Admin_Bar   $admin_bar        = null;
+
+	private EE_Capabilities $capabilities;
+
+	private string          $events_admin_url = '';
+
+	private string          $menu_class       = 'espresso_menu_item_class';
+
+	private string          $reg_admin_url    = '';
+
+
+	/**
+	 * AdminToolBar constructor.
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+		add_action('admin_bar_menu', [$this, 'espressoToolbarItems'], 100);
+		$this->enqueueAssets();
+	}
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
+	{
+		// if it's an AJAX request, or user is NOT an admin, or in full M-Mode
+		if (
+			(defined('DOING_AJAX') && DOING_AJAX)
+			|| ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+			|| MaintenanceStatus::isFullSite()
+		) {
+			return;
+		}
+		$this->admin_bar = $admin_bar;
+		// we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		// because they're only defined in each of their respective constructors
+		// and this might be a frontend request, in which case they aren't available
+		$this->events_admin_url = admin_url('admin.php?page=espresso_events');
+		$this->reg_admin_url    = admin_url('admin.php?page=espresso_registrations');
+		// now let's add all the menu items
+		$this->addTopLevelMenu();
+		$this->addEventsSubMenu();
+		$this->addEventsAddEditHeader();
+		$this->addEventsAddNew();
+		$this->addEventsEditCurrentEvent();
+		$this->addEventsViewHeader();
+		$this->addEventsViewAll();
+		$this->addEventsViewToday();
+		$this->addEventsViewThisMonth();
+		$this->addRegistrationSubMenu();
+		$this->addRegistrationOverviewToday();
+		$this->addRegistrationOverviewTodayApproved();
+		$this->addRegistrationOverviewTodayPendingPayment();
+		$this->addRegistrationOverviewTodayNotApproved();
+		$this->addRegistrationOverviewTodayCancelled();
+		$this->addRegistrationOverviewThisMonth();
+		$this->addRegistrationOverviewThisMonthApproved();
+		$this->addRegistrationOverviewThisMonthPending();
+		$this->addRegistrationOverviewThisMonthNotApproved();
+		$this->addRegistrationOverviewThisMonthCancelled();
+		$this->addExtensionsAndServices();
+		$this->addFontSizeSubMenu();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function enqueueAssets()
+	{
+		wp_register_style(
+			'espresso-admin-toolbar',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+			['dashicons'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-admin-toolbar');
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addTopLevelMenu()
+	{
+		$this->admin_bar->add_menu(
+			[
+				'id'    => 'espresso-toolbar',
+				'title' => '<span class="ab-icon ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+						   . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+						   . '</span>',
+				'href'  => $this->events_admin_url,
+				'meta'  => [
+					'title' => esc_html__('Event Espresso', 'event_espresso'),
+					'class' => $this->menu_class . 'first',
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsSubMenu()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Events', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => [
+						'title'  => esc_html__('Events', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddEditHeader()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-view'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-add-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('Add / Edit', 'event_espresso'),
+					'href'   => '',
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddNew()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_edit_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-new'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-new',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Add New', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						['action' => 'create_new'],
+						$this->events_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Add New', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsEditCurrentEvent()
+	{
+		if (is_single() && (get_post_type() === EspressoPostType::EVENTS)) {
+			// Current post
+			global $post;
+			if (
+				$this->capabilities->current_user_can(
+					'ee_edit_event',
+					'ee_admin_bar_menu_espresso-toolbar-events-edit',
+					$post->ID
+				)
+			) {
+				$this->admin_bar->add_menu(
+					[
+						'id'     => 'espresso-toolbar-events-edit',
+						'parent' => 'espresso-toolbar-events',
+						'title'  => '<span class="ee-toolbar-icon"></span>'
+									. esc_html__('Edit Event', 'event_espresso'),
+						'href'   => EEH_URL::add_query_args_and_nonce(
+							[
+								'action' => 'edit',
+								'post'   => $post->ID,
+							],
+							$this->events_admin_url
+						),
+						'meta'   => [
+							'title'  => esc_html__('Edit Event', 'event_espresso'),
+							'target' => '',
+							'class'  => $this->menu_class,
+						],
+					]
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewHeader()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-view'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-view',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('View', 'event_espresso'),
+					'href'   => '',
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewAll()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-all'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-all',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('All', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => [
+						'title'  => esc_html__('All', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewToday()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-today'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-today',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Today', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action' => 'default',
+							'status' => 'today',
+						],
+						$this->events_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewThisMonth()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_events',
+				'ee_admin_bar_menu_espresso-toolbar-events-month'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-events-month',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('This Month', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action' => 'default',
+							'status' => 'month',
+						],
+						$this->events_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationSubMenu()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Registrations', 'event_espresso'),
+					'href'   => $this->reg_admin_url,
+					'meta'   => [
+						'title'  => esc_html__('Registrations', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewToday()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('Today', 'event_espresso'),
+					'href'   => '',
+					'meta'   => [
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => RegStatus::APPROVED,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayPendingPayment()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => RegStatus::PENDING_PAYMENT,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Pending Payment', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayNotApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => RegStatus::AWAITING_REVIEW,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayCancelled()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-today-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => RegStatus::CANCELLED,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonth()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('This Month', 'event_espresso'),
+					'href'   => '', // EEH_URL::add_query_args_and_nonce(
+					//     array(
+					//         'action' => 'default',
+					//         'status' => 'month'
+					//     ),
+					//     $this->reg_admin_url
+					// ),
+					'meta'   => [
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => RegStatus::APPROVED,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthPending()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => RegStatus::PENDING_PAYMENT,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Pending', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthNotApproved()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => RegStatus::AWAITING_REVIEW,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthCancelled()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_registrations',
+				'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-registrations-month-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						[
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => RegStatus::CANCELLED,
+						],
+						$this->reg_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addExtensionsAndServices()
+	{
+		if (
+			$this->capabilities->current_user_can(
+				'ee_read_ee',
+				'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
+			)
+		) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => 'espresso-toolbar-extensions-and-services',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Extensions & Services', 'event_espresso'),
+					'href'   => admin_url('admin.php?page=espresso_packages'),
+					'meta'   => [
+						'title'  => esc_html__('Extensions & Services', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addFontSizeSubMenu()
+	{
+		if (! is_admin()) {
+			return;
+		}
+		$this->admin_bar->add_menu(
+			[
+				'id'     => 'espresso-toolbar-font-size',
+				'parent' => 'espresso-toolbar',
+				'title'  => '<span class="ee-toolbar-icon"></span>'
+							. esc_html__('Set Font Size', 'event_espresso'),
+				'href'   => '',
+				'meta'   => [
+					'title'  => esc_html__('Set Font Size', 'event_espresso'),
+					'target' => '',
+					'class'  => $this->menu_class,
+				],
+			]
+		);
+
+		$settings_admin_url = admin_url('admin.php?page=espresso_general_settings');
+
+		$font_sizes = [
+			'tiny'    => AdminFontSize::FONT_SIZE_TINY,
+			'smaller' => AdminFontSize::FONT_SIZE_SMALLER,
+			'small'   => AdminFontSize::FONT_SIZE_SMALL,
+			'default' => AdminFontSize::FONT_SIZE_DEFAULT,
+			'big'     => AdminFontSize::FONT_SIZE_BIG,
+			'bigger'  => AdminFontSize::FONT_SIZE_BIGGER,
+		];
+
+		foreach ($font_sizes as $font_size => $value) {
+			$this->admin_bar->add_menu(
+				[
+					'id'     => "espresso-toolbar-set-font-size-$font_size",
+					'parent' => 'espresso-toolbar-font-size',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. sprintf(
+									/* translators: Font Size Small */
+									esc_html__('Font Size %1$s', 'event_espresso'),
+									ucwords($font_size)
+								),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						['action' => 'set_font_size', 'font_size' => $value],
+						$settings_admin_url
+					),
+					'meta'   => [
+						'title'  => esc_html__('increases or decreases the Event Espresso admin font size', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					],
+				]
+			);
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -20,7 +20,7 @@ 
  */
 class AdminToolBar
 {
-    private ?WP_Admin_Bar   $admin_bar        = null;
+    private ?WP_Admin_Bar   $admin_bar = null;
 
     private EE_Capabilities $capabilities;
 
@@ -100,7 +100,7 @@ 
     {
         wp_register_style(
             'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-admin-toolbar.css',
             ['dashicons'],
             EVENT_ESPRESSO_VERSION
         );
@@ -122,7 +122,7 @@ 
                 'href'  => $this->events_admin_url,
                 'meta'  => [
                     'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
+                    'class' => $this->menu_class.'first',
                 ],
             ]
         );
@@ -460,7 +460,7 @@ 
                     'meta'   => [
                         'title'  => esc_html__('Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-approved',
                     ],
                 ]
             );
@@ -496,7 +496,7 @@ 
                     'meta'   => [
                         'title'  => esc_html__('Pending Payment', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-pending',
                     ],
                 ]
             );
@@ -532,7 +532,7 @@ 
                     'meta'   => [
                         'title'  => esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-not-approved',
                     ],
                 ]
             );
@@ -568,7 +568,7 @@ 
                     'meta'   => [
                         'title'  => esc_html__('Cancelled', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-cancelled',
                     ],
                 ]
             );
@@ -638,7 +638,7 @@ 
                     'meta'   => [
                         'title'  => esc_html__('Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-approved',
                     ],
                 ]
             );
@@ -674,7 +674,7 @@ 
                     'meta'   => [
                         'title'  => esc_html__('Pending', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-pending',
                     ],
                 ]
             );
@@ -710,7 +710,7 @@ 
                     'meta'   => [
                         'title'  => esc_html__('Not Approved / Awaiting Review', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-not-approved',
                     ],
                 ]
             );
@@ -746,7 +746,7 @@ 
                     'meta'   => [
                         'title'  => esc_html__('Cancelled', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-cancelled',
                     ],
                 ]
             );
@@ -788,7 +788,7 @@ 
      */
     private function addFontSizeSubMenu()
     {
-        if (! is_admin()) {
+        if ( ! is_admin()) {
             return;
         }
         $this->admin_bar->add_menu(

core/domain/services/admin/menu/AdminMenuManager.php

Indentation +430 added lines, -430 removed lines

@@ -15,434 +15,434 @@
 
 class AdminMenuManager
 {
-    /**
-     * Default: null - defaults to below Comments
-     *
-     * 5 - below Posts
-     * 10 - below Media
-     * 15 - below Links
-     * 20 - below Pages
-     * 25 - below comments
-     * 60 - below first separator
-     * 65 - below Plugins
-     * 70 - below Users
-     * 75 - below Tools
-     * 80 - below Settings
-     * 100 - below second separator
-     */
-    const DEFAULT_MENU_POSITION = 100;
-
-
-    /**
-     * @var AdminMenuItem[]
-     */
-    private array $menu_items = [];
-
-    /**
-     * objects for page_init objects detected and loaded
-     *
-     * @var EE_Admin_Page_Init[]
-     */
-    private array $installed_pages = [];
-
-    /**
-     * set to TRUE if site is currently in maintenance mode level 2
-     *
-     * @var bool
-     */
-    protected bool $maintenance_mode = false;
-
-    /**
-     * same values used by AdminMenuManager::DEFAULT_MENU_POSITION
-     *
-     * @var int
-     */
-    private int $menu_position;
-
-    /**
-     * @var AdminMenuItem
-     */
-    private AdminMenuItem $top_level_menu_item;
-
-
-    public function __construct()
-    {
-    }
-
-
-    public function initialize()
-    {
-        $this->maintenance_mode = MaintenanceStatus::isFullSite();
-        $this->menu_position = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_admin_menu_AdminMenuManager__initialize__menu_position',
-            AdminMenuManager::DEFAULT_MENU_POSITION,
-            $this->maintenance_mode
-        );
-        $this->addTopLevelMenuItem();
-        $this->initializeMenuGroups();
-        add_action('admin_menu', [$this, 'generateAdminMenu']);
-        add_action('network_admin_menu', [$this, 'generateNetworkAdminMenu']);
-        add_filter('custom_menu_order', '__return_true');
-        add_filter('menu_order', [$this, 'reorderAdminMenu']);
-    }
-
-
-    /**
-     * adds the top level menu item that everything else descends from.
-     * changes depending on whether site is in full maintenance mode or not
-     *
-     * @return void
-     */
-    private function addTopLevelMenuItem()
-    {
-        $this->top_level_menu_item = $this->maintenance_mode
-            ? $this->instantiateAdminMenu(
-                [
-                    'menu_slug'    => 'espresso_maintenance_settings',
-                    'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
-                    'capability'   => 'manage_options',
-                    'menu_group'   => 'main',
-                    'menu_order'   => 10,
-                    'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
-                    'parent_slug'  => 'espresso_maintenance_settings',
-                    'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                ]
-            )
-            : $this->instantiateAdminMenu(
-                [
-                    'menu_slug'    => 'espresso_events',
-                    'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
-                    'capability'   => 'ee_read_events',
-                    'menu_group'   => 'main',
-                    'menu_order'   => 10,
-                    'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
-                    'parent_slug'  => 'espresso_events',
-                    'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                ]
-            );
-    }
-
-
-    /**
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @return void
-     */
-    private function initializeMenuGroups()
-    {
-        $this->menu_items = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            [
-                'main'       => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'               => 'main',
-                        'menu_label'              => esc_html__('Main', 'event_espresso'),
-                        'capability'              => $this->maintenance_mode ? 'manage_options' : 'ee_read_ee',
-                        'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                        'menu_order'              => 0,
-                        'parent_slug'             => 'espresso_events',
-                        'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
-                    ]
-                ),
-                'management' => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'management',
-                        'menu_label'   => esc_html__('Management', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 10,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                'addons'     => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'addons',
-                        'menu_label'   => esc_html__('Add-ons', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 20,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
-                    ]
-                ),
-                'settings'   => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'settings',
-                        'menu_label'   => esc_html__('Settings', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 30,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                'templates'  => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'templates',
-                        'menu_label'   => esc_html__('Templates', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 40,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-                'extras'     => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'               => 'extras',
-                        'menu_label'              => esc_html__('Extras', 'event_espresso'),
-                        'capability'              => 'ee_read_ee',
-                        'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                        'menu_order'              => 50,
-                        'parent_slug'             => 'espresso_events',
-                        'show_on_menu'            => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
-                    ]
-                ),
-                'tools'      => $this->instantiateAdminMenu(
-                    [
-                        'menu_slug'    => 'tools',
-                        'menu_label'   => esc_html__('Tools', 'event_espresso'),
-                        'capability'   => 'ee_read_ee',
-                        'menu_order'   => 60,
-                        'parent_slug'  => 'espresso_events',
-                        'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * adds an AdminMenuItem
-     *
-     * @param AdminMenuItem $admin_menu_item
-     * @return AdminMenuItem
-     */
-    public function addAdminMenuItem(AdminMenuItem $admin_menu_item): AdminMenuItem
-    {
-        // get the menu group that this menu item belongs to and then add it
-        $admin_group = $this->getMenuGroup($admin_menu_item);
-        $admin_group->addMenuItem($admin_menu_item);
-        return $admin_menu_item;
-    }
-
-
-    /**
-     * instantiates and returns the appropriate AdminMenuItem for the provided EE_Admin_Page_Init
-     *
-     * @param EE_Admin_Page_Init $admin_page_init
-     * @return AdminMenuItem
-     */
-    public function getAdminMenu(EE_Admin_Page_Init $admin_page_init): AdminMenuItem
-    {
-        // see if admin page init is using new classes
-        $menu_properties = $admin_page_init->getMenuProperties();
-        if (empty($menu_properties)) {
-            // no? ok setup the admin menu item the old way
-            $admin_page_init->setupLegacyAdminMenuItem();
-        } else {
-            // adding the admin page init callback here means the menu doesn't have to cart that object around
-            $menu_properties['menu_callback'] = [$admin_page_init, 'initialize_admin_page'];
-            $admin_page_init->setAdminMenu($this->instantiateAdminMenu($menu_properties));
-        }
-        $admin_menu = $admin_page_init->adminMenu();
-        if (! $admin_menu instanceof AdminMenuItem) {
-            throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
-        }
-        if (! is_callable($admin_menu->menuCallback())) {
-            $admin_menu->setMenuCallback([$admin_page_init, 'initialize_admin_page']);
-        }
-        // get the menu group that this menu item belongs to and then add it
-        $admin_group = $this->getMenuGroup($admin_menu);
-        $admin_group->addMenuItem($admin_menu);
-        return $admin_menu;
-    }
-
-
-    /**
-     * @param array $menu_properties
-     * @return AdminMenuItem|null
-     */
-    private function instantiateAdminMenu(array $menu_properties): ?AdminMenuItem
-    {
-        $type = $menu_properties['menu_type'] ?? AdminMenuItem::TYPE_MENU_GROUP;
-        unset($menu_properties['menu_type']);
-        switch ($type) {
-            case AdminMenuItem::TYPE_MENU_GROUP:
-                unset($menu_properties['menu_callback']);
-                return new AdminMenuGroup($menu_properties);
-            case AdminMenuItem::TYPE_MENU_TOP:
-                return new AdminMenuTopLevel($menu_properties);
-            case AdminMenuItem::TYPE_MENU_SUB_ITEM:
-                return new AdminMenuSubItem($menu_properties);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param AdminMenuItem $admin_menu
-     * @return AdminMenuGroup
-     * @throws DomainException
-     * @throws OutOfRangeException
-     */
-    private function getMenuGroup(AdminMenuItem $admin_menu): AdminMenuGroup
-    {
-        if (! isset($this->menu_items[ $admin_menu->menuGroup() ])) {
-            throw new OutOfRangeException(esc_html__('AdminMenuGroup does not exist', 'event_espresso'));
-        }
-        $admin_group = $this->menu_items[ $admin_menu->menuGroup() ];
-        if (! $admin_group instanceof AdminMenuGroup) {
-            throw new DomainException(esc_html__('Invalid AdminMenuGroup found', 'event_espresso'));
-        }
-        return $admin_group;
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function generateNetworkAdminMenu()
-    {
-        $this->generateAdminMenu(true);
-    }
-
-
-    /**
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function generateAdminMenu(bool $network_admin = false)
-    {
-        $admin_menu = $this->sortMenu($this->menu_items);
-        $this->top_level_menu_item->registerAdminMenuItem($network_admin);
-        $this->registerAdminMenu($admin_menu, $network_admin);
-    }
-
-
-    /**
-     * @param array $admin_menu
-     * @param bool  $network_admin
-     */
-    private function registerAdminMenu(array $admin_menu, bool $network_admin)
-    {
-        foreach ($admin_menu as $menu_item) {
-            if ($this->skipMenuItem($menu_item)) {
-                continue;
-            }
-            try {
-                $wp_page_slug    = $menu_item->registerAdminMenuItem($network_admin);
-                $admin_init_page = $this->installed_pages[ $menu_item->menuSlug() ] ?? null;
-                if ($wp_page_slug && $admin_init_page instanceof EE_Admin_Page_Init) {
-                    $admin_init_page->setWpPageSlug($wp_page_slug);
-                    $admin_init_page->set_page_dependencies($wp_page_slug);
-                }
-                if ($menu_item instanceof AdminMenuGroup) {
-                    $this->registerAdminMenu($menu_item->getMenuItems(), $network_admin);
-                }
-            } catch (Exception $e) {
-                EE_Error::add_error($e->getMessage(), $e->getFile(), __FUNCTION__, $e->getLine());
-            }
-        }
-    }
-
-
-    /**
-     * returns TRUE if any of the following conditions is met:
-     * - menu item is NOT an instanceof AdminMenuItem
-     * - menu item has already been registered
-     * - menu item should not be shown when site is in full maintenance mode
-     * - current user does not have the required access permission
-     * - menu item is a group but has no sub items
-     *
-     * @param AdminMenuItem|null $menu_item
-     * @return bool
-     */
-    private function skipMenuItem(?AdminMenuItem $menu_item): bool
-    {
-        return ! $menu_item instanceof AdminMenuItem
-               || $menu_item->isRegistered()
-               || ! $menu_item->showOnMaintenanceModeMenu()
-               || ! $menu_item->currentUserHasAccess()
-               || (
-                   $menu_item instanceof AdminMenuGroup
-                   && $menu_item->hasNoMenuItems()
-               );
-    }
-
-
-    /**
-     * @param EE_Admin_Page_Init[] $installed_pages
-     */
-    public function setInstalledPages(array $installed_pages): void
-    {
-        $this->installed_pages = $installed_pages;
-    }
-
-
-    /**
-     * Recursively sort menu groups and their sub items
-     *
-     * @return AdminMenuItem[]
-     * @throws DomainException
-     */
-    public function sortMenu(array $admin_menu): array
-    {
-        foreach ($admin_menu as $menu_group) {
-            if (! $menu_group instanceof AdminMenuItem) {
-                throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
-            }
-            if ($menu_group instanceof AdminMenuGroup) {
-                // sort sub items
-                $menu_items = $this->sortMenu($menu_group->getMenuItems());
-                $menu_group->setMenuItems($menu_items);
-            }
-        }
-        // sort incoming array AFTER it's been looped through and elements have been validated
-        usort($admin_menu, [$this, 'sortMenuItems']);
-        return $admin_menu;
-    }
-
-
-    /**
-     *  sort sub menu items
-     *
-     * @param AdminMenuItem $a menu_item
-     * @param AdminMenuItem $b being compared to
-     * @return int    sort order
-     */
-    private function sortMenuItems(AdminMenuItem $a, AdminMenuItem $b): int
-    {
-        if ($a->menuOrder() === $b->menuOrder()) {
-            return 0;
-        }
-        return $a->menuOrder() < $b->menuOrder() ? -1 : 1;
-    }
-
-
-    /**
-     * Moves the Event Espresso admin menu to the position set by $this->menu_position
-     *
-     * @param array $menu_order
-     * @return array
-     */
-    public function reorderAdminMenu(array $menu_order): array
-    {
-        $menu_slug     = $this->maintenance_mode ? 'espresso_maintenance_settings' : 'espresso_events';
-        $current_index = array_search($menu_slug, $menu_order);
-        if ($current_index === false) {
-            return $menu_order;
-        }
-        // chop out the espresso admin menu if found
-        $espresso_menu = array_splice($menu_order, $current_index, 1);
-        // reinsert at position set by $this->menu_position
-        array_splice($menu_order, $this->menu_position, 0, $espresso_menu);
-        return $menu_order;
-    }
+	/**
+	 * Default: null - defaults to below Comments
+	 *
+	 * 5 - below Posts
+	 * 10 - below Media
+	 * 15 - below Links
+	 * 20 - below Pages
+	 * 25 - below comments
+	 * 60 - below first separator
+	 * 65 - below Plugins
+	 * 70 - below Users
+	 * 75 - below Tools
+	 * 80 - below Settings
+	 * 100 - below second separator
+	 */
+	const DEFAULT_MENU_POSITION = 100;
+
+
+	/**
+	 * @var AdminMenuItem[]
+	 */
+	private array $menu_items = [];
+
+	/**
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @var EE_Admin_Page_Init[]
+	 */
+	private array $installed_pages = [];
+
+	/**
+	 * set to TRUE if site is currently in maintenance mode level 2
+	 *
+	 * @var bool
+	 */
+	protected bool $maintenance_mode = false;
+
+	/**
+	 * same values used by AdminMenuManager::DEFAULT_MENU_POSITION
+	 *
+	 * @var int
+	 */
+	private int $menu_position;
+
+	/**
+	 * @var AdminMenuItem
+	 */
+	private AdminMenuItem $top_level_menu_item;
+
+
+	public function __construct()
+	{
+	}
+
+
+	public function initialize()
+	{
+		$this->maintenance_mode = MaintenanceStatus::isFullSite();
+		$this->menu_position = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_admin_menu_AdminMenuManager__initialize__menu_position',
+			AdminMenuManager::DEFAULT_MENU_POSITION,
+			$this->maintenance_mode
+		);
+		$this->addTopLevelMenuItem();
+		$this->initializeMenuGroups();
+		add_action('admin_menu', [$this, 'generateAdminMenu']);
+		add_action('network_admin_menu', [$this, 'generateNetworkAdminMenu']);
+		add_filter('custom_menu_order', '__return_true');
+		add_filter('menu_order', [$this, 'reorderAdminMenu']);
+	}
+
+
+	/**
+	 * adds the top level menu item that everything else descends from.
+	 * changes depending on whether site is in full maintenance mode or not
+	 *
+	 * @return void
+	 */
+	private function addTopLevelMenuItem()
+	{
+		$this->top_level_menu_item = $this->maintenance_mode
+			? $this->instantiateAdminMenu(
+				[
+					'menu_slug'    => 'espresso_maintenance_settings',
+					'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
+					'capability'   => 'manage_options',
+					'menu_group'   => 'main',
+					'menu_order'   => 10,
+					'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
+					'parent_slug'  => 'espresso_maintenance_settings',
+					'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+				]
+			)
+			: $this->instantiateAdminMenu(
+				[
+					'menu_slug'    => 'espresso_events',
+					'menu_label'   => esc_html__('Event Espresso', 'event_espresso'),
+					'capability'   => 'ee_read_events',
+					'menu_group'   => 'main',
+					'menu_order'   => 10,
+					'menu_type'    => AdminMenuItem::TYPE_MENU_TOP,
+					'parent_slug'  => 'espresso_events',
+					'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+				]
+			);
+	}
+
+
+	/**
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @return void
+	 */
+	private function initializeMenuGroups()
+	{
+		$this->menu_items = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			[
+				'main'       => $this->instantiateAdminMenu(
+					[
+						'menu_slug'               => 'main',
+						'menu_label'              => esc_html__('Main', 'event_espresso'),
+						'capability'              => $this->maintenance_mode ? 'manage_options' : 'ee_read_ee',
+						'maintenance_mode_parent' => 'espresso_maintenance_settings',
+						'menu_order'              => 0,
+						'parent_slug'             => 'espresso_events',
+						'show_on_menu'            => AdminMenuItem::DISPLAY_NONE,
+					]
+				),
+				'management' => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'management',
+						'menu_label'   => esc_html__('Management', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 10,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				'addons'     => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'addons',
+						'menu_label'   => esc_html__('Add-ons', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 20,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
+					]
+				),
+				'settings'   => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'settings',
+						'menu_label'   => esc_html__('Settings', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 30,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				'templates'  => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'templates',
+						'menu_label'   => esc_html__('Templates', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 40,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+				'extras'     => $this->instantiateAdminMenu(
+					[
+						'menu_slug'               => 'extras',
+						'menu_label'              => esc_html__('Extras', 'event_espresso'),
+						'capability'              => 'ee_read_ee',
+						'maintenance_mode_parent' => 'espresso_maintenance_settings',
+						'menu_order'              => 50,
+						'parent_slug'             => 'espresso_events',
+						'show_on_menu'            => AdminMenuItem::DISPLAY_BLOG_AND_NETWORK,
+					]
+				),
+				'tools'      => $this->instantiateAdminMenu(
+					[
+						'menu_slug'    => 'tools',
+						'menu_label'   => esc_html__('Tools', 'event_espresso'),
+						'capability'   => 'ee_read_ee',
+						'menu_order'   => 60,
+						'parent_slug'  => 'espresso_events',
+						'show_on_menu' => AdminMenuItem::DISPLAY_BLOG_ONLY,
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * adds an AdminMenuItem
+	 *
+	 * @param AdminMenuItem $admin_menu_item
+	 * @return AdminMenuItem
+	 */
+	public function addAdminMenuItem(AdminMenuItem $admin_menu_item): AdminMenuItem
+	{
+		// get the menu group that this menu item belongs to and then add it
+		$admin_group = $this->getMenuGroup($admin_menu_item);
+		$admin_group->addMenuItem($admin_menu_item);
+		return $admin_menu_item;
+	}
+
+
+	/**
+	 * instantiates and returns the appropriate AdminMenuItem for the provided EE_Admin_Page_Init
+	 *
+	 * @param EE_Admin_Page_Init $admin_page_init
+	 * @return AdminMenuItem
+	 */
+	public function getAdminMenu(EE_Admin_Page_Init $admin_page_init): AdminMenuItem
+	{
+		// see if admin page init is using new classes
+		$menu_properties = $admin_page_init->getMenuProperties();
+		if (empty($menu_properties)) {
+			// no? ok setup the admin menu item the old way
+			$admin_page_init->setupLegacyAdminMenuItem();
+		} else {
+			// adding the admin page init callback here means the menu doesn't have to cart that object around
+			$menu_properties['menu_callback'] = [$admin_page_init, 'initialize_admin_page'];
+			$admin_page_init->setAdminMenu($this->instantiateAdminMenu($menu_properties));
+		}
+		$admin_menu = $admin_page_init->adminMenu();
+		if (! $admin_menu instanceof AdminMenuItem) {
+			throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
+		}
+		if (! is_callable($admin_menu->menuCallback())) {
+			$admin_menu->setMenuCallback([$admin_page_init, 'initialize_admin_page']);
+		}
+		// get the menu group that this menu item belongs to and then add it
+		$admin_group = $this->getMenuGroup($admin_menu);
+		$admin_group->addMenuItem($admin_menu);
+		return $admin_menu;
+	}
+
+
+	/**
+	 * @param array $menu_properties
+	 * @return AdminMenuItem|null
+	 */
+	private function instantiateAdminMenu(array $menu_properties): ?AdminMenuItem
+	{
+		$type = $menu_properties['menu_type'] ?? AdminMenuItem::TYPE_MENU_GROUP;
+		unset($menu_properties['menu_type']);
+		switch ($type) {
+			case AdminMenuItem::TYPE_MENU_GROUP:
+				unset($menu_properties['menu_callback']);
+				return new AdminMenuGroup($menu_properties);
+			case AdminMenuItem::TYPE_MENU_TOP:
+				return new AdminMenuTopLevel($menu_properties);
+			case AdminMenuItem::TYPE_MENU_SUB_ITEM:
+				return new AdminMenuSubItem($menu_properties);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param AdminMenuItem $admin_menu
+	 * @return AdminMenuGroup
+	 * @throws DomainException
+	 * @throws OutOfRangeException
+	 */
+	private function getMenuGroup(AdminMenuItem $admin_menu): AdminMenuGroup
+	{
+		if (! isset($this->menu_items[ $admin_menu->menuGroup() ])) {
+			throw new OutOfRangeException(esc_html__('AdminMenuGroup does not exist', 'event_espresso'));
+		}
+		$admin_group = $this->menu_items[ $admin_menu->menuGroup() ];
+		if (! $admin_group instanceof AdminMenuGroup) {
+			throw new DomainException(esc_html__('Invalid AdminMenuGroup found', 'event_espresso'));
+		}
+		return $admin_group;
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function generateNetworkAdminMenu()
+	{
+		$this->generateAdminMenu(true);
+	}
+
+
+	/**
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function generateAdminMenu(bool $network_admin = false)
+	{
+		$admin_menu = $this->sortMenu($this->menu_items);
+		$this->top_level_menu_item->registerAdminMenuItem($network_admin);
+		$this->registerAdminMenu($admin_menu, $network_admin);
+	}
+
+
+	/**
+	 * @param array $admin_menu
+	 * @param bool  $network_admin
+	 */
+	private function registerAdminMenu(array $admin_menu, bool $network_admin)
+	{
+		foreach ($admin_menu as $menu_item) {
+			if ($this->skipMenuItem($menu_item)) {
+				continue;
+			}
+			try {
+				$wp_page_slug    = $menu_item->registerAdminMenuItem($network_admin);
+				$admin_init_page = $this->installed_pages[ $menu_item->menuSlug() ] ?? null;
+				if ($wp_page_slug && $admin_init_page instanceof EE_Admin_Page_Init) {
+					$admin_init_page->setWpPageSlug($wp_page_slug);
+					$admin_init_page->set_page_dependencies($wp_page_slug);
+				}
+				if ($menu_item instanceof AdminMenuGroup) {
+					$this->registerAdminMenu($menu_item->getMenuItems(), $network_admin);
+				}
+			} catch (Exception $e) {
+				EE_Error::add_error($e->getMessage(), $e->getFile(), __FUNCTION__, $e->getLine());
+			}
+		}
+	}
+
+
+	/**
+	 * returns TRUE if any of the following conditions is met:
+	 * - menu item is NOT an instanceof AdminMenuItem
+	 * - menu item has already been registered
+	 * - menu item should not be shown when site is in full maintenance mode
+	 * - current user does not have the required access permission
+	 * - menu item is a group but has no sub items
+	 *
+	 * @param AdminMenuItem|null $menu_item
+	 * @return bool
+	 */
+	private function skipMenuItem(?AdminMenuItem $menu_item): bool
+	{
+		return ! $menu_item instanceof AdminMenuItem
+			   || $menu_item->isRegistered()
+			   || ! $menu_item->showOnMaintenanceModeMenu()
+			   || ! $menu_item->currentUserHasAccess()
+			   || (
+				   $menu_item instanceof AdminMenuGroup
+				   && $menu_item->hasNoMenuItems()
+			   );
+	}
+
+
+	/**
+	 * @param EE_Admin_Page_Init[] $installed_pages
+	 */
+	public function setInstalledPages(array $installed_pages): void
+	{
+		$this->installed_pages = $installed_pages;
+	}
+
+
+	/**
+	 * Recursively sort menu groups and their sub items
+	 *
+	 * @return AdminMenuItem[]
+	 * @throws DomainException
+	 */
+	public function sortMenu(array $admin_menu): array
+	{
+		foreach ($admin_menu as $menu_group) {
+			if (! $menu_group instanceof AdminMenuItem) {
+				throw new DomainException(esc_html__('Invalid AdminMenuItem', 'event_espresso'));
+			}
+			if ($menu_group instanceof AdminMenuGroup) {
+				// sort sub items
+				$menu_items = $this->sortMenu($menu_group->getMenuItems());
+				$menu_group->setMenuItems($menu_items);
+			}
+		}
+		// sort incoming array AFTER it's been looped through and elements have been validated
+		usort($admin_menu, [$this, 'sortMenuItems']);
+		return $admin_menu;
+	}
+
+
+	/**
+	 *  sort sub menu items
+	 *
+	 * @param AdminMenuItem $a menu_item
+	 * @param AdminMenuItem $b being compared to
+	 * @return int    sort order
+	 */
+	private function sortMenuItems(AdminMenuItem $a, AdminMenuItem $b): int
+	{
+		if ($a->menuOrder() === $b->menuOrder()) {
+			return 0;
+		}
+		return $a->menuOrder() < $b->menuOrder() ? -1 : 1;
+	}
+
+
+	/**
+	 * Moves the Event Espresso admin menu to the position set by $this->menu_position
+	 *
+	 * @param array $menu_order
+	 * @return array
+	 */
+	public function reorderAdminMenu(array $menu_order): array
+	{
+		$menu_slug     = $this->maintenance_mode ? 'espresso_maintenance_settings' : 'espresso_events';
+		$current_index = array_search($menu_slug, $menu_order);
+		if ($current_index === false) {
+			return $menu_order;
+		}
+		// chop out the espresso admin menu if found
+		$espresso_menu = array_splice($menu_order, $current_index, 1);
+		// reinsert at position set by $this->menu_position
+		array_splice($menu_order, $this->menu_position, 0, $espresso_menu);
+		return $menu_order;
+	}
 }

core/domain/services/wp_queries/EventListQuery.php

Indentation +164 added lines, -164 removed lines

@@ -16,168 +16,168 @@
  */
 class EventListQuery extends WP_Query
 {
-    private ?string $title = '';
-
-    private int $limit = 10;
-
-    private ?string $css_class = '';
-
-    private bool $show_expired = false;
-
-    private ?string $month = '';
-
-    private ?string $category_slug = '';
-
-    /**
-     * @var array|string|null
-     */
-    private $order_by =[];
-
-    private ?string $sort = '';
-
-    private bool $show_title = true;
-
-
-    /**
-     * EE_Event_List_Query Constructor     *
-     *
-     * @param array $args
-     */
-    public function __construct($args = [])
-    {
-        $args = $this->parseArgs((array) $args);
-        $this->setupEventQueryHelper();
-        $this->setupFilters();
-        $args = $this->getQueryArgs($args);
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * @param array $args
-     * @return array
-     */
-    private function parseArgs(array $args): array
-    {
-        // incoming args could be a mix of WP query args + EE shortcode args
-        foreach ($args as $property => $value) {
-            // if the arg is a property of this class, then it's an EE shortcode arg
-            if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
-                // set the property value
-                $this->{$property} = $value;
-                // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
-            }
-        }
-        return $args;
-    }
-
-
-    private function setupEventQueryHelper()
-    {
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            $this->month,
-            $this->category_slug,
-            $this->show_expired,
-            $this->order_by,
-            $this->sort
-        );
-    }
-
-
-    private function setupFilters()
-    {
-        // first off, let's remove any filters from previous queries
-        remove_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            [$this, 'show_event_list_title']
-        );
-        remove_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            [$this, 'event_list_title']
-        );
-        remove_all_filters('FHEE__content_espresso_events__event_class');
-        // Event List Title ?
-        add_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            [$this, 'show_event_list_title']
-        );
-        add_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            [$this, 'event_list_title']
-        );
-        // add the css class
-        add_filter(
-            'FHEE__content_espresso_events__event_class',
-            [$this, 'event_list_css']
-        );
-    }
-
-
-    private function getQueryArgs(array $args): array
-    {
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        return array_merge(
-            $args,
-            [
-                'post_type'              => EspressoPostType::EVENTS,
-                'posts_per_page'         => $this->limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $this->limit,
-            ]
-        );
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-
-    /**
-     * show_event_list_title
-     *
-     * @return boolean
-     */
-    public function show_event_list_title(): bool
-    {
-        return filter_var($this->show_title, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
-     *
-     * @param string $event_list_title
-     * @return    string
-     */
-    public function event_list_title(string $event_list_title = ''): string
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * callback for FHEE__content_espresso_events__event_class filter
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css(string $event_list_css = ''): string
-    {
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
-        return $event_list_css;
-    }
-    // phpcs:enable
+	private ?string $title = '';
+
+	private int $limit = 10;
+
+	private ?string $css_class = '';
+
+	private bool $show_expired = false;
+
+	private ?string $month = '';
+
+	private ?string $category_slug = '';
+
+	/**
+	 * @var array|string|null
+	 */
+	private $order_by =[];
+
+	private ?string $sort = '';
+
+	private bool $show_title = true;
+
+
+	/**
+	 * EE_Event_List_Query Constructor     *
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = [])
+	{
+		$args = $this->parseArgs((array) $args);
+		$this->setupEventQueryHelper();
+		$this->setupFilters();
+		$args = $this->getQueryArgs($args);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * @param array $args
+	 * @return array
+	 */
+	private function parseArgs(array $args): array
+	{
+		// incoming args could be a mix of WP query args + EE shortcode args
+		foreach ($args as $property => $value) {
+			// if the arg is a property of this class, then it's an EE shortcode arg
+			if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
+				// set the property value
+				$this->{$property} = $value;
+				// then remove it from the array of args that will later be passed to WP_Query()
+				unset($args[ $property ]);
+			}
+		}
+		return $args;
+	}
+
+
+	private function setupEventQueryHelper()
+	{
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			$this->month,
+			$this->category_slug,
+			$this->show_expired,
+			$this->order_by,
+			$this->sort
+		);
+	}
+
+
+	private function setupFilters()
+	{
+		// first off, let's remove any filters from previous queries
+		remove_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			[$this, 'show_event_list_title']
+		);
+		remove_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			[$this, 'event_list_title']
+		);
+		remove_all_filters('FHEE__content_espresso_events__event_class');
+		// Event List Title ?
+		add_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			[$this, 'show_event_list_title']
+		);
+		add_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			[$this, 'event_list_title']
+		);
+		// add the css class
+		add_filter(
+			'FHEE__content_espresso_events__event_class',
+			[$this, 'event_list_css']
+		);
+	}
+
+
+	private function getQueryArgs(array $args): array
+	{
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		return array_merge(
+			$args,
+			[
+				'post_type'              => EspressoPostType::EVENTS,
+				'posts_per_page'         => $this->limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $this->limit,
+			]
+		);
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+
+	/**
+	 * show_event_list_title
+	 *
+	 * @return boolean
+	 */
+	public function show_event_list_title(): bool
+	{
+		return filter_var($this->show_title, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
+	 *
+	 * @param string $event_list_title
+	 * @return    string
+	 */
+	public function event_list_title(string $event_list_title = ''): string
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * callback for FHEE__content_espresso_events__event_class filter
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css(string $event_list_css = ''): string
+	{
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
+		return $event_list_css;
+	}
+	// phpcs:enable
 }

Spacing +3 added lines, -3 removed lines

@@ -31,7 +31,7 @@ 
     /**
      * @var array|string|null
      */
-    private $order_by =[];
+    private $order_by = [];
 
     private ?string $sort = '';
 
@@ -67,7 +67,7 @@ 
                 // set the property value
                 $this->{$property} = $value;
                 // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
+                unset($args[$property]);
             }
         }
         return $args;
@@ -158,7 +158,7 @@ 
      */
     public function event_list_title(string $event_list_title = ''): string
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;