eventespresso / event-espresso-core

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_checkins.dmsstage.php

Indentation +178 added lines, -178 removed lines

@@ -27,186 +27,186 @@
 class EE_DMS_4_1_0_checkins extends EE_Data_Migration_Script_Stage_Table
 {
 
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name      = esc_html__('Check-ins', 'event_espresso');
-        $this->_old_table        = $wpdb->prefix . "events_attendee";
-        $this->select_expression = 'att.*, e.event_status';
-        $this->_extra_where_sql  = 'AS att
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name      = esc_html__('Check-ins', 'event_espresso');
+		$this->_old_table        = $wpdb->prefix . "events_attendee";
+		$this->select_expression = 'att.*, e.event_status';
+		$this->_extra_where_sql  = 'AS att
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_new_table        = $wpdb->prefix . "esp_checkin";
-        parent::__construct();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _migrate_old_row($old_row)
-    {
-        global $wpdb;
-        $new_reg_table = $wpdb->prefix . "esp_registration";
-
-        $num_to_checkin_at_this_time = max([intval($old_row['checked_in_quantity']), intval($old_row['checked_in'])]);
-
-        $new_registrations_for_attendee =
-            $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table);
-        if (! $new_registrations_for_attendee) {
-            $new_registrations_for_attendee = [];
-        }
-        $new_datetime = $this->_try_to_find_datetime($old_row);
-
-        // make sure registrations array is numerically indexed starting at 0 (it probably already is)
-        $new_registrations_for_attendee = array_values($new_registrations_for_attendee);
-        $new_checkin_ids                = [];
-        for ($i = 0; $i < abs($num_to_checkin_at_this_time); $i++) {
-            $new_reg_id = $new_registrations_for_attendee[ $i ];
-            if (! $new_reg_id) {
-                $this->add_error(
-                    sprintf(
-                        esc_html__(
-                        /* translators: %1$s database row represented in JSON, %2$s number of registrations to check in
+		$this->_new_table        = $wpdb->prefix . "esp_checkin";
+		parent::__construct();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _migrate_old_row($old_row)
+	{
+		global $wpdb;
+		$new_reg_table = $wpdb->prefix . "esp_registration";
+
+		$num_to_checkin_at_this_time = max([intval($old_row['checked_in_quantity']), intval($old_row['checked_in'])]);
+
+		$new_registrations_for_attendee =
+			$this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table);
+		if (! $new_registrations_for_attendee) {
+			$new_registrations_for_attendee = [];
+		}
+		$new_datetime = $this->_try_to_find_datetime($old_row);
+
+		// make sure registrations array is numerically indexed starting at 0 (it probably already is)
+		$new_registrations_for_attendee = array_values($new_registrations_for_attendee);
+		$new_checkin_ids                = [];
+		for ($i = 0; $i < abs($num_to_checkin_at_this_time); $i++) {
+			$new_reg_id = $new_registrations_for_attendee[ $i ];
+			if (! $new_reg_id) {
+				$this->add_error(
+					sprintf(
+						esc_html__(
+						/* translators: %1$s database row represented in JSON, %2$s number of registrations to check in
                         *  %3$s number of registrations for the attendee, %4$s new registration rows represented in JSON
                         */
-                        // @codingStandardsIgnoreStart
-                            'It appears we wanted to check-in more registrations than actually exist. The old attendee record (%1$s) indicated we should check-in %2$d registrations, but there are only %3$d registrations for that attendee (%4$s)',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $this->_json_encode($old_row),
-                        abs($num_to_checkin_at_this_time),
-                        count($new_registrations_for_attendee),
-                        $this->_json_encode($new_registrations_for_attendee)
-                    )
-                );
-                break;
-            }
-            $existing_checkin_record = $wpdb->get_var(
-                $wpdb->prepare(
-                    "SELECT CHK_ID FROM $this->_new_table WHERE REG_ID = %d ORDER BY CHK_ID DESC LIMIT 1",
-                    $new_reg_id
-                )
-            );
-            if (! $existing_checkin_record) {
-                $new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime);
-                if ($new_id) {
-                    $new_checkin_ids[] = $new_id;
-                }
-            }
-        }
-        if ($new_checkin_ids) {
-            $this->get_migration_script()->set_mapping(
-                $this->_old_table,
-                $old_row['id'],
-                $this->_new_table,
-                $new_checkin_ids
-            );
-        }
-    }
-
-
-    /**
-     * Tries to find the new datetime the Check-in was for, based on the attendee row
-     * (because we know the attendee was for an event as a specific time, and we know
-     * the event's OLD ID...)
-     *
-     * @param array $old_attendee
-     * @return array row of datetime from DB
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    private function _try_to_find_datetime(array $old_attendee): array
-    {
-        global $wpdb;
-
-        $new_event_id =
-            $this->get_migration_script()->get_mapping_new_pk(
-                $wpdb->prefix . "events_detail",
-                $old_attendee['event_id'],
-                $wpdb->posts
-            );
-        if (! $new_event_id) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                    /* translators: 1: original event ID, 2: original attendee database row */
-                    // @codingStandardsIgnoreStart
-                        'Could not find new event ID with old event ID %1$d, on attendee row %2$s; and because of that couldn\'t find the correct datetime for Check-in',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $old_attendee['event_id'],
-                    $this->_json_encode($old_attendee)
-                )
-            );
-            return [];
-        }
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_datetime   =
-            $this->get_migration_script()->convert_date_string_to_utc(
-                $this,
-                $old_attendee,
-                "$old_att_start_date $old_att_start_time:00"
-            );
-
-        $datetime_table = $wpdb->prefix . "esp_datetime";
-        // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
-        // the most important condition should be last, as it will be array_shift'ed off last
-        $conditions = [
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
-        ];
-        // start running queries, widening search each time by removing a condition
-        do {
-            $full_query     = "SELECT * FROM $datetime_table WHERE " . implode(" AND ", $conditions) . " LIMIT 1";
-            $datetime_found = $wpdb->get_row($full_query, ARRAY_A);
-            array_shift($conditions);
-        } while (! $datetime_found && $conditions);
-        return $datetime_found;
-    }
-
-
-    /**
-     * Adds a new Check-in/checkout record according to $new_reg_id,$new_datetime_id,$checking_in, and $timestamp
-     *
-     * @param int   $new_reg_id
-     * @param array $new_datetime
-     * @return int new Check-in id
-     */
-    private function _insert_checkin_record(int $new_reg_id, array $new_datetime): int
-    {
-        global $wpdb;
-
-
-        // ok we can actually do what we set out to do: add a checkin/checkout record
-        $cols_n_values = [
-            'REG_ID'        => $new_reg_id,
-            'DTT_ID'        => $new_datetime['DTT_ID'] ?? 0,
-            'CHK_in'        => true,
-            'CHK_timestamp' => $new_datetime['DTT_EVT_start'] ?? null,
-        ];
-        $data_types    = [
-            '%d',// REG_ID
-            '%d',// DTT_ID
-            '%d',// CHK_in
-            '%s',// CHK_timestamp
-        ];
-        $success       = $wpdb->insert($this->_new_table, $cols_n_values, $data_types);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    [],
-                    $this->_new_table,
-                    $cols_n_values,
-                    $data_types
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+						// @codingStandardsIgnoreStart
+							'It appears we wanted to check-in more registrations than actually exist. The old attendee record (%1$s) indicated we should check-in %2$d registrations, but there are only %3$d registrations for that attendee (%4$s)',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$this->_json_encode($old_row),
+						abs($num_to_checkin_at_this_time),
+						count($new_registrations_for_attendee),
+						$this->_json_encode($new_registrations_for_attendee)
+					)
+				);
+				break;
+			}
+			$existing_checkin_record = $wpdb->get_var(
+				$wpdb->prepare(
+					"SELECT CHK_ID FROM $this->_new_table WHERE REG_ID = %d ORDER BY CHK_ID DESC LIMIT 1",
+					$new_reg_id
+				)
+			);
+			if (! $existing_checkin_record) {
+				$new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime);
+				if ($new_id) {
+					$new_checkin_ids[] = $new_id;
+				}
+			}
+		}
+		if ($new_checkin_ids) {
+			$this->get_migration_script()->set_mapping(
+				$this->_old_table,
+				$old_row['id'],
+				$this->_new_table,
+				$new_checkin_ids
+			);
+		}
+	}
+
+
+	/**
+	 * Tries to find the new datetime the Check-in was for, based on the attendee row
+	 * (because we know the attendee was for an event as a specific time, and we know
+	 * the event's OLD ID...)
+	 *
+	 * @param array $old_attendee
+	 * @return array row of datetime from DB
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	private function _try_to_find_datetime(array $old_attendee): array
+	{
+		global $wpdb;
+
+		$new_event_id =
+			$this->get_migration_script()->get_mapping_new_pk(
+				$wpdb->prefix . "events_detail",
+				$old_attendee['event_id'],
+				$wpdb->posts
+			);
+		if (! $new_event_id) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+					/* translators: 1: original event ID, 2: original attendee database row */
+					// @codingStandardsIgnoreStart
+						'Could not find new event ID with old event ID %1$d, on attendee row %2$s; and because of that couldn\'t find the correct datetime for Check-in',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$old_attendee['event_id'],
+					$this->_json_encode($old_attendee)
+				)
+			);
+			return [];
+		}
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_datetime   =
+			$this->get_migration_script()->convert_date_string_to_utc(
+				$this,
+				$old_attendee,
+				"$old_att_start_date $old_att_start_time:00"
+			);
+
+		$datetime_table = $wpdb->prefix . "esp_datetime";
+		// add all conditions to an array from which we can SHIFT conditions off in order to widen our search
+		// the most important condition should be last, as it will be array_shift'ed off last
+		$conditions = [
+			$wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
+			$wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+		];
+		// start running queries, widening search each time by removing a condition
+		do {
+			$full_query     = "SELECT * FROM $datetime_table WHERE " . implode(" AND ", $conditions) . " LIMIT 1";
+			$datetime_found = $wpdb->get_row($full_query, ARRAY_A);
+			array_shift($conditions);
+		} while (! $datetime_found && $conditions);
+		return $datetime_found;
+	}
+
+
+	/**
+	 * Adds a new Check-in/checkout record according to $new_reg_id,$new_datetime_id,$checking_in, and $timestamp
+	 *
+	 * @param int   $new_reg_id
+	 * @param array $new_datetime
+	 * @return int new Check-in id
+	 */
+	private function _insert_checkin_record(int $new_reg_id, array $new_datetime): int
+	{
+		global $wpdb;
+
+
+		// ok we can actually do what we set out to do: add a checkin/checkout record
+		$cols_n_values = [
+			'REG_ID'        => $new_reg_id,
+			'DTT_ID'        => $new_datetime['DTT_ID'] ?? 0,
+			'CHK_in'        => true,
+			'CHK_timestamp' => $new_datetime['DTT_EVT_start'] ?? null,
+		];
+		$data_types    = [
+			'%d',// REG_ID
+			'%d',// DTT_ID
+			'%d',// CHK_in
+			'%s',// CHK_timestamp
+		];
+		$success       = $wpdb->insert($this->_new_table, $cols_n_values, $data_types);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					[],
+					$this->_new_table,
+					$cols_n_values,
+					$data_types
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -31,12 +31,12 @@ 
     {
         global $wpdb;
         $this->_pretty_name      = esc_html__('Check-ins', 'event_espresso');
-        $this->_old_table        = $wpdb->prefix . "events_attendee";
+        $this->_old_table        = $wpdb->prefix."events_attendee";
         $this->select_expression = 'att.*, e.event_status';
         $this->_extra_where_sql  = 'AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_new_table        = $wpdb->prefix . "esp_checkin";
+        $this->_new_table        = $wpdb->prefix."esp_checkin";
         parent::__construct();
     }
 
@@ -47,13 +47,13 @@ 
     protected function _migrate_old_row($old_row)
     {
         global $wpdb;
-        $new_reg_table = $wpdb->prefix . "esp_registration";
+        $new_reg_table = $wpdb->prefix."esp_registration";
 
         $num_to_checkin_at_this_time = max([intval($old_row['checked_in_quantity']), intval($old_row['checked_in'])]);
 
         $new_registrations_for_attendee =
             $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table);
-        if (! $new_registrations_for_attendee) {
+        if ( ! $new_registrations_for_attendee) {
             $new_registrations_for_attendee = [];
         }
         $new_datetime = $this->_try_to_find_datetime($old_row);
@@ -62,8 +62,8 @@ 
         $new_registrations_for_attendee = array_values($new_registrations_for_attendee);
         $new_checkin_ids                = [];
         for ($i = 0; $i < abs($num_to_checkin_at_this_time); $i++) {
-            $new_reg_id = $new_registrations_for_attendee[ $i ];
-            if (! $new_reg_id) {
+            $new_reg_id = $new_registrations_for_attendee[$i];
+            if ( ! $new_reg_id) {
                 $this->add_error(
                     sprintf(
                         esc_html__(
@@ -89,7 +89,7 @@ 
                     $new_reg_id
                 )
             );
-            if (! $existing_checkin_record) {
+            if ( ! $existing_checkin_record) {
                 $new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime);
                 if ($new_id) {
                     $new_checkin_ids[] = $new_id;
@@ -123,11 +123,11 @@ 
 
         $new_event_id =
             $this->get_migration_script()->get_mapping_new_pk(
-                $wpdb->prefix . "events_detail",
+                $wpdb->prefix."events_detail",
                 $old_attendee['event_id'],
                 $wpdb->posts
             );
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(
                 sprintf(
                     esc_html__(
@@ -152,19 +152,19 @@ 
                 "$old_att_start_date $old_att_start_time:00"
             );
 
-        $datetime_table = $wpdb->prefix . "esp_datetime";
+        $datetime_table = $wpdb->prefix."esp_datetime";
         // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
         // the most important condition should be last, as it will be array_shift'ed off last
         $conditions = [
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime), // times match?
+            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id), // events match?
         ];
         // start running queries, widening search each time by removing a condition
         do {
-            $full_query     = "SELECT * FROM $datetime_table WHERE " . implode(" AND ", $conditions) . " LIMIT 1";
+            $full_query     = "SELECT * FROM $datetime_table WHERE ".implode(" AND ", $conditions)." LIMIT 1";
             $datetime_found = $wpdb->get_row($full_query, ARRAY_A);
             array_shift($conditions);
-        } while (! $datetime_found && $conditions);
+        }while ( ! $datetime_found && $conditions);
         return $datetime_found;
     }
 
@@ -188,14 +188,14 @@ 
             'CHK_in'        => true,
             'CHK_timestamp' => $new_datetime['DTT_EVT_start'] ?? null,
         ];
-        $data_types    = [
-            '%d',// REG_ID
-            '%d',// DTT_ID
-            '%d',// CHK_in
-            '%s',// CHK_timestamp
+        $data_types = [
+            '%d', // REG_ID
+            '%d', // DTT_ID
+            '%d', // CHK_in
+            '%s', // CHK_timestamp
         ];
-        $success       = $wpdb->insert($this->_new_table, $cols_n_values, $data_types);
-        if (! $success) {
+        $success = $wpdb->insert($this->_new_table, $cols_n_values, $data_types);
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,

core/EE_Front_Controller.core.php

Indentation +513 added lines, -513 removed lines

@@ -19,517 +19,517 @@
  */
 final class EE_Front_Controller
 {
-    /**
-     * @var string
-     */
-    private $_template_path;
-
-    /**
-     * @var string
-     */
-    private $_template;
-
-    /**
-     * @type EE_Registry
-     */
-    protected $Registry;
-
-    /**
-     * @type EE_Request_Handler
-     */
-    protected $Request_Handler;
-
-    /**
-     * @type EE_Module_Request_Router
-     */
-    protected $Module_Request_Router;
-
-    /**
-     * @type CurrentPage
-     */
-    protected $current_page;
-
-
-    /**
-     *    class constructor
-     *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
-     *
-     * @access    public
-     * @param EE_Registry              $Registry
-     * @param CurrentPage              $EspressoPage
-     * @param EE_Module_Request_Router $Module_Request_Router
-     */
-    public function __construct(
-        EE_Registry $Registry,
-        CurrentPage $EspressoPage,
-        EE_Module_Request_Router $Module_Request_Router
-    ) {
-        $this->Registry              = $Registry;
-        $this->current_page          = $EspressoPage;
-        $this->Module_Request_Router = $Module_Request_Router;
-        // load other resources and begin to actually run shortcodes and modules
-        // analyse the incoming WP request
-        add_action('parse_request', array($this, 'get_request'), 1, 1);
-        // process request with module factory
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
-        // before headers sent
-        add_action('wp', array($this, 'wp'), 5);
-        // primarily used to process any content shortcodes
-        add_action('template_redirect', array($this, 'templateRedirect'), 999);
-        // header
-        add_action('wp_head', array($this, 'header_meta_tag'), 5);
-        add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
-        add_filter('template_include', array($this, 'template_include'), 1);
-        // display errors
-        add_action('loop_start', array($this, 'display_errors'), 2);
-        // the content
-        // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
-        // exclude our private cpt comments
-        add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
-        // make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
-        add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
-        // action hook EE
-        do_action('AHEE__EE_Front_Controller__construct__done', $this);
-    }
-
-
-    /**
-     * @return EE_Request_Handler
-     * @deprecated 4.10.14.p
-     */
-    public function Request_Handler()
-    {
-        if (! $this->Request_Handler instanceof EE_Request_Handler) {
-            $this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
-        }
-        return $this->Request_Handler;
-    }
-
-
-    /**
-     * @return EE_Module_Request_Router
-     */
-    public function Module_Request_Router()
-    {
-        return $this->Module_Request_Router;
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     * @deprecated 4.10.14.p
-     */
-    public function getLegacyShortcodesManager()
-    {
-        return EE_Config::getLegacyShortcodesManager();
-    }
-
-
-
-
-
-    /***********************************************        INIT ACTION HOOK         ***********************************************/
-    /**
-     * filter_wp_comments
-     * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
-     * widgets/queries done on frontend
-     *
-     * @param  array $clauses array of comment clauses setup by WP_Comment_Query
-     * @return array array of comment clauses with modifications.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function filter_wp_comments($clauses)
-    {
-        global $wpdb;
-        if (strpos($clauses['join'], $wpdb->posts) !== false) {
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $cpts = $custom_post_types->getPrivateCustomPostTypes();
-            foreach ($cpts as $cpt => $details) {
-                $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
-            }
-        }
-        return $clauses;
-    }
-
-
-    /**
-     * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
-     *
-     * @param  string $url incoming url
-     * @return string         final assembled url
-     */
-    public function maybe_force_admin_ajax_ssl($url)
-    {
-        if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
-            $url = str_replace('http://', 'https://', $url);
-        }
-        return $url;
-    }
-
-
-
-
-
-
-    /***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
-
-
-    /**
-     *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
-     *    default priority init phases have run
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-
-
-    /***********************************************        PARSE_REQUEST HOOK         ***********************************************/
-    /**
-     *    _get_request
-     *
-     * @access public
-     * @param WP $WP
-     * @return void
-     */
-    public function get_request(WP $WP)
-    {
-        do_action('AHEE__EE_Front_Controller__get_request__start');
-        $this->current_page->parseQueryVars($WP);
-        do_action('AHEE__EE_Front_Controller__get_request__complete');
-        remove_action('parse_request', [$this, 'get_request'], 1);
-    }
-
-
-    /**
-     *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // only load Module_Request_Router if this is the main query
-        if (
-            $this->Module_Request_Router instanceof EE_Module_Request_Router
-            && $WP_Query->is_main_query()
-        ) {
-            // cycle thru module routes
-            while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
-                // determine module and method for route
-                $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
-                if ($module instanceof EED_Module) {
-                    // get registered view for route
-                    $this->_template_path = $this->Module_Request_Router->get_view($route);
-                    // grab module name
-                    $module_name = $module->module_name();
-                    // map the module to the module objects
-                    $this->Registry->modules->{$module_name} = $module;
-                }
-            }
-        }
-    }
-
-
-
-
-
-    /***********************************************        WP HOOK         ***********************************************/
-
-
-    /**
-     *    wp - basically last chance to do stuff before headers sent
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp()
-    {
-    }
-
-
-
-    /***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
-
-
-    /**
-     * callback for the "template_redirect" hook point
-     * checks sidebars for EE widgets
-     * loads resources and assets accordingly
-     *
-     * @return void
-     */
-    public function templateRedirect()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)) {
-            return;
-        }
-        // if we already know this is an espresso page, then load assets
-        $load_assets = $this->current_page->isEspressoPage();
-        // if we are already loading assets then just move along, otherwise check for widgets
-        $load_assets = $load_assets || $this->espresso_widgets_in_active_sidebars();
-        if ($load_assets) {
-            add_action('wp_enqueue_scripts', array($this, 'enqueueStyle'), 10);
-            add_action('wp_enqueue_scripts', array($this, 'enqueueScripts'), 10);
-        }
-
-        if (is_singular(EspressoPostType::EVENTS)) {
-            new FilterNextPreviousEventPostQuery();
-        }
-    }
-
-
-    /**
-     * builds list of active widgets then scans active sidebars looking for them
-     * returns true is an EE widget is found in an active sidebar
-     * Please Note: this does NOT mean that the sidebar or widget
-     * is actually in use in a given template, as that is unfortunately not known
-     * until a sidebar and it's widgets are actually loaded
-     *
-     * @return boolean
-     */
-    private function espresso_widgets_in_active_sidebars()
-    {
-        $espresso_widgets = array();
-        foreach ($this->Registry->widgets as $widget_class => $widget) {
-            $id_base = EspressoWidget::getIdBase($widget_class);
-            if (is_active_widget(false, false, $id_base)) {
-                $espresso_widgets[] = $id_base;
-            }
-        }
-        $all_sidebar_widgets = wp_get_sidebars_widgets();
-        foreach ($all_sidebar_widgets as $sidebar_widgets) {
-            if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
-                foreach ($sidebar_widgets as $sidebar_widget) {
-                    foreach ($espresso_widgets as $espresso_widget) {
-                        if (strpos($sidebar_widget, $espresso_widget) !== false) {
-                            return true;
-                        }
-                    }
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    header_meta_tag
-     *
-     * @access    public
-     * @return    void
-     */
-    public function header_meta_tag()
-    {
-        print(
-        apply_filters(
-            'FHEE__EE_Front_Controller__header_meta_tag',
-            '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
-        )
-        );
-
-        // let's exclude all event type taxonomy term archive pages from search engine indexing
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/10249
-        // also exclude all critical pages from indexing
-        if (
-            (
-                is_tax('espresso_event_type')
-                && get_option('blog_public') !== '0'
-            )
-            || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
-        ) {
-            print(
-            apply_filters(
-                'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                '<meta name="robots" content="noindex,follow" />' . "\n"
-            )
-            );
-        }
-    }
-
-
-    /**
-     * wp_print_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function wp_print_scripts()
-    {
-        global $post;
-        if (
-            isset($post->EE_Event)
-            && $post->EE_Event instanceof EE_Event
-            && get_post_type() === EspressoPostType::EVENTS
-            && is_singular()
-        ) {
-            EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
-        }
-    }
-
-
-    public function enqueueStyle()
-    {
-        wp_enqueue_style('espresso_default');
-        wp_enqueue_style('espresso_custom_css');
-    }
-
-
-
-    /***********************************************        WP_FOOTER         ***********************************************/
-
-
-    public function enqueueScripts()
-    {
-        wp_enqueue_script('espresso_core');
-    }
-
-
-    /**
-     * display_errors
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     */
-    public function display_errors()
-    {
-        static $shown_already = false;
-        do_action('AHEE__EE_Front_Controller__display_errors__begin');
-        if (
-            ! $shown_already
-            && apply_filters('FHEE__EE_Front_Controller__display_errors', true)
-            && is_main_query()
-            && ! is_feed()
-            && in_the_loop()
-            && $this->current_page->isEspressoPage()
-        ) {
-            $shown_already = true;
-            if (did_action('wp_head')) {
-                echo wp_kses($this->printNotices(), AllowedTags::getAllowedTags());
-            } else {
-                // block enabled themes run their query loop before headers are sent
-                // so we need to add our notices onto the beginning of the content
-                add_filter('the_content', [$this, 'prependNotices'], 1, 1);
-            }
-        }
-        do_action('AHEE__EE_Front_Controller__display_errors__end');
-    }
-
-
-    /**
-     * @param string $the_content
-     * @return string
-     * @since 4.10.30.p
-     */
-    public function prependNotices($the_content)
-    {
-        $notices = $this->printNotices();
-        return $notices ? $notices . $the_content : $the_content;
-    }
-
-
-    /**
-     * @return false|string
-     * @since 4.10.30.p
-     */
-    public function printNotices()
-    {
-        ob_start();
-        echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
-        EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
-        return ob_get_clean();
-    }
-
-
-
-    /***********************************************        UTILITIES         ***********************************************/
-
-
-    /**
-     * @param string $template_include_path
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function template_include($template_include_path = null)
-    {
-        if ($this->current_page->isEspressoPage()) {
-            // despite all helpers having autoloaders set, we need to manually load the template loader
-            // because there are some side effects in that class for triggering template tag functions
-            $this->Registry->load_helper('EEH_Template');
-            $this->_template_path = ! empty($this->_template_path)
-                ? basename($this->_template_path)
-                : basename(
-                    $template_include_path
-                );
-            $template_path = EEH_Template::locate_template($this->_template_path, array(), false);
-            $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
-            $this->_template = basename($this->_template_path);
-            return $this->_template_path;
-        }
-        return $template_include_path;
-    }
-
-
-    /**
-     * @param bool $with_path
-     * @return    string
-     */
-    public function get_selected_template($with_path = false)
-    {
-        return $with_path ? $this->_template_path : $this->_template;
-    }
-
-
-    /**
-     * @param string $shortcode_class
-     * @param WP     $wp
-     * @throws ReflectionException
-     * @deprecated 4.9.26
-     */
-    public function initialize_shortcode($shortcode_class = '', WP $wp = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        $this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.57.p
-     */
-    public function loadPersistentAdminNoticeManager()
-    {
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.64.p
-     */
-    public function employ_CPT_Strategy()
-    {
-    }
+	/**
+	 * @var string
+	 */
+	private $_template_path;
+
+	/**
+	 * @var string
+	 */
+	private $_template;
+
+	/**
+	 * @type EE_Registry
+	 */
+	protected $Registry;
+
+	/**
+	 * @type EE_Request_Handler
+	 */
+	protected $Request_Handler;
+
+	/**
+	 * @type EE_Module_Request_Router
+	 */
+	protected $Module_Request_Router;
+
+	/**
+	 * @type CurrentPage
+	 */
+	protected $current_page;
+
+
+	/**
+	 *    class constructor
+	 *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
+	 *
+	 * @access    public
+	 * @param EE_Registry              $Registry
+	 * @param CurrentPage              $EspressoPage
+	 * @param EE_Module_Request_Router $Module_Request_Router
+	 */
+	public function __construct(
+		EE_Registry $Registry,
+		CurrentPage $EspressoPage,
+		EE_Module_Request_Router $Module_Request_Router
+	) {
+		$this->Registry              = $Registry;
+		$this->current_page          = $EspressoPage;
+		$this->Module_Request_Router = $Module_Request_Router;
+		// load other resources and begin to actually run shortcodes and modules
+		// analyse the incoming WP request
+		add_action('parse_request', array($this, 'get_request'), 1, 1);
+		// process request with module factory
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
+		// before headers sent
+		add_action('wp', array($this, 'wp'), 5);
+		// primarily used to process any content shortcodes
+		add_action('template_redirect', array($this, 'templateRedirect'), 999);
+		// header
+		add_action('wp_head', array($this, 'header_meta_tag'), 5);
+		add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
+		add_filter('template_include', array($this, 'template_include'), 1);
+		// display errors
+		add_action('loop_start', array($this, 'display_errors'), 2);
+		// the content
+		// add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
+		// exclude our private cpt comments
+		add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
+		// make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
+		add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
+		// action hook EE
+		do_action('AHEE__EE_Front_Controller__construct__done', $this);
+	}
+
+
+	/**
+	 * @return EE_Request_Handler
+	 * @deprecated 4.10.14.p
+	 */
+	public function Request_Handler()
+	{
+		if (! $this->Request_Handler instanceof EE_Request_Handler) {
+			$this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
+		}
+		return $this->Request_Handler;
+	}
+
+
+	/**
+	 * @return EE_Module_Request_Router
+	 */
+	public function Module_Request_Router()
+	{
+		return $this->Module_Request_Router;
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 * @deprecated 4.10.14.p
+	 */
+	public function getLegacyShortcodesManager()
+	{
+		return EE_Config::getLegacyShortcodesManager();
+	}
+
+
+
+
+
+	/***********************************************        INIT ACTION HOOK         ***********************************************/
+	/**
+	 * filter_wp_comments
+	 * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
+	 * widgets/queries done on frontend
+	 *
+	 * @param  array $clauses array of comment clauses setup by WP_Comment_Query
+	 * @return array array of comment clauses with modifications.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function filter_wp_comments($clauses)
+	{
+		global $wpdb;
+		if (strpos($clauses['join'], $wpdb->posts) !== false) {
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$cpts = $custom_post_types->getPrivateCustomPostTypes();
+			foreach ($cpts as $cpt => $details) {
+				$clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
+			}
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
+	 *
+	 * @param  string $url incoming url
+	 * @return string         final assembled url
+	 */
+	public function maybe_force_admin_ajax_ssl($url)
+	{
+		if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
+			$url = str_replace('http://', 'https://', $url);
+		}
+		return $url;
+	}
+
+
+
+
+
+
+	/***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
+
+
+	/**
+	 *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
+	 *    default priority init phases have run
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+
+
+	/***********************************************        PARSE_REQUEST HOOK         ***********************************************/
+	/**
+	 *    _get_request
+	 *
+	 * @access public
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function get_request(WP $WP)
+	{
+		do_action('AHEE__EE_Front_Controller__get_request__start');
+		$this->current_page->parseQueryVars($WP);
+		do_action('AHEE__EE_Front_Controller__get_request__complete');
+		remove_action('parse_request', [$this, 'get_request'], 1);
+	}
+
+
+	/**
+	 *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// only load Module_Request_Router if this is the main query
+		if (
+			$this->Module_Request_Router instanceof EE_Module_Request_Router
+			&& $WP_Query->is_main_query()
+		) {
+			// cycle thru module routes
+			while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
+				// determine module and method for route
+				$module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
+				if ($module instanceof EED_Module) {
+					// get registered view for route
+					$this->_template_path = $this->Module_Request_Router->get_view($route);
+					// grab module name
+					$module_name = $module->module_name();
+					// map the module to the module objects
+					$this->Registry->modules->{$module_name} = $module;
+				}
+			}
+		}
+	}
+
+
+
+
+
+	/***********************************************        WP HOOK         ***********************************************/
+
+
+	/**
+	 *    wp - basically last chance to do stuff before headers sent
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp()
+	{
+	}
+
+
+
+	/***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
+
+
+	/**
+	 * callback for the "template_redirect" hook point
+	 * checks sidebars for EE widgets
+	 * loads resources and assets accordingly
+	 *
+	 * @return void
+	 */
+	public function templateRedirect()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)) {
+			return;
+		}
+		// if we already know this is an espresso page, then load assets
+		$load_assets = $this->current_page->isEspressoPage();
+		// if we are already loading assets then just move along, otherwise check for widgets
+		$load_assets = $load_assets || $this->espresso_widgets_in_active_sidebars();
+		if ($load_assets) {
+			add_action('wp_enqueue_scripts', array($this, 'enqueueStyle'), 10);
+			add_action('wp_enqueue_scripts', array($this, 'enqueueScripts'), 10);
+		}
+
+		if (is_singular(EspressoPostType::EVENTS)) {
+			new FilterNextPreviousEventPostQuery();
+		}
+	}
+
+
+	/**
+	 * builds list of active widgets then scans active sidebars looking for them
+	 * returns true is an EE widget is found in an active sidebar
+	 * Please Note: this does NOT mean that the sidebar or widget
+	 * is actually in use in a given template, as that is unfortunately not known
+	 * until a sidebar and it's widgets are actually loaded
+	 *
+	 * @return boolean
+	 */
+	private function espresso_widgets_in_active_sidebars()
+	{
+		$espresso_widgets = array();
+		foreach ($this->Registry->widgets as $widget_class => $widget) {
+			$id_base = EspressoWidget::getIdBase($widget_class);
+			if (is_active_widget(false, false, $id_base)) {
+				$espresso_widgets[] = $id_base;
+			}
+		}
+		$all_sidebar_widgets = wp_get_sidebars_widgets();
+		foreach ($all_sidebar_widgets as $sidebar_widgets) {
+			if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
+				foreach ($sidebar_widgets as $sidebar_widget) {
+					foreach ($espresso_widgets as $espresso_widget) {
+						if (strpos($sidebar_widget, $espresso_widget) !== false) {
+							return true;
+						}
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    header_meta_tag
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function header_meta_tag()
+	{
+		print(
+		apply_filters(
+			'FHEE__EE_Front_Controller__header_meta_tag',
+			'<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
+		)
+		);
+
+		// let's exclude all event type taxonomy term archive pages from search engine indexing
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/10249
+		// also exclude all critical pages from indexing
+		if (
+			(
+				is_tax('espresso_event_type')
+				&& get_option('blog_public') !== '0'
+			)
+			|| is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
+		) {
+			print(
+			apply_filters(
+				'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
+				'<meta name="robots" content="noindex,follow" />' . "\n"
+			)
+			);
+		}
+	}
+
+
+	/**
+	 * wp_print_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function wp_print_scripts()
+	{
+		global $post;
+		if (
+			isset($post->EE_Event)
+			&& $post->EE_Event instanceof EE_Event
+			&& get_post_type() === EspressoPostType::EVENTS
+			&& is_singular()
+		) {
+			EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
+		}
+	}
+
+
+	public function enqueueStyle()
+	{
+		wp_enqueue_style('espresso_default');
+		wp_enqueue_style('espresso_custom_css');
+	}
+
+
+
+	/***********************************************        WP_FOOTER         ***********************************************/
+
+
+	public function enqueueScripts()
+	{
+		wp_enqueue_script('espresso_core');
+	}
+
+
+	/**
+	 * display_errors
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function display_errors()
+	{
+		static $shown_already = false;
+		do_action('AHEE__EE_Front_Controller__display_errors__begin');
+		if (
+			! $shown_already
+			&& apply_filters('FHEE__EE_Front_Controller__display_errors', true)
+			&& is_main_query()
+			&& ! is_feed()
+			&& in_the_loop()
+			&& $this->current_page->isEspressoPage()
+		) {
+			$shown_already = true;
+			if (did_action('wp_head')) {
+				echo wp_kses($this->printNotices(), AllowedTags::getAllowedTags());
+			} else {
+				// block enabled themes run their query loop before headers are sent
+				// so we need to add our notices onto the beginning of the content
+				add_filter('the_content', [$this, 'prependNotices'], 1, 1);
+			}
+		}
+		do_action('AHEE__EE_Front_Controller__display_errors__end');
+	}
+
+
+	/**
+	 * @param string $the_content
+	 * @return string
+	 * @since 4.10.30.p
+	 */
+	public function prependNotices($the_content)
+	{
+		$notices = $this->printNotices();
+		return $notices ? $notices . $the_content : $the_content;
+	}
+
+
+	/**
+	 * @return false|string
+	 * @since 4.10.30.p
+	 */
+	public function printNotices()
+	{
+		ob_start();
+		echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
+		EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+		return ob_get_clean();
+	}
+
+
+
+	/***********************************************        UTILITIES         ***********************************************/
+
+
+	/**
+	 * @param string $template_include_path
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function template_include($template_include_path = null)
+	{
+		if ($this->current_page->isEspressoPage()) {
+			// despite all helpers having autoloaders set, we need to manually load the template loader
+			// because there are some side effects in that class for triggering template tag functions
+			$this->Registry->load_helper('EEH_Template');
+			$this->_template_path = ! empty($this->_template_path)
+				? basename($this->_template_path)
+				: basename(
+					$template_include_path
+				);
+			$template_path = EEH_Template::locate_template($this->_template_path, array(), false);
+			$this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
+			$this->_template = basename($this->_template_path);
+			return $this->_template_path;
+		}
+		return $template_include_path;
+	}
+
+
+	/**
+	 * @param bool $with_path
+	 * @return    string
+	 */
+	public function get_selected_template($with_path = false)
+	{
+		return $with_path ? $this->_template_path : $this->_template;
+	}
+
+
+	/**
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 * @throws ReflectionException
+	 * @deprecated 4.9.26
+	 */
+	public function initialize_shortcode($shortcode_class = '', WP $wp = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		$this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.57.p
+	 */
+	public function loadPersistentAdminNoticeManager()
+	{
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.64.p
+	 */
+	public function employ_CPT_Strategy()
+	{
+	}
 }

core/CPTs/EE_CPT_Strategy.core.php

Indentation +339 added lines, -339 removed lines

@@ -16,343 +16,343 @@
  */
 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
-    {
-        $post_type = $wp_query->query->post_type ?? '';
-        $post_type = $post_type === '' && isset($wp_query->query['post_type']) ? $wp_query->query['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)
-    {
-        // check that post-type is one of ours
-        if (! $this->isEspressoPostType($wp_query)) {
-            return;
-        }
-        // 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;
-        }
-        $term->post_type = array_merge(['post', 'page'], (array) $term->post_type);
-        $term->post_type = apply_filters(
-            'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
-            $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 ($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
+	{
+		$post_type = $wp_query->query->post_type ?? '';
+		$post_type = $post_type === '' && isset($wp_query->query['post_type']) ? $wp_query->query['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)
+	{
+		// check that post-type is one of ours
+		if (! $this->isEspressoPostType($wp_query)) {
+			return;
+		}
+		// 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;
+		}
+		$term->post_type = array_merge(['post', 'page'], (array) $term->post_type);
+		$term->post_type = apply_filters(
+			'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
+			$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 ($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 +16 added lines, -16 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;
@@ -126,7 +126,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]);
     }
 
 
@@ -143,7 +143,7 @@ 
     public function pre_get_posts(WP_Query $wp_query)
     {
         // check that post-type is one of ours
-        if (! $this->isEspressoPostType($wp_query)) {
+        if ( ! $this->isEspressoPostType($wp_query)) {
             return;
         }
         // add our conditionals
@@ -185,7 +185,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;
                 }
             }
         }
@@ -201,13 +201,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;
         }
         $term->post_type = array_merge(['post', 'page'], (array) $term->post_type);
@@ -246,13 +246,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
@@ -282,7 +282,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
                         );
@@ -297,19 +297,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'])) {
@@ -328,18 +328,18 @@ 
      */
     protected function _generate_CptQueryModifier(WP_Query $wp_query, string $post_type)
     {
-        if ($this->query_modifier[ $post_type ] instanceof CptQueryModifier) {
+        if ($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/CPTs/EE_CPT_Default_Strategy.core.php

Indentation +51 added lines, -51 removed lines

@@ -9,63 +9,63 @@
  */
 class EE_CPT_Default_Strategy
 {
-    /**
-     * $CPT - the current page, if it utilizes CPTs
-     *
-     * @var    object
-     */
-    protected $CPT = null;
+	/**
+	 * $CPT - the current page, if it utilizes CPTs
+	 *
+	 * @var    object
+	 */
+	protected $CPT = null;
 
 
-    /**
-     * @param array $arguments
-     */
-    public function __construct(array $arguments = [])
-    {
-        $this->CPT = $arguments['CPT'] ?? null;
-    }
+	/**
+	 * @param array $arguments
+	 */
+	public function __construct(array $arguments = [])
+	{
+		$this->CPT = $arguments['CPT'] ?? null;
+	}
 
 
-    /**
-     *    pre_get_posts
-     *
-     * @param WP_Query $wp_query
-     * @return    WP_Query
-     */
-    public function pre_get_posts(WP_Query $wp_query): WP_Query
-    {
-        return $wp_query;
-    }
+	/**
+	 *    pre_get_posts
+	 *
+	 * @param WP_Query $wp_query
+	 * @return    WP_Query
+	 */
+	public function pre_get_posts(WP_Query $wp_query): WP_Query
+	{
+		return $wp_query;
+	}
 
 
-    /**
-     *    wp
-     *
-     * @param WP_Post[] $posts
-     * @param WP_Query  $wp_query
-     * @return    WP_Post[]
-     */
-    public function the_posts(array $posts, WP_Query $wp_query): array
-    {
-        return $posts;
-    }
+	/**
+	 *    wp
+	 *
+	 * @param WP_Post[] $posts
+	 * @param WP_Query  $wp_query
+	 * @return    WP_Post[]
+	 */
+	public function the_posts(array $posts, WP_Query $wp_query): array
+	{
+		return $posts;
+	}
 
 
-    /**
-     * @param mixed  $meta_value
-     * @param int    $object_id
-     * @param string $meta_key
-     * @param bool   $single
-     * @param string $meta_type
-     * @return mixed
-     */
-    public function get_EE_post_type_metadata(
-        $meta_value,
-        int $object_id,
-        string $meta_key,
-        bool $single,
-        string $meta_type
-    ) {
-        return $meta_value;
-    }
+	/**
+	 * @param mixed  $meta_value
+	 * @param int    $object_id
+	 * @param string $meta_key
+	 * @param bool   $single
+	 * @param string $meta_type
+	 * @return mixed
+	 */
+	public function get_EE_post_type_metadata(
+		$meta_value,
+		int $object_id,
+		string $meta_key,
+		bool $single,
+		string $meta_type
+	) {
+		return $meta_value;
+	}
 }

core/CPTs/EE_CPT_Event_Strategy.core.php

Indentation +237 added lines, -237 removed lines

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

Spacing +10 added lines, -10 removed lines

@@ -45,7 +45,7 @@ 
         // 'posts_join'
         $this->_add_filters();
         if ($wp_query instanceof WP_Query) {
-            $wp_query->is_espresso_event_single   = is_singular()
+            $wp_query->is_espresso_event_single = is_singular()
                 && (
                     (isset($wp_query->query->post_type) && $wp_query->query->post_type === EspressoPostType::EVENTS)
                     || (isset($wp_query->query['post_type']) && $wp_query->query['post_type'] === EspressoPostType::EVENTS)
@@ -104,13 +104,13 @@ 
             )
         ) {
             // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
+            $SQL .= ', '.EEM_Datetime::instance()->table().'.* ';
             if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
                 // because we only want to retrieve the next upcoming datetime for each event:
                 // add something like:
                 // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
                 // to WP Query SELECT statement
-                $SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+                $SQL .= ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
             }
             remove_filter('posts_fields', [$this, 'posts_fields'], 1);
         }
@@ -141,9 +141,9 @@ 
             // adds something like:
             // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
             // to WP Query JOIN statement
-            $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
-                . '.ID = ' . EEM_Datetime::instance()->table() . '.'
-                . EEM_Event::instance()->primary_key_name() . ' ) ';
+            $SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.EEM_Event::instance()->table()
+                . '.ID = '.EEM_Datetime::instance()->table().'.'
+                . EEM_Event::instance()->primary_key_name().' ) ';
             remove_filter('posts_join', [$this, 'posts_join'], 1);
         }
         return $SQL;
@@ -174,11 +174,11 @@ 
                 || ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
                 || ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
             ) {
-                $SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
-                    . current_time('mysql', true) . "' ";
+                $SQL .= ' AND '.EEM_Datetime::instance()->table().".DTT_EVT_end > '"
+                    . current_time('mysql', true)."' ";
             }
             // exclude trashed datetimes
-            $SQL .= ' AND ' . EEM_Datetime::instance()->table() . '.DTT_deleted = 0';
+            $SQL .= ' AND '.EEM_Datetime::instance()->table().'.DTT_deleted = 0';
             remove_filter('posts_where', [$this, 'posts_where']);
         }
         return $SQL;
@@ -232,7 +232,7 @@ 
             // but we want to only show each event only once
             // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
             global $wpdb;
-            $SQL = $wpdb->posts . '.ID ';
+            $SQL = $wpdb->posts.'.ID ';
             remove_filter('posts_groupby', [$this, 'posts_groupby'], 1);
         }
         return $SQL;

core/CPTs/CptQueryModifier.php

Indentation +480 added lines, -480 removed lines

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

Spacing +13 added lines, -13 removed lines

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

core/CPTs/EE_CPT_Attendee_Strategy.core.php

Indentation +26 added lines, -26 removed lines

@@ -9,34 +9,34 @@
  */
 class EE_CPT_Attendee_Strategy
 {
-    /**
-     * $CPT - the current page, if it utilizes CPTs
-     *
-     * @var    array
-     * @access    protected
-     */
-    protected $CPT = null;
+	/**
+	 * $CPT - the current page, if it utilizes CPTs
+	 *
+	 * @var    array
+	 * @access    protected
+	 */
+	protected $CPT = null;
 
 
-    /**
-     * @param array $arguments
-     */
-    public function __construct(array $arguments = [])
-    {
-        $this->CPT = $arguments['CPT'] ?? null;
-    }
+	/**
+	 * @param array $arguments
+	 */
+	public function __construct(array $arguments = [])
+	{
+		$this->CPT = $arguments['CPT'] ?? null;
+	}
 
 
-    /**
-     *    the_posts
-     *
-     * @access    public
-     * @param          $posts
-     * @param WP_Query $wp_query
-     * @return    void
-     */
-    public function the_posts($posts, WP_Query $wp_query)
-    {
-        return $posts;
-    }
+	/**
+	 *    the_posts
+	 *
+	 * @access    public
+	 * @param          $posts
+	 * @param WP_Query $wp_query
+	 * @return    void
+	 */
+	public function the_posts($posts, WP_Query $wp_query)
+	{
+		return $posts;
+	}
 }

core/CPTs/EE_CPT_Venue_Strategy.core.php

Indentation +49 added lines, -49 removed lines

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

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
             $this->CPT = $CPT;
         }
         if ($wp_query instanceof WP_Query && ! $wp_query->is_tag) {
-            $wp_query->is_espresso_venue_single   = is_singular()
+            $wp_query->is_espresso_venue_single = is_singular()
                 && (
                     (isset($wp_query->query->post_type) && $wp_query->query->post_type === EspressoPostType::VENUES)
                     || (isset($wp_query->query['post_type']) && $wp_query->query['post_type'] === EspressoPostType::VENUES)

core/helpers/EEH_Debug_Tools.helper.php

Indentation +715 added lines, -715 removed lines

@@ -15,716 +15,716 @@ 
  */
 class EEH_Debug_Tools
 {
-    /**
-     *    instance of the EEH_Autoloader object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var array
-     */
-    protected $_memory_usage_points = array();
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EEH_Debug_Tools
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private class constructor
-     */
-    private function __construct()
-    {
-        // load Kint PHP debugging library
-        if (
-            defined('EE_LOAD_KINT')
-            && ! class_exists('Kint')
-            && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
-        ) {
-            // despite EE4 having a check for an existing copy of the Kint debugging class,
-            // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
-            // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
-            // so we've moved it to our test folder so that it is not included with production releases
-            // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
-        }
-        $plugin = basename(EE_PLUGIN_DIR_PATH);
-        add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
-    }
-
-
-
-    /**
-     *    show_db_name
-     *
-     * @return void
-     */
-    public static function show_db_name()
-    {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
-            echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
-                 . DB_NAME
-                 . '</p>';
-        }
-        if (EE_DEBUG) {
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    dump EE_Session object at bottom of page after everything else has happened
-     *
-     * @return void
-     */
-    public function espresso_session_footer_dump()
-    {
-        if (
-            (defined('WP_DEBUG') && WP_DEBUG)
-            && ! defined('DOING_AJAX')
-            && class_exists('Kint')
-            && function_exists('wp_get_current_user')
-            && current_user_can('update_core')
-            && class_exists('EE_Registry')
-        ) {
-            Kint::dump(EE_Registry::instance()->SSN->id());
-            Kint::dump(EE_Registry::instance()->SSN);
-            //          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
-            $this->espresso_list_hooked_functions();
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    List All Hooked Functions
-     *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
-     *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
-     *
-     * @param string $tag
-     * @return void
-     */
-    public function espresso_list_hooked_functions($tag = '')
-    {
-        global $wp_filter;
-        echo '<br/><br/><br/><h3>Hooked Functions</h3>';
-        if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
-                trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
-                return;
-            }
-            echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
-        } else {
-            $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
-            ksort($hook);
-        }
-        foreach ($hook as $tag_name => $priorities) {
-            echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>esc_html($tag_name)</strong><br />";
-            ksort($priorities);
-            foreach ($priorities as $priority => $function) {
-                echo esc_html($priority);
-                foreach ($function as $name => $properties) {
-                    $name = esc_html($name);
-                    echo "\t$name<br />";
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    registered_filter_callbacks
-     *
-     * @param string $hook_name
-     * @return array
-     */
-    public static function registered_filter_callbacks($hook_name = '')
-    {
-        $filters = array();
-        global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
-                foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
-                }
-            }
-        }
-        return $filters;
-    }
-
-
-
-    /**
-     *    captures plugin activation errors for debugging
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ee_plugin_activation_errors()
-    {
-        if (WP_DEBUG) {
-            $activation_errors = ob_get_contents();
-            if (empty($activation_errors)) {
-                return;
-            }
-            $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
-            if (class_exists('EEH_File')) {
-                try {
-                    EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
-                    );
-                    EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
-                        $activation_errors
-                    );
-                } catch (EE_Error $e) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The Event Espresso activation errors file could not be setup because: %s',
-                                'event_espresso'
-                            ),
-                            $e->getMessage()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // old school attempt
-                file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
-                    $activation_errors
-                );
-            }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
-            update_option('ee_plugin_activation_errors', $activation_errors);
-        }
-    }
-
-
-
-    /**
-     * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
-     * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
-     * or we want to make sure they use something the right way.
-     *
-     * @access public
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     * @uses   trigger_error()
-     */
-    public function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        $applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
-        $error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
-        // because we swapped the parameter order around for the last two params,
-        // let's verify that some third party isn't still passing an error type value for the third param
-        if (is_int($applies_when)) {
-            $error_type = $applies_when;
-            $applies_when = espresso_version();
-        }
-        // if not displaying notices yet, then just leave
-        if (version_compare(espresso_version(), $applies_when, '<')) {
-            return;
-        }
-        do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
-        $version = $version === null
-            ? ''
-            : sprintf(
-                esc_html__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
-                $version
-            );
-        $error_message = sprintf(
-            esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
-            $function,
-            '<strong>',
-            '</strong>',
-            $message,
-            $version
-        );
-        // don't trigger error if doing ajax,
-        // instead we'll add a transient EE_Error notice that in theory should show on the next request.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
-                'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
-                'event_espresso'
-            );
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $error_message .= '<ul><li>';
-            $error_message .= implode('</li><li>', $request->requestParams());
-            $error_message .= '</ul>';
-            EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
-            // now we set this on the transient so it shows up on the next request.
-            EE_Error::get_notices(false, true);
-        } else {
-            trigger_error($error_message, $error_type);
-        }
-    }
-
-
-
-
-    /**
-     * Logger helpers
-     */
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @param string $debug_index
-     * @param string $debug_key
-     */
-    public static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        $info = array(),
-        $display_request = false,
-        $debug_index = '',
-        $debug_key = 'EE_DEBUG_SPCO'
-    ) {
-        if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
-            $debug_data = get_option($debug_key, array());
-            $default_data = array(
-                $class => $func . '() : ' . $line,
-            );
-            // don't serialize objects
-            $info = self::strip_objects($info);
-            $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
-            }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
-            update_option($debug_key, $debug_data);
-        }
-    }
-
-
-
-    /**
-     * strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public static function strip_objects($info = array())
-    {
-        foreach ($info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
-                if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
-                }
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     * @param string     $margin
-     */
-    public static function printv(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false,
-        $margin = ''
-    ) {
-        $var_name = ! $var_name ? 'string' : $var_name;
-        $var_name = ucwords(str_replace('$', '', $var_name));
-        $is_method = method_exists($var_name, $var);
-        $var_name = ucwords(str_replace('_', ' ', $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        // $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo wp_kses($result, AllowedTags::getWithFormTags());
-    }
-
-
-    protected static function headingTag($heading_tag)
-    {
-        $heading_tag = absint($heading_tag);
-        return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
-    }
-
-    protected static function headingSpacer($heading_tag)
-    {
-        return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
-            ? self::lineBreak()
-            : '';
-    }
-
-
-    protected static function plainOutput()
-    {
-        return defined('EE_TESTS_DIR')
-               || (defined('DOING_AJAX') && DOING_AJAX && ! isset($_REQUEST['pretty_output']))
-               || (
-                   isset($_SERVER['REQUEST_URI'])
-                   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
-               );
-    }
-
-
-    /**
-     * @param string $var_name
-     * @param string $heading_tag
-     * @param string $margin
-     * @param int    $line
-     * @return string
-     */
-    protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            switch ($heading_tag) {
-                case 'h1':
-                    $line_breaks = EEH_Debug_Tools::lineBreak(3);
-                    break;
-                case 'h2':
-                    $line_breaks = EEH_Debug_Tools::lineBreak(2);
-                    break;
-                default:
-                    $line_breaks = EEH_Debug_Tools::lineBreak();
-                    break;
-            }
-            return "{$line_breaks}{$line}) {$var_name}";
-        }
-        $margin = "1rem 1rem .5rem {$margin}";
-        return '
+	/**
+	 *    instance of the EEH_Autoloader object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array
+	 */
+	protected $_memory_usage_points = array();
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EEH_Debug_Tools
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_Debug_Tools) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private class constructor
+	 */
+	private function __construct()
+	{
+		// load Kint PHP debugging library
+		if (
+			defined('EE_LOAD_KINT')
+			&& ! class_exists('Kint')
+			&& file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
+		) {
+			// despite EE4 having a check for an existing copy of the Kint debugging class,
+			// if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
+			// then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
+			// so we've moved it to our test folder so that it is not included with production releases
+			// plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
+			require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
+		}
+		$plugin = basename(EE_PLUGIN_DIR_PATH);
+		add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
+	}
+
+
+
+	/**
+	 *    show_db_name
+	 *
+	 * @return void
+	 */
+	public static function show_db_name()
+	{
+		if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
+				 . DB_NAME
+				 . '</p>';
+		}
+		if (EE_DEBUG) {
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    dump EE_Session object at bottom of page after everything else has happened
+	 *
+	 * @return void
+	 */
+	public function espresso_session_footer_dump()
+	{
+		if (
+			(defined('WP_DEBUG') && WP_DEBUG)
+			&& ! defined('DOING_AJAX')
+			&& class_exists('Kint')
+			&& function_exists('wp_get_current_user')
+			&& current_user_can('update_core')
+			&& class_exists('EE_Registry')
+		) {
+			Kint::dump(EE_Registry::instance()->SSN->id());
+			Kint::dump(EE_Registry::instance()->SSN);
+			//          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
+			$this->espresso_list_hooked_functions();
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    List All Hooked Functions
+	 *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
+	 *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
+	 *
+	 * @param string $tag
+	 * @return void
+	 */
+	public function espresso_list_hooked_functions($tag = '')
+	{
+		global $wp_filter;
+		echo '<br/><br/><br/><h3>Hooked Functions</h3>';
+		if ($tag) {
+			$hook[ $tag ] = $wp_filter[ $tag ];
+			if (! is_array($hook[ $tag ])) {
+				trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
+				return;
+			}
+			echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
+		} else {
+			$hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
+			ksort($hook);
+		}
+		foreach ($hook as $tag_name => $priorities) {
+			echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>esc_html($tag_name)</strong><br />";
+			ksort($priorities);
+			foreach ($priorities as $priority => $function) {
+				echo esc_html($priority);
+				foreach ($function as $name => $properties) {
+					$name = esc_html($name);
+					echo "\t$name<br />";
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    registered_filter_callbacks
+	 *
+	 * @param string $hook_name
+	 * @return array
+	 */
+	public static function registered_filter_callbacks($hook_name = '')
+	{
+		$filters = array();
+		global $wp_filter;
+		if (isset($wp_filter[ $hook_name ])) {
+			$filters[ $hook_name ] = array();
+			foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
+				$filters[ $hook_name ][ $priority ] = array();
+				foreach ($callbacks as $callback) {
+					$filters[ $hook_name ][ $priority ][] = $callback['function'];
+				}
+			}
+		}
+		return $filters;
+	}
+
+
+
+	/**
+	 *    captures plugin activation errors for debugging
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ee_plugin_activation_errors()
+	{
+		if (WP_DEBUG) {
+			$activation_errors = ob_get_contents();
+			if (empty($activation_errors)) {
+				return;
+			}
+			$activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+			espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+			if (class_exists('EEH_File')) {
+				try {
+					EEH_File::ensure_file_exists_and_is_writable(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
+					);
+					EEH_File::write_to_file(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+						$activation_errors
+					);
+				} catch (EE_Error $e) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The Event Espresso activation errors file could not be setup because: %s',
+								'event_espresso'
+							),
+							$e->getMessage()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// old school attempt
+				file_put_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+					$activation_errors
+				);
+			}
+			$activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+			update_option('ee_plugin_activation_errors', $activation_errors);
+		}
+	}
+
+
+
+	/**
+	 * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
+	 * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
+	 * or we want to make sure they use something the right way.
+	 *
+	 * @access public
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 * @uses   trigger_error()
+	 */
+	public function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		$applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
+		$error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
+		// because we swapped the parameter order around for the last two params,
+		// let's verify that some third party isn't still passing an error type value for the third param
+		if (is_int($applies_when)) {
+			$error_type = $applies_when;
+			$applies_when = espresso_version();
+		}
+		// if not displaying notices yet, then just leave
+		if (version_compare(espresso_version(), $applies_when, '<')) {
+			return;
+		}
+		do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
+		$version = $version === null
+			? ''
+			: sprintf(
+				esc_html__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
+				$version
+			);
+		$error_message = sprintf(
+			esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
+			$function,
+			'<strong>',
+			'</strong>',
+			$message,
+			$version
+		);
+		// don't trigger error if doing ajax,
+		// instead we'll add a transient EE_Error notice that in theory should show on the next request.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$error_message .= ' ' . esc_html__(
+				'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
+				'event_espresso'
+			);
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$error_message .= '<ul><li>';
+			$error_message .= implode('</li><li>', $request->requestParams());
+			$error_message .= '</ul>';
+			EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
+			// now we set this on the transient so it shows up on the next request.
+			EE_Error::get_notices(false, true);
+		} else {
+			trigger_error($error_message, $error_type);
+		}
+	}
+
+
+
+
+	/**
+	 * Logger helpers
+	 */
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @param string $debug_index
+	 * @param string $debug_key
+	 */
+	public static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		$info = array(),
+		$display_request = false,
+		$debug_index = '',
+		$debug_key = 'EE_DEBUG_SPCO'
+	) {
+		if (WP_DEBUG) {
+			$debug_key = $debug_key . '_' . EE_Session::instance()->id();
+			$debug_data = get_option($debug_key, array());
+			$default_data = array(
+				$class => $func . '() : ' . $line,
+			);
+			// don't serialize objects
+			$info = self::strip_objects($info);
+			$index = ! empty($debug_index) ? $debug_index : 0;
+			if (! isset($debug_data[ $index ])) {
+				$debug_data[ $index ] = array();
+			}
+			$debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+			update_option($debug_key, $debug_data);
+		}
+	}
+
+
+
+	/**
+	 * strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public static function strip_objects($info = array())
+	{
+		foreach ($info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = self::strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+				if (method_exists($value, 'ID')) {
+					$info[ $object_class ]['ID'] = $value->ID();
+				}
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 * @param string     $margin
+	 */
+	public static function printv(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false,
+		$margin = ''
+	) {
+		$var_name = ! $var_name ? 'string' : $var_name;
+		$var_name = ucwords(str_replace('$', '', $var_name));
+		$is_method = method_exists($var_name, $var);
+		$var_name = ucwords(str_replace('_', ' ', $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		// $result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= $is_method
+			? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
+			: EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo wp_kses($result, AllowedTags::getWithFormTags());
+	}
+
+
+	protected static function headingTag($heading_tag)
+	{
+		$heading_tag = absint($heading_tag);
+		return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
+	}
+
+	protected static function headingSpacer($heading_tag)
+	{
+		return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
+			? self::lineBreak()
+			: '';
+	}
+
+
+	protected static function plainOutput()
+	{
+		return defined('EE_TESTS_DIR')
+			   || (defined('DOING_AJAX') && DOING_AJAX && ! isset($_REQUEST['pretty_output']))
+			   || (
+				   isset($_SERVER['REQUEST_URI'])
+				   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
+			   );
+	}
+
+
+	/**
+	 * @param string $var_name
+	 * @param string $heading_tag
+	 * @param string $margin
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			switch ($heading_tag) {
+				case 'h1':
+					$line_breaks = EEH_Debug_Tools::lineBreak(3);
+					break;
+				case 'h2':
+					$line_breaks = EEH_Debug_Tools::lineBreak(2);
+					break;
+				default:
+					$line_breaks = EEH_Debug_Tools::lineBreak();
+					break;
+			}
+			return "{$line_breaks}{$line}) {$var_name}";
+		}
+		$margin = "1rem 1rem .5rem {$margin}";
+		return '
         <' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . '; position: sticky;">
             <b>' . $var_name . '</b>';
-    }
+	}
 
 
 
-    /**
-     * @param string $heading_tag
-     * @return string
-     */
-    protected static function headingX($heading_tag = 'h5')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return '';
-        }
-        return '
+	/**
+	 * @param string $heading_tag
+	 * @return string
+	 */
+	protected static function headingX($heading_tag = 'h5')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return '';
+		}
+		return '
         </' . $heading_tag . '>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function grey_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#999">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param string $file
-     * @param int    $line
-     * @return string
-     */
-    protected static function file_and_line($file, $line, $heading_tag)
-    {
-        if ($file === '' || $line === '') {
-            return '';
-        }
-        $file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
-        if (EEH_Debug_Tools::plainOutput()) {
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                return " ({$file})" . EEH_Debug_Tools::lineBreak();
-            }
-            return '';
-        }
-        return EEH_Debug_Tools::lineBreak()
-               . '<span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
-               . $file
-               . EEH_Debug_Tools::lineBreak()
-               . 'line no: '
-               . $line
-               . '</span>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function orange_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#E76700">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param mixed $var
-     * @return string
-     */
-    protected static function pre_span($var)
-    {
-        $var = var_export($var, true);
-        if (EEH_Debug_Tools::plainOutput()) {
-            return str_replace("\n", '', $var);
-        }
-        $style =[
-            'background: #334',
-            'color: #9C3',
-            'display: inline-block',
-            'padding: .4em .6em',
-        ];
-        return '<pre style="' . implode('; ', $style) . '">' . $var . '</pre>';
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     */
-    public static function printr(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false
-    ) {
-        // return;
-        $file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
-        if (empty($var) && empty($var_name)) {
-            $var = $file;
-            $var_name = "line $line";
-            $file = '';
-            $line = '';
-        }
-        $margin = is_admin() ? '180px' : '2rem';
-        if (is_string($var)) {
-            EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
-            return;
-        }
-        if (is_object($var)) {
-            $var_name = ! $var_name ? 'object' : $var_name;
-        } elseif (is_array($var)) {
-            $var_name = ! $var_name ? 'array' : $var_name;
-        } elseif (is_numeric($var)) {
-            $var_name = ! $var_name ? 'numeric' : $var_name;
-        } elseif ($var === null) {
-            $var_name = ! $var_name ? 'null' : $var_name;
-        }
-        $var_name = EEH_Debug_Tools::trimVarName($var_name);
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        // $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
-            EEH_Debug_Tools::pre_span($var)
-        );
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo wp_kses($result, AllowedTags::getWithFormTags());
-    }
-
-
-    private static function trimVarName($var_name): string
-    {
-        $converted = str_replace(['$', '_', 'this->'], ['', ' ', ''], $var_name);
-        $words = explode(' ', $converted);
-        $words = array_map(
-            function ($word) {
-                return $word === 'id' || $word === 'Id' ? 'ID' : $word;
-            },
-            $words
-        );
-        return ucwords(implode(' ', $words));
-    }
-
-
-    private static function lineBreak($lines = 1): string
-    {
-        $linebreak = defined('DOING_AJAX') && DOING_AJAX ? '<br />' : PHP_EOL;
-        return str_repeat($linebreak, $lines);
-    }
-
-
-    public static function shortClassName(string $fqcn): string
-    {
-        return substr(strrchr($fqcn, '\\'), 1);
-    }
-
-
-
-    /******************** deprecated ********************/
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     */
-    public function reset_times()
-    {
-        Benchmark::resetTimes();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param null $timer_name
-     */
-    public function start_timer($timer_name = null)
-    {
-        Benchmark::startTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     */
-    public function stop_timer($timer_name = '')
-    {
-        Benchmark::stopTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @return void
-     */
-    public function measure_memory($label, $output_now = false)
-    {
-        Benchmark::measureMemory($label, $output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param int $size
-     * @return string
-     */
-    public function convert($size)
-    {
-        return Benchmark::convert($size);
-    }
-
-
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function grey_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#999">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $file
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function file_and_line($file, $line, $heading_tag)
+	{
+		if ($file === '' || $line === '') {
+			return '';
+		}
+		$file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
+		if (EEH_Debug_Tools::plainOutput()) {
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				return " ({$file})" . EEH_Debug_Tools::lineBreak();
+			}
+			return '';
+		}
+		return EEH_Debug_Tools::lineBreak()
+			   . '<span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
+			   . $file
+			   . EEH_Debug_Tools::lineBreak()
+			   . 'line no: '
+			   . $line
+			   . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function orange_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#E76700">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param mixed $var
+	 * @return string
+	 */
+	protected static function pre_span($var)
+	{
+		$var = var_export($var, true);
+		if (EEH_Debug_Tools::plainOutput()) {
+			return str_replace("\n", '', $var);
+		}
+		$style =[
+			'background: #334',
+			'color: #9C3',
+			'display: inline-block',
+			'padding: .4em .6em',
+		];
+		return '<pre style="' . implode('; ', $style) . '">' . $var . '</pre>';
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 */
+	public static function printr(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false
+	) {
+		// return;
+		$file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
+		if (empty($var) && empty($var_name)) {
+			$var = $file;
+			$var_name = "line $line";
+			$file = '';
+			$line = '';
+		}
+		$margin = is_admin() ? '180px' : '2rem';
+		if (is_string($var)) {
+			EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
+			return;
+		}
+		if (is_object($var)) {
+			$var_name = ! $var_name ? 'object' : $var_name;
+		} elseif (is_array($var)) {
+			$var_name = ! $var_name ? 'array' : $var_name;
+		} elseif (is_numeric($var)) {
+			$var_name = ! $var_name ? 'numeric' : $var_name;
+		} elseif ($var === null) {
+			$var_name = ! $var_name ? 'null' : $var_name;
+		}
+		$var_name = EEH_Debug_Tools::trimVarName($var_name);
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		// $result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+			EEH_Debug_Tools::pre_span($var)
+		);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo wp_kses($result, AllowedTags::getWithFormTags());
+	}
+
+
+	private static function trimVarName($var_name): string
+	{
+		$converted = str_replace(['$', '_', 'this->'], ['', ' ', ''], $var_name);
+		$words = explode(' ', $converted);
+		$words = array_map(
+			function ($word) {
+				return $word === 'id' || $word === 'Id' ? 'ID' : $word;
+			},
+			$words
+		);
+		return ucwords(implode(' ', $words));
+	}
+
+
+	private static function lineBreak($lines = 1): string
+	{
+		$linebreak = defined('DOING_AJAX') && DOING_AJAX ? '<br />' : PHP_EOL;
+		return str_repeat($linebreak, $lines);
+	}
+
+
+	public static function shortClassName(string $fqcn): string
+	{
+		return substr(strrchr($fqcn, '\\'), 1);
+	}
+
+
+
+	/******************** deprecated ********************/
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 */
+	public function reset_times()
+	{
+		Benchmark::resetTimes();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param null $timer_name
+	 */
+	public function start_timer($timer_name = null)
+	{
+		Benchmark::startTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 */
+	public function stop_timer($timer_name = '')
+	{
+		Benchmark::stopTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @return void
+	 */
+	public function measure_memory($label, $output_now = false)
+	{
+		Benchmark::measureMemory($label, $output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param int $size
+	 * @return string
+	 */
+	public function convert($size)
+	{
+		return Benchmark::convert($size);
+	}
+
+
 
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param bool $output_now
-     * @return string
-     */
-    public function show_times($output_now = true)
-    {
-        return Benchmark::displayResults($output_now);
-    }
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param bool $output_now
+	 * @return string
+	 */
+	public function show_times($output_now = true)
+	{
+		return Benchmark::displayResults($output_now);
+	}
 
 
 
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     * @param float  $total_time
-     * @return string
-     */
-    public function format_time($timer_name, $total_time)
-    {
-        return Benchmark::formatTime($timer_name, $total_time);
-    }
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @return string
+	 */
+	public function format_time($timer_name, $total_time)
+	{
+		return Benchmark::formatTime($timer_name, $total_time);
+	}
 }
 
 
@@ -734,31 +734,31 @@ 
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp_query')) {
-    function dump_wp_query()
-    {
-        global $wp_query;
-        d($wp_query);
-    }
+	function dump_wp_query()
+	{
+		global $wp_query;
+		d($wp_query);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp')) {
-    function dump_wp()
-    {
-        global $wp;
-        d($wp);
-    }
+	function dump_wp()
+	{
+		global $wp;
+		d($wp);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_post')) {
-    function dump_post()
-    {
-        global $post;
-        d($post);
-    }
+	function dump_post()
+	{
+		global $post;
+		d($post);
+	}
 }

Spacing +43 added lines, -43 removed lines

@@ -38,7 +38,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
+        if ( ! self::$_instance instanceof EEH_Debug_Tools) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -55,14 +55,14 @@ 
         if (
             defined('EE_LOAD_KINT')
             && ! class_exists('Kint')
-            && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
+            && file_exists(EE_PLUGIN_DIR_PATH.'tests/kint/Kint.class.php')
         ) {
             // despite EE4 having a check for an existing copy of the Kint debugging class,
             // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
             // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
             // so we've moved it to our test folder so that it is not included with production releases
             // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
+            require_once(EE_PLUGIN_DIR_PATH.'tests/kint/Kint.class.php');
         }
         $plugin = basename(EE_PLUGIN_DIR_PATH);
         add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
@@ -79,7 +79,7 @@ 
      */
     public static function show_db_name()
     {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+        if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
             echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
                  . DB_NAME
                  . '</p>';
@@ -129,12 +129,12 @@ 
         global $wp_filter;
         echo '<br/><br/><br/><h3>Hooked Functions</h3>';
         if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
+            $hook[$tag] = $wp_filter[$tag];
+            if ( ! is_array($hook[$tag])) {
                 trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
                 return;
             }
-            echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
+            echo '<h5>For Tag: '.esc_html($tag).'</h5>';
         } else {
             $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
             ksort($hook);
@@ -164,12 +164,12 @@ 
     {
         $filters = array();
         global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
+        if (isset($wp_filter[$hook_name])) {
+            $filters[$hook_name] = array();
+            foreach ($wp_filter[$hook_name] as $priority => $callbacks) {
+                $filters[$hook_name][$priority] = array();
                 foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
+                    $filters[$hook_name][$priority][] = $callback['function'];
                 }
             }
         }
@@ -191,15 +191,15 @@ 
             if (empty($activation_errors)) {
                 return;
             }
-            $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+            $activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors;
+            espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php');
             if (class_exists('EEH_File')) {
                 try {
                     EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html'
                     );
                     EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html',
                         $activation_errors
                     );
                 } catch (EE_Error $e) {
@@ -219,11 +219,11 @@ 
             } else {
                 // old school attempt
                 file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+                    EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html',
                     $activation_errors
                 );
             }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+            $activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors;
             update_option('ee_plugin_activation_errors', $activation_errors);
         }
     }
@@ -283,7 +283,7 @@ 
         // don't trigger error if doing ajax,
         // instead we'll add a transient EE_Error notice that in theory should show on the next request.
         if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
+            $error_message .= ' '.esc_html__(
                 'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
                 'event_espresso'
             );
@@ -326,18 +326,18 @@ 
         $debug_key = 'EE_DEBUG_SPCO'
     ) {
         if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
+            $debug_key = $debug_key.'_'.EE_Session::instance()->id();
             $debug_data = get_option($debug_key, array());
             $default_data = array(
-                $class => $func . '() : ' . $line,
+                $class => $func.'() : '.$line,
             );
             // don't serialize objects
             $info = self::strip_objects($info);
             $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
+            if ( ! isset($debug_data[$index])) {
+                $debug_data[$index] = array();
             }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+            $debug_data[$index][microtime()] = array_merge($default_data, $info);
             update_option($debug_key, $debug_data);
         }
     }
@@ -354,20 +354,20 @@ 
     {
         foreach ($info as $key => $value) {
             if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
+                $info[$key] = self::strip_objects($value);
             } elseif (is_object($value)) {
                 $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+                $info[$object_class] = array();
+                $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
                 if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
+                    $info[$object_class]['ID'] = $value->ID();
                 }
                 if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
+                    $info[$object_class]['status'] = $value->status();
                 } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
+                    $info[$object_class]['status'] = $value->status_ID();
                 }
-                unset($info[ $key ]);
+                unset($info[$key]);
             }
         }
         return (array) $info;
@@ -401,8 +401,8 @@ 
         // $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
         $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+            ? EEH_Debug_Tools::grey_span('::').EEH_Debug_Tools::orange_span($var.'()')
+            : EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span($var);
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
         $result .= EEH_Debug_Tools::headingX($heading_tag);
         if ($die) {
@@ -462,8 +462,8 @@ 
         }
         $margin = "1rem 1rem .5rem {$margin}";
         return '
-        <' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . '; position: sticky;">
-            <b>' . $var_name . '</b>';
+        <' . $heading_tag.' style="color:#2EA2CC; margin:'.$margin.'; position: sticky;">
+            <b>' . $var_name.'</b>';
     }
 
 
@@ -478,7 +478,7 @@ 
             return '';
         }
         return '
-        </' . $heading_tag . '>';
+        </' . $heading_tag.'>';
     }
 
 
@@ -492,7 +492,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#999">' . $content . '</span>';
+        return '<span style="color:#999">'.$content.'</span>';
     }
 
 
@@ -510,7 +510,7 @@ 
         $file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
         if (EEH_Debug_Tools::plainOutput()) {
             if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                return " ({$file})" . EEH_Debug_Tools::lineBreak();
+                return " ({$file})".EEH_Debug_Tools::lineBreak();
             }
             return '';
         }
@@ -534,7 +534,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#E76700">' . $content . '</span>';
+        return '<span style="color:#E76700">'.$content.'</span>';
     }
 
 
@@ -549,13 +549,13 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return str_replace("\n", '', $var);
         }
-        $style =[
+        $style = [
             'background: #334',
             'color: #9C3',
             'display: inline-block',
             'padding: .4em .6em',
         ];
-        return '<pre style="' . implode('; ', $style) . '">' . $var . '</pre>';
+        return '<pre style="'.implode('; ', $style).'">'.$var.'</pre>';
     }
 
 
@@ -602,7 +602,7 @@ 
         $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
         // $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result = EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+        $result .= EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span(
             EEH_Debug_Tools::pre_span($var)
         );
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
@@ -619,7 +619,7 @@ 
         $converted = str_replace(['$', '_', 'this->'], ['', ' ', ''], $var_name);
         $words = explode(' ', $converted);
         $words = array_map(
-            function ($word) {
+            function($word) {
                 return $word === 'id' || $word === 'Id' ? 'ID' : $word;
             },
             $words