eventespresso / event-espresso-core

espresso.php

Indentation +107 added lines, -107 removed lines

@@ -37,138 +37,138 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time.
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time.
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
 <div class="error">
 	<p>
 		<?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
 	</p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
 <div class="error">
 	<p>
 		<?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
+					);
+					?>
 	</p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
 
-        require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/autoload.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version(): string
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.10.rc.000');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version(): string
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.10.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-            update_option('event-espresso-core_allow_tracking', 'no');
-            update_option('event-espresso-core_tracking_notice', 'hide');
-            // Run WP GraphQL activation callback
-            espressoLoadWpGraphQL();
-            graphql_activation_callback();
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+			update_option('event-espresso-core_allow_tracking', 'no');
+			update_option('event-espresso-core_tracking_notice', 'hide');
+			// Run WP GraphQL activation callback
+			espressoLoadWpGraphQL();
+			graphql_activation_callback();
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        /**
-         * espresso_plugin_deactivation
-         */
-        function espresso_plugin_deactivation()
-        {
-            // Run WP GraphQL deactivation callback
-            espressoLoadWpGraphQL();
-            graphql_deactivation_callback();
-            delete_option('event-espresso-core_allow_tracking');
-            delete_option('event-espresso-core_tracking_notice');
-        }
-        register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
+		/**
+		 * espresso_plugin_deactivation
+		 */
+		function espresso_plugin_deactivation()
+		{
+			// Run WP GraphQL deactivation callback
+			espressoLoadWpGraphQL();
+			graphql_deactivation_callback();
+			delete_option('event-espresso-core_allow_tracking');
+			delete_option('event-espresso-core_tracking_notice');
+		}
+		register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin(string $plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin(string $plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
 
 
 if (! function_exists('espressoLoadWpGraphQL')) {
-    function espressoLoadWpGraphQL()
-    {
-        if (
-            ! class_exists('WPGraphQL')
-            && is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
-        ) {
-            require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
-        }
-    }
+	function espressoLoadWpGraphQL()
+	{
+		if (
+			! class_exists('WPGraphQL')
+			&& is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
+		) {
+			require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
+		}
+	}
 }

core/db_models/relations/EE_HABTM_Relation.php

Indentation +262 added lines, -262 removed lines

@@ -9,291 +9,291 @@
  */
 class EE_HABTM_Relation extends EE_Model_Relation_Base
 {
-    /**
-     * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
-     * which joins EE_Event and EE_Question_Group
-     */
-    protected ?string $_joining_model_name                 = '';
+	/**
+	 * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
+	 * which joins EE_Event and EE_Question_Group
+	 */
+	protected ?string $_joining_model_name                 = '';
 
-    protected ?string $_model_relation_chain_to_join_model = '';
+	protected ?string $_model_relation_chain_to_join_model = '';
 
 
-    /**
-     * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
-     * (and an ee joining-model.) This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param string $joining_model_name
-     * @param bool   $block_deletes                  for this type of relation, we block by default for now. if there
-     *                                               are related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct(
-        $joining_model_name,
-        bool $block_deletes = true,
-        string $blocking_delete_error_message = ''
-    ) {
-        $this->_joining_model_name = $joining_model_name;
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
+	 * (and an ee joining-model.) This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param string $joining_model_name
+	 * @param bool   $block_deletes                  for this type of relation, we block by default for now. if there
+	 *                                               are related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct(
+		$joining_model_name,
+		bool $block_deletes = true,
+		string $blocking_delete_error_message = ''
+	) {
+		$this->_joining_model_name = $joining_model_name;
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
 
 
-    /**
-     * Gets the joining model's object
-     *
-     * @return EEM_Base
-     * @throws Exception
-     */
-    public function get_join_model(): EEM_Base
-    {
-        return $this->_get_model($this->_joining_model_name);
-    }
+	/**
+	 * Gets the joining model's object
+	 *
+	 * @return EEM_Base
+	 * @throws Exception
+	 */
+	public function get_join_model(): EEM_Base
+	{
+		return $this->_get_model($this->_joining_model_name);
+	}
 
 
-    /**
-     * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
-     * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function get_join_to_intermediate_model_statement(string $model_relation_chain): string
-    {
-        // create sql like
-        // LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
-        // LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
-        // remember the model relation chain to the JOIN model, because we'll
-        // need it for get_join_statement()
-        $this->_model_relation_chain_to_join_model = $model_relation_chain;
-        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field(
-        );// get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $join_table_fk_field_to_this_table         =
-            $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_this_model()->get_this_model_name()
-            ) . $this_table_pk_field->get_table_alias();
+	/**
+	 * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
+	 * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function get_join_to_intermediate_model_statement(string $model_relation_chain): string
+	{
+		// create sql like
+		// LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
+		// LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
+		// remember the model relation chain to the JOIN model, because we'll
+		// need it for get_join_statement()
+		$this->_model_relation_chain_to_join_model = $model_relation_chain;
+		$this_table_pk_field                       = $this->get_this_model()->get_primary_key_field(
+		);// get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$join_table_fk_field_to_this_table         =
+			$this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_this_model()->get_this_model_name()
+			) . $this_table_pk_field->get_table_alias();
 
-        $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_join_model()->get_this_model_name()
-            ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
-        // phew! ok, we have all the info we need, now we can create the SQL join string
-        return $this->_left_join(
-                $join_table,
-                $join_table_alias,
-                $join_table_fk_field_to_this_table->get_table_column(),
-                $this_table_alias,
-                $this_table_pk_field->get_table_column()
-            ) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
-    }
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_join_model()->get_this_model_name()
+			) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
+		// phew! ok, we have all the info we need, now we can create the SQL join string
+		return $this->_left_join(
+				$join_table,
+				$join_table_alias,
+				$join_table_fk_field_to_this_table->get_table_column(),
+				$this_table_alias,
+				$this_table_pk_field->get_table_column()
+			) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+	}
 
 
-    /**
-     * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
-     * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
-     * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
-     * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
-     * the intermediate join table, and then to the other model's pk's table
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function get_join_statement(string $model_relation_chain): string
-    {
-        if (empty($this->_model_relation_chain_to_join_model)) {
-            throw new EE_Error(
-                esc_html__(
-                    'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
-                    'event_espresso'
-                )
-            );
-        }
-        $join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to(
-            $this->get_this_model()->get_this_model_name()
-        );
-        $join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $this->_model_relation_chain_to_join_model,
-                $this->get_join_model()->get_this_model_name()
-            ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
-        $join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to(
-            $this->get_other_model()->get_this_model_name()
-        );
-        $other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_other_model()->get_this_model_name()
-            ) . $other_table_pk_field->get_table_alias();
-        $other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
+	/**
+	 * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
+	 * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
+	 * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
+	 * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
+	 * the intermediate join table, and then to the other model's pk's table
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function get_join_statement(string $model_relation_chain): string
+	{
+		if (empty($this->_model_relation_chain_to_join_model)) {
+			throw new EE_Error(
+				esc_html__(
+					'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
+					'event_espresso'
+				)
+			);
+		}
+		$join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to(
+			$this->get_this_model()->get_this_model_name()
+		);
+		$join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$this->_model_relation_chain_to_join_model,
+				$this->get_join_model()->get_this_model_name()
+			) . $join_table_fk_field_to_this_table->get_table_alias();
+		$other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
+		$join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to(
+			$this->get_other_model()->get_this_model_name()
+		);
+		$other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_other_model()->get_this_model_name()
+			) . $other_table_pk_field->get_table_alias();
+		$other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
-        return $this->_left_join(
-                $other_table,
-                $other_table_alias,
-                $other_table_pk_field->get_table_column(),
-                $join_table_alias,
-                $join_table_fk_field_to_other_table->get_table_column()
-            ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
-    }
+		return $this->_left_join(
+				$other_table,
+				$other_table_alias,
+				$other_table_pk_field->get_table_column(),
+				$join_table_alias,
+				$join_table_fk_field_to_other_table->get_table_column()
+			) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+	}
 
 
-    /**
-     * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
-     * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
-     * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
-     * columns' values
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
-     *                                                            checking existing values and for setting new rows if
-     *                                                            no exact matches.
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $extra_join_model_fields_n_values = []
-    ): EE_Base_Class {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // check if such a relationship already exists
-        $join_model_fk_to_this_model  =
-            $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_model_fk_to_other_model =
-            $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+	/**
+	 * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
+	 * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
+	 * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
+	 * columns' values
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
+	 *                                                            checking existing values and for setting new rows if
+	 *                                                            no exact matches.
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $extra_join_model_fields_n_values = []
+	): EE_Base_Class {
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model  =
+			$this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_model_fk_to_other_model =
+			$this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-        $foreign_keys = $all_fields = [
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
-        ];
+		$foreign_keys = $all_fields = [
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
+		];
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = [];
-            foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                  = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $all_fields = array_merge($foreign_keys, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($extra_join_model_fields_n_values)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = [];
+			foreach ($extra_join_model_fields_n_values as $query_param => $val) {
+				$query_param                  = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$all_fields = array_merge($foreign_keys, $parsed_query);
+		}
 
-        $existing_entry_in_join_table = $this->get_join_model()->get_one([$foreign_keys]);
-        // If there is already an entry in the join table, indicating a relationship, update it instead of adding a
-        // new row.
-        // Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
-        // the other tables) use the joining model directly!
-        if (! $existing_entry_in_join_table) {
-            $this->get_join_model()->insert($all_fields);
-        } else {
-            $this->get_join_model()->update(
-                $all_fields,
-                [$foreign_keys]
-            );
-        }
-        return $other_model_obj;
-    }
+		$existing_entry_in_join_table = $this->get_join_model()->get_one([$foreign_keys]);
+		// If there is already an entry in the join table, indicating a relationship, update it instead of adding a
+		// new row.
+		// Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
+		// the other tables) use the joining model directly!
+		if (! $existing_entry_in_join_table) {
+			$this->get_join_model()->insert($all_fields);
+		} else {
+			$this->get_join_model()->update(
+				$all_fields,
+				[$foreign_keys]
+			);
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Deletes any rows in the join table that have foreign keys matching the other model objects specified
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
-     *                                       values and for removing existing rows if exact matches exist.
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // check if such a relationship already exists
-        $join_model_fk_to_this_model  =
-            $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_model_fk_to_other_model =
-            $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+	/**
+	 * Deletes any rows in the join table that have foreign keys matching the other model objects specified
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
+	 *                                       values and for removing existing rows if exact matches exist.
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model  =
+			$this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_model_fk_to_other_model =
+			$this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-        $cols_n_values = [
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
-        ];
+		$cols_n_values = [
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
+		];
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = [];
-            foreach ($where_query as $query_param => $val) {
-                $query_param                  = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($where_query)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = [];
+			foreach ($where_query as $query_param => $val) {
+				$query_param                  = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
 
-        $this->get_join_model()->delete([$cols_n_values]);
-        return $other_model_obj;
-    }
+		$this->get_join_model()->delete([$cols_n_values]);
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Gets all the non-key fields (ie, not the primary key and not foreign keys) on the join model.
-     *
-     * @return EE_Model_Field_Base[]
-     * @throws EE_Error
-     * @throws Exception
-     * @since 4.9.76.p
-     */
-    public function getNonKeyFields(): array
-    {
-        // all fields besides the primary key and two foreign keys should be parameters
-        $join_model      = $this->get_join_model();
-        $standard_fields = [];
-        if ($join_model->has_primary_key_field()) {
-            $standard_fields[] = $join_model->primary_key_name();
-        }
-        if ($this->get_this_model()->has_primary_key_field()) {
-            $standard_fields[] = $this->get_this_model()->primary_key_name();
-        }
-        if ($this->get_other_model()->has_primary_key_field()) {
-            $standard_fields[] = $this->get_other_model()->primary_key_name();
-        }
-        return array_diff_key(
-            $join_model->field_settings(),
-            array_flip($standard_fields)
-        );
-    }
+	/**
+	 * Gets all the non-key fields (ie, not the primary key and not foreign keys) on the join model.
+	 *
+	 * @return EE_Model_Field_Base[]
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @since 4.9.76.p
+	 */
+	public function getNonKeyFields(): array
+	{
+		// all fields besides the primary key and two foreign keys should be parameters
+		$join_model      = $this->get_join_model();
+		$standard_fields = [];
+		if ($join_model->has_primary_key_field()) {
+			$standard_fields[] = $join_model->primary_key_name();
+		}
+		if ($this->get_this_model()->has_primary_key_field()) {
+			$standard_fields[] = $this->get_this_model()->primary_key_name();
+		}
+		if ($this->get_other_model()->has_primary_key_field()) {
+			$standard_fields[] = $this->get_other_model()->primary_key_name();
+		}
+		return array_diff_key(
+			$join_model->field_settings(),
+			array_flip($standard_fields)
+		);
+	}
 
 
-    /**
-     * Returns true if the join model has non-key fields (ie, fields that aren't the primary key or foreign keys.)
-     *
-     * @return boolean
-     * @throws Exception
-     * @since 4.9.76.p
-     */
-    public function hasNonKeyFields(): bool
-    {
-        return count($this->get_join_model()->field_settings()) > 3;
-    }
+	/**
+	 * Returns true if the join model has non-key fields (ie, fields that aren't the primary key or foreign keys.)
+	 *
+	 * @return boolean
+	 * @throws Exception
+	 * @since 4.9.76.p
+	 */
+	public function hasNonKeyFields(): bool
+	{
+		return count($this->get_join_model()->field_settings()) > 3;
+	}
 }

core/db_models/relations/EE_Model_Relation_Base.php

Indentation +524 added lines, -524 removed lines

@@ -16,531 +16,531 @@
  */
 abstract class EE_Model_Relation_Base implements HasSchemaInterface
 {
-    /**
-     * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private ?string $_this_model_name = '';
-
-    /**
-     * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private ?string $_other_model_name = '';
-
-    /**
-     * this is typically used when calling the relation models to make sure they inherit any set timezone from the
-     * initiating model.
-     *
-     * @var string
-     */
-    protected ?string $_timezone = '';
-
-    /**
-     * If you try to delete "this_model", and there are related "other_models",
-     * and this isn't null, then abandon the deletion and add this warning.
-     * This effectively makes it impossible to delete "this_model" while there are
-     * related "other_models" along this relation.
-     *
-     * @var string (internationalized)
-     */
-    protected ?string $_blocking_delete_error_message;
-
-    protected bool   $_blocking_delete = false;
-
-
-    /**
-     * Object representing the relationship between two models. This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param bool   $block_deletes                  if there are related models across this relation, block (prevent
-     *                                               and add an error) the deletion of this model
-     * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct(bool $block_deletes = false, string $blocking_delete_error_message = '')
-    {
-        $this->_blocking_delete               = filter_var($block_deletes, FILTER_VALIDATE_BOOLEAN);
-        $this->_blocking_delete_error_message = $blocking_delete_error_message;
-    }
-
-
-    /**
-     * @param $this_model_name
-     * @param $other_model_name
-     */
-    public function _construct_finalize_set_models($this_model_name, $other_model_name)
-    {
-        $this->_this_model_name  = $this_model_name;
-        $this->_other_model_name = $other_model_name;
-    }
-
-
-    /**
-     * Gets the model where this relation is defined.
-     *
-     * @return EEM_Base
-     * @throws Exception
-     */
-    public function get_this_model(): EEM_Base
-    {
-        return $this->_get_model($this->_this_model_name);
-    }
-
-
-    /**
-     * Gets the model which this relation establishes the relation TO (ie,
-     * this relation object was defined on get_this_model(), get_other_model() is the other one)
-     *
-     * @return EEM_Base
-     * @throws Exception
-     */
-    public function get_other_model(): EEM_Base
-    {
-        return $this->_get_model($this->_other_model_name);
-    }
-
-
-    /**
-     * Internally used by get_this_model() and get_other_model()
-     *
-     * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-     * @return EEM_Base
-     * @throws Exception
-     */
-    protected function _get_model(string $model_name): EEM_Base
-    {
-        /** @var EEM_Base $modelInstance */
-        $modelInstance = EE_Registry::instance()->load_model($model_name);
-        $modelInstance->set_timezone($this->_timezone);
-        return $modelInstance;
-    }
-
-
-    /**
-     * entirely possible that relations may be called from a model and we need to make sure those relations have their
-     * timezone set correctly.
-     *
-     * @param string|null $timezone timezone to set.
-     */
-    public function set_timezone(?string $timezone = '')
-    {
-        if ($timezone) {
-            $this->_timezone = $timezone;
-        }
-    }
-
-
-    /**
-     * @param string $other_table
-     * @param string $other_table_alias
-     * @param string $other_table_column
-     * @param string $this_table_alias
-     * @param string $this_table_join_column
-     * @param string $extra_join_sql
-     * @return string
-     */
-    protected function _left_join(
-        string $other_table,
-        string $other_table_alias,
-        string $other_table_column,
-        string $this_table_alias,
-        string $this_table_join_column,
-        string $extra_join_sql = ''
-    ): string {
-        return " 
+	/**
+	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private ?string $_this_model_name = '';
+
+	/**
+	 * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private ?string $_other_model_name = '';
+
+	/**
+	 * this is typically used when calling the relation models to make sure they inherit any set timezone from the
+	 * initiating model.
+	 *
+	 * @var string
+	 */
+	protected ?string $_timezone = '';
+
+	/**
+	 * If you try to delete "this_model", and there are related "other_models",
+	 * and this isn't null, then abandon the deletion and add this warning.
+	 * This effectively makes it impossible to delete "this_model" while there are
+	 * related "other_models" along this relation.
+	 *
+	 * @var string (internationalized)
+	 */
+	protected ?string $_blocking_delete_error_message;
+
+	protected bool   $_blocking_delete = false;
+
+
+	/**
+	 * Object representing the relationship between two models. This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param bool   $block_deletes                  if there are related models across this relation, block (prevent
+	 *                                               and add an error) the deletion of this model
+	 * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct(bool $block_deletes = false, string $blocking_delete_error_message = '')
+	{
+		$this->_blocking_delete               = filter_var($block_deletes, FILTER_VALIDATE_BOOLEAN);
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
+	}
+
+
+	/**
+	 * @param $this_model_name
+	 * @param $other_model_name
+	 */
+	public function _construct_finalize_set_models($this_model_name, $other_model_name)
+	{
+		$this->_this_model_name  = $this_model_name;
+		$this->_other_model_name = $other_model_name;
+	}
+
+
+	/**
+	 * Gets the model where this relation is defined.
+	 *
+	 * @return EEM_Base
+	 * @throws Exception
+	 */
+	public function get_this_model(): EEM_Base
+	{
+		return $this->_get_model($this->_this_model_name);
+	}
+
+
+	/**
+	 * Gets the model which this relation establishes the relation TO (ie,
+	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
+	 *
+	 * @return EEM_Base
+	 * @throws Exception
+	 */
+	public function get_other_model(): EEM_Base
+	{
+		return $this->_get_model($this->_other_model_name);
+	}
+
+
+	/**
+	 * Internally used by get_this_model() and get_other_model()
+	 *
+	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
+	 * @return EEM_Base
+	 * @throws Exception
+	 */
+	protected function _get_model(string $model_name): EEM_Base
+	{
+		/** @var EEM_Base $modelInstance */
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		$modelInstance->set_timezone($this->_timezone);
+		return $modelInstance;
+	}
+
+
+	/**
+	 * entirely possible that relations may be called from a model and we need to make sure those relations have their
+	 * timezone set correctly.
+	 *
+	 * @param string|null $timezone timezone to set.
+	 */
+	public function set_timezone(?string $timezone = '')
+	{
+		if ($timezone) {
+			$this->_timezone = $timezone;
+		}
+	}
+
+
+	/**
+	 * @param string $other_table
+	 * @param string $other_table_alias
+	 * @param string $other_table_column
+	 * @param string $this_table_alias
+	 * @param string $this_table_join_column
+	 * @param string $extra_join_sql
+	 * @return string
+	 */
+	protected function _left_join(
+		string $other_table,
+		string $other_table_alias,
+		string $other_table_column,
+		string $this_table_alias,
+		string $this_table_join_column,
+		string $extra_join_sql = ''
+	): string {
+		return " 
         LEFT JOIN " . $other_table . " AS " . $other_table_alias . " 
         ON " . $other_table_alias . "." . $other_table_column
-               . "=" . $this_table_alias . "." . $this_table_join_column
-               . ($extra_join_sql ? " AND $extra_join_sql" : '');
-    }
-
-
-    /**
-     * Gets all the model objects of type of other model related to $model_object,
-     * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
-     * For both of those child classes, $model_object must be saved so that it has an ID before querying,
-     * otherwise an error will be thrown. Note: by default we disable default_where_conditions
-     * EE_Belongs_To_Relation doesn't need to be saved before querying.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id                      or the primary key of this model
-     * @param array|null               $query_params
-     * @param boolean                  $values_already_prepared_by_model_object @deprecated 4.8.1
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        ?array $query_params = [],
-        bool $values_already_prepared_by_model_object = false
-    ): array {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                esc_html__(
-                    'The argument $values_already_prepared_by_model_object is no longer used.',
-                    'event_espresso'
-                ),
-                '4.8.1'
-            );
-        }
-        $query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
-
-        $query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name()
-                                           . "." . $this->get_this_model()->get_primary_key_field()->get_name();
-
-        $model_object_id = $this->_get_model_object_id($model_object_or_id);
-
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
-        return $this->get_other_model()->get_all($query_params);
-    }
-
-
-    /**
-     * Alters the $query_params to disable default where conditions, unless otherwise specified
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _disable_default_where_conditions_on_query_param(array $query_params): array
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function delete_all_related($model_object_or_id, array $query_params = []): int
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $related_model_object->delete();
-                $deleted_count++;
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function delete_related_permanently($model_object_or_id, array $query_params = []): int
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $deleted_count++;
-                if (! $delete_is_blocked) {
-                    $related_model_object->delete_permanently();
-                } else {
-                    // delete is blocked
-                    // brent and darren, in this case, wanted to just soft delete it then
-                    $related_model_object->delete();
-                }
-            } else {
-                // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
-                    $this->remove_relation_to($model_object_or_id, $related_model_object);
-                    $related_model_object->delete();
-                    $deleted_count++;
-                }
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * this just returns a model_object_id for incoming item that could be an object or id.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id model object or the primary key of this model
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function _get_model_object_id($model_object_or_id)
-    {
-        $model_object_id = $model_object_or_id;
-        if ($model_object_or_id instanceof EE_Base_Class) {
-            $model_object_id = $model_object_or_id->ID();
-        }
-        if (! $model_object_id) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
-                        "event_espresso"
-                    ),
-                    $this->get_other_model()->get_this_model_name(),
-                    $this->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $model_object_id;
-    }
-
-
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                                     other_model_primary_table.fk" etc
-     */
-    abstract public function get_join_statement(string $model_relation_chain): string;
-
-
-    /**
-     * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
-     * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
-     * relationship only allows this model to be related to a single other model of this type)
-     *
-     * @param EE_Base_Class|int|string $this_obj_or_id
-     * @param EE_Base_Class|int|string $other_obj_or_id
-     * @param array                    $extra_join_model_fields_n_values
-     * @return EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
-     *                        $other_obj_or_id)
-     */
-    abstract public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $extra_join_model_fields_n_values = []
-    ): EE_Base_Class;
-
-
-    /**
-     * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
-     * model objects
-     *
-     * @param EE_Base_Class|int|string $this_obj_or_id
-     * @param EE_Base_Class|int|string $other_obj_or_id
-     * @param array                    $where_query
-     * @return EE_Base_Class
-     */
-    abstract public function remove_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $where_query = []
-    ): EE_Base_Class;
-
-
-    /**
-     * Removes ALL relation instances for this relation obj
-     *
-     * @param EE_Base_Class|int|string $this_obj_or_id
-     * @param array                    $where_query_param @see
-     *                                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_relations($this_obj_or_id, array $where_query_param = []): array
-    {
-        $related_things = $this->get_all_related($this_obj_or_id, [$where_query_param]);
-        $objs_removed   = [];
-        foreach ($related_things as $related_thing) {
-            $objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
-        }
-        return $objs_removed;
-    }
-
-
-    /**
-     * If you aren't allowed to delete this model when there are related models across this
-     * relation object, return true. Otherwise, if you can delete this model even though
-     * related objects exist, returns false.
-     *
-     * @return boolean
-     */
-    public function block_delete_if_related_models_exist(): bool
-    {
-        return $this->_blocking_delete;
-    }
-
-
-    /**
-     * Gets the error message to show
-     *
-     * @return string
-     * @throws Exception
-     */
-    public function get_deletion_error_message(): string
-    {
-        if ($this->_blocking_delete_error_message) {
-            return $this->_blocking_delete_error_message;
-        } else {
+			   . "=" . $this_table_alias . "." . $this_table_join_column
+			   . ($extra_join_sql ? " AND $extra_join_sql" : '');
+	}
+
+
+	/**
+	 * Gets all the model objects of type of other model related to $model_object,
+	 * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
+	 * For both of those child classes, $model_object must be saved so that it has an ID before querying,
+	 * otherwise an error will be thrown. Note: by default we disable default_where_conditions
+	 * EE_Belongs_To_Relation doesn't need to be saved before querying.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id                      or the primary key of this model
+	 * @param array|null               $query_params
+	 * @param boolean                  $values_already_prepared_by_model_object @deprecated 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		?array $query_params = [],
+		bool $values_already_prepared_by_model_object = false
+	): array {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				esc_html__(
+					'The argument $values_already_prepared_by_model_object is no longer used.',
+					'event_espresso'
+				),
+				'4.8.1'
+			);
+		}
+		$query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
+
+		$query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name()
+										   . "." . $this->get_this_model()->get_primary_key_field()->get_name();
+
+		$model_object_id = $this->_get_model_object_id($model_object_or_id);
+
+		$query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+		return $this->get_other_model()->get_all($query_params);
+	}
+
+
+	/**
+	 * Alters the $query_params to disable default where conditions, unless otherwise specified
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _disable_default_where_conditions_on_query_param(array $query_params): array
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function delete_all_related($model_object_or_id, array $query_params = []): int
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if (! $delete_is_blocked) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$related_model_object->delete();
+				$deleted_count++;
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function delete_related_permanently($model_object_or_id, array $query_params = []): int
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$deleted_count++;
+				if (! $delete_is_blocked) {
+					$related_model_object->delete_permanently();
+				} else {
+					// delete is blocked
+					// brent and darren, in this case, wanted to just soft delete it then
+					$related_model_object->delete();
+				}
+			} else {
+				// its not a soft-deletable thing anyways. do the normal logic.
+				if (! $delete_is_blocked) {
+					$this->remove_relation_to($model_object_or_id, $related_model_object);
+					$related_model_object->delete();
+					$deleted_count++;
+				}
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * this just returns a model_object_id for incoming item that could be an object or id.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id model object or the primary key of this model
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function _get_model_object_id($model_object_or_id)
+	{
+		$model_object_id = $model_object_or_id;
+		if ($model_object_or_id instanceof EE_Base_Class) {
+			$model_object_id = $model_object_or_id->ID();
+		}
+		if (! $model_object_id) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
+						"event_espresso"
+					),
+					$this->get_other_model()->get_this_model_name(),
+					$this->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $model_object_id;
+	}
+
+
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                                     other_model_primary_table.fk" etc
+	 */
+	abstract public function get_join_statement(string $model_relation_chain): string;
+
+
+	/**
+	 * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
+	 * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
+	 * relationship only allows this model to be related to a single other model of this type)
+	 *
+	 * @param EE_Base_Class|int|string $this_obj_or_id
+	 * @param EE_Base_Class|int|string $other_obj_or_id
+	 * @param array                    $extra_join_model_fields_n_values
+	 * @return EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
+	 *                        $other_obj_or_id)
+	 */
+	abstract public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $extra_join_model_fields_n_values = []
+	): EE_Base_Class;
+
+
+	/**
+	 * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
+	 * model objects
+	 *
+	 * @param EE_Base_Class|int|string $this_obj_or_id
+	 * @param EE_Base_Class|int|string $other_obj_or_id
+	 * @param array                    $where_query
+	 * @return EE_Base_Class
+	 */
+	abstract public function remove_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $where_query = []
+	): EE_Base_Class;
+
+
+	/**
+	 * Removes ALL relation instances for this relation obj
+	 *
+	 * @param EE_Base_Class|int|string $this_obj_or_id
+	 * @param array                    $where_query_param @see
+	 *                                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_relations($this_obj_or_id, array $where_query_param = []): array
+	{
+		$related_things = $this->get_all_related($this_obj_or_id, [$where_query_param]);
+		$objs_removed   = [];
+		foreach ($related_things as $related_thing) {
+			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
+		}
+		return $objs_removed;
+	}
+
+
+	/**
+	 * If you aren't allowed to delete this model when there are related models across this
+	 * relation object, return true. Otherwise, if you can delete this model even though
+	 * related objects exist, returns false.
+	 *
+	 * @return boolean
+	 */
+	public function block_delete_if_related_models_exist(): bool
+	{
+		return $this->_blocking_delete;
+	}
+
+
+	/**
+	 * Gets the error message to show
+	 *
+	 * @return string
+	 * @throws Exception
+	 */
+	public function get_deletion_error_message(): string
+	{
+		if ($this->_blocking_delete_error_message) {
+			return $this->_blocking_delete_error_message;
+		} else {
 //          return sprintf(esc_html__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
-            return sprintf(
-                esc_html__(
-                    'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
-                    "event_espresso"
-                ),
-                $this->get_this_model()->item_name(),
-                $this->get_other_model()->item_name(),
-                $this->get_other_model()->item_name(2)
-            );
-        }
-    }
-
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     * @throws Exception
-     */
-    public function getSchemaDescription(): string
-    {
-        $description = $this instanceof EE_Belongs_To_Relation
-            ? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
-            : esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
-        return sprintf(
-            $description,
-            $this->get_other_model()->get_this_model_name(),
-            $this->get_this_model()->get_this_model_name()
-        );
-    }
-
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string
-     */
-    public function getSchemaType(): string
-    {
-        return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
-    }
-
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return array
-     */
-    public function getSchemaFormat(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     * @throws Exception
-     */
-    public function getSchema(): array
-    {
-        $schema = [
-            'description'   => $this->getSchemaDescription(),
-            'type'          => $this->getSchemaType(),
-            'relation'      => true,
-            'relation_type' => get_class($this),
-            'readonly'      => $this->getSchemaReadonly(),
-        ];
-
-        if ($this instanceof EE_HABTM_Relation) {
-            $schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
-        }
-
-        if ($this->getSchemaType() === 'array') {
-            $schema['items'] = [
-                'type' => 'object',
-            ];
-        }
-
-        return $schema;
-    }
+			return sprintf(
+				esc_html__(
+					'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
+					"event_espresso"
+				),
+				$this->get_this_model()->item_name(),
+				$this->get_other_model()->item_name(),
+				$this->get_other_model()->item_name(2)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 * @throws Exception
+	 */
+	public function getSchemaDescription(): string
+	{
+		$description = $this instanceof EE_Belongs_To_Relation
+			? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
+			: esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
+		return sprintf(
+			$description,
+			$this->get_other_model()->get_this_model_name(),
+			$this->get_this_model()->get_this_model_name()
+		);
+	}
+
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string
+	 */
+	public function getSchemaType(): string
+	{
+		return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
+	}
+
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return array
+	 */
+	public function getSchemaFormat(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 * @throws Exception
+	 */
+	public function getSchema(): array
+	{
+		$schema = [
+			'description'   => $this->getSchemaDescription(),
+			'type'          => $this->getSchemaType(),
+			'relation'      => true,
+			'relation_type' => get_class($this),
+			'readonly'      => $this->getSchemaReadonly(),
+		];
+
+		if ($this instanceof EE_HABTM_Relation) {
+			$schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
+		}
+
+		if ($this->getSchemaType() === 'array') {
+			$schema['items'] = [
+				'type' => 'object',
+			];
+		}
+
+		return $schema;
+	}
 }

core/db_models/fields/EE_Model_Field_Base.php

Indentation +668 added lines, -668 removed lines

@@ -20,672 +20,672 @@
  */
 abstract class EE_Model_Field_Base implements HasSchemaInterface
 {
-    /**
-     * The alias for the table the column belongs to.
-     */
-    protected ?string $_table_alias = '';
-
-    /**
-     * The actual db column name for the table
-     */
-    protected ?string $_table_column;
-
-
-    /**
-     * The authoritative name for the table column (used by client code to reference the field).
-     */
-    protected ?string $_name = '';
-
-
-    /**
-     * A description for the field.
-     */
-    protected ?string $_nicename;
-
-
-    /**
-     * Whether the field is nullable or not
-     */
-    protected ?bool $_nullable;
-
-
-    /**
-     * What the default value for the field should be.
-     *
-     * @var mixed
-     */
-    protected $_default_value;
-
-
-    /**
-     * Other configuration for the field
-     *
-     * @var mixed
-     */
-    protected $_other_config;
-
-
-    /**
-     * The name of the model this field is instantiated for.
-     */
-    protected ?string $_model_name = '';
-
-
-    /**
-     * This should be a json-schema valid data type for the field.
-     *
-     * @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
-     * @var string|string[]
-     */
-    private $_schema_type = 'string';
-
-
-    /**
-     * If the schema has a defined format then it should be defined via this property.
-     *
-     * @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
-     */
-    private ?string $_schema_format = '';
-
-
-    /**
-     * Indicates that the value of the field is managed exclusively by the server/model and not something
-     * settable by client code.
-     *
-     * @link http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.4.4
-     */
-    private bool $_schema_readonly = false;
-
-
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        $this->_table_column  = $table_column;
-        $this->_nicename      = $nicename;
-        $this->_nullable      = $nullable;
-        $this->_default_value = $default_value;
-    }
-
-
-    /**
-     * @param string $table_alias
-     * @param string $name
-     * @param string $model_name
-     */
-    public function _construct_finalize(string $table_alias, string $name, string $model_name)
-    {
-        $this->_table_alias = $table_alias;
-        $this->_name        = $name;
-        $this->_model_name  = $model_name;
-        /**
-         * allow for changing the defaults
-         */
-        $this->_nicename      = apply_filters(
-            'FHEE__EE_Model_Field_Base___construct_finalize___nicename',
-            $this->_nicename,
-            $this
-        );
-        $this->_default_value = apply_filters(
-            'FHEE__EE_Model_Field_Base___construct_finalize___default_value',
-            $this->_default_value,
-            $this
-        );
-    }
-
-
-    public function get_table_alias()
-    {
-        return $this->_table_alias;
-    }
-
-
-    public function get_table_column()
-    {
-        return $this->_table_column;
-    }
-
-
-    /**
-     * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
-     *
-     * @return string
-     */
-    public function get_model_name()
-    {
-        return $this->_model_name;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_name()
-    {
-        if ($this->_name) {
-            return $this->_name;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
-                    "event_espresso"
-                ),
-                get_class($this)
-            )
-        );
-    }
-
-
-    public function get_nicename()
-    {
-        return $this->_nicename;
-    }
-
-
-    public function is_nullable()
-    {
-        return $this->_nullable;
-    }
-
-
-    /**
-     * returns whether this field is an auto-increment field or not. If it is, then
-     * on insertion it can be null. However, on updates it must be present.
-     *
-     * @return boolean
-     */
-    public function is_auto_increment()
-    {
-        return false;
-    }
-
-
-    /**
-     * The default value in the model object's value domain. See lengthy comment about
-     * value domains at the top of EEM_Base
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        return $this->_default_value;
-    }
-
-
-    /**
-     * Returns the table alias joined to the table column, however this isn't the right
-     * table alias if the aliased table is being joined to. In that case, you can use
-     * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
-     * in the current query
-     *
-     * @return string
-     */
-    public function get_qualified_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_table_column();
-    }
-
-
-    /**
-     * When get() is called on a model object (eg EE_Event), before returning its value,
-     * call this function on it, allowing us to customize the returned value based on
-     * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
-     * we simply return it.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. Generally this converts
-     * the validated input on the model object into the format used in the DB.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     * If the model field is going to perform any validation on the input, this is where it should be done
-     * (once the value is on the model object, it may be used in other ways besides putting it into the DB
-     * so it's best to validate it right away).
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $value_inputted_for_field_on_model_object;
-    }
-
-
-    /**
-     * When instantiating a model object from DB results, this function is called before setting each field.
-     * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
-     * is the one child classes will most often define.
-     *
-     * @param mixed $value_found_in_db_for_model_object
-     * @return mixed
-     */
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return $this->prepare_for_set($value_found_in_db_for_model_object);
-    }
-
-
-    /**
-     * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
-     * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
-     * 2013, at 3:23pm" instead of
-     * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
-     *
-     * @param mixed $value_on_field_to_be_outputted
-     * @return mixed
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return $value_on_field_to_be_outputted;
-    }
-
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     */
-    public function getSchemaDescription(): string
-    {
-        return $this->get_nicename();
-    }
-
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        if ($this->is_nullable()) {
-            $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
-                $this->_schema_type[] = 'null';
-            };
-        }
-        return $this->_schema_type;
-    }
-
-
-    /**
-     * Sets the _schema_type property.  Child classes should call this in their constructors to override the default
-     * state for this property.
-     *
-     * @param string|array $type
-     * @throws InvalidArgumentException
-     */
-    protected function setSchemaType($type)
-    {
-        $this->validateSchemaType($type);
-        $this->_schema_type = $type;
-    }
-
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * By default this returns the scalar default value that was sent in on the class prepped according to the class
-     * type as the default.  However, when there are schema properties, then the default property is setup to mirror
-     * the property keys and correctly prepare the default according to that expected property value. The getSchema
-     * method validates whether the schema for default is setup correctly or not according to the schema type
-     *
-     * @return mixed
-     */
-    public function getSchemaDefault()
-    {
-        $default_value     = $this->prepare_for_use_in_db($this->prepare_for_set($this->get_default_value()));
-        $schema_properties = $this->getSchemaProperties();
-
-        // if this schema has properties than shape the default value to match the properties shape.
-        if ($schema_properties) {
-            $value_to_return = [];
-            foreach ($schema_properties as $property_key => $property_schema) {
-                switch ($property_key) {
-                    case 'pretty':
-                    case 'rendered':
-                        $value_to_return[ $property_key ] =
-                            $this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
-                        break;
-                    default:
-                        $value_to_return[ $property_key ] = $default_value;
-                        break;
-                }
-            }
-            $default_value = $value_to_return;
-        }
-        return $default_value;
-    }
-
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return string
-     */
-    public function getSchemaFormat()
-    {
-        return $this->_schema_format;
-    }
-
-
-    /**
-     * Sets the schema format property.
-     *
-     * @param string $format
-     * @throws InvalidArgumentException
-     */
-    protected function setSchemaFormat($format)
-    {
-        $this->validateSchemaFormat($format);
-        $this->_schema_format = $format;
-    }
-
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly(): bool
-    {
-        return $this->_schema_readonly;
-    }
-
-
-    /**
-     * This sets the value for the $_schema_readonly property.
-     *
-     * @param bool $readonly (only explicit boolean values are accepted)
-     */
-    protected function setSchemaReadOnly($readonly)
-    {
-        if (! is_bool($readonly)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
-                    print_r($readonly, true)
-                )
-            );
-        }
-
-        $this->_schema_readonly = $readonly;
-    }
-
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field.
-     *
-     * @return string
-     * @uses _get_wpdb_data_type()
-     */
-    public function get_wpdb_data_type()
-    {
-        return $this->_get_wpdb_data_type();
-    }
-
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
-     *
-     * @param string $type Included if a specific type is requested.
-     * @return string
-     * @uses get_schema_type()
-     */
-    protected function _get_wpdb_data_type($type = '')
-    {
-        $type = empty($type) ? $this->getSchemaType() : $type;
-
-        // if type is an array, then different parsing is required.
-        if (is_array($type)) {
-            return $this->_get_wpdb_data_type_for_type_array($type);
-        }
-
-        $wpdb_type = '%s';
-        switch ($type) {
-            case 'number':
-                $wpdb_type = '%f';
-                break;
-            case 'integer':
-            case 'boolean':
-                $wpdb_type = '%d';
-                break;
-            case 'object':
-                $properties = $this->getSchemaProperties();
-                if (isset($properties['raw'], $properties['raw']['type'])) {
-                    $wpdb_type = $this->_get_wpdb_data_type($properties['raw']['type']);
-                }
-                break; // leave at default
-        }
-        return $wpdb_type;
-    }
-
-
-    protected function _get_wpdb_data_type_for_type_array($type)
-    {
-        $type = (array) $type;
-        // first let's flip because then we can do a faster key check
-        $type = array_flip($type);
-
-        // check for things that mean '%s'
-        if (isset($type['string'], $type['object'], $type['array'])) {
-            return '%s';
-        }
-
-        // if makes it past the above condition and there's float in the array
-        // then the type is %f
-        if (isset($type['number'])) {
-            return '%f';
-        }
-
-        // if it makes it above the above conditions and there is an integer in the array
-        // then the type is %d
-        if (isset($type['integer'])) {
-            return '%d';
-        }
-
-        // anything else is a string
-        return '%s';
-    }
-
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema(): array
-    {
-        $schema = [
-            'description' => $this->getSchemaDescription(),
-            'type'        => $this->getSchemaType(),
-            'readonly'    => $this->getSchemaReadonly(),
-            'default'     => $this->getSchemaDefault(),
-        ];
-
-        // optional properties of the schema
-        $enum       = $this->getSchemaEnum();
-        $properties = $this->getSchemaProperties();
-        $format     = $this->getSchemaFormat();
-        if ($enum) {
-            $schema['enum'] = $enum;
-        }
-
-        if ($properties) {
-            $schema['properties'] = $properties;
-        }
-
-        if ($format) {
-            $schema['format'] = $format;
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
-     * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
-     * want to see their value, then they shouldn't be db-only fields!)
-     * Eg, when doing events as custom post types, querying the post_type is essential, but
-     * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
-     * By default, all fields aren't db-only.
-     *
-     * @return boolean
-     */
-    public function is_db_only_field()
-    {
-        return false;
-    }
-
-
-    /**
-     * Validates the incoming string|array to ensure its an allowable type.
-     *
-     * @param string|array $type
-     * @throws InvalidArgumentException
-     */
-    private function validateSchemaType($type)
-    {
-        if (! (is_string($type) || is_array($type))) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
-                    print_r($type, true)
-                )
-            );
-        }
-
-        if (is_array($type)) {
-            foreach ($type as $item_in_type) {
-                $this->validateSchemaType($item_in_type);
-            }
-            return;
-        }
-
-        // validate allowable types.
-        // @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
-        $allowable_types = [
-            'string',
-            'number',
-            'null',
-            'object',
-            'array',
-            'boolean',
-            'integer',
-        ];
-
-        if (! in_array($type, $allowable_types, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The incoming argument (%1$s) must be one of the allowable types: %2$s',
-                        'event_espresso'
-                    ),
-                    $type,
-                    implode(',', array_flip($allowable_types))
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Validates that the incoming format is an allowable string to use for the _schema_format property
-     *
-     * @param $format
-     * @throws InvalidArgumentException
-     */
-    private function validateSchemaFormat($format)
-    {
-        if (! is_string($format)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
-                    print_r($format, true)
-                )
-            );
-        }
-
-        // validate allowable format values
-        // @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
-        $allowable_formats = array_flip(
-            [
-                'date-time',
-                'email',
-                'hostname',
-                'ipv4',
-                'ipv6',
-                'uri',
-                'uriref',
-            ]
-        );
-
-        if (! isset($allowable_formats[ $format ])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The incoming argument (%1$s) must be one of the allowable formats: %2$s',
-                        'event_espresso'
-                    ),
-                    $format,
-                    implode(',', array_flip($allowable_formats))
-                )
-            );
-        }
-    }
+	/**
+	 * The alias for the table the column belongs to.
+	 */
+	protected ?string $_table_alias = '';
+
+	/**
+	 * The actual db column name for the table
+	 */
+	protected ?string $_table_column;
+
+
+	/**
+	 * The authoritative name for the table column (used by client code to reference the field).
+	 */
+	protected ?string $_name = '';
+
+
+	/**
+	 * A description for the field.
+	 */
+	protected ?string $_nicename;
+
+
+	/**
+	 * Whether the field is nullable or not
+	 */
+	protected ?bool $_nullable;
+
+
+	/**
+	 * What the default value for the field should be.
+	 *
+	 * @var mixed
+	 */
+	protected $_default_value;
+
+
+	/**
+	 * Other configuration for the field
+	 *
+	 * @var mixed
+	 */
+	protected $_other_config;
+
+
+	/**
+	 * The name of the model this field is instantiated for.
+	 */
+	protected ?string $_model_name = '';
+
+
+	/**
+	 * This should be a json-schema valid data type for the field.
+	 *
+	 * @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
+	 * @var string|string[]
+	 */
+	private $_schema_type = 'string';
+
+
+	/**
+	 * If the schema has a defined format then it should be defined via this property.
+	 *
+	 * @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
+	 */
+	private ?string $_schema_format = '';
+
+
+	/**
+	 * Indicates that the value of the field is managed exclusively by the server/model and not something
+	 * settable by client code.
+	 *
+	 * @link http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.4.4
+	 */
+	private bool $_schema_readonly = false;
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		$this->_table_column  = $table_column;
+		$this->_nicename      = $nicename;
+		$this->_nullable      = $nullable;
+		$this->_default_value = $default_value;
+	}
+
+
+	/**
+	 * @param string $table_alias
+	 * @param string $name
+	 * @param string $model_name
+	 */
+	public function _construct_finalize(string $table_alias, string $name, string $model_name)
+	{
+		$this->_table_alias = $table_alias;
+		$this->_name        = $name;
+		$this->_model_name  = $model_name;
+		/**
+		 * allow for changing the defaults
+		 */
+		$this->_nicename      = apply_filters(
+			'FHEE__EE_Model_Field_Base___construct_finalize___nicename',
+			$this->_nicename,
+			$this
+		);
+		$this->_default_value = apply_filters(
+			'FHEE__EE_Model_Field_Base___construct_finalize___default_value',
+			$this->_default_value,
+			$this
+		);
+	}
+
+
+	public function get_table_alias()
+	{
+		return $this->_table_alias;
+	}
+
+
+	public function get_table_column()
+	{
+		return $this->_table_column;
+	}
+
+
+	/**
+	 * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
+	 *
+	 * @return string
+	 */
+	public function get_model_name()
+	{
+		return $this->_model_name;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_name()
+	{
+		if ($this->_name) {
+			return $this->_name;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
+					"event_espresso"
+				),
+				get_class($this)
+			)
+		);
+	}
+
+
+	public function get_nicename()
+	{
+		return $this->_nicename;
+	}
+
+
+	public function is_nullable()
+	{
+		return $this->_nullable;
+	}
+
+
+	/**
+	 * returns whether this field is an auto-increment field or not. If it is, then
+	 * on insertion it can be null. However, on updates it must be present.
+	 *
+	 * @return boolean
+	 */
+	public function is_auto_increment()
+	{
+		return false;
+	}
+
+
+	/**
+	 * The default value in the model object's value domain. See lengthy comment about
+	 * value domains at the top of EEM_Base
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		return $this->_default_value;
+	}
+
+
+	/**
+	 * Returns the table alias joined to the table column, however this isn't the right
+	 * table alias if the aliased table is being joined to. In that case, you can use
+	 * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
+	 * in the current query
+	 *
+	 * @return string
+	 */
+	public function get_qualified_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_table_column();
+	}
+
+
+	/**
+	 * When get() is called on a model object (eg EE_Event), before returning its value,
+	 * call this function on it, allowing us to customize the returned value based on
+	 * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
+	 * we simply return it.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. Generally this converts
+	 * the validated input on the model object into the format used in the DB.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 * If the model field is going to perform any validation on the input, this is where it should be done
+	 * (once the value is on the model object, it may be used in other ways besides putting it into the DB
+	 * so it's best to validate it right away).
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $value_inputted_for_field_on_model_object;
+	}
+
+
+	/**
+	 * When instantiating a model object from DB results, this function is called before setting each field.
+	 * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
+	 * is the one child classes will most often define.
+	 *
+	 * @param mixed $value_found_in_db_for_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return $this->prepare_for_set($value_found_in_db_for_model_object);
+	}
+
+
+	/**
+	 * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
+	 * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
+	 * 2013, at 3:23pm" instead of
+	 * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
+	 *
+	 * @param mixed $value_on_field_to_be_outputted
+	 * @return mixed
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return $value_on_field_to_be_outputted;
+	}
+
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaDescription(): string
+	{
+		return $this->get_nicename();
+	}
+
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		if ($this->is_nullable()) {
+			$this->_schema_type = (array) $this->_schema_type;
+			if (! in_array('null', $this->_schema_type)) {
+				$this->_schema_type[] = 'null';
+			};
+		}
+		return $this->_schema_type;
+	}
+
+
+	/**
+	 * Sets the _schema_type property.  Child classes should call this in their constructors to override the default
+	 * state for this property.
+	 *
+	 * @param string|array $type
+	 * @throws InvalidArgumentException
+	 */
+	protected function setSchemaType($type)
+	{
+		$this->validateSchemaType($type);
+		$this->_schema_type = $type;
+	}
+
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * By default this returns the scalar default value that was sent in on the class prepped according to the class
+	 * type as the default.  However, when there are schema properties, then the default property is setup to mirror
+	 * the property keys and correctly prepare the default according to that expected property value. The getSchema
+	 * method validates whether the schema for default is setup correctly or not according to the schema type
+	 *
+	 * @return mixed
+	 */
+	public function getSchemaDefault()
+	{
+		$default_value     = $this->prepare_for_use_in_db($this->prepare_for_set($this->get_default_value()));
+		$schema_properties = $this->getSchemaProperties();
+
+		// if this schema has properties than shape the default value to match the properties shape.
+		if ($schema_properties) {
+			$value_to_return = [];
+			foreach ($schema_properties as $property_key => $property_schema) {
+				switch ($property_key) {
+					case 'pretty':
+					case 'rendered':
+						$value_to_return[ $property_key ] =
+							$this->prepare_for_pretty_echoing($this->prepare_for_set($default_value));
+						break;
+					default:
+						$value_to_return[ $property_key ] = $default_value;
+						break;
+				}
+			}
+			$default_value = $value_to_return;
+		}
+		return $default_value;
+	}
+
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaFormat()
+	{
+		return $this->_schema_format;
+	}
+
+
+	/**
+	 * Sets the schema format property.
+	 *
+	 * @param string $format
+	 * @throws InvalidArgumentException
+	 */
+	protected function setSchemaFormat($format)
+	{
+		$this->validateSchemaFormat($format);
+		$this->_schema_format = $format;
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly(): bool
+	{
+		return $this->_schema_readonly;
+	}
+
+
+	/**
+	 * This sets the value for the $_schema_readonly property.
+	 *
+	 * @param bool $readonly (only explicit boolean values are accepted)
+	 */
+	protected function setSchemaReadOnly($readonly)
+	{
+		if (! is_bool($readonly)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
+					print_r($readonly, true)
+				)
+			);
+		}
+
+		$this->_schema_readonly = $readonly;
+	}
+
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field.
+	 *
+	 * @return string
+	 * @uses _get_wpdb_data_type()
+	 */
+	public function get_wpdb_data_type()
+	{
+		return $this->_get_wpdb_data_type();
+	}
+
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
+	 *
+	 * @param string $type Included if a specific type is requested.
+	 * @return string
+	 * @uses get_schema_type()
+	 */
+	protected function _get_wpdb_data_type($type = '')
+	{
+		$type = empty($type) ? $this->getSchemaType() : $type;
+
+		// if type is an array, then different parsing is required.
+		if (is_array($type)) {
+			return $this->_get_wpdb_data_type_for_type_array($type);
+		}
+
+		$wpdb_type = '%s';
+		switch ($type) {
+			case 'number':
+				$wpdb_type = '%f';
+				break;
+			case 'integer':
+			case 'boolean':
+				$wpdb_type = '%d';
+				break;
+			case 'object':
+				$properties = $this->getSchemaProperties();
+				if (isset($properties['raw'], $properties['raw']['type'])) {
+					$wpdb_type = $this->_get_wpdb_data_type($properties['raw']['type']);
+				}
+				break; // leave at default
+		}
+		return $wpdb_type;
+	}
+
+
+	protected function _get_wpdb_data_type_for_type_array($type)
+	{
+		$type = (array) $type;
+		// first let's flip because then we can do a faster key check
+		$type = array_flip($type);
+
+		// check for things that mean '%s'
+		if (isset($type['string'], $type['object'], $type['array'])) {
+			return '%s';
+		}
+
+		// if makes it past the above condition and there's float in the array
+		// then the type is %f
+		if (isset($type['number'])) {
+			return '%f';
+		}
+
+		// if it makes it above the above conditions and there is an integer in the array
+		// then the type is %d
+		if (isset($type['integer'])) {
+			return '%d';
+		}
+
+		// anything else is a string
+		return '%s';
+	}
+
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema(): array
+	{
+		$schema = [
+			'description' => $this->getSchemaDescription(),
+			'type'        => $this->getSchemaType(),
+			'readonly'    => $this->getSchemaReadonly(),
+			'default'     => $this->getSchemaDefault(),
+		];
+
+		// optional properties of the schema
+		$enum       = $this->getSchemaEnum();
+		$properties = $this->getSchemaProperties();
+		$format     = $this->getSchemaFormat();
+		if ($enum) {
+			$schema['enum'] = $enum;
+		}
+
+		if ($properties) {
+			$schema['properties'] = $properties;
+		}
+
+		if ($format) {
+			$schema['format'] = $format;
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
+	 * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
+	 * want to see their value, then they shouldn't be db-only fields!)
+	 * Eg, when doing events as custom post types, querying the post_type is essential, but
+	 * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
+	 * By default, all fields aren't db-only.
+	 *
+	 * @return boolean
+	 */
+	public function is_db_only_field()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Validates the incoming string|array to ensure its an allowable type.
+	 *
+	 * @param string|array $type
+	 * @throws InvalidArgumentException
+	 */
+	private function validateSchemaType($type)
+	{
+		if (! (is_string($type) || is_array($type))) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
+					print_r($type, true)
+				)
+			);
+		}
+
+		if (is_array($type)) {
+			foreach ($type as $item_in_type) {
+				$this->validateSchemaType($item_in_type);
+			}
+			return;
+		}
+
+		// validate allowable types.
+		// @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
+		$allowable_types = [
+			'string',
+			'number',
+			'null',
+			'object',
+			'array',
+			'boolean',
+			'integer',
+		];
+
+		if (! in_array($type, $allowable_types, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The incoming argument (%1$s) must be one of the allowable types: %2$s',
+						'event_espresso'
+					),
+					$type,
+					implode(',', array_flip($allowable_types))
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Validates that the incoming format is an allowable string to use for the _schema_format property
+	 *
+	 * @param $format
+	 * @throws InvalidArgumentException
+	 */
+	private function validateSchemaFormat($format)
+	{
+		if (! is_string($format)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
+					print_r($format, true)
+				)
+			);
+		}
+
+		// validate allowable format values
+		// @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
+		$allowable_formats = array_flip(
+			[
+				'date-time',
+				'email',
+				'hostname',
+				'ipv4',
+				'ipv6',
+				'uri',
+				'uriref',
+			]
+		);
+
+		if (! isset($allowable_formats[ $format ])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The incoming argument (%1$s) must be one of the allowable formats: %2$s',
+						'event_espresso'
+					),
+					$format,
+					implode(',', array_flip($allowable_formats))
+				)
+			);
+		}
+	}
 }

core/EE_Session.core.php

Indentation +1308 added lines, -1308 removed lines

@@ -23,1306 +23,1306 @@ 
  */
 class EE_Session implements SessionIdentifierInterface
 {
-    const session_id_prefix    = 'ee_ssn_';
-
-    const hash_check_prefix    = 'ee_shc_';
-
-    const OPTION_NAME_SETTINGS = 'ee_session_settings';
-
-    const STATUS_CLOSED        = 0;
-
-    const STATUS_OPEN          = 1;
-
-    const SAVE_STATE_CLEAN     = 'clean';
-
-    const SAVE_STATE_DIRTY     = 'dirty';
-
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @var EE_Session
-     */
-    private static $_instance;
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    protected $cache_storage;
-
-    /**
-     * @var Base64Encoder
-     */
-    protected $encryption;
-
-    /**
-     * @var SessionStartHandler $session_start_handler
-     */
-    protected $session_start_handler;
-
-    /**
-     * the session id
-     *
-     * @var string
-     */
-    private $_sid;
-
-    /**
-     * session id salt
-     *
-     * @var string
-     */
-    private $_sid_salt;
-
-    /**
-     * session data
-     *
-     * @var array
-     */
-    private $_session_data = [];
-
-    /**
-     * how long an EE session lasts
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    /**
-     * session expiration time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_expiration;
-
-    /**
-     * whether session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
-
-    /**
-     * current time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_time;
-
-    /**
-     * whether to encrypt session data
-     *
-     * @var bool
-     */
-    private $_use_encryption;
-
-    /**
-     * well... according to the server...
-     *
-     * @var null
-     */
-    private $_user_agent;
-
-
-    /**
-     * array for defining default session vars
-     *
-     * @var array
-     */
-    private $_default_session_vars = [
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => [],
-    ];
-
-    /**
-     * timestamp for when last garbage collection cycle was performed
-     *
-     * @var int $_last_gc
-     */
-    private $_last_gc;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * whether session is active or not
-     *
-     * @var int $status
-     */
-    private $status = EE_Session::STATUS_CLOSED;
-
-    /**
-     * whether session data has changed therefore requiring a session save
-     *
-     * @var string $save_state
-     */
-    private $save_state = EE_Session::SAVE_STATE_CLEAN;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CacheStorageInterface|null $cache_storage
-     * @param SessionLifespan|null       $lifespan
-     * @param RequestInterface|null      $request
-     * @param SessionStartHandler|null   $session_start_handler
-     * @param Base64Encoder|null         $encryption
-     * @return EE_Session
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instance(
-        CacheStorageInterface $cache_storage = null,
-        SessionLifespan $lifespan = null,
-        RequestInterface $request = null,
-        SessionStartHandler $session_start_handler = null,
-        Base64Encoder $encryption = null
-    ) {
-        // check if class object is instantiated
-        // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
-        // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (
-            ! self::$_instance instanceof EE_Session
-            && $cache_storage instanceof CacheStorageInterface
-            && $lifespan instanceof SessionLifespan
-            && $request instanceof RequestInterface
-            && $session_start_handler instanceof SessionStartHandler
-            && apply_filters('FHEE_load_EE_Session', true)
-        ) {
-            self::$_instance = new self(
-                $cache_storage,
-                $lifespan,
-                $request,
-                $session_start_handler,
-                $encryption
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan       $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param Base64Encoder|null    $encryption
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function __construct(
-        CacheStorageInterface $cache_storage,
-        SessionLifespan $lifespan,
-        RequestInterface $request,
-        SessionStartHandler $session_start_handler,
-        Base64Encoder $encryption = null
-    ) {
-        // session loading is turned ON by default,
-        // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
-        // (which currently fires on the init hook at priority 9),
-        // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
-            return;
-        }
-        $this->session_start_handler = $session_start_handler;
-        $this->session_lifespan      = $lifespan;
-        $this->request               = $request;
-        if (! defined('ESPRESSO_SESSION')) {
-            define('ESPRESSO_SESSION', true);
-        }
-        // retrieve session options from db
-        $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, []);
-        if (! empty($session_settings)) {
-            // cycle though existing session options
-            foreach ($session_settings as $var_name => $session_setting) {
-                // set values for class properties
-                $var_name          = '_' . $var_name;
-                $this->{$var_name} = $session_setting;
-            }
-        }
-        $this->cache_storage = $cache_storage;
-        // are we using encryption?
-        $this->_use_encryption = $encryption instanceof Base64Encoder
-                                 && EE_Registry::instance()->CFG->admin->encode_session_data();
-        // encrypt data via: $this->encryption->encodeString();
-        $this->encryption = $encryption;
-        // filter hook allows outside functions/classes/plugins to change default empty cart
-        $extra_default_session_vars  = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', []);
-        $this->_default_session_vars = array_merge($this->_default_session_vars, $extra_default_session_vars);
-        // apply default session vars
-        $this->_set_defaults();
-        add_action('AHEE__EE_System__initialize', [$this, 'open_session']);
-        // check request for 'clear_session' param
-        add_action('AHEE__EE_Request_Handler__construct__complete', [$this, 'wp_loaded']);
-        // once everything is all said and done,
-        add_action('shutdown', [$this, 'update'], 100);
-        add_action('shutdown', [$this, 'garbageCollection'], 1000);
-        $this->configure_garbage_collection_filters();
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function isLoadedAndActive(): bool
-    {
-        return did_action('AHEE__EE_System__core_loaded_and_ready')
-               && EE_Session::instance() instanceof EE_Session
-               && EE_Session::instance()->isActive();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActive(): bool
-    {
-        return $this->status === EE_Session::STATUS_OPEN;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function open_session()
-    {
-        // Check for an existing session and retrieve it from the database, unless the system is in maintenance level 2.
-        if (EE_Maintenance_Mode::instance()->models_can_query() && ! $this->_espresso_session()) {
-            // or just start a new one
-            $this->_create_espresso_session();
-        }
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function expired(): bool
-    {
-        return $this->_expired;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function expiration(): int
-    {
-        return $this->_expiration;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function extension(): int
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
-    }
-
-
-    /**
-     * @param int $time number of seconds to add to session expiration
-     */
-    public function extend_expiration(int $time = 0)
-    {
-        $time              = $time
-            ?: $this->extension();
-        $this->_expiration += absint($time);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function lifespan(): int
-    {
-        return $this->session_lifespan->inSeconds();
-    }
-
-
-    /**
-     * Marks whether the session data has been updated or not.
-     * Valid options are:
-     *      EE_Session::SAVE_STATE_CLEAN - session data remains unchanged and updating is not necessary
-     *      EE_Session::SAVE_STATE_DIRTY - session data has changed since last save and needs to be updated
-     * default value is EE_Session::SAVE_STATE_DIRTY
-     *
-     * @param string $save_state
-     */
-    public function setSaveState(string $save_state = EE_Session::SAVE_STATE_DIRTY)
-    {
-        $valid_save_states = [
-            EE_Session::SAVE_STATE_CLEAN,
-            EE_Session::SAVE_STATE_DIRTY,
-        ];
-        if (! in_array($save_state, $valid_save_states, true)) {
-            $save_state = EE_Session::SAVE_STATE_DIRTY;
-        }
-        $this->save_state = $save_state;
-    }
-
-
-    /**
-     * This just sets some defaults for the _session data property
-     *
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        // set some defaults
-        foreach ($this->_default_session_vars as $key => $default_var) {
-            if (is_array($default_var)) {
-                $this->_session_data[ $key ] = [];
-            } else {
-                $this->_session_data[ $key ] = '';
-            }
-        }
-    }
-
-
-    /**
-     * @retrieve  session data
-     * @return    string
-     */
-    public function id(): string
-    {
-        return $this->_sid;
-    }
-
-
-    /**
-     * @param EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart): bool
-    {
-        $this->_session_data['cart'] = $cart;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_cart
-     */
-    public function reset_cart()
-    {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
-        $this->_session_data['cart'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return EE_Cart
-     */
-    public function cart(): ?EE_Cart
-    {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * @param EE_Checkout $checkout
-     * @return bool
-     */
-    public function set_checkout(EE_Checkout $checkout): bool
-    {
-        $this->_session_data['checkout'] = $checkout;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_checkout
-     */
-    public function reset_checkout()
-    {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
-        $this->_session_data['checkout'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return EE_Checkout
-     */
-    public function checkout(): ?EE_Checkout
-    {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_transaction(EE_Transaction $transaction): bool
-    {
-        // first remove the session from the transaction before we save the transaction in the session
-        $transaction->set_txn_session_data(null);
-        $this->_session_data['transaction'] = $transaction;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_transaction
-     */
-    public function reset_transaction()
-    {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
-        $this->_session_data['transaction'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction(): ?EE_Transaction
-    {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-            ? $this->_session_data['transaction']
-            : null;
-    }
-
-
-    /**
-     * retrieve session data
-     *
-     * @param string|null $key
-     * @param bool        $reset_cache
-     * @return array|EE_Cart|EE_Checkout|EE_Transaction
-     */
-    public function get_session_data(?string $key = null, bool $reset_cache = false)
-    {
-        if ($reset_cache) {
-            $this->reset_cart();
-            $this->reset_checkout();
-            $this->reset_transaction();
-        }
-        if (! empty($key)) {
-            return $this->_session_data[ $key ] ?? null;
-        }
-        return $this->_session_data;
-    }
-
-
-    /**
-     * Returns TRUE on success, FALSE on fail
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function set_session_data(array $data): bool
-    {
-        // nothing ??? bad data ??? go home!
-        if (empty($data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data or invalid session data was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'
-                        ),
-                        $key
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $this->_session_data[ $key ] = $value;
-            $this->setSaveState();
-        }
-        return true;
-    }
-
-
-    /**
-     * @initiate session
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    private function _espresso_session(): bool
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->session_start_handler->startSession();
-        $this->status = EE_Session::STATUS_OPEN;
-        // get our modified session ID
-        $this->_sid = $this->_generate_session_id();
-        // set the "user agent"
-        $this->_user_agent = $this->request->userAgent();
-        // now let's retrieve what's in the db
-        $session_data = $this->_retrieve_session_data();
-        if (empty($session_data)) {
-            // set initial site access time and the session expiration
-            $this->_set_init_access_and_expiration();
-            // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
-                $this->request->getServerParam('HTTP_REFERER')
-            );
-            // no previous session = go back and create one (on top of the data above)
-            return false;
-        }
-        // get the current time in UTC
-        $this->_time = $this->_time !== null
-            ? $this->_time
-            : time();
-        // and reset the session expiration
-        $this->_expiration = $session_data['expiration'] ?? $this->_time + $this->session_lifespan->inSeconds();
-        // now the user agent
-        if ($session_data['user_agent'] !== $this->_user_agent) {
-            return false;
-        }
-        // wait a minute... how old are you?
-        if ($this->_time > $this->_expiration) {
-            // yer too old fer me!
-            $this->_expired = true;
-            // wipe out everything that isn't a default session datum
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // make event espresso session data available to plugin
-        $this->_session_data = array_merge($this->_session_data, $session_data);
-        return true;
-    }
-
-
-    /**
-     * _get_session_data
-     * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
-     * databases
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidSessionDataException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _retrieve_session_data(): array
-    {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
-        try {
-            // we're using WP's Transient API to store session data using the PHP session ID as the option name
-            $session_data = $this->cache_storage->get($ssn_key, false);
-            if (empty($session_data)) {
-                return [];
-            }
-            if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
-                    false
-                );
-                if ($hash_check && $hash_check !== md5($session_data)) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
-                                'event_espresso'
-                            ),
-                            EE_Session::session_id_prefix . $this->_sid
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } catch (Exception $e) {
-            // let's just eat that error for now and attempt to correct any corrupted data
-            global $wpdb;
-            $row          = $wpdb->get_row(
-                $wpdb->prepare(
-                    "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
-                )
-            );
-            $session_data = is_object($row)
-                ? $row->option_value
-                : null;
-            if ($session_data) {
-                $session_data = preg_replace_callback(
-                    '!s:(d+):"(.*?)";!',
-                    function ($match) {
-                        return $match[1] === strlen($match[2])
-                            ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
-                    },
-                    $session_data
-                );
-            }
-            $session_data = maybe_unserialize($session_data);
-        }
-        // in case the data is encoded... try to decode it
-        $session_data = $this->_use_encryption
-            ? $this->encryption->decodeString($session_data)
-            : $session_data;
-        if (! is_array($session_data)) {
-            try {
-                $session_data = maybe_unserialize($session_data);
-            } catch (Exception $e) {
-                $msg = esc_html__(
-                    'An error occurred while attempting to unserialize the session data.',
-                    'event_espresso'
-                );
-                $msg .= WP_DEBUG
-                    ? '<br><pre>'
-                      . print_r($session_data, true)
-                      . '</pre><br>'
-                      . $this->find_serialize_error($session_data)
-                    : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-                throw new InvalidSessionDataException($msg, 0, $e);
-            }
-        }
-        // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
-            // no?!?! then something is wrong
-            $msg = esc_html__(
-                'The session data is missing, invalid, or corrupted.',
-                'event_espresso'
-            );
-            $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-            throw new InvalidSessionDataException($msg);
-        }
-        if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
-            $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
-                $session_data['transaction']
-            );
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * _generate_session_id
-     * Retrieves the PHP session id either directly from the PHP session,
-     * or from the request array if it was passed in from an AJAX request.
-     * The session id is then salted and hashed (mmm sounds tasty)
-     * so that it can be safely used as a request param
-     *
-     * @return string
-     */
-    protected function _generate_session_id(): string
-    {
-        // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-        $session_id = $this->request->requestParamIsSet('EESID')
-            ? $this->request->getRequestParam('EESID')
-            : md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
-        return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
-    }
-
-
-    /**
-     * _get_sid_salt
-     *
-     * @return string
-     */
-    protected function _get_sid_salt(): string
-    {
-        // was session id salt already saved to db ?
-        if (empty($this->_sid_salt)) {
-            // no?  then maybe use WP defined constant
-            if (defined('AUTH_SALT')) {
-                $this->_sid_salt = AUTH_SALT;
-            }
-            // if salt doesn't exist or is too short
-            if (strlen($this->_sid_salt) < 32) {
-                // create a new one
-                $this->_sid_salt = wp_generate_password(64);
-            }
-            // and save it as a permanent session setting
-            $this->updateSessionSettings(['sid_salt' => $this->_sid_salt]);
-        }
-        return $this->_sid_salt;
-    }
-
-
-    /**
-     * _set_init_access_and_expiration
-     *
-     * @return void
-     */
-    protected function _set_init_access_and_expiration()
-    {
-        $this->_time       = time();
-        $this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
-        // set initial site access time
-        $this->_session_data['init_access'] = $this->_time;
-        // and the session expiration
-        $this->_session_data['expiration'] = $this->_expiration;
-    }
-
-
-    /**
-     * @update session data  prior to saving to the db
-     * @param bool $new_session
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function update(bool $new_session = false): bool
-    {
-        $this->_session_data = is_array($this->_session_data) && isset($this->_session_data['id'])
-            ? $this->_session_data
-            : [];
-        if (empty($this->_session_data)) {
-            $this->_set_defaults();
-        }
-        $session_data = [];
-        foreach ($this->_session_data as $key => $value) {
-            switch ($key) {
-                case 'id':
-                    // session ID
-                    $session_data['id'] = $this->_sid;
-                    break;
-                case 'ip_address':
-                    // visitor ip address
-                    $session_data['ip_address'] = $this->request->ipAddress();
-                    break;
-                case 'user_agent':
-                    // visitor user_agent
-                    $session_data['user_agent'] = $this->_user_agent;
-                    break;
-                case 'init_access':
-                    $session_data['init_access'] = absint($value);
-                    break;
-                case 'last_access':
-                    // current access time
-                    $session_data['last_access'] = $this->_time;
-                    break;
-                case 'expiration':
-                    // when the session expires
-                    $session_data['expiration'] = ! empty($this->_expiration)
-                        ? $this->_expiration
-                        : $session_data['init_access'] + $this->session_lifespan->inSeconds();
-                    break;
-                case 'user_id':
-                    // current user if logged in
-                    $session_data['user_id'] = $this->_wp_user_id();
-                    break;
-                case 'pages_visited':
-                    $page_visit = $this->_get_page_visit();
-                    if ($page_visit) {
-                        // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
-                        // we'll only save the last 10 page visits.
-                        $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
-                    }
-                    break;
-                default:
-                    // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
-            }
-        }
-        $this->_session_data = $session_data;
-        // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
-            // ready? let's save
-            if ($this->_save_session_to_db()) {
-                return true;
-            }
-            return false;
-        }
-        // meh, why not?
-        return true;
-    }
-
-
-    /**
-     * @create session data array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _create_espresso_session()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
-        // use the update function for now with $new_session arg set to TRUE
-        $this->update(true);
-    }
-
-
-    /**
-     * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
-     * too). This is used when determining if we want to save the session or not.
-     *
-     * @return bool
-     * @since 4.9.67.p
-     */
-    private function sessionHasStuffWorthSaving(): bool
-    {
-        return $this->save_state === EE_Session::SAVE_STATE_DIRTY
-               // we may want to eventually remove the following
-               // on the assumption that the above check is enough
-               || $this->cart() instanceof EE_Cart
-               || (
-                   isset($this->_session_data['ee_notices'])
-                   && (
-                       ! empty($this->_session_data['ee_notices']['attention'])
-                       || ! empty($this->_session_data['ee_notices']['errors'])
-                       || ! empty($this->_session_data['ee_notices']['success'])
-                   )
-               );
-    }
-
-
-    /**
-     * _save_session_to_db
-     *
-     * @param bool $clear_session
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _save_session_to_db(bool $clear_session = false): bool
-    {
-        // don't save sessions for crawlers
-        // and unless we're deleting the session data, don't save anything if there isn't a cart
-        if (
-            $this->request->isBot()
-            || (
-                ! $clear_session
-                && ! $this->sessionHasStuffWorthSaving()
-                && apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
-            )
-        ) {
-            return false;
-        }
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
-                $transaction->save();
-            }
-            $this->_session_data['transaction'] = $transaction->ID();
-        }
-        // then serialize all of our session data
-        $session_data = serialize($this->_session_data);
-        // do we need to also encode it to avoid corrupted data when saved to the db?
-        $session_data = $this->_use_encryption
-            ? $this->encryption->encodeString($session_data)
-            : $session_data;
-        // maybe save hash check
-        if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-            $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
-                md5($session_data),
-                $this->session_lifespan->inSeconds()
-            );
-        }
-        // we're using the Transient API for storing session data,
-        $saved = $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
-            $session_data,
-            $this->session_lifespan->inSeconds()
-        );
-        $this->setSaveState(EE_Session::SAVE_STATE_CLEAN);
-        return $saved;
-    }
-
-
-    /**
-     * @get    the full page request the visitor is accessing
-     * @return string
-     */
-    public function _get_page_visit(): string
-    {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
-        // check for request url
-        if ($this->request->serverParamIsSet('REQUEST_URI')) {
-            $page_id     = '?';
-            $e_reg       = '';
-            $request_uri = $this->request->getServerParam('REQUEST_URI');
-            $ru_bits     = explode('?', $request_uri);
-            $request_uri = $ru_bits[0];
-            $http_host   = $this->request->getServerParam('HTTP_HOST');
-            // check for page_id in SERVER REQUEST
-            if ($this->request->requestParamIsSet('page_id')) {
-                // rebuild $e_reg without any of the extra parameters
-                $page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
-            }
-            // check for $e_reg in SERVER REQUEST
-            if ($this->request->requestParamIsSet('ee')) {
-                // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . $this->request->getRequestParam('ee');
-            }
-            $page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
-        }
-        return $page_visit !== home_url('/wp-admin/admin-ajax.php')
-            ? $page_visit
-            : '';
-    }
-
-
-    /**
-     * @the    current wp user id
-     * @return int
-     */
-    public function _wp_user_id(): int
-    {
-        // if I need to explain the following lines of code, then you shouldn't be looking at this!
-        return get_current_user_id();
-    }
-
-
-    /**
-     * Clear EE_Session data
-     *
-     * @param string $class
-     * @param string $function
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function clear_session(string $class = '', string $function = '')
-    {
+	const session_id_prefix    = 'ee_ssn_';
+
+	const hash_check_prefix    = 'ee_shc_';
+
+	const OPTION_NAME_SETTINGS = 'ee_session_settings';
+
+	const STATUS_CLOSED        = 0;
+
+	const STATUS_OPEN          = 1;
+
+	const SAVE_STATE_CLEAN     = 'clean';
+
+	const SAVE_STATE_DIRTY     = 'dirty';
+
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @var EE_Session
+	 */
+	private static $_instance;
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	protected $cache_storage;
+
+	/**
+	 * @var Base64Encoder
+	 */
+	protected $encryption;
+
+	/**
+	 * @var SessionStartHandler $session_start_handler
+	 */
+	protected $session_start_handler;
+
+	/**
+	 * the session id
+	 *
+	 * @var string
+	 */
+	private $_sid;
+
+	/**
+	 * session id salt
+	 *
+	 * @var string
+	 */
+	private $_sid_salt;
+
+	/**
+	 * session data
+	 *
+	 * @var array
+	 */
+	private $_session_data = [];
+
+	/**
+	 * how long an EE session lasts
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	/**
+	 * session expiration time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_expiration;
+
+	/**
+	 * whether session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
+
+	/**
+	 * current time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_time;
+
+	/**
+	 * whether to encrypt session data
+	 *
+	 * @var bool
+	 */
+	private $_use_encryption;
+
+	/**
+	 * well... according to the server...
+	 *
+	 * @var null
+	 */
+	private $_user_agent;
+
+
+	/**
+	 * array for defining default session vars
+	 *
+	 * @var array
+	 */
+	private $_default_session_vars = [
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => [],
+	];
+
+	/**
+	 * timestamp for when last garbage collection cycle was performed
+	 *
+	 * @var int $_last_gc
+	 */
+	private $_last_gc;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * whether session is active or not
+	 *
+	 * @var int $status
+	 */
+	private $status = EE_Session::STATUS_CLOSED;
+
+	/**
+	 * whether session data has changed therefore requiring a session save
+	 *
+	 * @var string $save_state
+	 */
+	private $save_state = EE_Session::SAVE_STATE_CLEAN;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CacheStorageInterface|null $cache_storage
+	 * @param SessionLifespan|null       $lifespan
+	 * @param RequestInterface|null      $request
+	 * @param SessionStartHandler|null   $session_start_handler
+	 * @param Base64Encoder|null         $encryption
+	 * @return EE_Session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instance(
+		CacheStorageInterface $cache_storage = null,
+		SessionLifespan $lifespan = null,
+		RequestInterface $request = null,
+		SessionStartHandler $session_start_handler = null,
+		Base64Encoder $encryption = null
+	) {
+		// check if class object is instantiated
+		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
+		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (
+			! self::$_instance instanceof EE_Session
+			&& $cache_storage instanceof CacheStorageInterface
+			&& $lifespan instanceof SessionLifespan
+			&& $request instanceof RequestInterface
+			&& $session_start_handler instanceof SessionStartHandler
+			&& apply_filters('FHEE_load_EE_Session', true)
+		) {
+			self::$_instance = new self(
+				$cache_storage,
+				$lifespan,
+				$request,
+				$session_start_handler,
+				$encryption
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan       $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param Base64Encoder|null    $encryption
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function __construct(
+		CacheStorageInterface $cache_storage,
+		SessionLifespan $lifespan,
+		RequestInterface $request,
+		SessionStartHandler $session_start_handler,
+		Base64Encoder $encryption = null
+	) {
+		// session loading is turned ON by default,
+		// but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
+		// (which currently fires on the init hook at priority 9),
+		// can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! apply_filters('FHEE_load_EE_Session', true)) {
+			return;
+		}
+		$this->session_start_handler = $session_start_handler;
+		$this->session_lifespan      = $lifespan;
+		$this->request               = $request;
+		if (! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
+		}
+		// retrieve session options from db
+		$session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, []);
+		if (! empty($session_settings)) {
+			// cycle though existing session options
+			foreach ($session_settings as $var_name => $session_setting) {
+				// set values for class properties
+				$var_name          = '_' . $var_name;
+				$this->{$var_name} = $session_setting;
+			}
+		}
+		$this->cache_storage = $cache_storage;
+		// are we using encryption?
+		$this->_use_encryption = $encryption instanceof Base64Encoder
+								 && EE_Registry::instance()->CFG->admin->encode_session_data();
+		// encrypt data via: $this->encryption->encodeString();
+		$this->encryption = $encryption;
+		// filter hook allows outside functions/classes/plugins to change default empty cart
+		$extra_default_session_vars  = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', []);
+		$this->_default_session_vars = array_merge($this->_default_session_vars, $extra_default_session_vars);
+		// apply default session vars
+		$this->_set_defaults();
+		add_action('AHEE__EE_System__initialize', [$this, 'open_session']);
+		// check request for 'clear_session' param
+		add_action('AHEE__EE_Request_Handler__construct__complete', [$this, 'wp_loaded']);
+		// once everything is all said and done,
+		add_action('shutdown', [$this, 'update'], 100);
+		add_action('shutdown', [$this, 'garbageCollection'], 1000);
+		$this->configure_garbage_collection_filters();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function isLoadedAndActive(): bool
+	{
+		return did_action('AHEE__EE_System__core_loaded_and_ready')
+			   && EE_Session::instance() instanceof EE_Session
+			   && EE_Session::instance()->isActive();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActive(): bool
+	{
+		return $this->status === EE_Session::STATUS_OPEN;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function open_session()
+	{
+		// Check for an existing session and retrieve it from the database, unless the system is in maintenance level 2.
+		if (EE_Maintenance_Mode::instance()->models_can_query() && ! $this->_espresso_session()) {
+			// or just start a new one
+			$this->_create_espresso_session();
+		}
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function expired(): bool
+	{
+		return $this->_expired;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function expiration(): int
+	{
+		return $this->_expiration;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function extension(): int
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
+	}
+
+
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 */
+	public function extend_expiration(int $time = 0)
+	{
+		$time              = $time
+			?: $this->extension();
+		$this->_expiration += absint($time);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function lifespan(): int
+	{
+		return $this->session_lifespan->inSeconds();
+	}
+
+
+	/**
+	 * Marks whether the session data has been updated or not.
+	 * Valid options are:
+	 *      EE_Session::SAVE_STATE_CLEAN - session data remains unchanged and updating is not necessary
+	 *      EE_Session::SAVE_STATE_DIRTY - session data has changed since last save and needs to be updated
+	 * default value is EE_Session::SAVE_STATE_DIRTY
+	 *
+	 * @param string $save_state
+	 */
+	public function setSaveState(string $save_state = EE_Session::SAVE_STATE_DIRTY)
+	{
+		$valid_save_states = [
+			EE_Session::SAVE_STATE_CLEAN,
+			EE_Session::SAVE_STATE_DIRTY,
+		];
+		if (! in_array($save_state, $valid_save_states, true)) {
+			$save_state = EE_Session::SAVE_STATE_DIRTY;
+		}
+		$this->save_state = $save_state;
+	}
+
+
+	/**
+	 * This just sets some defaults for the _session data property
+	 *
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		// set some defaults
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[ $key ] = [];
+			} else {
+				$this->_session_data[ $key ] = '';
+			}
+		}
+	}
+
+
+	/**
+	 * @retrieve  session data
+	 * @return    string
+	 */
+	public function id(): string
+	{
+		return $this->_sid;
+	}
+
+
+	/**
+	 * @param EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart): bool
+	{
+		$this->_session_data['cart'] = $cart;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_cart
+	 */
+	public function reset_cart()
+	{
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		$this->_session_data['cart'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return EE_Cart
+	 */
+	public function cart(): ?EE_Cart
+	{
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * @param EE_Checkout $checkout
+	 * @return bool
+	 */
+	public function set_checkout(EE_Checkout $checkout): bool
+	{
+		$this->_session_data['checkout'] = $checkout;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_checkout
+	 */
+	public function reset_checkout()
+	{
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		$this->_session_data['checkout'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return EE_Checkout
+	 */
+	public function checkout(): ?EE_Checkout
+	{
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_transaction(EE_Transaction $transaction): bool
+	{
+		// first remove the session from the transaction before we save the transaction in the session
+		$transaction->set_txn_session_data(null);
+		$this->_session_data['transaction'] = $transaction;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_transaction
+	 */
+	public function reset_transaction()
+	{
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		$this->_session_data['transaction'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction(): ?EE_Transaction
+	{
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+			? $this->_session_data['transaction']
+			: null;
+	}
+
+
+	/**
+	 * retrieve session data
+	 *
+	 * @param string|null $key
+	 * @param bool        $reset_cache
+	 * @return array|EE_Cart|EE_Checkout|EE_Transaction
+	 */
+	public function get_session_data(?string $key = null, bool $reset_cache = false)
+	{
+		if ($reset_cache) {
+			$this->reset_cart();
+			$this->reset_checkout();
+			$this->reset_transaction();
+		}
+		if (! empty($key)) {
+			return $this->_session_data[ $key ] ?? null;
+		}
+		return $this->_session_data;
+	}
+
+
+	/**
+	 * Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function set_session_data(array $data): bool
+	{
+		// nothing ??? bad data ??? go home!
+		if (empty($data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data or invalid session data was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		foreach ($data as $key => $value) {
+			if (isset($this->_default_session_vars[ $key ])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'
+						),
+						$key
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$this->_session_data[ $key ] = $value;
+			$this->setSaveState();
+		}
+		return true;
+	}
+
+
+	/**
+	 * @initiate session
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	private function _espresso_session(): bool
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->session_start_handler->startSession();
+		$this->status = EE_Session::STATUS_OPEN;
+		// get our modified session ID
+		$this->_sid = $this->_generate_session_id();
+		// set the "user agent"
+		$this->_user_agent = $this->request->userAgent();
+		// now let's retrieve what's in the db
+		$session_data = $this->_retrieve_session_data();
+		if (empty($session_data)) {
+			// set initial site access time and the session expiration
+			$this->_set_init_access_and_expiration();
+			// set referer
+			$this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
+				$this->request->getServerParam('HTTP_REFERER')
+			);
+			// no previous session = go back and create one (on top of the data above)
+			return false;
+		}
+		// get the current time in UTC
+		$this->_time = $this->_time !== null
+			? $this->_time
+			: time();
+		// and reset the session expiration
+		$this->_expiration = $session_data['expiration'] ?? $this->_time + $this->session_lifespan->inSeconds();
+		// now the user agent
+		if ($session_data['user_agent'] !== $this->_user_agent) {
+			return false;
+		}
+		// wait a minute... how old are you?
+		if ($this->_time > $this->_expiration) {
+			// yer too old fer me!
+			$this->_expired = true;
+			// wipe out everything that isn't a default session datum
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// make event espresso session data available to plugin
+		$this->_session_data = array_merge($this->_session_data, $session_data);
+		return true;
+	}
+
+
+	/**
+	 * _get_session_data
+	 * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
+	 * databases
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidSessionDataException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _retrieve_session_data(): array
+	{
+		$ssn_key = EE_Session::session_id_prefix . $this->_sid;
+		try {
+			// we're using WP's Transient API to store session data using the PHP session ID as the option name
+			$session_data = $this->cache_storage->get($ssn_key, false);
+			if (empty($session_data)) {
+				return [];
+			}
+			if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+				$hash_check = $this->cache_storage->get(
+					EE_Session::hash_check_prefix . $this->_sid,
+					false
+				);
+				if ($hash_check && $hash_check !== md5($session_data)) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
+								'event_espresso'
+							),
+							EE_Session::session_id_prefix . $this->_sid
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} catch (Exception $e) {
+			// let's just eat that error for now and attempt to correct any corrupted data
+			global $wpdb;
+			$row          = $wpdb->get_row(
+				$wpdb->prepare(
+					"SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
+					'_transient_' . $ssn_key
+				)
+			);
+			$session_data = is_object($row)
+				? $row->option_value
+				: null;
+			if ($session_data) {
+				$session_data = preg_replace_callback(
+					'!s:(d+):"(.*?)";!',
+					function ($match) {
+						return $match[1] === strlen($match[2])
+							? $match[0]
+							: 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+					},
+					$session_data
+				);
+			}
+			$session_data = maybe_unserialize($session_data);
+		}
+		// in case the data is encoded... try to decode it
+		$session_data = $this->_use_encryption
+			? $this->encryption->decodeString($session_data)
+			: $session_data;
+		if (! is_array($session_data)) {
+			try {
+				$session_data = maybe_unserialize($session_data);
+			} catch (Exception $e) {
+				$msg = esc_html__(
+					'An error occurred while attempting to unserialize the session data.',
+					'event_espresso'
+				);
+				$msg .= WP_DEBUG
+					? '<br><pre>'
+					  . print_r($session_data, true)
+					  . '</pre><br>'
+					  . $this->find_serialize_error($session_data)
+					: '';
+				$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+				throw new InvalidSessionDataException($msg, 0, $e);
+			}
+		}
+		// just a check to make sure the session array is indeed an array
+		if (! is_array($session_data)) {
+			// no?!?! then something is wrong
+			$msg = esc_html__(
+				'The session data is missing, invalid, or corrupted.',
+				'event_espresso'
+			);
+			$msg .= WP_DEBUG
+				? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+				: '';
+			$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+			throw new InvalidSessionDataException($msg);
+		}
+		if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
+			$session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
+				$session_data['transaction']
+			);
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * _generate_session_id
+	 * Retrieves the PHP session id either directly from the PHP session,
+	 * or from the request array if it was passed in from an AJAX request.
+	 * The session id is then salted and hashed (mmm sounds tasty)
+	 * so that it can be safely used as a request param
+	 *
+	 * @return string
+	 */
+	protected function _generate_session_id(): string
+	{
+		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
+		$session_id = $this->request->requestParamIsSet('EESID')
+			? $this->request->getRequestParam('EESID')
+			: md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
+	}
+
+
+	/**
+	 * _get_sid_salt
+	 *
+	 * @return string
+	 */
+	protected function _get_sid_salt(): string
+	{
+		// was session id salt already saved to db ?
+		if (empty($this->_sid_salt)) {
+			// no?  then maybe use WP defined constant
+			if (defined('AUTH_SALT')) {
+				$this->_sid_salt = AUTH_SALT;
+			}
+			// if salt doesn't exist or is too short
+			if (strlen($this->_sid_salt) < 32) {
+				// create a new one
+				$this->_sid_salt = wp_generate_password(64);
+			}
+			// and save it as a permanent session setting
+			$this->updateSessionSettings(['sid_salt' => $this->_sid_salt]);
+		}
+		return $this->_sid_salt;
+	}
+
+
+	/**
+	 * _set_init_access_and_expiration
+	 *
+	 * @return void
+	 */
+	protected function _set_init_access_and_expiration()
+	{
+		$this->_time       = time();
+		$this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
+		// set initial site access time
+		$this->_session_data['init_access'] = $this->_time;
+		// and the session expiration
+		$this->_session_data['expiration'] = $this->_expiration;
+	}
+
+
+	/**
+	 * @update session data  prior to saving to the db
+	 * @param bool $new_session
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function update(bool $new_session = false): bool
+	{
+		$this->_session_data = is_array($this->_session_data) && isset($this->_session_data['id'])
+			? $this->_session_data
+			: [];
+		if (empty($this->_session_data)) {
+			$this->_set_defaults();
+		}
+		$session_data = [];
+		foreach ($this->_session_data as $key => $value) {
+			switch ($key) {
+				case 'id':
+					// session ID
+					$session_data['id'] = $this->_sid;
+					break;
+				case 'ip_address':
+					// visitor ip address
+					$session_data['ip_address'] = $this->request->ipAddress();
+					break;
+				case 'user_agent':
+					// visitor user_agent
+					$session_data['user_agent'] = $this->_user_agent;
+					break;
+				case 'init_access':
+					$session_data['init_access'] = absint($value);
+					break;
+				case 'last_access':
+					// current access time
+					$session_data['last_access'] = $this->_time;
+					break;
+				case 'expiration':
+					// when the session expires
+					$session_data['expiration'] = ! empty($this->_expiration)
+						? $this->_expiration
+						: $session_data['init_access'] + $this->session_lifespan->inSeconds();
+					break;
+				case 'user_id':
+					// current user if logged in
+					$session_data['user_id'] = $this->_wp_user_id();
+					break;
+				case 'pages_visited':
+					$page_visit = $this->_get_page_visit();
+					if ($page_visit) {
+						// set pages visited where the first will be the http referrer
+						$this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+						// we'll only save the last 10 page visits.
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
+					}
+					break;
+				default:
+					// carry any other data over
+					$session_data[ $key ] = $this->_session_data[ $key ];
+			}
+		}
+		$this->_session_data = $session_data;
+		// creating a new session does not require saving to the db just yet
+		if (! $new_session) {
+			// ready? let's save
+			if ($this->_save_session_to_db()) {
+				return true;
+			}
+			return false;
+		}
+		// meh, why not?
+		return true;
+	}
+
+
+	/**
+	 * @create session data array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _create_espresso_session()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
+		// use the update function for now with $new_session arg set to TRUE
+		$this->update(true);
+	}
+
+
+	/**
+	 * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
+	 * too). This is used when determining if we want to save the session or not.
+	 *
+	 * @return bool
+	 * @since 4.9.67.p
+	 */
+	private function sessionHasStuffWorthSaving(): bool
+	{
+		return $this->save_state === EE_Session::SAVE_STATE_DIRTY
+			   // we may want to eventually remove the following
+			   // on the assumption that the above check is enough
+			   || $this->cart() instanceof EE_Cart
+			   || (
+				   isset($this->_session_data['ee_notices'])
+				   && (
+					   ! empty($this->_session_data['ee_notices']['attention'])
+					   || ! empty($this->_session_data['ee_notices']['errors'])
+					   || ! empty($this->_session_data['ee_notices']['success'])
+				   )
+			   );
+	}
+
+
+	/**
+	 * _save_session_to_db
+	 *
+	 * @param bool $clear_session
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _save_session_to_db(bool $clear_session = false): bool
+	{
+		// don't save sessions for crawlers
+		// and unless we're deleting the session data, don't save anything if there isn't a cart
+		if (
+			$this->request->isBot()
+			|| (
+				! $clear_session
+				&& ! $this->sessionHasStuffWorthSaving()
+				&& apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
+			)
+		) {
+			return false;
+		}
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			if (! $transaction->ID()) {
+				$transaction->save();
+			}
+			$this->_session_data['transaction'] = $transaction->ID();
+		}
+		// then serialize all of our session data
+		$session_data = serialize($this->_session_data);
+		// do we need to also encode it to avoid corrupted data when saved to the db?
+		$session_data = $this->_use_encryption
+			? $this->encryption->encodeString($session_data)
+			: $session_data;
+		// maybe save hash check
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+			$this->cache_storage->add(
+				EE_Session::hash_check_prefix . $this->_sid,
+				md5($session_data),
+				$this->session_lifespan->inSeconds()
+			);
+		}
+		// we're using the Transient API for storing session data,
+		$saved = $this->cache_storage->add(
+			EE_Session::session_id_prefix . $this->_sid,
+			$session_data,
+			$this->session_lifespan->inSeconds()
+		);
+		$this->setSaveState(EE_Session::SAVE_STATE_CLEAN);
+		return $saved;
+	}
+
+
+	/**
+	 * @get    the full page request the visitor is accessing
+	 * @return string
+	 */
+	public function _get_page_visit(): string
+	{
+		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		// check for request url
+		if ($this->request->serverParamIsSet('REQUEST_URI')) {
+			$page_id     = '?';
+			$e_reg       = '';
+			$request_uri = $this->request->getServerParam('REQUEST_URI');
+			$ru_bits     = explode('?', $request_uri);
+			$request_uri = $ru_bits[0];
+			$http_host   = $this->request->getServerParam('HTTP_HOST');
+			// check for page_id in SERVER REQUEST
+			if ($this->request->requestParamIsSet('page_id')) {
+				// rebuild $e_reg without any of the extra parameters
+				$page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
+			}
+			// check for $e_reg in SERVER REQUEST
+			if ($this->request->requestParamIsSet('ee')) {
+				// rebuild $e_reg without any of the extra parameters
+				$e_reg = 'ee=' . $this->request->getRequestParam('ee');
+			}
+			$page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
+		}
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php')
+			? $page_visit
+			: '';
+	}
+
+
+	/**
+	 * @the    current wp user id
+	 * @return int
+	 */
+	public function _wp_user_id(): int
+	{
+		// if I need to explain the following lines of code, then you shouldn't be looking at this!
+		return get_current_user_id();
+	}
+
+
+	/**
+	 * Clear EE_Session data
+	 *
+	 * @param string $class
+	 * @param string $function
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function clear_session(string $class = '', string $function = '')
+	{
 //         echo '
 // <h3 style="color:#999;line-height:.9em;">
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
-        $this->reset_cart();
-        $this->reset_checkout();
-        $this->reset_transaction();
-        // wipe out everything that isn't a default session datum
-        $this->reset_data(array_keys($this->_session_data));
-        // reset initial site access time and the session expiration
-        $this->_set_init_access_and_expiration();
-        $this->setSaveState();
-        $this->_save_session_to_db(true);
-    }
-
-
-    /**
-     * resets all non-default session vars. Returns TRUE on success, FALSE on fail
-     *
-     * @param array|mixed $data_to_reset
-     * @param bool        $show_all_notices
-     * @return bool
-     */
-    public function reset_data($data_to_reset = [], bool $show_all_notices = false): bool
-    {
-        // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
-            $data_to_reset = [$data_to_reset];
-        }
-        // nothing ??? go home!
-        if (empty($data_to_reset)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data could be reset, because no session var name was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $return_value = true;
-        // since $data_to_reset is an array, cycle through the values
-        foreach ($data_to_reset as $reset) {
-            // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
-                // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
-                    // remove session var
-                    unset($this->_session_data[ $reset ]);
-                    $this->setSaveState();
-                    if ($show_all_notices) {
-                        EE_Error::add_success(
-                            sprintf(
-                                esc_html__('The session variable %s was removed.', 'event_espresso'),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    // yeeeeeeeeerrrrrrrrrrr OUT !!!!
-                    if ($show_all_notices) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'Sorry! %s is a default session datum and can not be reset.',
-                                    'event_espresso'
-                                ),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    $return_value = false;
-                }
-            } elseif ($show_all_notices) {
-                // oops! that session var does not exist!
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The session item provided, %s, is invalid or does not exist.',
-                            'event_espresso'
-                        ),
-                        $reset
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $return_value = false;
-            }
-        } // end of foreach
-        return $return_value;
-    }
-
-
-    /**
-     *   wp_loaded
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function wp_loaded()
-    {
-        if ($this->request->requestParamIsSet('clear_session')) {
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-    }
-
-
-    /**
-     * Used to reset the entire object (for tests).
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.3.0
-     */
-    public function reset_instance()
-    {
-        $this->clear_session();
-        self::$_instance = null;
-    }
-
-
-    public function configure_garbage_collection_filters()
-    {
-        // run old filter we had for controlling session cleanup
-        $expired_session_transient_delete_query_limit = absint(
-            apply_filters(
-                'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                50
-            )
-        );
-        // is there a value? or one that is different than the default 50 records?
-        if ($expired_session_transient_delete_query_limit === 0) {
-            // hook into TransientCacheStorage in case Session cleanup was turned off
-            add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
-        } elseif ($expired_session_transient_delete_query_limit !== 50) {
-            // or use that for the new transient cleanup query limit
-            add_filter(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
-                    return $expired_session_transient_delete_query_limit;
-                }
-            );
-        }
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
-     * @param string $data1
-     * @return string
-     */
-    private function find_serialize_error(string $data1): string
-    {
-        $error = '<pre>';
-        $data2 = preg_replace_callback(
-            '!s:(\d+):"(.*?)";!',
-            function ($match) {
-                return ($match[1] === strlen($match[2]))
-                    ? $match[0]
-                    : 's:'
-                      . strlen($match[2])
-                      . ':"'
-                      . $match[2]
-                      . '";';
-            },
-            $data1
-        );
-        $max   = (strlen($data1) > strlen($data2))
-            ? strlen($data1)
-            : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
-        for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error  .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error  .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error  .= "\t-> Line Number = $i" . PHP_EOL;
-                $start  = ($i - 20);
-                $start  = ($start < 0)
-                    ? 0
-                    : $start;
-                $length = 40;
-                $point  = $max - $i;
-                if ($point < 20) {
-                    $rlength = 1;
-                    $rpoint  = -$point;
-                } else {
-                    $rpoint  = $length - 20;
-                    $rlength = 1;
-                }
-                $error .= "\t-> Section Data1  = ";
-                $error .= substr_replace(
-                    substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-                $error .= "\t-> Section Data2  = ";
-                $error .= substr_replace(
-                    substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-            }
-        }
-        $error .= '</pre>';
-        return $error;
-    }
-
-
-    /**
-     * Saves an  array of settings used for configuring aspects of session behaviour
-     *
-     * @param array $updated_settings
-     */
-    private function updateSessionSettings(array $updated_settings = [])
-    {
-        // add existing settings, but only if not included in incoming $updated_settings array
-        $updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, []);
-        update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
-    }
-
-
-    /**
-     * garbage_collection
-     */
-    public function garbageCollection()
-    {
-        // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
-            $this->_last_gc = time();
-            $this->updateSessionSettings(['last_gc' => $this->_last_gc]);
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            // filter the query limit. Set to 0 to turn off garbage collection
-            $expired_session_transient_delete_query_limit = absint(
-                apply_filters(
-                    'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                    50
-                )
-            );
-            // non-zero LIMIT means take out the trash
-            if ($expired_session_transient_delete_query_limit) {
-                $session_key    = str_replace('_', '\_', EE_Session::session_id_prefix);
-                $hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
-                // since transient expiration timestamps are set in the future, we can compare against NOW,
-                // but we only want to pick up any trash that's been around for more than a day
-                $expiration = time() - DAY_IN_SECONDS;
-                $SQL        = "
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+		$this->reset_cart();
+		$this->reset_checkout();
+		$this->reset_transaction();
+		// wipe out everything that isn't a default session datum
+		$this->reset_data(array_keys($this->_session_data));
+		// reset initial site access time and the session expiration
+		$this->_set_init_access_and_expiration();
+		$this->setSaveState();
+		$this->_save_session_to_db(true);
+	}
+
+
+	/**
+	 * resets all non-default session vars. Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array|mixed $data_to_reset
+	 * @param bool        $show_all_notices
+	 * @return bool
+	 */
+	public function reset_data($data_to_reset = [], bool $show_all_notices = false): bool
+	{
+		// if $data_to_reset is not in an array, then put it in one
+		if (! is_array($data_to_reset)) {
+			$data_to_reset = [$data_to_reset];
+		}
+		// nothing ??? go home!
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data could be reset, because no session var name was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$return_value = true;
+		// since $data_to_reset is an array, cycle through the values
+		foreach ($data_to_reset as $reset) {
+			// first check to make sure it is a valid session var
+			if (isset($this->_session_data[ $reset ])) {
+				// then check to make sure it is not a default var
+				if (! array_key_exists($reset, $this->_default_session_vars)) {
+					// remove session var
+					unset($this->_session_data[ $reset ]);
+					$this->setSaveState();
+					if ($show_all_notices) {
+						EE_Error::add_success(
+							sprintf(
+								esc_html__('The session variable %s was removed.', 'event_espresso'),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
+					if ($show_all_notices) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'Sorry! %s is a default session datum and can not be reset.',
+									'event_espresso'
+								),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					$return_value = false;
+				}
+			} elseif ($show_all_notices) {
+				// oops! that session var does not exist!
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The session item provided, %s, is invalid or does not exist.',
+							'event_espresso'
+						),
+						$reset
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$return_value = false;
+			}
+		} // end of foreach
+		return $return_value;
+	}
+
+
+	/**
+	 *   wp_loaded
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function wp_loaded()
+	{
+		if ($this->request->requestParamIsSet('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+	}
+
+
+	/**
+	 * Used to reset the entire object (for tests).
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.3.0
+	 */
+	public function reset_instance()
+	{
+		$this->clear_session();
+		self::$_instance = null;
+	}
+
+
+	public function configure_garbage_collection_filters()
+	{
+		// run old filter we had for controlling session cleanup
+		$expired_session_transient_delete_query_limit = absint(
+			apply_filters(
+				'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+				50
+			)
+		);
+		// is there a value? or one that is different than the default 50 records?
+		if ($expired_session_transient_delete_query_limit === 0) {
+			// hook into TransientCacheStorage in case Session cleanup was turned off
+			add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
+		} elseif ($expired_session_transient_delete_query_limit !== 50) {
+			// or use that for the new transient cleanup query limit
+			add_filter(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				function () use ($expired_session_transient_delete_query_limit) {
+					return $expired_session_transient_delete_query_limit;
+				}
+			);
+		}
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
+	 * @param string $data1
+	 * @return string
+	 */
+	private function find_serialize_error(string $data1): string
+	{
+		$error = '<pre>';
+		$data2 = preg_replace_callback(
+			'!s:(\d+):"(.*?)";!',
+			function ($match) {
+				return ($match[1] === strlen($match[2]))
+					? $match[0]
+					: 's:'
+					  . strlen($match[2])
+					  . ':"'
+					  . $match[2]
+					  . '";';
+			},
+			$data1
+		);
+		$max   = (strlen($data1) > strlen($data2))
+			? strlen($data1)
+			: strlen($data2);
+		$error .= $data1 . PHP_EOL;
+		$error .= $data2 . PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[ $i ] !== @$data2[ $i ]) {
+				$error  .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
+				$error  .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
+				$error  .= "\t-> Line Number = $i" . PHP_EOL;
+				$start  = ($i - 20);
+				$start  = ($start < 0)
+					? 0
+					: $start;
+				$length = 40;
+				$point  = $max - $i;
+				if ($point < 20) {
+					$rlength = 1;
+					$rpoint  = -$point;
+				} else {
+					$rpoint  = $length - 20;
+					$rlength = 1;
+				}
+				$error .= "\t-> Section Data1  = ";
+				$error .= substr_replace(
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+				$error .= "\t-> Section Data2  = ";
+				$error .= substr_replace(
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+			}
+		}
+		$error .= '</pre>';
+		return $error;
+	}
+
+
+	/**
+	 * Saves an  array of settings used for configuring aspects of session behaviour
+	 *
+	 * @param array $updated_settings
+	 */
+	private function updateSessionSettings(array $updated_settings = [])
+	{
+		// add existing settings, but only if not included in incoming $updated_settings array
+		$updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, []);
+		update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
+	}
+
+
+	/**
+	 * garbage_collection
+	 */
+	public function garbageCollection()
+	{
+		// only perform during regular requests if last garbage collection was over an hour ago
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+			$this->_last_gc = time();
+			$this->updateSessionSettings(['last_gc' => $this->_last_gc]);
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			// filter the query limit. Set to 0 to turn off garbage collection
+			$expired_session_transient_delete_query_limit = absint(
+				apply_filters(
+					'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+					50
+				)
+			);
+			// non-zero LIMIT means take out the trash
+			if ($expired_session_transient_delete_query_limit) {
+				$session_key    = str_replace('_', '\_', EE_Session::session_id_prefix);
+				$hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
+				// since transient expiration timestamps are set in the future, we can compare against NOW,
+				// but we only want to pick up any trash that's been around for more than a day
+				$expiration = time() - DAY_IN_SECONDS;
+				$SQL        = "
                     SELECT option_name
                     FROM $wpdb->options
                     WHERE
@@ -1331,17 +1331,17 @@ 
                     AND option_value < $expiration
                     LIMIT $expired_session_transient_delete_query_limit
                 ";
-                // produces something like:
-                // SELECT option_name FROM wp_options
-                // WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
-                // OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
-                // AND option_value < 1508368198 LIMIT 50
-                $expired_sessions = $wpdb->get_col($SQL);
-                // valid results?
-                if (! empty($expired_sessions)) {
-                    $this->cache_storage->deleteMany($expired_sessions, true);
-                }
-            }
-        }
-    }
+				// produces something like:
+				// SELECT option_name FROM wp_options
+				// WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
+				// OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
+				// AND option_value < 1508368198 LIMIT 50
+				$expired_sessions = $wpdb->get_col($SQL);
+				// valid results?
+				if (! empty($expired_sessions)) {
+					$this->cache_storage->deleteMany($expired_sessions, true);
+				}
+			}
+		}
+	}
 }

Spacing +54 added lines, -54 removed lines

@@ -233,22 +233,22 @@ 
         // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
         // (which currently fires on the init hook at priority 9),
         // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! apply_filters('FHEE_load_EE_Session', true)) {
             return;
         }
         $this->session_start_handler = $session_start_handler;
         $this->session_lifespan      = $lifespan;
         $this->request               = $request;
-        if (! defined('ESPRESSO_SESSION')) {
+        if ( ! defined('ESPRESSO_SESSION')) {
             define('ESPRESSO_SESSION', true);
         }
         // retrieve session options from db
         $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, []);
-        if (! empty($session_settings)) {
+        if ( ! empty($session_settings)) {
             // cycle though existing session options
             foreach ($session_settings as $var_name => $session_setting) {
                 // set values for class properties
-                $var_name          = '_' . $var_name;
+                $var_name          = '_'.$var_name;
                 $this->{$var_name} = $session_setting;
             }
         }
@@ -357,7 +357,7 @@ 
      */
     public function extend_expiration(int $time = 0)
     {
-        $time              = $time
+        $time = $time
             ?: $this->extension();
         $this->_expiration += absint($time);
     }
@@ -387,7 +387,7 @@ 
             EE_Session::SAVE_STATE_CLEAN,
             EE_Session::SAVE_STATE_DIRTY,
         ];
-        if (! in_array($save_state, $valid_save_states, true)) {
+        if ( ! in_array($save_state, $valid_save_states, true)) {
             $save_state = EE_Session::SAVE_STATE_DIRTY;
         }
         $this->save_state = $save_state;
@@ -404,9 +404,9 @@ 
         // set some defaults
         foreach ($this->_default_session_vars as $key => $default_var) {
             if (is_array($default_var)) {
-                $this->_session_data[ $key ] = [];
+                $this->_session_data[$key] = [];
             } else {
-                $this->_session_data[ $key ] = '';
+                $this->_session_data[$key] = '';
             }
         }
     }
@@ -543,8 +543,8 @@ 
             $this->reset_checkout();
             $this->reset_transaction();
         }
-        if (! empty($key)) {
-            return $this->_session_data[ $key ] ?? null;
+        if ( ! empty($key)) {
+            return $this->_session_data[$key] ?? null;
         }
         return $this->_session_data;
     }
@@ -572,7 +572,7 @@ 
             return false;
         }
         foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
+            if (isset($this->_default_session_vars[$key])) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -587,7 +587,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
             $this->setSaveState();
         }
         return true;
@@ -620,7 +620,7 @@ 
             // set initial site access time and the session expiration
             $this->_set_init_access_and_expiration();
             // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
+            $this->_session_data['pages_visited'][$this->_session_data['init_access']] = esc_attr(
                 $this->request->getServerParam('HTTP_REFERER')
             );
             // no previous session = go back and create one (on top of the data above)
@@ -665,7 +665,7 @@ 
      */
     protected function _retrieve_session_data(): array
     {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+        $ssn_key = EE_Session::session_id_prefix.$this->_sid;
         try {
             // we're using WP's Transient API to store session data using the PHP session ID as the option name
             $session_data = $this->cache_storage->get($ssn_key, false);
@@ -674,7 +674,7 @@ 
             }
             if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                 $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
+                    EE_Session::hash_check_prefix.$this->_sid,
                     false
                 );
                 if ($hash_check && $hash_check !== md5($session_data)) {
@@ -684,7 +684,7 @@ 
                                 'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                 'event_espresso'
                             ),
-                            EE_Session::session_id_prefix . $this->_sid
+                            EE_Session::session_id_prefix.$this->_sid
                         ),
                         __FILE__,
                         __FUNCTION__,
@@ -695,10 +695,10 @@ 
         } catch (Exception $e) {
             // let's just eat that error for now and attempt to correct any corrupted data
             global $wpdb;
-            $row          = $wpdb->get_row(
+            $row = $wpdb->get_row(
                 $wpdb->prepare(
                     "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
+                    '_transient_'.$ssn_key
                 )
             );
             $session_data = is_object($row)
@@ -707,10 +707,10 @@ 
             if ($session_data) {
                 $session_data = preg_replace_callback(
                     '!s:(d+):"(.*?)";!',
-                    function ($match) {
+                    function($match) {
                         return $match[1] === strlen($match[2])
                             ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                            : 's:'.strlen($match[2]).':"'.$match[2].'";';
                     },
                     $session_data
                 );
@@ -721,7 +721,7 @@ 
         $session_data = $this->_use_encryption
             ? $this->encryption->decodeString($session_data)
             : $session_data;
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             try {
                 $session_data = maybe_unserialize($session_data);
             } catch (Exception $e) {
@@ -735,21 +735,21 @@ 
                       . '</pre><br>'
                       . $this->find_serialize_error($session_data)
                     : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+                $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
                 throw new InvalidSessionDataException($msg, 0, $e);
             }
         }
         // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             // no?!?! then something is wrong
             $msg = esc_html__(
                 'The session data is missing, invalid, or corrupted.',
                 'event_espresso'
             );
             $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                 : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+            $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
             throw new InvalidSessionDataException($msg);
         }
         if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
@@ -775,7 +775,7 @@ 
         // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
         $session_id = $this->request->requestParamIsSet('EESID')
             ? $this->request->getRequestParam('EESID')
-            : md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+            : md5(session_id().get_current_blog_id().$this->_get_sid_salt());
         return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
     }
 
@@ -875,19 +875,19 @@ 
                     $page_visit = $this->_get_page_visit();
                     if ($page_visit) {
                         // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+                        $this->_session_data['pages_visited'][$this->_time] = $page_visit;
                         // we'll only save the last 10 page visits.
                         $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
                     }
                     break;
                 default:
                     // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
+                    $session_data[$key] = $this->_session_data[$key];
             }
         }
         $this->_session_data = $session_data;
         // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
+        if ( ! $new_session) {
             // ready? let's save
             if ($this->_save_session_to_db()) {
                 return true;
@@ -966,7 +966,7 @@ 
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -980,14 +980,14 @@ 
         // maybe save hash check
         if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->session_lifespan->inSeconds()
             );
         }
         // we're using the Transient API for storing session data,
         $saved = $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->session_lifespan->inSeconds()
         );
@@ -1002,7 +1002,7 @@ 
      */
     public function _get_page_visit(): string
     {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+        $page_visit = home_url('/').'wp-admin/admin-ajax.php';
         // check for request url
         if ($this->request->serverParamIsSet('REQUEST_URI')) {
             $page_id     = '?';
@@ -1014,14 +1014,14 @@ 
             // check for page_id in SERVER REQUEST
             if ($this->request->requestParamIsSet('page_id')) {
                 // rebuild $e_reg without any of the extra parameters
-                $page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
+                $page_id .= 'page_id='.$this->request->getRequestParam('page_id', 0, 'int').'&amp;';
             }
             // check for $e_reg in SERVER REQUEST
             if ($this->request->requestParamIsSet('ee')) {
                 // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . $this->request->getRequestParam('ee');
+                $e_reg = 'ee='.$this->request->getRequestParam('ee');
             }
-            $page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
+            $page_visit = esc_url(rtrim($http_host.$request_uri.$page_id.$e_reg, '?'));
         }
         return $page_visit !== home_url('/wp-admin/admin-ajax.php')
             ? $page_visit
@@ -1059,7 +1059,7 @@ 
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
         $this->reset_cart();
         $this->reset_checkout();
         $this->reset_transaction();
@@ -1082,7 +1082,7 @@ 
     public function reset_data($data_to_reset = [], bool $show_all_notices = false): bool
     {
         // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
+        if ( ! is_array($data_to_reset)) {
             $data_to_reset = [$data_to_reset];
         }
         // nothing ??? go home!
@@ -1102,11 +1102,11 @@ 
         // since $data_to_reset is an array, cycle through the values
         foreach ($data_to_reset as $reset) {
             // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
+            if (isset($this->_session_data[$reset])) {
                 // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
+                if ( ! array_key_exists($reset, $this->_default_session_vars)) {
                     // remove session var
-                    unset($this->_session_data[ $reset ]);
+                    unset($this->_session_data[$reset]);
                     $this->setSaveState();
                     if ($show_all_notices) {
                         EE_Error::add_success(
@@ -1209,7 +1209,7 @@ 
             // or use that for the new transient cleanup query limit
             add_filter(
                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
+                function() use ($expired_session_transient_delete_query_limit) {
                     return $expired_session_transient_delete_query_limit;
                 }
             );
@@ -1227,7 +1227,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match) {
+            function($match) {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
                     : 's:'
@@ -1238,16 +1238,16 @@ 
             },
             $data1
         );
-        $max   = (strlen($data1) > strlen($data2))
+        $max = (strlen($data1) > strlen($data2))
             ? strlen($data1)
             : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
+        $error .= $data1.PHP_EOL;
+        $error .= $data2.PHP_EOL;
         for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error  .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error  .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error  .= "\t-> Line Number = $i" . PHP_EOL;
+            if (@$data1[$i] !== @$data2[$i]) {
+                $error  .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+                $error  .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+                $error  .= "\t-> Line Number = $i".PHP_EOL;
                 $start  = ($i - 20);
                 $start  = ($start < 0)
                     ? 0
@@ -1264,7 +1264,7 @@ 
                 $error .= "\t-> Section Data1  = ";
                 $error .= substr_replace(
                     substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
+                    "<b style=\"color:green\">{$data1[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1272,7 +1272,7 @@ 
                 $error .= "\t-> Section Data2  = ";
                 $error .= substr_replace(
                     substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
+                    "<b style=\"color:red\">{$data2[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1303,7 +1303,7 @@ 
     public function garbageCollection()
     {
         // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
             $this->_last_gc = time();
             $this->updateSessionSettings(['last_gc' => $this->_last_gc]);
             /** @type WPDB $wpdb */
@@ -1338,7 +1338,7 @@ 
                 // AND option_value < 1508368198 LIMIT 50
                 $expired_sessions = $wpdb->get_col($SQL);
                 // valid results?
-                if (! empty($expired_sessions)) {
+                if ( ! empty($expired_sessions)) {
                     $this->cache_storage->deleteMany($expired_sessions, true);
                 }
             }

core/libraries/form_sections/inputs/EE_State_Select_Input.php

Indentation +86 added lines, -86 removed lines

@@ -12,94 +12,94 @@
  */
 class EE_State_Select_Input extends EE_Select_Input
 {
-    /**
-     * @var string the name of the EE_State field to use for option values in the HTML form input.
-     */
-    protected $valueFieldName;
+	/**
+	 * @var string the name of the EE_State field to use for option values in the HTML form input.
+	 */
+	protected $valueFieldName;
 
-    /**
-     * @param EE_State[]|array|null $state_options. If a flat array of string is provided,
-     * $input_settings['value_field_name'] is ignored. If an array of states is passed, that field will be used for
-     * the keys (which will become the option values). If null or empty is passed, all active states will be used,
-     * and $input_settings['value_field_name'] will again be used.     *
-     * @param array $input_settings same as parent, but also {
-     *   @type string $value_field_name the name of the field to use
-     *   for the HTML option values, ie, `STA_ID`, `STA_abbrev`, or `STA_name`.
-     * }
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($state_options, $input_settings = array())
-    {
-        if (isset($input_settings['value_field_name'])) {
-            $this->valueFieldName = $input_settings['value_field_name'];
-            if (! EEM_State::instance()->has_field((string) $this->valueFieldName())) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__('An invalid state field "%1$s" was specified for the state input\'s option values.', 'event_espresso'),
-                        $this->valueFieldName()
-                    )
-                );
-            }
-        } else {
-            $this->valueFieldName = 'STA_ID';
-        }
-        $state_options = apply_filters(
-            'FHEE__EE_State_Select_Input____construct__state_options',
-            $this->get_state_answer_options($state_options),
-            $this
-        );
-        $input_settings['html_class'] = isset($input_settings['html_class'])
-            ? $input_settings['html_class'] . ' ee-state-select-js'
-            : 'ee-state-select-js';
-        parent::__construct($state_options, $input_settings);
-    }
+	/**
+	 * @param EE_State[]|array|null $state_options. If a flat array of string is provided,
+	 * $input_settings['value_field_name'] is ignored. If an array of states is passed, that field will be used for
+	 * the keys (which will become the option values). If null or empty is passed, all active states will be used,
+	 * and $input_settings['value_field_name'] will again be used.     *
+	 * @param array $input_settings same as parent, but also {
+	 *   @type string $value_field_name the name of the field to use
+	 *   for the HTML option values, ie, `STA_ID`, `STA_abbrev`, or `STA_name`.
+	 * }
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($state_options, $input_settings = array())
+	{
+		if (isset($input_settings['value_field_name'])) {
+			$this->valueFieldName = $input_settings['value_field_name'];
+			if (! EEM_State::instance()->has_field((string) $this->valueFieldName())) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__('An invalid state field "%1$s" was specified for the state input\'s option values.', 'event_espresso'),
+						$this->valueFieldName()
+					)
+				);
+			}
+		} else {
+			$this->valueFieldName = 'STA_ID';
+		}
+		$state_options = apply_filters(
+			'FHEE__EE_State_Select_Input____construct__state_options',
+			$this->get_state_answer_options($state_options),
+			$this
+		);
+		$input_settings['html_class'] = isset($input_settings['html_class'])
+			? $input_settings['html_class'] . ' ee-state-select-js'
+			: 'ee-state-select-js';
+		parent::__construct($state_options, $input_settings);
+	}
 
-    /**
-     * Returns the name of the state field used for the HTML option values.
-     * @since 4.10.0.p
-     * @return string
-     */
-    public function valueFieldName()
-    {
-        return $this->valueFieldName;
-    }
+	/**
+	 * Returns the name of the state field used for the HTML option values.
+	 * @since 4.10.0.p
+	 * @return string
+	 */
+	public function valueFieldName()
+	{
+		return $this->valueFieldName;
+	}
 
 
-    /**
-     * get_state_answer_options
-     *
-     * @param array $state_options
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_state_answer_options($state_options = null)
-    {
-        // if passed something that is NOT an array
-        if (! is_array($state_options) || empty($state_options)) {
-            // get possibly cached list of states
-            $states = EEM_State::instance()->get_all_active_states();
-        }
-        if (is_array($state_options) && reset($state_options) instanceof EE_State) {
-            $states = $state_options;
-            $state_options = array();
-        }
-        if (! empty($states)) {
-            // set the default
-            $state_options[''][''] = '';
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->get($this->valueFieldName()) ] = $state->name();
-                }
-            }
-        }
-        return $state_options ?? [];
-    }
+	/**
+	 * get_state_answer_options
+	 *
+	 * @param array $state_options
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_state_answer_options($state_options = null)
+	{
+		// if passed something that is NOT an array
+		if (! is_array($state_options) || empty($state_options)) {
+			// get possibly cached list of states
+			$states = EEM_State::instance()->get_all_active_states();
+		}
+		if (is_array($state_options) && reset($state_options) instanceof EE_State) {
+			$states = $state_options;
+			$state_options = array();
+		}
+		if (! empty($states)) {
+			// set the default
+			$state_options[''][''] = '';
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $state->country()->name() ][ $state->get($this->valueFieldName()) ] = $state->name();
+				}
+			}
+		}
+		return $state_options ?? [];
+	}
 }

core/services/encryption/Base64Encoder.php

Indentation +148 added lines, -148 removed lines

@@ -14,152 +14,152 @@
  */
 class Base64Encoder
 {
-    /**
-     * @var boolean
-     */
-    protected $use_base64_encode;
-
-
-    public function __construct()
-    {
-        $this->use_base64_encode = function_exists('base64_encode');
-    }
-
-
-    /**
-     * encodes string with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $text_string the text to be encoded
-     * @return string
-     */
-    public function encodeString(string $text_string = ''): string
-    {
-        // you give me nothing??? GET OUT !
-        if (! $this->use_base64_encode || empty($text_string)) {
-            return $text_string;
-        }
-        // encode
-        return base64_encode($text_string);
-    }
-
-
-    /**
-     * decodes string that has been encoded with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $encoded_string the text to be decoded
-     * @param bool $no_throw         whether to throw an exception if the string is not valid base64
-     * @return string
-     * @throws RuntimeException
-     */
-    public function decodeString(string $encoded_string = '', bool $no_throw = false): string
-    {
-        // you give me nothing??? GET OUT !
-        if (
-            ! $this->use_base64_encode
-            || empty($encoded_string)
-            || ($no_throw && ! $this->isValidBase64($encoded_string))
-        ) {
-            return $encoded_string;
-        }
-        $this->isValidBase64OrFail($encoded_string);
-        return $this->decode($encoded_string);
-    }
-
-
-    /**
-     * @param string $encoded_string the text to be decoded
-     * @return string
-     * @throws RuntimeException
-     */
-    private function decode(string $encoded_string): string
-    {
-        $decoded_string = base64_decode($encoded_string);
-        if ($decoded_string === false) {
-            throw new RuntimeException(
-                esc_html__('Base 64 decoding failed.', 'event_espresso')
-            );
-        }
-        return $decoded_string;
-    }
-
-
-    /**
-     * encodes  url string with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $text_string the text to be encoded
-     * @return string
-     */
-    public function encodeUrl(string $text_string = ''): string
-    {
-        // you give me nothing??? GET OUT !
-        if (! $this->use_base64_encode || empty($text_string)) {
-            return $text_string;
-        }
-        // encode
-        $encoded_string = base64_encode($text_string);
-        // remove some chars to make encoding more URL friendly
-        return rtrim(strtr($encoded_string, '+/', '-_'), '=');
-    }
-
-
-    /**
-     * decodes  url string that has been encoded with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $encoded_string the text to be decoded
-     * @return string
-     * @throws RuntimeException
-     */
-    public function decodeUrl(string $encoded_string = ''): string
-    {
-        // you give me nothing??? GET OUT !
-        if (! $this->use_base64_encode || empty($encoded_string)) {
-            return $encoded_string;
-        }
-        // replace previously removed characters
-        $encoded_string = strtr($encoded_string, '-_', '+/');
-        $encoded_string .= str_repeat('=', 3 - (3 + strlen($encoded_string)) % 4);
-        $this->isValidBase64OrFail($encoded_string);
-        return $this->decode($encoded_string);
-    }
-
-
-    /**
-     * @param string $encoded_string the text to be decoded
-     * @throws RuntimeException
-     */
-    public function isValidBase64OrFail(string $encoded_string)
-    {
-        if (! $this->isValidBase64($encoded_string)) {
-            throw new RuntimeException(
-                esc_html__(
-                    'Base 64 decoding failed because the supplied string is not valid or was not base64 encoded.',
-                    'event_espresso'
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/a/51877882
-     * @param string $string
-     * @return bool
-     */
-    public function isValidBase64(string $string): bool
-    {
-        if (! $this->use_base64_encode) {
-            return false;
-        }
-        // first check if we're dealing with an actual valid base64 encoded string
-        $decoded = base64_decode($string, true);
-        if ($decoded === false) {
-            return false;
-        }
-        // finally, re-encode and compare it to original one
-        return base64_encode($decoded) === $string;
-    }
+	/**
+	 * @var boolean
+	 */
+	protected $use_base64_encode;
+
+
+	public function __construct()
+	{
+		$this->use_base64_encode = function_exists('base64_encode');
+	}
+
+
+	/**
+	 * encodes string with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $text_string the text to be encoded
+	 * @return string
+	 */
+	public function encodeString(string $text_string = ''): string
+	{
+		// you give me nothing??? GET OUT !
+		if (! $this->use_base64_encode || empty($text_string)) {
+			return $text_string;
+		}
+		// encode
+		return base64_encode($text_string);
+	}
+
+
+	/**
+	 * decodes string that has been encoded with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $encoded_string the text to be decoded
+	 * @param bool $no_throw         whether to throw an exception if the string is not valid base64
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function decodeString(string $encoded_string = '', bool $no_throw = false): string
+	{
+		// you give me nothing??? GET OUT !
+		if (
+			! $this->use_base64_encode
+			|| empty($encoded_string)
+			|| ($no_throw && ! $this->isValidBase64($encoded_string))
+		) {
+			return $encoded_string;
+		}
+		$this->isValidBase64OrFail($encoded_string);
+		return $this->decode($encoded_string);
+	}
+
+
+	/**
+	 * @param string $encoded_string the text to be decoded
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	private function decode(string $encoded_string): string
+	{
+		$decoded_string = base64_decode($encoded_string);
+		if ($decoded_string === false) {
+			throw new RuntimeException(
+				esc_html__('Base 64 decoding failed.', 'event_espresso')
+			);
+		}
+		return $decoded_string;
+	}
+
+
+	/**
+	 * encodes  url string with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $text_string the text to be encoded
+	 * @return string
+	 */
+	public function encodeUrl(string $text_string = ''): string
+	{
+		// you give me nothing??? GET OUT !
+		if (! $this->use_base64_encode || empty($text_string)) {
+			return $text_string;
+		}
+		// encode
+		$encoded_string = base64_encode($text_string);
+		// remove some chars to make encoding more URL friendly
+		return rtrim(strtr($encoded_string, '+/', '-_'), '=');
+	}
+
+
+	/**
+	 * decodes  url string that has been encoded with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $encoded_string the text to be decoded
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function decodeUrl(string $encoded_string = ''): string
+	{
+		// you give me nothing??? GET OUT !
+		if (! $this->use_base64_encode || empty($encoded_string)) {
+			return $encoded_string;
+		}
+		// replace previously removed characters
+		$encoded_string = strtr($encoded_string, '-_', '+/');
+		$encoded_string .= str_repeat('=', 3 - (3 + strlen($encoded_string)) % 4);
+		$this->isValidBase64OrFail($encoded_string);
+		return $this->decode($encoded_string);
+	}
+
+
+	/**
+	 * @param string $encoded_string the text to be decoded
+	 * @throws RuntimeException
+	 */
+	public function isValidBase64OrFail(string $encoded_string)
+	{
+		if (! $this->isValidBase64($encoded_string)) {
+			throw new RuntimeException(
+				esc_html__(
+					'Base 64 decoding failed because the supplied string is not valid or was not base64 encoded.',
+					'event_espresso'
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/a/51877882
+	 * @param string $string
+	 * @return bool
+	 */
+	public function isValidBase64(string $string): bool
+	{
+		if (! $this->use_base64_encode) {
+			return false;
+		}
+		// first check if we're dealing with an actual valid base64 encoded string
+		$decoded = base64_decode($string, true);
+		if ($decoded === false) {
+			return false;
+		}
+		// finally, re-encode and compare it to original one
+		return base64_encode($decoded) === $string;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -36,7 +36,7 @@ 
     public function encodeString(string $text_string = ''): string
     {
         // you give me nothing??? GET OUT !
-        if (! $this->use_base64_encode || empty($text_string)) {
+        if ( ! $this->use_base64_encode || empty($text_string)) {
             return $text_string;
         }
         // encode
@@ -95,7 +95,7 @@ 
     public function encodeUrl(string $text_string = ''): string
     {
         // you give me nothing??? GET OUT !
-        if (! $this->use_base64_encode || empty($text_string)) {
+        if ( ! $this->use_base64_encode || empty($text_string)) {
             return $text_string;
         }
         // encode
@@ -116,7 +116,7 @@ 
     public function decodeUrl(string $encoded_string = ''): string
     {
         // you give me nothing??? GET OUT !
-        if (! $this->use_base64_encode || empty($encoded_string)) {
+        if ( ! $this->use_base64_encode || empty($encoded_string)) {
             return $encoded_string;
         }
         // replace previously removed characters
@@ -133,7 +133,7 @@ 
      */
     public function isValidBase64OrFail(string $encoded_string)
     {
-        if (! $this->isValidBase64($encoded_string)) {
+        if ( ! $this->isValidBase64($encoded_string)) {
             throw new RuntimeException(
                 esc_html__(
                     'Base 64 decoding failed because the supplied string is not valid or was not base64 encoded.',
@@ -151,7 +151,7 @@ 
      */
     public function isValidBase64(string $string): bool
     {
-        if (! $this->use_base64_encode) {
+        if ( ! $this->use_base64_encode) {
             return false;
         }
         // first check if we're dealing with an actual valid base64 encoded string

admin_pages/registrations/EE_Registrations_List_Table.class.php

Indentation +1005 added lines, -1005 removed lines

@@ -15,574 +15,574 @@ 
  */
 class EE_Registrations_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * @var Registrations_Admin_Page
-     */
-    protected $_admin_page;
-
-    /**
-     * @var RegistrationsListTableUserCapabilities
-     */
-    protected $caps_handler;
-
-    /**
-     * @var array
-     */
-    private $_status;
-
-    /**
-     * An array of transaction details for the related transaction to the registration being processed.
-     * This is set via the _set_related_details method.
-     *
-     * @var array
-     */
-    protected $_transaction_details = [];
-
-    /**
-     * An array of event details for the related event to the registration being processed.
-     * This is set via the _set_related_details method.
-     *
-     * @var array
-     */
-    protected $_event_details = [];
-
-
-    /**
-     * @param Registrations_Admin_Page $admin_page
-     */
-    public function __construct(Registrations_Admin_Page $admin_page)
-    {
-        $this->caps_handler = new RegistrationsListTableUserCapabilities(EE_Registry::instance()->CAP);
-        $req_data = $admin_page->get_request_data();
-        if (! empty($req_data['event_id'])) {
-            $extra_query_args = [];
-            foreach ($admin_page->get_views() as $view_details) {
-                $extra_query_args[ $view_details['slug'] ] = ['event_id' => $req_data['event_id']];
-            }
-            $this->_views = $admin_page->get_list_table_view_RLs($extra_query_args);
-        }
-        parent::__construct($admin_page);
-        $this->_status = $this->_admin_page->get_registration_status_array();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _setup_data()
-    {
-        $this->_data           = $this->_admin_page->get_registrations($this->_per_page);
-        $this->_all_data_count = $this->_admin_page->get_registrations($this->_per_page, true);
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _set_properties()
-    {
-        $return_url          = $this->getReturnUrl();
-        $req_data            = $this->_admin_page->get_request_data();
-
-        $this->_wp_list_args = [
-            'singular' => esc_html__('registration', 'event_espresso'),
-            'plural'   => esc_html__('registrations', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        ];
-
-        $EVT_ID = isset($req_data['event_id']) ? (int) $req_data['event_id'] : 0;
-
-        $DTT_ID = $req_data['DTT_ID'] ?? 0;
-        $DTT_ID = $req_data['datetime_id'] ?? $DTT_ID;
-        $DTT_ID = (int) $DTT_ID;
-
-        if ($EVT_ID) {
-            $this->_columns        = [
-                'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
-                'id'               => esc_html__('ID', 'event_espresso'),
-                'ATT_fname'        => esc_html__('Name', 'event_espresso'),
-                'ATT_email'        => esc_html__('Email', 'event_espresso'),
-                '_REG_date'        => esc_html__('Reg Date', 'event_espresso'),
-                'PRC_amount'       => esc_html__('TKT Price', 'event_espresso'),
-                '_REG_final_price' => esc_html__('Final Price', 'event_espresso'),
-                'TXN_total'        => esc_html__('Total Txn', 'event_espresso'),
-                'TXN_paid'         => esc_html__('Paid', 'event_espresso'),
-                'actions'          => $this->actionsColumnHeader(),
-            ];
-        } else {
-            $this->_columns        = [
-                'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
-                'id'               => esc_html__('ID', 'event_espresso'),
-                'ATT_fname'        => esc_html__('Name', 'event_espresso'),
-                '_REG_date'        => esc_html__('TXN Date', 'event_espresso'),
-                'event_name'       => esc_html__('Event', 'event_espresso'),
-                'DTT_EVT_start'    => esc_html__('Event Date', 'event_espresso'),
-                '_REG_final_price' => esc_html__('Price', 'event_espresso'),
-                '_REG_paid'        => esc_html__('Paid', 'event_espresso'),
-                'actions'          => $this->actionsColumnHeader(),
-            ];
-        }
-
-        $csv_report = RegistrationsCsvReportParams::getRequestParams($return_url, $req_data, $EVT_ID, $DTT_ID);
-        if (! empty($csv_report)) {
-            $this->_bottom_buttons['csv_reg_report'] = $csv_report;
-        }
-
-        $this->_primary_column   = 'id';
-        $this->_sortable_columns = [
-            '_REG_date'     => ['_REG_date' => true],   // true means its already sorted
-            /**
-             * Allows users to change the default sort if they wish.
-             * Returning a falsey on this filter will result in the default sort to be by firstname rather than last
-             * name.
-             */
-            'ATT_fname'     => [
-                'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
-                true,
-                $this,
-            ]
-                ? ['ATT_lname' => false]
-                : ['ATT_fname' => false],
-            'event_name'    => ['event_name' => false],
-            'DTT_EVT_start' => ['DTT_EVT_start' => false],
-            'id'            => ['REG_ID' => false],
-        ];
-        $this->_hidden_columns   = [];
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param EE_Registration $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item): string
-    {
-        $class = parent::_get_row_class($item);
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * Set the $_transaction_details property if not set yet.
-     *
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_related_details(EE_Registration $registration)
-    {
-        $transaction                = $registration->get_first_related('Transaction');
-        $status                     = $transaction instanceof EE_Transaction
-            ? $transaction->status_ID()
-            : EEM_Transaction::failed_status_code;
-        $this->_transaction_details = [
-            'transaction' => $transaction,
-            'status'      => $status,
-            'id'          => $transaction instanceof EE_Transaction
-                ? $transaction->ID()
-                : 0,
-            'title_attr'  => sprintf(
-                esc_html__('View Transaction Details (%s)', 'event_espresso'),
-                EEH_Template::pretty_status($status, false, 'sentence')
-            ),
-        ];
-        try {
-            $event = $registration->event();
-        } catch (EntityNotFoundException $e) {
-            $event = null;
-        }
-        $status               = $event instanceof EE_Event
-            ? $event->get_active_status()
-            : EE_Datetime::inactive;
-        $this->_event_details = [
-            'event'      => $event,
-            'status'     => $status,
-            'id'         => $event instanceof EE_Event
-                ? $event->ID()
-                : 0,
-            'title_attr' => sprintf(
-                esc_html__('Edit Event (%s)', 'event_espresso'),
-                EEH_Template::pretty_status($status, false, 'sentence')
-            ),
-        ];
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_table_filters()
-    {
-        $filters = [];
-        // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as
-        // methods.
-        $cur_date     = $this->_req_data['month_range'] ?? '';
-        $cur_category = $this->_req_data['EVT_CAT'] ?? -1;
-        $reg_status   = $this->_req_data['_reg_status'] ?? '';
-        $filters[]    = EEH_Form_Fields::generate_registration_months_dropdown($cur_date, $reg_status, $cur_category);
-        $filters[]    = EEH_Form_Fields::generate_event_category_dropdown($cur_category);
-        $status       = [];
-        $status[]     = ['id' => 0, 'text' => esc_html__('Select Status', 'event_espresso')];
-        foreach ($this->_status as $key => $value) {
-            $status[] = ['id' => $key, 'text' => $value];
-        }
-        if ($this->_view !== 'incomplete') {
-            $filters[] = EEH_Form_Fields::select_input(
-                '_reg_status',
-                $status,
-                isset($this->_req_data['_reg_status'])
-                    ? strtoupper(sanitize_key($this->_req_data['_reg_status']))
-                    : ''
-            );
-        }
-        foreach (['event_id', 'datetime_id', 'ticket_id'] as $filter_key) {
-            if (isset($this->_req_data[ $filter_key ])) {
-                $filters[] = EEH_Form_Fields::hidden_input($filter_key, $this->_req_data[ $filter_key ], 'reg_' . $filter_key);
-            }
-        }
-        return $filters;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count']   = $this->_total_registrations();
-        $this->_views['month']['count'] = $this->_total_registrations_this_month();
-        $this->_views['today']['count'] = $this->_total_registrations_today();
-        if ($this->caps_handler->userCanTrashRegistrations()) {
-            $this->_views['incomplete']['count'] = $this->_total_registrations('incomplete');
-            $this->_views['trash']['count']      = $this->_total_registrations('trash');
-        }
-    }
-
-
-    /**
-     * @param string $view
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _total_registrations(string $view = ''): int
-    {
-        $_where = [];
-        $EVT_ID = isset($this->_req_data['event_id'])
-            ? absint($this->_req_data['event_id'])
-            : false;
-        if ($EVT_ID) {
-            $_where['EVT_ID'] = $EVT_ID;
-        }
-        switch ($view) {
-            case 'trash':
-                return EEM_Registration::instance()->count_deleted([$_where]);
-            case 'incomplete':
-                $_where['STS_ID'] = EEM_Registration::status_id_incomplete;
-                break;
-            default:
-                $_where['STS_ID'] = ['!=', EEM_Registration::status_id_incomplete];
-        }
-        return EEM_Registration::instance()->count([$_where]);
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _total_registrations_this_month(): int
-    {
-        $EVT_ID          = isset($this->_req_data['event_id'])
-            ? absint($this->_req_data['event_id'])
-            : false;
-        $_where          = $EVT_ID
-            ? ['EVT_ID' => $EVT_ID]
-            : [];
-        $this_year_r     = date('Y', current_time('timestamp'));
-        $time_start      = ' 00:00:00';
-        $time_end        = ' 23:59:59';
-        $this_month_r    = date('m', current_time('timestamp'));
-        $days_this_month = date('t', current_time('timestamp'));
-        // setup date query.
-        $beginning_string   = EEM_Registration::instance()->convert_datetime_for_query(
-            'REG_date',
-            $this_year_r . '-' . $this_month_r . '-01' . $time_start,
-            'Y-m-d H:i:s'
-        );
-        $end_string         = EEM_Registration::instance()->convert_datetime_for_query(
-            'REG_date',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . $time_end,
-            'Y-m-d H:i:s'
-        );
-        $_where['REG_date'] = [
-            'BETWEEN',
-            [
-                $beginning_string,
-                $end_string,
-            ],
-        ];
-        $_where['STS_ID']   = ['!=', EEM_Registration::status_id_incomplete];
-        return EEM_Registration::instance()->count([$_where]);
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _total_registrations_today(): int
-    {
-        $EVT_ID             = isset($this->_req_data['event_id'])
-            ? absint($this->_req_data['event_id'])
-            : false;
-        $_where             = $EVT_ID
-            ? ['EVT_ID' => $EVT_ID]
-            : [];
-        $current_date       = date('Y-m-d', current_time('timestamp'));
-        $time_start         = ' 00:00:00';
-        $time_end           = ' 23:59:59';
-        $_where['REG_date'] = [
-            'BETWEEN',
-            [
-                EEM_Registration::instance()->convert_datetime_for_query(
-                    'REG_date',
-                    $current_date . $time_start,
-                    'Y-m-d H:i:s'
-                ),
-                EEM_Registration::instance()->convert_datetime_for_query(
-                    'REG_date',
-                    $current_date . $time_end,
-                    'Y-m-d H:i:s'
-                ),
-            ],
-        ];
-        $_where['STS_ID']   = ['!=', EEM_Registration::status_id_incomplete];
-        return EEM_Registration::instance()->count([$_where]);
-    }
-
-
-    /**
-     * @param EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_cb($item): string
-    {
-        /** checkbox/lock **/
-        $REG_ID        = $item->ID();
-        $transaction   = $item->get_first_related('Transaction');
-        $payment_count = $transaction instanceof EE_Transaction
-            ? $transaction->count_related('Payment')
-            : 0;
-
-        $content = '<input type="checkbox" name="_REG_ID[]" value="' . $REG_ID . '" />';
-        $content .= $payment_count > 0 || ! $this->caps_handler->userCanEditRegistration($item)
-            ? '<span class="ee-locked-entity dashicons dashicons-lock ee-aria-tooltip ee-aria-tooltip--big-box"
+	/**
+	 * @var Registrations_Admin_Page
+	 */
+	protected $_admin_page;
+
+	/**
+	 * @var RegistrationsListTableUserCapabilities
+	 */
+	protected $caps_handler;
+
+	/**
+	 * @var array
+	 */
+	private $_status;
+
+	/**
+	 * An array of transaction details for the related transaction to the registration being processed.
+	 * This is set via the _set_related_details method.
+	 *
+	 * @var array
+	 */
+	protected $_transaction_details = [];
+
+	/**
+	 * An array of event details for the related event to the registration being processed.
+	 * This is set via the _set_related_details method.
+	 *
+	 * @var array
+	 */
+	protected $_event_details = [];
+
+
+	/**
+	 * @param Registrations_Admin_Page $admin_page
+	 */
+	public function __construct(Registrations_Admin_Page $admin_page)
+	{
+		$this->caps_handler = new RegistrationsListTableUserCapabilities(EE_Registry::instance()->CAP);
+		$req_data = $admin_page->get_request_data();
+		if (! empty($req_data['event_id'])) {
+			$extra_query_args = [];
+			foreach ($admin_page->get_views() as $view_details) {
+				$extra_query_args[ $view_details['slug'] ] = ['event_id' => $req_data['event_id']];
+			}
+			$this->_views = $admin_page->get_list_table_view_RLs($extra_query_args);
+		}
+		parent::__construct($admin_page);
+		$this->_status = $this->_admin_page->get_registration_status_array();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _setup_data()
+	{
+		$this->_data           = $this->_admin_page->get_registrations($this->_per_page);
+		$this->_all_data_count = $this->_admin_page->get_registrations($this->_per_page, true);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _set_properties()
+	{
+		$return_url          = $this->getReturnUrl();
+		$req_data            = $this->_admin_page->get_request_data();
+
+		$this->_wp_list_args = [
+			'singular' => esc_html__('registration', 'event_espresso'),
+			'plural'   => esc_html__('registrations', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		];
+
+		$EVT_ID = isset($req_data['event_id']) ? (int) $req_data['event_id'] : 0;
+
+		$DTT_ID = $req_data['DTT_ID'] ?? 0;
+		$DTT_ID = $req_data['datetime_id'] ?? $DTT_ID;
+		$DTT_ID = (int) $DTT_ID;
+
+		if ($EVT_ID) {
+			$this->_columns        = [
+				'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
+				'id'               => esc_html__('ID', 'event_espresso'),
+				'ATT_fname'        => esc_html__('Name', 'event_espresso'),
+				'ATT_email'        => esc_html__('Email', 'event_espresso'),
+				'_REG_date'        => esc_html__('Reg Date', 'event_espresso'),
+				'PRC_amount'       => esc_html__('TKT Price', 'event_espresso'),
+				'_REG_final_price' => esc_html__('Final Price', 'event_espresso'),
+				'TXN_total'        => esc_html__('Total Txn', 'event_espresso'),
+				'TXN_paid'         => esc_html__('Paid', 'event_espresso'),
+				'actions'          => $this->actionsColumnHeader(),
+			];
+		} else {
+			$this->_columns        = [
+				'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
+				'id'               => esc_html__('ID', 'event_espresso'),
+				'ATT_fname'        => esc_html__('Name', 'event_espresso'),
+				'_REG_date'        => esc_html__('TXN Date', 'event_espresso'),
+				'event_name'       => esc_html__('Event', 'event_espresso'),
+				'DTT_EVT_start'    => esc_html__('Event Date', 'event_espresso'),
+				'_REG_final_price' => esc_html__('Price', 'event_espresso'),
+				'_REG_paid'        => esc_html__('Paid', 'event_espresso'),
+				'actions'          => $this->actionsColumnHeader(),
+			];
+		}
+
+		$csv_report = RegistrationsCsvReportParams::getRequestParams($return_url, $req_data, $EVT_ID, $DTT_ID);
+		if (! empty($csv_report)) {
+			$this->_bottom_buttons['csv_reg_report'] = $csv_report;
+		}
+
+		$this->_primary_column   = 'id';
+		$this->_sortable_columns = [
+			'_REG_date'     => ['_REG_date' => true],   // true means its already sorted
+			/**
+			 * Allows users to change the default sort if they wish.
+			 * Returning a falsey on this filter will result in the default sort to be by firstname rather than last
+			 * name.
+			 */
+			'ATT_fname'     => [
+				'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
+				true,
+				$this,
+			]
+				? ['ATT_lname' => false]
+				: ['ATT_fname' => false],
+			'event_name'    => ['event_name' => false],
+			'DTT_EVT_start' => ['DTT_EVT_start' => false],
+			'id'            => ['REG_ID' => false],
+		];
+		$this->_hidden_columns   = [];
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param EE_Registration $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item): string
+	{
+		$class = parent::_get_row_class($item);
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * Set the $_transaction_details property if not set yet.
+	 *
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_related_details(EE_Registration $registration)
+	{
+		$transaction                = $registration->get_first_related('Transaction');
+		$status                     = $transaction instanceof EE_Transaction
+			? $transaction->status_ID()
+			: EEM_Transaction::failed_status_code;
+		$this->_transaction_details = [
+			'transaction' => $transaction,
+			'status'      => $status,
+			'id'          => $transaction instanceof EE_Transaction
+				? $transaction->ID()
+				: 0,
+			'title_attr'  => sprintf(
+				esc_html__('View Transaction Details (%s)', 'event_espresso'),
+				EEH_Template::pretty_status($status, false, 'sentence')
+			),
+		];
+		try {
+			$event = $registration->event();
+		} catch (EntityNotFoundException $e) {
+			$event = null;
+		}
+		$status               = $event instanceof EE_Event
+			? $event->get_active_status()
+			: EE_Datetime::inactive;
+		$this->_event_details = [
+			'event'      => $event,
+			'status'     => $status,
+			'id'         => $event instanceof EE_Event
+				? $event->ID()
+				: 0,
+			'title_attr' => sprintf(
+				esc_html__('Edit Event (%s)', 'event_espresso'),
+				EEH_Template::pretty_status($status, false, 'sentence')
+			),
+		];
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = [];
+		// todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as
+		// methods.
+		$cur_date     = $this->_req_data['month_range'] ?? '';
+		$cur_category = $this->_req_data['EVT_CAT'] ?? -1;
+		$reg_status   = $this->_req_data['_reg_status'] ?? '';
+		$filters[]    = EEH_Form_Fields::generate_registration_months_dropdown($cur_date, $reg_status, $cur_category);
+		$filters[]    = EEH_Form_Fields::generate_event_category_dropdown($cur_category);
+		$status       = [];
+		$status[]     = ['id' => 0, 'text' => esc_html__('Select Status', 'event_espresso')];
+		foreach ($this->_status as $key => $value) {
+			$status[] = ['id' => $key, 'text' => $value];
+		}
+		if ($this->_view !== 'incomplete') {
+			$filters[] = EEH_Form_Fields::select_input(
+				'_reg_status',
+				$status,
+				isset($this->_req_data['_reg_status'])
+					? strtoupper(sanitize_key($this->_req_data['_reg_status']))
+					: ''
+			);
+		}
+		foreach (['event_id', 'datetime_id', 'ticket_id'] as $filter_key) {
+			if (isset($this->_req_data[ $filter_key ])) {
+				$filters[] = EEH_Form_Fields::hidden_input($filter_key, $this->_req_data[ $filter_key ], 'reg_' . $filter_key);
+			}
+		}
+		return $filters;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count']   = $this->_total_registrations();
+		$this->_views['month']['count'] = $this->_total_registrations_this_month();
+		$this->_views['today']['count'] = $this->_total_registrations_today();
+		if ($this->caps_handler->userCanTrashRegistrations()) {
+			$this->_views['incomplete']['count'] = $this->_total_registrations('incomplete');
+			$this->_views['trash']['count']      = $this->_total_registrations('trash');
+		}
+	}
+
+
+	/**
+	 * @param string $view
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _total_registrations(string $view = ''): int
+	{
+		$_where = [];
+		$EVT_ID = isset($this->_req_data['event_id'])
+			? absint($this->_req_data['event_id'])
+			: false;
+		if ($EVT_ID) {
+			$_where['EVT_ID'] = $EVT_ID;
+		}
+		switch ($view) {
+			case 'trash':
+				return EEM_Registration::instance()->count_deleted([$_where]);
+			case 'incomplete':
+				$_where['STS_ID'] = EEM_Registration::status_id_incomplete;
+				break;
+			default:
+				$_where['STS_ID'] = ['!=', EEM_Registration::status_id_incomplete];
+		}
+		return EEM_Registration::instance()->count([$_where]);
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _total_registrations_this_month(): int
+	{
+		$EVT_ID          = isset($this->_req_data['event_id'])
+			? absint($this->_req_data['event_id'])
+			: false;
+		$_where          = $EVT_ID
+			? ['EVT_ID' => $EVT_ID]
+			: [];
+		$this_year_r     = date('Y', current_time('timestamp'));
+		$time_start      = ' 00:00:00';
+		$time_end        = ' 23:59:59';
+		$this_month_r    = date('m', current_time('timestamp'));
+		$days_this_month = date('t', current_time('timestamp'));
+		// setup date query.
+		$beginning_string   = EEM_Registration::instance()->convert_datetime_for_query(
+			'REG_date',
+			$this_year_r . '-' . $this_month_r . '-01' . $time_start,
+			'Y-m-d H:i:s'
+		);
+		$end_string         = EEM_Registration::instance()->convert_datetime_for_query(
+			'REG_date',
+			$this_year_r . '-' . $this_month_r . '-' . $days_this_month . $time_end,
+			'Y-m-d H:i:s'
+		);
+		$_where['REG_date'] = [
+			'BETWEEN',
+			[
+				$beginning_string,
+				$end_string,
+			],
+		];
+		$_where['STS_ID']   = ['!=', EEM_Registration::status_id_incomplete];
+		return EEM_Registration::instance()->count([$_where]);
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _total_registrations_today(): int
+	{
+		$EVT_ID             = isset($this->_req_data['event_id'])
+			? absint($this->_req_data['event_id'])
+			: false;
+		$_where             = $EVT_ID
+			? ['EVT_ID' => $EVT_ID]
+			: [];
+		$current_date       = date('Y-m-d', current_time('timestamp'));
+		$time_start         = ' 00:00:00';
+		$time_end           = ' 23:59:59';
+		$_where['REG_date'] = [
+			'BETWEEN',
+			[
+				EEM_Registration::instance()->convert_datetime_for_query(
+					'REG_date',
+					$current_date . $time_start,
+					'Y-m-d H:i:s'
+				),
+				EEM_Registration::instance()->convert_datetime_for_query(
+					'REG_date',
+					$current_date . $time_end,
+					'Y-m-d H:i:s'
+				),
+			],
+		];
+		$_where['STS_ID']   = ['!=', EEM_Registration::status_id_incomplete];
+		return EEM_Registration::instance()->count([$_where]);
+	}
+
+
+	/**
+	 * @param EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_cb($item): string
+	{
+		/** checkbox/lock **/
+		$REG_ID        = $item->ID();
+		$transaction   = $item->get_first_related('Transaction');
+		$payment_count = $transaction instanceof EE_Transaction
+			? $transaction->count_related('Payment')
+			: 0;
+
+		$content = '<input type="checkbox" name="_REG_ID[]" value="' . $REG_ID . '" />';
+		$content .= $payment_count > 0 || ! $this->caps_handler->userCanEditRegistration($item)
+			? '<span class="ee-locked-entity dashicons dashicons-lock ee-aria-tooltip ee-aria-tooltip--big-box"
                     aria-label="' . $this->lockedRegMessage() . '"></span>'
-            : '';
-        return $this->columnContent('cb', $content, 'center');
-    }
-
-
-    private function lockedRegMessage(): string
-    {
-        return esc_html__(
-            'This lock-icon means that this registration cannot be trashed.  Registrations that belong to a transaction that has payments cannot be trashed.  If you wish to trash this registration then you must delete all payments attached to the related transaction first.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_id(EE_Registration $registration): string
-    {
-        $content = '<span class="ee-entity-id">' . $registration->ID() . '</span>';
-        $content .= '<span class="show-on-mobile-view-only">';
-        $content .= $this->column_ATT_fname($registration, false);
-        $content .= '</span>';
-
-        return $this->columnContent('id', $content, 'end');
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param bool            $prep_content
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_ATT_fname(EE_Registration $registration, bool $prep_content = true): string
-    {
-
-        $status         = esc_attr($registration->status_ID());
-        $pretty_status  = EEH_Template::pretty_status($status, false, 'sentence');
-        $prime_reg_star = $registration->count() === 1
-            ? '<sup><span class="dashicons dashicons-star-filled gold-icon"></span></sup>'
-            : '';
-
-        $group_count = '
+			: '';
+		return $this->columnContent('cb', $content, 'center');
+	}
+
+
+	private function lockedRegMessage(): string
+	{
+		return esc_html__(
+			'This lock-icon means that this registration cannot be trashed.  Registrations that belong to a transaction that has payments cannot be trashed.  If you wish to trash this registration then you must delete all payments attached to the related transaction first.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_id(EE_Registration $registration): string
+	{
+		$content = '<span class="ee-entity-id">' . $registration->ID() . '</span>';
+		$content .= '<span class="show-on-mobile-view-only">';
+		$content .= $this->column_ATT_fname($registration, false);
+		$content .= '</span>';
+
+		return $this->columnContent('id', $content, 'end');
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param bool            $prep_content
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_ATT_fname(EE_Registration $registration, bool $prep_content = true): string
+	{
+
+		$status         = esc_attr($registration->status_ID());
+		$pretty_status  = EEH_Template::pretty_status($status, false, 'sentence');
+		$prime_reg_star = $registration->count() === 1
+			? '<sup><span class="dashicons dashicons-star-filled gold-icon"></span></sup>'
+			: '';
+
+		$group_count = '
             <span class="reg-count-group-size" >
                 ' . sprintf(
-            esc_html__('(%1$s / %2$s)', 'event_espresso'),
-            $registration->count(),
-            $registration->group_size()
-        ) . '
+			esc_html__('(%1$s / %2$s)', 'event_espresso'),
+			$registration->count(),
+			$registration->group_size()
+		) . '
             </span >';
 
-        $content = '
+		$content = '
         <div class="ee-layout-row">
             <span aria-label="' . $pretty_status . '"
                   class="ee-status-dot ee-status-bg--' . $status . ' ee-aria-tooltip"
             ></span>
             ' . $this->viewRegistrationLink($registration, $status)
-                   . $prime_reg_star
-                   . $group_count . '
+				   . $prime_reg_star
+				   . $group_count . '
             <span class="spacer"></span>
             <span>
                 ' . sprintf(
-                       esc_html__('Reg Code: %s', 'event_espresso'),
-                       $registration->get('REG_code')
-                   ) . '
+					   esc_html__('Reg Code: %s', 'event_espresso'),
+					   $registration->get('REG_code')
+				   ) . '
             </span>
         </div>';
 
-        $url_params = ['_REG_ID' => $registration->ID()];
-        if (isset($this->_req_data['event_id'])) {
-            $url_params['event_id'] = $registration->event_ID();
-        }
-        // trash/restore/delete actions
-        $actions = $this->trashRegistrationLink($registration, $url_params);
-        $actions = $this->restoreRegistrationLink($registration, $url_params, $actions);
-        $actions = $this->deleteRegistrationLink($registration, $url_params, $actions);
-
-        $content = sprintf('%1$s %2$s', $content, $this->row_actions($actions));
-
-        return $prep_content ? $this->columnContent('ATT_fname', $content) : $content;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param bool            $prep_content
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column__REG_date(EE_Registration $registration, bool $prep_content = true): string
-    {
-        $this->_set_related_details($registration);
-        // Build row actions
-        $content = $this->caps_handler->userCanViewTransaction()
-            ? '<a class="ee-aria-tooltip ee-status-color--' . $this->_transaction_details['status'] . '" href="'
-              . $this->viewTransactionUrl()
-              . '" aria-label="'
-              . esc_attr($this->_transaction_details['title_attr'])
-              . '">'
-              . $registration->get_i18n_datetime('REG_date', 'M jS Y g:i a')
-              . '</a>'
-            : $registration->get_i18n_datetime('REG_date');
-
-        return $prep_content ? $this->columnContent('_REG_date', $content) : $content;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_event_name(EE_Registration $registration): string
-    {
-        $this->_set_related_details($registration);
-        $EVT_ID     = $registration->event_ID();
-        $event_name = $registration->event_name();
-        $event_name = $event_name ?: esc_html__("No Associated Event", 'event_espresso');
-        $event_name = wp_trim_words($event_name, 30, '...');
-        $edit_event = $this->editEventLink($EVT_ID, $event_name);
-        $actions['event_filter'] = $this->eventFilterLink($EVT_ID, $event_name);
-        $content = sprintf('%1$s %2$s', $edit_event, $this->row_actions($actions));
-
-        return $this->columnContent('event_name', $content);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_DTT_EVT_start(EE_Registration $registration): string
-    {
-        $datetime_strings = [];
-        $ticket           = $registration->ticket();
-        if ($ticket instanceof EE_Ticket) {
-            $remove_defaults = ['default_where_conditions' => 'none'];
-            $datetimes       = $ticket->datetimes($remove_defaults);
-            foreach ($datetimes as $datetime) {
-                $datetime_strings[] = $datetime->get_i18n_datetime('DTT_EVT_start', 'M jS Y g:i a');
-            }
-            $content = $this->generateDisplayForDatetimes($datetime_strings);
-        } else {
-            $content = esc_html__('There is no ticket on this registration', 'event_espresso');
-        }
-        return $this->columnContent('DTT_EVT_start', $content);
-    }
-
-
-    /**
-     * Receives an array of datetime strings to display and converts them to the html container for the column.
-     *
-     * @param array $datetime_strings
-     * @return string
-     */
-    public function generateDisplayForDatetimes(array $datetime_strings): string
-    {
-        // get first item for initial visibility
-        $content = (string) array_shift($datetime_strings);
-        if (! empty($datetime_strings)) {
-            $content .= '
+		$url_params = ['_REG_ID' => $registration->ID()];
+		if (isset($this->_req_data['event_id'])) {
+			$url_params['event_id'] = $registration->event_ID();
+		}
+		// trash/restore/delete actions
+		$actions = $this->trashRegistrationLink($registration, $url_params);
+		$actions = $this->restoreRegistrationLink($registration, $url_params, $actions);
+		$actions = $this->deleteRegistrationLink($registration, $url_params, $actions);
+
+		$content = sprintf('%1$s %2$s', $content, $this->row_actions($actions));
+
+		return $prep_content ? $this->columnContent('ATT_fname', $content) : $content;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param bool            $prep_content
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column__REG_date(EE_Registration $registration, bool $prep_content = true): string
+	{
+		$this->_set_related_details($registration);
+		// Build row actions
+		$content = $this->caps_handler->userCanViewTransaction()
+			? '<a class="ee-aria-tooltip ee-status-color--' . $this->_transaction_details['status'] . '" href="'
+			  . $this->viewTransactionUrl()
+			  . '" aria-label="'
+			  . esc_attr($this->_transaction_details['title_attr'])
+			  . '">'
+			  . $registration->get_i18n_datetime('REG_date', 'M jS Y g:i a')
+			  . '</a>'
+			: $registration->get_i18n_datetime('REG_date');
+
+		return $prep_content ? $this->columnContent('_REG_date', $content) : $content;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_event_name(EE_Registration $registration): string
+	{
+		$this->_set_related_details($registration);
+		$EVT_ID     = $registration->event_ID();
+		$event_name = $registration->event_name();
+		$event_name = $event_name ?: esc_html__("No Associated Event", 'event_espresso');
+		$event_name = wp_trim_words($event_name, 30, '...');
+		$edit_event = $this->editEventLink($EVT_ID, $event_name);
+		$actions['event_filter'] = $this->eventFilterLink($EVT_ID, $event_name);
+		$content = sprintf('%1$s %2$s', $edit_event, $this->row_actions($actions));
+
+		return $this->columnContent('event_name', $content);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_DTT_EVT_start(EE_Registration $registration): string
+	{
+		$datetime_strings = [];
+		$ticket           = $registration->ticket();
+		if ($ticket instanceof EE_Ticket) {
+			$remove_defaults = ['default_where_conditions' => 'none'];
+			$datetimes       = $ticket->datetimes($remove_defaults);
+			foreach ($datetimes as $datetime) {
+				$datetime_strings[] = $datetime->get_i18n_datetime('DTT_EVT_start', 'M jS Y g:i a');
+			}
+			$content = $this->generateDisplayForDatetimes($datetime_strings);
+		} else {
+			$content = esc_html__('There is no ticket on this registration', 'event_espresso');
+		}
+		return $this->columnContent('DTT_EVT_start', $content);
+	}
+
+
+	/**
+	 * Receives an array of datetime strings to display and converts them to the html container for the column.
+	 *
+	 * @param array $datetime_strings
+	 * @return string
+	 */
+	public function generateDisplayForDatetimes(array $datetime_strings): string
+	{
+		// get first item for initial visibility
+		$content = (string) array_shift($datetime_strings);
+		if (! empty($datetime_strings)) {
+			$content .= '
                 <div class="ee-registration-event-datetimes-container-wrap">
                     <button aria-label="' . esc_attr__('Click to view all dates', 'event_espresso') . '"
                           class="ee-aria-tooltip button button--secondary button--tiny button--icon-only ee-js ee-more-datetimes-toggle"
@@ -593,539 +593,539 @@ 
                         ' . implode("", $datetime_strings) . '
                     </div>
                 </div>';
-        }
-        return $content;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_ATT_email(EE_Registration $registration): string
-    {
-        $attendee = $registration->get_first_related('Attendee');
-        $content  = ! $attendee instanceof EE_Attendee
-            ? esc_html__('No attached contact record.', 'event_espresso')
-            : $attendee->email();
-        return $this->columnContent('ATT_email', $content);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     */
-    public function column__REG_count(EE_Registration $registration): string
-    {
-        $content =
-            sprintf(esc_html__('%1$s / %2$s', 'event_espresso'), $registration->count(), $registration->group_size());
-        return $this->columnContent('_REG_count', $content);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_PRC_amount(EE_Registration $registration): string
-    {
-        $ticket   = $registration->ticket();
-        $req_data = $this->_admin_page->get_request_data();
-
-        $content = isset($req_data['event_id']) && $ticket instanceof EE_Ticket
-            ? '<div class="TKT_name">' . $ticket->name() . '</div>'
-            : '';
-
-        $payment_status = $registration->owes_monies_and_can_pay() ? 'TFL' : 'TCM';
-        $content        .= $registration->final_price() > 0
-            ? '<span class="reg-overview-paid-event-spn ee-status-color--' . $payment_status . '">
+		}
+		return $content;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_ATT_email(EE_Registration $registration): string
+	{
+		$attendee = $registration->get_first_related('Attendee');
+		$content  = ! $attendee instanceof EE_Attendee
+			? esc_html__('No attached contact record.', 'event_espresso')
+			: $attendee->email();
+		return $this->columnContent('ATT_email', $content);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 */
+	public function column__REG_count(EE_Registration $registration): string
+	{
+		$content =
+			sprintf(esc_html__('%1$s / %2$s', 'event_espresso'), $registration->count(), $registration->group_size());
+		return $this->columnContent('_REG_count', $content);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_PRC_amount(EE_Registration $registration): string
+	{
+		$ticket   = $registration->ticket();
+		$req_data = $this->_admin_page->get_request_data();
+
+		$content = isset($req_data['event_id']) && $ticket instanceof EE_Ticket
+			? '<div class="TKT_name">' . $ticket->name() . '</div>'
+			: '';
+
+		$payment_status = $registration->owes_monies_and_can_pay() ? 'TFL' : 'TCM';
+		$content        .= $registration->final_price() > 0
+			? '<span class="reg-overview-paid-event-spn ee-status-color--' . $payment_status . '">
                 ' . $registration->pretty_final_price() . '
                </span>'
-            // free event
-            : '<span class="reg-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
-
-        return $this->columnContent('PRC_amount', $content, 'end');
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column__REG_final_price(EE_Registration $registration): string
-    {
-        $ticket   = $registration->ticket();
-        $req_data = $this->_admin_page->get_request_data();
-        $content  = isset($req_data['event_id']) || ! $ticket instanceof EE_Ticket
-            ? ''
-            : '<span class="TKT_name ee-status-color--'
-              . $ticket->ticket_status()
-              . '">'
-              . $ticket->name()
-              . '</span> ';
-
-        $content .= '
+			// free event
+			: '<span class="reg-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
+
+		return $this->columnContent('PRC_amount', $content, 'end');
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column__REG_final_price(EE_Registration $registration): string
+	{
+		$ticket   = $registration->ticket();
+		$req_data = $this->_admin_page->get_request_data();
+		$content  = isset($req_data['event_id']) || ! $ticket instanceof EE_Ticket
+			? ''
+			: '<span class="TKT_name ee-status-color--'
+			  . $ticket->ticket_status()
+			  . '">'
+			  . $ticket->name()
+			  . '</span> ';
+
+		$content .= '
             <span class="reg-overview-paid-event-spn">
                 ' . $registration->pretty_final_price() . '
             </span>';
-        return $this->columnContent('_REG_final_price', $content, 'end');
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     */
-    public function column__REG_paid(EE_Registration $registration): string
-    {
-        $payment_method      = $registration->payment_method();
-        $payment_method_name = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-
-        $payment_status = $registration->owes_monies_and_can_pay() ? 'TFL' : 'TCM';
-        $content        = '
+		return $this->columnContent('_REG_final_price', $content, 'end');
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column__REG_paid(EE_Registration $registration): string
+	{
+		$payment_method      = $registration->payment_method();
+		$payment_method_name = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+
+		$payment_status = $registration->owes_monies_and_can_pay() ? 'TFL' : 'TCM';
+		$content        = '
             <span class="reg-overview-paid-event-spn ee-status-color--' . $payment_status . '">
                 ' . $registration->pretty_paid() . '
             </span>';
-        if ($registration->paid() > 0) {
-            $content .= '<span class="ee-status-text-small">'
-                        . sprintf(
-                            esc_html__('...via %s', 'event_espresso'),
-                            $payment_method_name
-                        )
-                        . '</span>';
-        }
-        return $this->columnContent('_REG_paid', $content, 'end');
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_TXN_total(EE_Registration $registration): string
-    {
-        if ($registration->transaction()) {
-            $content = $this->caps_handler->userCanViewTransaction()
-                ? '
+		if ($registration->paid() > 0) {
+			$content .= '<span class="ee-status-text-small">'
+						. sprintf(
+							esc_html__('...via %s', 'event_espresso'),
+							$payment_method_name
+						)
+						. '</span>';
+		}
+		return $this->columnContent('_REG_paid', $content, 'end');
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_TXN_total(EE_Registration $registration): string
+	{
+		if ($registration->transaction()) {
+			$content = $this->caps_handler->userCanViewTransaction()
+				? '
                     <a class="ee-aria-tooltip ee-status-color--' . $registration->transaction()->status_ID() . '"
                         href="' . $this->viewTransactionUrl() . '"
                         aria-label="' . esc_attr__('View Transaction', 'event_espresso') . '"
                     >
                         ' . $registration->transaction()->pretty_total() . '
                     </a>'
-                : $registration->transaction()->pretty_total();
-        } else {
-            $content = esc_html__("None", "event_espresso");
-        }
-        return $this->columnContent('TXN_total', $content, 'end');
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_TXN_paid(EE_Registration $registration): string
-    {
-        $content = '&nbsp;';
-        $align   = 'end';
-        if ($registration->count() === 1) {
-            $transaction = $registration->transaction()
-                ? $registration->transaction()
-                : EE_Transaction::new_instance();
-            if ($transaction->paid() >= $transaction->total()) {
-                $align   = 'center';
-                $content = '<span class="dashicons dashicons-yes green-icon"></span>';
-            } else {
-                $content = $this->caps_handler->userCanViewTransaction()
-                    ? '
+				: $registration->transaction()->pretty_total();
+		} else {
+			$content = esc_html__("None", "event_espresso");
+		}
+		return $this->columnContent('TXN_total', $content, 'end');
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_TXN_paid(EE_Registration $registration): string
+	{
+		$content = '&nbsp;';
+		$align   = 'end';
+		if ($registration->count() === 1) {
+			$transaction = $registration->transaction()
+				? $registration->transaction()
+				: EE_Transaction::new_instance();
+			if ($transaction->paid() >= $transaction->total()) {
+				$align   = 'center';
+				$content = '<span class="dashicons dashicons-yes green-icon"></span>';
+			} else {
+				$content = $this->caps_handler->userCanViewTransaction()
+					? '
                     <a class="ee-aria-tooltip ee-status-color--' . $transaction->status_ID() . '"
                         href="' . $this->viewTransactionUrl() . '"
                         aria-label="' . esc_attr__('View Transaction', 'event_espresso') . '"
                     >
                         ' . $registration->transaction()->pretty_paid() . '
                     </a>'
-                    : $registration->transaction()->pretty_paid();
-            }
-        }
-        return $this->columnContent('TXN_paid', $content, $align);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_actions(EE_Registration $registration): string
-    {
-        $attendee = $registration->attendee();
-        $this->_set_related_details($registration);
-
-        // Build and filter row actions
-        $actions = apply_filters(
-            'FHEE__EE_Registrations_List_Table__column_actions__actions',
-            [
-                'view_lnk'               => $this->viewRegistrationAction($registration),
-                'edit_lnk'               => $this->editContactAction($registration, $attendee),
-                'resend_reg_lnk'         => $this->resendRegistrationMessageAction($registration, $attendee),
-                'view_txn_lnk'           => $this->viewTransactionAction(),
-                'dl_invoice_lnk'         => $this->viewTransactionInvoiceAction($registration, $attendee),
-                'filtered_messages_link' => $this->viewNotificationsAction($registration),
-            ],
-            $registration,
-            $this
-        );
-
-        $content = $this->_action_string(
-            implode('', $actions),
-            $registration,
-            'div',
-            'reg-overview-actions ee-list-table-actions'
-        );
-
-        return $this->columnContent('actions', $this->actionsModalMenu($content));
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function viewRegistrationUrl(EE_Registration $registration): string
-    {
-        return EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'  => 'view_registration',
-                '_REG_ID' => $registration->ID(),
-            ],
-            REG_ADMIN_URL
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function viewRegistrationLink(
-        EE_Registration $registration,
-        string $status
-    ): string {
-        $attendee      = $registration->attendee();
-        $attendee_name = $attendee instanceof EE_Attendee
-            ? $attendee->full_name()
-            : '';
-        return $this->caps_handler->userCanReadRegistration($registration)
-            ? '
+					: $registration->transaction()->pretty_paid();
+			}
+		}
+		return $this->columnContent('TXN_paid', $content, $align);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_actions(EE_Registration $registration): string
+	{
+		$attendee = $registration->attendee();
+		$this->_set_related_details($registration);
+
+		// Build and filter row actions
+		$actions = apply_filters(
+			'FHEE__EE_Registrations_List_Table__column_actions__actions',
+			[
+				'view_lnk'               => $this->viewRegistrationAction($registration),
+				'edit_lnk'               => $this->editContactAction($registration, $attendee),
+				'resend_reg_lnk'         => $this->resendRegistrationMessageAction($registration, $attendee),
+				'view_txn_lnk'           => $this->viewTransactionAction(),
+				'dl_invoice_lnk'         => $this->viewTransactionInvoiceAction($registration, $attendee),
+				'filtered_messages_link' => $this->viewNotificationsAction($registration),
+			],
+			$registration,
+			$this
+		);
+
+		$content = $this->_action_string(
+			implode('', $actions),
+			$registration,
+			'div',
+			'reg-overview-actions ee-list-table-actions'
+		);
+
+		return $this->columnContent('actions', $this->actionsModalMenu($content));
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function viewRegistrationUrl(EE_Registration $registration): string
+	{
+		return EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'  => 'view_registration',
+				'_REG_ID' => $registration->ID(),
+			],
+			REG_ADMIN_URL
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function viewRegistrationLink(
+		EE_Registration $registration,
+		string $status
+	): string {
+		$attendee      = $registration->attendee();
+		$attendee_name = $attendee instanceof EE_Attendee
+			? $attendee->full_name()
+			: '';
+		return $this->caps_handler->userCanReadRegistration($registration)
+			? '
             <a  href="' . $this->viewRegistrationUrl($registration) . '"
                 class="row-title ee-status-color--' . $status . ' ee-aria-tooltip"
                 aria-label="' . esc_attr__('View Registration Details', 'event_espresso') . '"
             >
                 ' . $attendee_name . '
             </a>'
-            : $attendee_name;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function viewRegistrationAction(EE_Registration $registration): string
-    {
-        return $this->caps_handler->userCanReadRegistration($registration)
-            ? '
+			: $attendee_name;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function viewRegistrationAction(EE_Registration $registration): string
+	{
+		return $this->caps_handler->userCanReadRegistration($registration)
+			? '
             <a  href="' . $this->viewRegistrationUrl($registration) . '"
                 class="ee-aria-tooltip button button--icon-only"
                 aria-label="' . esc_attr__('View Registration Details', 'event_espresso') . '"
             >
                 <span class="dashicons dashicons-clipboard"></span>
             </a>'
-            : '';
-    }
-
-
-    private function editContactAction(EE_Registration $registration, ?EE_Attendee $attendee = null): string
-    {
-
-        if ($attendee instanceof EE_Attendee && $this->caps_handler->userCanEditContacts()) {
-            $edit_link_url = EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action' => 'edit_attendee',
-                    'post'   => $registration->attendee_ID(),
-                ],
-                REG_ADMIN_URL
-            );
-            return '
+			: '';
+	}
+
+
+	private function editContactAction(EE_Registration $registration, ?EE_Attendee $attendee = null): string
+	{
+
+		if ($attendee instanceof EE_Attendee && $this->caps_handler->userCanEditContacts()) {
+			$edit_link_url = EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action' => 'edit_attendee',
+					'post'   => $registration->attendee_ID(),
+				],
+				REG_ADMIN_URL
+			);
+			return '
                 <a href="' . $edit_link_url . '"
                    aria-label="' . esc_attr__('Edit Contact Details', 'event_espresso') . '"
                    class="ee-aria-tooltip button button--secondary button--icon-only"
                 >
                     <span class="dashicons dashicons-admin-users"></span>
                 </a>';
-        }
-        return '';
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function resendRegistrationMessageAction(
-        EE_Registration $registration,
-        ?EE_Attendee $attendee = null
-    ): string {
-        if ($attendee instanceof EE_Attendee && $this->caps_handler->userCanResendMessage($registration)) {
-            $resend_reg_link_url = EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action'  => 'resend_registration',
-                    '_REG_ID' => $registration->ID(),
-                ],
-                REG_ADMIN_URL,
-                true
-            );
-            return '
+		}
+		return '';
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function resendRegistrationMessageAction(
+		EE_Registration $registration,
+		?EE_Attendee $attendee = null
+	): string {
+		if ($attendee instanceof EE_Attendee && $this->caps_handler->userCanResendMessage($registration)) {
+			$resend_reg_link_url = EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action'  => 'resend_registration',
+					'_REG_ID' => $registration->ID(),
+				],
+				REG_ADMIN_URL,
+				true
+			);
+			return '
 			    <a href="' . $resend_reg_link_url . '" aria-label="'
-                                         . esc_attr__('Resend Registration Details', 'event_espresso')
-                                         . '" class="ee-aria-tooltip button button--icon-only">
+										 . esc_attr__('Resend Registration Details', 'event_espresso')
+										 . '" class="ee-aria-tooltip button button--icon-only">
 			        <span class="dashicons dashicons-email-alt"></span>
 			    </a>';
-        }
-        return '';
-    }
-
-
-    private function viewTransactionUrl(): string
-    {
-        return EE_Admin_Page::add_query_args_and_nonce(
-            [
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $this->_transaction_details['id'],
-                ],
-            TXN_ADMIN_URL
-        );
-    }
-
-
-    private function viewTransactionAction(): string
-    {
-        if ($this->caps_handler->userCanViewTransaction()) {
-            return '
+		}
+		return '';
+	}
+
+
+	private function viewTransactionUrl(): string
+	{
+		return EE_Admin_Page::add_query_args_and_nonce(
+			[
+					'action' => 'view_transaction',
+					'TXN_ID' => $this->_transaction_details['id'],
+				],
+			TXN_ADMIN_URL
+		);
+	}
+
+
+	private function viewTransactionAction(): string
+	{
+		if ($this->caps_handler->userCanViewTransaction()) {
+			return '
                 <a class="ee-aria-tooltip button button--icon-only"
                    href="' . $this->viewTransactionUrl() . '"
                    aria-label="' . $this->_transaction_details['title_attr'] . '"
                 >
                     <span class="dashicons dashicons-cart"></span>
                 </a>';
-        }
-        return '';
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function viewTransactionInvoiceAction(
-        EE_Registration $registration,
-        ?EE_Attendee $attendee = null
-    ): string {
-        // only show invoice link if message type is active.
-        if (
-            $attendee instanceof EE_Attendee
-            && $registration->is_primary_registrant()
-            && EEH_MSG_Template::is_mt_active('invoice')
-        ) {
-            return '
+		}
+		return '';
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function viewTransactionInvoiceAction(
+		EE_Registration $registration,
+		?EE_Attendee $attendee = null
+	): string {
+		// only show invoice link if message type is active.
+		if (
+			$attendee instanceof EE_Attendee
+			&& $registration->is_primary_registrant()
+			&& EEH_MSG_Template::is_mt_active('invoice')
+		) {
+			return '
                 <a aria-label="' . esc_attr__('View Transaction Invoice', 'event_espresso')
-                                         . '" target="_blank" href="' . $registration->invoice_url() . '" class="ee-aria-tooltip button button--icon-only">
+										 . '" target="_blank" href="' . $registration->invoice_url() . '" class="ee-aria-tooltip button button--icon-only">
                     <span class="dashicons dashicons-media-spreadsheet"></span>
                 </a>';
-        }
-        return '';
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    private function viewNotificationsAction(EE_Registration $registration): string
-    {
-        // message list table link (filtered by REG_ID
-        return $this->caps_handler->userCanReadGlobalMessages()
-            ? EEH_MSG_Template::get_message_action_link(
-                'see_notifications_for',
-                null,
-                ['_REG_ID' => $registration->ID()]
-            )
-            : '';
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function trashRegistrationLink(
-        EE_Registration $registration,
-        array $url_params
-    ): array {
-        $actions = [];
-        // can't trash what's already trashed
-        if ($this->_view === 'trash') {
-            return $actions;
-        }
-
-        // check caps
-        if (! $this->caps_handler->userCanTrashRegistration($registration)) {
-            return $actions;
-        }
-
-        // don't delete registrations that have payments applied
-        $transaction   = $registration->get_first_related('Transaction');
-        $payment_count = $transaction instanceof EE_Transaction
-            ? $transaction->count_related('Payment')
-            : 0;
-
-        if ($payment_count > 0) {
-            return $actions;
-        }
-
-        $url_params['action'] = 'trash_registrations';
-        $trash_link_url       = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
-        $actions['trash']     = '
+		}
+		return '';
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	private function viewNotificationsAction(EE_Registration $registration): string
+	{
+		// message list table link (filtered by REG_ID
+		return $this->caps_handler->userCanReadGlobalMessages()
+			? EEH_MSG_Template::get_message_action_link(
+				'see_notifications_for',
+				null,
+				['_REG_ID' => $registration->ID()]
+			)
+			: '';
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function trashRegistrationLink(
+		EE_Registration $registration,
+		array $url_params
+	): array {
+		$actions = [];
+		// can't trash what's already trashed
+		if ($this->_view === 'trash') {
+			return $actions;
+		}
+
+		// check caps
+		if (! $this->caps_handler->userCanTrashRegistration($registration)) {
+			return $actions;
+		}
+
+		// don't delete registrations that have payments applied
+		$transaction   = $registration->get_first_related('Transaction');
+		$payment_count = $transaction instanceof EE_Transaction
+			? $transaction->count_related('Payment')
+			: 0;
+
+		if ($payment_count > 0) {
+			return $actions;
+		}
+
+		$url_params['action'] = 'trash_registrations';
+		$trash_link_url       = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
+		$actions['trash']     = '
             <a class="ee-aria-tooltip"
                 href="' . $trash_link_url . '"
                 aria-label="' . esc_attr__('Trash Registration', 'event_espresso') . '"
             >
                 ' . esc_html__('Trash', 'event_espresso') . '
             </a>';
-        return $actions;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function restoreRegistrationLink(
-        EE_Registration $registration,
-        array $url_params,
-        array $actions
-    ): array {
-        // can't restore what's not trashed
-        if ($this->_view !== 'trash') {
-            return $actions;
-        }
-
-        // restore registration link
-        if ($this->caps_handler->userCanRestoreRegistration($registration)) {
-            $url_params['action'] = 'restore_registrations';
-            $restore_link_url     = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
-            $actions['restore']   = '
+		return $actions;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function restoreRegistrationLink(
+		EE_Registration $registration,
+		array $url_params,
+		array $actions
+	): array {
+		// can't restore what's not trashed
+		if ($this->_view !== 'trash') {
+			return $actions;
+		}
+
+		// restore registration link
+		if ($this->caps_handler->userCanRestoreRegistration($registration)) {
+			$url_params['action'] = 'restore_registrations';
+			$restore_link_url     = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
+			$actions['restore']   = '
                 <a class="ee-aria-tooltip"
                     href="' . $restore_link_url . '"
                     aria-label="' . esc_attr__('Restore Registration', 'event_espresso') . '"
                 >
                     ' . esc_html__('Restore', 'event_espresso') . '
                 </a>';
-        }
-
-        return $actions;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function deleteRegistrationLink(
-        EE_Registration $registration,
-        array $url_params,
-        array $actions
-    ): array {
-        if ($this->_view === 'trash' && $this->caps_handler->userCanDeleteRegistration($registration)) {
-            $url_params['action'] = 'delete_registrations';
-            $delete_link_url      = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
-            $actions['delete']    = '
+		}
+
+		return $actions;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function deleteRegistrationLink(
+		EE_Registration $registration,
+		array $url_params,
+		array $actions
+	): array {
+		if ($this->_view === 'trash' && $this->caps_handler->userCanDeleteRegistration($registration)) {
+			$url_params['action'] = 'delete_registrations';
+			$delete_link_url      = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
+			$actions['delete']    = '
                 <a class="ee-aria-tooltip"
                     href="' . $delete_link_url . '"
                     aria-label="' . esc_attr__('Delete Registration Permanently', 'event_espresso') . '"
                 >
                     ' . esc_html__('Delete', 'event_espresso') . '
                 </a>';
-        }
-        return $actions;
-    }
-
-
-    private function editEventLink(int $EVT_ID, string $event_name): string
-    {
-        if (! $EVT_ID || ! $this->caps_handler->userCanEditEvent($EVT_ID)) {
-            return $event_name;
-        }
-        $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'edit', 'post' => $EVT_ID],
-            EVENTS_ADMIN_URL
-        );
-        return '
+		}
+		return $actions;
+	}
+
+
+	private function editEventLink(int $EVT_ID, string $event_name): string
+	{
+		if (! $EVT_ID || ! $this->caps_handler->userCanEditEvent($EVT_ID)) {
+			return $event_name;
+		}
+		$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'edit', 'post' => $EVT_ID],
+			EVENTS_ADMIN_URL
+		);
+		return '
             <a class="ee-aria-tooltip ee-status-color--' . $this->_event_details['status'] . '"
                 href="' . $edit_event_url . '"
                 aria-label="' . esc_attr($this->_event_details['title_attr']) . '"
             >
                 ' . $event_name . '
             </a>';
-    }
+	}
 
 
-    private function eventFilterLink(int $EVT_ID, string $event_name): string
-    {
-        if (!$EVT_ID) {
-            return '';
-        }
-        $event_filter_url = EE_Admin_Page::add_query_args_and_nonce(['event_id' => $EVT_ID], REG_ADMIN_URL);
-        return '
+	private function eventFilterLink(int $EVT_ID, string $event_name): string
+	{
+		if (!$EVT_ID) {
+			return '';
+		}
+		$event_filter_url = EE_Admin_Page::add_query_args_and_nonce(['event_id' => $EVT_ID], REG_ADMIN_URL);
+		return '
             <a  class="ee-aria-tooltip ee-event-filter-link"
                 href="' . $event_filter_url . '"
                 aria-label="' . sprintf(
-                    esc_attr__('Filter this list to only show registrations for %s', 'event_espresso'),
-                    $event_name
-                ) . '"
+					esc_attr__('Filter this list to only show registrations for %s', 'event_espresso'),
+					$event_name
+				) . '"
             >
                 <span class="dashicons dashicons-groups dashicons--small"></span>'
-                . esc_html__('View Registrations', 'event_espresso') . '
+				. esc_html__('View Registrations', 'event_espresso') . '
             </a>';
-    }
+	}
 }

Spacing +76 added lines, -76 removed lines

@@ -54,10 +54,10 @@ 
     {
         $this->caps_handler = new RegistrationsListTableUserCapabilities(EE_Registry::instance()->CAP);
         $req_data = $admin_page->get_request_data();
-        if (! empty($req_data['event_id'])) {
+        if ( ! empty($req_data['event_id'])) {
             $extra_query_args = [];
             foreach ($admin_page->get_views() as $view_details) {
-                $extra_query_args[ $view_details['slug'] ] = ['event_id' => $req_data['event_id']];
+                $extra_query_args[$view_details['slug']] = ['event_id' => $req_data['event_id']];
             }
             $this->_views = $admin_page->get_list_table_view_RLs($extra_query_args);
         }
@@ -99,7 +99,7 @@ 
         $DTT_ID = (int) $DTT_ID;
 
         if ($EVT_ID) {
-            $this->_columns        = [
+            $this->_columns = [
                 'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
                 'id'               => esc_html__('ID', 'event_espresso'),
                 'ATT_fname'        => esc_html__('Name', 'event_espresso'),
@@ -112,7 +112,7 @@ 
                 'actions'          => $this->actionsColumnHeader(),
             ];
         } else {
-            $this->_columns        = [
+            $this->_columns = [
                 'cb'               => '<input type="checkbox" />', // Render a checkbox instead of text
                 'id'               => esc_html__('ID', 'event_espresso'),
                 'ATT_fname'        => esc_html__('Name', 'event_espresso'),
@@ -126,13 +126,13 @@ 
         }
 
         $csv_report = RegistrationsCsvReportParams::getRequestParams($return_url, $req_data, $EVT_ID, $DTT_ID);
-        if (! empty($csv_report)) {
+        if ( ! empty($csv_report)) {
             $this->_bottom_buttons['csv_reg_report'] = $csv_report;
         }
 
         $this->_primary_column   = 'id';
         $this->_sortable_columns = [
-            '_REG_date'     => ['_REG_date' => true],   // true means its already sorted
+            '_REG_date'     => ['_REG_date' => true], // true means its already sorted
             /**
              * Allows users to change the default sort if they wish.
              * Returning a falsey on this filter will result in the default sort to be by firstname rather than last
@@ -149,7 +149,7 @@ 
             'DTT_EVT_start' => ['DTT_EVT_start' => false],
             'id'            => ['REG_ID' => false],
         ];
-        $this->_hidden_columns   = [];
+        $this->_hidden_columns = [];
     }
 
 
@@ -249,8 +249,8 @@ 
             );
         }
         foreach (['event_id', 'datetime_id', 'ticket_id'] as $filter_key) {
-            if (isset($this->_req_data[ $filter_key ])) {
-                $filters[] = EEH_Form_Fields::hidden_input($filter_key, $this->_req_data[ $filter_key ], 'reg_' . $filter_key);
+            if (isset($this->_req_data[$filter_key])) {
+                $filters[] = EEH_Form_Fields::hidden_input($filter_key, $this->_req_data[$filter_key], 'reg_'.$filter_key);
             }
         }
         return $filters;
@@ -324,14 +324,14 @@ 
         $this_month_r    = date('m', current_time('timestamp'));
         $days_this_month = date('t', current_time('timestamp'));
         // setup date query.
-        $beginning_string   = EEM_Registration::instance()->convert_datetime_for_query(
+        $beginning_string = EEM_Registration::instance()->convert_datetime_for_query(
             'REG_date',
-            $this_year_r . '-' . $this_month_r . '-01' . $time_start,
+            $this_year_r.'-'.$this_month_r.'-01'.$time_start,
             'Y-m-d H:i:s'
         );
-        $end_string         = EEM_Registration::instance()->convert_datetime_for_query(
+        $end_string = EEM_Registration::instance()->convert_datetime_for_query(
             'REG_date',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . $time_end,
+            $this_year_r.'-'.$this_month_r.'-'.$days_this_month.$time_end,
             'Y-m-d H:i:s'
         );
         $_where['REG_date'] = [
@@ -341,7 +341,7 @@ 
                 $end_string,
             ],
         ];
-        $_where['STS_ID']   = ['!=', EEM_Registration::status_id_incomplete];
+        $_where['STS_ID'] = ['!=', EEM_Registration::status_id_incomplete];
         return EEM_Registration::instance()->count([$_where]);
     }
 
@@ -367,17 +367,17 @@ 
             [
                 EEM_Registration::instance()->convert_datetime_for_query(
                     'REG_date',
-                    $current_date . $time_start,
+                    $current_date.$time_start,
                     'Y-m-d H:i:s'
                 ),
                 EEM_Registration::instance()->convert_datetime_for_query(
                     'REG_date',
-                    $current_date . $time_end,
+                    $current_date.$time_end,
                     'Y-m-d H:i:s'
                 ),
             ],
         ];
-        $_where['STS_ID']   = ['!=', EEM_Registration::status_id_incomplete];
+        $_where['STS_ID'] = ['!=', EEM_Registration::status_id_incomplete];
         return EEM_Registration::instance()->count([$_where]);
     }
 
@@ -400,10 +400,10 @@ 
             ? $transaction->count_related('Payment')
             : 0;
 
-        $content = '<input type="checkbox" name="_REG_ID[]" value="' . $REG_ID . '" />';
+        $content = '<input type="checkbox" name="_REG_ID[]" value="'.$REG_ID.'" />';
         $content .= $payment_count > 0 || ! $this->caps_handler->userCanEditRegistration($item)
             ? '<span class="ee-locked-entity dashicons dashicons-lock ee-aria-tooltip ee-aria-tooltip--big-box"
-                    aria-label="' . $this->lockedRegMessage() . '"></span>'
+                    aria-label="' . $this->lockedRegMessage().'"></span>'
             : '';
         return $this->columnContent('cb', $content, 'center');
     }
@@ -429,7 +429,7 @@ 
      */
     public function column_id(EE_Registration $registration): string
     {
-        $content = '<span class="ee-entity-id">' . $registration->ID() . '</span>';
+        $content = '<span class="ee-entity-id">'.$registration->ID().'</span>';
         $content .= '<span class="show-on-mobile-view-only">';
         $content .= $this->column_ATT_fname($registration, false);
         $content .= '</span>';
@@ -460,23 +460,23 @@ 
             esc_html__('(%1$s / %2$s)', 'event_espresso'),
             $registration->count(),
             $registration->group_size()
-        ) . '
+        ).'
             </span >';
 
         $content = '
         <div class="ee-layout-row">
-            <span aria-label="' . $pretty_status . '"
-                  class="ee-status-dot ee-status-bg--' . $status . ' ee-aria-tooltip"
+            <span aria-label="' . $pretty_status.'"
+                  class="ee-status-dot ee-status-bg--' . $status.' ee-aria-tooltip"
             ></span>
             ' . $this->viewRegistrationLink($registration, $status)
                    . $prime_reg_star
-                   . $group_count . '
+                   . $group_count.'
             <span class="spacer"></span>
             <span>
                 ' . sprintf(
                        esc_html__('Reg Code: %s', 'event_espresso'),
                        $registration->get('REG_code')
-                   ) . '
+                   ).'
             </span>
         </div>';
 
@@ -507,7 +507,7 @@ 
         $this->_set_related_details($registration);
         // Build row actions
         $content = $this->caps_handler->userCanViewTransaction()
-            ? '<a class="ee-aria-tooltip ee-status-color--' . $this->_transaction_details['status'] . '" href="'
+            ? '<a class="ee-aria-tooltip ee-status-color--'.$this->_transaction_details['status'].'" href="'
               . $this->viewTransactionUrl()
               . '" aria-label="'
               . esc_attr($this->_transaction_details['title_attr'])
@@ -581,16 +581,16 @@ 
     {
         // get first item for initial visibility
         $content = (string) array_shift($datetime_strings);
-        if (! empty($datetime_strings)) {
+        if ( ! empty($datetime_strings)) {
             $content .= '
                 <div class="ee-registration-event-datetimes-container-wrap">
-                    <button aria-label="' . esc_attr__('Click to view all dates', 'event_espresso') . '"
+                    <button aria-label="' . esc_attr__('Click to view all dates', 'event_espresso').'"
                           class="ee-aria-tooltip button button--secondary button--tiny button--icon-only ee-js ee-more-datetimes-toggle"
                     >
                         <span class="dashicons dashicons-admin-collapse"></span>
                     </button>
                     <div class="ee-registration-event-datetimes-container more-items hidden">
-                        ' . implode("", $datetime_strings) . '
+                        ' . implode("", $datetime_strings).'
                     </div>
                 </div>';
         }
@@ -641,16 +641,16 @@ 
         $req_data = $this->_admin_page->get_request_data();
 
         $content = isset($req_data['event_id']) && $ticket instanceof EE_Ticket
-            ? '<div class="TKT_name">' . $ticket->name() . '</div>'
+            ? '<div class="TKT_name">'.$ticket->name().'</div>'
             : '';
 
         $payment_status = $registration->owes_monies_and_can_pay() ? 'TFL' : 'TCM';
-        $content        .= $registration->final_price() > 0
-            ? '<span class="reg-overview-paid-event-spn ee-status-color--' . $payment_status . '">
-                ' . $registration->pretty_final_price() . '
+        $content .= $registration->final_price() > 0
+            ? '<span class="reg-overview-paid-event-spn ee-status-color--'.$payment_status.'">
+                ' . $registration->pretty_final_price().'
                </span>'
             // free event
-            : '<span class="reg-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
+            : '<span class="reg-overview-free-event-spn">'.esc_html__('free', 'event_espresso').'</span>';
 
         return $this->columnContent('PRC_amount', $content, 'end');
     }
@@ -676,7 +676,7 @@ 
 
         $content .= '
             <span class="reg-overview-paid-event-spn">
-                ' . $registration->pretty_final_price() . '
+                ' . $registration->pretty_final_price().'
             </span>';
         return $this->columnContent('_REG_final_price', $content, 'end');
     }
@@ -696,8 +696,8 @@ 
 
         $payment_status = $registration->owes_monies_and_can_pay() ? 'TFL' : 'TCM';
         $content        = '
-            <span class="reg-overview-paid-event-spn ee-status-color--' . $payment_status . '">
-                ' . $registration->pretty_paid() . '
+            <span class="reg-overview-paid-event-spn ee-status-color--' . $payment_status.'">
+                ' . $registration->pretty_paid().'
             </span>';
         if ($registration->paid() > 0) {
             $content .= '<span class="ee-status-text-small">'
@@ -726,11 +726,11 @@ 
         if ($registration->transaction()) {
             $content = $this->caps_handler->userCanViewTransaction()
                 ? '
-                    <a class="ee-aria-tooltip ee-status-color--' . $registration->transaction()->status_ID() . '"
-                        href="' . $this->viewTransactionUrl() . '"
-                        aria-label="' . esc_attr__('View Transaction', 'event_espresso') . '"
+                    <a class="ee-aria-tooltip ee-status-color--' . $registration->transaction()->status_ID().'"
+                        href="' . $this->viewTransactionUrl().'"
+                        aria-label="' . esc_attr__('View Transaction', 'event_espresso').'"
                     >
-                        ' . $registration->transaction()->pretty_total() . '
+                        ' . $registration->transaction()->pretty_total().'
                     </a>'
                 : $registration->transaction()->pretty_total();
         } else {
@@ -764,11 +764,11 @@ 
             } else {
                 $content = $this->caps_handler->userCanViewTransaction()
                     ? '
-                    <a class="ee-aria-tooltip ee-status-color--' . $transaction->status_ID() . '"
-                        href="' . $this->viewTransactionUrl() . '"
-                        aria-label="' . esc_attr__('View Transaction', 'event_espresso') . '"
+                    <a class="ee-aria-tooltip ee-status-color--' . $transaction->status_ID().'"
+                        href="' . $this->viewTransactionUrl().'"
+                        aria-label="' . esc_attr__('View Transaction', 'event_espresso').'"
                     >
-                        ' . $registration->transaction()->pretty_paid() . '
+                        ' . $registration->transaction()->pretty_paid().'
                     </a>'
                     : $registration->transaction()->pretty_paid();
             }
@@ -847,11 +847,11 @@ 
             : '';
         return $this->caps_handler->userCanReadRegistration($registration)
             ? '
-            <a  href="' . $this->viewRegistrationUrl($registration) . '"
-                class="row-title ee-status-color--' . $status . ' ee-aria-tooltip"
-                aria-label="' . esc_attr__('View Registration Details', 'event_espresso') . '"
+            <a  href="' . $this->viewRegistrationUrl($registration).'"
+                class="row-title ee-status-color--' . $status.' ee-aria-tooltip"
+                aria-label="' . esc_attr__('View Registration Details', 'event_espresso').'"
             >
-                ' . $attendee_name . '
+                ' . $attendee_name.'
             </a>'
             : $attendee_name;
     }
@@ -865,9 +865,9 @@ 
     {
         return $this->caps_handler->userCanReadRegistration($registration)
             ? '
-            <a  href="' . $this->viewRegistrationUrl($registration) . '"
+            <a  href="' . $this->viewRegistrationUrl($registration).'"
                 class="ee-aria-tooltip button button--icon-only"
-                aria-label="' . esc_attr__('View Registration Details', 'event_espresso') . '"
+                aria-label="' . esc_attr__('View Registration Details', 'event_espresso').'"
             >
                 <span class="dashicons dashicons-clipboard"></span>
             </a>'
@@ -887,8 +887,8 @@ 
                 REG_ADMIN_URL
             );
             return '
-                <a href="' . $edit_link_url . '"
-                   aria-label="' . esc_attr__('Edit Contact Details', 'event_espresso') . '"
+                <a href="' . $edit_link_url.'"
+                   aria-label="' . esc_attr__('Edit Contact Details', 'event_espresso').'"
                    class="ee-aria-tooltip button button--secondary button--icon-only"
                 >
                     <span class="dashicons dashicons-admin-users"></span>
@@ -916,7 +916,7 @@ 
                 true
             );
             return '
-			    <a href="' . $resend_reg_link_url . '" aria-label="'
+			    <a href="' . $resend_reg_link_url.'" aria-label="'
                                          . esc_attr__('Resend Registration Details', 'event_espresso')
                                          . '" class="ee-aria-tooltip button button--icon-only">
 			        <span class="dashicons dashicons-email-alt"></span>
@@ -943,8 +943,8 @@ 
         if ($this->caps_handler->userCanViewTransaction()) {
             return '
                 <a class="ee-aria-tooltip button button--icon-only"
-                   href="' . $this->viewTransactionUrl() . '"
-                   aria-label="' . $this->_transaction_details['title_attr'] . '"
+                   href="' . $this->viewTransactionUrl().'"
+                   aria-label="' . $this->_transaction_details['title_attr'].'"
                 >
                     <span class="dashicons dashicons-cart"></span>
                 </a>';
@@ -969,7 +969,7 @@ 
         ) {
             return '
                 <a aria-label="' . esc_attr__('View Transaction Invoice', 'event_espresso')
-                                         . '" target="_blank" href="' . $registration->invoice_url() . '" class="ee-aria-tooltip button button--icon-only">
+                                         . '" target="_blank" href="'.$registration->invoice_url().'" class="ee-aria-tooltip button button--icon-only">
                     <span class="dashicons dashicons-media-spreadsheet"></span>
                 </a>';
         }
@@ -1009,7 +1009,7 @@ 
         }
 
         // check caps
-        if (! $this->caps_handler->userCanTrashRegistration($registration)) {
+        if ( ! $this->caps_handler->userCanTrashRegistration($registration)) {
             return $actions;
         }
 
@@ -1027,10 +1027,10 @@ 
         $trash_link_url       = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
         $actions['trash']     = '
             <a class="ee-aria-tooltip"
-                href="' . $trash_link_url . '"
-                aria-label="' . esc_attr__('Trash Registration', 'event_espresso') . '"
+                href="' . $trash_link_url.'"
+                aria-label="' . esc_attr__('Trash Registration', 'event_espresso').'"
             >
-                ' . esc_html__('Trash', 'event_espresso') . '
+                ' . esc_html__('Trash', 'event_espresso').'
             </a>';
         return $actions;
     }
@@ -1056,10 +1056,10 @@ 
             $restore_link_url     = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
             $actions['restore']   = '
                 <a class="ee-aria-tooltip"
-                    href="' . $restore_link_url . '"
-                    aria-label="' . esc_attr__('Restore Registration', 'event_espresso') . '"
+                    href="' . $restore_link_url.'"
+                    aria-label="' . esc_attr__('Restore Registration', 'event_espresso').'"
                 >
-                    ' . esc_html__('Restore', 'event_espresso') . '
+                    ' . esc_html__('Restore', 'event_espresso').'
                 </a>';
         }
 
@@ -1081,10 +1081,10 @@ 
             $delete_link_url      = EE_Admin_Page::add_query_args_and_nonce($url_params, REG_ADMIN_URL);
             $actions['delete']    = '
                 <a class="ee-aria-tooltip"
-                    href="' . $delete_link_url . '"
-                    aria-label="' . esc_attr__('Delete Registration Permanently', 'event_espresso') . '"
+                    href="' . $delete_link_url.'"
+                    aria-label="' . esc_attr__('Delete Registration Permanently', 'event_espresso').'"
                 >
-                    ' . esc_html__('Delete', 'event_espresso') . '
+                    ' . esc_html__('Delete', 'event_espresso').'
                 </a>';
         }
         return $actions;
@@ -1093,7 +1093,7 @@ 
 
     private function editEventLink(int $EVT_ID, string $event_name): string
     {
-        if (! $EVT_ID || ! $this->caps_handler->userCanEditEvent($EVT_ID)) {
+        if ( ! $EVT_ID || ! $this->caps_handler->userCanEditEvent($EVT_ID)) {
             return $event_name;
         }
         $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
@@ -1101,31 +1101,31 @@ 
             EVENTS_ADMIN_URL
         );
         return '
-            <a class="ee-aria-tooltip ee-status-color--' . $this->_event_details['status'] . '"
-                href="' . $edit_event_url . '"
-                aria-label="' . esc_attr($this->_event_details['title_attr']) . '"
+            <a class="ee-aria-tooltip ee-status-color--' . $this->_event_details['status'].'"
+                href="' . $edit_event_url.'"
+                aria-label="' . esc_attr($this->_event_details['title_attr']).'"
             >
-                ' . $event_name . '
+                ' . $event_name.'
             </a>';
     }
 
 
     private function eventFilterLink(int $EVT_ID, string $event_name): string
     {
-        if (!$EVT_ID) {
+        if ( ! $EVT_ID) {
             return '';
         }
         $event_filter_url = EE_Admin_Page::add_query_args_and_nonce(['event_id' => $EVT_ID], REG_ADMIN_URL);
         return '
             <a  class="ee-aria-tooltip ee-event-filter-link"
-                href="' . $event_filter_url . '"
+                href="' . $event_filter_url.'"
                 aria-label="' . sprintf(
                     esc_attr__('Filter this list to only show registrations for %s', 'event_espresso'),
                     $event_name
-                ) . '"
+                ).'"
             >
                 <span class="dashicons dashicons-groups dashicons--small"></span>'
-                . esc_html__('View Registrations', 'event_espresso') . '
+                . esc_html__('View Registrations', 'event_espresso').'
             </a>';
     }
 }

PaymentMethods/Manager.php

Indentation +193 added lines, -193 removed lines

@@ -21,197 +21,197 @@
  */
 class Manager
 {
-    /**
-     * List of PMs that can be replaced with PP Commerce.
-     * ['payment method name' => 'settings option']
-     *
-     * @var $pms_can_hide
-     */
-    protected static $pms_can_hide = [
-        'paypal_express' => 'api_username',
-        'paypal_pro'     => 'api_username',
-        'aim'            => 'login_id',
-    ];
-
-
-    /**
-     * Manager constructor.
-     */
-    public function __construct()
-    {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            return;
-        }
-        $this->loadPaymentMethods();
-        if (is_admin()) {
-            // Use only PayPal Commerce if it's a new setup.
-            add_filter(
-                'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-                [__CLASS__, 'hidePaymentMethods']
-            );
-            // Payment methods related admin notices.
-            add_action('admin_init', [__CLASS__, 'adminNotice']);
-        }
-    }
-
-
-    /**
-     * Load all payment methods that are in PaymentMethods folder.
-     *
-     * @return void
-     */
-    protected function loadPaymentMethods()
-    {
-        // Scan the PaymentMethods folder.
-        $pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
-        // Filter the discovered PM list.
-        $pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
-        // Clean from duplicates.
-        $pms_list = array_unique($pms_list);
-        foreach ($pms_list as $pm_path) {
-            $this->registerPaymentMethod($pm_path);
-        }
-    }
-
-
-    /**
-     * Looks for the main payment method file and loads it.
-     *
-     * @param string $pm_path path to the payment method folder
-     * @param string $file_ext
-     * @param string $pm_namespace
-     * @return boolean
-     */
-    public function registerPaymentMethod(
-        string $pm_path,
-        string $file_ext = '.php',
-        string $pm_namespace = 'EventEspresso\PaymentMethods'
-    ): bool {
-        do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
-        // Separators should match.
-        $pm_path = str_replace('/\\', '/', $pm_path) . DS;
-        // Sanitize PM name.
-        $module_dir = basename($pm_path);
-        // Get class name.
-        $pm_class_name = str_replace(' ', '_', $module_dir);
-        // Check if file exists.
-        if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
-            return false;
-        }
-        // Load the initial PM class.
-        require_once($pm_path . DS . $pm_class_name . $file_ext);
-        $pm_object = "$pm_namespace\\$pm_class_name";
-        if (! class_exists($pm_object)) {
-            return false;
-        }
-        new $pm_object();
-        return true;
-    }
-
-
-    /**
-     * Deactivate a few other PMs if it's a new setup. Use PP Commerce.
-     *
-     * @param array $pms_to_list
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function hidePaymentMethods(array $pms_to_list): array
-    {
-        foreach (self::$pms_can_hide as $pm_name => $pm_option) {
-            // Can we deregister this PM ?
-            if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
-                unset($pms_to_list[ $pm_name ]);
-            }
-        }
-        return $pms_to_list;
-    }
-
-
-    /**
-     * Deregisters the provided payment method if not used.
-     *
-     * @param string $pm_name
-     * @param string $pm_option
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function pmCanBeHidden(string $pm_name, string $pm_option): bool
-    {
-        $pm_to_hide = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
-        $pm_active  = $pm_active_before = false;
-        if ($pm_to_hide instanceof EE_Payment_Method) {
-            $pm_active = $pm_to_hide->active();
-            // Payment method used before ?
-            $option = $pm_to_hide->get_extra_meta($pm_option, true, false);
-            $pm_active_before = ! empty($option);
-        }
-        // If PM not used before and not active, deregister it.
-        if (
-            apply_filters(
-                "FHEE__PaymentMethods__Manager__register_payment_methods__hide_$pm_name",
-                ! $pm_active && ! $pm_active_before,
-                $pm_name
-            )
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Payment methods related admin notices.
-     *
-     * @return void
-     */
-    public static function adminNotice()
-    {
-        // Is this an EE admin page ?
-        $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page_name = $request->getRequestParam('page');
-        // Only show the notice on core EE pages
-        if (! str_contains($page_name, 'espresso')) {
-            return;
-        }
-        // Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.
-        try {
-            $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-            // Don't show notice if PayPal Commerce is active.
-            if ($pp_commerce instanceof EE_Payment_Method && $pp_commerce->active()) {
-                return;
-            }
-            foreach (self::$pms_can_hide as $pm_name => $pm_option) {
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
-                if ($payment_method instanceof EE_Payment_Method && $payment_method->active()) {
-                    add_action('admin_notices', [__CLASS__, 'usePayPalCommerceNotice']);
-                    return;
-                }
-            }
-        } catch (EE_Error | ReflectionException $e) {
-            // No handling needed right now.
-        }
-    }
-
-
-    /**
-     * Recommend PayPal Commerce notice contents.
-     *
-     * @return void
-     */
-    public static function usePayPalCommerceNotice()
-    {
-        echo '<div class="error"><p>'
-         . sprintf(
-             esc_html__(
-                 'We recommend using our latest PayPal integration - %1$sPayPal Commerce%2$s payment method in place of PayPal Standard, PayPal Express and PayPal Pro.',
-                 'event_espresso'
-             ),
-             '<strong>',
-             '</strong>'
-         )
-         . '</p></div>';
-    }
+	/**
+	 * List of PMs that can be replaced with PP Commerce.
+	 * ['payment method name' => 'settings option']
+	 *
+	 * @var $pms_can_hide
+	 */
+	protected static $pms_can_hide = [
+		'paypal_express' => 'api_username',
+		'paypal_pro'     => 'api_username',
+		'aim'            => 'login_id',
+	];
+
+
+	/**
+	 * Manager constructor.
+	 */
+	public function __construct()
+	{
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			return;
+		}
+		$this->loadPaymentMethods();
+		if (is_admin()) {
+			// Use only PayPal Commerce if it's a new setup.
+			add_filter(
+				'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+				[__CLASS__, 'hidePaymentMethods']
+			);
+			// Payment methods related admin notices.
+			add_action('admin_init', [__CLASS__, 'adminNotice']);
+		}
+	}
+
+
+	/**
+	 * Load all payment methods that are in PaymentMethods folder.
+	 *
+	 * @return void
+	 */
+	protected function loadPaymentMethods()
+	{
+		// Scan the PaymentMethods folder.
+		$pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
+		// Filter the discovered PM list.
+		$pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
+		// Clean from duplicates.
+		$pms_list = array_unique($pms_list);
+		foreach ($pms_list as $pm_path) {
+			$this->registerPaymentMethod($pm_path);
+		}
+	}
+
+
+	/**
+	 * Looks for the main payment method file and loads it.
+	 *
+	 * @param string $pm_path path to the payment method folder
+	 * @param string $file_ext
+	 * @param string $pm_namespace
+	 * @return boolean
+	 */
+	public function registerPaymentMethod(
+		string $pm_path,
+		string $file_ext = '.php',
+		string $pm_namespace = 'EventEspresso\PaymentMethods'
+	): bool {
+		do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
+		// Separators should match.
+		$pm_path = str_replace('/\\', '/', $pm_path) . DS;
+		// Sanitize PM name.
+		$module_dir = basename($pm_path);
+		// Get class name.
+		$pm_class_name = str_replace(' ', '_', $module_dir);
+		// Check if file exists.
+		if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
+			return false;
+		}
+		// Load the initial PM class.
+		require_once($pm_path . DS . $pm_class_name . $file_ext);
+		$pm_object = "$pm_namespace\\$pm_class_name";
+		if (! class_exists($pm_object)) {
+			return false;
+		}
+		new $pm_object();
+		return true;
+	}
+
+
+	/**
+	 * Deactivate a few other PMs if it's a new setup. Use PP Commerce.
+	 *
+	 * @param array $pms_to_list
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function hidePaymentMethods(array $pms_to_list): array
+	{
+		foreach (self::$pms_can_hide as $pm_name => $pm_option) {
+			// Can we deregister this PM ?
+			if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
+				unset($pms_to_list[ $pm_name ]);
+			}
+		}
+		return $pms_to_list;
+	}
+
+
+	/**
+	 * Deregisters the provided payment method if not used.
+	 *
+	 * @param string $pm_name
+	 * @param string $pm_option
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function pmCanBeHidden(string $pm_name, string $pm_option): bool
+	{
+		$pm_to_hide = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
+		$pm_active  = $pm_active_before = false;
+		if ($pm_to_hide instanceof EE_Payment_Method) {
+			$pm_active = $pm_to_hide->active();
+			// Payment method used before ?
+			$option = $pm_to_hide->get_extra_meta($pm_option, true, false);
+			$pm_active_before = ! empty($option);
+		}
+		// If PM not used before and not active, deregister it.
+		if (
+			apply_filters(
+				"FHEE__PaymentMethods__Manager__register_payment_methods__hide_$pm_name",
+				! $pm_active && ! $pm_active_before,
+				$pm_name
+			)
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Payment methods related admin notices.
+	 *
+	 * @return void
+	 */
+	public static function adminNotice()
+	{
+		// Is this an EE admin page ?
+		$request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$page_name = $request->getRequestParam('page');
+		// Only show the notice on core EE pages
+		if (! str_contains($page_name, 'espresso')) {
+			return;
+		}
+		// Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.
+		try {
+			$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+			// Don't show notice if PayPal Commerce is active.
+			if ($pp_commerce instanceof EE_Payment_Method && $pp_commerce->active()) {
+				return;
+			}
+			foreach (self::$pms_can_hide as $pm_name => $pm_option) {
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
+				if ($payment_method instanceof EE_Payment_Method && $payment_method->active()) {
+					add_action('admin_notices', [__CLASS__, 'usePayPalCommerceNotice']);
+					return;
+				}
+			}
+		} catch (EE_Error | ReflectionException $e) {
+			// No handling needed right now.
+		}
+	}
+
+
+	/**
+	 * Recommend PayPal Commerce notice contents.
+	 *
+	 * @return void
+	 */
+	public static function usePayPalCommerceNotice()
+	{
+		echo '<div class="error"><p>'
+		 . sprintf(
+			 esc_html__(
+				 'We recommend using our latest PayPal integration - %1$sPayPal Commerce%2$s payment method in place of PayPal Standard, PayPal Express and PayPal Pro.',
+				 'event_espresso'
+			 ),
+			 '<strong>',
+			 '</strong>'
+		 )
+		 . '</p></div>';
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -39,7 +39,7 @@ 
      */
     public function __construct()
     {
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             return;
         }
         $this->loadPaymentMethods();
@@ -63,7 +63,7 @@ 
     protected function loadPaymentMethods()
     {
         // Scan the PaymentMethods folder.
-        $pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
+        $pms_list = glob(EE_PLUGIN_DIR_PATH.'PaymentMethods/*', GLOB_ONLYDIR);
         // Filter the discovered PM list.
         $pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
         // Clean from duplicates.
@@ -89,19 +89,19 @@ 
     ): bool {
         do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
         // Separators should match.
-        $pm_path = str_replace('/\\', '/', $pm_path) . DS;
+        $pm_path = str_replace('/\\', '/', $pm_path).DS;
         // Sanitize PM name.
         $module_dir = basename($pm_path);
         // Get class name.
         $pm_class_name = str_replace(' ', '_', $module_dir);
         // Check if file exists.
-        if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
+        if ( ! is_readable($pm_path.$pm_class_name.$file_ext)) {
             return false;
         }
         // Load the initial PM class.
-        require_once($pm_path . DS . $pm_class_name . $file_ext);
+        require_once($pm_path.DS.$pm_class_name.$file_ext);
         $pm_object = "$pm_namespace\\$pm_class_name";
-        if (! class_exists($pm_object)) {
+        if ( ! class_exists($pm_object)) {
             return false;
         }
         new $pm_object();
@@ -121,8 +121,8 @@ 
     {
         foreach (self::$pms_can_hide as $pm_name => $pm_option) {
             // Can we deregister this PM ?
-            if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
-                unset($pms_to_list[ $pm_name ]);
+            if (isset($pms_to_list[$pm_name]) && self::pmCanBeHidden($pm_name, $pm_option)) {
+                unset($pms_to_list[$pm_name]);
             }
         }
         return $pms_to_list;
@@ -173,7 +173,7 @@ 
         $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
         $page_name = $request->getRequestParam('page');
         // Only show the notice on core EE pages
-        if (! str_contains($page_name, 'espresso')) {
+        if ( ! str_contains($page_name, 'espresso')) {
             return;
         }
         // Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.