eventespresso / event-espresso-core

espresso.php

Indentation +97 added lines, -97 removed lines

@@ -37,124 +37,124 @@
  * @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="http://php.net/downloads.php">http://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="http://php.net/downloads.php">http://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/wp-graphql/wp-graphql/wp-graphql.php';
+		require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.1.rc.003');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.1.rc.003');
+		}
 
-        /**
-         * 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
-            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
+			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
-            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
+			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($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($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/db_models/EEM_Payment_Method.model.php

Indentation +452 added lines, -452 removed lines

@@ -16,456 +16,456 @@
  */
 class EEM_Payment_Method extends EEM_Base
 {
-    const scope_cart = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api = 'API';
-
-    /**
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Payment Method', 'event_espresso');
-        $this->plural_item = esc_html__('Payment Methods', 'event_espresso');
-        $this->_tables = [
-            'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
-        ];
-        $this->_fields = [
-            'Payment_Method' => [
-                'PMD_ID'              => new EE_Primary_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'PMD_type'            => new EE_Plain_Text_Field(
-                    'PMD_type',
-                    esc_html__('Payment Method Type', 'event_espresso'),
-                    false,
-                    'Admin_Only'
-                ),
-                'PMD_name'            => new EE_Plain_Text_Field(
-                    'PMD_name',
-                    esc_html__('Name', 'event_espresso'),
-                    false
-                ),
-                'PMD_desc'            => new EE_Post_Content_Field(
-                    'PMD_desc',
-                    esc_html__('Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PMD_admin_name'      => new EE_Plain_Text_Field(
-                    'PMD_admin_name',
-                    esc_html__('Admin-Only Name', 'event_espresso'),
-                    true
-                ),
-                'PMD_admin_desc'      => new EE_Post_Content_Field(
-                    'PMD_admin_desc',
-                    esc_html__('Admin-Only Description', 'event_espresso'),
-                    true
-                ),
-                'PMD_slug'            => new EE_Slug_Field(
-                    'PMD_slug',
-                    esc_html__('Slug', 'event_espresso'),
-                    false
-                ),
-                'PMD_order'           => new EE_Integer_Field(
-                    'PMD_order',
-                    esc_html__('Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PMD_debug_mode'      => new EE_Boolean_Field(
-                    'PMD_debug_mode',
-                    esc_html__('Sandbox Mode On? (AKA: debug mode)', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_wp_user'         => new EE_WP_User_Field(
-                    'PMD_wp_user',
-                    esc_html__('Payment Method Creator ID', 'event_espresso'),
-                    false
-                ),
-                'PMD_open_by_default' => new EE_Boolean_Field(
-                    'PMD_open_by_default',
-                    esc_html__('Open by Default?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_button_url'      => new EE_Plain_Text_Field(
-                    'PMD_button_url',
-                    esc_html__('Button URL', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PMD_scope'           => new EE_Serialized_Text_Field(
-                    'PMD_scope',
-                    esc_html__('Usable From?', 'event_espresso'),
-                    false,
-                    []// possible values currently are 'CART','ADMIN','API'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Payment'     => new EE_Has_Many_Relation(),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User'     => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets one by the slug provided
-     *
-     * @param string $slug
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one([['PMD_slug' => $slug]]);
-    }
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     *
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            [
-                EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
-                EEM_Payment_Method::scope_admin => esc_html__(
-                    'Admin Registration Page (no online processing)',
-                    'event_espresso'
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * Determines if this is an valid scope
-     *
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all active payment methods
-     *
-     * @param string $scope one of
-     * @param array  $query_params
-     * @return EE_Base_Class[]|EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_active($scope = null, $query_params = [])
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Counts all active gateways in the specified scope
-     *
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_active($scope = null, $query_params = [])
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
-                    $scope
-                )
-            );
-        }
-        $acceptable_scopes = [];
-        $count = 0;
-        foreach ($this->scopes() as $scope_name => $desc) {
-            $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
-        }
-        return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     *
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_active($scope = null, $query_params = [])
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     *
-     * @param string $type
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one([['PMD_type' => $type]]);
-    }
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     *
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
-     * @throws EE_Error
-     * @see EEM_Base::ensure_is_obj()
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
-                $base_class_obj_or_id
-            )
-        );
-    }
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     *
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     * @throws EE_Error
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url.
-     * If not, resets them to their default.
-     *
-     * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods)
-            ? $payment_methods
-            : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (
-                    empty($current_button_url)
-                    || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->deactivate();
-            }
-        }
-    }
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    protected function _create_objects($rows = [])
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = [];
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        esc_html__(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, ['group_by' => 'PMD_type']),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment
-     * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
-     *                                                    registration.
-     * @return EE_Payment|null
-     * @throws EE_Error
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = [
-            0          => [
-                'Payment.Registration.REG_ID' => $registration_id,
-            ],
-            'order_by' => ['Payment.PAY_ID' => 'DESC'],
-        ];
-        return $this->get_one($query_params);
-    }
+	const scope_cart = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api = 'API';
+
+	/**
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Payment Method', 'event_espresso');
+		$this->plural_item = esc_html__('Payment Methods', 'event_espresso');
+		$this->_tables = [
+			'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
+		];
+		$this->_fields = [
+			'Payment_Method' => [
+				'PMD_ID'              => new EE_Primary_Key_Int_Field(
+					'PMD_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'PMD_type'            => new EE_Plain_Text_Field(
+					'PMD_type',
+					esc_html__('Payment Method Type', 'event_espresso'),
+					false,
+					'Admin_Only'
+				),
+				'PMD_name'            => new EE_Plain_Text_Field(
+					'PMD_name',
+					esc_html__('Name', 'event_espresso'),
+					false
+				),
+				'PMD_desc'            => new EE_Post_Content_Field(
+					'PMD_desc',
+					esc_html__('Description', 'event_espresso'),
+					false,
+					''
+				),
+				'PMD_admin_name'      => new EE_Plain_Text_Field(
+					'PMD_admin_name',
+					esc_html__('Admin-Only Name', 'event_espresso'),
+					true
+				),
+				'PMD_admin_desc'      => new EE_Post_Content_Field(
+					'PMD_admin_desc',
+					esc_html__('Admin-Only Description', 'event_espresso'),
+					true
+				),
+				'PMD_slug'            => new EE_Slug_Field(
+					'PMD_slug',
+					esc_html__('Slug', 'event_espresso'),
+					false
+				),
+				'PMD_order'           => new EE_Integer_Field(
+					'PMD_order',
+					esc_html__('Order', 'event_espresso'),
+					false,
+					0
+				),
+				'PMD_debug_mode'      => new EE_Boolean_Field(
+					'PMD_debug_mode',
+					esc_html__('Sandbox Mode On? (AKA: debug mode)', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_wp_user'         => new EE_WP_User_Field(
+					'PMD_wp_user',
+					esc_html__('Payment Method Creator ID', 'event_espresso'),
+					false
+				),
+				'PMD_open_by_default' => new EE_Boolean_Field(
+					'PMD_open_by_default',
+					esc_html__('Open by Default?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_button_url'      => new EE_Plain_Text_Field(
+					'PMD_button_url',
+					esc_html__('Button URL', 'event_espresso'),
+					true,
+					''
+				),
+				'PMD_scope'           => new EE_Serialized_Text_Field(
+					'PMD_scope',
+					esc_html__('Usable From?', 'event_espresso'),
+					false,
+					[]// possible values currently are 'CART','ADMIN','API'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Payment'     => new EE_Has_Many_Relation(),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User'     => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets one by the slug provided
+	 *
+	 * @param string $slug
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one([['PMD_slug' => $slug]]);
+	}
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 *
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			[
+				EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
+				EEM_Payment_Method::scope_admin => esc_html__(
+					'Admin Registration Page (no online processing)',
+					'event_espresso'
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * Determines if this is an valid scope
+	 *
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all active payment methods
+	 *
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @return EE_Base_Class[]|EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_active($scope = null, $query_params = [])
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 *
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_active($scope = null, $query_params = [])
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
+					$scope
+				)
+			);
+		}
+		$acceptable_scopes = [];
+		$count = 0;
+		foreach ($this->scopes() as $scope_name => $desc) {
+			$count++;
+			$acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+		}
+		return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 *
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_active($scope = null, $query_params = [])
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 *
+	 * @param string $type
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one([['PMD_type' => $type]]);
+	}
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 *
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
+	 * @throws EE_Error
+	 * @see EEM_Base::ensure_is_obj()
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
+				$base_class_obj_or_id
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 *
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url.
+	 * If not, resets them to their default.
+	 *
+	 * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods)
+			? $payment_methods
+			: $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (
+					empty($current_button_url)
+					|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->deactivate();
+			}
+		}
+	}
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	protected function _create_objects($rows = [])
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = [];
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						esc_html__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, ['group_by' => 'PMD_type']),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment
+	 * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
+	 *                                                    registration.
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = [
+			0          => [
+				'Payment.Registration.REG_ID' => $registration_id,
+			],
+			'order_by' => ['Payment.PAY_ID' => 'DESC'],
+		];
+		return $this->get_one($query_params);
+	}
 }

core/EE_Maintenance_Mode.core.php

Indentation +355 added lines, -355 removed lines

@@ -16,361 +16,361 @@
  */
 class EE_Maintenance_Mode implements ResettableInterface
 {
-    /**
-     * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
-     * level_0_not_in_maintenance means the site is NOT in maintenance mode (so everything's normal)
-     */
-    const level_0_not_in_maintenance = 0;
-
-    /**
-     * level_1_frontend_only_maintenance means that the site's frontend EE code should be completely disabled
-     * but the admin backend should be running as normal. Maybe an admin can view the frontend though
-     */
-    const level_1_frontend_only_maintenance = 1;
-
-    /**
-     * level_2_complete_maintenance means the frontend AND EE backend code are disabled. The only system running
-     * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
-     * migration scripts before taking the site out of maintenance mode
-     */
-    const level_2_complete_maintenance = 2;
-
-    /**
-     * the name of the option which stores the current level of maintenance mode
-     */
-    const option_name_maintenance_mode = 'ee_maintenance_mode';
-
-
-    /**
-     * @var EE_Maintenance_Mode $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $EE
-     */
-    protected $EE;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Maintenance_Mode
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets maintenance mode (mostly just re-checks whether we should be in maintenance mode)
-     *
-     * @return EE_Maintenance_Mode
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::instance()->set_maintenance_mode_if_db_old();
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     */
-    private function __construct()
-    {
-        // if M-Mode level 2 is engaged, we still need basic assets loaded
-        add_action('wp_enqueue_scripts', [$this, 'load_assets_required_for_m_mode']);
-        // shut 'er down for maintenance ?
-        add_filter('the_content', [$this, 'the_content'], 2);
-        // redirect ee menus to maintenance page
-        add_action('admin_page_access_denied', [$this, 'redirect_to_maintenance']);
-        // add powered by EE msg
-        add_action('shutdown', [$this, 'display_maintenance_mode_notice'], 10);
-    }
-
-
-    /**
-     * retrieves the maintenance mode option value from the db
-     *
-     * @return int
-     */
-    public function real_level()
-    {
-        return (int) get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
-    }
-
-
-    /**
-     * Returns whether the models reportedly are able to run queries or not
-     * (ie, if the system thinks their tables are present and up-to-date).
-     *
-     * @return boolean
-     */
-    public function models_can_query()
-    {
-        return $this->real_level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
-    }
-
-
-    /**
-     * Determines whether we're in maintenance mode and what level. However, while the site
-     * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
-     * to them as if teh site isn't in maintenance mode.
-     * EE_Maintenance_Mode::level_0_not_in_maintenance => not in maintenance mode (in normal mode)
-     * EE_Maintenance_Mode::level_1_frontend_only_maintenance=> frontend-only maintenance mode
-     * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
-     *
-     * @return int
-     */
-    public function level()
-    {
-        $maintenance_mode_level = $this->real_level();
-        // if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
-        if (
-            $maintenance_mode_level === EE_Maintenance_Mode::level_1_frontend_only_maintenance// we're in level 1
-            && ((defined('DOING_AJAX') && DOING_AJAX) || ! is_admin()) // on non-ajax frontend requests
-            && current_user_can('administrator') // when the user is an admin
-        ) {
-            $maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
-        }
-        return $maintenance_mode_level;
-    }
-
-
-    /**
-     * Determines if we need to put EE in maintenance mode because the database needs updating
-     *
-     * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
-     * @throws EE_Error
-     */
-    public function set_maintenance_mode_if_db_old()
-    {
-        LoaderFactory::getLoader()->getShared('Data_Migration_Manager');
-        if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
-            update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
-            return true;
-        }
-        if ($this->level() === self::level_2_complete_maintenance) {
-            // we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
-            // then we shouldn't be in mm2. (Maybe an addon got deactivated?)
-            update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
-            return false;
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the maintenance level on the site
-     *
-     * @param int $level
-     * @return void
-     */
-    public function set_maintenance_level($level)
-    {
-        do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
-        update_option(self::option_name_maintenance_mode, (int) $level);
-    }
-
-
-    /**
-     * returns TRUE if M-Mode is engaged and the current request is not for the admin
-     *
-     * @return bool
-     */
-    public static function disable_frontend_for_maintenance()
-    {
-        return (! is_admin() && EE_Maintenance_Mode::instance()->level());
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_assets_required_for_m_mode()
-    {
-        if (
-            $this->real_level() === EE_Maintenance_Mode::level_2_complete_maintenance
-            && ! wp_script_is('espresso_core')
-        ) {
-            wp_register_style(
-                'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                ['dashicons'],
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('espresso_default');
-            wp_register_script(
-                'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-                ['jquery'],
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('espresso_core');
-        }
-    }
-
-
-    /**
-     * replacement EE CPT template that displays message notifying site visitors
-     * that EE has been temporarily placed into maintenance mode
-     * does NOT get called on non-EE-CPT requests
-     *
-     * @return    string
-     */
-    public static function template_include()
-    {
-        // shut 'er down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
-    }
-
-
-    /**
-     * displays message notifying site visitors that EE has been temporarily
-     * placed into maintenance mode when post_type != EE CPT
-     *
-     * @param string $the_content
-     * @return string
-     */
-    public function the_content($the_content)
-    {
-        // check if M-mode is engaged and for EE shortcode
-        if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
-            // this can eventually be moved to a template, or edited via admin. But for now...
-            $the_content = sprintf(
-                esc_html__(
-                    '%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
-                    'event_espresso'
-                ),
-                '<h3>',
-                '</h3><p>',
-                '</p>'
-            );
-        }
-        return $the_content;
-    }
-
-
-    /**
-     * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
-     */
-    public function display_maintenance_mode_notice()
-    {
-        /** @var CurrentPage $current_page */
-        $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        // check if M-mode is engaged and for EE shortcode
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && $this->real_level()
-            && ! is_admin()
-            && current_user_can('administrator')
-            && $current_page->isEspressoPage()
-        ) {
-            printf(
-                esc_html__(
-                    '%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
-                    'event_espresso'
-                ),
-                '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
-                '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
-                    ['page' => 'espresso_maintenance_settings'],
-                    admin_url('admin.php')
-                ) . '">',
-                '</a></p></div>'
-            );
-        }
-    }
-    // espresso-notices important-notice ee-attention
-
-    /**
-     * Redirects EE admin menu requests to the maintenance page
-     */
-    public function redirect_to_maintenance()
-    {
-        global $pagenow;
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page   = $request->getRequestParam('page');
-
-        if (
-            $pagenow == 'admin.php' && 
-            strpos($page, 'espresso_') !== false &&
-            $this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            wp_safe_redirect( 'admin.php?page=espresso_maintenance_settings' );
-            exit;
-        }
-    }
-
-
-    /**
-     * override magic methods
-     */
-    final public function __destruct()
-    {
-    }
-
-
-    final public function __call($a, $b)
-    {
-    }
-
-
-    final public function __get($a)
-    {
-    }
-
-
-    final public function __set($a, $b)
-    {
-    }
-
-
-    final public function __isset($a)
-    {
-    }
-
-
-    final public function __unset($a)
-    {
-    }
-
-
-    final public function __sleep()
-    {
-        return [];
-    }
-
-
-    final public function __wakeup()
-    {
-    }
-
-
-    final public function __invoke()
-    {
-    }
-
-
-    final public static function __set_state($a = null)
-    {
-        return EE_Maintenance_Mode::instance();
-    }
-
-
-    final public function __clone()
-    {
-    }
+	/**
+	 * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
+	 * level_0_not_in_maintenance means the site is NOT in maintenance mode (so everything's normal)
+	 */
+	const level_0_not_in_maintenance = 0;
+
+	/**
+	 * level_1_frontend_only_maintenance means that the site's frontend EE code should be completely disabled
+	 * but the admin backend should be running as normal. Maybe an admin can view the frontend though
+	 */
+	const level_1_frontend_only_maintenance = 1;
+
+	/**
+	 * level_2_complete_maintenance means the frontend AND EE backend code are disabled. The only system running
+	 * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
+	 * migration scripts before taking the site out of maintenance mode
+	 */
+	const level_2_complete_maintenance = 2;
+
+	/**
+	 * the name of the option which stores the current level of maintenance mode
+	 */
+	const option_name_maintenance_mode = 'ee_maintenance_mode';
+
+
+	/**
+	 * @var EE_Maintenance_Mode $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $EE
+	 */
+	protected $EE;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Maintenance_Mode
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Maintenance_Mode) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets maintenance mode (mostly just re-checks whether we should be in maintenance mode)
+	 *
+	 * @return EE_Maintenance_Mode
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::instance()->set_maintenance_mode_if_db_old();
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 */
+	private function __construct()
+	{
+		// if M-Mode level 2 is engaged, we still need basic assets loaded
+		add_action('wp_enqueue_scripts', [$this, 'load_assets_required_for_m_mode']);
+		// shut 'er down for maintenance ?
+		add_filter('the_content', [$this, 'the_content'], 2);
+		// redirect ee menus to maintenance page
+		add_action('admin_page_access_denied', [$this, 'redirect_to_maintenance']);
+		// add powered by EE msg
+		add_action('shutdown', [$this, 'display_maintenance_mode_notice'], 10);
+	}
+
+
+	/**
+	 * retrieves the maintenance mode option value from the db
+	 *
+	 * @return int
+	 */
+	public function real_level()
+	{
+		return (int) get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
+	}
+
+
+	/**
+	 * Returns whether the models reportedly are able to run queries or not
+	 * (ie, if the system thinks their tables are present and up-to-date).
+	 *
+	 * @return boolean
+	 */
+	public function models_can_query()
+	{
+		return $this->real_level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
+	}
+
+
+	/**
+	 * Determines whether we're in maintenance mode and what level. However, while the site
+	 * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
+	 * to them as if teh site isn't in maintenance mode.
+	 * EE_Maintenance_Mode::level_0_not_in_maintenance => not in maintenance mode (in normal mode)
+	 * EE_Maintenance_Mode::level_1_frontend_only_maintenance=> frontend-only maintenance mode
+	 * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
+	 *
+	 * @return int
+	 */
+	public function level()
+	{
+		$maintenance_mode_level = $this->real_level();
+		// if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
+		if (
+			$maintenance_mode_level === EE_Maintenance_Mode::level_1_frontend_only_maintenance// we're in level 1
+			&& ((defined('DOING_AJAX') && DOING_AJAX) || ! is_admin()) // on non-ajax frontend requests
+			&& current_user_can('administrator') // when the user is an admin
+		) {
+			$maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
+		}
+		return $maintenance_mode_level;
+	}
+
+
+	/**
+	 * Determines if we need to put EE in maintenance mode because the database needs updating
+	 *
+	 * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
+	 * @throws EE_Error
+	 */
+	public function set_maintenance_mode_if_db_old()
+	{
+		LoaderFactory::getLoader()->getShared('Data_Migration_Manager');
+		if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
+			update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
+			return true;
+		}
+		if ($this->level() === self::level_2_complete_maintenance) {
+			// we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
+			// then we shouldn't be in mm2. (Maybe an addon got deactivated?)
+			update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
+			return false;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the maintenance level on the site
+	 *
+	 * @param int $level
+	 * @return void
+	 */
+	public function set_maintenance_level($level)
+	{
+		do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
+		update_option(self::option_name_maintenance_mode, (int) $level);
+	}
+
+
+	/**
+	 * returns TRUE if M-Mode is engaged and the current request is not for the admin
+	 *
+	 * @return bool
+	 */
+	public static function disable_frontend_for_maintenance()
+	{
+		return (! is_admin() && EE_Maintenance_Mode::instance()->level());
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_assets_required_for_m_mode()
+	{
+		if (
+			$this->real_level() === EE_Maintenance_Mode::level_2_complete_maintenance
+			&& ! wp_script_is('espresso_core')
+		) {
+			wp_register_style(
+				'espresso_default',
+				EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				['dashicons'],
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('espresso_default');
+			wp_register_script(
+				'espresso_core',
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+				['jquery'],
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('espresso_core');
+		}
+	}
+
+
+	/**
+	 * replacement EE CPT template that displays message notifying site visitors
+	 * that EE has been temporarily placed into maintenance mode
+	 * does NOT get called on non-EE-CPT requests
+	 *
+	 * @return    string
+	 */
+	public static function template_include()
+	{
+		// shut 'er down for maintenance ? then don't use any of our templates for our endpoints
+		return get_template_directory() . '/index.php';
+	}
+
+
+	/**
+	 * displays message notifying site visitors that EE has been temporarily
+	 * placed into maintenance mode when post_type != EE CPT
+	 *
+	 * @param string $the_content
+	 * @return string
+	 */
+	public function the_content($the_content)
+	{
+		// check if M-mode is engaged and for EE shortcode
+		if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
+			// this can eventually be moved to a template, or edited via admin. But for now...
+			$the_content = sprintf(
+				esc_html__(
+					'%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
+					'event_espresso'
+				),
+				'<h3>',
+				'</h3><p>',
+				'</p>'
+			);
+		}
+		return $the_content;
+	}
+
+
+	/**
+	 * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
+	 */
+	public function display_maintenance_mode_notice()
+	{
+		/** @var CurrentPage $current_page */
+		$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		// check if M-mode is engaged and for EE shortcode
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& $this->real_level()
+			&& ! is_admin()
+			&& current_user_can('administrator')
+			&& $current_page->isEspressoPage()
+		) {
+			printf(
+				esc_html__(
+					'%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
+					'event_espresso'
+				),
+				'<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
+				'"><span class="dashicons dashicons-no"></span></a><p>',
+				' &raquo; <a href="' . add_query_arg(
+					['page' => 'espresso_maintenance_settings'],
+					admin_url('admin.php')
+				) . '">',
+				'</a></p></div>'
+			);
+		}
+	}
+	// espresso-notices important-notice ee-attention
+
+	/**
+	 * Redirects EE admin menu requests to the maintenance page
+	 */
+	public function redirect_to_maintenance()
+	{
+		global $pagenow;
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$page   = $request->getRequestParam('page');
+
+		if (
+			$pagenow == 'admin.php' && 
+			strpos($page, 'espresso_') !== false &&
+			$this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			wp_safe_redirect( 'admin.php?page=espresso_maintenance_settings' );
+			exit;
+		}
+	}
+
+
+	/**
+	 * override magic methods
+	 */
+	final public function __destruct()
+	{
+	}
+
+
+	final public function __call($a, $b)
+	{
+	}
+
+
+	final public function __get($a)
+	{
+	}
+
+
+	final public function __set($a, $b)
+	{
+	}
+
+
+	final public function __isset($a)
+	{
+	}
+
+
+	final public function __unset($a)
+	{
+	}
+
+
+	final public function __sleep()
+	{
+		return [];
+	}
+
+
+	final public function __wakeup()
+	{
+	}
+
+
+	final public function __invoke()
+	{
+	}
+
+
+	final public static function __set_state($a = null)
+	{
+		return EE_Maintenance_Mode::instance();
+	}
+
+
+	final public function __clone()
+	{
+	}
 
 
-    final public static function __callStatic($a, $b)
-    {
-    }
+	final public static function __callStatic($a, $b)
+	{
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -59,7 +59,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
+        if ( ! self::$_instance instanceof EE_Maintenance_Mode) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -186,7 +186,7 @@ 
      */
     public static function disable_frontend_for_maintenance()
     {
-        return (! is_admin() && EE_Maintenance_Mode::instance()->level());
+        return ( ! is_admin() && EE_Maintenance_Mode::instance()->level());
     }
 
 
@@ -201,14 +201,14 @@ 
         ) {
             wp_register_style(
                 'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+                EE_GLOBAL_ASSETS_URL.'css/espresso_default.css',
                 ['dashicons'],
                 EVENT_ESPRESSO_VERSION
             );
             wp_enqueue_style('espresso_default');
             wp_register_script(
                 'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+                EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
                 ['jquery'],
                 EVENT_ESPRESSO_VERSION,
                 true
@@ -228,7 +228,7 @@ 
     public static function template_include()
     {
         // shut 'er down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
+        return get_template_directory().'/index.php';
     }
 
 
@@ -280,10 +280,10 @@ 
                 ),
                 '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
                 '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
+                ' &raquo; <a href="'.add_query_arg(
                     ['page' => 'espresso_maintenance_settings'],
                     admin_url('admin.php')
-                ) . '">',
+                ).'">',
                 '</a></p></div>'
             );
         }
@@ -297,14 +297,14 @@ 
     {
         global $pagenow;
         $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page   = $request->getRequestParam('page');
+        $page = $request->getRequestParam('page');
 
         if (
             $pagenow == 'admin.php' && 
             strpos($page, 'espresso_') !== false &&
             $this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance
         ) {
-            wp_safe_redirect( 'admin.php?page=espresso_maintenance_settings' );
+            wp_safe_redirect('admin.php?page=espresso_maintenance_settings');
             exit;
         }
     }

core/domain/services/graphql/types/FormElement.php

Indentation +197 added lines, -197 removed lines

@@ -26,210 +26,210 @@
  */
 class FormElement extends TypeBase
 {
-    /**
-     * FormElement constructor.
-     *
-     * @param EEM_Form_Element $form_element_model
-     */
-    public function __construct(EEM_Form_Element $form_element_model)
-    {
-        $this->setName($this->namespace . 'FormElement');
-        $this->setDescription(__('A form element', 'event_espresso'));
-        $this->setIsCustomPostType(false);
+	/**
+	 * FormElement constructor.
+	 *
+	 * @param EEM_Form_Element $form_element_model
+	 */
+	public function __construct(EEM_Form_Element $form_element_model)
+	{
+		$this->setName($this->namespace . 'FormElement');
+		$this->setDescription(__('A form element', 'event_espresso'));
+		$this->setIsCustomPostType(false);
 
-        parent::__construct($form_element_model);
-    }
+		parent::__construct($form_element_model);
+	}
 
 
-    /**
-     * @return GraphQLFieldInterface[]
-     */
-    public function getFields(): array
-    {
-        $fields = [
-            new GraphQLField(
-                'id',
-                ['non_null' => 'ID'],
-                null,
-                esc_html__('The globally unique ID for the object.', 'event_espresso')
-            ),
-            new GraphQLField(
-                'adminOnly',
-                'Boolean',
-                'adminOnly',
-                esc_html__(
-                    'Whether or not the element is only displayed in the admin. If false, input will appear in public forms',
-                    'event_espresso'
-                )
-            ),
-            new GraphQLField(
-                'attributes',
-                'String',
-                'attributes',
-                esc_html__(
-                    'JSON string of HTML attributes such as class, max, min, placeholder, type, etc.',
-                    'event_espresso'
-                ),
-                [$this, 'toJson']
-            ),
-            new GraphQLField(
-                'belongsTo',
-                'String',
-                'belongsTo',
-                esc_html__('UUID of parent form section this form element belongs to.', 'event_espresso')
-            ),
-            new GraphQLField(
-                'helpText',
-                'String',
-                'helpText',
-                esc_html__(
-                    "JSON string of properties pertaining to any help text required for an input.",
-                    'event_espresso'
-                ),
-                [$this, 'toJson']
-            ),
-            new GraphQLField(
-                'label',
-                'String',
-                'label',
-                esc_html__(
-                    'JSON string of properties pertaining to an element\'s label.',
-                    'event_espresso'
-                ),
-                [$this, 'toJson']
-            ),
-            new GraphQLField(
-                'mapsTo',
-                'String',
-                'mapsTo',
-                esc_html__("Model and Fields name that this element maps to; ex: Attendee.email", 'event_espresso')
-            ),
-            new GraphQLField(
-                'options',
-                'String',
-                'options',
-                esc_html__(
-                    "JSON string of options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc.",
-                    'event_espresso'
-                ),
-                [$this, 'toJson']
-            ),
-            new GraphQLField(
-                'order',
-                'Int',
-                'order',
-                esc_html__('Order in which form element appears in a form.', 'event_espresso')
-            ),
-            new GraphQLField(
-                'required',
-                'String',
-                'required',
-                esc_html__(
-                    "properties pertaining to an input\'s required status and the validation text to display.",
-                    'event_espresso'
-                ),
-                [$this, 'toJson']
-            ),
-            new GraphQLField(
-                'status',
-                $this->namespace . 'FormStatusEnum',
-                'status',
-                esc_html__(
-                    'Whether form element is active, archived, trashed, or used as a default on new forms.',
-                    'event_espresso'
-                )
-            ),
-            new GraphQLField(
-                'type',
-                $this->namespace . 'ElementTypeEnum',
-                'type',
-                esc_html__('Form element type.', 'event_espresso')
-            ),
-            new GraphQLOutputField(
-                'wpUser',
-                'User',
-                null,
-                esc_html__('WP User that created this form element.', 'event_espresso')
-            ),
-            new GraphQLInputField(
-                'wpUser',
-                'ID',
-                null,
-                esc_html__('ID of the WP User that created the form element.', 'event_espresso')
-            ),
-        ];
+	/**
+	 * @return GraphQLFieldInterface[]
+	 */
+	public function getFields(): array
+	{
+		$fields = [
+			new GraphQLField(
+				'id',
+				['non_null' => 'ID'],
+				null,
+				esc_html__('The globally unique ID for the object.', 'event_espresso')
+			),
+			new GraphQLField(
+				'adminOnly',
+				'Boolean',
+				'adminOnly',
+				esc_html__(
+					'Whether or not the element is only displayed in the admin. If false, input will appear in public forms',
+					'event_espresso'
+				)
+			),
+			new GraphQLField(
+				'attributes',
+				'String',
+				'attributes',
+				esc_html__(
+					'JSON string of HTML attributes such as class, max, min, placeholder, type, etc.',
+					'event_espresso'
+				),
+				[$this, 'toJson']
+			),
+			new GraphQLField(
+				'belongsTo',
+				'String',
+				'belongsTo',
+				esc_html__('UUID of parent form section this form element belongs to.', 'event_espresso')
+			),
+			new GraphQLField(
+				'helpText',
+				'String',
+				'helpText',
+				esc_html__(
+					"JSON string of properties pertaining to any help text required for an input.",
+					'event_espresso'
+				),
+				[$this, 'toJson']
+			),
+			new GraphQLField(
+				'label',
+				'String',
+				'label',
+				esc_html__(
+					'JSON string of properties pertaining to an element\'s label.',
+					'event_espresso'
+				),
+				[$this, 'toJson']
+			),
+			new GraphQLField(
+				'mapsTo',
+				'String',
+				'mapsTo',
+				esc_html__("Model and Fields name that this element maps to; ex: Attendee.email", 'event_espresso')
+			),
+			new GraphQLField(
+				'options',
+				'String',
+				'options',
+				esc_html__(
+					"JSON string of options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc.",
+					'event_espresso'
+				),
+				[$this, 'toJson']
+			),
+			new GraphQLField(
+				'order',
+				'Int',
+				'order',
+				esc_html__('Order in which form element appears in a form.', 'event_espresso')
+			),
+			new GraphQLField(
+				'required',
+				'String',
+				'required',
+				esc_html__(
+					"properties pertaining to an input\'s required status and the validation text to display.",
+					'event_espresso'
+				),
+				[$this, 'toJson']
+			),
+			new GraphQLField(
+				'status',
+				$this->namespace . 'FormStatusEnum',
+				'status',
+				esc_html__(
+					'Whether form element is active, archived, trashed, or used as a default on new forms.',
+					'event_espresso'
+				)
+			),
+			new GraphQLField(
+				'type',
+				$this->namespace . 'ElementTypeEnum',
+				'type',
+				esc_html__('Form element type.', 'event_espresso')
+			),
+			new GraphQLOutputField(
+				'wpUser',
+				'User',
+				null,
+				esc_html__('WP User that created this form element.', 'event_espresso')
+			),
+			new GraphQLInputField(
+				'wpUser',
+				'ID',
+				null,
+				esc_html__('ID of the WP User that created the form element.', 'event_espresso')
+			),
+		];
 
-        return apply_filters(
-            'FHEE__EventEspresso_core_domain_services_graphql_types__form_element_fields',
-            $fields,
-            $this->name,
-            $this->model
-        );
-    }
+		return apply_filters(
+			'FHEE__EventEspresso_core_domain_services_graphql_types__form_element_fields',
+			$fields,
+			$this->name,
+			$this->model
+		);
+	}
 
 
-    /**
-     * @param array $inputFields The mutation input fields.
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws Exception
-     * @since $VID:$
-     */
-    public function registerMutations(array $inputFields)
-    {
-        // Register mutation to update an entity.
-        register_graphql_mutation(
-            'update' . $this->name(),
-            [
-                'inputFields'         => $inputFields,
-                'outputFields'        => [
-                    lcfirst($this->name()) => [
-                        'type'    => $this->name(),
-                        'resolve' => [$this, 'resolveFromPayload'],
-                    ],
-                ],
-                'mutateAndGetPayload' => FormElementUpdate::mutateAndGetPayload($this->model),
-            ]
-        );
-        // Register mutation to delete an entity.
-        register_graphql_mutation(
-            'delete' . $this->name(),
-            [
-                'inputFields'         => [
-                    'id' => $inputFields['id'],
-                ],
-                'outputFields'        => [
-                    lcfirst($this->name()) => [
-                        'type'        => $this->name(),
-                        'description' => esc_html__('The object before it was deleted', 'event_espresso'),
-                        'resolve'     => static function ($payload) {
-                            $deleted = (object) $payload['deleted'];
+	/**
+	 * @param array $inputFields The mutation input fields.
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 * @since $VID:$
+	 */
+	public function registerMutations(array $inputFields)
+	{
+		// Register mutation to update an entity.
+		register_graphql_mutation(
+			'update' . $this->name(),
+			[
+				'inputFields'         => $inputFields,
+				'outputFields'        => [
+					lcfirst($this->name()) => [
+						'type'    => $this->name(),
+						'resolve' => [$this, 'resolveFromPayload'],
+					],
+				],
+				'mutateAndGetPayload' => FormElementUpdate::mutateAndGetPayload($this->model),
+			]
+		);
+		// Register mutation to delete an entity.
+		register_graphql_mutation(
+			'delete' . $this->name(),
+			[
+				'inputFields'         => [
+					'id' => $inputFields['id'],
+				],
+				'outputFields'        => [
+					lcfirst($this->name()) => [
+						'type'        => $this->name(),
+						'description' => esc_html__('The object before it was deleted', 'event_espresso'),
+						'resolve'     => static function ($payload) {
+							$deleted = (object) $payload['deleted'];
 
-                            return ! empty($deleted) ? $deleted : null;
-                        },
-                    ],
-                ],
-                'mutateAndGetPayload' => FormElementDelete::mutateAndGetPayload($this->model),
-            ]
-        );
+							return ! empty($deleted) ? $deleted : null;
+						},
+					],
+				],
+				'mutateAndGetPayload' => FormElementDelete::mutateAndGetPayload($this->model),
+			]
+		);
 
-        // Make element 'type' a required field for create mutations
-        // Yes it's "['type']['type']" 

core/db_classes/EE_Currency_Payment_Method.class.php

Indentation +27 added lines, -27 removed lines

@@ -11,33 +11,33 @@
  */
 class EE_Currency_Payment_Method extends EE_Base_Class
 {
-    /**
-     * @param array $props_n_values           incoming values
-     * @param null  $timezone                 incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array $date_formats             incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Currency_Payment_Method
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ?: new self($props_n_values, false, $timezone, $date_formats);
-    }
+	/**
+	 * @param array $props_n_values           incoming values
+	 * @param null  $timezone                 incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array $date_formats             incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Currency_Payment_Method
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ?: new self($props_n_values, false, $timezone, $date_formats);
+	}
 
 
-    /**
-     * @param array $props_n_values   incoming values from the database
-     * @param null  $timezone         incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Currency_Payment_Method
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array $props_n_values   incoming values from the database
+	 * @param null  $timezone         incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Currency_Payment_Method
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/data_migration_scripts/EE_DMS_Core_5_0_0.dms.php

Indentation +263 added lines, -263 removed lines

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

core/services/database/TableManager.php

Indentation +239 added lines, -239 removed lines

@@ -16,264 +16,264 @@
  */
 class TableManager extends EE_Base
 {
-    private ?TableAnalysis $table_analysis;
+	private ?TableAnalysis $table_analysis;
 
 
-    /**
-     * TableManager constructor.
-     *
-     * @param TableAnalysis $TableAnalysis
-     */
-    public function __construct(TableAnalysis $TableAnalysis)
-    {
-        $this->table_analysis = $TableAnalysis;
-    }
+	/**
+	 * TableManager constructor.
+	 *
+	 * @param TableAnalysis $TableAnalysis
+	 */
+	public function __construct(TableAnalysis $TableAnalysis)
+	{
+		$this->table_analysis = $TableAnalysis;
+	}
 
 
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function getTableAnalysis(): ?TableAnalysis
-    {
-        if ($this->table_analysis instanceof TableAnalysis) {
-            return $this->table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function getTableAnalysis(): ?TableAnalysis
+	{
+		if ($this->table_analysis instanceof TableAnalysis) {
+			return $this->table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
-     * @param string $column_name
-     * @param string $column_info
-     * @return bool|false|int
-     * @throws EE_Error
-     */
-    public function addColumn(string $table_name, string $column_name, string $column_info = 'INT UNSIGNED NOT NULL')
-    {
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $columns         = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
-            $alter_query = "ALTER TABLE $full_table_name ADD $column_name $column_info";
-            return $wpdb->query($alter_query);
-        }
-        return true;
-    }
+	/**
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
+	 * @param string $column_name
+	 * @param string $column_info
+	 * @return bool|false|int
+	 * @throws EE_Error
+	 */
+	public function addColumn(string $table_name, string $column_name, string $column_info = 'INT UNSIGNED NOT NULL')
+	{
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$columns         = $this->getTableColumns($table_name);
+		if (! in_array($column_name, $columns)) {
+			$alter_query = "ALTER TABLE $full_table_name ADD $column_name $column_info";
+			return $wpdb->query($alter_query);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the name of all columns on the  table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @return array
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     */
-    public function getTableColumns(string $table_name): array
-    {
-        global $wpdb;
-        $table_name  = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $field_array = [];
-        if (! empty($table_name)) {
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM $table_name ");
-            if ($columns !== false) {
-                foreach ($columns as $column) {
-                    $field_array[] = $column->Field;
-                }
-            }
-        }
-        return $field_array;
-    }
+	/**
+	 * Gets the name of all columns on the  table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @return array
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 */
+	public function getTableColumns(string $table_name): array
+	{
+		global $wpdb;
+		$table_name  = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$field_array = [];
+		if (! empty($table_name)) {
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM $table_name ");
+			if ($columns !== false) {
+				foreach ($columns as $column) {
+					$field_array[] = $column->Field;
+				}
+			}
+		}
+		return $field_array;
+	}
 
 
-    /**
-     * Drops the specified table from the database. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @return bool|int
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     */
-    public function dropTable(string $table_name)
-    {
-        global $wpdb;
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            return $wpdb->query("DROP TABLE IF EXISTS $table_name");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified table from the database. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 */
+	public function dropTable(string $table_name)
+	{
+		global $wpdb;
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			return $wpdb->query("DROP TABLE IF EXISTS $table_name");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @param string[] $table_names
-     * @return array of table names which we deleted
-     * @throws EE_Error
-     * @global WPDB    $wpdb
-     */
-    public function dropTables(array $table_names): array
-    {
-        $tables_to_delete = [];
-        foreach ($table_names as $table_name) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
-            }
-        }
-        if (! empty($tables_to_delete)) {
-            global $wpdb;
-            // make sure we only have a unique strings in the array.
-            $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
-        }
-        return $tables_to_delete;
-    }
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @param string[] $table_names
+	 * @return array of table names which we deleted
+	 * @throws EE_Error
+	 * @global WPDB    $wpdb
+	 */
+	public function dropTables(array $table_names): array
+	{
+		$tables_to_delete = [];
+		foreach ($table_names as $table_name) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
+				$tables_to_delete[ $table_name ] = $table_name;
+			}
+		}
+		if (! empty($tables_to_delete)) {
+			global $wpdb;
+			// make sure we only have a unique strings in the array.
+			$tables_to_delete = array_unique($tables_to_delete);
+			$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+		}
+		return $tables_to_delete;
+	}
 
 
-    /**
-     * Drops the specified index from the specified table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $index_name
-     * @return bool|int the number of indexes dropped. False if there was a datbase error
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     */
-    public function dropIndex(string $table_name, string $index_name)
-    {
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
-            return 0;
-        }
-        global $wpdb;
-        $table_name         = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM $table_name WHERE key_name = '$index_name'";
-        if (
-            $this->getTableAnalysis()->tableExists($table_name)
-            && $wpdb->get_var($index_exists_query)
-               === $table_name // using get_var with the $index_exists_query returns the table's name
-        ) {
-            return $wpdb->query("ALTER TABLE $table_name DROP INDEX $index_name");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified index from the specified table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return bool|int the number of indexes dropped. False if there was a datbase error
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 */
+	public function dropIndex(string $table_name, string $index_name)
+	{
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
+			return 0;
+		}
+		global $wpdb;
+		$table_name         = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM $table_name WHERE key_name = '$index_name'";
+		if (
+			$this->getTableAnalysis()->tableExists($table_name)
+			&& $wpdb->get_var($index_exists_query)
+			   === $table_name // using get_var with the $index_exists_query returns the table's name
+		) {
+			return $wpdb->query("ALTER TABLE $table_name DROP INDEX $index_name");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Just creates the requested table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $create_sql defining the table's columns and indexes
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
-     * @return void
-     * @throws EE_Error
-     */
-    public function createTable(string $table_name, string $create_sql, string $engine = 'MyISAM')
-    {
-        $engine = apply_filters(
-            'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
-            $engine,
-            $table_name,
-            $create_sql
-        );
-        // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
-        if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            /** @var wpdb $wpdb */
-            global $wpdb;
-            $SQL = "CREATE TABLE $table_name ( $create_sql ) ENGINE=$engine " . $wpdb->get_charset_collate();
+	/**
+	 * Just creates the requested table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $create_sql defining the table's columns and indexes
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function createTable(string $table_name, string $create_sql, string $engine = 'MyISAM')
+	{
+		$engine = apply_filters(
+			'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
+			$engine,
+			$table_name,
+			$create_sql
+		);
+		// does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
+		if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			/** @var wpdb $wpdb */
+			global $wpdb;
+			$SQL = "CREATE TABLE $table_name ( $create_sql ) ENGINE=$engine " . $wpdb->get_charset_collate();
 
-            // get $wpdb to echo errors, but buffer them. This way at least WE know an error
-            // happened. And then we can choose to tell the end user
-            $old_show_errors_policy       = $wpdb->show_errors();
-            $old_error_suppression_policy = $wpdb->suppress_errors(false);
+			// get $wpdb to echo errors, but buffer them. This way at least WE know an error
+			// happened. And then we can choose to tell the end user
+			$old_show_errors_policy       = $wpdb->show_errors();
+			$old_error_suppression_policy = $wpdb->suppress_errors(false);
 
-            if (! function_exists('dbDelta')) {
-                require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
-            }
+			if (! function_exists('dbDelta')) {
+				require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+			}
 
-            ob_start();
-            dbDelta($SQL);
-            $output = ob_get_contents();
-            ob_end_clean();
-            $wpdb->show_errors($old_show_errors_policy);
-            $wpdb->suppress_errors($old_error_suppression_policy);
-            if (! empty($output)) {
-                throw new EE_Error($output);
-            }
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $create_sql
-                )
-            );
-        }
-    }
+			ob_start();
+			dbDelta($SQL);
+			$output = ob_get_contents();
+			ob_end_clean();
+			$wpdb->show_errors($old_show_errors_policy);
+			$wpdb->suppress_errors($old_error_suppression_policy);
+			if (! empty($output)) {
+				throw new EE_Error($output);
+			}
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$create_sql
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Drops the specified index if it's size differs from $desired_index_size.
-     * WordPress' dbdelta method doesn't automatically change index sizes, so this
-     * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
-     * If the table doesn't exist, or it exists but the index does not, or returns false
-     *
-     * @param string     $table_name
-     * @param string     $index_name
-     * @param string     $column_name        if none is provided, we assume the column name matches the index
-     *                                       (often true in EE)
-     * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
-     * @return bool whether an index was dropped or not
-     * @throws /EE_Error if table analysis object isn't defined
-     */
-    public function dropIndexIfSizeNot(
-        string $table_name,
-        string $index_name,
-        string $column_name = '',
-        $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
-    ) {
-        if ($column_name === '') {
-            $column_name = $index_name;
-        }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
-            return false;
-        }
-        $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
-        if (empty($index_entries)) {
-            return false;
-        }
-        foreach ($index_entries as $index_entry) {
-            if (
-                $column_name === $index_entry->Column_name
-                && (string)$desired_index_size !== $index_entry->Sub_part
-            ) {
-                return $this->dropIndex($table_name, $index_name);
-            }
-        }
-        return false;
-    }
+	/**
+	 * Drops the specified index if it's size differs from $desired_index_size.
+	 * WordPress' dbdelta method doesn't automatically change index sizes, so this
+	 * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
+	 * If the table doesn't exist, or it exists but the index does not, or returns false
+	 *
+	 * @param string     $table_name
+	 * @param string     $index_name
+	 * @param string     $column_name        if none is provided, we assume the column name matches the index
+	 *                                       (often true in EE)
+	 * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
+	 * @return bool whether an index was dropped or not
+	 * @throws /EE_Error if table analysis object isn't defined
+	 */
+	public function dropIndexIfSizeNot(
+		string $table_name,
+		string $index_name,
+		string $column_name = '',
+		$desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
+	) {
+		if ($column_name === '') {
+			$column_name = $index_name;
+		}
+		if (! $this->getTableAnalysis()->tableExists($table_name)) {
+			return false;
+		}
+		$index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
+		if (empty($index_entries)) {
+			return false;
+		}
+		foreach ($index_entries as $index_entry) {
+			if (
+				$column_name === $index_entry->Column_name
+				&& (string)$desired_index_size !== $index_entry->Sub_part
+			) {
+				return $this->dropIndex($table_name, $index_name);
+			}
+		}
+		return false;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -66,7 +66,7 @@ 
         global $wpdb;
         $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
         $columns         = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
+        if ( ! in_array($column_name, $columns)) {
             $alter_query = "ALTER TABLE $full_table_name ADD $column_name $column_info";
             return $wpdb->query($alter_query);
         }
@@ -88,7 +88,7 @@ 
         global $wpdb;
         $table_name  = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
         $field_array = [];
-        if (! empty($table_name)) {
+        if ( ! empty($table_name)) {
             $columns = $wpdb->get_results("SHOW COLUMNS FROM $table_name ");
             if ($columns !== false) {
                 foreach ($columns as $column) {
@@ -136,14 +136,14 @@ 
         foreach ($table_names as $table_name) {
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
+                $tables_to_delete[$table_name] = $table_name;
             }
         }
-        if (! empty($tables_to_delete)) {
+        if ( ! empty($tables_to_delete)) {
             global $wpdb;
             // make sure we only have a unique strings in the array.
             $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+            $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete));
         }
         return $tables_to_delete;
     }
@@ -201,15 +201,15 @@ 
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             /** @var wpdb $wpdb */
             global $wpdb;
-            $SQL = "CREATE TABLE $table_name ( $create_sql ) ENGINE=$engine " . $wpdb->get_charset_collate();
+            $SQL = "CREATE TABLE $table_name ( $create_sql ) ENGINE=$engine ".$wpdb->get_charset_collate();
 
             // get $wpdb to echo errors, but buffer them. This way at least WE know an error
             // happened. And then we can choose to tell the end user
             $old_show_errors_policy       = $wpdb->show_errors();
             $old_error_suppression_policy = $wpdb->suppress_errors(false);
 
-            if (! function_exists('dbDelta')) {
-                require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+            if ( ! function_exists('dbDelta')) {
+                require_once(ABSPATH.'wp-admin/includes/upgrade.php');
             }
 
             ob_start();
@@ -218,7 +218,7 @@ 
             ob_end_clean();
             $wpdb->show_errors($old_show_errors_policy);
             $wpdb->suppress_errors($old_error_suppression_policy);
-            if (! empty($output)) {
+            if ( ! empty($output)) {
                 throw new EE_Error($output);
             }
         } else {
@@ -259,7 +259,7 @@ 
         if ($column_name === '') {
             $column_name = $index_name;
         }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
+        if ( ! $this->getTableAnalysis()->tableExists($table_name)) {
             return false;
         }
         $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
@@ -269,7 +269,7 @@ 
         foreach ($index_entries as $index_entry) {
             if (
                 $column_name === $index_entry->Column_name
-                && (string)$desired_index_size !== $index_entry->Sub_part
+                && (string) $desired_index_size !== $index_entry->Sub_part
             ) {
                 return $this->dropIndex($table_name, $index_name);
             }