eventespresso / event-espresso-core

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Indentation +407 added lines, -407 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -17,407 +17,407 @@ 
 class EE_Payment_Method_Manager
 {
 
-    /**
-     *    instance of the EE_Payment_Method_Manager object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var array keys are classnames without 'EE_PMT_', values are their filepaths
-     */
-    protected $_payment_method_types = array();
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Payment_Method_Manager instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
-            self::$_instance = new self();
-        }
-        EE_Registry::instance()->load_lib('PMT_Base');
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * Resets the instance and returns a new one
-     *
-     * @return EE_Payment_Method_Manager
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-
-    /**
-     * If necessary, re-register payment methods
-     *
-     * @param boolean $force_recheck whether to recheck for payment method types,
-     *                               or just re-use the PMTs we found last time we checked during this request (if
-     *                               we have not yet checked during this request, then we need to check anyways)
-     */
-    public function maybe_register_payment_methods($force_recheck = false)
-    {
-        if ( ! $this->_payment_method_types || $force_recheck) {
-            $this->_register_payment_methods();
-            //if in admin lets ensure caps are set.
-            if (is_admin()) {
-                add_filter('FHEE__EE_Capabilities__init_caps_map__caps', array($this, 'add_payment_method_caps'));
-                EE_Registry::instance()->CAP->init_caps();
-            }
-        }
-    }
-
-
-
-    /**
-     *        register_payment_methods
-     *
-     * @return array
-     */
-    protected function _register_payment_methods()
-    {
-        // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $pm_to_register = apply_filters('FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            $pm_to_register);
-        // loop through folders
-        foreach ($pm_to_register as $pm_path) {
-            $this->register_payment_method($pm_path);
-        }
-        do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
-        // filter list of installed modules
-        //keep them organized alphabetically by the payment method type's name
-        ksort($this->_payment_method_types);
-        return apply_filters('FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
-            $this->_payment_method_types);
-    }
-
-
-
-    /**
-     *    register_payment_method- makes core aware of this payment method
-     *
-     * @access public
-     * @param string $payment_method_path - full path up to and including payment method folder
-     * @return boolean
-     */
-    public function register_payment_method($payment_method_path = '')
-    {
-        do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
-        $module_ext = '.pm.php';
-        // make all separators match
-        $payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
-        // grab and sanitize module name
-        $module_dir = basename($payment_method_path);
-        // create classname from module directory name
-        $module = str_replace(' ', '_', str_replace('_', ' ', $module_dir));
-        // add class prefix
-        $module_class = 'EE_PMT_' . $module;
-        // does the module exist ?
-        if ( ! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
-            $msg = sprintf(__('The requested %s payment method file could not be found or is not readable due to file permissions.',
-                'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (WP_DEBUG === true) {
-            EEH_Debug_Tools::instance()->start_timer();
-        }
-        // load the module class file
-        require_once($payment_method_path . DS . $module_class . $module_ext);
-        if (WP_DEBUG === true) {
-            EEH_Debug_Tools::instance()->stop_timer("Requiring payment method $module_class");
-        }
-        // verify that class exists
-        if ( ! class_exists($module_class)) {
-            $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        $this->_payment_method_types[$module] = $payment_method_path . DS . $module_class . $module_ext;
-        return true;
-    }
-
-
-
-    /**
-     * Checks if a payment method has been registered, and if so includes it
-     *
-     * @param string  $payment_method_name like 'Paypal_Pro', (ie classname without the prefix 'EEPM_')
-     * @param boolean $force_recheck       whether to force re-checking for new payment method types
-     * @return boolean
-     */
-    public function payment_method_type_exists($payment_method_name, $force_recheck = false)
-    {
-        if (
-            $force_recheck
-            || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[$payment_method_name])
-        ) {
-            $this->maybe_register_payment_methods($force_recheck);
-        }
-        if (isset($this->_payment_method_types[$payment_method_name])) {
-            require_once($this->_payment_method_types[$payment_method_name]);
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Returns all the classnames of the various payment method types
-     *
-     * @param boolean $with_prefixes TRUE: get payment method type classnames; false just their 'names'
-     *                               (what you'd find in wp_esp_payment_method.PMD_type)
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return array
-     */
-    public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        if ($with_prefixes) {
-            $classnames = array_keys($this->_payment_method_types);
-            $payment_methods = array();
-            foreach ($classnames as $classname) {
-                $payment_methods[] = $this->payment_method_class_from_type($classname);
-            }
-            return $payment_methods;
-        } else {
-            return array_keys($this->_payment_method_types);
-        }
-    }
-
-
-
-    /**
-     * Gets an object of each payment method type, none of which are bound to a
-     * payment method instance
-     *
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return EE_PMT_Base[]
-     */
-    public function payment_method_types($force_recheck = false)
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        $pmt_objs = array();
-        foreach ($this->payment_method_type_names(true) as $classname) {
-            $pmt_objs[] = new $classname;
-        }
-        return $pmt_objs;
-    }
-
-
-
-    /**
-     * Changes the payment method's classname into the payment method type's name
-     * (as used on the payment method's table's PMD_type field)
-     *
-     * @param string $classname
-     * @return string
-     */
-    public function payment_method_type_sans_class_prefix($classname)
-    {
-        return str_replace("EE_PMT_", "", $classname);
-    }
-
-
-
-    /**
-     * Does the opposite of payment-method_type_sans_prefix
-     *
-     * @param string $type
-     * @return string
-     */
-    public function payment_method_class_from_type($type)
-    {
-        $this->maybe_register_payment_methods();
-        return "EE_PMT_" . $type;
-    }
-
-
-
-    /**
-     * Activates a payment method of the given type.
-     *
-     * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
-     * @return \EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public function activate_a_payment_method_of_type($payment_method_type)
-    {
-        $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if ( ! $payment_method instanceof EE_Payment_Method) {
-            $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-            if (class_exists($pm_type_class)) {
-                /** @var $pm_type_obj EE_PMT_Base */
-                $pm_type_obj = new $pm_type_class;
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if ( ! $payment_method) {
-                    $payment_method = $this->create_payment_method_of_type($pm_type_obj);
-                }
-                $payment_method->set_type($payment_method_type);
-                $this->initialize_payment_method($payment_method);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __('There is no payment method of type %1$s, so it could not be activated', 'event_espresso'),
-                        $pm_type_class)
-                );
-            }
-        }
-        $payment_method->set_active();
-        $payment_method->save();
-        if ($payment_method->type() === 'Invoice') {
-            /** @type EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $message_resource_manager->ensure_message_type_is_active('invoice', 'html');
-            $message_resource_manager->ensure_messenger_is_active('pdf');
-            EE_Error::add_persistent_admin_notice(
-                'invoice_pm_requirements_notice',
-                sprintf(
-                    __('The Invoice payment method has been activated. It requires the invoice message type, html messenger, and pdf messenger be activated as well for the %1$smessages system%2$s, so it has been automatically verified that they are also active.',
-                        'event_espresso'),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages') . '">',
-                    '</a>'
-                ),
-                true
-            );
-        }
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Creates a payment method of the specified type. Does not save it.
-     *
-     * @global WP_User    $current_user
-     * @param EE_PMT_Base $pm_type_obj
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public function create_payment_method_of_type($pm_type_obj)
-    {
-        global $current_user;
-        $payment_method = EE_Payment_Method::new_instance(
-            array(
-                'PMD_type'       => $pm_type_obj->system_name(),
-                'PMD_name'       => $pm_type_obj->pretty_name(),
-                'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),//automatically converted to slug
-                'PMD_wp_user'    => $current_user->ID,
-                'PMD_order'      => EEM_Payment_Method::instance()->count(
-                        array(array('PMD_type' => array('!=', 'Admin_Only')))
-                    ) * 10,
-            )
-        );
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Sets the initial payment method properties (including extra meta)
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public function initialize_payment_method($payment_method)
-    {
-        $pm_type_obj = $payment_method->type_obj();
-        $payment_method->set_description($pm_type_obj->default_description());
-        if ( ! $payment_method->button_url()) {
-            $payment_method->set_button_url($pm_type_obj->default_button_url());
-        }
-        //now add setup its default extra meta properties
-        $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if ( ! empty($extra_metas)) {
-            //verify the payment method has an ID before adding extra meta
-            if ( ! $payment_method->ID()) {
-                $payment_method->save();
-            }
-            foreach ($extra_metas as $meta_name => $input) {
-                $payment_method->update_extra_meta($meta_name, $input->raw_value());
-            }
-        }
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Makes sure the payment method is related to the specified payment method
-     * @deprecated in 4.9.40 because the currency payment method table is being deprecated
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public function set_usable_currencies_on_payment_method($payment_method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
-                esc_html__('We no longer define what currencies are usable by payment methods. Its not used nor efficient.', 'event_espresso'),
-            '4.9.40');
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Deactivates a payment method of the given payment method slug.
-     *
-     * @param string $payment_method_slug The slug for the payment method to deactivate.
-     * @return int count of rows updated.
-     */
-    public function deactivate_payment_method($payment_method_slug)
-    {
-        EE_Log::instance()->log(
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                __('Payment method with slug %1$s is being deactivated by site admin', 'event_espresso'),
-                $payment_method_slug
-            ),
-            'payment_method_change'
-        );
-        $count_updated = EEM_Payment_Method::instance()->update(
-            array('PMD_scope' => array()),
-            array(array('PMD_slug' => $payment_method_slug))
-        );
-        return $count_updated;
-    }
-
-
-
-    /**
-     * callback for FHEE__EE_Capabilities__init_caps_map__caps filter to add dynamic payment method
-     * access caps.
-     *
-     * @param array $caps capabilities being filtered
-     * @return array
-     */
-    public function add_payment_method_caps($caps)
-    {
-        /* add dynamic caps from payment methods
+	/**
+	 *    instance of the EE_Payment_Method_Manager object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array keys are classnames without 'EE_PMT_', values are their filepaths
+	 */
+	protected $_payment_method_types = array();
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Payment_Method_Manager instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
+			self::$_instance = new self();
+		}
+		EE_Registry::instance()->load_lib('PMT_Base');
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * Resets the instance and returns a new one
+	 *
+	 * @return EE_Payment_Method_Manager
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+
+	/**
+	 * If necessary, re-register payment methods
+	 *
+	 * @param boolean $force_recheck whether to recheck for payment method types,
+	 *                               or just re-use the PMTs we found last time we checked during this request (if
+	 *                               we have not yet checked during this request, then we need to check anyways)
+	 */
+	public function maybe_register_payment_methods($force_recheck = false)
+	{
+		if ( ! $this->_payment_method_types || $force_recheck) {
+			$this->_register_payment_methods();
+			//if in admin lets ensure caps are set.
+			if (is_admin()) {
+				add_filter('FHEE__EE_Capabilities__init_caps_map__caps', array($this, 'add_payment_method_caps'));
+				EE_Registry::instance()->CAP->init_caps();
+			}
+		}
+	}
+
+
+
+	/**
+	 *        register_payment_methods
+	 *
+	 * @return array
+	 */
+	protected function _register_payment_methods()
+	{
+		// grab list of installed modules
+		$pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$pm_to_register = apply_filters('FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			$pm_to_register);
+		// loop through folders
+		foreach ($pm_to_register as $pm_path) {
+			$this->register_payment_method($pm_path);
+		}
+		do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
+		// filter list of installed modules
+		//keep them organized alphabetically by the payment method type's name
+		ksort($this->_payment_method_types);
+		return apply_filters('FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
+			$this->_payment_method_types);
+	}
+
+
+
+	/**
+	 *    register_payment_method- makes core aware of this payment method
+	 *
+	 * @access public
+	 * @param string $payment_method_path - full path up to and including payment method folder
+	 * @return boolean
+	 */
+	public function register_payment_method($payment_method_path = '')
+	{
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
+		$module_ext = '.pm.php';
+		// make all separators match
+		$payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
+		// grab and sanitize module name
+		$module_dir = basename($payment_method_path);
+		// create classname from module directory name
+		$module = str_replace(' ', '_', str_replace('_', ' ', $module_dir));
+		// add class prefix
+		$module_class = 'EE_PMT_' . $module;
+		// does the module exist ?
+		if ( ! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
+			$msg = sprintf(__('The requested %s payment method file could not be found or is not readable due to file permissions.',
+				'event_espresso'), $module);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (WP_DEBUG === true) {
+			EEH_Debug_Tools::instance()->start_timer();
+		}
+		// load the module class file
+		require_once($payment_method_path . DS . $module_class . $module_ext);
+		if (WP_DEBUG === true) {
+			EEH_Debug_Tools::instance()->stop_timer("Requiring payment method $module_class");
+		}
+		// verify that class exists
+		if ( ! class_exists($module_class)) {
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		$this->_payment_method_types[$module] = $payment_method_path . DS . $module_class . $module_ext;
+		return true;
+	}
+
+
+
+	/**
+	 * Checks if a payment method has been registered, and if so includes it
+	 *
+	 * @param string  $payment_method_name like 'Paypal_Pro', (ie classname without the prefix 'EEPM_')
+	 * @param boolean $force_recheck       whether to force re-checking for new payment method types
+	 * @return boolean
+	 */
+	public function payment_method_type_exists($payment_method_name, $force_recheck = false)
+	{
+		if (
+			$force_recheck
+			|| ! is_array($this->_payment_method_types)
+			|| ! isset($this->_payment_method_types[$payment_method_name])
+		) {
+			$this->maybe_register_payment_methods($force_recheck);
+		}
+		if (isset($this->_payment_method_types[$payment_method_name])) {
+			require_once($this->_payment_method_types[$payment_method_name]);
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Returns all the classnames of the various payment method types
+	 *
+	 * @param boolean $with_prefixes TRUE: get payment method type classnames; false just their 'names'
+	 *                               (what you'd find in wp_esp_payment_method.PMD_type)
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return array
+	 */
+	public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		if ($with_prefixes) {
+			$classnames = array_keys($this->_payment_method_types);
+			$payment_methods = array();
+			foreach ($classnames as $classname) {
+				$payment_methods[] = $this->payment_method_class_from_type($classname);
+			}
+			return $payment_methods;
+		} else {
+			return array_keys($this->_payment_method_types);
+		}
+	}
+
+
+
+	/**
+	 * Gets an object of each payment method type, none of which are bound to a
+	 * payment method instance
+	 *
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return EE_PMT_Base[]
+	 */
+	public function payment_method_types($force_recheck = false)
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		$pmt_objs = array();
+		foreach ($this->payment_method_type_names(true) as $classname) {
+			$pmt_objs[] = new $classname;
+		}
+		return $pmt_objs;
+	}
+
+
+
+	/**
+	 * Changes the payment method's classname into the payment method type's name
+	 * (as used on the payment method's table's PMD_type field)
+	 *
+	 * @param string $classname
+	 * @return string
+	 */
+	public function payment_method_type_sans_class_prefix($classname)
+	{
+		return str_replace("EE_PMT_", "", $classname);
+	}
+
+
+
+	/**
+	 * Does the opposite of payment-method_type_sans_prefix
+	 *
+	 * @param string $type
+	 * @return string
+	 */
+	public function payment_method_class_from_type($type)
+	{
+		$this->maybe_register_payment_methods();
+		return "EE_PMT_" . $type;
+	}
+
+
+
+	/**
+	 * Activates a payment method of the given type.
+	 *
+	 * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
+	 * @return \EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public function activate_a_payment_method_of_type($payment_method_type)
+	{
+		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
+		if ( ! $payment_method instanceof EE_Payment_Method) {
+			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
+			if (class_exists($pm_type_class)) {
+				/** @var $pm_type_obj EE_PMT_Base */
+				$pm_type_obj = new $pm_type_class;
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
+				if ( ! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
+				}
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__('There is no payment method of type %1$s, so it could not be activated', 'event_espresso'),
+						$pm_type_class)
+				);
+			}
+		}
+		$payment_method->set_active();
+		$payment_method->save();
+		if ($payment_method->type() === 'Invoice') {
+			/** @type EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->ensure_message_type_is_active('invoice', 'html');
+			$message_resource_manager->ensure_messenger_is_active('pdf');
+			EE_Error::add_persistent_admin_notice(
+				'invoice_pm_requirements_notice',
+				sprintf(
+					__('The Invoice payment method has been activated. It requires the invoice message type, html messenger, and pdf messenger be activated as well for the %1$smessages system%2$s, so it has been automatically verified that they are also active.',
+						'event_espresso'),
+					'<a href="' . admin_url('admin.php?page=espresso_messages') . '">',
+					'</a>'
+				),
+				true
+			);
+		}
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Creates a payment method of the specified type. Does not save it.
+	 *
+	 * @global WP_User    $current_user
+	 * @param EE_PMT_Base $pm_type_obj
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public function create_payment_method_of_type($pm_type_obj)
+	{
+		global $current_user;
+		$payment_method = EE_Payment_Method::new_instance(
+			array(
+				'PMD_type'       => $pm_type_obj->system_name(),
+				'PMD_name'       => $pm_type_obj->pretty_name(),
+				'PMD_admin_name' => $pm_type_obj->pretty_name(),
+				'PMD_slug'       => $pm_type_obj->system_name(),//automatically converted to slug
+				'PMD_wp_user'    => $current_user->ID,
+				'PMD_order'      => EEM_Payment_Method::instance()->count(
+						array(array('PMD_type' => array('!=', 'Admin_Only')))
+					) * 10,
+			)
+		);
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Sets the initial payment method properties (including extra meta)
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public function initialize_payment_method($payment_method)
+	{
+		$pm_type_obj = $payment_method->type_obj();
+		$payment_method->set_description($pm_type_obj->default_description());
+		if ( ! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
+		}
+		//now add setup its default extra meta properties
+		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
+		if ( ! empty($extra_metas)) {
+			//verify the payment method has an ID before adding extra meta
+			if ( ! $payment_method->ID()) {
+				$payment_method->save();
+			}
+			foreach ($extra_metas as $meta_name => $input) {
+				$payment_method->update_extra_meta($meta_name, $input->raw_value());
+			}
+		}
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Makes sure the payment method is related to the specified payment method
+	 * @deprecated in 4.9.40 because the currency payment method table is being deprecated
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public function set_usable_currencies_on_payment_method($payment_method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
+				esc_html__('We no longer define what currencies are usable by payment methods. Its not used nor efficient.', 'event_espresso'),
+			'4.9.40');
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Deactivates a payment method of the given payment method slug.
+	 *
+	 * @param string $payment_method_slug The slug for the payment method to deactivate.
+	 * @return int count of rows updated.
+	 */
+	public function deactivate_payment_method($payment_method_slug)
+	{
+		EE_Log::instance()->log(
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				__('Payment method with slug %1$s is being deactivated by site admin', 'event_espresso'),
+				$payment_method_slug
+			),
+			'payment_method_change'
+		);
+		$count_updated = EEM_Payment_Method::instance()->update(
+			array('PMD_scope' => array()),
+			array(array('PMD_slug' => $payment_method_slug))
+		);
+		return $count_updated;
+	}
+
+
+
+	/**
+	 * callback for FHEE__EE_Capabilities__init_caps_map__caps filter to add dynamic payment method
+	 * access caps.
+	 *
+	 * @param array $caps capabilities being filtered
+	 * @return array
+	 */
+	public function add_payment_method_caps($caps)
+	{
+		/* add dynamic caps from payment methods
          * at the time of writing, october 20 2014, these are the caps added:
          * ee_payment_method_admin_only
          * ee_payment_method_aim
@@ -431,10 +431,10 @@ 
          * their related capability automatically added too, so long as they are
          * registered properly using EE_Register_Payment_Method::register()
          */
-        foreach ($this->payment_method_types() as $payment_method_type_obj) {
-            $caps['administrator'][] = $payment_method_type_obj->cap_name();
-        }
-        return $caps;
-    }
+		foreach ($this->payment_method_types() as $payment_method_type_obj) {
+			$caps['administrator'][] = $payment_method_type_obj->cap_name();
+		}
+		return $caps;
+	}
 
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_payment_method_currencies.dmsstage.php

Spacing +24 added lines, -24 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
 	exit('No direct script access allowed');
 }
 
@@ -14,7 +14,7 @@ 
  * @deprecated in 4.9.40 because the currency payment method table has been deprecated
  *
  */
-class EE_DMS_4_6_0_payment_method_currencies extends EE_Data_Migration_Script_Stage{
+class EE_DMS_4_6_0_payment_method_currencies extends EE_Data_Migration_Script_Stage {
 	protected $_currency_table_name;
 	protected $_currency_payment_method_table_name;
 	protected $_payment_method_table_name;
@@ -90,7 +90,7 @@ 
 	);
 	public function __construct() {
 		global $wpdb;
-		$this->_pretty_name = __( 'Payment Method Currencies', 'event_espresso' );
+		$this->_pretty_name = __('Payment Method Currencies', 'event_espresso');
 		$this->_payment_method_table_name = $wpdb->prefix.'esp_payment_method';
 		$this->_currency_payment_method_table_name = $wpdb->prefix.'esp_currency_payment_method';
 		$this->_currency_table_name = $wpdb->prefix.'esp_currency';
@@ -99,8 +99,8 @@ 
 
 	protected function _count_records_to_migrate() {
 		$count = 0;
-		foreach($this->_gateway_currencies as $currencies){
-			if( $currencies == 'all'){
+		foreach ($this->_gateway_currencies as $currencies) {
+			if ($currencies == 'all') {
 				$currencies = $this->_get_all_currencies();
 			}
 			$count += count($currencies);
@@ -110,20 +110,20 @@ 
 
 
 
-	protected function _migration_step( $num_items_to_migrate = 50 ) {
+	protected function _migration_step($num_items_to_migrate = 50) {
 		$items_actually_migrated = 0;
 		$relations_to_add_this_step = $this->_gather_relations_to_add($num_items_to_migrate);
-		foreach($relations_to_add_this_step as $pm_slug => $currencies){
+		foreach ($relations_to_add_this_step as $pm_slug => $currencies) {
 
-			$id = $this->get_migration_script()->get_mapping_new_pk( 'EE_Gateway_Config', $pm_slug, $this->_payment_method_table_name );
-			foreach( $currencies as $currency ){
-				if( $id ){
-					$this->_add_currency_relations( $id, $currency );
+			$id = $this->get_migration_script()->get_mapping_new_pk('EE_Gateway_Config', $pm_slug, $this->_payment_method_table_name);
+			foreach ($currencies as $currency) {
+				if ($id) {
+					$this->_add_currency_relations($id, $currency);
 				}
 				$items_actually_migrated++;
 			}
 		}
-		if($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()){
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
 			$this->set_completed();
 		}
 		return $items_actually_migrated;
@@ -133,14 +133,14 @@ 
 		$relations_to_add_this_step = array();
 		$migrate_up_to_count = $this->count_records_migrated() + $num_items_to_migrate;
 		$iterator = 0;
-		foreach($this->_gateway_currencies as $pm_slug => $currencies){
-			if( $currencies == 'all' ){
+		foreach ($this->_gateway_currencies as $pm_slug => $currencies) {
+			if ($currencies == 'all') {
 				$currencies = $this->_get_all_currencies();
 			}
-			foreach($currencies as $currency_code){
-				if( $this->count_records_migrated() <= $iterator &&
-						$iterator < $migrate_up_to_count ){
-					$relations_to_add_this_step[ $pm_slug ] [] = $currency_code;
+			foreach ($currencies as $currency_code) {
+				if ($this->count_records_migrated() <= $iterator &&
+						$iterator < $migrate_up_to_count) {
+					$relations_to_add_this_step[$pm_slug] [] = $currency_code;
 				}
 				$iterator++;
 			}
@@ -151,7 +151,7 @@ 
 	 * Gets all the currency codes in the database
 	 * @return array
 	 */
-	private function _get_all_currencies(){
+	private function _get_all_currencies() {
 		global $wpdb;
 		$currencies = $wpdb->get_col("SELECT CUR_code FROM {$this->_currency_table_name}");
 		return $currencies;
@@ -162,7 +162,7 @@ 
 	 * @param int $id
 	 * @param string $gateway_slug
 	 */
-	private function _add_currency_relations($pm_id,$currency_code){
+	private function _add_currency_relations($pm_id, $currency_code) {
 		global $wpdb;
 		$cur_pm_relation = array(
 					'CUR_code'=>$currency_code,
@@ -171,11 +171,11 @@ 
 		$success = $wpdb->insert($this->_currency_payment_method_table_name,
 				$cur_pm_relation,
 				array(
-					'%s',//CUR_code
-					'%d',//PMD_ID
+					'%s', //CUR_code
+					'%d', //PMD_ID
 				));
-		if( ! $success ){
-			$this->add_error( sprintf( __( 'Could not add currency relation %s because %s', "event_espresso" ), wp_json_encode( $cur_pm_relation ), $wpdb->last_error ) );
+		if ( ! $success) {
+			$this->add_error(sprintf(__('Could not add currency relation %s because %s', "event_espresso"), wp_json_encode($cur_pm_relation), $wpdb->last_error));
 		}
 	}
 }

core/data_migration_scripts/EE_DMS_Core_4_9_0.dms.php

Indentation +282 added lines, -282 removed lines

@@ -12,9 +12,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_9_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
-    $matches = array();
-    preg_match('~4_9_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[$matches[1]] = $filepath;
+	$matches = array();
+	preg_match('~4_9_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_9_0__autoloaded_stages', $class_to_filepath);
@@ -33,68 +33,68 @@ 
 class EE_DMS_Core_4_9_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * return EE_DMS_Core_4_9_0
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = esc_html__("Data Update to Event Espresso 4.9.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_9_0_Email_System_Question(),
-            new EE_DMS_4_9_0_Answers_With_No_Registration(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
+	/**
+	 * return EE_DMS_Core_4_9_0
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = esc_html__("Data Update to Event Espresso 4.9.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_9_0_Email_System_Question(),
+			new EE_DMS_4_9_0_Answers_With_No_Registration(),
+		);
+		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)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.9.0', '<=') && version_compare($version_string, '4.8.0', '>=')) {
-            //			echo "$version_string can be migrated from";
-            return true;
-        } elseif ( ! $version_string) {
-            //			echo "no version string provided: $version_string";
-            //no version string provided... this must be pre 4.3
-            return false;//changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
-            //			echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+	/**
+	 * Whether to migrate or not.
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.9.0', '<=') && version_compare($version_string, '4.8.0', '>=')) {
+			//			echo "$version_string can be migrated from";
+			return true;
+		} elseif ( ! $version_string) {
+			//			echo "no version string provided: $version_string";
+			//no version string provided... this must be pre 4.3
+			return false;//changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
+			//			echo "$version_string doesnt apply";
+			return false;
+		}
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $now_in_mysql = current_time('mysql', true);
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$now_in_mysql = current_time('mysql', true);
+		$table_name = 'esp_answer';
+		$sql = " 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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'ATT_email');
-        $sql = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'ATT_email');
+		$sql = "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,
@@ -111,9 +111,9 @@ 
 				KEY ATT_email (ATT_email(191)),
 				KEY ATT_lname (ATT_lname),
 				KEY ATT_fname (ATT_fname)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "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,
@@ -121,9 +121,9 @@ 
 				PRIMARY KEY  (CHK_ID),
 				KEY REG_ID (REG_ID),
 				KEY DTT_ID (DTT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO varchar(2) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_country';
+		$sql = "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,
@@ -139,29 +139,29 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code varchar(6) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, '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
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, '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
+		$table_name = 'esp_currency_payment_method';
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				DTT_name varchar(255) NOT NULL DEFAULT '',
 				DTT_description text NOT NULL,
@@ -178,25 +178,25 @@ 
 				KEY DTT_EVT_start (DTT_EVT_start),
 				KEY EVT_ID (EVT_ID),
 				KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
 				EVT_display_ticket_selector tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -211,34 +211,34 @@ 
 				EVT_donations tinyint(1) NULL,
 				PRIMARY KEY  (EVTM_ID),
 				KEY EVT_ID (EVT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "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,
 				PRIMARY KEY  (EQG_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY QSG_ID (QSG_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_join';
-        $sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_join';
+		$sql = "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,
@@ -246,9 +246,9 @@ 
 				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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(11) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -267,9 +267,9 @@ 
 				PRIMARY KEY  (LIN_ID),
 				KEY LIN_code (LIN_code(191)),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "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,
@@ -280,12 +280,12 @@ 
 				KEY LOG_time (LOG_time),
 				KEY OBJ (OBJ_type,OBJ_ID),
 				KEY LOG_type (LOG_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message';
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_to');
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_from');
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_subject');
-        $sql = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message';
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_to');
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_from');
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_subject');
+		$sql = "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,
@@ -317,18 +317,18 @@ 
 				KEY STS_ID (STS_ID),
 				KEY MSG_created (MSG_created),
 				KEY MSG_modified (MSG_modified)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template_group';
+		$sql = "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 '',
@@ -340,9 +340,9 @@ 
 				MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 				PRIMARY KEY  (GRP_ID),
 				KEY MTP_user_id (MTP_user_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "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 '0000-00-00 00:00:00',
@@ -359,9 +359,9 @@ 
 				PRIMARY KEY  (PAY_ID),
 				KEY PAY_timestamp (PAY_timestamp),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -377,24 +377,24 @@ 
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug),
 				KEY PMD_type (PMD_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = '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,
@@ -408,18 +408,18 @@ 
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID),
 				KEY QST_order (QST_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "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)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "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,
@@ -429,9 +429,9 @@ 
 				PRIMARY KEY  (QSO_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSO_order (QSO_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "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,
@@ -455,18 +455,18 @@ 
 				KEY TKT_ID (TKT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY STS_ID (STS_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_registration_payment';
-        $sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_registration_payment';
+		$sql = "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)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_state';
+		$sql = "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,
@@ -474,9 +474,9 @@ 
 				PRIMARY KEY  (STA_ID),
 				KEY STA_abbrev (STA_abbrev),
 				KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID varchar(3) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "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,
@@ -484,9 +484,9 @@ 
 				STS_open tinyint(1) NOT NULL DEFAULT 1,
 				UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 				KEY STS_type (STS_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
 				TXN_total decimal(12,3) DEFAULT '0.00',
 				TXN_paid decimal(12,3) NOT NULL DEFAULT '0.00',
@@ -498,9 +498,9 @@ 
 				PRIMARY KEY  (TXN_ID),
 				KEY TXN_timestamp (TXN_timestamp),
 				KEY STS_ID (STS_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "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,
@@ -519,10 +519,10 @@ 
 			KEY VNU_ID (VNU_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        //modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		//modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_ID tinyint(3) unsigned NOT NULL,
 				PRC_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 				PRC_name varchar(245) NOT NULL,
@@ -535,9 +535,9 @@ 
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID),
 				KEY PRT_ID (PRT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "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',
@@ -546,9 +546,9 @@ 
 				PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				PRIMARY KEY  (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "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,
@@ -571,9 +571,9 @@ 
 				TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				PRIMARY KEY  (TKT_ID),
 				KEY TKT_start_date (TKT_start_date)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group';
+		$sql = '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,
@@ -586,138 +586,138 @@ 
 				PRIMARY KEY  (QSG_ID),
 				UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 				KEY QSG_order (QSG_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        /** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
-        $script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        //(because many need to convert old string states to foreign keys into the states table)
-        $script_4_1_defaults->insert_default_states();
-        $script_4_1_defaults->insert_default_countries();
-        /** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
-        $script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
-        $script_4_5_defaults->insert_default_price_types();
-        $script_4_5_defaults->insert_default_prices();
-        $script_4_5_defaults->insert_default_tickets();
-        /** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
-        $script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
-        $script_4_6_defaults->add_default_admin_only_payments();
-        $script_4_6_defaults->insert_default_currencies();
-        /** @var EE_DMS_Core_4_8_0 $script_4_8_defaults */
-        $script_4_8_defaults = EE_Registry::instance()->load_dms('Core_4_8_0');
-        $script_4_8_defaults->verify_new_countries();
-        $script_4_8_defaults->verify_new_currencies();
-        $this->verify_db_collations();
-        $this->verify_db_collations_again();
-        return true;
-    }
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
+		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		//(because many need to convert old string states to foreign keys into the states table)
+		$script_4_1_defaults->insert_default_states();
+		$script_4_1_defaults->insert_default_countries();
+		/** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
+		$script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
+		$script_4_5_defaults->insert_default_price_types();
+		$script_4_5_defaults->insert_default_prices();
+		$script_4_5_defaults->insert_default_tickets();
+		/** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
+		$script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
+		$script_4_6_defaults->add_default_admin_only_payments();
+		$script_4_6_defaults->insert_default_currencies();
+		/** @var EE_DMS_Core_4_8_0 $script_4_8_defaults */
+		$script_4_8_defaults = EE_Registry::instance()->load_dms('Core_4_8_0');
+		$script_4_8_defaults->verify_new_countries();
+		$script_4_8_defaults->verify_new_currencies();
+		$this->verify_db_collations();
+		$this->verify_db_collations_again();
+		return true;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 
 
 
-    /**
-     * Verify all EE4 models' tables use utf8mb4 collation
-     *
-     * @return void
-     */
-    public function verify_db_collations()
-    {
-        if (get_option('ee_verified_db_collations', false)) {
-            return;
-        }
-        // grab tables from each model
-        $tables_to_check = array();
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_Base) {
-                    foreach ($model_obj->get_tables() as $table) {
-                        if (
-                            strpos($table->get_table_name(), 'esp_')
-                            && (is_main_site()//for main tables, verify global tables
-                                || ! $table->is_global()//if not the main site, then only verify non-global tables (avoid doubling up)
-                            )
-                            && function_exists('maybe_convert_table_to_utf8mb4')
-                        ) {
-                            $tables_to_check[] = $table->get_table_name();
-                        }
-                    }
-                }
-            }
-        }
-        //and let's just be sure these addons' tables get migrated too. They already get handled if their addons are active
-        //when this code is run, but not otherwise. Once we record what tables EE added, we'll be able to use that instead
-        //of hard-coding this
-        $addon_tables = array(
-            //mailchimp
-            'esp_event_mailchimp_list_group',
-            'esp_event_question_mailchimp_field',
-            //multisite
-            'esp_blog_meta',
-            //people
-            'esp_people_to_post',
-            //promotions
-            'esp_promotion',
-            'esp_promotion_object',
-        );
-        foreach ($addon_tables as $table_name) {
-                $tables_to_check[] = $table_name;
-        }
-        $this->_verify_db_collations_for_tables(array_unique($tables_to_check));
-        //ok and now let's remember this was done (without needing to check the db schemas all over again)
-        add_option('ee_verified_db_collations', true, null, 'no');
-        //seeing how this ran with the fix from 10435, no need to check again
-        add_option('ee_verified_db_collations_again',true,null,'no');
-    }
+	/**
+	 * Verify all EE4 models' tables use utf8mb4 collation
+	 *
+	 * @return void
+	 */
+	public function verify_db_collations()
+	{
+		if (get_option('ee_verified_db_collations', false)) {
+			return;
+		}
+		// grab tables from each model
+		$tables_to_check = array();
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (
+							strpos($table->get_table_name(), 'esp_')
+							&& (is_main_site()//for main tables, verify global tables
+								|| ! $table->is_global()//if not the main site, then only verify non-global tables (avoid doubling up)
+							)
+							&& function_exists('maybe_convert_table_to_utf8mb4')
+						) {
+							$tables_to_check[] = $table->get_table_name();
+						}
+					}
+				}
+			}
+		}
+		//and let's just be sure these addons' tables get migrated too. They already get handled if their addons are active
+		//when this code is run, but not otherwise. Once we record what tables EE added, we'll be able to use that instead
+		//of hard-coding this
+		$addon_tables = array(
+			//mailchimp
+			'esp_event_mailchimp_list_group',
+			'esp_event_question_mailchimp_field',
+			//multisite
+			'esp_blog_meta',
+			//people
+			'esp_people_to_post',
+			//promotions
+			'esp_promotion',
+			'esp_promotion_object',
+		);
+		foreach ($addon_tables as $table_name) {
+				$tables_to_check[] = $table_name;
+		}
+		$this->_verify_db_collations_for_tables(array_unique($tables_to_check));
+		//ok and now let's remember this was done (without needing to check the db schemas all over again)
+		add_option('ee_verified_db_collations', true, null, 'no');
+		//seeing how this ran with the fix from 10435, no need to check again
+		add_option('ee_verified_db_collations_again',true,null,'no');
+	}
 
 
 
-    /**
-     * Verifies DB collations because a bug was discovered on https://events.codebasehq.com/projects/event-espresso/tickets/10435
-     * which meant some DB collations might not have been updated
-     * @return void
-     */
-    public function verify_db_collations_again(){
-        if (get_option('ee_verified_db_collations_again', false)) {
-            return;
-        }
-        $tables_to_check = array(
-            'esp_attendee_meta',
-            'esp_message'
-        );
-        $this->_verify_db_collations_for_tables(array_unique($tables_to_check));
-        add_option('ee_verified_db_collations_again',true,null,'no');
-    }
+	/**
+	 * Verifies DB collations because a bug was discovered on https://events.codebasehq.com/projects/event-espresso/tickets/10435
+	 * which meant some DB collations might not have been updated
+	 * @return void
+	 */
+	public function verify_db_collations_again(){
+		if (get_option('ee_verified_db_collations_again', false)) {
+			return;
+		}
+		$tables_to_check = array(
+			'esp_attendee_meta',
+			'esp_message'
+		);
+		$this->_verify_db_collations_for_tables(array_unique($tables_to_check));
+		add_option('ee_verified_db_collations_again',true,null,'no');
+	}
 
 
 
-    /**
-     * Runs maybe_convert_table_to_utf8mb4 on the specified tables
-     * @param $tables_to_check
-     * @return boolean true if logic ran, false if it didn't
-     */
-    protected function _verify_db_collations_for_tables($tables_to_check)
-    {
-        foreach ($tables_to_check as $table_name) {
-            $table_name = $this->_table_analysis->ensureTableNameHasPrefix($table_name);
-            if ( ! apply_filters('FHEE__EE_DMS_Core_4_9_0__verify_db_collations__check_overridden', false, $table_name )
-                && $this->_get_table_analysis()->tableExists($table_name)
-            ) {
-                maybe_convert_table_to_utf8mb4($table_name);
-            }
-        }
-    }
+	/**
+	 * Runs maybe_convert_table_to_utf8mb4 on the specified tables
+	 * @param $tables_to_check
+	 * @return boolean true if logic ran, false if it didn't
+	 */
+	protected function _verify_db_collations_for_tables($tables_to_check)
+	{
+		foreach ($tables_to_check as $table_name) {
+			$table_name = $this->_table_analysis->ensureTableNameHasPrefix($table_name);
+			if ( ! apply_filters('FHEE__EE_DMS_Core_4_9_0__verify_db_collations__check_overridden', false, $table_name )
+				&& $this->_get_table_analysis()->tableExists($table_name)
+			) {
+				maybe_convert_table_to_utf8mb4($table_name);
+			}
+		}
+	}
 }
\ No newline at end of file

core/data_migration_scripts/EE_DMS_Core_4_6_0.dms.php

Indentation +269 added lines, -269 removed lines

@@ -14,9 +14,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_6_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
-    $matches = array();
-    preg_match('~4_6_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[$matches[1]] = $filepath;
+	$matches = array();
+	preg_match('~4_6_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_6_0__autoloaded_stages', $class_to_filepath);
@@ -35,69 +35,69 @@ 
 class EE_DMS_Core_4_6_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * return EE_DMS_Core_4_6_0
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = __("Data Update to Event Espresso 4.6.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_6_0_gateways(),
-            new EE_DMS_4_6_0_question_types(),
-            new EE_DMS_4_6_0_country_system_question(),
-            new EE_DMS_4_6_0_state_system_question(),
-            new EE_DMS_4_6_0_billing_info(),
-            new EE_DMS_4_6_0_transactions(),
-            new EE_DMS_4_6_0_payments(),
-            new EE_DMS_4_6_0_invoice_settings(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-
-    /**
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.6.0', '<=') && version_compare($version_string, '4.5.0', '>=')) {
+	/**
+	 * return EE_DMS_Core_4_6_0
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = __("Data Update to Event Espresso 4.6.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_6_0_gateways(),
+			new EE_DMS_4_6_0_question_types(),
+			new EE_DMS_4_6_0_country_system_question(),
+			new EE_DMS_4_6_0_state_system_question(),
+			new EE_DMS_4_6_0_billing_info(),
+			new EE_DMS_4_6_0_transactions(),
+			new EE_DMS_4_6_0_payments(),
+			new EE_DMS_4_6_0_invoice_settings(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+
+	/**
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.6.0', '<=') && version_compare($version_string, '4.5.0', '>=')) {
 //			echo "$version_string can be migrated from";
-            return true;
-        } elseif ( ! $version_string) {
+			return true;
+		} elseif ( ! $version_string) {
 //			echo "no version string provided: $version_string";
-            //no version string provided... this must be pre 4.3
-            return false;//changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
+			//no version string provided... this must be pre 4.3
+			return false;//changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
 //			echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+			return false;
+		}
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        //relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		//relies on 4.1's EEH_Activation::create_table
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT UNSIGNED NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					ANS_value TEXT NOT NULL,
 					PRIMARY KEY  (ANS_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $sql = "ATTM_ID INT(10) UNSIGNED NOT	NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$sql = "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,
@@ -113,9 +113,9 @@ 
 								KEY ATT_fname (ATT_fname),
 								KEY ATT_lname (ATT_lname),
 								KEY ATT_email (ATT_email)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
 					  CNT_ISO3 VARCHAR(3) COLLATE utf8_bin NOT NULL,
 					  RGN_ID TINYINT(3) UNSIGNED DEFAULT NULL,
 					  CNT_name VARCHAR(45) COLLATE utf8_bin NOT NULL,
@@ -131,24 +131,24 @@ 
 					  CNT_is_EU TINYINT(1) DEFAULT '0',
 					  CNT_active TINYINT(1) DEFAULT '0',
 					  PRIMARY KEY  (CNT_ISO)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code VARCHAR(6) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "CUR_code VARCHAR(6) COLLATE utf8_bin NOT NULL,
 				CUR_single VARCHAR(45) COLLATE utf8_bin DEFAULT 'dollar',
 				CUR_plural VARCHAR(45) COLLATE utf8_bin DEFAULT 'dollars',
 				CUR_sign VARCHAR(45) COLLATE utf8_bin DEFAULT '$',
 				CUR_dec_plc VARCHAR(1) COLLATE utf8_bin NOT NULL DEFAULT '2',
 				CUR_active TINYINT(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency_payment_method';
+		$sql = "CPM_ID INT(11) NOT NULL AUTO_INCREMENT,
 				CUR_code  VARCHAR(6) COLLATE utf8_bin NOT NULL,
 				PMD_ID INT(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 				  EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 				  DTT_name VARCHAR(255) NOT NULL DEFAULT '',
 				  DTT_description TEXT NOT NULL,
@@ -163,9 +163,9 @@ 
 						PRIMARY KEY  (DTT_ID),
 						KEY EVT_ID (EVT_ID),
 						KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "
 			EVTM_ID INT NOT NULL AUTO_INCREMENT,
 			EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 			EVT_display_desc TINYINT(1) UNSIGNED NOT NULL DEFAULT 1,
@@ -180,31 +180,31 @@ 
 			EVT_external_URL VARCHAR(200) NULL,
 			EVT_donations TINYINT(1) NULL,
 			PRIMARY KEY  (EVTM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 					QSG_ID INT UNSIGNED NOT NULL,
 					EQG_primary TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EQG_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "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)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "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)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID INT(11) NOT NULL AUTO_INCREMENT,
 				LIN_code VARCHAR(245) NOT NULL DEFAULT '',
 				TXN_ID INT(11) DEFAULT NULL,
 				LIN_name VARCHAR(245) NOT NULL DEFAULT '',
@@ -220,9 +220,9 @@ 
 				OBJ_ID INT(11) DEFAULT NULL,
 				OBJ_type VARCHAR(45)DEFAULT NULL,
 				PRIMARY KEY  (LIN_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "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,
@@ -230,19 +230,19 @@ 
 				LOG_message TEXT,
 				LOG_wp_user INT(11) DEFAULT NULL,
 				PRIMARY KEY  (LOG_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "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)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $this->_get_table_manager()->dropIndex('esp_message_template_group', 'EVT_ID');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_get_table_manager()->dropIndex('esp_message_template_group', 'EVT_ID');
+		$table_name = 'esp_message_template_group';
+		$sql = "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 '',
@@ -254,17 +254,17 @@ 
 					MTP_is_active TINYINT(1) NOT NULL DEFAULT '1',
 					PRIMARY KEY  (GRP_ID),
 					KEY MTP_user_id (MTP_user_id)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "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)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					TXN_ID INT(10) UNSIGNED DEFAULT NULL,
 					STS_ID VARCHAR(3) COLLATE utf8_bin DEFAULT NULL,
 					PAY_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -281,9 +281,9 @@ 
 					PRIMARY KEY  (PAY_ID),
 					KEY TXN_ID (TXN_ID),
 					KEY PAY_timestamp (PAY_timestamp)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID INT(11) NOT NULL AUTO_INCREMENT,
 				PMD_type VARCHAR(124) DEFAULT NULL,
 				PMD_name VARCHAR(255) DEFAULT NULL,
 				PMD_desc TEXT,
@@ -298,28 +298,28 @@ 
 				PMD_scope VARCHAR(255) NULL DEFAULT 'frontend',
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "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)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "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)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "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)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QST_display_text TEXT NOT NULL,
 					QST_admin_label VARCHAR(255) NOT NULL,
 					QST_system VARCHAR(25) DEFAULT NULL,
@@ -331,25 +331,25 @@ 
 					QST_wp_user BIGINT UNSIGNED NULL,
 					QST_deleted TINYINT UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QST_ID)';
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSG_ID INT UNSIGNED NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					QGQ_order INT UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QGQ_ID) ";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSO_value VARCHAR(255) NOT NULL,
 					QSO_desc TEXT NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					QSO_order INT UNSIGNED NOT NULL DEFAULT 0,
 					QSO_deleted TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QSO_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "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,
@@ -372,25 +372,25 @@ 
 					  KEY STS_ID (STS_ID),
 					  KEY REG_url_link (REG_url_link),
 					  KEY REG_code (REG_code)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "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,
 					CHK_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 					PRIMARY KEY  (CHK_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
 					  STA_abbrev VARCHAR(24) COLLATE utf8_bin NOT NULL,
 					  STA_name VARCHAR(100) COLLATE utf8_bin NOT NULL,
 					  STA_active TINYINT(1) DEFAULT '1',
 					  PRIMARY KEY  (STA_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID VARCHAR(3) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID VARCHAR(3) COLLATE utf8_bin NOT NULL,
 					  STS_code VARCHAR(45) COLLATE utf8_bin NOT NULL,
 					  STS_type set('event','registration','transaction','payment','email') COLLATE utf8_bin NOT NULL,
 					  STS_can_edit TINYINT(1) NOT NULL DEFAULT 0,
@@ -398,9 +398,9 @@ 
 					  STS_open TINYINT(1) NOT NULL DEFAULT 1,
 					  UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 					  KEY STS_type (STS_type)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TXN_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 					  TXN_total DECIMAL(10,3) DEFAULT '0.00',
 					  TXN_paid DECIMAL(10,3) NOT NULL DEFAULT '0.00',
@@ -412,9 +412,9 @@ 
 					  PRIMARY KEY  (TXN_ID),
 					  KEY TXN_timestamp (TXN_timestamp),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "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,
@@ -432,10 +432,10 @@ 
 			PRIMARY KEY  (VNUM_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        //modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		//modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  PRT_ID TINYINT(3) UNSIGNED NOT NULL,
 					  PRC_amount DECIMAL(10,3) NOT NULL DEFAULT '0.00',
 					  PRC_name VARCHAR(245) NOT NULL,
@@ -447,9 +447,9 @@ 
 					  PRC_wp_user BIGINT UNSIGNED NULL,
 					  PRC_parent INT(10) UNSIGNED DEFAULT 0,
 					  PRIMARY KEY  (PRC_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID TINYINT(3) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "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',
@@ -458,9 +458,9 @@ 
 				  PRT_deleted TINYINT(1) NOT NULL DEFAULT '0',
 				  UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				  PRIMARY KEY  (PRT_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "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,
@@ -481,10 +481,10 @@ 
 					  TKT_parent INT(10) UNSIGNED DEFAULT '0',
 					  TKT_deleted TINYINT(1) NOT NULL DEFAULT '0',
 					  PRIMARY KEY  (TKT_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSG_name VARCHAR(255) NOT NULL,
 					QSG_identifier VARCHAR(100) NOT NULL,
 					QSG_desc TEXT NULL,
@@ -496,119 +496,119 @@ 
 					QSG_wp_user BIGINT UNSIGNED NULL,
 					PRIMARY KEY  (QSG_ID),
 					UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier ASC)';
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        /** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
-        $script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        //(because many need to convert old string states to foreign keys into the states table)
-        $script_4_1_defaults->insert_default_states();
-        $script_4_1_defaults->insert_default_countries();
-        /** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
-        $script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
-        $script_4_5_defaults->insert_default_price_types();
-        $script_4_5_defaults->insert_default_prices();
-        $script_4_5_defaults->insert_default_tickets();
-        //setting up the config wp option pretty well counts as a 'schema change', or at least should happen here
-        EE_Config::instance()->update_espresso_config(false, true);
-        $this->add_default_admin_only_payments();
-        $this->insert_default_currencies();
-        return true;
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
-
-
-
-    public function migration_page_hooks()
-    {
-    }
-
-
-
-    public function add_default_admin_only_payments()
-    {
-        global $wpdb;
-        $table_name = $wpdb->prefix . "esp_payment_method";
-        $user_id = EEH_Activation::get_default_creator_id();
-        if ($this->_get_table_analysis()->tableExists($table_name)) {
-            $SQL = "SELECT COUNT( * ) FROM $table_name";
-            $existing_payment_methods = $wpdb->get_var($SQL);
-            $default_admin_only_payment_methods = apply_filters(
-                'FHEE__EEH_Activation__add_default_admin_only_payments__default_admin_only_payment_methods',
-                array(
-                    __("Bank", 'event_espresso')        => __("Bank Draft", 'event_espresso'),
-                    __("Cash", 'event_espresso')        => __("Cash Delivered Physically", 'event_espresso'),
-                    __("Check", 'event_espresso')       => __("Paper Check", 'event_espresso'),
-                    __("Credit Card", 'event_espresso') => __("Offline Credit Card Payment", 'event_espresso'),
-                    __("Debit Card", 'event_espresso')  => __("Offline Debit Payment", 'event_espresso'),
-                    __("Invoice", 'event_espresso')     => __("Invoice received with monies included",
-                        'event_espresso'),
-                    __("Money Order", 'event_espresso') => '',
-                    __("Paypal", 'event_espresso')      => __("Paypal eCheck, Invoice, etc", 'event_espresso'),
-                    __('Other', 'event_espresso')       => __('Other method of payment', 'event_espresso'),
-                ));
-            //make sure we hae payment method records for the following
-            //so admins can record payments for them from the admin page
-            foreach ($default_admin_only_payment_methods as $nicename => $description) {
-                $slug = sanitize_key($nicename);
-                //check that such a payment method exists
-                $exists = $wpdb->get_var($wpdb->prepare("SELECT count(*) FROM $table_name WHERE PMD_slug = %s", $slug));
-                if ( ! $exists) {
-                    $values = array(
-                        'PMD_type'       => 'Admin_Only',
-                        'PMD_name'       => $nicename,
-                        'PMD_admin_name' => $nicename,
-                        'PMD_admin_desc' => $description,
-                        'PMD_slug'       => $slug,
-                        'PMD_wp_user'    => $user_id,
-                        'PMD_scope'      => serialize(array('ADMIN')),
-                    );
-                    $success = $wpdb->insert(
-                        $table_name,
-                        $values,
-                        array(
-                            '%s',//PMD_type
-                            '%s',//PMD_name
-                            '%s',//PMD_admin_name
-                            '%s',//PMD_admin_desc
-                            '%s',//PMD_slug
-                            '%d',//PMD_wp_user
-                            '%s',//PMD_scope
-                        )
-                    );
-                    if ( ! $success) {
-                        $this->add_error(sprintf(__("Could not insert new admin-only payment method with values %s during migration",
-                            "event_espresso"), $this->_json_encode($values)));
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * insert_default_countries
-     *
-     * @static
-     * @return void
-     */
-    public function insert_default_currencies()
-    {
-        global $wpdb;
-        $currency_table = $wpdb->prefix . "esp_currency";
-        if ($this->_get_table_analysis()->tableExists($currency_table)) {
-            $SQL = "SELECT COUNT('CUR_code') FROM $currency_table";
-            $countries = $wpdb->get_var($SQL);
-            if ( ! $countries) {
-                $SQL = "INSERT INTO $currency_table
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
+		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		//(because many need to convert old string states to foreign keys into the states table)
+		$script_4_1_defaults->insert_default_states();
+		$script_4_1_defaults->insert_default_countries();
+		/** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
+		$script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
+		$script_4_5_defaults->insert_default_price_types();
+		$script_4_5_defaults->insert_default_prices();
+		$script_4_5_defaults->insert_default_tickets();
+		//setting up the config wp option pretty well counts as a 'schema change', or at least should happen here
+		EE_Config::instance()->update_espresso_config(false, true);
+		$this->add_default_admin_only_payments();
+		$this->insert_default_currencies();
+		return true;
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
+
+
+
+	public function migration_page_hooks()
+	{
+	}
+
+
+
+	public function add_default_admin_only_payments()
+	{
+		global $wpdb;
+		$table_name = $wpdb->prefix . "esp_payment_method";
+		$user_id = EEH_Activation::get_default_creator_id();
+		if ($this->_get_table_analysis()->tableExists($table_name)) {
+			$SQL = "SELECT COUNT( * ) FROM $table_name";
+			$existing_payment_methods = $wpdb->get_var($SQL);
+			$default_admin_only_payment_methods = apply_filters(
+				'FHEE__EEH_Activation__add_default_admin_only_payments__default_admin_only_payment_methods',
+				array(
+					__("Bank", 'event_espresso')        => __("Bank Draft", 'event_espresso'),
+					__("Cash", 'event_espresso')        => __("Cash Delivered Physically", 'event_espresso'),
+					__("Check", 'event_espresso')       => __("Paper Check", 'event_espresso'),
+					__("Credit Card", 'event_espresso') => __("Offline Credit Card Payment", 'event_espresso'),
+					__("Debit Card", 'event_espresso')  => __("Offline Debit Payment", 'event_espresso'),
+					__("Invoice", 'event_espresso')     => __("Invoice received with monies included",
+						'event_espresso'),
+					__("Money Order", 'event_espresso') => '',
+					__("Paypal", 'event_espresso')      => __("Paypal eCheck, Invoice, etc", 'event_espresso'),
+					__('Other', 'event_espresso')       => __('Other method of payment', 'event_espresso'),
+				));
+			//make sure we hae payment method records for the following
+			//so admins can record payments for them from the admin page
+			foreach ($default_admin_only_payment_methods as $nicename => $description) {
+				$slug = sanitize_key($nicename);
+				//check that such a payment method exists
+				$exists = $wpdb->get_var($wpdb->prepare("SELECT count(*) FROM $table_name WHERE PMD_slug = %s", $slug));
+				if ( ! $exists) {
+					$values = array(
+						'PMD_type'       => 'Admin_Only',
+						'PMD_name'       => $nicename,
+						'PMD_admin_name' => $nicename,
+						'PMD_admin_desc' => $description,
+						'PMD_slug'       => $slug,
+						'PMD_wp_user'    => $user_id,
+						'PMD_scope'      => serialize(array('ADMIN')),
+					);
+					$success = $wpdb->insert(
+						$table_name,
+						$values,
+						array(
+							'%s',//PMD_type
+							'%s',//PMD_name
+							'%s',//PMD_admin_name
+							'%s',//PMD_admin_desc
+							'%s',//PMD_slug
+							'%d',//PMD_wp_user
+							'%s',//PMD_scope
+						)
+					);
+					if ( ! $success) {
+						$this->add_error(sprintf(__("Could not insert new admin-only payment method with values %s during migration",
+							"event_espresso"), $this->_json_encode($values)));
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * insert_default_countries
+	 *
+	 * @static
+	 * @return void
+	 */
+	public function insert_default_currencies()
+	{
+		global $wpdb;
+		$currency_table = $wpdb->prefix . "esp_currency";
+		if ($this->_get_table_analysis()->tableExists($currency_table)) {
+			$SQL = "SELECT COUNT('CUR_code') FROM $currency_table";
+			$countries = $wpdb->get_var($SQL);
+			if ( ! $countries) {
+				$SQL = "INSERT INTO $currency_table
 				( CUR_code, CUR_single, CUR_plural, CUR_sign, CUR_dec_plc, CUR_active) VALUES
 				( 'EUR',  'Euro',  'Euros',  '€',  2,1),
 				( 'AED',  'Dirham',  'Dirhams', 'د.إ',2,1),
@@ -762,10 +762,10 @@ 
 				( 'ZAR',  'Rand',  'Rands',  'R',  2,1),
 				( 'ZMK',  'Kwacha',  'Kwachas',  '',  2,1),
 				( 'ZWD', 'Dollar', 'Dollars', 'Z$', 2,1);";
-                $wpdb->query($SQL);
-            }
-        }
-    }
+				$wpdb->query($SQL);
+			}
+		}
+	}
 
 }
 

core/exceptions/InvalidEntityException.php

Indentation +27 added lines, -27 removed lines

@@ -3,7 +3,7 @@ 
 namespace EventEspresso\core\exceptions;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -18,32 +18,32 @@ 
 class InvalidEntityException extends \InvalidArgumentException
 {
 
-    /**
-     * InvalidInterfaceException constructor.
-     *
-     * @param string     $actual   classname of what we got
-     * @param string     $expected classname of the entity we wanted
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($actual, $expected, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
-                    'event_espresso'
-                ),
-                is_object($actual)
-                    ? get_class($actual)
-                    : gettype($actual),
-                $expected,
-                var_export($actual, true)
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidInterfaceException constructor.
+	 *
+	 * @param string     $actual   classname of what we got
+	 * @param string     $expected classname of the entity we wanted
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($actual, $expected, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
+					'event_espresso'
+				),
+				is_object($actual)
+					? get_class($actual)
+					: gettype($actual),
+				$expected,
+				var_export($actual, true)
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 
 }
 // End of file InvalidEntityException.php

Spacing +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 
 namespace EventEspresso\core\exceptions;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

core/libraries/form_sections/strategies/validation/EE_Email_Validation_Strategy.strategy.php

Indentation +103 added lines, -103 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -15,117 +15,117 @@ 
 class EE_Email_Validation_Strategy extends EE_Text_Validation_Strategy
 {
 
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = __("Please enter a valid email address.", "event_espresso");
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = __("Please enter a valid email address.", "event_espresso");
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     * just checks the field isn't blank
-     *
-     * @param $normalized_value
-     * @return bool
-     * @throws \EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        if ($normalized_value && ! $this->_validate_email($normalized_value)) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
-        }
-    }
+	/**
+	 * just checks the field isn't blank
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 * @throws \EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		if ($normalized_value && ! $this->_validate_email($normalized_value)) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
+		}
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message()));
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message()));
+	}
 
 
 
-    /**
-     * Validate an email address.
-     * Provide email address (raw input)
-     *
-     * @param $email
-     * @return bool of whether the email is valid or not
-     * @throws \EE_Validation_Error
-     */
-    private function _validate_email($email)
-    {
-        $validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
-            : 'wp_default';
-        if (! preg_match('/^.+\@\S+$/', $email)) { // \.\S+
-            // email not in correct {string}@{string} format
-            return false;
-        } else {
-            $atIndex = strrpos($email, "@");
-            $domain = substr($email, $atIndex + 1);
-            $local = substr($email, 0, $atIndex);
-            $localLen = strlen($local);
-            $domainLen = strlen($domain);
-            if ($localLen < 1 || $localLen > 64) {
-                // local part length exceeded
-                return false;
-            } else if ($domainLen < 1 || $domainLen > 255) {
-                // domain part length exceeded
-                return false;
-            } else if ($local[0] === '.' || $local[$localLen - 1] === '.') {
-                // local part starts or ends with '.'
-                return false;
-            } else if (preg_match('/\\.\\./', $local)) {
-                // local part has two consecutive dots
-                return false;
-            } else if (preg_match('/\\.\\./', $domain)) {
-                // domain part has two consecutive dots
-                return false;
-            } else if ($validation_level === 'wp_default') {
-                return is_email($email);
-            } else if (
-                ($validation_level === 'i18n' || $validation_level === 'i18n_dns')
-                // plz see http://stackoverflow.com/a/24817336 re: the following regex
-                && ! preg_match(
-                    '/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u',
-                    $email
-                )
-            ) {
-                return false;
-            }
-            if ($validation_level === 'i18n_dns') {
-                if (! checkdnsrr($domain, "MX")) {
-                    // domain not found in MX records
-                    throw new EE_Validation_Error(
-                        __(
-                            'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
-                            'event_espresso'
-                        )
-                    );
-                } else if (! checkdnsrr($domain, "A")) {
-                    // domain not found in A records
-                    throw new EE_Validation_Error(
-                        __(
-                            'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
-                            'event_espresso'
-                        )
-                    );
-                }
-            }
-        }
-        // you have successfully run the gauntlet young Padawan
-        return true;
-    }
+	/**
+	 * Validate an email address.
+	 * Provide email address (raw input)
+	 *
+	 * @param $email
+	 * @return bool of whether the email is valid or not
+	 * @throws \EE_Validation_Error
+	 */
+	private function _validate_email($email)
+	{
+		$validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+			? EE_Registry::instance()->CFG->registration->email_validation_level
+			: 'wp_default';
+		if (! preg_match('/^.+\@\S+$/', $email)) { // \.\S+
+			// email not in correct {string}@{string} format
+			return false;
+		} else {
+			$atIndex = strrpos($email, "@");
+			$domain = substr($email, $atIndex + 1);
+			$local = substr($email, 0, $atIndex);
+			$localLen = strlen($local);
+			$domainLen = strlen($domain);
+			if ($localLen < 1 || $localLen > 64) {
+				// local part length exceeded
+				return false;
+			} else if ($domainLen < 1 || $domainLen > 255) {
+				// domain part length exceeded
+				return false;
+			} else if ($local[0] === '.' || $local[$localLen - 1] === '.') {
+				// local part starts or ends with '.'
+				return false;
+			} else if (preg_match('/\\.\\./', $local)) {
+				// local part has two consecutive dots
+				return false;
+			} else if (preg_match('/\\.\\./', $domain)) {
+				// domain part has two consecutive dots
+				return false;
+			} else if ($validation_level === 'wp_default') {
+				return is_email($email);
+			} else if (
+				($validation_level === 'i18n' || $validation_level === 'i18n_dns')
+				// plz see http://stackoverflow.com/a/24817336 re: the following regex
+				&& ! preg_match(
+					'/^(?!\.)((?!.*\.{2})[a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\.!#$%&\'*+-\/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}\-\.\d]+)((\.([a-zA-Z\x{0080}-\x{00FF}\x{0100}-\x{017F}\x{0180}-\x{024F}\x{0250}-\x{02AF}\x{0300}-\x{036F}\x{0370}-\x{03FF}\x{0400}-\x{04FF}\x{0500}-\x{052F}\x{0530}-\x{058F}\x{0590}-\x{05FF}\x{0600}-\x{06FF}\x{0700}-\x{074F}\x{0750}-\x{077F}\x{0780}-\x{07BF}\x{07C0}-\x{07FF}\x{0900}-\x{097F}\x{0980}-\x{09FF}\x{0A00}-\x{0A7F}\x{0A80}-\x{0AFF}\x{0B00}-\x{0B7F}\x{0B80}-\x{0BFF}\x{0C00}-\x{0C7F}\x{0C80}-\x{0CFF}\x{0D00}-\x{0D7F}\x{0D80}-\x{0DFF}\x{0E00}-\x{0E7F}\x{0E80}-\x{0EFF}\x{0F00}-\x{0FFF}\x{1000}-\x{109F}\x{10A0}-\x{10FF}\x{1100}-\x{11FF}\x{1200}-\x{137F}\x{1380}-\x{139F}\x{13A0}-\x{13FF}\x{1400}-\x{167F}\x{1680}-\x{169F}\x{16A0}-\x{16FF}\x{1700}-\x{171F}\x{1720}-\x{173F}\x{1740}-\x{175F}\x{1760}-\x{177F}\x{1780}-\x{17FF}\x{1800}-\x{18AF}\x{1900}-\x{194F}\x{1950}-\x{197F}\x{1980}-\x{19DF}\x{19E0}-\x{19FF}\x{1A00}-\x{1A1F}\x{1B00}-\x{1B7F}\x{1D00}-\x{1D7F}\x{1D80}-\x{1DBF}\x{1DC0}-\x{1DFF}\x{1E00}-\x{1EFF}\x{1F00}-\x{1FFF}\x{20D0}-\x{20FF}\x{2100}-\x{214F}\x{2C00}-\x{2C5F}\x{2C60}-\x{2C7F}\x{2C80}-\x{2CFF}\x{2D00}-\x{2D2F}\x{2D30}-\x{2D7F}\x{2D80}-\x{2DDF}\x{2F00}-\x{2FDF}\x{2FF0}-\x{2FFF}\x{3040}-\x{309F}\x{30A0}-\x{30FF}\x{3100}-\x{312F}\x{3130}-\x{318F}\x{3190}-\x{319F}\x{31C0}-\x{31EF}\x{31F0}-\x{31FF}\x{3200}-\x{32FF}\x{3300}-\x{33FF}\x{3400}-\x{4DBF}\x{4DC0}-\x{4DFF}\x{4E00}-\x{9FFF}\x{A000}-\x{A48F}\x{A490}-\x{A4CF}\x{A700}-\x{A71F}\x{A800}-\x{A82F}\x{A840}-\x{A87F}\x{AC00}-\x{D7AF}\x{F900}-\x{FAFF}]){2,63})+)$/u',
+					$email
+				)
+			) {
+				return false;
+			}
+			if ($validation_level === 'i18n_dns') {
+				if (! checkdnsrr($domain, "MX")) {
+					// domain not found in MX records
+					throw new EE_Validation_Error(
+						__(
+							'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
+							'event_espresso'
+						)
+					);
+				} else if (! checkdnsrr($domain, "A")) {
+					// domain not found in A records
+					throw new EE_Validation_Error(
+						__(
+							'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
+							'event_espresso'
+						)
+					);
+				}
+			}
+		}
+		// you have successfully run the gauntlet young Padawan
+		return true;
+	}
 
 
 }

Spacing +5 added lines, -5 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -20,7 +20,7 @@ 
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = __("Please enter a valid email address.", "event_espresso");
         }
         parent::__construct($validation_error_message);
@@ -67,7 +67,7 @@ 
         $validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
             ? EE_Registry::instance()->CFG->registration->email_validation_level
             : 'wp_default';
-        if (! preg_match('/^.+\@\S+$/', $email)) { // \.\S+
+        if ( ! preg_match('/^.+\@\S+$/', $email)) { // \.\S+
             // email not in correct {string}@{string} format
             return false;
         } else {
@@ -104,7 +104,7 @@ 
                 return false;
             }
             if ($validation_level === 'i18n_dns') {
-                if (! checkdnsrr($domain, "MX")) {
+                if ( ! checkdnsrr($domain, "MX")) {
                     // domain not found in MX records
                     throw new EE_Validation_Error(
                         __(
@@ -112,7 +112,7 @@ 
                             'event_espresso'
                         )
                     );
-                } else if (! checkdnsrr($domain, "A")) {
+                } else if ( ! checkdnsrr($domain, "A")) {
                     // domain not found in A records
                     throw new EE_Validation_Error(
                         __(

core/libraries/messages/EE_Message_Template_Group_Collection.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
     /**
      * This retrieves any EE_Message_Template_Group in the repo by its ID.
      *
-     * @param $GRP_ID
+     * @param integer $GRP_ID
      * @return EE_Message_Template_Group | null
      */
     public function get_by_ID($GRP_ID)

Indentation +100 added lines, -100 removed lines

@@ -14,115 +14,115 @@
 {
 
 
-    /**
-     * EE_Message_Template_Group_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message_Template_Group';
-    }
+	/**
+	 * EE_Message_Template_Group_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message_Template_Group';
+	}
 
 
-    /**
-     * Adds the Message Template Group object to the repository.
-     *
-     * @param           $message_template_group
-     * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
-     *                         indexing the template by key.  If this template is shared among multiple events then
-     *                         include the events as an array.
-     * @return bool
-     */
-    public function add($message_template_group, $EVT_ID = array())
-    {
-        $EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
-        if ($message_template_group instanceof $this->interface) {
-            $data['key'] = $this->getKey(
-                $message_template_group->messenger(),
-                $message_template_group->message_type(),
-                $EVT_ID
-            );
-            return parent::add($message_template_group, $data);
-        }
-        return false;
-    }
+	/**
+	 * Adds the Message Template Group object to the repository.
+	 *
+	 * @param           $message_template_group
+	 * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
+	 *                         indexing the template by key.  If this template is shared among multiple events then
+	 *                         include the events as an array.
+	 * @return bool
+	 */
+	public function add($message_template_group, $EVT_ID = array())
+	{
+		$EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
+		if ($message_template_group instanceof $this->interface) {
+			$data['key'] = $this->getKey(
+				$message_template_group->messenger(),
+				$message_template_group->message_type(),
+				$EVT_ID
+			);
+			return parent::add($message_template_group, $data);
+		}
+		return false;
+	}
 
 
-    /**
-     * This retrieves any EE_Message_Template_Group in the repo by its ID.
-     *
-     * @param $GRP_ID
-     * @return EE_Message_Template_Group | null
-     */
-    public function get_by_ID($GRP_ID)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->ID() === $GRP_ID) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This retrieves any EE_Message_Template_Group in the repo by its ID.
+	 *
+	 * @param $GRP_ID
+	 * @return EE_Message_Template_Group | null
+	 */
+	public function get_by_ID($GRP_ID)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->ID() === $GRP_ID) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group.
-     *
-     * @param string $messenger    The EE_messenger->name
-     * @param string $message_type The EE_message_type->name
-     * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
-     * @deprecated 4.9.40.rc.017  Use getKey instead.
-     * @return string
-     */
-    public function get_key($messenger, $message_type, $EVT_ID = 0)
-    {
-        $EVT_ID = (array) $EVT_ID;
-        return $this->getKey($messenger, $message_type, $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group.
+	 *
+	 * @param string $messenger    The EE_messenger->name
+	 * @param string $message_type The EE_message_type->name
+	 * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
+	 * @deprecated 4.9.40.rc.017  Use getKey instead.
+	 * @return string
+	 */
+	public function get_key($messenger, $message_type, $EVT_ID = 0)
+	{
+		$EVT_ID = (array) $EVT_ID;
+		return $this->getKey($messenger, $message_type, $EVT_ID);
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group
-     * @param string    $messenger      The EE_messenger->name
-     * @param string    $message_type   The EE_message_type->name
-     * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
-     *                                  be included.
-     * @since 4.9.40.rc.017
-     * @return string
-     */
-    public function getKey($messenger, $message_type, array $EVT_ID = array())
-    {
-        sort($EVT_ID);
-        $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group
+	 * @param string    $messenger      The EE_messenger->name
+	 * @param string    $message_type   The EE_message_type->name
+	 * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
+	 *                                  be included.
+	 * @since 4.9.40.rc.017
+	 * @return string
+	 */
+	public function getKey($messenger, $message_type, array $EVT_ID = array())
+	{
+		sort($EVT_ID);
+		$EVT_ID = implode(',', array_unique($EVT_ID));
+		return md5($messenger . $message_type . $EVT_ID);
+	}
 
 
-    /**
-     * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
-     * the given string.
-     *
-     * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
-     * @return null|EE_Message_Template_Group
-     */
-    public function get_by_key($key)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $data = $this->getInfo();
-            if (isset($data['key']) && $data['key'] === $key) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
+	 * the given string.
+	 *
+	 * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
+	 * @return null|EE_Message_Template_Group
+	 */
+	public function get_by_key($key)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$data = $this->getInfo();
+			if (isset($data['key']) && $data['key'] === $key) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 }

Spacing +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
     {
         sort($EVT_ID);
         $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
+        return md5($messenger.$message_type.$EVT_ID);
     }
 
 

core/EE_Session.core.php

Spacing +148 added lines, -148 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\exceptions\InvalidSessionDataException;
 use EventEspresso\core\services\cache\CacheStorageInterface;
 
-if (!defined( 'EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed');}
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed'); }
 /**
  *
  * EE_Session class
@@ -108,7 +108,7 @@ 
 	  * array for defining default session vars
 	  * @var array
 	  */
-	 private $_default_session_vars = array (
+	 private $_default_session_vars = array(
         'id'            => null,
         'user_id'       => null,
         'ip_address'    => null,
@@ -136,8 +136,8 @@ 
 		// check if class object is instantiated
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
 		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
-		if ( ! self::$_instance instanceof EE_Session && apply_filters( 'FHEE_load_EE_Session', true ) ) {
-			self::$_instance = new self($cache_storage, $encryption );
+		if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+			self::$_instance = new self($cache_storage, $encryption);
 		}
 		return self::$_instance;
 	}
@@ -152,15 +152,15 @@ 
 	  * @throws \EE_Error
 	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
 	  */
-	 protected function __construct(CacheStorageInterface $cache_storage, EE_Encryption $encryption = null ) {
+	 protected function __construct(CacheStorageInterface $cache_storage, EE_Encryption $encryption = null) {
 
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-		if ( ! apply_filters( 'FHEE_load_EE_Session', true ) ) {
+		if ( ! apply_filters('FHEE_load_EE_Session', true)) {
 			return;
 		}
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		if ( ! defined( 'ESPRESSO_SESSION' ) ) {
-			define( 'ESPRESSO_SESSION', true );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
 		}
 		// default session lifespan in seconds
 		$this->_lifespan = apply_filters(
@@ -174,12 +174,12 @@ 
 		 * 		}
 		 */
 		// retrieve session options from db
-		$session_settings = (array) get_option( 'ee_session_settings', array() );
-		if ( ! empty( $session_settings )) {
+		$session_settings = (array) get_option('ee_session_settings', array());
+		if ( ! empty($session_settings)) {
 			// cycle though existing session options
-			foreach ( $session_settings as $var_name => $session_setting ) {
+			foreach ($session_settings as $var_name => $session_setting) {
 				// set values for class properties
-				$var_name = '_' . $var_name;
+				$var_name = '_'.$var_name;
 				$this->{$var_name} = $session_setting;
 			}
 		}
@@ -190,15 +190,15 @@ 
         // encrypt data via: $this->encryption->encrypt();
         $this->encryption = $encryption;
 		// filter hook allows outside functions/classes/plugins to change default empty cart
-		$extra_default_session_vars = apply_filters( 'FHEE__EE_Session__construct__extra_default_session_vars', array() );
-		array_merge( $this->_default_session_vars, $extra_default_session_vars );
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
 		// apply default session vars
 		$this->_set_defaults();
          add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
          // check request for 'clear_session' param
-		add_action( 'AHEE__EE_Request_Handler__construct__complete', array( $this, 'wp_loaded' ));
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
 		// once everything is all said and done,
-		add_action( 'shutdown', array( $this, 'update' ), 100 );
+		add_action('shutdown', array($this, 'update'), 100);
          $this->configure_garbage_collection_filters();
 	}
 
@@ -286,11 +286,11 @@ 
 	 */
 	private function _set_defaults() {
 		// set some defaults
-		foreach ( $this->_default_session_vars as $key => $default_var ) {
-			if ( is_array( $default_var )) {
-				$this->_session_data[ $key ] = array();
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[$key] = array();
 			} else {
-				$this->_session_data[ $key ] = '';
+				$this->_session_data[$key] = '';
 			}
 		}
 	}
@@ -345,7 +345,7 @@ 
 	  * @param \EE_Checkout $checkout
 	  * @return bool
 	  */
-	 public function set_checkout( EE_Checkout $checkout ) {
+	 public function set_checkout(EE_Checkout $checkout) {
 		 $this->_session_data['checkout'] = $checkout;
 		 return TRUE;
 	 }
@@ -378,9 +378,9 @@ 
 	  * @return bool
 	  * @throws \EE_Error
 	  */
-	 public function set_transaction( EE_Transaction $transaction ) {
+	 public function set_transaction(EE_Transaction $transaction) {
 		 // first remove the session from the transaction before we save the transaction in the session
-		 $transaction->set_txn_session_data( NULL );
+		 $transaction->set_txn_session_data(NULL);
 		 $this->_session_data['transaction'] = $transaction;
 		 return TRUE;
 	 }
@@ -416,15 +416,15 @@ 
 	  * @param bool $reset_cache
 	  * @return    array
 	  */
-	public function get_session_data( $key = NULL, $reset_cache = FALSE ) {
-		if ( $reset_cache ) {
+	public function get_session_data($key = NULL, $reset_cache = FALSE) {
+		if ($reset_cache) {
 			$this->reset_cart();
 			$this->reset_checkout();
 			$this->reset_transaction();
 		}
-		 if ( ! empty( $key ))  {
-			return  isset( $this->_session_data[ $key ] ) ? $this->_session_data[ $key ] : NULL;
-		}  else  {
+		 if ( ! empty($key)) {
+			return  isset($this->_session_data[$key]) ? $this->_session_data[$key] : NULL;
+		} else {
 			return $this->_session_data;
 		}
 	}
@@ -437,20 +437,20 @@ 
 	  * @param 	array $data
 	  * @return 	TRUE on success, FALSE on fail
 	  */
-	public function set_session_data( $data ) {
+	public function set_session_data($data) {
 
 		// nothing ??? bad data ??? go home!
-		if ( empty( $data ) || ! is_array( $data )) {
-			EE_Error::add_error( __( 'No session data or invalid session data was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(__('No session data or invalid session data was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 
-		foreach ( $data as $key =>$value ) {
-			if ( isset( $this->_default_session_vars[ $key ] )) {
-				EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $key ), __FILE__, __FUNCTION__, __LINE__ );
+		foreach ($data as $key =>$value) {
+			if (isset($this->_default_session_vars[$key])) {
+				EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $key), __FILE__, __FUNCTION__, __LINE__);
 				return FALSE;
 			} else {
-				$this->_session_data[ $key ] = $value;
+				$this->_session_data[$key] = $value;
 			}
 		}
 
@@ -468,9 +468,9 @@ 
 	  * @throws \EE_Error
 	  */
 	private function _espresso_session() {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 		// check that session has started
-		if ( session_id() === '' ) {
+		if (session_id() === '') {
 			//starts a new session if one doesn't already exist, or re-initiates an existing one
 			session_start();
 		}
@@ -479,39 +479,39 @@ 
 		// and the visitors IP
 		$this->_ip_address = $this->_visitor_ip();
 		// set the "user agent"
-		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr( $_SERVER['HTTP_USER_AGENT'] ) : FALSE;
+		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr($_SERVER['HTTP_USER_AGENT']) : FALSE;
 		// now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
-			$this->_time = isset( $this->_time ) ? $this->_time : time();
+			$this->_time = isset($this->_time) ? $this->_time : time();
 			// and reset the session expiration
-			$this->_expiration = isset( $session_data['expiration'] )
+			$this->_expiration = isset($session_data['expiration'])
 				? $session_data['expiration']
 				: $this->_time + $this->_lifespan;
 		} else {
             // set initial site access time and the session expiration
 			$this->_set_init_access_and_expiration();
 			// set referer
-			$this->_session_data[ 'pages_visited' ][ $this->_session_data['init_access'] ] = isset( $_SERVER['HTTP_REFERER'] )
-				? esc_attr( $_SERVER['HTTP_REFERER'] )
+			$this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['HTTP_REFERER'])
 				: '';
 			// no previous session = go back and create one (on top of the data above)
 			return FALSE;
 		}
         // now the user agent
-		if ( $session_data['user_agent'] !== $this->_user_agent ) {
+		if ($session_data['user_agent'] !== $this->_user_agent) {
 			return FALSE;
 		}
 		// wait a minute... how old are you?
-		if ( $this->_time > $this->_expiration ) {
+		if ($this->_time > $this->_expiration) {
 			// yer too old fer me!
             $this->_expired = true;
 			// wipe out everything that isn't a default session datum
-			$this->clear_session( __CLASS__, __FUNCTION__ );
+			$this->clear_session(__CLASS__, __FUNCTION__);
 		}
 		// make event espresso session data available to plugin
-		$this->_session_data = array_merge( $this->_session_data, $session_data );
+		$this->_session_data = array_merge($this->_session_data, $session_data);
 		return TRUE;
 
 	}
@@ -527,7 +527,7 @@ 
       */
      protected function _retrieve_session_data()
      {
-         $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+         $ssn_key = EE_Session::session_id_prefix.$this->_sid;
          try {
              // we're using WP's Transient API to store session data using the PHP session ID as the option name
              $session_data = $this->cache_storage->get($ssn_key, false);
@@ -536,7 +536,7 @@ 
              }
              if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                  $hash_check = $this->cache_storage->get(
-                     EE_Session::hash_check_prefix . $this->_sid,
+                     EE_Session::hash_check_prefix.$this->_sid,
                      false
                  );
                  if ($hash_check && $hash_check !== md5($session_data)) {
@@ -546,7 +546,7 @@ 
                                  'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                  'event_espresso'
                              ),
-                             EE_Session::session_id_prefix . $this->_sid
+                             EE_Session::session_id_prefix.$this->_sid
                          ),
                          __FILE__, __FUNCTION__, __LINE__
                      );
@@ -558,17 +558,17 @@ 
              $row = $wpdb->get_row(
                  $wpdb->prepare(
                      "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                     '_transient_' . $ssn_key
+                     '_transient_'.$ssn_key
                  )
              );
              $session_data = is_object($row) ? $row->option_value : null;
              if ($session_data) {
                  $session_data = preg_replace_callback(
                      '!s:(d+):"(.*?)";!',
-                     function ($match) {
+                     function($match) {
                          return $match[1] === strlen($match[2])
                              ? $match[0]
-                             : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                             : 's:'.strlen($match[2]).':"'.$match[2].'";';
                      },
                      $session_data
                  );
@@ -589,7 +589,7 @@ 
                      'event_espresso'
                  );
                  $msg .= WP_DEBUG
-                     ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                     ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                      : '';
                  throw new InvalidSessionDataException($msg, 0, $e);
              }
@@ -602,11 +602,11 @@ 
                  'event_espresso'
              );
              $msg .= WP_DEBUG
-                 ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                 ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                  : '';
 	         throw new InvalidSessionDataException($msg);
          }
-	     if ( isset($session_data['transaction'] ) && absint($session_data['transaction'] ) !== 0 ) {
+	     if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
              $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
                  $session_data['transaction']
 	         );
@@ -627,12 +627,12 @@ 
 	  */
 	protected function _generate_session_id() {
 		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-		if ( isset( $_REQUEST[ 'EESID' ] ) ) {
-			$session_id = sanitize_text_field( $_REQUEST[ 'EESID' ] );
+		if (isset($_REQUEST['EESID'])) {
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
 		} else {
-			$session_id = md5( session_id() . get_current_blog_id() . $this->_get_sid_salt() );
+			$session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
 		}
-		return apply_filters( 'FHEE__EE_Session___generate_session_id__session_id', $session_id );
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
 	}
 
 
@@ -644,20 +644,20 @@ 
 	  */
 	protected function _get_sid_salt() {
 		// was session id salt already saved to db ?
-		if ( empty( $this->_sid_salt ) ) {
+		if (empty($this->_sid_salt)) {
 			// no?  then maybe use WP defined constant
-			if ( defined( 'AUTH_SALT' ) ) {
+			if (defined('AUTH_SALT')) {
 				$this->_sid_salt = AUTH_SALT;
 			}
 			// if salt doesn't exist or is too short
-			if ( strlen( $this->_sid_salt ) < 32 ) {
+			if (strlen($this->_sid_salt) < 32) {
 				// create a new one
-				$this->_sid_salt = wp_generate_password( 64 );
+				$this->_sid_salt = wp_generate_password(64);
 			}
 			// and save it as a permanent session setting
-			$session_settings = get_option( 'ee_session_settings' );
-			$session_settings[ 'sid_salt' ] = $this->_sid_salt;
-			update_option( 'ee_session_settings', $session_settings );
+			$session_settings = get_option('ee_session_settings');
+			$session_settings['sid_salt'] = $this->_sid_salt;
+			update_option('ee_session_settings', $session_settings);
 		}
 		return $this->_sid_salt;
 	}
@@ -686,19 +686,19 @@ 
       * @return TRUE on success, FALSE on fail
       * @throws \EE_Error
       */
-	public function update( $new_session = FALSE ) {
-		$this->_session_data = isset( $this->_session_data )
-			&& is_array( $this->_session_data )
-			&& isset( $this->_session_data['id'])
+	public function update($new_session = FALSE) {
+		$this->_session_data = isset($this->_session_data)
+			&& is_array($this->_session_data)
+			&& isset($this->_session_data['id'])
 			? $this->_session_data
 			: array();
-		if ( empty( $this->_session_data )) {
+		if (empty($this->_session_data)) {
 			$this->_set_defaults();
 		}
 		$session_data = array();
-		foreach ( $this->_session_data as $key => $value ) {
+		foreach ($this->_session_data as $key => $value) {
 
-			switch( $key ) {
+			switch ($key) {
 
 				case 'id' :
 					// session ID
@@ -716,7 +716,7 @@ 
 				break;
 
 				case 'init_access' :
-					$session_data['init_access'] = absint( $value );
+					$session_data['init_access'] = absint($value);
 				break;
 
 				case 'last_access' :
@@ -726,7 +726,7 @@ 
 
 				case 'expiration' :
 					// when the session expires
-					$session_data['expiration'] = ! empty( $this->_expiration )
+					$session_data['expiration'] = ! empty($this->_expiration)
 						? $this->_expiration
 						: $session_data['init_access'] + $this->_lifespan;
 				break;
@@ -738,11 +738,11 @@ 
 
 				case 'pages_visited' :
 					$page_visit = $this->_get_page_visit();
-					if ( $page_visit ) {
+					if ($page_visit) {
 						// set pages visited where the first will be the http referrer
-						$this->_session_data[ 'pages_visited' ][ $this->_time ] = $page_visit;
+						$this->_session_data['pages_visited'][$this->_time] = $page_visit;
 						// we'll only save the last 10 page visits.
-						$session_data[ 'pages_visited' ] = array_slice( $this->_session_data['pages_visited'], -10 );
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
 					}
 				break;
 
@@ -756,9 +756,9 @@ 
 
 		$this->_session_data = $session_data;
 		// creating a new session does not require saving to the db just yet
-		if ( ! $new_session ) {
+		if ( ! $new_session) {
 			// ready? let's save
-			if ( $this->_save_session_to_db() ) {
+			if ($this->_save_session_to_db()) {
 				return TRUE;
 			} else {
 				return FALSE;
@@ -778,9 +778,9 @@ 
       * @throws \EE_Error
       */
 	private function _create_espresso_session( ) {
-		do_action( 'AHEE_log', __CLASS__, __FUNCTION__, '' );
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
 		// use the update function for now with $new_session arg set to TRUE
-		return  $this->update( TRUE ) ? TRUE : FALSE;
+		return  $this->update(TRUE) ? TRUE : FALSE;
 	}
 
 
@@ -800,7 +800,7 @@ 
                 EE_Registry::instance()->REQ->front_ajax
                 || (
                     // OR an admin request that is NOT AJAX
-					! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
+					! (defined('DOING_AJAX') && DOING_AJAX)
                     && is_admin()
 				)
                 || (
@@ -813,8 +813,8 @@ 
 			return false;
 		}
 		$transaction = $this->transaction();
-		if ( $transaction instanceof EE_Transaction ) {
-			if ( ! $transaction->ID() ) {
+		if ($transaction instanceof EE_Transaction) {
+			if ( ! $transaction->ID()) {
 				$transaction->save();
 			}
 			$this->_session_data['transaction'] = $transaction->ID();
@@ -823,19 +823,19 @@ 
 		$session_data = serialize($this->_session_data);
 		// do we need to also encode it to avoid corrupted data when saved to the db?
 		$session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode( $session_data )
+            ? $this->encryption->base64_string_encode($session_data)
             : $session_data;
 		// maybe save hash check
-		if ( apply_filters( 'FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG ) ) {
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->_lifespan
             );
         }
         // we're using the Transient API for storing session data,
         return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->_lifespan
         );
@@ -864,10 +864,10 @@ 
 			'HTTP_FORWARDED',
 			'REMOTE_ADDR'
 		);
-		foreach ( $server_keys as $key ){
-			if ( isset( $_SERVER[ $key ] )) {
-				foreach ( array_map( 'trim', explode( ',', $_SERVER[ $key ] )) as $ip ) {
-					if ( $ip === '127.0.0.1' || filter_var( $ip, FILTER_VALIDATE_IP ) !== FALSE ) {
+		foreach ($server_keys as $key) {
+			if (isset($_SERVER[$key])) {
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== FALSE) {
 						$visitor_ip = $ip;
 					}
 				}
@@ -886,32 +886,32 @@ 
 	 *			@return string
 	 */
 	public function _get_page_visit() {
-		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		$page_visit = home_url('/').'wp-admin/admin-ajax.php';
 		// check for request url
-		if ( isset( $_SERVER['REQUEST_URI'] )) {
+		if (isset($_SERVER['REQUEST_URI'])) {
 			$http_host = '';
 			$page_id = '?';
 			$e_reg = '';
-			$request_uri = esc_url( $_SERVER['REQUEST_URI'] );
-			$ru_bits = explode( '?', $request_uri );
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
+			$ru_bits = explode('?', $request_uri);
 			$request_uri = $ru_bits[0];
 			// check for and grab host as well
-			if ( isset( $_SERVER['HTTP_HOST'] )) {
-				$http_host = esc_url( $_SERVER['HTTP_HOST'] );
+			if (isset($_SERVER['HTTP_HOST'])) {
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
 			}
 			// check for page_id in SERVER REQUEST
-			if ( isset( $_REQUEST['page_id'] )) {
+			if (isset($_REQUEST['page_id'])) {
 				// rebuild $e_reg without any of the extra parameters
-				$page_id = '?page_id=' . esc_attr( $_REQUEST['page_id'] ) . '&amp;';
+				$page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
 			}
 			// check for $e_reg in SERVER REQUEST
-			if ( isset( $_REQUEST['ee'] )) {
+			if (isset($_REQUEST['ee'])) {
 				// rebuild $e_reg without any of the extra parameters
-				$e_reg = 'ee=' . esc_attr( $_REQUEST['ee'] );
+				$e_reg = 'ee='.esc_attr($_REQUEST['ee']);
 			}
-			$page_visit = rtrim( $http_host . $request_uri . $page_id . $e_reg, '?' );
+			$page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
 		}
-		return $page_visit !== home_url( '/wp-admin/admin-ajax.php' ) ? $page_visit : '';
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
 
 	}
 
@@ -941,14 +941,14 @@ 
       * @return void
       * @throws \EE_Error
       */
-	public function clear_session( $class = '', $function = '' ) {
+	public function clear_session($class = '', $function = '') {
 		//echo '<h3 style="color:#999;line-height:.9em;"><span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/><span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b></h3>';
-        do_action( 'AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' .  $function . '()' );
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
 		$this->reset_cart();
 		$this->reset_checkout();
 		$this->reset_transaction();
 		// wipe out everything that isn't a default session datum
-		$this->reset_data( array_keys( $this->_session_data ));
+		$this->reset_data(array_keys($this->_session_data));
 		// reset initial site access time and the session expiration
 		$this->_set_init_access_and_expiration();
 		$this->_save_session_to_db();
@@ -963,42 +963,42 @@ 
 	  * @param bool  $show_all_notices
 	  * @return TRUE on success, FALSE on fail
 	  */
-	public function reset_data( $data_to_reset = array(), $show_all_notices = FALSE ) {
+	public function reset_data($data_to_reset = array(), $show_all_notices = FALSE) {
 		// if $data_to_reset is not in an array, then put it in one
-		if ( ! is_array( $data_to_reset ) ) {
-			$data_to_reset = array ( $data_to_reset );
+		if ( ! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
 		}
 		// nothing ??? go home!
-		if ( empty( $data_to_reset )) {
-			EE_Error::add_error( __( 'No session data could be reset, because no session var name was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(__('No session data could be reset, because no session var name was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		$return_value = TRUE;
 		// since $data_to_reset is an array, cycle through the values
-		foreach ( $data_to_reset as $reset ) {
+		foreach ($data_to_reset as $reset) {
 
 			// first check to make sure it is a valid session var
-			if ( isset( $this->_session_data[ $reset ] )) {
+			if (isset($this->_session_data[$reset])) {
 				// then check to make sure it is not a default var
-				if ( ! array_key_exists( $reset, $this->_default_session_vars )) {
+				if ( ! array_key_exists($reset, $this->_default_session_vars)) {
 					// remove session var
-					unset( $this->_session_data[ $reset ] );
-					if ( $show_all_notices ) {
-						EE_Error::add_success( sprintf( __( 'The session variable %s was removed.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+					unset($this->_session_data[$reset]);
+					if ($show_all_notices) {
+						EE_Error::add_success(sprintf(__('The session variable %s was removed.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 					}
-					$return_value = !isset($return_value) ? TRUE : $return_value;
+					$return_value = ! isset($return_value) ? TRUE : $return_value;
 
 				} else {
 					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
-					if ( $show_all_notices ) {
-						EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+					if ($show_all_notices) {
+						EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 					}
 					$return_value = FALSE;
 				}
 
-			} else if ( $show_all_notices ) {
+			} else if ($show_all_notices) {
 				// oops! that session var does not exist!
-				EE_Error::add_error( sprintf( __( 'The session item provided, %s, is invalid or does not exist.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error(sprintf(__('The session item provided, %s, is invalid or does not exist.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 				$return_value = FALSE;
 			}
 
@@ -1017,8 +1017,8 @@ 
       * @throws \EE_Error
       */
 	public function wp_loaded() {
-		if ( isset(  EE_Registry::instance()->REQ ) && EE_Registry::instance()->REQ->is_set( 'clear_session' )) {
-			$this->clear_session( __CLASS__, __FUNCTION__ );
+		if (isset(EE_Registry::instance()->REQ) && EE_Registry::instance()->REQ->is_set('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
 		}
 	}
 
@@ -1054,7 +1054,7 @@ 
              // or use that for the new transient cleanup query limit
              add_filter(
                  'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                 function () use ($expired_session_transient_delete_query_limit) {
+                 function() use ($expired_session_transient_delete_query_limit) {
                      return $expired_session_transient_delete_query_limit;
                  }
              );
@@ -1068,34 +1068,34 @@ 
 	  * @param $data1
 	  * @return string
 	  */
-	 private function find_serialize_error( $data1 ) {
+	 private function find_serialize_error($data1) {
 		$error = '<pre>';
 		 $data2 = preg_replace_callback(
 			 '!s:(\d+):"(.*?)";!',
-			 function ( $match ) {
-				 return ( $match[1] === strlen( $match[2] ) )
+			 function($match) {
+				 return ($match[1] === strlen($match[2]))
 					 ? $match[0]
 					 : 's:'
-					   . strlen( $match[2] )
+					   . strlen($match[2])
 					   . ':"'
 					   . $match[2]
 					   . '";';
 			 },
 			 $data1
 		 );
-		$max = ( strlen( $data1 ) > strlen( $data2 ) ) ? strlen( $data1 ) : strlen( $data2 );
-		$error .= $data1 . PHP_EOL;
-		$error .= $data2 . PHP_EOL;
-		for ( $i = 0; $i < $max; $i++ ) {
-			if ( @$data1[ $i ] !== @$data2[ $i ] ) {
-				$error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-				$error .= "\t-> ORD number " . ord( @$data1[ $i ] ) . ' != ' . ord( @$data2[ $i ] ) . PHP_EOL;
-				$error .= "\t-> Line Number = $i" . PHP_EOL;
-				$start = ( $i - 20 );
-				$start = ( $start < 0 ) ? 0 : $start;
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1.PHP_EOL;
+		$error .= $data2.PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[$i] !== @$data2[$i]) {
+				$error .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+				$error .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+				$error .= "\t-> Line Number = $i".PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
 				$length = 40;
 				$point = $max - $i;
-				if ( $point < 20 ) {
+				if ($point < 20) {
 					$rlength = 1;
 					$rpoint = -$point;
 				} else {
@@ -1104,16 +1104,16 @@ 
 				}
 				$error .= "\t-> Section Data1  = ";
 				$error .= substr_replace(
-					substr( $data1, $start, $length ),
-					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[$i]}</b>",
 					$rpoint,
 					$rlength
 				);
 				$error .= PHP_EOL;
 				$error .= "\t-> Section Data2  = ";
 				$error .= substr_replace(
-					substr( $data2, $start, $length ),
-					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[$i]}</b>",
 					$rpoint,
 					$rlength
 				);

core/domain/entities/shortcodes/EspressoTicketSelector.php

Indentation +76 added lines, -76 removed lines

@@ -24,82 +24,82 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TICKET_SELECTOR';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return MINUTE_IN_SECONDS;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    public function processShortcode($attributes = array())
-    {
-        extract($attributes, EXTR_OVERWRITE);
-        $event_id = isset($event_id) ? $event_id : 0;
-        $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
-            new ExceptionStackTraceDisplay(
-                new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that it\'s value corresponds to a valid Event ID.',
-                            'event_espresso'
-                        ),
-                        $this->getTag(),
-                        $event_id,
-                        'event_id',
-                        '<br />'
-                    )
-                )
-            );
-            return '';
-        }
-        ob_start();
-        do_action('AHEE_event_details_before_post', $event_id);
-        espresso_ticket_selector($event);
-        do_action('AHEE_event_details_after_post');
-        return ob_get_clean();
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TICKET_SELECTOR';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return MINUTE_IN_SECONDS;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	public function processShortcode($attributes = array())
+	{
+		extract($attributes, EXTR_OVERWRITE);
+		$event_id = isset($event_id) ? $event_id : 0;
+		$event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
+		if (! $event instanceof EE_Event) {
+			new ExceptionStackTraceDisplay(
+				new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that it\'s value corresponds to a valid Event ID.',
+							'event_espresso'
+						),
+						$this->getTag(),
+						$event_id,
+						'event_id',
+						'<br />'
+					)
+				)
+			);
+			return '';
+		}
+		ob_start();
+		do_action('AHEE_event_details_before_post', $event_id);
+		espresso_ticket_selector($event);
+		do_action('AHEE_event_details_after_post');
+		return ob_get_clean();
+	}
 
 
 }

Spacing +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
         extract($attributes, EXTR_OVERWRITE);
         $event_id = isset($event_id) ? $event_id : 0;
         $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             new ExceptionStackTraceDisplay(
                 new InvalidArgumentException(
                     sprintf(