eventespresso / event-espresso-core

core/EE_Config.core.php

Spacing +122 added lines, -122 removed lines

@@ -145,7 +145,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Config) {
+        if ( ! self::$_instance instanceof EE_Config) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -283,7 +283,7 @@ 
                 $this
             );
             if (is_object($settings) && property_exists($this, $config)) {
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
+                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__'.$config, $settings);
                 // call configs populate method to ensure any defaults are set for empty values.
                 if (method_exists($settings, 'populate')) {
                     $this->{$config}->populate();
@@ -556,7 +556,7 @@ 
                         break;
                     // TEST #2 : check that settings section exists
                     case 2:
-                        if (! isset($this->{$section})) {
+                        if ( ! isset($this->{$section})) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -570,7 +570,7 @@ 
                         break;
                     // TEST #3 : check that section is the proper format
                     case 3:
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
+                        if ( ! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
                         ) {
                             if ($display_errors) {
                                 throw new EE_Error(
@@ -616,7 +616,7 @@ 
                         break;
                     // TEST #6 : verify config class is accessible
                     case 6:
-                        if (! class_exists($config_class)) {
+                        if ( ! class_exists($config_class)) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -633,7 +633,7 @@ 
                         break;
                     // TEST #7 : check that config has even been set
                     case 7:
-                        if (! isset($this->{$section}->{$name})) {
+                        if ( ! isset($this->{$section}->{$name})) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -651,7 +651,7 @@ 
                         break;
                     // TEST #8 : check that config is the requested type
                     case 8:
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
+                        if ( ! $this->{$section}->{$name} instanceof $config_class) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -670,7 +670,7 @@ 
                         break;
                     // TEST #9 : verify config object
                     case 9:
-                        if (! $config_obj instanceof EE_Config_Base) {
+                        if ( ! $config_obj instanceof EE_Config_Base) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -702,7 +702,7 @@ 
      */
     private function _generate_config_option_name($section = '', $name = '')
     {
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
+        return 'ee_config-'.strtolower($section.'-'.str_replace(array('EE_', 'EED_'), '', $name));
     }
 
 
@@ -719,7 +719,7 @@ 
     {
         return ! empty($config_class)
             ? $config_class
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
+            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))).'_Config';
     }
 
 
@@ -738,17 +738,17 @@ 
         // ensure config class is set to something
         $config_class = $this->_set_config_class($config_class, $name);
         // run tests 1-4, 6, and 7 to verify all config params are set and valid
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
             return null;
         }
         $config_option_name = $this->_generate_config_option_name($section, $name);
         // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
+        if ( ! isset($this->_addon_option_names[$config_option_name])) {
+            $this->_addon_option_names[$config_option_name] = $config_class;
             $this->update_addon_option_names();
         }
         // verify the incoming config object but suppress errors
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
             $config_obj = new $config_class();
         }
         if (get_option($config_option_name)) {
@@ -795,7 +795,7 @@ 
         // get class name of the incoming object
         $config_class = get_class($config_obj);
         // run tests 1-5 and 9 to verify config
-        if (! $this->_verify_config_params(
+        if ( ! $this->_verify_config_params(
             $section,
             $name,
             $config_class,
@@ -807,7 +807,7 @@ 
         }
         $config_option_name = $this->_generate_config_option_name($section, $name);
         // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
+        if ( ! isset($this->_addon_option_names[$config_option_name])) {
             // save new config to db
             if ($this->set_config($section, $name, $config_class, $config_obj)) {
                 return true;
@@ -833,7 +833,7 @@ 
                             'event_espresso'
                         ),
                         $config_class,
-                        'EE_Config->' . $section . '->' . $name
+                        'EE_Config->'.$section.'->'.$name
                     ),
                     __FILE__,
                     __FUNCTION__,
@@ -859,7 +859,7 @@ 
         // ensure config class is set to something
         $config_class = $this->_set_config_class($config_class, $name);
         // run tests 1-4, 6 and 7 to verify that all params have been set
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
             return null;
         }
         // now test if the requested config object exists, but suppress errors
@@ -904,7 +904,7 @@ 
         // retrieve the wp-option for this config class.
         $config_option = maybe_unserialize(get_option($config_option_name, array()));
         if (empty($config_option)) {
-            EE_Config::log($config_option_name . '-NOT-FOUND');
+            EE_Config::log($config_option_name.'-NOT-FOUND');
         }
         return $config_option;
     }
@@ -922,7 +922,7 @@ 
             // copy incoming $_REQUEST and sanitize it so we can save it
             $_request = $_REQUEST;
             array_walk_recursive($_request, 'sanitize_text_field');
-            $config_log[ (string) microtime(true) ] = array(
+            $config_log[(string) microtime(true)] = array(
                 'config_name' => $config_option_name,
                 'request'     => $_request,
             );
@@ -937,7 +937,7 @@ 
      */
     public static function trim_log()
     {
-        if (! EE_Config::logging_enabled()) {
+        if ( ! EE_Config::logging_enabled()) {
             return;
         }
         $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
@@ -961,7 +961,7 @@ 
     public static function get_page_for_posts()
     {
         $page_for_posts = get_option('page_for_posts');
-        if (! $page_for_posts) {
+        if ( ! $page_for_posts) {
             return 'posts';
         }
         /** @type WPDB $wpdb */
@@ -1011,20 +1011,20 @@ 
     {
         // only init widgets on admin pages when not in complete maintenance, and
         // on frontend when not in any maintenance mode
-        if (! EE_Maintenance_Mode::instance()->level()
+        if ( ! EE_Maintenance_Mode::instance()->level()
             || (
                 is_admin()
                 && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
             )
         ) {
             // grab list of installed widgets
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
+            $widgets_to_register = glob(EE_WIDGETS.'*', GLOB_ONLYDIR);
             // filter list of modules to register
             $widgets_to_register = apply_filters(
                 'FHEE__EE_Config__register_widgets__widgets_to_register',
                 $widgets_to_register
             );
-            if (! empty($widgets_to_register)) {
+            if ( ! empty($widgets_to_register)) {
                 // cycle thru widget folders
                 foreach ($widgets_to_register as $widget_path) {
                     // add to list of installed widget modules
@@ -1074,31 +1074,31 @@ 
         // create classname from widget directory name
         $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
         // add class prefix
-        $widget_class = 'EEW_' . $widget;
+        $widget_class = 'EEW_'.$widget;
         // does the widget exist ?
-        if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
+        if ( ! is_readable($widget_path.DS.$widget_class.$widget_ext)) {
             $msg = sprintf(
                 __(
                     'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
                     'event_espresso'
                 ),
                 $widget_class,
-                $widget_path . DS . $widget_class . $widget_ext
+                $widget_path.DS.$widget_class.$widget_ext
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return;
         }
         // load the widget class file
-        require_once($widget_path . DS . $widget_class . $widget_ext);
+        require_once($widget_path.DS.$widget_class.$widget_ext);
         // verify that class exists
-        if (! class_exists($widget_class)) {
+        if ( ! class_exists($widget_class)) {
             $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return;
         }
         register_widget($widget_class);
         // add to array of registered widgets
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
+        EE_Registry::instance()->widgets->{$widget_class} = $widget_path.DS.$widget_class.$widget_ext;
     }
 
 
@@ -1111,18 +1111,18 @@ 
     private function _register_modules()
     {
         // grab list of installed modules
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
+        $modules_to_register = glob(EE_MODULES.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $modules_to_register = apply_filters(
             'FHEE__EE_Config__register_modules__modules_to_register',
             $modules_to_register
         );
-        if (! empty($modules_to_register)) {
+        if ( ! empty($modules_to_register)) {
             // loop through folders
             foreach ($modules_to_register as $module_path) {
                 /**TEMPORARILY EXCLUDE gateways from modules for time being**/
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-                    && $module_path !== EE_MODULES . 'gateways'
+                if ($module_path !== EE_MODULES.'zzz-copy-this-module-template'
+                    && $module_path !== EE_MODULES.'gateways'
                 ) {
                     // add to list of installed modules
                     EE_Config::register_module($module_path);
@@ -1159,25 +1159,25 @@ 
             // remove last segment
             array_pop($module_path);
             // glue it back together
-            $module_path = implode(DS, $module_path) . DS;
+            $module_path = implode(DS, $module_path).DS;
             // take first segment from file name pieces and sanitize it
             $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
             // ensure class prefix is added
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
+            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_'.$module : $module;
         } else {
             // we need to generate the filename based off of the folder name
             // grab and sanitize module name
             $module = strtolower(basename($module_path));
             $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
             // like trailingslashit()
-            $module_path = rtrim($module_path, DS) . DS;
+            $module_path = rtrim($module_path, DS).DS;
             // create classname from module directory name
             $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
             // add class prefix
-            $module_class = 'EED_' . $module;
+            $module_class = 'EED_'.$module;
         }
         // does the module exist ?
-        if (! is_readable($module_path . DS . $module_class . $module_ext)) {
+        if ( ! is_readable($module_path.DS.$module_class.$module_ext)) {
             $msg = sprintf(
                 __(
                     'The requested %s module file could not be found or is not readable due to file permissions.',
@@ -1185,19 +1185,19 @@ 
                 ),
                 $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($module_path . $module_class . $module_ext);
+        require_once($module_path.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        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__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+        EE_Registry::instance()->modules->{$module_class} = $module_path.$module_class.$module_ext;
         do_action(
             'AHEE__EE_Config__register_module__complete',
             $module_class,
@@ -1248,26 +1248,26 @@ 
     {
         do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
         $module = str_replace('EED_', '', $module);
-        $module_class = 'EED_' . $module;
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
+        $module_class = 'EED_'.$module;
+        if ( ! isset(EE_Registry::instance()->modules->{$module_class})) {
             $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (empty($route)) {
             $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        if (! method_exists('EED_' . $module, $method_name)) {
+        if ( ! method_exists('EED_'.$module, $method_name)) {
             $msg = sprintf(
                 __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
+        EE_Config::$_module_route_map[(string) $key][(string) $route] = array('EED_'.$module, $method_name);
         return true;
     }
 
@@ -1284,8 +1284,8 @@ 
     {
         do_action('AHEE__EE_Config__get_route__begin', $route);
         $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
-            return EE_Config::$_module_route_map[ $key ][ $route ];
+        if (isset(EE_Config::$_module_route_map[$key][$route])) {
+            return EE_Config::$_module_route_map[$key][$route];
         }
         return null;
     }
@@ -1317,47 +1317,47 @@ 
     public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
     {
         do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+        if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
             $msg = sprintf(
                 __('The module route %s for this forward has not been registered.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (empty($forward)) {
             $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (is_array($forward)) {
-            if (! isset($forward[1])) {
+            if ( ! isset($forward[1])) {
                 $msg = sprintf(
                     __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
                     $route
                 );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
                 return false;
             }
-            if (! method_exists($forward[0], $forward[1])) {
+            if ( ! method_exists($forward[0], $forward[1])) {
                 $msg = sprintf(
                     __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
                     $forward[1],
                     $route
                 );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
                 return false;
             }
-        } elseif (! function_exists($forward)) {
+        } elseif ( ! function_exists($forward)) {
             $msg = sprintf(
                 __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
                 $forward,
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
+        EE_Config::$_module_forward_map[$key][$route][absint($status)] = $forward;
         return true;
     }
 
@@ -1375,10 +1375,10 @@ 
     public static function get_forward($route = null, $status = 0, $key = 'ee')
     {
         do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
+        if (isset(EE_Config::$_module_forward_map[$key][$route][$status])) {
             return apply_filters(
                 'FHEE__EE_Config__get_forward',
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+                EE_Config::$_module_forward_map[$key][$route][$status],
                 $route,
                 $status
             );
@@ -1402,15 +1402,15 @@ 
     public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
     {
         do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+        if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
             $msg = sprintf(
                 __('The module route %s for this view has not been registered.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        if (! is_readable($view)) {
+        if ( ! is_readable($view)) {
             $msg = sprintf(
                 __(
                     'The %s view file could not be found or is not readable due to file permissions.',
@@ -1418,10 +1418,10 @@ 
                 ),
                 $view
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
+        EE_Config::$_module_view_map[$key][$route][absint($status)] = $view;
         return true;
     }
 
@@ -1439,10 +1439,10 @@ 
     public static function get_view($route = null, $status = 0, $key = 'ee')
     {
         do_action('AHEE__EE_Config__get_view__begin', $route, $status);
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
+        if (isset(EE_Config::$_module_view_map[$key][$route][$status])) {
             return apply_filters(
                 'FHEE__EE_Config__get_view',
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+                EE_Config::$_module_view_map[$key][$route][$status],
                 $route,
                 $status
             );
@@ -1469,7 +1469,7 @@ 
     public static function getLegacyShortcodesManager()
     {
 
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
+        if ( ! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
             EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
                 EE_Registry::instance()
             );
@@ -1516,7 +1516,7 @@ 
      */
     public function get_pretty($property)
     {
-        if (! property_exists($this, $property)) {
+        if ( ! property_exists($this, $property)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -1745,11 +1745,11 @@ 
      */
     public function reg_page_url()
     {
-        if (! $this->reg_page_url) {
+        if ( ! $this->reg_page_url) {
             $this->reg_page_url = add_query_arg(
                 array('uts' => time()),
                 get_permalink($this->reg_page_id)
-            ) . '#checkout';
+            ).'#checkout';
         }
         return $this->reg_page_url;
     }
@@ -1765,7 +1765,7 @@ 
      */
     public function txn_page_url($query_args = array())
     {
-        if (! $this->txn_page_url) {
+        if ( ! $this->txn_page_url) {
             $this->txn_page_url = get_permalink($this->txn_page_id);
         }
         if ($query_args) {
@@ -1786,7 +1786,7 @@ 
      */
     public function thank_you_page_url($query_args = array())
     {
-        if (! $this->thank_you_page_url) {
+        if ( ! $this->thank_you_page_url) {
             $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
         }
         if ($query_args) {
@@ -1805,7 +1805,7 @@ 
      */
     public function cancel_page_url()
     {
-        if (! $this->cancel_page_url) {
+        if ( ! $this->cancel_page_url) {
             $this->cancel_page_url = get_permalink($this->cancel_page_id);
         }
         return $this->cancel_page_url;
@@ -1848,13 +1848,13 @@ 
         $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
         $option = self::OPTION_NAME_UXIP;
         // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+        $table_name = $wpdb->get_blog_prefix($current_main_site_id).'options';
         // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
         // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
         // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
         // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
         // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
+        $pre = apply_filters('pre_option_'.$option, false, $option);
         if (false !== $pre) {
             EE_Core_Config::$ee_ueip_option = $pre;
             return EE_Core_Config::$ee_ueip_option;
@@ -1868,10 +1868,10 @@ 
         if (is_object($row)) {
             $value = $row->option_value;
         } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
+            EE_Core_Config::$ee_ueip_option = apply_filters('default_option_'.$option, false, $option);
             return EE_Core_Config::$ee_ueip_option;
         }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+        EE_Core_Config::$ee_ueip_option = apply_filters('option_'.$option, maybe_unserialize($value), $option);
         return EE_Core_Config::$ee_ueip_option;
     }
 
@@ -2140,37 +2140,37 @@ 
         // but override if requested
         $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
         // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
-        if (! empty($CNT_ISO)
+        if ( ! empty($CNT_ISO)
             && EE_Maintenance_Mode::instance()->models_can_query()
             && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
         ) {
             // retrieve the country settings from the db, just in case they have been customized
             $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
             if ($country instanceof EE_Country) {
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-                $this->name = $country->currency_name_single();    // Dollar
-                $this->plural = $country->currency_name_plural();    // Dollars
-                $this->sign = $country->currency_sign();            // currency sign: $
+                $this->code = $country->currency_code(); // currency code: USD, CAD, EUR
+                $this->name = $country->currency_name_single(); // Dollar
+                $this->plural = $country->currency_name_plural(); // Dollars
+                $this->sign = $country->currency_sign(); // currency sign: $
                 $this->sign_b4 = $country->currency_sign_before(
-                );        // currency sign before or after: $TRUE  or  FALSE$
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
+                ); // currency sign before or after: $TRUE  or  FALSE$
+                $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00  3 = 0.000
                 $this->dec_mrk = $country->currency_decimal_mark(
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+                ); // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
                 $this->thsnds = $country->currency_thousands_separator(
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+                ); // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
             }
         }
         // fallback to hardcoded defaults, in case the above failed
         if (empty($this->code)) {
             // set default currency settings
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
-            $this->sign = '$';    // currency sign: $
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+            $this->code = 'USD'; // currency code: USD, CAD, EUR
+            $this->name = __('Dollar', 'event_espresso'); // Dollar
+            $this->plural = __('Dollars', 'event_espresso'); // Dollars
+            $this->sign = '$'; // currency sign: $
+            $this->sign_b4 = true; // currency sign before or after: $TRUE  or  FALSE$
+            $this->dec_plc = 2; // decimal places: 2 = 0.00  3 = 0.000
+            $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+            $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
         }
     }
 }
@@ -2429,8 +2429,8 @@ 
             $closing_a_tag = '';
             if (function_exists('get_privacy_policy_url')) {
                 $privacy_page_url = get_privacy_policy_url();
-                if (! empty($privacy_page_url)) {
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
+                if ( ! empty($privacy_page_url)) {
+                    $opening_a_tag = '<a href="'.$privacy_page_url.'" target="_blank">';
                     $closing_a_tag = '</a>';
                 }
             }
@@ -2642,7 +2642,7 @@ 
     public function log_file_name($reset = false)
     {
         if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+            $this->log_file_name = sanitize_key('espresso_log_'.md5(uniqid('', true))).'.txt';
             EE_Config::instance()->update_espresso_config(false, false);
         }
         return $this->log_file_name;
@@ -2656,7 +2656,7 @@ 
     public function debug_file_name($reset = false)
     {
         if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+            $this->debug_file_name = sanitize_key('espresso_debug_'.md5(uniqid('', true))).'.txt';
             EE_Config::instance()->update_espresso_config(false, false);
         }
         return $this->debug_file_name;
@@ -2860,21 +2860,21 @@ 
         $this->use_google_maps = true;
         $this->google_map_api_key = '';
         // for event details pages (reg page)
-        $this->event_details_map_width = 585;            // ee_map_width_single
-        $this->event_details_map_height = 362;            // ee_map_height_single
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
-        $this->event_details_map_align = 'center';            // ee_map_align_single
+        $this->event_details_map_width = 585; // ee_map_width_single
+        $this->event_details_map_height = 362; // ee_map_height_single
+        $this->event_details_map_zoom = 14; // ee_map_zoom_single
+        $this->event_details_display_nav = true; // ee_map_nav_display_single
+        $this->event_details_nav_size = false; // ee_map_nav_size_single
+        $this->event_details_control_type = 'default'; // ee_map_type_control_single
+        $this->event_details_map_align = 'center'; // ee_map_align_single
         // for event list pages
-        $this->event_list_map_width = 300;            // ee_map_width
-        $this->event_list_map_height = 185;        // ee_map_height
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
-        $this->event_list_display_nav = false;        // ee_map_nav_display
-        $this->event_list_nav_size = true;            // ee_map_nav_size
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $this->event_list_map_align = 'center';            // ee_map_align
+        $this->event_list_map_width = 300; // ee_map_width
+        $this->event_list_map_height = 185; // ee_map_height
+        $this->event_list_map_zoom = 12; // ee_map_zoom
+        $this->event_list_display_nav = false; // ee_map_nav_display
+        $this->event_list_nav_size = true; // ee_map_nav_size
+        $this->event_list_control_type = 'dropdown'; // ee_map_type_control
+        $this->event_list_map_align = 'center'; // ee_map_align
     }
 }
 
@@ -3166,7 +3166,7 @@ 
      */
     public function max_input_vars_limit_check($input_count = 0)
     {
-        if (! empty($this->php->max_input_vars)
+        if ( ! empty($this->php->max_input_vars)
             && ($input_count >= $this->php->max_input_vars)
             && (PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9)
         ) {

Indentation +3146 added lines, -3146 removed lines

@@ -14,2509 +14,2509 @@ 
 final class EE_Config implements ResettableInterface
 {
 
-    const OPTION_NAME = 'ee_config';
-
-    const LOG_NAME = 'ee_config_log';
-
-    const LOG_LENGTH = 100;
-
-    const ADDON_OPTION_NAMES = 'ee_config_option_names';
-
-    /**
-     *    instance of the EE_Config object
-     *
-     * @var    EE_Config $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean $_logging_enabled
-     */
-    private static $_logging_enabled = false;
-
-    /**
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    private $legacy_shortcodes_manager;
-
-    /**
-     * An StdClass whose property names are addon slugs,
-     * and values are their config classes
-     *
-     * @var StdClass
-     */
-    public $addons;
-
-    /**
-     * @var EE_Admin_Config
-     */
-    public $admin;
-
-    /**
-     * @var EE_Core_Config
-     */
-    public $core;
-
-    /**
-     * @var EE_Currency_Config
-     */
-    public $currency;
-
-    /**
-     * @var EE_Organization_Config
-     */
-    public $organization;
-
-    /**
-     * @var EE_Registration_Config
-     */
-    public $registration;
-
-    /**
-     * @var EE_Template_Config
-     */
-    public $template_settings;
-
-    /**
-     * Holds EE environment values.
-     *
-     * @var EE_Environment_Config
-     */
-    public $environment;
-
-    /**
-     * settings pertaining to Google maps
-     *
-     * @var EE_Map_Config
-     */
-    public $map_settings;
-
-    /**
-     * settings pertaining to Taxes
-     *
-     * @var EE_Tax_Config
-     */
-    public $tax_settings;
-
-    /**
-     * Settings pertaining to global messages settings.
-     *
-     * @var EE_Messages_Config
-     */
-    public $messages;
-
-    /**
-     * @deprecated
-     * @var EE_Gateway_Config
-     */
-    public $gateway;
-
-    /**
-     * @var    array $_addon_option_names
-     * @access    private
-     */
-    private $_addon_option_names = array();
-
-    /**
-     * @var    array $_module_route_map
-     * @access    private
-     */
-    private static $_module_route_map = array();
-
-    /**
-     * @var    array $_module_forward_map
-     * @access    private
-     */
-    private static $_module_forward_map = array();
-
-    /**
-     * @var    array $_module_view_map
-     * @access    private
-     */
-    private static $_module_view_map = array();
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Config instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Config) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the config
-     *
-     * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
-     *                               (default) leaves the database alone, and merely resets the EE_Config object to
-     *                               reflect its state in the database
-     * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
-     *                               $_instance as NULL. Useful in case you want to forget about the old instance on
-     *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
-     *                               site was put into maintenance mode)
-     * @return EE_Config
-     */
-    public static function reset($hard_reset = false, $reinstantiate = true)
-    {
-        if (self::$_instance instanceof EE_Config) {
-            if ($hard_reset) {
-                self::$_instance->legacy_shortcodes_manager = null;
-                self::$_instance->_addon_option_names = array();
-                self::$_instance->_initialize_config();
-                self::$_instance->update_espresso_config();
-            }
-            self::$_instance->update_addon_option_names();
-        }
-        self::$_instance = null;
-        // we don't need to reset the static properties imo because those should
-        // only change when a module is added or removed. Currently we don't
-        // support removing a module during a request when it previously existed
-        if ($reinstantiate) {
-            return self::instance();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Config__construct__begin', $this);
-        EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
-        // setup empty config classes
-        $this->_initialize_config();
-        // load existing EE site settings
-        $this->_load_core_config();
-        // confirm everything loaded correctly and set filtered defaults if not
-        $this->_verify_config();
-        //  register shortcodes and modules
-        add_action(
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_and_modules'),
-            999
-        );
-        //  initialize shortcodes and modules
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
-        // register widgets
-        add_action('widgets_init', array($this, 'widgets_init'), 10);
-        // shutdown
-        add_action('shutdown', array($this, 'shutdown'), 10);
-        // construct__end hook
-        do_action('AHEE__EE_Config__construct__end', $this);
-        // hardcoded hack
-        $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function logging_enabled()
-    {
-        return self::$_logging_enabled;
-    }
-
-
-    /**
-     * use to get the current theme if needed from static context
-     *
-     * @return string current theme set.
-     */
-    public static function get_current_theme()
-    {
-        return isset(self::$_instance->template_settings->current_espresso_theme)
-            ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     *        _initialize_config
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_config()
-    {
-        EE_Config::trim_log();
-        // set defaults
-        $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
-        $this->addons = new stdClass();
-        // set _module_route_map
-        EE_Config::$_module_route_map = array();
-        // set _module_forward_map
-        EE_Config::$_module_forward_map = array();
-        // set _module_view_map
-        EE_Config::$_module_view_map = array();
-    }
-
-
-    /**
-     *        load core plugin configuration
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_core_config()
-    {
-        // load_core_config__start hook
-        do_action('AHEE__EE_Config___load_core_config__start', $this);
-        $espresso_config = $this->get_espresso_config();
-        foreach ($espresso_config as $config => $settings) {
-            // load_core_config__start hook
-            $settings = apply_filters(
-                'FHEE__EE_Config___load_core_config__config_settings',
-                $settings,
-                $config,
-                $this
-            );
-            if (is_object($settings) && property_exists($this, $config)) {
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
-                // call configs populate method to ensure any defaults are set for empty values.
-                if (method_exists($settings, 'populate')) {
-                    $this->{$config}->populate();
-                }
-                if (method_exists($settings, 'do_hooks')) {
-                    $this->{$config}->do_hooks();
-                }
-            }
-        }
-        if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
-            $this->update_espresso_config();
-        }
-        // load_core_config__end hook
-        do_action('AHEE__EE_Config___load_core_config__end', $this);
-    }
-
-
-    /**
-     *    _verify_config
-     *
-     * @access    protected
-     * @return    void
-     */
-    protected function _verify_config()
-    {
-        $this->core = $this->core instanceof EE_Core_Config
-            ? $this->core
-            : new EE_Core_Config();
-        $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
-        $this->organization = $this->organization instanceof EE_Organization_Config
-            ? $this->organization
-            : new EE_Organization_Config();
-        $this->organization = apply_filters(
-            'FHEE__EE_Config___initialize_config__organization',
-            $this->organization
-        );
-        $this->currency = $this->currency instanceof EE_Currency_Config
-            ? $this->currency
-            : new EE_Currency_Config();
-        $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
-        $this->registration = $this->registration instanceof EE_Registration_Config
-            ? $this->registration
-            : new EE_Registration_Config();
-        $this->registration = apply_filters(
-            'FHEE__EE_Config___initialize_config__registration',
-            $this->registration
-        );
-        $this->admin = $this->admin instanceof EE_Admin_Config
-            ? $this->admin
-            : new EE_Admin_Config();
-        $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
-        $this->template_settings = $this->template_settings instanceof EE_Template_Config
-            ? $this->template_settings
-            : new EE_Template_Config();
-        $this->template_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__template_settings',
-            $this->template_settings
-        );
-        $this->map_settings = $this->map_settings instanceof EE_Map_Config
-            ? $this->map_settings
-            : new EE_Map_Config();
-        $this->map_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__map_settings',
-            $this->map_settings
-        );
-        $this->environment = $this->environment instanceof EE_Environment_Config
-            ? $this->environment
-            : new EE_Environment_Config();
-        $this->environment = apply_filters(
-            'FHEE__EE_Config___initialize_config__environment',
-            $this->environment
-        );
-        $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
-            ? $this->tax_settings
-            : new EE_Tax_Config();
-        $this->tax_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__tax_settings',
-            $this->tax_settings
-        );
-        $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
-        $this->messages = $this->messages instanceof EE_Messages_Config
-            ? $this->messages
-            : new EE_Messages_Config();
-        $this->gateway = $this->gateway instanceof EE_Gateway_Config
-            ? $this->gateway
-            : new EE_Gateway_Config();
-        $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
-        $this->legacy_shortcodes_manager = null;
-    }
-
-
-    /**
-     *    get_espresso_config
-     *
-     * @access    public
-     * @return    array of espresso config stuff
-     */
-    public function get_espresso_config()
-    {
-        // grab espresso configuration
-        return apply_filters(
-            'FHEE__EE_Config__get_espresso_config__CFG',
-            get_option(EE_Config::OPTION_NAME, array())
-        );
-    }
-
-
-    /**
-     *    double_check_config_comparison
-     *
-     * @access    public
-     * @param string $option
-     * @param        $old_value
-     * @param        $value
-     */
-    public function double_check_config_comparison($option = '', $old_value, $value)
-    {
-        // make sure we're checking the ee config
-        if ($option === EE_Config::OPTION_NAME) {
-            // run a loose comparison of the old value against the new value for type and properties,
-            // but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
-            if ($value != $old_value) {
-                // if they are NOT the same, then remove the hook,
-                // which means the subsequent update results will be based solely on the update query results
-                // the reason we do this is because, as stated above,
-                // WP update_option performs an exact instance comparison (===) on any update values passed to it
-                // this happens PRIOR to serialization and any subsequent update.
-                // If values are found to match their previous old value,
-                // then WP bails before performing any update.
-                // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
-                // it just pulled from the db, with the one being passed to it (which will not match).
-                // HOWEVER, once the object is serialized and passed off to MySQL to update,
-                // MySQL MAY ALSO NOT perform the update because
-                // the string it sees in the db looks the same as the new one it has been passed!!!
-                // This results in the query returning an "affected rows" value of ZERO,
-                // which gets returned immediately by WP update_option and looks like an error.
-                remove_action('update_option', array($this, 'check_config_updated'));
-            }
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     */
-    protected function _reset_espresso_addon_config()
-    {
-        $this->_addon_option_names = array();
-        foreach ($this->addons as $addon_name => $addon_config_obj) {
-            $addon_config_obj = maybe_unserialize($addon_config_obj);
-            if ($addon_config_obj instanceof EE_Config_Base) {
-                $this->update_config('addons', $addon_name, $addon_config_obj, false);
-            }
-            $this->addons->{$addon_name} = null;
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     * @param   bool $add_success
-     * @param   bool $add_error
-     * @return   bool
-     */
-    public function update_espresso_config($add_success = false, $add_error = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
-        // $clone = clone( self::$_instance );
-        // self::$_instance = NULL;
-        do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
-        $this->_reset_espresso_addon_config();
-        // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
-        // but BEFORE the actual update occurs
-        add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
-        // don't want to persist legacy_shortcodes_manager, but don't want to lose it either
-        $legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
-        $this->legacy_shortcodes_manager = null;
-        // now update "ee_config"
-        $saved = update_option(EE_Config::OPTION_NAME, $this);
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
-        EE_Config::log(EE_Config::OPTION_NAME);
-        // if not saved... check if the hook we just added still exists;
-        // if it does, it means one of two things:
-        // that update_option bailed at the($value === $old_value) conditional,
-        // or...
-        // the db update query returned 0 rows affected
-        // (probably because the data  value was the same from it's perspective)
-        // so the existence of the hook means that a negative result from update_option is NOT an error,
-        // but just means no update occurred, so don't display an error to the user.
-        // BUT... if update_option returns FALSE, AND the hook is missing,
-        // then it means that something truly went wrong
-        $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
-        // remove our action since we don't want it in the system anymore
-        remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
-        do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
-        // self::$_instance = $clone;
-        // unset( $clone );
-        // if config remains the same or was updated successfully
-        if ($saved) {
-            if ($add_success) {
-                EE_Error::add_success(
-                    __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return true;
-        } else {
-            if ($add_error) {
-                EE_Error::add_error(
-                    __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-    }
-
-
-    /**
-     *    _verify_config_params
-     *
-     * @access    private
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @param    array          $tests_to_run
-     * @param    bool           $display_errors
-     * @return    bool    TRUE on success, FALSE on fail
-     */
-    private function _verify_config_params(
-        $section = '',
-        $name = '',
-        $config_class = '',
-        $config_obj = null,
-        $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
-        $display_errors = true
-    ) {
-        try {
-            foreach ($tests_to_run as $test) {
-                switch ($test) {
-                    // TEST #1 : check that section was set
-                    case 1:
-                        if (empty($section)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'No configuration section has been provided while attempting to save "%s".',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #2 : check that settings section exists
-                    case 2:
-                        if (! isset($this->{$section})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" configuration section does not exist.', 'event_espresso'),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #3 : check that section is the proper format
-                    case 3:
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
-                        ) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" configuration settings have not been formatted correctly.',
-                                            'event_espresso'
-                                        ),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #4 : check that config section name has been set
-                    case 4:
-                        if (empty($name)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #5 : check that a config class name has been set
-                    case 5:
-                        if (empty($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No class name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #6 : verify config class is accessible
-                    case 6:
-                        if (! class_exists($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #7 : check that config has even been set
-                    case 7:
-                        if (! isset($this->{$section}->{$name})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
-                                        $section,
-                                        $name
-                                    )
-                                );
-                            }
-                            return false;
-                        } else {
-                            // and make sure it's not serialized
-                            $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
-                        }
-                        break;
-                    // TEST #8 : check that config is the requested type
-                    case 8:
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
-                                            'event_espresso'
-                                        ),
-                                        $section,
-                                        $name,
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #9 : verify config object
-                    case 9:
-                        if (! $config_obj instanceof EE_Config_Base) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
-                                        print_r($config_obj, true)
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        // you have successfully run the gauntlet
-        return true;
-    }
-
-
-    /**
-     *    _generate_config_option_name
-     *
-     * @access        protected
-     * @param        string $section
-     * @param        string $name
-     * @return        string
-     */
-    private function _generate_config_option_name($section = '', $name = '')
-    {
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
-    }
-
-
-    /**
-     *    _set_config_class
-     * ensures that a config class is set, either from a passed config class or one generated from the config name
-     *
-     * @access    private
-     * @param    string $config_class
-     * @param    string $name
-     * @return    string
-     */
-    private function _set_config_class($config_class = '', $name = '')
-    {
-        return ! empty($config_class)
-            ? $config_class
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
-    }
-
-
-    /**
-     *    set_config
-     *
-     * @access    protected
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @return    EE_Config_Base
-     */
-    public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6, and 7 to verify all config params are set and valid
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
-            $this->update_addon_option_names();
-        }
-        // verify the incoming config object but suppress errors
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            $config_obj = new $config_class();
-        }
-        if (get_option($config_option_name)) {
-            EE_Config::log($config_option_name);
-            update_option($config_option_name, $config_obj);
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        } else {
-            // create a wp-option for this config
-            if (add_option($config_option_name, $config_obj, '', 'no')) {
-                $this->{$section}->{$name} = maybe_unserialize($config_obj);
-                return $this->{$section}->{$name};
-            } else {
-                EE_Error::add_error(
-                    sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return null;
-            }
-        }
-    }
-
-
-    /**
-     *    update_config
-     * Important: the config object must ALREADY be set, otherwise this will produce an error.
-     *
-     * @access    public
-     * @param    string                $section
-     * @param    string                $name
-     * @param    EE_Config_Base|string $config_obj
-     * @param    bool                  $throw_errors
-     * @return    bool
-     */
-    public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        $config_obj = maybe_unserialize($config_obj);
-        // get class name of the incoming object
-        $config_class = get_class($config_obj);
-        // run tests 1-5 and 9 to verify config
-        if (! $this->_verify_config_params(
-            $section,
-            $name,
-            $config_class,
-            $config_obj,
-            array(1, 2, 3, 4, 7, 9)
-        )
-        ) {
-            return false;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            // save new config to db
-            if ($this->set_config($section, $name, $config_class, $config_obj)) {
-                return true;
-            }
-        } else {
-            // first check if the record already exists
-            $existing_config = get_option($config_option_name);
-            $config_obj = serialize($config_obj);
-            // just return if db record is already up to date (NOT type safe comparison)
-            if ($existing_config == $config_obj) {
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif (update_option($config_option_name, $config_obj)) {
-                EE_Config::log($config_option_name);
-                // update wp-option for this config class
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif ($throw_errors) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
-                            'event_espresso'
-                        ),
-                        $config_class,
-                        'EE_Config->' . $section . '->' . $name
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    get_config
-     *
-     * @access    public
-     * @param    string $section
-     * @param    string $name
-     * @param    string $config_class
-     * @return    mixed EE_Config_Base | NULL
-     */
-    public function get_config($section = '', $name = '', $config_class = '')
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6 and 7 to verify that all params have been set
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        // now test if the requested config object exists, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
-            // config already exists, so pass it back
-            return $this->{$section}->{$name};
-        }
-        // load config option from db if it exists
-        $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
-        // verify the newly retrieved config object, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            // config is good, so set it and pass it back
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        }
-        // oops! $config_obj is not already set and does not exist in the db, so create a new one
-        $config_obj = $this->set_config($section, $name, $config_class);
-        // verify the newly created config object
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
-            return $this->{$section}->{$name};
-        } else {
-            EE_Error::add_error(
-                sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_config_option
-     *
-     * @access    public
-     * @param    string $config_option_name
-     * @return    mixed EE_Config_Base | FALSE
-     */
-    public function get_config_option($config_option_name = '')
-    {
-        // retrieve the wp-option for this config class.
-        $config_option = maybe_unserialize(get_option($config_option_name, array()));
-        if (empty($config_option)) {
-            EE_Config::log($config_option_name . '-NOT-FOUND');
-        }
-        return $config_option;
-    }
-
-
-    /**
-     * log
-     *
-     * @param string $config_option_name
-     */
-    public static function log($config_option_name = '')
-    {
-        if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
-            $config_log = get_option(EE_Config::LOG_NAME, array());
-            // copy incoming $_REQUEST and sanitize it so we can save it
-            $_request = $_REQUEST;
-            array_walk_recursive($_request, 'sanitize_text_field');
-            $config_log[ (string) microtime(true) ] = array(
-                'config_name' => $config_option_name,
-                'request'     => $_request,
-            );
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     * trim_log
-     * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
-     */
-    public static function trim_log()
-    {
-        if (! EE_Config::logging_enabled()) {
-            return;
-        }
-        $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
-        $log_length = count($config_log);
-        if ($log_length > EE_Config::LOG_LENGTH) {
-            ksort($config_log);
-            $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     *    get_page_for_posts
-     *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
-     *    wp-option "page_for_posts", or "posts" if no page is selected
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function get_page_for_posts()
-    {
-        $page_for_posts = get_option('page_for_posts');
-        if (! $page_for_posts) {
-            return 'posts';
-        }
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
-        return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
-    }
-
-
-    /**
-     *    register_shortcodes_and_modules.
-     *    At this point, it's too early to tell if we're maintenance mode or not.
-     *    In fact, this is where we give modules a chance to let core know they exist
-     *    so they can help trigger maintenance mode if it's needed
-     *
-     * @access    public
-     * @return    void
-     */
-    public function register_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        EE_Registry::instance()->modules = $this->_register_modules();
-    }
-
-
-    /**
-     *    initialize_shortcodes_and_modules
-     *    meaning they can start adding their hooks to get stuff done
-     *
-     * @access    public
-     * @return    void
-     */
-    public function initialize_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        $this->_initialize_modules();
-    }
-
-
-    /**
-     *    widgets_init
-     *
-     * @access private
-     * @return void
-     */
-    public function widgets_init()
-    {
-        // only init widgets on admin pages when not in complete maintenance, and
-        // on frontend when not in any maintenance mode
-        if (! EE_Maintenance_Mode::instance()->level()
-            || (
-                is_admin()
-                && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
-            )
-        ) {
-            // grab list of installed widgets
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
-            // filter list of modules to register
-            $widgets_to_register = apply_filters(
-                'FHEE__EE_Config__register_widgets__widgets_to_register',
-                $widgets_to_register
-            );
-            if (! empty($widgets_to_register)) {
-                // cycle thru widget folders
-                foreach ($widgets_to_register as $widget_path) {
-                    // add to list of installed widget modules
-                    EE_Config::register_ee_widget($widget_path);
-                }
-            }
-            // filter list of installed modules
-            EE_Registry::instance()->widgets = apply_filters(
-                'FHEE__EE_Config__register_widgets__installed_widgets',
-                EE_Registry::instance()->widgets
-            );
-        }
-    }
-
-
-    /**
-     *    register_ee_widget - makes core aware of this widget
-     *
-     * @access    public
-     * @param    string $widget_path - full path up to and including widget folder
-     * @return    void
-     */
-    public static function register_ee_widget($widget_path = null)
-    {
-        do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
-        $widget_ext = '.widget.php';
-        // make all separators match
-        $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($widget_path, $widget_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $file_name = explode('.', basename($widget_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
-            // sanitize shortcode directory name
-            $widget = sanitize_key($widget);
-            // now we need to rebuild the shortcode path
-            $widget_path = explode(DS, $widget_path);
-            // remove last segment
-            array_pop($widget_path);
-            // glue it back together
-            $widget_path = implode(DS, $widget_path);
-        } else {
-            // grab and sanitize widget directory name
-            $widget = sanitize_key(basename($widget_path));
-        }
-        // create classname from widget directory name
-        $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
-        // add class prefix
-        $widget_class = 'EEW_' . $widget;
-        // does the widget exist ?
-        if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
-                    'event_espresso'
-                ),
-                $widget_class,
-                $widget_path . DS . $widget_class . $widget_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        // load the widget class file
-        require_once($widget_path . DS . $widget_class . $widget_ext);
-        // verify that class exists
-        if (! class_exists($widget_class)) {
-            $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        register_widget($widget_class);
-        // add to array of registered widgets
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
-    }
-
-
-    /**
-     *        _register_modules
-     *
-     * @access private
-     * @return array
-     */
-    private function _register_modules()
-    {
-        // grab list of installed modules
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $modules_to_register = apply_filters(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            $modules_to_register
-        );
-        if (! empty($modules_to_register)) {
-            // loop through folders
-            foreach ($modules_to_register as $module_path) {
-                /**TEMPORARILY EXCLUDE gateways from modules for time being**/
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-                    && $module_path !== EE_MODULES . 'gateways'
-                ) {
-                    // add to list of installed modules
-                    EE_Config::register_module($module_path);
-                }
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_modules__installed_modules',
-            EE_Registry::instance()->modules
-        );
-    }
-
-
-    /**
-     *    register_module - makes core aware of this module
-     *
-     * @access    public
-     * @param    string $module_path - full path up to and including module folder
-     * @return    bool
-     */
-    public static function register_module($module_path = null)
-    {
-        do_action('AHEE__EE_Config__register_module__begin', $module_path);
-        $module_ext = '.module.php';
-        // make all separators match
-        $module_path = str_replace(array('\\', '/'), DS, $module_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($module_path, $module_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $module_file = explode('.', basename($module_path));
-            // now we need to rebuild the shortcode path
-            $module_path = explode(DS, $module_path);
-            // remove last segment
-            array_pop($module_path);
-            // glue it back together
-            $module_path = implode(DS, $module_path) . DS;
-            // take first segment from file name pieces and sanitize it
-            $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
-            // ensure class prefix is added
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize module name
-            $module = strtolower(basename($module_path));
-            $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
-            // like trailingslashit()
-            $module_path = rtrim($module_path, DS) . DS;
-            // create classname from module directory name
-            $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
-            // add class prefix
-            $module_class = 'EED_' . $module;
-        }
-        // does the module exist ?
-        if (! is_readable($module_path . DS . $module_class . $module_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s module 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;
-        }
-        // load the module class file
-        require_once($module_path . $module_class . $module_ext);
-        // 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
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
-        do_action(
-            'AHEE__EE_Config__register_module__complete',
-            $module_class,
-            EE_Registry::instance()->modules->{$module_class}
-        );
-        return true;
-    }
-
-
-    /**
-     *    _initialize_modules
-     *    allow modules to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_modules()
-    {
-        // cycle thru shortcode folders
-        foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($module_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($module_class, 'set_hooks')
-                );
-            }
-        }
-    }
-
-
-    /**
-     *    register_route - adds module method routes to route_map
-     *
-     * @access    public
-     * @param    string $route       - "pretty" public alias for module method
-     * @param    string $module      - module name (classname without EED_ prefix)
-     * @param    string $method_name - the actual module method to be routed to
-     * @param    string $key         - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
-        $module = str_replace('EED_', '', $module);
-        $module_class = 'EED_' . $module;
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
-            $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($route)) {
-            $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! method_exists('EED_' . $module, $method_name)) {
-            $msg = sprintf(
-                __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
-        return true;
-    }
-
-
-    /**
-     *    get_route - get module method route
-     *
-     * @access    public
-     * @param    string $route - "pretty" public alias for module method
-     * @param    string $key   - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_route($route = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_route__begin', $route);
-        $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
-            return EE_Config::$_module_route_map[ $key ][ $route ];
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_routes - get ALL module method routes
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function get_routes()
-    {
-        return EE_Config::$_module_route_map;
-    }
-
-
-    /**
-     *    register_forward - allows modules to forward request to another module for further processing
-     *
-     * @access    public
-     * @param    string       $route   - "pretty" public alias for module method
-     * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
-     *                                 class, allows different forwards to be served based on status
-     * @param    array|string $forward - function name or array( class, method )
-     * @param    string       $key     - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this forward has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($forward)) {
-            $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (is_array($forward)) {
-            if (! isset($forward[1])) {
-                $msg = sprintf(
-                    __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-            if (! method_exists($forward[0], $forward[1])) {
-                $msg = sprintf(
-                    __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                    $forward[1],
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-        } elseif (! function_exists($forward)) {
-            $msg = sprintf(
-                __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                $forward,
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
-        return true;
-    }
-
-
-    /**
-     *    get_forward - get forwarding route
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different forwards to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_forward($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_forward',
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    register_forward - allows modules to specify different view templates for different method routes and status
-     *    results
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $view
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this view has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! is_readable($view)) {
-            $msg = sprintf(
-                __(
-                    'The %s view file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $view
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
-        return true;
-    }
-
-
-    /**
-     *    get_view - get view for route and status
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_view($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_view__begin', $route, $status);
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_view',
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    public function update_addon_option_names()
-    {
-        update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
-    }
-
-
-    public function shutdown()
-    {
-        $this->update_addon_option_names();
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     */
-    public static function getLegacyShortcodesManager()
-    {
-
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
-            EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
-                EE_Registry::instance()
-            );
-        }
-        return EE_Config::instance()->legacy_shortcodes_manager;
-    }
-
-
-    /**
-     * register_shortcode - makes core aware of this shortcode
-     *
-     * @deprecated 4.9.26
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public static function register_shortcode($shortcode_path = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
-    }
-}
-
-/**
- * Base class used for config classes. These classes should generally not have
- * magic functions in use, except we'll allow them to magically set and get stuff...
- * basically, they should just be well-defined stdClasses
- */
-class EE_Config_Base
-{
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if (! property_exists($this, $property)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $property
-                )
-            );
-        }
-        // just handling escaping of strings for now.
-        if (is_string($this->{$property})) {
-            return stripslashes($this->{$property});
-        }
-        return $this->{$property};
-    }
-
-
-    public function populate()
-    {
-        // grab defaults via a new instance of this class.
-        $class_name = get_class($this);
-        $defaults = new $class_name;
-        // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
-        // default from our $defaults object.
-        foreach (get_object_vars($defaults) as $property => $value) {
-            if ($this->{$property} === null) {
-                $this->{$property} = $value;
-            }
-        }
-        // cleanup
-        unset($defaults);
-    }
-
-
-    /**
-     *        __isset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __isset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __unset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __unset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __clone
-     */
-    public function __clone()
-    {
-    }
-
-
-    /**
-     *        __wakeup
-     */
-    public function __wakeup()
-    {
-    }
-
-
-    /**
-     *        __destruct
-     */
-    public function __destruct()
-    {
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Core_Config extends EE_Config_Base
-{
-
-    const OPTION_NAME_UXIP = 'ee_ueip_optin';
-
-
-    public $current_blog_id;
-
-    public $ee_ueip_optin;
-
-    public $ee_ueip_has_notified;
-
-    /**
-     * Not to be confused with the 4 critical page variables (See
-     * get_critical_pages_array()), this is just an array of wp posts that have EE
-     * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
-     * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
-     *
-     * @var array
-     */
-    public $post_shortcodes;
-
-    public $module_route_map;
-
-    public $module_forward_map;
-
-    public $module_view_map;
-
-    /**
-     * The next 4 vars are the IDs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_id;
-
-    public $txn_page_id;
-
-    public $thank_you_page_id;
-
-    public $cancel_page_id;
-
-    /**
-     * The next 4 vars are the URLs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_url;
-
-    public $txn_page_url;
-
-    public $thank_you_page_url;
-
-    public $cancel_page_url;
-
-    /**
-     * The next vars relate to the custom slugs for EE CPT routes
-     */
-    public $event_cpt_slug;
-
-    /**
-     * This caches the _ee_ueip_option in case this config is reset in the same
-     * request across blog switches in a multisite context.
-     * Avoids extra queries to the db for this option.
-     *
-     * @var bool
-     */
-    public static $ee_ueip_option;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        $this->current_blog_id = get_current_blog_id();
-        $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
-        $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
-        $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
-        $this->post_shortcodes = array();
-        $this->module_route_map = array();
-        $this->module_forward_map = array();
-        $this->module_view_map = array();
-        // critical EE page IDs
-        $this->reg_page_id = 0;
-        $this->txn_page_id = 0;
-        $this->thank_you_page_id = 0;
-        $this->cancel_page_id = 0;
-        // critical EE page URLs
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->thank_you_page_url = '';
-        $this->cancel_page_url = '';
-        // cpt slugs
-        $this->event_cpt_slug = __('events', 'event_espresso');
-        // ueip constant check
-        if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
-            $this->ee_ueip_optin = false;
-            $this->ee_ueip_has_notified = true;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_array()
-    {
-        return array(
-            $this->reg_page_id,
-            $this->txn_page_id,
-            $this->thank_you_page_id,
-            $this->cancel_page_id,
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_shortcodes_array()
-    {
-        return array(
-            $this->reg_page_id       => 'ESPRESSO_CHECKOUT',
-            $this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
-            $this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
-            $this->cancel_page_id    => 'ESPRESSO_CANCELLED',
-        );
-    }
-
-
-    /**
-     *  gets/returns URL for EE reg_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function reg_page_url()
-    {
-        if (! $this->reg_page_url) {
-            $this->reg_page_url = add_query_arg(
-                array('uts' => time()),
-                get_permalink($this->reg_page_id)
-            ) . '#checkout';
-        }
-        return $this->reg_page_url;
-    }
-
-
-    /**
-     *  gets/returns URL for EE txn_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function txn_page_url($query_args = array())
-    {
-        if (! $this->txn_page_url) {
-            $this->txn_page_url = get_permalink($this->txn_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->txn_page_url);
-        } else {
-            return $this->txn_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE thank_you_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function thank_you_page_url($query_args = array())
-    {
-        if (! $this->thank_you_page_url) {
-            $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->thank_you_page_url);
-        } else {
-            return $this->thank_you_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE cancel_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function cancel_page_url()
-    {
-        if (! $this->cancel_page_url) {
-            $this->cancel_page_url = get_permalink($this->cancel_page_id);
-        }
-        return $this->cancel_page_url;
-    }
-
-
-    /**
-     * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
-     *
-     * @since 4.7.5
-     */
-    protected function _reset_urls()
-    {
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->cancel_page_url = '';
-        $this->thank_you_page_url = '';
-    }
-
-
-    /**
-     * Used to return what the optin value is set for the EE User Experience Program.
-     * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
-     * on the main site only.
-     *
-     * @return bool
-     */
-    protected function _get_main_ee_ueip_optin()
-    {
-        // if this is the main site then we can just bypass our direct query.
-        if (is_main_site()) {
-            return get_option(self::OPTION_NAME_UXIP, false);
-        }
-        // is this already cached for this request?  If so use it.
-        if (EE_Core_Config::$ee_ueip_option !== null) {
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        global $wpdb;
-        $current_network_main_site = is_multisite() ? get_current_site() : null;
-        $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
-        $option = self::OPTION_NAME_UXIP;
-        // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
-        // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
-        // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
-        // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
-        // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
-        // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
-        if (false !== $pre) {
-            EE_Core_Config::$ee_ueip_option = $pre;
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        $row = $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
-                $option
-            )
-        );
-        if (is_object($row)) {
-            $value = $row->option_value;
-        } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
-        return EE_Core_Config::$ee_ueip_option;
-    }
-
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if ($property === self::OPTION_NAME_UXIP) {
-            return $this->ee_ueip_optin ? 'yes' : 'no';
-        }
-        return parent::get_pretty($property);
-    }
-
-
-    /**
-     * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
-     * on the object.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // reset all url properties
-        $this->_reset_urls();
-        // return what to save to db
-        return array_keys(get_object_vars($this));
-    }
-}
-
-/**
- * Config class for storing info on the Organization
- */
-class EE_Organization_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $name
-     * eg EE4.1
-     */
-    public $name;
-
-    /**
-     * @var string $address_1
-     * eg 123 Onna Road
-     */
-    public $address_1 = '';
-
-    /**
-     * @var string $address_2
-     * eg PO Box 123
-     */
-    public $address_2 = '';
-
-    /**
-     * @var string $city
-     * eg Inna City
-     */
-    public $city = '';
-
-    /**
-     * @var int $STA_ID
-     * eg 4
-     */
-    public $STA_ID = 0;
-
-    /**
-     * @var string $CNT_ISO
-     * eg US
-     */
-    public $CNT_ISO = '';
-
-    /**
-     * @var string $zip
-     * eg 12345  or V1A 2B3
-     */
-    public $zip = '';
-
-    /**
-     * @var string $email
-     * eg support@eventespresso.com
-     */
-    public $email;
-
-    /**
-     * @var string $phone
-     * eg. 111-111-1111
-     */
-    public $phone = '';
-
-    /**
-     * @var string $vat
-     * VAT/Tax Number
-     */
-    public $vat = '';
-
-    /**
-     * @var string $logo_url
-     * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
-     */
-    public $logo_url = '';
-
-    /**
-     * The below are all various properties for holding links to organization social network profiles
-     *
-     * @var string
-     */
-    /**
-     * facebook (facebook.com/profile.name)
-     *
-     * @var string
-     */
-    public $facebook = '';
-
-    /**
-     * twitter (twitter.com/twitter_handle)
-     *
-     * @var string
-     */
-    public $twitter = '';
-
-    /**
-     * linkedin (linkedin.com/in/profile_name)
-     *
-     * @var string
-     */
-    public $linkedin = '';
-
-    /**
-     * pinterest (www.pinterest.com/profile_name)
-     *
-     * @var string
-     */
-    public $pinterest = '';
-
-    /**
-     * google+ (google.com/+profileName)
-     *
-     * @var string
-     */
-    public $google = '';
-
-    /**
-     * instagram (instagram.com/handle)
-     *
-     * @var string
-     */
-    public $instagram = '';
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
-        $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
-        $this->email = get_bloginfo('admin_email');
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to currency
- */
-class EE_Currency_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $code
-     * eg 'US'
-     */
-    public $code;
-
-    /**
-     * @var string $name
-     * eg 'Dollar'
-     */
-    public $name;
-
-    /**
-     * plural name
-     *
-     * @var string $plural
-     * eg 'Dollars'
-     */
-    public $plural;
-
-    /**
-     * currency sign
-     *
-     * @var string $sign
-     * eg '$'
-     */
-    public $sign;
-
-    /**
-     * Whether the currency sign should come before the number or not
-     *
-     * @var boolean $sign_b4
-     */
-    public $sign_b4;
-
-    /**
-     * How many digits should come after the decimal place
-     *
-     * @var int $dec_plc
-     */
-    public $dec_plc;
-
-    /**
-     * Symbol to use for decimal mark
-     *
-     * @var string $dec_mrk
-     * eg '.'
-     */
-    public $dec_mrk;
-
-    /**
-     * Symbol to use for thousands
-     *
-     * @var string $thsnds
-     * eg ','
-     */
-    public $thsnds;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param string $CNT_ISO
-     * @throws \EE_Error
-     */
-    public function __construct($CNT_ISO = '')
-    {
-        /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
-        $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        // get country code from organization settings or use default
-        $ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
-                   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : '';
-        // but override if requested
-        $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
-        // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
-        if (! empty($CNT_ISO)
-            && EE_Maintenance_Mode::instance()->models_can_query()
-            && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
-        ) {
-            // retrieve the country settings from the db, just in case they have been customized
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
-            if ($country instanceof EE_Country) {
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-                $this->name = $country->currency_name_single();    // Dollar
-                $this->plural = $country->currency_name_plural();    // Dollars
-                $this->sign = $country->currency_sign();            // currency sign: $
-                $this->sign_b4 = $country->currency_sign_before(
-                );        // currency sign before or after: $TRUE  or  FALSE$
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
-                $this->dec_mrk = $country->currency_decimal_mark(
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $this->thsnds = $country->currency_thousands_separator(
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-            }
-        }
-        // fallback to hardcoded defaults, in case the above failed
-        if (empty($this->code)) {
-            // set default currency settings
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
-            $this->sign = '$';    // currency sign: $
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-        }
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Registration_Config extends EE_Config_Base
-{
-
-    /**
-     * Default registration status
-     *
-     * @var string $default_STS_ID
-     * eg 'RPP'
-     */
-    public $default_STS_ID;
-
-    /**
-     * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
-     * registrations)
-     *
-     * @var int
-     */
-    public $default_maximum_number_of_tickets;
-
-    /**
-     * level of validation to apply to email addresses
-     *
-     * @var string $email_validation_level
-     * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
-     */
-    public $email_validation_level;
-
-    /**
-     *    whether or not to show alternate payment options during the reg process if payment status is pending
-     *
-     * @var boolean $show_pending_payment_options
-     */
-    public $show_pending_payment_options;
-
-    /**
-     * Whether to skip the registration confirmation page
-     *
-     * @var boolean $skip_reg_confirmation
-     */
-    public $skip_reg_confirmation;
-
-    /**
-     * an array of SPCO reg steps where:
-     *        the keys denotes the reg step order
-     *        each element consists of an array with the following elements:
-     *            "file_path" => the file path to the EE_SPCO_Reg_Step class
-     *            "class_name" => the specific EE_SPCO_Reg_Step child class name
-     *            "slug" => the URL param used to trigger the reg step
-     *
-     * @var array $reg_steps
-     */
-    public $reg_steps;
-
-    /**
-     * Whether registration confirmation should be the last page of SPCO
-     *
-     * @var boolean $reg_confirmation_last
-     */
-    public $reg_confirmation_last;
-
-    /**
-     * Whether or not to enable the EE Bot Trap
-     *
-     * @var boolean $use_bot_trap
-     */
-    public $use_bot_trap;
-
-    /**
-     * Whether or not to encrypt some data sent by the EE Bot Trap
-     *
-     * @var boolean $use_encryption
-     */
-    public $use_encryption;
-
-    /**
-     * Whether or not to use ReCaptcha
-     *
-     * @var boolean $use_captcha
-     */
-    public $use_captcha;
-
-    /**
-     * ReCaptcha Theme
-     *
-     * @var string $recaptcha_theme
-     *    options: 'dark', 'light', 'invisible'
-     */
-    public $recaptcha_theme;
-
-    /**
-     * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
-     *
-     * @var string $recaptcha_badge
-     *    options: 'bottomright', 'bottomleft', 'inline'
-     */
-    public $recaptcha_badge;
+	const OPTION_NAME = 'ee_config';
+
+	const LOG_NAME = 'ee_config_log';
+
+	const LOG_LENGTH = 100;
+
+	const ADDON_OPTION_NAMES = 'ee_config_option_names';
+
+	/**
+	 *    instance of the EE_Config object
+	 *
+	 * @var    EE_Config $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean $_logging_enabled
+	 */
+	private static $_logging_enabled = false;
+
+	/**
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	private $legacy_shortcodes_manager;
+
+	/**
+	 * An StdClass whose property names are addon slugs,
+	 * and values are their config classes
+	 *
+	 * @var StdClass
+	 */
+	public $addons;
+
+	/**
+	 * @var EE_Admin_Config
+	 */
+	public $admin;
+
+	/**
+	 * @var EE_Core_Config
+	 */
+	public $core;
+
+	/**
+	 * @var EE_Currency_Config
+	 */
+	public $currency;
+
+	/**
+	 * @var EE_Organization_Config
+	 */
+	public $organization;
+
+	/**
+	 * @var EE_Registration_Config
+	 */
+	public $registration;
+
+	/**
+	 * @var EE_Template_Config
+	 */
+	public $template_settings;
+
+	/**
+	 * Holds EE environment values.
+	 *
+	 * @var EE_Environment_Config
+	 */
+	public $environment;
+
+	/**
+	 * settings pertaining to Google maps
+	 *
+	 * @var EE_Map_Config
+	 */
+	public $map_settings;
+
+	/**
+	 * settings pertaining to Taxes
+	 *
+	 * @var EE_Tax_Config
+	 */
+	public $tax_settings;
+
+	/**
+	 * Settings pertaining to global messages settings.
+	 *
+	 * @var EE_Messages_Config
+	 */
+	public $messages;
+
+	/**
+	 * @deprecated
+	 * @var EE_Gateway_Config
+	 */
+	public $gateway;
+
+	/**
+	 * @var    array $_addon_option_names
+	 * @access    private
+	 */
+	private $_addon_option_names = array();
+
+	/**
+	 * @var    array $_module_route_map
+	 * @access    private
+	 */
+	private static $_module_route_map = array();
+
+	/**
+	 * @var    array $_module_forward_map
+	 * @access    private
+	 */
+	private static $_module_forward_map = array();
+
+	/**
+	 * @var    array $_module_view_map
+	 * @access    private
+	 */
+	private static $_module_view_map = array();
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Config instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Config) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the config
+	 *
+	 * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
+	 *                               (default) leaves the database alone, and merely resets the EE_Config object to
+	 *                               reflect its state in the database
+	 * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
+	 *                               $_instance as NULL. Useful in case you want to forget about the old instance on
+	 *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
+	 *                               site was put into maintenance mode)
+	 * @return EE_Config
+	 */
+	public static function reset($hard_reset = false, $reinstantiate = true)
+	{
+		if (self::$_instance instanceof EE_Config) {
+			if ($hard_reset) {
+				self::$_instance->legacy_shortcodes_manager = null;
+				self::$_instance->_addon_option_names = array();
+				self::$_instance->_initialize_config();
+				self::$_instance->update_espresso_config();
+			}
+			self::$_instance->update_addon_option_names();
+		}
+		self::$_instance = null;
+		// we don't need to reset the static properties imo because those should
+		// only change when a module is added or removed. Currently we don't
+		// support removing a module during a request when it previously existed
+		if ($reinstantiate) {
+			return self::instance();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Config__construct__begin', $this);
+		EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
+		// setup empty config classes
+		$this->_initialize_config();
+		// load existing EE site settings
+		$this->_load_core_config();
+		// confirm everything loaded correctly and set filtered defaults if not
+		$this->_verify_config();
+		//  register shortcodes and modules
+		add_action(
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_and_modules'),
+			999
+		);
+		//  initialize shortcodes and modules
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
+		// register widgets
+		add_action('widgets_init', array($this, 'widgets_init'), 10);
+		// shutdown
+		add_action('shutdown', array($this, 'shutdown'), 10);
+		// construct__end hook
+		do_action('AHEE__EE_Config__construct__end', $this);
+		// hardcoded hack
+		$this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function logging_enabled()
+	{
+		return self::$_logging_enabled;
+	}
+
+
+	/**
+	 * use to get the current theme if needed from static context
+	 *
+	 * @return string current theme set.
+	 */
+	public static function get_current_theme()
+	{
+		return isset(self::$_instance->template_settings->current_espresso_theme)
+			? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 *        _initialize_config
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_config()
+	{
+		EE_Config::trim_log();
+		// set defaults
+		$this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
+		$this->addons = new stdClass();
+		// set _module_route_map
+		EE_Config::$_module_route_map = array();
+		// set _module_forward_map
+		EE_Config::$_module_forward_map = array();
+		// set _module_view_map
+		EE_Config::$_module_view_map = array();
+	}
+
+
+	/**
+	 *        load core plugin configuration
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_core_config()
+	{
+		// load_core_config__start hook
+		do_action('AHEE__EE_Config___load_core_config__start', $this);
+		$espresso_config = $this->get_espresso_config();
+		foreach ($espresso_config as $config => $settings) {
+			// load_core_config__start hook
+			$settings = apply_filters(
+				'FHEE__EE_Config___load_core_config__config_settings',
+				$settings,
+				$config,
+				$this
+			);
+			if (is_object($settings) && property_exists($this, $config)) {
+				$this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
+				// call configs populate method to ensure any defaults are set for empty values.
+				if (method_exists($settings, 'populate')) {
+					$this->{$config}->populate();
+				}
+				if (method_exists($settings, 'do_hooks')) {
+					$this->{$config}->do_hooks();
+				}
+			}
+		}
+		if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
+			$this->update_espresso_config();
+		}
+		// load_core_config__end hook
+		do_action('AHEE__EE_Config___load_core_config__end', $this);
+	}
+
+
+	/**
+	 *    _verify_config
+	 *
+	 * @access    protected
+	 * @return    void
+	 */
+	protected function _verify_config()
+	{
+		$this->core = $this->core instanceof EE_Core_Config
+			? $this->core
+			: new EE_Core_Config();
+		$this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
+		$this->organization = $this->organization instanceof EE_Organization_Config
+			? $this->organization
+			: new EE_Organization_Config();
+		$this->organization = apply_filters(
+			'FHEE__EE_Config___initialize_config__organization',
+			$this->organization
+		);
+		$this->currency = $this->currency instanceof EE_Currency_Config
+			? $this->currency
+			: new EE_Currency_Config();
+		$this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
+		$this->registration = $this->registration instanceof EE_Registration_Config
+			? $this->registration
+			: new EE_Registration_Config();
+		$this->registration = apply_filters(
+			'FHEE__EE_Config___initialize_config__registration',
+			$this->registration
+		);
+		$this->admin = $this->admin instanceof EE_Admin_Config
+			? $this->admin
+			: new EE_Admin_Config();
+		$this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
+		$this->template_settings = $this->template_settings instanceof EE_Template_Config
+			? $this->template_settings
+			: new EE_Template_Config();
+		$this->template_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__template_settings',
+			$this->template_settings
+		);
+		$this->map_settings = $this->map_settings instanceof EE_Map_Config
+			? $this->map_settings
+			: new EE_Map_Config();
+		$this->map_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__map_settings',
+			$this->map_settings
+		);
+		$this->environment = $this->environment instanceof EE_Environment_Config
+			? $this->environment
+			: new EE_Environment_Config();
+		$this->environment = apply_filters(
+			'FHEE__EE_Config___initialize_config__environment',
+			$this->environment
+		);
+		$this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
+			? $this->tax_settings
+			: new EE_Tax_Config();
+		$this->tax_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__tax_settings',
+			$this->tax_settings
+		);
+		$this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
+		$this->messages = $this->messages instanceof EE_Messages_Config
+			? $this->messages
+			: new EE_Messages_Config();
+		$this->gateway = $this->gateway instanceof EE_Gateway_Config
+			? $this->gateway
+			: new EE_Gateway_Config();
+		$this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
+		$this->legacy_shortcodes_manager = null;
+	}
+
+
+	/**
+	 *    get_espresso_config
+	 *
+	 * @access    public
+	 * @return    array of espresso config stuff
+	 */
+	public function get_espresso_config()
+	{
+		// grab espresso configuration
+		return apply_filters(
+			'FHEE__EE_Config__get_espresso_config__CFG',
+			get_option(EE_Config::OPTION_NAME, array())
+		);
+	}
+
+
+	/**
+	 *    double_check_config_comparison
+	 *
+	 * @access    public
+	 * @param string $option
+	 * @param        $old_value
+	 * @param        $value
+	 */
+	public function double_check_config_comparison($option = '', $old_value, $value)
+	{
+		// make sure we're checking the ee config
+		if ($option === EE_Config::OPTION_NAME) {
+			// run a loose comparison of the old value against the new value for type and properties,
+			// but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
+			if ($value != $old_value) {
+				// if they are NOT the same, then remove the hook,
+				// which means the subsequent update results will be based solely on the update query results
+				// the reason we do this is because, as stated above,
+				// WP update_option performs an exact instance comparison (===) on any update values passed to it
+				// this happens PRIOR to serialization and any subsequent update.
+				// If values are found to match their previous old value,
+				// then WP bails before performing any update.
+				// Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
+				// it just pulled from the db, with the one being passed to it (which will not match).
+				// HOWEVER, once the object is serialized and passed off to MySQL to update,
+				// MySQL MAY ALSO NOT perform the update because
+				// the string it sees in the db looks the same as the new one it has been passed!!!
+				// This results in the query returning an "affected rows" value of ZERO,
+				// which gets returned immediately by WP update_option and looks like an error.
+				remove_action('update_option', array($this, 'check_config_updated'));
+			}
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 */
+	protected function _reset_espresso_addon_config()
+	{
+		$this->_addon_option_names = array();
+		foreach ($this->addons as $addon_name => $addon_config_obj) {
+			$addon_config_obj = maybe_unserialize($addon_config_obj);
+			if ($addon_config_obj instanceof EE_Config_Base) {
+				$this->update_config('addons', $addon_name, $addon_config_obj, false);
+			}
+			$this->addons->{$addon_name} = null;
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 * @param   bool $add_success
+	 * @param   bool $add_error
+	 * @return   bool
+	 */
+	public function update_espresso_config($add_success = false, $add_error = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		// commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
+		// $clone = clone( self::$_instance );
+		// self::$_instance = NULL;
+		do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
+		$this->_reset_espresso_addon_config();
+		// hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
+		// but BEFORE the actual update occurs
+		add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
+		// don't want to persist legacy_shortcodes_manager, but don't want to lose it either
+		$legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
+		$this->legacy_shortcodes_manager = null;
+		// now update "ee_config"
+		$saved = update_option(EE_Config::OPTION_NAME, $this);
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
+		EE_Config::log(EE_Config::OPTION_NAME);
+		// if not saved... check if the hook we just added still exists;
+		// if it does, it means one of two things:
+		// that update_option bailed at the($value === $old_value) conditional,
+		// or...
+		// the db update query returned 0 rows affected
+		// (probably because the data  value was the same from it's perspective)
+		// so the existence of the hook means that a negative result from update_option is NOT an error,
+		// but just means no update occurred, so don't display an error to the user.
+		// BUT... if update_option returns FALSE, AND the hook is missing,
+		// then it means that something truly went wrong
+		$saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
+		// remove our action since we don't want it in the system anymore
+		remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
+		do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
+		// self::$_instance = $clone;
+		// unset( $clone );
+		// if config remains the same or was updated successfully
+		if ($saved) {
+			if ($add_success) {
+				EE_Error::add_success(
+					__('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return true;
+		} else {
+			if ($add_error) {
+				EE_Error::add_error(
+					__('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+	}
+
+
+	/**
+	 *    _verify_config_params
+	 *
+	 * @access    private
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @param    array          $tests_to_run
+	 * @param    bool           $display_errors
+	 * @return    bool    TRUE on success, FALSE on fail
+	 */
+	private function _verify_config_params(
+		$section = '',
+		$name = '',
+		$config_class = '',
+		$config_obj = null,
+		$tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
+		$display_errors = true
+	) {
+		try {
+			foreach ($tests_to_run as $test) {
+				switch ($test) {
+					// TEST #1 : check that section was set
+					case 1:
+						if (empty($section)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'No configuration section has been provided while attempting to save "%s".',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #2 : check that settings section exists
+					case 2:
+						if (! isset($this->{$section})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" configuration section does not exist.', 'event_espresso'),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #3 : check that section is the proper format
+					case 3:
+						if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
+						) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" configuration settings have not been formatted correctly.',
+											'event_espresso'
+										),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #4 : check that config section name has been set
+					case 4:
+						if (empty($name)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #5 : check that a config class name has been set
+					case 5:
+						if (empty($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No class name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #6 : verify config class is accessible
+					case 6:
+						if (! class_exists($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #7 : check that config has even been set
+					case 7:
+						if (! isset($this->{$section}->{$name})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
+										$section,
+										$name
+									)
+								);
+							}
+							return false;
+						} else {
+							// and make sure it's not serialized
+							$this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
+						}
+						break;
+					// TEST #8 : check that config is the requested type
+					case 8:
+						if (! $this->{$section}->{$name} instanceof $config_class) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
+											'event_espresso'
+										),
+										$section,
+										$name,
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #9 : verify config object
+					case 9:
+						if (! $config_obj instanceof EE_Config_Base) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
+										print_r($config_obj, true)
+									)
+								);
+							}
+							return false;
+						}
+						break;
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		// you have successfully run the gauntlet
+		return true;
+	}
+
+
+	/**
+	 *    _generate_config_option_name
+	 *
+	 * @access        protected
+	 * @param        string $section
+	 * @param        string $name
+	 * @return        string
+	 */
+	private function _generate_config_option_name($section = '', $name = '')
+	{
+		return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
+	}
+
+
+	/**
+	 *    _set_config_class
+	 * ensures that a config class is set, either from a passed config class or one generated from the config name
+	 *
+	 * @access    private
+	 * @param    string $config_class
+	 * @param    string $name
+	 * @return    string
+	 */
+	private function _set_config_class($config_class = '', $name = '')
+	{
+		return ! empty($config_class)
+			? $config_class
+			: str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
+	}
+
+
+	/**
+	 *    set_config
+	 *
+	 * @access    protected
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @return    EE_Config_Base
+	 */
+	public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6, and 7 to verify all config params are set and valid
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			$this->_addon_option_names[ $config_option_name ] = $config_class;
+			$this->update_addon_option_names();
+		}
+		// verify the incoming config object but suppress errors
+		if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			$config_obj = new $config_class();
+		}
+		if (get_option($config_option_name)) {
+			EE_Config::log($config_option_name);
+			update_option($config_option_name, $config_obj);
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		} else {
+			// create a wp-option for this config
+			if (add_option($config_option_name, $config_obj, '', 'no')) {
+				$this->{$section}->{$name} = maybe_unserialize($config_obj);
+				return $this->{$section}->{$name};
+			} else {
+				EE_Error::add_error(
+					sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return null;
+			}
+		}
+	}
+
+
+	/**
+	 *    update_config
+	 * Important: the config object must ALREADY be set, otherwise this will produce an error.
+	 *
+	 * @access    public
+	 * @param    string                $section
+	 * @param    string                $name
+	 * @param    EE_Config_Base|string $config_obj
+	 * @param    bool                  $throw_errors
+	 * @return    bool
+	 */
+	public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		$config_obj = maybe_unserialize($config_obj);
+		// get class name of the incoming object
+		$config_class = get_class($config_obj);
+		// run tests 1-5 and 9 to verify config
+		if (! $this->_verify_config_params(
+			$section,
+			$name,
+			$config_class,
+			$config_obj,
+			array(1, 2, 3, 4, 7, 9)
+		)
+		) {
+			return false;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			// save new config to db
+			if ($this->set_config($section, $name, $config_class, $config_obj)) {
+				return true;
+			}
+		} else {
+			// first check if the record already exists
+			$existing_config = get_option($config_option_name);
+			$config_obj = serialize($config_obj);
+			// just return if db record is already up to date (NOT type safe comparison)
+			if ($existing_config == $config_obj) {
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif (update_option($config_option_name, $config_obj)) {
+				EE_Config::log($config_option_name);
+				// update wp-option for this config class
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif ($throw_errors) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
+							'event_espresso'
+						),
+						$config_class,
+						'EE_Config->' . $section . '->' . $name
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    get_config
+	 *
+	 * @access    public
+	 * @param    string $section
+	 * @param    string $name
+	 * @param    string $config_class
+	 * @return    mixed EE_Config_Base | NULL
+	 */
+	public function get_config($section = '', $name = '', $config_class = '')
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6 and 7 to verify that all params have been set
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		// now test if the requested config object exists, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
+			// config already exists, so pass it back
+			return $this->{$section}->{$name};
+		}
+		// load config option from db if it exists
+		$config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
+		// verify the newly retrieved config object, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			// config is good, so set it and pass it back
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		}
+		// oops! $config_obj is not already set and does not exist in the db, so create a new one
+		$config_obj = $this->set_config($section, $name, $config_class);
+		// verify the newly created config object
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
+			return $this->{$section}->{$name};
+		} else {
+			EE_Error::add_error(
+				sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_config_option
+	 *
+	 * @access    public
+	 * @param    string $config_option_name
+	 * @return    mixed EE_Config_Base | FALSE
+	 */
+	public function get_config_option($config_option_name = '')
+	{
+		// retrieve the wp-option for this config class.
+		$config_option = maybe_unserialize(get_option($config_option_name, array()));
+		if (empty($config_option)) {
+			EE_Config::log($config_option_name . '-NOT-FOUND');
+		}
+		return $config_option;
+	}
+
+
+	/**
+	 * log
+	 *
+	 * @param string $config_option_name
+	 */
+	public static function log($config_option_name = '')
+	{
+		if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
+			$config_log = get_option(EE_Config::LOG_NAME, array());
+			// copy incoming $_REQUEST and sanitize it so we can save it
+			$_request = $_REQUEST;
+			array_walk_recursive($_request, 'sanitize_text_field');
+			$config_log[ (string) microtime(true) ] = array(
+				'config_name' => $config_option_name,
+				'request'     => $_request,
+			);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 * trim_log
+	 * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
+	 */
+	public static function trim_log()
+	{
+		if (! EE_Config::logging_enabled()) {
+			return;
+		}
+		$config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
+		$log_length = count($config_log);
+		if ($log_length > EE_Config::LOG_LENGTH) {
+			ksort($config_log);
+			$config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 *    get_page_for_posts
+	 *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
+	 *    wp-option "page_for_posts", or "posts" if no page is selected
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function get_page_for_posts()
+	{
+		$page_for_posts = get_option('page_for_posts');
+		if (! $page_for_posts) {
+			return 'posts';
+		}
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
+		return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
+	}
+
+
+	/**
+	 *    register_shortcodes_and_modules.
+	 *    At this point, it's too early to tell if we're maintenance mode or not.
+	 *    In fact, this is where we give modules a chance to let core know they exist
+	 *    so they can help trigger maintenance mode if it's needed
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function register_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		EE_Registry::instance()->modules = $this->_register_modules();
+	}
+
+
+	/**
+	 *    initialize_shortcodes_and_modules
+	 *    meaning they can start adding their hooks to get stuff done
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function initialize_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		$this->_initialize_modules();
+	}
+
+
+	/**
+	 *    widgets_init
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function widgets_init()
+	{
+		// only init widgets on admin pages when not in complete maintenance, and
+		// on frontend when not in any maintenance mode
+		if (! EE_Maintenance_Mode::instance()->level()
+			|| (
+				is_admin()
+				&& EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
+			)
+		) {
+			// grab list of installed widgets
+			$widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
+			// filter list of modules to register
+			$widgets_to_register = apply_filters(
+				'FHEE__EE_Config__register_widgets__widgets_to_register',
+				$widgets_to_register
+			);
+			if (! empty($widgets_to_register)) {
+				// cycle thru widget folders
+				foreach ($widgets_to_register as $widget_path) {
+					// add to list of installed widget modules
+					EE_Config::register_ee_widget($widget_path);
+				}
+			}
+			// filter list of installed modules
+			EE_Registry::instance()->widgets = apply_filters(
+				'FHEE__EE_Config__register_widgets__installed_widgets',
+				EE_Registry::instance()->widgets
+			);
+		}
+	}
+
+
+	/**
+	 *    register_ee_widget - makes core aware of this widget
+	 *
+	 * @access    public
+	 * @param    string $widget_path - full path up to and including widget folder
+	 * @return    void
+	 */
+	public static function register_ee_widget($widget_path = null)
+	{
+		do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
+		$widget_ext = '.widget.php';
+		// make all separators match
+		$widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($widget_path, $widget_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$file_name = explode('.', basename($widget_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
+			// sanitize shortcode directory name
+			$widget = sanitize_key($widget);
+			// now we need to rebuild the shortcode path
+			$widget_path = explode(DS, $widget_path);
+			// remove last segment
+			array_pop($widget_path);
+			// glue it back together
+			$widget_path = implode(DS, $widget_path);
+		} else {
+			// grab and sanitize widget directory name
+			$widget = sanitize_key(basename($widget_path));
+		}
+		// create classname from widget directory name
+		$widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
+		// add class prefix
+		$widget_class = 'EEW_' . $widget;
+		// does the widget exist ?
+		if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
+					'event_espresso'
+				),
+				$widget_class,
+				$widget_path . DS . $widget_class . $widget_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		// load the widget class file
+		require_once($widget_path . DS . $widget_class . $widget_ext);
+		// verify that class exists
+		if (! class_exists($widget_class)) {
+			$msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		register_widget($widget_class);
+		// add to array of registered widgets
+		EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
+	}
+
+
+	/**
+	 *        _register_modules
+	 *
+	 * @access private
+	 * @return array
+	 */
+	private function _register_modules()
+	{
+		// grab list of installed modules
+		$modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$modules_to_register = apply_filters(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			$modules_to_register
+		);
+		if (! empty($modules_to_register)) {
+			// loop through folders
+			foreach ($modules_to_register as $module_path) {
+				/**TEMPORARILY EXCLUDE gateways from modules for time being**/
+				if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
+					&& $module_path !== EE_MODULES . 'gateways'
+				) {
+					// add to list of installed modules
+					EE_Config::register_module($module_path);
+				}
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_modules__installed_modules',
+			EE_Registry::instance()->modules
+		);
+	}
+
+
+	/**
+	 *    register_module - makes core aware of this module
+	 *
+	 * @access    public
+	 * @param    string $module_path - full path up to and including module folder
+	 * @return    bool
+	 */
+	public static function register_module($module_path = null)
+	{
+		do_action('AHEE__EE_Config__register_module__begin', $module_path);
+		$module_ext = '.module.php';
+		// make all separators match
+		$module_path = str_replace(array('\\', '/'), DS, $module_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($module_path, $module_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$module_file = explode('.', basename($module_path));
+			// now we need to rebuild the shortcode path
+			$module_path = explode(DS, $module_path);
+			// remove last segment
+			array_pop($module_path);
+			// glue it back together
+			$module_path = implode(DS, $module_path) . DS;
+			// take first segment from file name pieces and sanitize it
+			$module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
+			// ensure class prefix is added
+			$module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize module name
+			$module = strtolower(basename($module_path));
+			$module = preg_replace('/[^a-z0-9_\-]/', '', $module);
+			// like trailingslashit()
+			$module_path = rtrim($module_path, DS) . DS;
+			// create classname from module directory name
+			$module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
+			// add class prefix
+			$module_class = 'EED_' . $module;
+		}
+		// does the module exist ?
+		if (! is_readable($module_path . DS . $module_class . $module_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s module 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;
+		}
+		// load the module class file
+		require_once($module_path . $module_class . $module_ext);
+		// 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
+		EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+		do_action(
+			'AHEE__EE_Config__register_module__complete',
+			$module_class,
+			EE_Registry::instance()->modules->{$module_class}
+		);
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_modules
+	 *    allow modules to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_modules()
+	{
+		// cycle thru shortcode folders
+		foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($module_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($module_class, 'set_hooks')
+				);
+			}
+		}
+	}
+
+
+	/**
+	 *    register_route - adds module method routes to route_map
+	 *
+	 * @access    public
+	 * @param    string $route       - "pretty" public alias for module method
+	 * @param    string $module      - module name (classname without EED_ prefix)
+	 * @param    string $method_name - the actual module method to be routed to
+	 * @param    string $key         - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
+		$module = str_replace('EED_', '', $module);
+		$module_class = 'EED_' . $module;
+		if (! isset(EE_Registry::instance()->modules->{$module_class})) {
+			$msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($route)) {
+			$msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! method_exists('EED_' . $module, $method_name)) {
+			$msg = sprintf(
+				__('A valid class method for the %s route has not been supplied.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
+		return true;
+	}
+
+
+	/**
+	 *    get_route - get module method route
+	 *
+	 * @access    public
+	 * @param    string $route - "pretty" public alias for module method
+	 * @param    string $key   - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_route($route = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_route__begin', $route);
+		$route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
+		if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
+			return EE_Config::$_module_route_map[ $key ][ $route ];
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_routes - get ALL module method routes
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function get_routes()
+	{
+		return EE_Config::$_module_route_map;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to forward request to another module for further processing
+	 *
+	 * @access    public
+	 * @param    string       $route   - "pretty" public alias for module method
+	 * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
+	 *                                 class, allows different forwards to be served based on status
+	 * @param    array|string $forward - function name or array( class, method )
+	 * @param    string       $key     - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this forward has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($forward)) {
+			$msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (is_array($forward)) {
+			if (! isset($forward[1])) {
+				$msg = sprintf(
+					__('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+			if (! method_exists($forward[0], $forward[1])) {
+				$msg = sprintf(
+					__('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
+					$forward[1],
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+		} elseif (! function_exists($forward)) {
+			$msg = sprintf(
+				__('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
+				$forward,
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
+		return true;
+	}
+
+
+	/**
+	 *    get_forward - get forwarding route
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different forwards to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_forward($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
+		if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_forward',
+				EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to specify different view templates for different method routes and status
+	 *    results
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $view
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this view has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! is_readable($view)) {
+			$msg = sprintf(
+				__(
+					'The %s view file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$view
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
+		return true;
+	}
+
+
+	/**
+	 *    get_view - get view for route and status
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_view($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_view__begin', $route, $status);
+		if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_view',
+				EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	public function update_addon_option_names()
+	{
+		update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
+	}
+
+
+	public function shutdown()
+	{
+		$this->update_addon_option_names();
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 */
+	public static function getLegacyShortcodesManager()
+	{
+
+		if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
+			EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
+				EE_Registry::instance()
+			);
+		}
+		return EE_Config::instance()->legacy_shortcodes_manager;
+	}
+
+
+	/**
+	 * register_shortcode - makes core aware of this shortcode
+	 *
+	 * @deprecated 4.9.26
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public static function register_shortcode($shortcode_path = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
+	}
+}
 
-    /**
-     * ReCaptcha Type
-     *
-     * @var string $recaptcha_type
-     *    options: 'audio', 'image'
-     */
-    public $recaptcha_type;
+/**
+ * Base class used for config classes. These classes should generally not have
+ * magic functions in use, except we'll allow them to magically set and get stuff...
+ * basically, they should just be well-defined stdClasses
+ */
+class EE_Config_Base
+{
 
-    /**
-     * ReCaptcha language
-     *
-     * @var string $recaptcha_language
-     * eg 'en'
-     */
-    public $recaptcha_language;
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if (! property_exists($this, $property)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
+						'event_espresso'
+					),
+					get_class($this),
+					$property
+				)
+			);
+		}
+		// just handling escaping of strings for now.
+		if (is_string($this->{$property})) {
+			return stripslashes($this->{$property});
+		}
+		return $this->{$property};
+	}
+
+
+	public function populate()
+	{
+		// grab defaults via a new instance of this class.
+		$class_name = get_class($this);
+		$defaults = new $class_name;
+		// loop through the properties for this class and see if they are set.  If they are NOT, then grab the
+		// default from our $defaults object.
+		foreach (get_object_vars($defaults) as $property => $value) {
+			if ($this->{$property} === null) {
+				$this->{$property} = $value;
+			}
+		}
+		// cleanup
+		unset($defaults);
+	}
+
+
+	/**
+	 *        __isset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __isset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __unset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __unset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __clone
+	 */
+	public function __clone()
+	{
+	}
+
+
+	/**
+	 *        __wakeup
+	 */
+	public function __wakeup()
+	{
+	}
+
+
+	/**
+	 *        __destruct
+	 */
+	public function __destruct()
+	{
+	}
+}
 
-    /**
-     * ReCaptcha public key
-     *
-     * @var string $recaptcha_publickey
-     */
-    public $recaptcha_publickey;
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Core_Config extends EE_Config_Base
+{
 
-    /**
-     * ReCaptcha private key
-     *
-     * @var string $recaptcha_privatekey
-     */
-    public $recaptcha_privatekey;
+	const OPTION_NAME_UXIP = 'ee_ueip_optin';
+
+
+	public $current_blog_id;
+
+	public $ee_ueip_optin;
+
+	public $ee_ueip_has_notified;
+
+	/**
+	 * Not to be confused with the 4 critical page variables (See
+	 * get_critical_pages_array()), this is just an array of wp posts that have EE
+	 * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
+	 * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
+	 *
+	 * @var array
+	 */
+	public $post_shortcodes;
+
+	public $module_route_map;
+
+	public $module_forward_map;
+
+	public $module_view_map;
+
+	/**
+	 * The next 4 vars are the IDs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_id;
+
+	public $txn_page_id;
+
+	public $thank_you_page_id;
+
+	public $cancel_page_id;
+
+	/**
+	 * The next 4 vars are the URLs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_url;
+
+	public $txn_page_url;
+
+	public $thank_you_page_url;
+
+	public $cancel_page_url;
+
+	/**
+	 * The next vars relate to the custom slugs for EE CPT routes
+	 */
+	public $event_cpt_slug;
+
+	/**
+	 * This caches the _ee_ueip_option in case this config is reset in the same
+	 * request across blog switches in a multisite context.
+	 * Avoids extra queries to the db for this option.
+	 *
+	 * @var bool
+	 */
+	public static $ee_ueip_option;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		$this->current_blog_id = get_current_blog_id();
+		$this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
+		$this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
+		$this->post_shortcodes = array();
+		$this->module_route_map = array();
+		$this->module_forward_map = array();
+		$this->module_view_map = array();
+		// critical EE page IDs
+		$this->reg_page_id = 0;
+		$this->txn_page_id = 0;
+		$this->thank_you_page_id = 0;
+		$this->cancel_page_id = 0;
+		// critical EE page URLs
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->thank_you_page_url = '';
+		$this->cancel_page_url = '';
+		// cpt slugs
+		$this->event_cpt_slug = __('events', 'event_espresso');
+		// ueip constant check
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
+			$this->ee_ueip_optin = false;
+			$this->ee_ueip_has_notified = true;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_array()
+	{
+		return array(
+			$this->reg_page_id,
+			$this->txn_page_id,
+			$this->thank_you_page_id,
+			$this->cancel_page_id,
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_shortcodes_array()
+	{
+		return array(
+			$this->reg_page_id       => 'ESPRESSO_CHECKOUT',
+			$this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
+			$this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
+			$this->cancel_page_id    => 'ESPRESSO_CANCELLED',
+		);
+	}
+
+
+	/**
+	 *  gets/returns URL for EE reg_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function reg_page_url()
+	{
+		if (! $this->reg_page_url) {
+			$this->reg_page_url = add_query_arg(
+				array('uts' => time()),
+				get_permalink($this->reg_page_id)
+			) . '#checkout';
+		}
+		return $this->reg_page_url;
+	}
+
+
+	/**
+	 *  gets/returns URL for EE txn_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function txn_page_url($query_args = array())
+	{
+		if (! $this->txn_page_url) {
+			$this->txn_page_url = get_permalink($this->txn_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->txn_page_url);
+		} else {
+			return $this->txn_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE thank_you_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function thank_you_page_url($query_args = array())
+	{
+		if (! $this->thank_you_page_url) {
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->thank_you_page_url);
+		} else {
+			return $this->thank_you_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE cancel_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function cancel_page_url()
+	{
+		if (! $this->cancel_page_url) {
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
+		}
+		return $this->cancel_page_url;
+	}
+
+
+	/**
+	 * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
+	 *
+	 * @since 4.7.5
+	 */
+	protected function _reset_urls()
+	{
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->cancel_page_url = '';
+		$this->thank_you_page_url = '';
+	}
+
+
+	/**
+	 * Used to return what the optin value is set for the EE User Experience Program.
+	 * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
+	 * on the main site only.
+	 *
+	 * @return bool
+	 */
+	protected function _get_main_ee_ueip_optin()
+	{
+		// if this is the main site then we can just bypass our direct query.
+		if (is_main_site()) {
+			return get_option(self::OPTION_NAME_UXIP, false);
+		}
+		// is this already cached for this request?  If so use it.
+		if (EE_Core_Config::$ee_ueip_option !== null) {
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		global $wpdb;
+		$current_network_main_site = is_multisite() ? get_current_site() : null;
+		$current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
+		$option = self::OPTION_NAME_UXIP;
+		// set correct table for query
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+		// rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
+		// get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
+		// re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
+		// this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
+		// for the purpose of caching.
+		$pre = apply_filters('pre_option_' . $option, false, $option);
+		if (false !== $pre) {
+			EE_Core_Config::$ee_ueip_option = $pre;
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		$row = $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
+				$option
+			)
+		);
+		if (is_object($row)) {
+			$value = $row->option_value;
+		} else { // option does not exist so use default.
+			EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+		return EE_Core_Config::$ee_ueip_option;
+	}
+
+
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if ($property === self::OPTION_NAME_UXIP) {
+			return $this->ee_ueip_optin ? 'yes' : 'no';
+		}
+		return parent::get_pretty($property);
+	}
+
+
+	/**
+	 * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
+	 * on the object.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// reset all url properties
+		$this->_reset_urls();
+		// return what to save to db
+		return array_keys(get_object_vars($this));
+	}
+}
 
-    /**
-     * array of form names protected by ReCaptcha
-     *
-     * @var array $recaptcha_protected_forms
-     */
-    public $recaptcha_protected_forms;
+/**
+ * Config class for storing info on the Organization
+ */
+class EE_Organization_Config extends EE_Config_Base
+{
 
-    /**
-     * ReCaptcha width
-     *
-     * @var int $recaptcha_width
-     * @deprecated
-     */
-    public $recaptcha_width;
+	/**
+	 * @var string $name
+	 * eg EE4.1
+	 */
+	public $name;
+
+	/**
+	 * @var string $address_1
+	 * eg 123 Onna Road
+	 */
+	public $address_1 = '';
+
+	/**
+	 * @var string $address_2
+	 * eg PO Box 123
+	 */
+	public $address_2 = '';
+
+	/**
+	 * @var string $city
+	 * eg Inna City
+	 */
+	public $city = '';
+
+	/**
+	 * @var int $STA_ID
+	 * eg 4
+	 */
+	public $STA_ID = 0;
+
+	/**
+	 * @var string $CNT_ISO
+	 * eg US
+	 */
+	public $CNT_ISO = '';
+
+	/**
+	 * @var string $zip
+	 * eg 12345  or V1A 2B3
+	 */
+	public $zip = '';
+
+	/**
+	 * @var string $email
+	 * eg support@eventespresso.com
+	 */
+	public $email;
+
+	/**
+	 * @var string $phone
+	 * eg. 111-111-1111
+	 */
+	public $phone = '';
+
+	/**
+	 * @var string $vat
+	 * VAT/Tax Number
+	 */
+	public $vat = '';
+
+	/**
+	 * @var string $logo_url
+	 * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
+	 */
+	public $logo_url = '';
+
+	/**
+	 * The below are all various properties for holding links to organization social network profiles
+	 *
+	 * @var string
+	 */
+	/**
+	 * facebook (facebook.com/profile.name)
+	 *
+	 * @var string
+	 */
+	public $facebook = '';
+
+	/**
+	 * twitter (twitter.com/twitter_handle)
+	 *
+	 * @var string
+	 */
+	public $twitter = '';
+
+	/**
+	 * linkedin (linkedin.com/in/profile_name)
+	 *
+	 * @var string
+	 */
+	public $linkedin = '';
+
+	/**
+	 * pinterest (www.pinterest.com/profile_name)
+	 *
+	 * @var string
+	 */
+	public $pinterest = '';
+
+	/**
+	 * google+ (google.com/+profileName)
+	 *
+	 * @var string
+	 */
+	public $google = '';
+
+	/**
+	 * instagram (instagram.com/handle)
+	 *
+	 * @var string
+	 */
+	public $instagram = '';
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		// decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
+		$this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
+		$this->email = get_bloginfo('admin_email');
+	}
+}
 
-    /**
-     * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
-     *
-     * @var boolean $track_invalid_checkout_access
-     */
-    protected $track_invalid_checkout_access = true;
+/**
+ * Class for defining what's in the EE_Config relating to currency
+ */
+class EE_Currency_Config extends EE_Config_Base
+{
 
-    /**
-     * Whether or not to show the privacy policy consent checkbox
-     *
-     * @var bool
-     */
-    public $consent_checkbox_enabled;
+	/**
+	 * @var string $code
+	 * eg 'US'
+	 */
+	public $code;
+
+	/**
+	 * @var string $name
+	 * eg 'Dollar'
+	 */
+	public $name;
+
+	/**
+	 * plural name
+	 *
+	 * @var string $plural
+	 * eg 'Dollars'
+	 */
+	public $plural;
+
+	/**
+	 * currency sign
+	 *
+	 * @var string $sign
+	 * eg '$'
+	 */
+	public $sign;
+
+	/**
+	 * Whether the currency sign should come before the number or not
+	 *
+	 * @var boolean $sign_b4
+	 */
+	public $sign_b4;
+
+	/**
+	 * How many digits should come after the decimal place
+	 *
+	 * @var int $dec_plc
+	 */
+	public $dec_plc;
+
+	/**
+	 * Symbol to use for decimal mark
+	 *
+	 * @var string $dec_mrk
+	 * eg '.'
+	 */
+	public $dec_mrk;
+
+	/**
+	 * Symbol to use for thousands
+	 *
+	 * @var string $thsnds
+	 * eg ','
+	 */
+	public $thsnds;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param string $CNT_ISO
+	 * @throws \EE_Error
+	 */
+	public function __construct($CNT_ISO = '')
+	{
+		/** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
+		$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		// get country code from organization settings or use default
+		$ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
+				   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: '';
+		// but override if requested
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
+		// so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
+		if (! empty($CNT_ISO)
+			&& EE_Maintenance_Mode::instance()->models_can_query()
+			&& $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
+		) {
+			// retrieve the country settings from the db, just in case they have been customized
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
+			if ($country instanceof EE_Country) {
+				$this->code = $country->currency_code();    // currency code: USD, CAD, EUR
+				$this->name = $country->currency_name_single();    // Dollar
+				$this->plural = $country->currency_name_plural();    // Dollars
+				$this->sign = $country->currency_sign();            // currency sign: $
+				$this->sign_b4 = $country->currency_sign_before(
+				);        // currency sign before or after: $TRUE  or  FALSE$
+				$this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
+				$this->dec_mrk = $country->currency_decimal_mark(
+				);    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$this->thsnds = $country->currency_thousands_separator(
+				);    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+			}
+		}
+		// fallback to hardcoded defaults, in case the above failed
+		if (empty($this->code)) {
+			// set default currency settings
+			$this->code = 'USD';    // currency code: USD, CAD, EUR
+			$this->name = __('Dollar', 'event_espresso');    // Dollar
+			$this->plural = __('Dollars', 'event_espresso');    // Dollars
+			$this->sign = '$';    // currency sign: $
+			$this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
+			$this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
+			$this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+			$this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+		}
+	}
+}
 
-    /**
-     * Label text to show on the checkbox
-     *
-     * @var string
-     */
-    public $consent_checkbox_label_text;
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Registration_Config extends EE_Config_Base
+{
 
-    /*
+	/**
+	 * Default registration status
+	 *
+	 * @var string $default_STS_ID
+	 * eg 'RPP'
+	 */
+	public $default_STS_ID;
+
+	/**
+	 * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
+	 * registrations)
+	 *
+	 * @var int
+	 */
+	public $default_maximum_number_of_tickets;
+
+	/**
+	 * level of validation to apply to email addresses
+	 *
+	 * @var string $email_validation_level
+	 * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
+	 */
+	public $email_validation_level;
+
+	/**
+	 *    whether or not to show alternate payment options during the reg process if payment status is pending
+	 *
+	 * @var boolean $show_pending_payment_options
+	 */
+	public $show_pending_payment_options;
+
+	/**
+	 * Whether to skip the registration confirmation page
+	 *
+	 * @var boolean $skip_reg_confirmation
+	 */
+	public $skip_reg_confirmation;
+
+	/**
+	 * an array of SPCO reg steps where:
+	 *        the keys denotes the reg step order
+	 *        each element consists of an array with the following elements:
+	 *            "file_path" => the file path to the EE_SPCO_Reg_Step class
+	 *            "class_name" => the specific EE_SPCO_Reg_Step child class name
+	 *            "slug" => the URL param used to trigger the reg step
+	 *
+	 * @var array $reg_steps
+	 */
+	public $reg_steps;
+
+	/**
+	 * Whether registration confirmation should be the last page of SPCO
+	 *
+	 * @var boolean $reg_confirmation_last
+	 */
+	public $reg_confirmation_last;
+
+	/**
+	 * Whether or not to enable the EE Bot Trap
+	 *
+	 * @var boolean $use_bot_trap
+	 */
+	public $use_bot_trap;
+
+	/**
+	 * Whether or not to encrypt some data sent by the EE Bot Trap
+	 *
+	 * @var boolean $use_encryption
+	 */
+	public $use_encryption;
+
+	/**
+	 * Whether or not to use ReCaptcha
+	 *
+	 * @var boolean $use_captcha
+	 */
+	public $use_captcha;
+
+	/**
+	 * ReCaptcha Theme
+	 *
+	 * @var string $recaptcha_theme
+	 *    options: 'dark', 'light', 'invisible'
+	 */
+	public $recaptcha_theme;
+
+	/**
+	 * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
+	 *
+	 * @var string $recaptcha_badge
+	 *    options: 'bottomright', 'bottomleft', 'inline'
+	 */
+	public $recaptcha_badge;
+
+	/**
+	 * ReCaptcha Type
+	 *
+	 * @var string $recaptcha_type
+	 *    options: 'audio', 'image'
+	 */
+	public $recaptcha_type;
+
+	/**
+	 * ReCaptcha language
+	 *
+	 * @var string $recaptcha_language
+	 * eg 'en'
+	 */
+	public $recaptcha_language;
+
+	/**
+	 * ReCaptcha public key
+	 *
+	 * @var string $recaptcha_publickey
+	 */
+	public $recaptcha_publickey;
+
+	/**
+	 * ReCaptcha private key
+	 *
+	 * @var string $recaptcha_privatekey
+	 */
+	public $recaptcha_privatekey;
+
+	/**
+	 * array of form names protected by ReCaptcha
+	 *
+	 * @var array $recaptcha_protected_forms
+	 */
+	public $recaptcha_protected_forms;
+
+	/**
+	 * ReCaptcha width
+	 *
+	 * @var int $recaptcha_width
+	 * @deprecated
+	 */
+	public $recaptcha_width;
+
+	/**
+	 * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
+	 *
+	 * @var boolean $track_invalid_checkout_access
+	 */
+	protected $track_invalid_checkout_access = true;
+
+	/**
+	 * Whether or not to show the privacy policy consent checkbox
+	 *
+	 * @var bool
+	 */
+	public $consent_checkbox_enabled;
+
+	/**
+	 * Label text to show on the checkbox
+	 *
+	 * @var string
+	 */
+	public $consent_checkbox_label_text;
+
+	/*
      * String describing how long to keep payment logs. Passed into DateTime constructor
      * @var string
      */
-    public $gateway_log_lifespan = '1 week';
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default registration settings
-        $this->default_STS_ID = EEM_Registration::status_id_pending_payment;
-        $this->email_validation_level = 'wp_default';
-        $this->show_pending_payment_options = true;
-        $this->skip_reg_confirmation = true;
-        $this->reg_steps = array();
-        $this->reg_confirmation_last = false;
-        $this->use_bot_trap = true;
-        $this->use_encryption = true;
-        $this->use_captcha = false;
-        $this->recaptcha_theme = 'light';
-        $this->recaptcha_badge = 'bottomleft';
-        $this->recaptcha_type = 'image';
-        $this->recaptcha_language = 'en';
-        $this->recaptcha_publickey = null;
-        $this->recaptcha_privatekey = null;
-        $this->recaptcha_protected_forms = array();
-        $this->recaptcha_width = 500;
-        $this->default_maximum_number_of_tickets = 10;
-        $this->consent_checkbox_enabled = false;
-        $this->consent_checkbox_label_text = '';
-        $this->gateway_log_lifespan = '7 days';
-    }
-
-
-    /**
-     * This is called by the config loader and hooks are initialized AFTER the config has been populated.
-     *
-     * @since 4.8.8.rc.019
-     */
-    public function do_hooks()
-    {
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
-        add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
-     * EVT_default_registration_status field matches the config setting for default_STS_ID.
-     */
-    public function set_default_reg_status_on_EEM_Event()
-    {
-        EEM_Event::set_default_reg_status($this->default_STS_ID);
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
-     * for Events matches the config setting for default_maximum_number_of_tickets
-     */
-    public function set_default_max_ticket_on_EEM_Event()
-    {
-        EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
-    }
-
-
-    /**
-     * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
-     * constructed because that happens before we can get the privacy policy page's permalink.
-     *
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function setDefaultCheckboxLabelText()
-    {
-        if ($this->getConsentCheckboxLabelText() === null
-            || $this->getConsentCheckboxLabelText() === '') {
-            $opening_a_tag = '';
-            $closing_a_tag = '';
-            if (function_exists('get_privacy_policy_url')) {
-                $privacy_page_url = get_privacy_policy_url();
-                if (! empty($privacy_page_url)) {
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
-                    $closing_a_tag = '</a>';
-                }
-            }
-            $loader = LoaderFactory::getLoader();
-            $org_config = $loader->getShared('EE_Organization_Config');
-            /**
-             * @var $org_config EE_Organization_Config
-             */
-
-            $this->setConsentCheckboxLabelText(
-                sprintf(
-                    esc_html__(
-                        'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
-                        'event_espresso'
-                    ),
-                    $org_config->name,
-                    $opening_a_tag,
-                    $closing_a_tag
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function track_invalid_checkout_access()
-    {
-        return $this->track_invalid_checkout_access;
-    }
-
-
-    /**
-     * @param boolean $track_invalid_checkout_access
-     */
-    public function set_track_invalid_checkout_access($track_invalid_checkout_access)
-    {
-        $this->track_invalid_checkout_access = filter_var(
-            $track_invalid_checkout_access,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * Gets the options to make availalbe for the gateway log lifespan
-     * @return array
-     */
-    public function gatewayLogLifespanOptions()
-    {
-        return (array) apply_filters(
-            'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
-            array(
-                '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
-                '1 day' => esc_html__('1 Day', 'event_espresso'),
-                '7 days' => esc_html__('7 Days', 'event_espresso'),
-                '14 days' => esc_html__('14 Days', 'event_espresso'),
-                '30 days' => esc_html__('30 Days', 'event_espresso')
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isConsentCheckboxEnabled()
-    {
-        return $this->consent_checkbox_enabled;
-    }
-
-
-    /**
-     * @param bool $consent_checkbox_enabled
-     */
-    public function setConsentCheckboxEnabled($consent_checkbox_enabled)
-    {
-        $this->consent_checkbox_enabled = filter_var(
-            $consent_checkbox_enabled,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getConsentCheckboxLabelText()
-    {
-        return $this->consent_checkbox_label_text;
-    }
-
-
-    /**
-     * @param string $consent_checkbox_label_text
-     */
-    public function setConsentCheckboxLabelText($consent_checkbox_label_text)
-    {
-        $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
-    }
+	public $gateway_log_lifespan = '1 week';
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default registration settings
+		$this->default_STS_ID = EEM_Registration::status_id_pending_payment;
+		$this->email_validation_level = 'wp_default';
+		$this->show_pending_payment_options = true;
+		$this->skip_reg_confirmation = true;
+		$this->reg_steps = array();
+		$this->reg_confirmation_last = false;
+		$this->use_bot_trap = true;
+		$this->use_encryption = true;
+		$this->use_captcha = false;
+		$this->recaptcha_theme = 'light';
+		$this->recaptcha_badge = 'bottomleft';
+		$this->recaptcha_type = 'image';
+		$this->recaptcha_language = 'en';
+		$this->recaptcha_publickey = null;
+		$this->recaptcha_privatekey = null;
+		$this->recaptcha_protected_forms = array();
+		$this->recaptcha_width = 500;
+		$this->default_maximum_number_of_tickets = 10;
+		$this->consent_checkbox_enabled = false;
+		$this->consent_checkbox_label_text = '';
+		$this->gateway_log_lifespan = '7 days';
+	}
+
+
+	/**
+	 * This is called by the config loader and hooks are initialized AFTER the config has been populated.
+	 *
+	 * @since 4.8.8.rc.019
+	 */
+	public function do_hooks()
+	{
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
+		add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
+	 * EVT_default_registration_status field matches the config setting for default_STS_ID.
+	 */
+	public function set_default_reg_status_on_EEM_Event()
+	{
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
+	 * for Events matches the config setting for default_maximum_number_of_tickets
+	 */
+	public function set_default_max_ticket_on_EEM_Event()
+	{
+		EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
+	}
+
+
+	/**
+	 * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
+	 * constructed because that happens before we can get the privacy policy page's permalink.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function setDefaultCheckboxLabelText()
+	{
+		if ($this->getConsentCheckboxLabelText() === null
+			|| $this->getConsentCheckboxLabelText() === '') {
+			$opening_a_tag = '';
+			$closing_a_tag = '';
+			if (function_exists('get_privacy_policy_url')) {
+				$privacy_page_url = get_privacy_policy_url();
+				if (! empty($privacy_page_url)) {
+					$opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
+					$closing_a_tag = '</a>';
+				}
+			}
+			$loader = LoaderFactory::getLoader();
+			$org_config = $loader->getShared('EE_Organization_Config');
+			/**
+			 * @var $org_config EE_Organization_Config
+			 */
+
+			$this->setConsentCheckboxLabelText(
+				sprintf(
+					esc_html__(
+						'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
+						'event_espresso'
+					),
+					$org_config->name,
+					$opening_a_tag,
+					$closing_a_tag
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function track_invalid_checkout_access()
+	{
+		return $this->track_invalid_checkout_access;
+	}
+
+
+	/**
+	 * @param boolean $track_invalid_checkout_access
+	 */
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access)
+	{
+		$this->track_invalid_checkout_access = filter_var(
+			$track_invalid_checkout_access,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * Gets the options to make availalbe for the gateway log lifespan
+	 * @return array
+	 */
+	public function gatewayLogLifespanOptions()
+	{
+		return (array) apply_filters(
+			'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
+			array(
+				'1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
+				'1 day' => esc_html__('1 Day', 'event_espresso'),
+				'7 days' => esc_html__('7 Days', 'event_espresso'),
+				'14 days' => esc_html__('14 Days', 'event_espresso'),
+				'30 days' => esc_html__('30 Days', 'event_espresso')
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isConsentCheckboxEnabled()
+	{
+		return $this->consent_checkbox_enabled;
+	}
+
+
+	/**
+	 * @param bool $consent_checkbox_enabled
+	 */
+	public function setConsentCheckboxEnabled($consent_checkbox_enabled)
+	{
+		$this->consent_checkbox_enabled = filter_var(
+			$consent_checkbox_enabled,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getConsentCheckboxLabelText()
+	{
+		return $this->consent_checkbox_label_text;
+	}
+
+
+	/**
+	 * @param string $consent_checkbox_label_text
+	 */
+	public function setConsentCheckboxLabelText($consent_checkbox_label_text)
+	{
+		$this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
+	}
 }
 
 /**
@@ -2525,154 +2525,154 @@ 
 class EE_Admin_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_personnel_manager
-     */
-    public $use_personnel_manager;
-
-    /**
-     * @var boolean $use_dashboard_widget
-     */
-    public $use_dashboard_widget;
-
-    /**
-     * @var int $events_in_dashboard
-     */
-    public $events_in_dashboard;
-
-    /**
-     * @var boolean $use_event_timezones
-     */
-    public $use_event_timezones;
-
-    /**
-     * @var boolean $use_full_logging
-     */
-    public $use_full_logging;
-
-    /**
-     * @var string $log_file_name
-     */
-    public $log_file_name;
-
-    /**
-     * @var string $debug_file_name
-     */
-    public $debug_file_name;
-
-    /**
-     * @var boolean $use_remote_logging
-     */
-    public $use_remote_logging;
-
-    /**
-     * @var string $remote_logging_url
-     */
-    public $remote_logging_url;
-
-    /**
-     * @var boolean $show_reg_footer
-     */
-    public $show_reg_footer;
-
-    /**
-     * @var string $affiliate_id
-     */
-    public $affiliate_id;
-
-    /**
-     * help tours on or off (global setting)
-     *
-     * @var boolean
-     */
-    public $help_tour_activation;
-
-    /**
-     * adds extra layer of encoding to session data to prevent serialization errors
-     * but is incompatible with some server configuration errors
-     * if you get "500 internal server errors" during registration, try turning this on
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
-     *
-     * @var boolean $encode_session_data
-     */
-    private $encode_session_data = false;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default general admin settings
-        $this->use_personnel_manager = true;
-        $this->use_dashboard_widget = true;
-        $this->events_in_dashboard = 30;
-        $this->use_event_timezones = false;
-        $this->use_full_logging = false;
-        $this->use_remote_logging = false;
-        $this->remote_logging_url = null;
-        $this->show_reg_footer = true;
-        $this->affiliate_id = 'default';
-        $this->help_tour_activation = true;
-        $this->encode_session_data = false;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function log_file_name($reset = false)
-    {
-        if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->log_file_name;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function debug_file_name($reset = false)
-    {
-        if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->debug_file_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function affiliate_id()
-    {
-        return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function encode_session_data()
-    {
-        return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param boolean $encode_session_data
-     */
-    public function set_encode_session_data($encode_session_data)
-    {
-        $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var boolean $use_personnel_manager
+	 */
+	public $use_personnel_manager;
+
+	/**
+	 * @var boolean $use_dashboard_widget
+	 */
+	public $use_dashboard_widget;
+
+	/**
+	 * @var int $events_in_dashboard
+	 */
+	public $events_in_dashboard;
+
+	/**
+	 * @var boolean $use_event_timezones
+	 */
+	public $use_event_timezones;
+
+	/**
+	 * @var boolean $use_full_logging
+	 */
+	public $use_full_logging;
+
+	/**
+	 * @var string $log_file_name
+	 */
+	public $log_file_name;
+
+	/**
+	 * @var string $debug_file_name
+	 */
+	public $debug_file_name;
+
+	/**
+	 * @var boolean $use_remote_logging
+	 */
+	public $use_remote_logging;
+
+	/**
+	 * @var string $remote_logging_url
+	 */
+	public $remote_logging_url;
+
+	/**
+	 * @var boolean $show_reg_footer
+	 */
+	public $show_reg_footer;
+
+	/**
+	 * @var string $affiliate_id
+	 */
+	public $affiliate_id;
+
+	/**
+	 * help tours on or off (global setting)
+	 *
+	 * @var boolean
+	 */
+	public $help_tour_activation;
+
+	/**
+	 * adds extra layer of encoding to session data to prevent serialization errors
+	 * but is incompatible with some server configuration errors
+	 * if you get "500 internal server errors" during registration, try turning this on
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
+	 *
+	 * @var boolean $encode_session_data
+	 */
+	private $encode_session_data = false;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default general admin settings
+		$this->use_personnel_manager = true;
+		$this->use_dashboard_widget = true;
+		$this->events_in_dashboard = 30;
+		$this->use_event_timezones = false;
+		$this->use_full_logging = false;
+		$this->use_remote_logging = false;
+		$this->remote_logging_url = null;
+		$this->show_reg_footer = true;
+		$this->affiliate_id = 'default';
+		$this->help_tour_activation = true;
+		$this->encode_session_data = false;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function log_file_name($reset = false)
+	{
+		if (empty($this->log_file_name) || $reset) {
+			$this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->log_file_name;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function debug_file_name($reset = false)
+	{
+		if (empty($this->debug_file_name) || $reset) {
+			$this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->debug_file_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function affiliate_id()
+	{
+		return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function encode_session_data()
+	{
+		return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param boolean $encode_session_data
+	 */
+	public function set_encode_session_data($encode_session_data)
+	{
+		$this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
 }
 
 /**
@@ -2681,70 +2681,70 @@ 
 class EE_Template_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $enable_default_style
-     */
-    public $enable_default_style;
-
-    /**
-     * @var string $custom_style_sheet
-     */
-    public $custom_style_sheet;
-
-    /**
-     * @var boolean $display_address_in_regform
-     */
-    public $display_address_in_regform;
-
-    /**
-     * @var int $display_description_on_multi_reg_page
-     */
-    public $display_description_on_multi_reg_page;
-
-    /**
-     * @var boolean $use_custom_templates
-     */
-    public $use_custom_templates;
-
-    /**
-     * @var string $current_espresso_theme
-     */
-    public $current_espresso_theme;
-
-    /**
-     * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
-     */
-    public $EED_Ticket_Selector;
-
-    /**
-     * @var EE_Event_Single_Config $EED_Event_Single
-     */
-    public $EED_Event_Single;
-
-    /**
-     * @var EE_Events_Archive_Config $EED_Events_Archive
-     */
-    public $EED_Events_Archive;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default template settings
-        $this->enable_default_style = true;
-        $this->custom_style_sheet = null;
-        $this->display_address_in_regform = true;
-        $this->display_description_on_multi_reg_page = false;
-        $this->use_custom_templates = false;
-        $this->current_espresso_theme = 'Espresso_Arabica_2014';
-        $this->EED_Event_Single = null;
-        $this->EED_Events_Archive = null;
-        $this->EED_Ticket_Selector = null;
-    }
+	/**
+	 * @var boolean $enable_default_style
+	 */
+	public $enable_default_style;
+
+	/**
+	 * @var string $custom_style_sheet
+	 */
+	public $custom_style_sheet;
+
+	/**
+	 * @var boolean $display_address_in_regform
+	 */
+	public $display_address_in_regform;
+
+	/**
+	 * @var int $display_description_on_multi_reg_page
+	 */
+	public $display_description_on_multi_reg_page;
+
+	/**
+	 * @var boolean $use_custom_templates
+	 */
+	public $use_custom_templates;
+
+	/**
+	 * @var string $current_espresso_theme
+	 */
+	public $current_espresso_theme;
+
+	/**
+	 * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
+	 */
+	public $EED_Ticket_Selector;
+
+	/**
+	 * @var EE_Event_Single_Config $EED_Event_Single
+	 */
+	public $EED_Event_Single;
+
+	/**
+	 * @var EE_Events_Archive_Config $EED_Events_Archive
+	 */
+	public $EED_Events_Archive;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default template settings
+		$this->enable_default_style = true;
+		$this->custom_style_sheet = null;
+		$this->display_address_in_regform = true;
+		$this->display_description_on_multi_reg_page = false;
+		$this->use_custom_templates = false;
+		$this->current_espresso_theme = 'Espresso_Arabica_2014';
+		$this->EED_Event_Single = null;
+		$this->EED_Events_Archive = null;
+		$this->EED_Ticket_Selector = null;
+	}
 }
 
 /**
@@ -2753,114 +2753,114 @@ 
 class EE_Map_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_google_maps
-     */
-    public $use_google_maps;
-
-    /**
-     * @var string $api_key
-     */
-    public $google_map_api_key;
-
-    /**
-     * @var int $event_details_map_width
-     */
-    public $event_details_map_width;
-
-    /**
-     * @var int $event_details_map_height
-     */
-    public $event_details_map_height;
-
-    /**
-     * @var int $event_details_map_zoom
-     */
-    public $event_details_map_zoom;
-
-    /**
-     * @var boolean $event_details_display_nav
-     */
-    public $event_details_display_nav;
-
-    /**
-     * @var boolean $event_details_nav_size
-     */
-    public $event_details_nav_size;
-
-    /**
-     * @var string $event_details_control_type
-     */
-    public $event_details_control_type;
-
-    /**
-     * @var string $event_details_map_align
-     */
-    public $event_details_map_align;
-
-    /**
-     * @var int $event_list_map_width
-     */
-    public $event_list_map_width;
-
-    /**
-     * @var int $event_list_map_height
-     */
-    public $event_list_map_height;
-
-    /**
-     * @var int $event_list_map_zoom
-     */
-    public $event_list_map_zoom;
-
-    /**
-     * @var boolean $event_list_display_nav
-     */
-    public $event_list_display_nav;
-
-    /**
-     * @var boolean $event_list_nav_size
-     */
-    public $event_list_nav_size;
-
-    /**
-     * @var string $event_list_control_type
-     */
-    public $event_list_control_type;
-
-    /**
-     * @var string $event_list_map_align
-     */
-    public $event_list_map_align;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default map settings
-        $this->use_google_maps = true;
-        $this->google_map_api_key = '';
-        // for event details pages (reg page)
-        $this->event_details_map_width = 585;            // ee_map_width_single
-        $this->event_details_map_height = 362;            // ee_map_height_single
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
-        $this->event_details_map_align = 'center';            // ee_map_align_single
-        // for event list pages
-        $this->event_list_map_width = 300;            // ee_map_width
-        $this->event_list_map_height = 185;        // ee_map_height
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
-        $this->event_list_display_nav = false;        // ee_map_nav_display
-        $this->event_list_nav_size = true;            // ee_map_nav_size
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $this->event_list_map_align = 'center';            // ee_map_align
-    }
+	/**
+	 * @var boolean $use_google_maps
+	 */
+	public $use_google_maps;
+
+	/**
+	 * @var string $api_key
+	 */
+	public $google_map_api_key;
+
+	/**
+	 * @var int $event_details_map_width
+	 */
+	public $event_details_map_width;
+
+	/**
+	 * @var int $event_details_map_height
+	 */
+	public $event_details_map_height;
+
+	/**
+	 * @var int $event_details_map_zoom
+	 */
+	public $event_details_map_zoom;
+
+	/**
+	 * @var boolean $event_details_display_nav
+	 */
+	public $event_details_display_nav;
+
+	/**
+	 * @var boolean $event_details_nav_size
+	 */
+	public $event_details_nav_size;
+
+	/**
+	 * @var string $event_details_control_type
+	 */
+	public $event_details_control_type;
+
+	/**
+	 * @var string $event_details_map_align
+	 */
+	public $event_details_map_align;
+
+	/**
+	 * @var int $event_list_map_width
+	 */
+	public $event_list_map_width;
+
+	/**
+	 * @var int $event_list_map_height
+	 */
+	public $event_list_map_height;
+
+	/**
+	 * @var int $event_list_map_zoom
+	 */
+	public $event_list_map_zoom;
+
+	/**
+	 * @var boolean $event_list_display_nav
+	 */
+	public $event_list_display_nav;
+
+	/**
+	 * @var boolean $event_list_nav_size
+	 */
+	public $event_list_nav_size;
+
+	/**
+	 * @var string $event_list_control_type
+	 */
+	public $event_list_control_type;
+
+	/**
+	 * @var string $event_list_map_align
+	 */
+	public $event_list_map_align;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default map settings
+		$this->use_google_maps = true;
+		$this->google_map_api_key = '';
+		// for event details pages (reg page)
+		$this->event_details_map_width = 585;            // ee_map_width_single
+		$this->event_details_map_height = 362;            // ee_map_height_single
+		$this->event_details_map_zoom = 14;            // ee_map_zoom_single
+		$this->event_details_display_nav = true;            // ee_map_nav_display_single
+		$this->event_details_nav_size = false;            // ee_map_nav_size_single
+		$this->event_details_control_type = 'default';        // ee_map_type_control_single
+		$this->event_details_map_align = 'center';            // ee_map_align_single
+		// for event list pages
+		$this->event_list_map_width = 300;            // ee_map_width
+		$this->event_list_map_height = 185;        // ee_map_height
+		$this->event_list_map_zoom = 12;            // ee_map_zoom
+		$this->event_list_display_nav = false;        // ee_map_nav_display
+		$this->event_list_nav_size = true;            // ee_map_nav_size
+		$this->event_list_control_type = 'dropdown';        // ee_map_type_control
+		$this->event_list_map_align = 'center';            // ee_map_align
+	}
 }
 
 /**
@@ -2869,46 +2869,46 @@ 
 class EE_Events_Archive_Config extends EE_Config_Base
 {
 
-    public $display_status_banner;
+	public $display_status_banner;
 
-    public $display_description;
+	public $display_description;
 
-    public $display_ticket_selector;
+	public $display_ticket_selector;
 
-    public $display_datetimes;
+	public $display_datetimes;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $display_expired_events;
+	public $display_expired_events;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner = 0;
-        $this->display_description = 1;
-        $this->display_ticket_selector = 0;
-        $this->display_datetimes = 1;
-        $this->display_venue = 0;
-        $this->display_expired_events = 0;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner = 0;
+		$this->display_description = 1;
+		$this->display_ticket_selector = 0;
+		$this->display_datetimes = 1;
+		$this->display_venue = 0;
+		$this->display_expired_events = 0;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 /**
@@ -2917,34 +2917,34 @@ 
 class EE_Event_Single_Config extends EE_Config_Base
 {
 
-    public $display_status_banner_single;
+	public $display_status_banner_single;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner_single = 0;
-        $this->display_venue = 1;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner_single = 0;
+		$this->display_venue = 1;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 /**
@@ -2953,172 +2953,172 @@ 
 class EE_Ticket_Selector_Config extends EE_Config_Base
 {
 
-    /**
-     * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
-     */
-    const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
-
-    /**
-     * constant to indicate that a datetime selector should only be shown for ticket selectors
-     * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
-     */
-    const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
-
-    /**
-     * @var boolean $show_ticket_sale_columns
-     */
-    public $show_ticket_sale_columns;
-
-    /**
-     * @var boolean $show_ticket_details
-     */
-    public $show_ticket_details;
-
-    /**
-     * @var boolean $show_expired_tickets
-     */
-    public $show_expired_tickets;
-
-    /**
-     * whether or not to display a dropdown box populated with event datetimes
-     * that toggles which tickets are displayed for a ticket selector.
-     * uses one of the *_DATETIME_SELECTOR constants defined above
-     *
-     * @var string $show_datetime_selector
-     */
-    private $show_datetime_selector = 'no_datetime_selector';
-
-    /**
-     * the number of datetimes an event has to have before conditionally displaying a datetime selector
-     *
-     * @var int $datetime_selector_threshold
-     */
-    private $datetime_selector_threshold = 3;
-
-    /**
-     * determines the maximum number of "checked" dates in the date and time filter
-     *
-     * @var int $datetime_selector_checked
-     */
-    private $datetime_selector_max_checked = 10;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->show_ticket_sale_columns = true;
-        $this->show_ticket_details = true;
-        $this->show_expired_tickets = true;
-        $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-        $this->datetime_selector_threshold = 3;
-        $this->datetime_selector_max_checked = 10;
-    }
-
-
-    /**
-     * returns true if a datetime selector should be displayed
-     *
-     * @param array $datetimes
-     * @return bool
-     */
-    public function showDatetimeSelector(array $datetimes)
-    {
-        // if the settings are NOT: don't show OR below threshold, THEN active = true
-        return ! (
-            $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
-            || (
-                $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
-                && count($datetimes) < $this->getDatetimeSelectorThreshold()
-            )
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getShowDatetimeSelector()
-    {
-        return $this->show_datetime_selector;
-    }
-
-
-    /**
-     * @param bool $keys_only
-     * @return array
-     */
-    public function getShowDatetimeSelectorOptions($keys_only = true)
-    {
-        return $keys_only
-            ? array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
-            )
-            : array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
-                    'Do not show date & time filter',
-                    'event_espresso'
-                ),
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
-                    'Maybe show date & time filter',
-                    'event_espresso'
-                ),
-            );
-    }
-
-
-    /**
-     * @param string $show_datetime_selector
-     */
-    public function setShowDatetimeSelector($show_datetime_selector)
-    {
-        $this->show_datetime_selector = in_array(
-            $show_datetime_selector,
-            $this->getShowDatetimeSelectorOptions(),
-            true
-        )
-            ? $show_datetime_selector
-            : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorThreshold()
-    {
-        return $this->datetime_selector_threshold;
-    }
-
-
-    /**
-     * @param int $datetime_selector_threshold
-     */
-    public function setDatetimeSelectorThreshold($datetime_selector_threshold)
-    {
-        $datetime_selector_threshold = absint($datetime_selector_threshold);
-        $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorMaxChecked()
-    {
-        return $this->datetime_selector_max_checked;
-    }
-
-
-    /**
-     * @param int $datetime_selector_max_checked
-     */
-    public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
-    {
-        $this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
-    }
+	/**
+	 * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
+	 */
+	const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
+
+	/**
+	 * constant to indicate that a datetime selector should only be shown for ticket selectors
+	 * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
+	 */
+	const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
+
+	/**
+	 * @var boolean $show_ticket_sale_columns
+	 */
+	public $show_ticket_sale_columns;
+
+	/**
+	 * @var boolean $show_ticket_details
+	 */
+	public $show_ticket_details;
+
+	/**
+	 * @var boolean $show_expired_tickets
+	 */
+	public $show_expired_tickets;
+
+	/**
+	 * whether or not to display a dropdown box populated with event datetimes
+	 * that toggles which tickets are displayed for a ticket selector.
+	 * uses one of the *_DATETIME_SELECTOR constants defined above
+	 *
+	 * @var string $show_datetime_selector
+	 */
+	private $show_datetime_selector = 'no_datetime_selector';
+
+	/**
+	 * the number of datetimes an event has to have before conditionally displaying a datetime selector
+	 *
+	 * @var int $datetime_selector_threshold
+	 */
+	private $datetime_selector_threshold = 3;
+
+	/**
+	 * determines the maximum number of "checked" dates in the date and time filter
+	 *
+	 * @var int $datetime_selector_checked
+	 */
+	private $datetime_selector_max_checked = 10;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->show_ticket_sale_columns = true;
+		$this->show_ticket_details = true;
+		$this->show_expired_tickets = true;
+		$this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+		$this->datetime_selector_threshold = 3;
+		$this->datetime_selector_max_checked = 10;
+	}
+
+
+	/**
+	 * returns true if a datetime selector should be displayed
+	 *
+	 * @param array $datetimes
+	 * @return bool
+	 */
+	public function showDatetimeSelector(array $datetimes)
+	{
+		// if the settings are NOT: don't show OR below threshold, THEN active = true
+		return ! (
+			$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
+			|| (
+				$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
+				&& count($datetimes) < $this->getDatetimeSelectorThreshold()
+			)
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getShowDatetimeSelector()
+	{
+		return $this->show_datetime_selector;
+	}
+
+
+	/**
+	 * @param bool $keys_only
+	 * @return array
+	 */
+	public function getShowDatetimeSelectorOptions($keys_only = true)
+	{
+		return $keys_only
+			? array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
+			)
+			: array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
+					'Do not show date & time filter',
+					'event_espresso'
+				),
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
+					'Maybe show date & time filter',
+					'event_espresso'
+				),
+			);
+	}
+
+
+	/**
+	 * @param string $show_datetime_selector
+	 */
+	public function setShowDatetimeSelector($show_datetime_selector)
+	{
+		$this->show_datetime_selector = in_array(
+			$show_datetime_selector,
+			$this->getShowDatetimeSelectorOptions(),
+			true
+		)
+			? $show_datetime_selector
+			: \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorThreshold()
+	{
+		return $this->datetime_selector_threshold;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_threshold
+	 */
+	public function setDatetimeSelectorThreshold($datetime_selector_threshold)
+	{
+		$datetime_selector_threshold = absint($datetime_selector_threshold);
+		$this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorMaxChecked()
+	{
+		return $this->datetime_selector_max_checked;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_max_checked
+	 */
+	public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
+	{
+		$this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
+	}
 }
 
 /**
@@ -3131,81 +3131,81 @@ 
 class EE_Environment_Config extends EE_Config_Base
 {
 
-    /**
-     * Hold any php environment variables that we want to track.
-     *
-     * @var stdClass;
-     */
-    public $php;
-
-
-    /**
-     *    constructor
-     */
-    public function __construct()
-    {
-        $this->php = new stdClass();
-        $this->_set_php_values();
-    }
-
-
-    /**
-     * This sets the php environment variables.
-     *
-     * @since 4.4.0
-     * @return void
-     */
-    protected function _set_php_values()
-    {
-        $this->php->max_input_vars = ini_get('max_input_vars');
-        $this->php->version = phpversion();
-    }
-
-
-    /**
-     * helper method for determining whether input_count is
-     * reaching the potential maximum the server can handle
-     * according to max_input_vars
-     *
-     * @param int   $input_count the count of input vars.
-     * @return array {
-     *                           An array that represents whether available space and if no available space the error
-     *                           message.
-     * @type bool   $has_space   whether more inputs can be added.
-     * @type string $msg         Any message to be displayed.
-     *                           }
-     */
-    public function max_input_vars_limit_check($input_count = 0)
-    {
-        if (! empty($this->php->max_input_vars)
-            && ($input_count >= $this->php->max_input_vars)
-            && (PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9)
-        ) {
-            return sprintf(
-                __(
-                    'The maximum number of inputs on this page has been exceeded.  You cannot add anymore items (i.e. tickets, datetimes, custom fields) on this page because of your servers PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.',
-                    'event_espresso'
-                ),
-                '<br>',
-                $input_count,
-                $this->php->max_input_vars
-            );
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
-     *
-     * @since 4.4.1
-     * @return void
-     */
-    public function recheck_values()
-    {
-        $this->_set_php_values();
-    }
+	/**
+	 * Hold any php environment variables that we want to track.
+	 *
+	 * @var stdClass;
+	 */
+	public $php;
+
+
+	/**
+	 *    constructor
+	 */
+	public function __construct()
+	{
+		$this->php = new stdClass();
+		$this->_set_php_values();
+	}
+
+
+	/**
+	 * This sets the php environment variables.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 */
+	protected function _set_php_values()
+	{
+		$this->php->max_input_vars = ini_get('max_input_vars');
+		$this->php->version = phpversion();
+	}
+
+
+	/**
+	 * helper method for determining whether input_count is
+	 * reaching the potential maximum the server can handle
+	 * according to max_input_vars
+	 *
+	 * @param int   $input_count the count of input vars.
+	 * @return array {
+	 *                           An array that represents whether available space and if no available space the error
+	 *                           message.
+	 * @type bool   $has_space   whether more inputs can be added.
+	 * @type string $msg         Any message to be displayed.
+	 *                           }
+	 */
+	public function max_input_vars_limit_check($input_count = 0)
+	{
+		if (! empty($this->php->max_input_vars)
+			&& ($input_count >= $this->php->max_input_vars)
+			&& (PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9)
+		) {
+			return sprintf(
+				__(
+					'The maximum number of inputs on this page has been exceeded.  You cannot add anymore items (i.e. tickets, datetimes, custom fields) on this page because of your servers PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.',
+					'event_espresso'
+				),
+				'<br>',
+				$input_count,
+				$this->php->max_input_vars
+			);
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
+	 *
+	 * @since 4.4.1
+	 * @return void
+	 */
+	public function recheck_values()
+	{
+		$this->_set_php_values();
+	}
 }
 
 /**
@@ -3218,21 +3218,21 @@ 
 class EE_Tax_Config extends EE_Config_Base
 {
 
-    /*
+	/*
      * flag to indicate whether or not to display ticket prices with the taxes included
      *
      * @var boolean $prices_displayed_including_taxes
      */
-    public $prices_displayed_including_taxes;
+	public $prices_displayed_including_taxes;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->prices_displayed_including_taxes = true;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->prices_displayed_including_taxes = true;
+	}
 }
 
 /**
@@ -3246,19 +3246,19 @@ 
 class EE_Messages_Config extends EE_Config_Base
 {
 
-    /**
-     * This is an integer representing the deletion threshold in months for when old messages will get deleted.
-     * A value of 0 represents never deleting.  Default is 0.
-     *
-     * @var integer
-     */
-    public $delete_threshold;
+	/**
+	 * This is an integer representing the deletion threshold in months for when old messages will get deleted.
+	 * A value of 0 represents never deleting.  Default is 0.
+	 *
+	 * @var integer
+	 */
+	public $delete_threshold;
 
 
-    public function __construct()
-    {
-        $this->delete_threshold = 0;
-    }
+	public function __construct()
+	{
+		$this->delete_threshold = 0;
+	}
 }
 
 /**
@@ -3269,31 +3269,31 @@ 
 class EE_Gateway_Config extends EE_Config_Base
 {
 
-    /**
-     * Array with keys that are payment gateways slugs, and values are arrays
-     * with any config info the gateway wants to store
-     *
-     * @var array
-     */
-    public $payment_settings;
-
-    /**
-     * Where keys are gateway slugs, and values are booleans indicating whether or not
-     * the gateway is stored in the uploads directory
-     *
-     * @var array
-     */
-    public $active_gateways;
-
-
-    /**
-     *    class constructor
-     *
-     * @deprecated
-     */
-    public function __construct()
-    {
-        $this->payment_settings = array();
-        $this->active_gateways = array('Invoice' => false);
-    }
+	/**
+	 * Array with keys that are payment gateways slugs, and values are arrays
+	 * with any config info the gateway wants to store
+	 *
+	 * @var array
+	 */
+	public $payment_settings;
+
+	/**
+	 * Where keys are gateway slugs, and values are booleans indicating whether or not
+	 * the gateway is stored in the uploads directory
+	 *
+	 * @var array
+	 */
+	public $active_gateways;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated
+	 */
+	public function __construct()
+	{
+		$this->payment_settings = array();
+		$this->active_gateways = array('Invoice' => false);
+	}
 }

core/EE_Payment_Processor.core.php

Indentation +838 added lines, -838 removed lines

@@ -18,842 +18,842 @@
 class EE_Payment_Processor extends EE_Processor_Base implements ResettableInterface
 {
 
-    /**
-     * @var EE_Payment_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Payment_Processor instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Payment_Processor) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @return EE_Payment_Processor
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Payment_Processor__construct');
-        add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
-    }
-
-
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction
-     * appropriately. Saves the payment that is generated
-     *
-     * @param EE_Payment_Method    $payment_method
-     * @param EE_Transaction       $transaction
-     * @param float                $amount       if only part of the transaction is to be paid for, how much.
-     *                                           Leave null if payment is for the full amount owing
-     * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
-     *                                           Receive_form_submission() should have
-     *                                           already been called on the billing form
-     *                                           (ie, its inputs should have their normalized values set).
-     * @param string               $return_url   string used mostly by offsite gateways to specify
-     *                                           where to go AFTER the offsite gateway
-     * @param string               $method       like 'CART', indicates who the client who called this was
-     * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
-     * @param boolean              $update_txn   whether or not to call
-     *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string               $cancel_url   URL to return to if off-site payments are cancelled
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_payment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_form = null,
-        $return_url = null,
-        $method = 'CART',
-        $by_admin = false,
-        $update_txn = true,
-        $cancel_url = ''
-    ) {
-        if ((float) $amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-        // verify payment method
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        // verify transaction
-        EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                min($amount, $transaction->remaining()), // make sure we don't overcharge
-                $billing_form,
-                $return_url,
-                add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        }
-        EE_Error::add_error(
-            sprintf(
-                __(
-                    'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return null;
-    }
-
-
-    /**
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment_Method  $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_ipn_url_for_payment_method($transaction, $payment_method)
-    {
-        /** @type \EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        $url = add_query_arg(
-            array(
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ),
-            EE_Registry::instance()->CFG->core->txn_page_url()
-        );
-        return $url;
-    }
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array              $_req_data            eg $_REQUEST
-     * @param EE_Transaction|int $transaction          optional (or a transactions id)
-     * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
-     * @param boolean            $update_txn           whether or not to call
-     *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
-     *                                                 or is processed manually ( false like Mijireh )
-     * @throws EE_Error
-     * @throws Exception
-     * @return EE_Payment
-     * @throws \RuntimeException
-     * @throws \ReflectionException
-     * @throws \InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function process_ipn(
-        $_req_data,
-        $transaction = null,
-        $payment_method = null,
-        $update_txn = true,
-        $separate_IPN_request = true
-    ) {
-        EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        $obj_for_log = null;
-        if ($transaction instanceof EE_Transaction) {
-            $obj_for_log = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $obj_for_log = EEM_Payment::instance()->get_one(
-                    array(
-                        array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
-                        'order_by' => array('PAY_timestamp' => 'desc'),
-                    )
-                );
-            }
-        } elseif ($payment_method instanceof EE_Payment) {
-            $obj_for_log = $payment_method;
-        }
-        $log = EEM_Change_Log::instance()->log(
-            EEM_Change_Log::type_gateway,
-            array('IPN data received' => $_req_data),
-            $obj_for_log
-        );
-        try {
-            /**
-             * @var EE_Payment $payment
-             */
-            $payment = null;
-            if ($transaction && $payment_method) {
-                /** @type EE_Transaction $transaction */
-                $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-                /** @type EE_Payment_Method $payment_method */
-                $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
-                if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-                    try {
-                        $payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
-                        $log->set_object($payment);
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    }
-                } else {
-                    // not a payment
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
-                                'event_espresso'
-                            ),
-                            '<br/>',
-                            EE_Registry::instance()->CFG->organization->get_pretty('email')
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // that's actually pretty ok. The IPN just wasn't able
-                // to identify which transaction or payment method this was for
-                // give all active payment methods a chance to claim it
-                $active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
-                foreach ($active_payment_methods as $active_payment_method) {
-                    try {
-                        $payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
-                        $payment_method = $active_payment_method;
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array('IPN data' => $_req_data),
-                            $payment
-                        );
-                        break;
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    } catch (EE_Error $e) {
-                        // that's fine- it apparently couldn't handle the IPN
-                    }
-                }
-            }
-            // EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
-            if ($payment instanceof EE_Payment) {
-                $payment->save();
-                //  update the TXN
-                $this->update_txn_based_on_payment(
-                    $transaction,
-                    $payment,
-                    $update_txn,
-                    $separate_IPN_request
-                );
-            } else {
-                // we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-                if ($payment_method) {
-                    EEM_Change_Log::instance()->log(
-                        EEM_Change_Log::type_gateway,
-                        array('IPN data' => $_req_data),
-                        $payment_method
-                    );
-                } elseif ($transaction) {
-                    EEM_Change_Log::instance()->log(
-                        EEM_Change_Log::type_gateway,
-                        array('IPN data' => $_req_data),
-                        $transaction
-                    );
-                }
-            }
-            return $payment;
-        } catch (EE_Error $e) {
-            do_action(
-                'AHEE__log',
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    __(
-                        'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
-                        'event_espresso'
-                    ),
-                    print_r($transaction, true),
-                    print_r($_req_data, true),
-                    $e->getMessage()
-                )
-            );
-            throw $e;
-        }
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param  array $request_data
-     * @return array
-     */
-    protected function _remove_unusable_characters_from_array(array $request_data)
-    {
-        $return_data = array();
-        foreach ($request_data as $key => $value) {
-            $return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
-                $value
-            );
-        }
-        return $return_data;
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    protected function _remove_unusable_characters($request_data)
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
-
-
-    /**
-     * Should be called just before displaying the payment attempt results to the user,
-     * when the payment attempt has finished. Some payment methods may have special
-     * logic to perform here. For example, if process_payment() happens on a special request
-     * and then the user is redirected to a page that displays the payment's status, this
-     * should be called while loading the page that displays the payment's status. If the user is
-     * sent to an offsite payment provider, this should be called upon returning from that offsite payment
-     * provider.
-     *
-     * @param EE_Transaction|int $transaction
-     * @param bool               $update_txn whether or not to call
-     *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
-     *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
-     */
-    public function finalize_payment_for($transaction, $update_txn = true)
-    {
-        /** @var $transaction EE_Transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $last_payment_method = $transaction->payment_method();
-        if ($last_payment_method instanceof EE_Payment_Method) {
-            $payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
-            $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            return $payment;
-        }
-        return null;
-    }
-
-
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param EE_Payment        $payment_to_refund
-     * @param array             $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_refund(
-        EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        array $refund_info = array()
-    ) {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
-        }
-        return $payment_to_refund;
-    }
-
-
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether or not to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment         $payment
-     * @param boolean            $update_txn
-     *                        whether or not to call
-     *                        EE_Transaction_Processor::
-     *                        update_transaction_and_registrations_after_checkout_or_payment()
-     *                        (you can save 1 DB query if you know you're going
-     *                        to save it later instead)
-     * @param bool               $IPN
-     *                        if processing IPNs or other similar payment
-     *                        related activities that occur in alternate
-     *                        requests than the main one that is processing the
-     *                        TXN, then set this to true to check whether the
-     *                        TXN is locked before updating
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
-    {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment && $payment->ID()) {
-                if ($payment->payment_method() instanceof EE_Payment_Method
-                    && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-                ) {
-                    $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                    // update TXN registrations with payment info
-                    $this->process_registration_payments($transaction, $payment);
-                }
-                $do_action = $payment->just_approved()
-                    ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                    : $do_action;
-            } else {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-            }
-            if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                // set new value for total paid
-                $transaction_payments->calculate_total_payments_and_update_status($transaction);
-                // call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
-                if ($update_txn) {
-                    $this->_post_payment_processing($transaction, $payment, $IPN);
-                }
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            // global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
-
-
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        array $registrations = array()
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        // EEM_Registration::instance()->show_next_x_db_queries();
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                array(
-                    array(
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
-                        'REG_final_price'  => array('!=', 0),
-                        'REG_final_price*' => array('!=', 'REG_paid', true),
-                    ),
-                )
-            );
-        }
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->process_registration_refund(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                } else {
-                    $available_payment_amount = $this->process_registration_payment(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                }
-            }
-        }
-        if ($available_payment_amount > 0
-            && apply_filters(
-                'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
-                false
-            )) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'
-                    ),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_payment_amount
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_payment_amount = 0.00
-    ) {
-        $owing = $registration->final_price() - $registration->paid();
-        if ($owing > 0) {
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount -= $payment_amount;
-            // calculate and set new REG_paid
-            $registration->set_paid($registration->paid() + $payment_amount);
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $payment_amount);
-        }
-        return $available_payment_amount;
-    }
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $payment_amount
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _apply_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $payment_amount = 0.00
-    ) {
-        // find any existing reg payment records for this registration and payment
-        $existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
-            array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
-        );
-        // if existing registration payment exists
-        if ($existing_reg_payment instanceof EE_Registration_Payment) {
-            // then update that record
-            $existing_reg_payment->set_amount($payment_amount);
-            $existing_reg_payment->save();
-        } else {
-            // or add new relation between registration and payment and set amount
-            $registration->_add_relation_to(
-                $payment,
-                'Payment',
-                array('RPY_amount' => $payment_amount)
-            );
-            // make it stick
-            $registration->save();
-        }
-    }
-
-
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_refund(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_refund_amount = 0.00
-    ) {
-        // EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
-        if ($registration->paid() > 0) {
-            // ensure $available_refund_amount is NOT negative
-            $available_refund_amount = (float) abs($available_refund_amount);
-            // don't allow refund amount to exceed the available payment amount, OR the amount paid
-            $refund_amount = min($available_refund_amount, (float) $registration->paid());
-            // update $available_payment_amount
-            $available_refund_amount -= $refund_amount;
-            // calculate and set new REG_paid
-            $registration->set_paid($registration->paid() - $refund_amount);
-            // convert payment amount back to a negative value for storage in the db
-            $refund_amount = (float) abs($refund_amount) * -1;
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $refund_amount);
-        }
-        return $available_refund_amount;
-    }
-
-
-    /**
-     * Process payments and transaction after payment process completed.
-     * ultimately this will send the TXN and payment details off so that notifications can be sent out.
-     * if this request happens to be processing an IPN,
-     * then we will also set the Payment Options Reg Step to completed,
-     * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // is the Payment Options Reg Step completed ?
-        $payment_options_step_completed = $transaction->reg_step_completed('payment_options');
-        // if the Payment Options Reg Step is completed...
-        $revisit = $payment_options_step_completed === true;
-        // then this is kinda sorta a revisit with regards to payments at least
-        $transaction_processor->set_revisit($revisit);
-        // if this is an IPN, let's consider the Payment Options Reg Step completed if not already
-        if ($IPN
-            && $payment_options_step_completed !== true
-            && ($payment->is_approved() || $payment->is_pending())
-        ) {
-            $payment_options_step_completed = $transaction->set_reg_step_completed(
-                'payment_options'
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid(false);
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        //  if this is an IPN and the final step has not been initiated
-        if ($IPN && $payment_options_step_completed && $finalized === false) {
-            // and if it hasn't already been set as being started...
-            $finalized = $transaction->set_reg_step_initiated('finalize_registration');
-        }
-        $transaction->save();
-        // because the above will return false if the final step was not fully completed, we need to check again...
-        if ($IPN && $finalized !== false) {
-            // and if we are all good to go, then send out notifications
-            add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            // ok, now process the transaction according to the payment
-            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                $transaction,
-                $payment
-            );
-        }
-        // DEBUG LOG
-        $payment_method = $payment->payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payment_method_type_obj = $payment_method->type_obj();
-            if ($payment_method_type_obj instanceof EE_PMT_Base) {
-                $gateway = $payment_method_type_obj->get_gateway();
-                if ($gateway instanceof EE_Gateway) {
-                    $gateway->log(
-                        array(
-                            'message'               => (string) __('Post Payment Transaction Details', 'event_espresso'),
-                            'transaction'           => $transaction->model_field_array(),
-                            'finalized'             => $finalized,
-                            'IPN'                   => $IPN,
-                            'deliver_notifications' => has_filter(
-                                'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-                            ),
-                        ),
-                        $payment
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect PayPal standard, pro, express, and Payflow.
-     *
-     * @param $handle
-     * @param $r
-     * @param $url
-     */
-    public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
-    {
-        if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
-            // Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            // instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 6);
-        }
-    }
+	/**
+	 * @var EE_Payment_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Payment_Processor instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Payment_Processor) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Payment_Processor
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Payment_Processor__construct');
+		add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
+	}
+
+
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction
+	 * appropriately. Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method    $payment_method
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount       if only part of the transaction is to be paid for, how much.
+	 *                                           Leave null if payment is for the full amount owing
+	 * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
+	 *                                           Receive_form_submission() should have
+	 *                                           already been called on the billing form
+	 *                                           (ie, its inputs should have their normalized values set).
+	 * @param string               $return_url   string used mostly by offsite gateways to specify
+	 *                                           where to go AFTER the offsite gateway
+	 * @param string               $method       like 'CART', indicates who the client who called this was
+	 * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
+	 * @param boolean              $update_txn   whether or not to call
+	 *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string               $cancel_url   URL to return to if off-site payments are cancelled
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_payment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_form = null,
+		$return_url = null,
+		$method = 'CART',
+		$by_admin = false,
+		$update_txn = true,
+		$cancel_url = ''
+	) {
+		if ((float) $amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+		// verify payment method
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		// verify transaction
+		EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				min($amount, $transaction->remaining()), // make sure we don't overcharge
+				$billing_form,
+				$return_url,
+				add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		}
+		EE_Error::add_error(
+			sprintf(
+				__(
+					'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return null;
+	}
+
+
+	/**
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment_Method  $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_ipn_url_for_payment_method($transaction, $payment_method)
+	{
+		/** @type \EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		$url = add_query_arg(
+			array(
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			),
+			EE_Registry::instance()->CFG->core->txn_page_url()
+		);
+		return $url;
+	}
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array              $_req_data            eg $_REQUEST
+	 * @param EE_Transaction|int $transaction          optional (or a transactions id)
+	 * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
+	 * @param boolean            $update_txn           whether or not to call
+	 *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
+	 *                                                 or is processed manually ( false like Mijireh )
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @return EE_Payment
+	 * @throws \RuntimeException
+	 * @throws \ReflectionException
+	 * @throws \InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function process_ipn(
+		$_req_data,
+		$transaction = null,
+		$payment_method = null,
+		$update_txn = true,
+		$separate_IPN_request = true
+	) {
+		EE_Registry::instance()->load_model('Change_Log');
+		$_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		$obj_for_log = null;
+		if ($transaction instanceof EE_Transaction) {
+			$obj_for_log = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$obj_for_log = EEM_Payment::instance()->get_one(
+					array(
+						array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
+						'order_by' => array('PAY_timestamp' => 'desc'),
+					)
+				);
+			}
+		} elseif ($payment_method instanceof EE_Payment) {
+			$obj_for_log = $payment_method;
+		}
+		$log = EEM_Change_Log::instance()->log(
+			EEM_Change_Log::type_gateway,
+			array('IPN data received' => $_req_data),
+			$obj_for_log
+		);
+		try {
+			/**
+			 * @var EE_Payment $payment
+			 */
+			$payment = null;
+			if ($transaction && $payment_method) {
+				/** @type EE_Transaction $transaction */
+				$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+				/** @type EE_Payment_Method $payment_method */
+				$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
+				if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+					try {
+						$payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
+						$log->set_object($payment);
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					}
+				} else {
+					// not a payment
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
+								'event_espresso'
+							),
+							'<br/>',
+							EE_Registry::instance()->CFG->organization->get_pretty('email')
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// that's actually pretty ok. The IPN just wasn't able
+				// to identify which transaction or payment method this was for
+				// give all active payment methods a chance to claim it
+				$active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
+				foreach ($active_payment_methods as $active_payment_method) {
+					try {
+						$payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
+						$payment_method = $active_payment_method;
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array('IPN data' => $_req_data),
+							$payment
+						);
+						break;
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					} catch (EE_Error $e) {
+						// that's fine- it apparently couldn't handle the IPN
+					}
+				}
+			}
+			// EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
+			if ($payment instanceof EE_Payment) {
+				$payment->save();
+				//  update the TXN
+				$this->update_txn_based_on_payment(
+					$transaction,
+					$payment,
+					$update_txn,
+					$separate_IPN_request
+				);
+			} else {
+				// we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+				if ($payment_method) {
+					EEM_Change_Log::instance()->log(
+						EEM_Change_Log::type_gateway,
+						array('IPN data' => $_req_data),
+						$payment_method
+					);
+				} elseif ($transaction) {
+					EEM_Change_Log::instance()->log(
+						EEM_Change_Log::type_gateway,
+						array('IPN data' => $_req_data),
+						$transaction
+					);
+				}
+			}
+			return $payment;
+		} catch (EE_Error $e) {
+			do_action(
+				'AHEE__log',
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					__(
+						'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
+						'event_espresso'
+					),
+					print_r($transaction, true),
+					print_r($_req_data, true),
+					$e->getMessage()
+				)
+			);
+			throw $e;
+		}
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param  array $request_data
+	 * @return array
+	 */
+	protected function _remove_unusable_characters_from_array(array $request_data)
+	{
+		$return_data = array();
+		foreach ($request_data as $key => $value) {
+			$return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
+				$value
+			);
+		}
+		return $return_data;
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	protected function _remove_unusable_characters($request_data)
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
+
+
+	/**
+	 * Should be called just before displaying the payment attempt results to the user,
+	 * when the payment attempt has finished. Some payment methods may have special
+	 * logic to perform here. For example, if process_payment() happens on a special request
+	 * and then the user is redirected to a page that displays the payment's status, this
+	 * should be called while loading the page that displays the payment's status. If the user is
+	 * sent to an offsite payment provider, this should be called upon returning from that offsite payment
+	 * provider.
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param bool               $update_txn whether or not to call
+	 *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
+	 *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
+	 */
+	public function finalize_payment_for($transaction, $update_txn = true)
+	{
+		/** @var $transaction EE_Transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$last_payment_method = $transaction->payment_method();
+		if ($last_payment_method instanceof EE_Payment_Method) {
+			$payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
+			$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			return $payment;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param EE_Payment        $payment_to_refund
+	 * @param array             $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_refund(
+		EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		array $refund_info = array()
+	) {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
+		}
+		return $payment_to_refund;
+	}
+
+
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether or not to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment         $payment
+	 * @param boolean            $update_txn
+	 *                        whether or not to call
+	 *                        EE_Transaction_Processor::
+	 *                        update_transaction_and_registrations_after_checkout_or_payment()
+	 *                        (you can save 1 DB query if you know you're going
+	 *                        to save it later instead)
+	 * @param bool               $IPN
+	 *                        if processing IPNs or other similar payment
+	 *                        related activities that occur in alternate
+	 *                        requests than the main one that is processing the
+	 *                        TXN, then set this to true to check whether the
+	 *                        TXN is locked before updating
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
+	{
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment && $payment->ID()) {
+				if ($payment->payment_method() instanceof EE_Payment_Method
+					&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+				) {
+					$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+					// update TXN registrations with payment info
+					$this->process_registration_payments($transaction, $payment);
+				}
+				$do_action = $payment->just_approved()
+					? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+					: $do_action;
+			} else {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+			}
+			if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				// set new value for total paid
+				$transaction_payments->calculate_total_payments_and_update_status($transaction);
+				// call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
+				if ($update_txn) {
+					$this->_post_payment_processing($transaction, $payment, $IPN);
+				}
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			// global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
+
+
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		array $registrations = array()
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		// EEM_Registration::instance()->show_next_x_db_queries();
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				array(
+					array(
+						// only these reg statuses can receive payments
+						'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
+						'REG_final_price'  => array('!=', 0),
+						'REG_final_price*' => array('!=', 'REG_paid', true),
+					),
+				)
+			);
+		}
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->process_registration_refund(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				} else {
+					$available_payment_amount = $this->process_registration_payment(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				}
+			}
+		}
+		if ($available_payment_amount > 0
+			&& apply_filters(
+				'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
+				false
+			)) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'
+					),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_payment_amount
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_payment_amount = 0.00
+	) {
+		$owing = $registration->final_price() - $registration->paid();
+		if ($owing > 0) {
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount -= $payment_amount;
+			// calculate and set new REG_paid
+			$registration->set_paid($registration->paid() + $payment_amount);
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $payment_amount);
+		}
+		return $available_payment_amount;
+	}
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $payment_amount
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _apply_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$payment_amount = 0.00
+	) {
+		// find any existing reg payment records for this registration and payment
+		$existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
+			array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
+		);
+		// if existing registration payment exists
+		if ($existing_reg_payment instanceof EE_Registration_Payment) {
+			// then update that record
+			$existing_reg_payment->set_amount($payment_amount);
+			$existing_reg_payment->save();
+		} else {
+			// or add new relation between registration and payment and set amount
+			$registration->_add_relation_to(
+				$payment,
+				'Payment',
+				array('RPY_amount' => $payment_amount)
+			);
+			// make it stick
+			$registration->save();
+		}
+	}
+
+
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_refund(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_refund_amount = 0.00
+	) {
+		// EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
+		if ($registration->paid() > 0) {
+			// ensure $available_refund_amount is NOT negative
+			$available_refund_amount = (float) abs($available_refund_amount);
+			// don't allow refund amount to exceed the available payment amount, OR the amount paid
+			$refund_amount = min($available_refund_amount, (float) $registration->paid());
+			// update $available_payment_amount
+			$available_refund_amount -= $refund_amount;
+			// calculate and set new REG_paid
+			$registration->set_paid($registration->paid() - $refund_amount);
+			// convert payment amount back to a negative value for storage in the db
+			$refund_amount = (float) abs($refund_amount) * -1;
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $refund_amount);
+		}
+		return $available_refund_amount;
+	}
+
+
+	/**
+	 * Process payments and transaction after payment process completed.
+	 * ultimately this will send the TXN and payment details off so that notifications can be sent out.
+	 * if this request happens to be processing an IPN,
+	 * then we will also set the Payment Options Reg Step to completed,
+	 * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// is the Payment Options Reg Step completed ?
+		$payment_options_step_completed = $transaction->reg_step_completed('payment_options');
+		// if the Payment Options Reg Step is completed...
+		$revisit = $payment_options_step_completed === true;
+		// then this is kinda sorta a revisit with regards to payments at least
+		$transaction_processor->set_revisit($revisit);
+		// if this is an IPN, let's consider the Payment Options Reg Step completed if not already
+		if ($IPN
+			&& $payment_options_step_completed !== true
+			&& ($payment->is_approved() || $payment->is_pending())
+		) {
+			$payment_options_step_completed = $transaction->set_reg_step_completed(
+				'payment_options'
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid(false);
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		//  if this is an IPN and the final step has not been initiated
+		if ($IPN && $payment_options_step_completed && $finalized === false) {
+			// and if it hasn't already been set as being started...
+			$finalized = $transaction->set_reg_step_initiated('finalize_registration');
+		}
+		$transaction->save();
+		// because the above will return false if the final step was not fully completed, we need to check again...
+		if ($IPN && $finalized !== false) {
+			// and if we are all good to go, then send out notifications
+			add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			// ok, now process the transaction according to the payment
+			$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+				$transaction,
+				$payment
+			);
+		}
+		// DEBUG LOG
+		$payment_method = $payment->payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payment_method_type_obj = $payment_method->type_obj();
+			if ($payment_method_type_obj instanceof EE_PMT_Base) {
+				$gateway = $payment_method_type_obj->get_gateway();
+				if ($gateway instanceof EE_Gateway) {
+					$gateway->log(
+						array(
+							'message'               => (string) __('Post Payment Transaction Details', 'event_espresso'),
+							'transaction'           => $transaction->model_field_array(),
+							'finalized'             => $finalized,
+							'IPN'                   => $IPN,
+							'deliver_notifications' => has_filter(
+								'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+							),
+						),
+						$payment
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect PayPal standard, pro, express, and Payflow.
+	 *
+	 * @param $handle
+	 * @param $r
+	 * @param $url
+	 */
+	public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
+	{
+		if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
+			// Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			// instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 6);
+		}
+	}
 }

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +666 added lines, -666 removed lines

@@ -11,674 +11,674 @@
  */
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
 if (! function_exists('mb_strcut')) {
-    /**
-     * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
-     * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
-     * @param $string
-     * @param $start
-     * @param $length
-     * @return bool|string
-     */
-    function mb_strcut($string, $start, $length = null)
-    {
-        return mb_substr($string, $start, $length);
-    }
+	/**
+	 * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
+	 * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
+	 * @param $string
+	 * @param $start
+	 * @param $length
+	 * @return bool|string
+	 */
+	function mb_strcut($string, $start, $length = null)
+	{
+		return mb_substr($string, $start, $length);
+	}
 }
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
 
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url;
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-            'INR',
-        );
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $payment instanceof EEI_Payment) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error. No associated payment was found.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
-        $primary_registration = $transaction->primary_registration();
-        $primary_attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : false;
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_dtls = array(
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => $order_description,
-            'RETURNURL'                      => $return_url,
-            'CANCELURL'                      => $cancel_url,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            // Buyer does not need to create a PayPal account to check out.
-            // This is referred to as PayPal Account Optional.
-            'SOLUTIONTYPE'                   => 'Sole',
-            // Locale of the pages displayed by PayPal during Express Checkout.
-            'LOCALECODE'                     => $locale[1]
-        );
-        // Show itemized list.
-        $itemized_list = $this->itemize_list($payment, $transaction);
-        $token_request_dtls = array_merge($token_request_dtls, $itemized_list);
-        // Automatically filling out shipping and contact information.
-        if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
-            // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-            $token_request_dtls['NOSHIPPING'] = '2';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
-            $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_dtls['NOSHIPPING'] = '1';
-            $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
-            $token_request_dtls['LOGOIMG'] = $this->_image_url;
-        }
-        $token_request_dtls = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $token_request_dtls,
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
-        $token_rstatus = $this->_ppExpress_check_response($token_request_response);
-        $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
-            ? $token_rstatus['args']
-            : array();
-        if ($token_rstatus['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $payment->set_redirect_url(
-                $gateway_url
-                . '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
-                . $response_args['TOKEN']
-            );
-        } else {
-            if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
-            } else {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Error occurred while trying to setup the Express Checkout.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $payment->set_details($response_args);
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string status an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
-        if ($payment instanceof EEI_Payment) {
-            $this->log(array('Return from Authorization' => $update_info), $payment);
-            $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Could not process this payment because it has no associated transaction.',
-                        'event_espresso'
-                    )
-                );
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $cdetails_request_dtls = array(
-                'METHOD' => 'GetExpressCheckoutDetails',
-                'TOKEN'  => $payment_details['TOKEN'],
-            );
-            // Request Customer Details.
-            $cdetails_request_response = $this->_ppExpress_request(
-                $cdetails_request_dtls,
-                'Customer Details',
-                $payment
-            );
-            $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
-            $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
-                ? $cdetails_rstatus['args']
-                : array();
-            if ($cdetails_rstatus['status']) {
-                // We got the PayerID so now we can Complete the transaction.
-                $docheckout_request_dtls = array(
-                    'METHOD'                         => 'DoExpressCheckoutPayment',
-                    'PAYERID'                        => $cdata_response_args['PAYERID'],
-                    'TOKEN'                          => $payment_details['TOKEN'],
-                    'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-                    'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-                    'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-                );
-                 // Include itemized list.
-                $itemized_list = $this->itemize_list(
-                    $payment,
-                    $transaction,
-                    $cdata_response_args
-                );
-                $docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
-                // Payment Checkout/Capture.
-                $docheckout_request_response = $this->_ppExpress_request(
-                    $docheckout_request_dtls,
-                    'Do Payment',
-                    $payment
-                );
-                $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
-                $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
-                    ? $docheckout_rstatus['args']
-                    : array();
-                if ($docheckout_rstatus['status']) {
-                    // All is well, payment approved.
-                    $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-                        $primary_registrant->reg_code()
-                        : '';
-                    $payment->set_extra_accntng($primary_registration_code);
-                    $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
-                        : 0);
-                    $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
-                        : null);
-                    $payment->set_details($cdata_response_args);
-                    $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_ACK']
-                        : '');
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    if (isset($docheckout_response_args['L_ERRORCODE'])) {
-                        $payment->set_gateway_response(
-                            $docheckout_response_args['L_ERRORCODE']
-                            . '; '
-                            . $docheckout_response_args['L_SHORTMESSAGE']
-                        );
-                    } else {
-                        $payment->set_gateway_response(
-                            esc_html__(
-                                'Error occurred while trying to Capture the funds.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $payment->set_details($docheckout_response_args);
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-            } else {
-                if (isset($cdata_response_args['L_ERRORCODE'])) {
-                    $payment->set_gateway_response(
-                        $cdata_response_args['L_ERRORCODE']
-                        . '; '
-                        . $cdata_response_args['L_SHORTMESSAGE']
-                    );
-                } else {
-                    $payment->set_gateway_response(
-                        esc_html__(
-                            'Error occurred while trying to get payment Details from PayPal.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                $payment->set_details($cdata_response_args);
-                $payment->set_status($this->_pay_model->failed_status());
-            }
-        } else {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     *  Make a list of items that are in the giver transaction.
-     *
-     * @param EEI_Payment     $payment
-     * @param EEI_Transaction $transaction
-     * @param array           $request_response_args Data from a previous communication with PP.
-     * @return array
-     */
-    public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
-    {
-        $itemized_list = array();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        // If we have data from a previous communication with PP (on this transaction) we may use that for our list...
-        if (! empty($request_response_args)
-            && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
-            && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
-        ) {
-            foreach ($request_response_args as $arg_key => $arg_val) {
-                if (strpos($arg_key, 'PAYMENTREQUEST_') !== false
-                    && strpos($arg_key, 'NOTIFYURL') === false
-                ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
-                }
-            }
-            // If we got only a few Items then something is not right.
-            if (count($itemized_list) > 2) {
-                return $itemized_list;
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                // @codingStandardsIgnoreStart
-                                'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($itemized_list)
-                        )
-                    );
-                }
-                // Reset the list and log an error, maybe allow to try and generate a new list (below).
-                $itemized_list = array();
-                $this->log(
-                    array(
-                        (string) esc_html__(
-                            'Could not generate a proper item list with:',
-                            'event_espresso'
-                        ) => $request_response_args
-                    ),
-                    $payment
-                );
-            }
-        }
-        // ...otherwise we generate a new list for this transaction.
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 0;
-            $itemized_sum = 0;
-            $total_line_items = $transaction->total_line_item();
-            // Go through each item in the list.
-            foreach ($total_line_items->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // PayPal doesn't like line items with 0.00 amount, so we may skip those.
-                    if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
-                        continue;
-                    }
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                    // This is a discount.
-                    if ($line_item->is_percent()) {
-                        $unit_price = $line_item->total();
-                        $line_item_quantity = 1;
-                    }
-                    // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
-                    // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                    // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
-                    // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                    $itemized_sum += $line_item->total();
-                    ++$item_num;
-                }
-            }
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
-                2
-            );
-            // If we were not able to recognize some item like promotion, surcharge or cancellation,
-            // add the difference as an extra line item.
-            if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
-                // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                    esc_html__(
-                        'Other (promotion/surcharge/cancellation)',
-                        'event_espresso'
-                    ),
-                    0,
-                    127
-                );
-                // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
-                // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
-                // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                $item_num++;
-            }
-        } else {
-            // Just one Item.
-            // Item Name.
-            $itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                0,
-                127
-            );
-            // Item description.
-            $itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemDesc($payment),
-                0,
-                127
-            );
-            // Cost of individual item.
-            $itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount());
-            // Item Number.
-            $itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-            // Item quantity.
-            $itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
-            // Digital item is sold.
-            $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount());
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-        }
-        return $itemized_list;
-    }
-
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return mixed
-     */
-    public function _ppExpress_request($request_params, $request_text, $payment)
-    {
-        $request_dtls = array(
-            'VERSION' => '204.0',
-            'USER' => urlencode($this->_api_username),
-            'PWD' => urlencode($this->_api_password),
-            'SIGNATURE' => urlencode($this->_api_signature),
-            // EE will blow up if you change this
-            'BUTTONSOURCE' => 'EventEspresso_SP',
-        );
-        $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($dtls, '', '&'),
-            )
-        );
-        // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
-        return $request_response;
-    }
-
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response)
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if ((
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
-    }
-
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request($request, $payment, $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log(array($info => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors($data_array)
-    {
-        $errors = array();
-        $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
-                : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
-                : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
-                : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
-                : '';
-            if ($n === 0) {
-                $errors = array(
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                );
-            } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url;
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+			'INR',
+		);
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error. No associated payment was found.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
+		$primary_registration = $transaction->primary_registration();
+		$primary_attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: false;
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_dtls = array(
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => $order_description,
+			'RETURNURL'                      => $return_url,
+			'CANCELURL'                      => $cancel_url,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			// Buyer does not need to create a PayPal account to check out.
+			// This is referred to as PayPal Account Optional.
+			'SOLUTIONTYPE'                   => 'Sole',
+			// Locale of the pages displayed by PayPal during Express Checkout.
+			'LOCALECODE'                     => $locale[1]
+		);
+		// Show itemized list.
+		$itemized_list = $this->itemize_list($payment, $transaction);
+		$token_request_dtls = array_merge($token_request_dtls, $itemized_list);
+		// Automatically filling out shipping and contact information.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			// If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+			$token_request_dtls['NOSHIPPING'] = '2';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
+			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
+		} elseif (! $this->_request_shipping_addr) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_dtls['NOSHIPPING'] = '1';
+			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($this->_image_url)) {
+			$token_request_dtls['LOGOIMG'] = $this->_image_url;
+		}
+		$token_request_dtls = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$token_request_dtls,
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
+			? $token_rstatus['args']
+			: array();
+		if ($token_rstatus['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$payment->set_redirect_url(
+				$gateway_url
+				. '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
+				. $response_args['TOKEN']
+			);
+		} else {
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+			} else {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Error occurred while trying to setup the Express Checkout.',
+						'event_espresso'
+					)
+				);
+			}
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string status an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
+			$transaction = $payment->transaction();
+			if (! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Could not process this payment because it has no associated transaction.',
+						'event_espresso'
+					)
+				);
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$primary_registrant = $transaction->primary_registration();
+			$payment_details = $payment->details();
+			// Check if we still have the token.
+			if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$cdetails_request_dtls = array(
+				'METHOD' => 'GetExpressCheckoutDetails',
+				'TOKEN'  => $payment_details['TOKEN'],
+			);
+			// Request Customer Details.
+			$cdetails_request_response = $this->_ppExpress_request(
+				$cdetails_request_dtls,
+				'Customer Details',
+				$payment
+			);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
+				? $cdetails_rstatus['args']
+				: array();
+			if ($cdetails_rstatus['status']) {
+				// We got the PayerID so now we can Complete the transaction.
+				$docheckout_request_dtls = array(
+					'METHOD'                         => 'DoExpressCheckoutPayment',
+					'PAYERID'                        => $cdata_response_args['PAYERID'],
+					'TOKEN'                          => $payment_details['TOKEN'],
+					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+					'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+					'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+				);
+				 // Include itemized list.
+				$itemized_list = $this->itemize_list(
+					$payment,
+					$transaction,
+					$cdata_response_args
+				);
+				$docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
+				// Payment Checkout/Capture.
+				$docheckout_request_response = $this->_ppExpress_request(
+					$docheckout_request_dtls,
+					'Do Payment',
+					$payment
+				);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
+					? $docheckout_rstatus['args']
+					: array();
+				if ($docheckout_rstatus['status']) {
+					// All is well, payment approved.
+					$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+						$primary_registrant->reg_code()
+						: '';
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
+						? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
+						: 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
+						? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
+						: null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
+						? $docheckout_response_args['PAYMENTINFO_0_ACK']
+						: '');
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response(
+							$docheckout_response_args['L_ERRORCODE']
+							. '; '
+							. $docheckout_response_args['L_SHORTMESSAGE']
+						);
+					} else {
+						$payment->set_gateway_response(
+							esc_html__(
+								'Error occurred while trying to Capture the funds.',
+								'event_espresso'
+							)
+						);
+					}
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+			} else {
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response(
+						$cdata_response_args['L_ERRORCODE']
+						. '; '
+						. $cdata_response_args['L_SHORTMESSAGE']
+					);
+				} else {
+					$payment->set_gateway_response(
+						esc_html__(
+							'Error occurred while trying to get payment Details from PayPal.',
+							'event_espresso'
+						)
+					);
+				}
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
+			}
+		} else {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 *  Make a list of items that are in the giver transaction.
+	 *
+	 * @param EEI_Payment     $payment
+	 * @param EEI_Transaction $transaction
+	 * @param array           $request_response_args Data from a previous communication with PP.
+	 * @return array
+	 */
+	public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
+	{
+		$itemized_list = array();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		// If we have data from a previous communication with PP (on this transaction) we may use that for our list...
+		if (! empty($request_response_args)
+			&& array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
+			&& array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
+		) {
+			foreach ($request_response_args as $arg_key => $arg_val) {
+				if (strpos($arg_key, 'PAYMENTREQUEST_') !== false
+					&& strpos($arg_key, 'NOTIFYURL') === false
+				) {
+					$itemized_list[ $arg_key ] = $arg_val;
+				}
+			}
+			// If we got only a few Items then something is not right.
+			if (count($itemized_list) > 2) {
+				return $itemized_list;
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								// @codingStandardsIgnoreStart
+								'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($itemized_list)
+						)
+					);
+				}
+				// Reset the list and log an error, maybe allow to try and generate a new list (below).
+				$itemized_list = array();
+				$this->log(
+					array(
+						(string) esc_html__(
+							'Could not generate a proper item list with:',
+							'event_espresso'
+						) => $request_response_args
+					),
+					$payment
+				);
+			}
+		}
+		// ...otherwise we generate a new list for this transaction.
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 0;
+			$itemized_sum = 0;
+			$total_line_items = $transaction->total_line_item();
+			// Go through each item in the list.
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
+					if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
+						continue;
+					}
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+					// This is a discount.
+					if ($line_item->is_percent()) {
+						$unit_price = $line_item->total();
+						$line_item_quantity = 1;
+					}
+					// Item Name.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					);
+					// Item description.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemDesc($line_item, $payment),
+						0,
+						127
+					);
+					// Cost of individual item.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
+					// Item Number.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+					// Item quantity.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+					// Digital item is sold.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+					$itemized_sum += $line_item->total();
+					++$item_num;
+				}
+			}
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
+				2
+			);
+			// If we were not able to recognize some item like promotion, surcharge or cancellation,
+			// add the difference as an extra line item.
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
+				// Item Name.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+					esc_html__(
+						'Other (promotion/surcharge/cancellation)',
+						'event_espresso'
+					),
+					0,
+					127
+				);
+				// Item description.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+				// Cost of individual item.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+					$itemized_sum_diff_from_txn_total
+				);
+				// Item Number.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+				// Item quantity.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+				// Digital item is sold.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+				$item_num++;
+			}
+		} else {
+			// Just one Item.
+			// Item Name.
+			$itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemName($payment),
+				0,
+				127
+			);
+			// Item description.
+			$itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemDesc($payment),
+				0,
+				127
+			);
+			// Cost of individual item.
+			$itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount());
+			// Item Number.
+			$itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+			// Item quantity.
+			$itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
+			// Digital item is sold.
+			$itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount());
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+		}
+		return $itemized_list;
+	}
+
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return mixed
+	 */
+	public function _ppExpress_request($request_params, $request_text, $payment)
+	{
+		$request_dtls = array(
+			'VERSION' => '204.0',
+			'USER' => urlencode($this->_api_username),
+			'PWD' => urlencode($this->_api_password),
+			'SIGNATURE' => urlencode($this->_api_signature),
+			// EE will blow up if you change this
+			'BUTTONSOURCE' => 'EventEspresso_SP',
+		);
+		$dtls = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($dtls, '', '&'),
+			)
+		);
+		// Log the response.
+		$this->log(array($request_text . ' Response' => $request_response), $payment);
+		return $request_response;
+	}
+
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response)
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if ((
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
+	}
+
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment, $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log(array($info => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors($data_array)
+	{
+		$errors = array();
+		$n = 0;
+		while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
+			$l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
+				? $data_array[ "L_ERRORCODE{$n}" ]
+				: '';
+			$l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
+				? $data_array[ "L_SEVERITYCODE{$n}" ]
+				: '';
+			$l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
+				? $data_array[ "L_SHORTMESSAGE{$n}" ]
+				: '';
+			$l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
+				? $data_array[ "L_LONGMESSAGE{$n}" ]
+				: '';
+			if ($n === 0) {
+				$errors = array(
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				);
+			} else {
+				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
 }

core/CPTs/EE_CPT_Strategy.core.php

Indentation +443 added lines, -443 removed lines

@@ -16,447 +16,447 @@
 class EE_CPT_Strategy extends EE_Base
 {
 
-    /**
-     * @var EE_CPT_Strategy $_instance
-     */
-    private static $_instance;
-
-    /**
-     * the current page, if it utilizes CPTs
-     *
-     * @var array $CPT
-     */
-    protected $CPT;
-
-    /**
-     * return value from CustomPostTypeDefinitions::getDefinitions()
-     *
-     * @var array $_CPTs
-     */
-    protected $_CPTs = array();
-
-    /**
-     * @var array $_CPT_taxonomies
-     */
-    protected $_CPT_taxonomies = array();
-
-    /**
-     * @var array $_CPT_terms
-     */
-    protected $_CPT_terms = array();
-
-    /**
-     * @var array $_CPT_endpoints
-     */
-    protected $_CPT_endpoints = array();
-
-    /**
-     * @var EEM_Base $CPT_model
-     */
-    protected $CPT_model;
-
-    /**
-     * @var EventEspresso\Core\CPTs\CptQueryModifier $query_modifier
-     */
-    protected $query_modifier;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CustomPostTypeDefinitions|null $custom_post_types
-     * @param CustomTaxonomyDefinitions|null $taxonomies
-     * @return EE_CPT_Strategy
-     */
-    public static function instance(
-        CustomPostTypeDefinitions $custom_post_types = null,
-        CustomTaxonomyDefinitions $taxonomies = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_CPT_Strategy
-            && $custom_post_types instanceof CustomPostTypeDefinitions
-            && $taxonomies instanceof CustomTaxonomyDefinitions
-        ) {
-            self::$_instance = new self($custom_post_types, $taxonomies);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param CustomPostTypeDefinitions $custom_post_types
-     * @param CustomTaxonomyDefinitions $taxonomies
-     */
-    protected function __construct(
-        CustomPostTypeDefinitions $custom_post_types,
-        CustomTaxonomyDefinitions $taxonomies
-    ) {
-        // get CPT data
-        $this->_CPTs = $custom_post_types->getDefinitions();
-        $this->_CPT_endpoints = $this->_set_CPT_endpoints();
-        $this->_CPT_taxonomies = $taxonomies->getCustomTaxonomyDefinitions();
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 5);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_CPT_endpoints()
-    {
-        return $this->_CPT_endpoints;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_CPT_taxonomies()
-    {
-        return $this->_CPT_taxonomies;
-    }
-
-
-    /**
-     * add CPT "slugs" to array of default espresso "pages"
-     *
-     * @return array
-     */
-    private function _set_CPT_endpoints()
-    {
-        $_CPT_endpoints = array();
-        if (is_array($this->_CPTs)) {
-            foreach ($this->_CPTs as $CPT_type => $CPT) {
-                if (isset($CPT['plural_slug'])) {
-                    $_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
-                }
-            }
-        }
-        return $_CPT_endpoints;
-    }
-
-
-    /**
-     * If this query (not just "main" queries (ie, for WP's infamous "loop")) is for an EE CPT, then we want to
-     * supercharge the get_posts query to add our EE stuff (like joining to our tables, selecting extra columns, and
-     * adding EE objects to the post to facilitate further querying of related data etc)
-     *
-     * @param WP_Query $WP_Query
-     * @return void
-     * @throws \EE_Error
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // check that post-type is set
-        if (! $WP_Query instanceof WP_Query) {
-            return;
-        }
-        // add our conditionals
-        $this->_set_EE_tags_on_WP_Query($WP_Query);
-        // check for terms
-        $this->_set_post_type_for_terms($WP_Query);
-        // make sure paging is always set
-        $this->_set_paging($WP_Query);
-        // is a taxonomy set ?
-        $this->_set_CPT_taxonomies_on_WP_Query($WP_Query);
-        // loop thru post_types if set
-        $this->_process_WP_Query_post_types($WP_Query);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     */
-    private function _set_EE_tags_on_WP_Query(WP_Query $WP_Query)
-    {
-        $WP_Query->is_espresso_event_single = false;
-        $WP_Query->is_espresso_event_archive = false;
-        $WP_Query->is_espresso_event_taxonomy = false;
-        $WP_Query->is_espresso_venue_single = false;
-        $WP_Query->is_espresso_venue_archive = false;
-        $WP_Query->is_espresso_venue_taxonomy = false;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_CPT_terms()
-    {
-        if (empty($this->_CPT_terms)) {
-            $terms = EEM_Term::instance()->get_all_CPT_post_tags();
-            foreach ($terms as $term) {
-                if ($term instanceof EE_Term) {
-                    $this->_CPT_terms[ $term->slug() ] = $term;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_post_type_for_terms(WP_Query $WP_Query)
-    {
-        // is a tag set ?
-        if (isset($WP_Query->query['tag'])) {
-            // get term for tag
-            $term = EEM_Term::instance()->get_post_tag_for_event_or_venue($WP_Query->query['tag']);
-            // verify the term
-            if ($term instanceof EE_Term) {
-                $term->post_type = array_merge(array('post', 'page'), (array) $term->post_type);
-                $term->post_type = apply_filters(
-                    'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
-                    $term->post_type,
-                    $term
-                );
-                // if a post type is already set
-                if (isset($WP_Query->query_vars['post_type'])) {
-                    // add to existing array
-                    $term->post_type = array_merge((array) $WP_Query->query_vars['post_type'], $term->post_type);
-                }
-                // just set post_type to our CPT
-                $WP_Query->set('post_type', array_unique($term->post_type));
-            }
-        }
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     */
-    public function _set_paging($WP_Query)
-    {
-        if ($WP_Query->is_main_query() && apply_filters('FHEE__EE_CPT_Strategy___set_paging', true)) {
-            $page = get_query_var('page') ? get_query_var('page') : null;
-            $paged = get_query_var('paged') ? get_query_var('paged') : $page;
-            $WP_Query->set('paged', $paged);
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     */
-    protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $WP_Query)
-    {
-        // is a taxonomy set ?
-        if ($WP_Query->is_tax) {
-            // loop thru our taxonomies
-            foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
-                // check if one of our taxonomies is set as a query var
-                if (isset($WP_Query->query[ $CPT_taxonomy ])) {
-                    // but which CPT does that correspond to??? hmmm... guess we gotta go looping
-                    foreach ($this->_CPTs as $post_type => $CPT) {
-                        // verify our CPT has args, is public and has taxonomies set
-                        if (isset($CPT['args']['public'])
-                            && $CPT['args']['public']
-                            && ! empty($CPT['args']['taxonomies'])
-                            && in_array($CPT_taxonomy, $CPT['args']['taxonomies'], true)
-                        ) {
-                            // if so, then add this CPT post_type to the current query's array of post_types'
-                            $WP_Query->query_vars['post_type'] = isset($WP_Query->query_vars['post_type'])
-                                ? (array) $WP_Query->query_vars['post_type']
-                                : array();
-                            $WP_Query->query_vars['post_type'][] = $post_type;
-                            switch ($post_type) {
-                                case 'espresso_events':
-                                    $WP_Query->is_espresso_event_taxonomy = true;
-                                    break;
-                                case 'espresso_venues':
-                                    $WP_Query->is_espresso_venue_taxonomy = true;
-                                    break;
-                                default:
-                                    do_action(
-                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
-                                        $WP_Query,
-                                        $this
-                                    );
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_WP_Query_post_types(WP_Query $WP_Query)
-    {
-        if (isset($WP_Query->query_vars['post_type'])) {
-            // loop thru post_types as array
-            foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
-                // is current query for an EE CPT ?
-                if (isset($this->_CPTs[ $post_type ])) {
-                    // is EE on or off ?
-                    if (EE_Maintenance_Mode::instance()->level()) {
-                        // reroute CPT template view to maintenance_mode.template.php
-                        if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
-                            add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
-                        }
-                        if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
-                            add_filter('the_content', array($this, 'inject_EE_shortcode_placeholder'), 1);
-                        }
-                        return;
-                    }
-                    $this->_generate_CptQueryModifier($WP_Query, $post_type);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     * @param string    $post_type
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _generate_CptQueryModifier(WP_Query $WP_Query, $post_type)
-    {
-        $this->query_modifier = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\CPTs\CptQueryModifier',
-            array(
-                $post_type,
-                $this->_CPTs[ $post_type ],
-                $WP_Query,
-            )
-        );
-        $this->_CPT_taxonomies = $this->query_modifier->taxonomies();
-    }
-
-
-    /**
-     * inject_EE_shortcode_placeholder
-     * in order to display the M-Mode notice on our CPT routes,
-     * we need to first inject what looks like one of our shortcodes,
-     * so that it can be replaced with the actual M-Mode notice
-     *
-     * @return string
-     */
-    public function inject_EE_shortcode_placeholder()
-    {
-        return '[ESPRESSO_';
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @return void
-     */
-    public function _possibly_set_ee_request_var()
-    {
-        $this->query_modifier->setRequestVarsIfCpt();
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  $SQL
-     * @return string
-     */
-    public function posts_fields($SQL)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->postsFields($SQL);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  $SQL
-     * @return string
-     */
-    public function posts_join($SQL)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->postsJoin($SQL);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  \WP_Post[] $posts
-     * @return \WP_Post[]
-     */
-    public function the_posts($posts)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            $this->query_modifier->thePosts($posts);
-        }
-        return $posts;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param $url
-     * @param $ID
-     * @return string
-     */
-    public function get_edit_post_link($url, $ID)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->getEditPostLink($url, $ID);
-        }
-        return '';
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param null $WP_Query
-     */
-    protected function _do_template_filters($WP_Query = null)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            $this->query_modifier->addTemplateFilters();
-        }
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param string $current_template Existing default template path derived for this page call.
-     * @return string the path to the full template file.
-     */
-    public function single_cpt_template($current_template)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->singleCptTemplate($current_template);
-        }
-        return $current_template;
-    }
+	/**
+	 * @var EE_CPT_Strategy $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * the current page, if it utilizes CPTs
+	 *
+	 * @var array $CPT
+	 */
+	protected $CPT;
+
+	/**
+	 * return value from CustomPostTypeDefinitions::getDefinitions()
+	 *
+	 * @var array $_CPTs
+	 */
+	protected $_CPTs = array();
+
+	/**
+	 * @var array $_CPT_taxonomies
+	 */
+	protected $_CPT_taxonomies = array();
+
+	/**
+	 * @var array $_CPT_terms
+	 */
+	protected $_CPT_terms = array();
+
+	/**
+	 * @var array $_CPT_endpoints
+	 */
+	protected $_CPT_endpoints = array();
+
+	/**
+	 * @var EEM_Base $CPT_model
+	 */
+	protected $CPT_model;
+
+	/**
+	 * @var EventEspresso\Core\CPTs\CptQueryModifier $query_modifier
+	 */
+	protected $query_modifier;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CustomPostTypeDefinitions|null $custom_post_types
+	 * @param CustomTaxonomyDefinitions|null $taxonomies
+	 * @return EE_CPT_Strategy
+	 */
+	public static function instance(
+		CustomPostTypeDefinitions $custom_post_types = null,
+		CustomTaxonomyDefinitions $taxonomies = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_CPT_Strategy
+			&& $custom_post_types instanceof CustomPostTypeDefinitions
+			&& $taxonomies instanceof CustomTaxonomyDefinitions
+		) {
+			self::$_instance = new self($custom_post_types, $taxonomies);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param CustomPostTypeDefinitions $custom_post_types
+	 * @param CustomTaxonomyDefinitions $taxonomies
+	 */
+	protected function __construct(
+		CustomPostTypeDefinitions $custom_post_types,
+		CustomTaxonomyDefinitions $taxonomies
+	) {
+		// get CPT data
+		$this->_CPTs = $custom_post_types->getDefinitions();
+		$this->_CPT_endpoints = $this->_set_CPT_endpoints();
+		$this->_CPT_taxonomies = $taxonomies->getCustomTaxonomyDefinitions();
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 5);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_CPT_endpoints()
+	{
+		return $this->_CPT_endpoints;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_CPT_taxonomies()
+	{
+		return $this->_CPT_taxonomies;
+	}
+
+
+	/**
+	 * add CPT "slugs" to array of default espresso "pages"
+	 *
+	 * @return array
+	 */
+	private function _set_CPT_endpoints()
+	{
+		$_CPT_endpoints = array();
+		if (is_array($this->_CPTs)) {
+			foreach ($this->_CPTs as $CPT_type => $CPT) {
+				if (isset($CPT['plural_slug'])) {
+					$_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
+				}
+			}
+		}
+		return $_CPT_endpoints;
+	}
+
+
+	/**
+	 * If this query (not just "main" queries (ie, for WP's infamous "loop")) is for an EE CPT, then we want to
+	 * supercharge the get_posts query to add our EE stuff (like joining to our tables, selecting extra columns, and
+	 * adding EE objects to the post to facilitate further querying of related data etc)
+	 *
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 * @throws \EE_Error
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// check that post-type is set
+		if (! $WP_Query instanceof WP_Query) {
+			return;
+		}
+		// add our conditionals
+		$this->_set_EE_tags_on_WP_Query($WP_Query);
+		// check for terms
+		$this->_set_post_type_for_terms($WP_Query);
+		// make sure paging is always set
+		$this->_set_paging($WP_Query);
+		// is a taxonomy set ?
+		$this->_set_CPT_taxonomies_on_WP_Query($WP_Query);
+		// loop thru post_types if set
+		$this->_process_WP_Query_post_types($WP_Query);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 */
+	private function _set_EE_tags_on_WP_Query(WP_Query $WP_Query)
+	{
+		$WP_Query->is_espresso_event_single = false;
+		$WP_Query->is_espresso_event_archive = false;
+		$WP_Query->is_espresso_event_taxonomy = false;
+		$WP_Query->is_espresso_venue_single = false;
+		$WP_Query->is_espresso_venue_archive = false;
+		$WP_Query->is_espresso_venue_taxonomy = false;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_CPT_terms()
+	{
+		if (empty($this->_CPT_terms)) {
+			$terms = EEM_Term::instance()->get_all_CPT_post_tags();
+			foreach ($terms as $term) {
+				if ($term instanceof EE_Term) {
+					$this->_CPT_terms[ $term->slug() ] = $term;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_post_type_for_terms(WP_Query $WP_Query)
+	{
+		// is a tag set ?
+		if (isset($WP_Query->query['tag'])) {
+			// get term for tag
+			$term = EEM_Term::instance()->get_post_tag_for_event_or_venue($WP_Query->query['tag']);
+			// verify the term
+			if ($term instanceof EE_Term) {
+				$term->post_type = array_merge(array('post', 'page'), (array) $term->post_type);
+				$term->post_type = apply_filters(
+					'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
+					$term->post_type,
+					$term
+				);
+				// if a post type is already set
+				if (isset($WP_Query->query_vars['post_type'])) {
+					// add to existing array
+					$term->post_type = array_merge((array) $WP_Query->query_vars['post_type'], $term->post_type);
+				}
+				// just set post_type to our CPT
+				$WP_Query->set('post_type', array_unique($term->post_type));
+			}
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 */
+	public function _set_paging($WP_Query)
+	{
+		if ($WP_Query->is_main_query() && apply_filters('FHEE__EE_CPT_Strategy___set_paging', true)) {
+			$page = get_query_var('page') ? get_query_var('page') : null;
+			$paged = get_query_var('paged') ? get_query_var('paged') : $page;
+			$WP_Query->set('paged', $paged);
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 */
+	protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $WP_Query)
+	{
+		// is a taxonomy set ?
+		if ($WP_Query->is_tax) {
+			// loop thru our taxonomies
+			foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
+				// check if one of our taxonomies is set as a query var
+				if (isset($WP_Query->query[ $CPT_taxonomy ])) {
+					// but which CPT does that correspond to??? hmmm... guess we gotta go looping
+					foreach ($this->_CPTs as $post_type => $CPT) {
+						// verify our CPT has args, is public and has taxonomies set
+						if (isset($CPT['args']['public'])
+							&& $CPT['args']['public']
+							&& ! empty($CPT['args']['taxonomies'])
+							&& in_array($CPT_taxonomy, $CPT['args']['taxonomies'], true)
+						) {
+							// if so, then add this CPT post_type to the current query's array of post_types'
+							$WP_Query->query_vars['post_type'] = isset($WP_Query->query_vars['post_type'])
+								? (array) $WP_Query->query_vars['post_type']
+								: array();
+							$WP_Query->query_vars['post_type'][] = $post_type;
+							switch ($post_type) {
+								case 'espresso_events':
+									$WP_Query->is_espresso_event_taxonomy = true;
+									break;
+								case 'espresso_venues':
+									$WP_Query->is_espresso_venue_taxonomy = true;
+									break;
+								default:
+									do_action(
+										'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
+										$WP_Query,
+										$this
+									);
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_WP_Query_post_types(WP_Query $WP_Query)
+	{
+		if (isset($WP_Query->query_vars['post_type'])) {
+			// loop thru post_types as array
+			foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
+				// is current query for an EE CPT ?
+				if (isset($this->_CPTs[ $post_type ])) {
+					// is EE on or off ?
+					if (EE_Maintenance_Mode::instance()->level()) {
+						// reroute CPT template view to maintenance_mode.template.php
+						if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
+							add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
+						}
+						if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
+							add_filter('the_content', array($this, 'inject_EE_shortcode_placeholder'), 1);
+						}
+						return;
+					}
+					$this->_generate_CptQueryModifier($WP_Query, $post_type);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 * @param string    $post_type
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _generate_CptQueryModifier(WP_Query $WP_Query, $post_type)
+	{
+		$this->query_modifier = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\CPTs\CptQueryModifier',
+			array(
+				$post_type,
+				$this->_CPTs[ $post_type ],
+				$WP_Query,
+			)
+		);
+		$this->_CPT_taxonomies = $this->query_modifier->taxonomies();
+	}
+
+
+	/**
+	 * inject_EE_shortcode_placeholder
+	 * in order to display the M-Mode notice on our CPT routes,
+	 * we need to first inject what looks like one of our shortcodes,
+	 * so that it can be replaced with the actual M-Mode notice
+	 *
+	 * @return string
+	 */
+	public function inject_EE_shortcode_placeholder()
+	{
+		return '[ESPRESSO_';
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @return void
+	 */
+	public function _possibly_set_ee_request_var()
+	{
+		$this->query_modifier->setRequestVarsIfCpt();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function posts_fields($SQL)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->postsFields($SQL);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function posts_join($SQL)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->postsJoin($SQL);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  \WP_Post[] $posts
+	 * @return \WP_Post[]
+	 */
+	public function the_posts($posts)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			$this->query_modifier->thePosts($posts);
+		}
+		return $posts;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param $url
+	 * @param $ID
+	 * @return string
+	 */
+	public function get_edit_post_link($url, $ID)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->getEditPostLink($url, $ID);
+		}
+		return '';
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param null $WP_Query
+	 */
+	protected function _do_template_filters($WP_Query = null)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			$this->query_modifier->addTemplateFilters();
+		}
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param string $current_template Existing default template path derived for this page call.
+	 * @return string the path to the full template file.
+	 */
+	public function single_cpt_template($current_template)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->singleCptTemplate($current_template);
+		}
+		return $current_template;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -72,7 +72,7 @@ 
         CustomTaxonomyDefinitions $taxonomies = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_CPT_Strategy
+        if ( ! self::$_instance instanceof EE_CPT_Strategy
             && $custom_post_types instanceof CustomPostTypeDefinitions
             && $taxonomies instanceof CustomTaxonomyDefinitions
         ) {
@@ -127,7 +127,7 @@ 
         if (is_array($this->_CPTs)) {
             foreach ($this->_CPTs as $CPT_type => $CPT) {
                 if (isset($CPT['plural_slug'])) {
-                    $_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
+                    $_CPT_endpoints [(string) $CPT['plural_slug']] = $CPT_type;
                 }
             }
         }
@@ -150,7 +150,7 @@ 
     public function pre_get_posts($WP_Query)
     {
         // check that post-type is set
-        if (! $WP_Query instanceof WP_Query) {
+        if ( ! $WP_Query instanceof WP_Query) {
             return;
         }
         // add our conditionals
@@ -194,7 +194,7 @@ 
             $terms = EEM_Term::instance()->get_all_CPT_post_tags();
             foreach ($terms as $term) {
                 if ($term instanceof EE_Term) {
-                    $this->_CPT_terms[ $term->slug() ] = $term;
+                    $this->_CPT_terms[$term->slug()] = $term;
                 }
             }
         }
@@ -259,7 +259,7 @@ 
             // loop thru our taxonomies
             foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
                 // check if one of our taxonomies is set as a query var
-                if (isset($WP_Query->query[ $CPT_taxonomy ])) {
+                if (isset($WP_Query->query[$CPT_taxonomy])) {
                     // but which CPT does that correspond to??? hmmm... guess we gotta go looping
                     foreach ($this->_CPTs as $post_type => $CPT) {
                         // verify our CPT has args, is public and has taxonomies set
@@ -282,7 +282,7 @@ 
                                     break;
                                 default:
                                     do_action(
-                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
+                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_'.$post_type.'_post_type',
                                         $WP_Query,
                                         $this
                                     );
@@ -307,11 +307,11 @@ 
             // loop thru post_types as array
             foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
                 // is current query for an EE CPT ?
-                if (isset($this->_CPTs[ $post_type ])) {
+                if (isset($this->_CPTs[$post_type])) {
                     // is EE on or off ?
                     if (EE_Maintenance_Mode::instance()->level()) {
                         // reroute CPT template view to maintenance_mode.template.php
-                        if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
+                        if ( ! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
                             add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
                         }
                         if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
@@ -339,7 +339,7 @@ 
             'EventEspresso\core\CPTs\CptQueryModifier',
             array(
                 $post_type,
-                $this->_CPTs[ $post_type ],
+                $this->_CPTs[$post_type],
                 $WP_Query,
             )
         );

core/data_migration_scripts/EE_DMS_Core_4_6_0.dms.php

Indentation +259 added lines, -259 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);
-    }
+	/**
+	 * 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', '>=')) {
+	/**
+	 * @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(191))";
-        $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,124 +496,124 @@ 
 					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;
-    }
+		$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;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	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(
-                    (string) __("Bank", 'event_espresso')        => __("Bank Draft", 'event_espresso'),
-                    (string) __("Cash", 'event_espresso')        => __("Cash Delivered Physically", 'event_espresso'),
-                    (string) __("Check", 'event_espresso')       => __("Paper Check", 'event_espresso'),
-                    (string) __("Credit Card", 'event_espresso') => __("Offline Credit Card Payment", 'event_espresso'),
-                    (string) __("Debit Card", 'event_espresso')  => __("Offline Debit Payment", 'event_espresso'),
-                    (string) __("Invoice", 'event_espresso')     => __(
-                        "Invoice received with monies included",
-                        'event_espresso'
-                    ),
-                    (string) __("Money Order", 'event_espresso') => '',
-                    (string) __("Paypal", 'event_espresso')      => __("Paypal eCheck, Invoice, etc", 'event_espresso'),
-                    (string) __('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)));
-                    }
-                }
-            }
-        }
-    }
+	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(
+					(string) __("Bank", 'event_espresso')        => __("Bank Draft", 'event_espresso'),
+					(string) __("Cash", 'event_espresso')        => __("Cash Delivered Physically", 'event_espresso'),
+					(string) __("Check", 'event_espresso')       => __("Paper Check", 'event_espresso'),
+					(string) __("Credit Card", 'event_espresso') => __("Offline Credit Card Payment", 'event_espresso'),
+					(string) __("Debit Card", 'event_espresso')  => __("Offline Debit Payment", 'event_espresso'),
+					(string) __("Invoice", 'event_espresso')     => __(
+						"Invoice received with monies included",
+						'event_espresso'
+					),
+					(string) __("Money Order", 'event_espresso') => '',
+					(string) __("Paypal", 'event_espresso')      => __("Paypal eCheck, Invoice, etc", 'event_espresso'),
+					(string) __('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
+	/**
+	 * 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),
@@ -767,8 +767,8 @@ 
 				( 'ZAR',  'Rand',  'Rands',  'R',  2,1),
 				( 'ZMK',  'Kwacha',  'Kwachas',  '',  2,1),
 				( 'ZWD', 'Dollar', 'Dollars', 'Z$', 2,1);";
-                $wpdb->query($SQL);
-            }
-        }
-    }
+				$wpdb->query($SQL);
+			}
+		}
+	}
 }

core/libraries/batch/JobHandlers/RegistrationsReport.php

Indentation +504 added lines, -504 removed lines

@@ -31,524 +31,524 @@
  */
 class RegistrationsReport extends JobHandlerFile
 {
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @throws BatchRequestException
-     * @return JobStepResponse
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
-            throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            $this->get_filename($event_id)
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-        if ($job_parameters->request_datum('use_filters', false)) {
-            $query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array())));
-        } else {
-            $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
-                array(
-                    'OR'                 => array(
-                        // don't include registrations from failed or abandoned transactions...
-                        'Transaction.STS_ID' => array(
-                            'NOT IN',
-                            array(
-                                EEM_Transaction::failed_status_code,
-                                EEM_Transaction::abandoned_status_code,
-                            ),
-                        ),
-                        // unless the registration is approved, in which case include it regardless of transaction status
-                        'STS_ID'             => \EEM_Registration::status_id_approved,
-                    ),
-                    'Ticket.TKT_deleted' => array('IN', array(true, false)),
-                ),
-                'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
-                'force_join' => array('Transaction', 'Ticket', 'Attendee'),
-                'caps'       => \EEM_Base::caps_read_admin,
-            ), $event_id);
-            if ($event_id) {
-                $query_params[0]['EVT_ID'] = $event_id;
-            } else {
-                $query_params['force_join'][] = 'Event';
-            }
-        }
-        if (! isset($query_params['force_join'])) {
-            $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
-        }
-        $job_parameters->add_extra_data('query_params', $query_params);
-        $question_labels = $this->_get_question_labels($query_params);
-        $job_parameters->add_extra_data('question_labels', $question_labels);
-        $job_parameters->set_job_size(
-            \EEM_Registration::instance()->count(
-                array_diff_key(
-                    $query_params,
-                    array_flip(
-                        array('limit')
-                    )
-                )
-            )
-        );
-        // we should also set the header columns
-        $csv_data_for_row = $this->get_csv_data_for(
-            $event_id,
-            0,
-            1,
-            $job_parameters->extra_datum('question_labels'),
-            $job_parameters->extra_datum('query_params')
-        );
-        EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
-        // if we actually processed a row there, record it
-        if ($job_parameters->job_size()) {
-            $job_parameters->mark_processed(1);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            __('Registrations report started successfully...', 'event_espresso')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @throws BatchRequestException
+	 * @return JobStepResponse
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
+		if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+			throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			$this->get_filename($event_id)
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+		if ($job_parameters->request_datum('use_filters', false)) {
+			$query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array())));
+		} else {
+			$query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
+				array(
+					'OR'                 => array(
+						// don't include registrations from failed or abandoned transactions...
+						'Transaction.STS_ID' => array(
+							'NOT IN',
+							array(
+								EEM_Transaction::failed_status_code,
+								EEM_Transaction::abandoned_status_code,
+							),
+						),
+						// unless the registration is approved, in which case include it regardless of transaction status
+						'STS_ID'             => \EEM_Registration::status_id_approved,
+					),
+					'Ticket.TKT_deleted' => array('IN', array(true, false)),
+				),
+				'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
+				'caps'       => \EEM_Base::caps_read_admin,
+			), $event_id);
+			if ($event_id) {
+				$query_params[0]['EVT_ID'] = $event_id;
+			} else {
+				$query_params['force_join'][] = 'Event';
+			}
+		}
+		if (! isset($query_params['force_join'])) {
+			$query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
+		}
+		$job_parameters->add_extra_data('query_params', $query_params);
+		$question_labels = $this->_get_question_labels($query_params);
+		$job_parameters->add_extra_data('question_labels', $question_labels);
+		$job_parameters->set_job_size(
+			\EEM_Registration::instance()->count(
+				array_diff_key(
+					$query_params,
+					array_flip(
+						array('limit')
+					)
+				)
+			)
+		);
+		// we should also set the header columns
+		$csv_data_for_row = $this->get_csv_data_for(
+			$event_id,
+			0,
+			1,
+			$job_parameters->extra_datum('question_labels'),
+			$job_parameters->extra_datum('query_params')
+		);
+		EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
+		// if we actually processed a row there, record it
+		if ($job_parameters->job_size()) {
+			$job_parameters->mark_processed(1);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			__('Registrations report started successfully...', 'event_espresso')
+		);
+	}
 
 
-    /**
-     * Gets the filename
-     *
-     * @return string
-     */
-    protected function get_filename()
-    {
-        return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql')));
-    }
+	/**
+	 * Gets the filename
+	 *
+	 * @return string
+	 */
+	protected function get_filename()
+	{
+		return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql')));
+	}
 
 
-    /**
-     * Gets the questions which are to be used for this report, so they
-     * can be remembered for later
-     *
-     * @param array $registration_query_params
-     * @return array question admin labels to be used for this report
-     */
-    protected function _get_question_labels($registration_query_params)
-    {
-        $where = isset($registration_query_params[0]) ? $registration_query_params[0] : null;
-        $question_query_params = array();
-        if ($where !== null) {
-            $question_query_params = array(
-                $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
-            );
-        }
-        $question_query_params[0]['QST_system'] = array(
-            'NOT_IN',
-            array_keys(EEM_Attendee::instance()->system_question_to_attendee_field_mapping()),
-        );
-        if (apply_filters(
-            'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
-            false,
-            $registration_query_params
-        )) {
-            $question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL');
-        }
-        $question_query_params['group_by'] = array('QST_ID');
-        return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
-    }
+	/**
+	 * Gets the questions which are to be used for this report, so they
+	 * can be remembered for later
+	 *
+	 * @param array $registration_query_params
+	 * @return array question admin labels to be used for this report
+	 */
+	protected function _get_question_labels($registration_query_params)
+	{
+		$where = isset($registration_query_params[0]) ? $registration_query_params[0] : null;
+		$question_query_params = array();
+		if ($where !== null) {
+			$question_query_params = array(
+				$this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
+			);
+		}
+		$question_query_params[0]['QST_system'] = array(
+			'NOT_IN',
+			array_keys(EEM_Attendee::instance()->system_question_to_attendee_field_mapping()),
+		);
+		if (apply_filters(
+			'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
+			false,
+			$registration_query_params
+		)) {
+			$question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL');
+		}
+		$question_query_params['group_by'] = array('QST_ID');
+		return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
+	}
 
 
-    /**
-     * Takes where params meant for registrations and changes them to work for questions
-     *
-     * @param array $reg_where_params
-     * @return array
-     */
-    protected function _change_registration_where_params_to_question_where_params($reg_where_params)
-    {
-        $question_where_params = array();
-        foreach ($reg_where_params as $key => $val) {
-            if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val);
-            } else {
-                // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
-            }
-        }
-        return $question_where_params;
-    }
+	/**
+	 * Takes where params meant for registrations and changes them to work for questions
+	 *
+	 * @param array $reg_where_params
+	 * @return array
+	 */
+	protected function _change_registration_where_params_to_question_where_params($reg_where_params)
+	{
+		$question_where_params = array();
+		foreach ($reg_where_params as $key => $val) {
+			if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
+				$question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val);
+			} else {
+				// it's a normal where condition
+				$question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+			}
+		}
+		return $question_where_params;
+	}
 
 
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws \EE_Error
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        if ($job_parameters->units_processed() < $job_parameters->job_size()) {
-            $csv_data = $this->get_csv_data_for(
-                $job_parameters->request_datum('EVT_ID', '0'),
-                $job_parameters->units_processed(),
-                $batch_size,
-                $job_parameters->extra_datum('question_labels'),
-                $job_parameters->extra_datum('query_params')
-            );
-            EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
-            $units_processed = count($csv_data);
-        } else {
-            $csv_data = array();
-            $units_processed = 0;
-        }
-        $job_parameters->mark_processed($units_processed);
-        $extra_response_data = array(
-            'file_url' => '',
-        );
-        if ($units_processed < $batch_size) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
-        }
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws \EE_Error
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		if ($job_parameters->units_processed() < $job_parameters->job_size()) {
+			$csv_data = $this->get_csv_data_for(
+				$job_parameters->request_datum('EVT_ID', '0'),
+				$job_parameters->units_processed(),
+				$batch_size,
+				$job_parameters->extra_datum('question_labels'),
+				$job_parameters->extra_datum('query_params')
+			);
+			EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
+			$units_processed = count($csv_data);
+		} else {
+			$csv_data = array();
+			$units_processed = 0;
+		}
+		$job_parameters->mark_processed($units_processed);
+		$extra_response_data = array(
+			'file_url' => '',
+		);
+		if ($units_processed < $batch_size) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
+		}
 
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)),
-            $extra_response_data
-        );
-    }
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)),
+			$extra_response_data
+		);
+	}
 
 
-    /**
-     * Gets the csv data for a batch of registrations
-     *
-     * @param int|null $event_id
-     * @param int $offset
-     * @param int $limit
-     * @param array $question_labels the IDs for all the questions which were answered by someone in this selection
-     * @param array $query_params for using where querying the model
-     * @return array top-level keys are numeric, next-level keys are column headers
-     * @throws \EE_Error
-     */
-    public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params)
-    {
-        $reg_fields_to_include = array(
-            'TXN_ID',
-            'ATT_ID',
-            'REG_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-        );
-        $att_fields_to_include = array(
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        );
-        $registrations_csv_ready_array = array();
-        $reg_model = EE_Registry::instance()->load_model('Registration');
-        $query_params['limit'] = array($offset, $limit);
-        $registration_rows = $reg_model->get_all_wpdb_results($query_params);
-        $registration_ids = array();
-        foreach ($registration_rows as $reg_row) {
-            $registration_ids[] = intval($reg_row['Registration.REG_ID']);
-        }
-        foreach ($registration_rows as $reg_row) {
-            if (is_array($reg_row)) {
-                $reg_csv_array = array();
-                if (! $event_id) {
-                    // get the event's name and Id
-                    $reg_csv_array[ (string) __('Event', 'event_espresso') ] = sprintf(
-                        /* translators: 1: event name, 2: event ID */
-                        __('%1$s (%2$s)', 'event_espresso'),
-                        EEH_Export::prepare_value_from_db_for_display(
-                            EEM_Event::instance(),
-                            'EVT_name',
-                            $reg_row['Event_CPT.post_title']
-                        ),
-                        $reg_row['Event_CPT.ID']
-                    );
-                }
-                $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
-                /*@var $reg_row EE_Registration */
-                foreach ($reg_fields_to_include as $field_name) {
-                    $field = $reg_model->field_settings_for($field_name);
-                    if ($field_name == 'REG_final_price') {
-                        $value = EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_final_price'],
-                            'localized_float'
-                        );
-                    } elseif ($field_name == 'REG_count') {
-                        $value = sprintf(
-                            /* translators: 1: number of registration in group (REG_count), 2: registration group size (REG_group_size) */
-                            __('%1$s of %2$s', 'event_espresso'),
-                            EEH_Export::prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_count',
-                                $reg_row['Registration.REG_count']
-                            ),
-                            EEH_Export::prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_group_size',
-                                $reg_row['Registration.REG_group_size']
-                            )
-                        );
-                    } elseif ($field_name == 'REG_date') {
-                        $value = EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_date'],
-                            'no_html'
-                        );
-                    } else {
-                        $value = EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row[ $field->get_qualified_column() ]
-                        );
-                    }
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value;
-                    if ($field_name == 'REG_final_price') {
-                        // add a column named Currency after the final price
-                        $reg_csv_array[ (string) __("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code;
-                    }
-                }
-                // get pretty status
-                $stati = EEM_Status::instance()->localized_status(
-                    array(
-                        $reg_row['Registration.STS_ID']     => __('unknown', 'event_espresso'),
-                        $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'),
-                    ),
-                    false,
-                    'sentence'
-                );
-                $reg_csv_array[ (string) __("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ];
-                // get pretty transaction status
-                $reg_csv_array[ (string) __("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-                $reg_csv_array[ (string) __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
-                    ? EEH_Export::prepare_value_from_db_for_display(
-                        EEM_Transaction::instance(),
-                        'TXN_total',
-                        $reg_row['TransactionTable.TXN_total'],
-                        'localized_float'
-                    ) : '0.00';
-                $reg_csv_array[ (string) __('Amount Paid', 'event_espresso') ] = $is_primary_reg
-                    ? EEH_Export::prepare_value_from_db_for_display(
-                        EEM_Transaction::instance(),
-                        'TXN_paid',
-                        $reg_row['TransactionTable.TXN_paid'],
-                        'localized_float'
-                    ) : '0.00';
-                $payment_methods = array();
-                $gateway_txn_ids_etc = array();
-                $payment_times = array();
-                if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                    $payments_info = EEM_Payment::instance()->get_all_wpdb_results(
-                        array(
-                            array(
-                                'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                                'STS_ID' => EEM_Payment::status_id_approved,
-                            ),
-                            'force_join' => array('Payment_Method'),
-                        ),
-                        ARRAY_A,
-                        'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
-                    );
-                    foreach ($payments_info as $payment_method_and_gateway_txn_id) {
-                        $payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
-                            ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
-                        $gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id'])
-                            ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
-                        $payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time'])
-                            ? $payment_method_and_gateway_txn_id['payment_time'] : '';
-                    }
-                }
-                $reg_csv_array[ (string) __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-                $reg_csv_array[ (string) __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-                $reg_csv_array[ (string) __('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
-                    ',',
-                    $gateway_txn_ids_etc
-                );
-                // get whether or not the user has checked in
-                $reg_csv_array[ (string) __("Check-Ins", "event_espresso") ] = $reg_model->count_related(
-                    $reg_row['Registration.REG_ID'],
-                    'Checkin'
-                );
-                // get ticket of registration and its price
-                $ticket_model = EE_Registry::instance()->load_model('Ticket');
-                if ($reg_row['Ticket.TKT_ID']) {
-                    $ticket_name = EEH_Export::prepare_value_from_db_for_display(
-                        $ticket_model,
-                        'TKT_name',
-                        $reg_row['Ticket.TKT_name']
-                    );
-                    $datetimes_strings = array();
-                    foreach (EEM_Datetime::instance()->get_all_wpdb_results(
-                        array(
-                            array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
-                            'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                            'default_where_conditions' => 'none',
-                        )
-                    ) as $datetime) {
-                        $datetimes_strings[] = EEH_Export::prepare_value_from_db_for_display(
-                            EEM_Datetime::instance(),
-                            'DTT_EVT_start',
-                            $datetime['Datetime.DTT_EVT_start']
-                        );
-                    }
-                } else {
-                    $ticket_name = __('Unknown', 'event_espresso');
-                    $datetimes_strings = array(__('Unknown', 'event_espresso'));
-                }
-                $reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-                $reg_csv_array[ (string) __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
-                // get datetime(s) of registration
-                // add attendee columns
-                foreach ($att_fields_to_include as $att_field_name) {
-                    $field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
-                    if ($reg_row['Attendee_CPT.ID']) {
-                        if ($att_field_name == 'STA_ID') {
-                            $value = EEM_State::instance()->get_var(
-                                array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
-                                'STA_name'
-                            );
-                        } elseif ($att_field_name == 'CNT_ISO') {
-                            $value = EEM_Country::instance()->get_var(
-                                array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
-                                'CNT_name'
-                            );
-                        } else {
-                            $value = EEH_Export::prepare_value_from_db_for_display(
-                                EEM_Attendee::instance(),
-                                $att_field_name,
-                                $reg_row[ $field_obj->get_qualified_column() ]
-                            );
-                        }
-                    } else {
-                        $value = '';
-                    }
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
-                }
-                // make sure each registration has the same questions in the same order
-                foreach ($question_labels as $question_label) {
-                    if (! isset($reg_csv_array[ $question_label ])) {
-                        $reg_csv_array[ $question_label ] = null;
-                    }
-                }
-                $answers = EEM_Answer::instance()->get_all_wpdb_results(array(
-                    array('REG_ID' => $reg_row['Registration.REG_ID']),
-                    'force_join' => array('Question'),
-                ));
-                // now fill out the questions THEY answered
-                foreach ($answers as $answer_row) {
-                    if ($answer_row['Question.QST_ID']) {
-                        $question_label = EEH_Export::prepare_value_from_db_for_display(
-                            EEM_Question::instance(),
-                            'QST_admin_label',
-                            $answer_row['Question.QST_admin_label']
-                        );
-                    } else {
-                        $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
-                    }
-                    if (isset($answer_row['Question.QST_type'])
-                        && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state
-                    ) {
-                        $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
-                            $answer_row['Answer.ANS_value']
-                        );
-                    } else {
-                        // this isn't for html, so don't show html entities
-                        $reg_csv_array[ $question_label ] = html_entity_decode(
-                            EEH_Export::prepare_value_from_db_for_display(
-                                EEM_Answer::instance(),
-                                'ANS_value',
-                                $answer_row['Answer.ANS_value']
-                            )
-                        );
-                    }
-                }
+	/**
+	 * Gets the csv data for a batch of registrations
+	 *
+	 * @param int|null $event_id
+	 * @param int $offset
+	 * @param int $limit
+	 * @param array $question_labels the IDs for all the questions which were answered by someone in this selection
+	 * @param array $query_params for using where querying the model
+	 * @return array top-level keys are numeric, next-level keys are column headers
+	 * @throws \EE_Error
+	 */
+	public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params)
+	{
+		$reg_fields_to_include = array(
+			'TXN_ID',
+			'ATT_ID',
+			'REG_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+		);
+		$att_fields_to_include = array(
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		);
+		$registrations_csv_ready_array = array();
+		$reg_model = EE_Registry::instance()->load_model('Registration');
+		$query_params['limit'] = array($offset, $limit);
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
+		$registration_ids = array();
+		foreach ($registration_rows as $reg_row) {
+			$registration_ids[] = intval($reg_row['Registration.REG_ID']);
+		}
+		foreach ($registration_rows as $reg_row) {
+			if (is_array($reg_row)) {
+				$reg_csv_array = array();
+				if (! $event_id) {
+					// get the event's name and Id
+					$reg_csv_array[ (string) __('Event', 'event_espresso') ] = sprintf(
+						/* translators: 1: event name, 2: event ID */
+						__('%1$s (%2$s)', 'event_espresso'),
+						EEH_Export::prepare_value_from_db_for_display(
+							EEM_Event::instance(),
+							'EVT_name',
+							$reg_row['Event_CPT.post_title']
+						),
+						$reg_row['Event_CPT.ID']
+					);
+				}
+				$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
+				/*@var $reg_row EE_Registration */
+				foreach ($reg_fields_to_include as $field_name) {
+					$field = $reg_model->field_settings_for($field_name);
+					if ($field_name == 'REG_final_price') {
+						$value = EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_final_price'],
+							'localized_float'
+						);
+					} elseif ($field_name == 'REG_count') {
+						$value = sprintf(
+							/* translators: 1: number of registration in group (REG_count), 2: registration group size (REG_group_size) */
+							__('%1$s of %2$s', 'event_espresso'),
+							EEH_Export::prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_count',
+								$reg_row['Registration.REG_count']
+							),
+							EEH_Export::prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_group_size',
+								$reg_row['Registration.REG_group_size']
+							)
+						);
+					} elseif ($field_name == 'REG_date') {
+						$value = EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_date'],
+							'no_html'
+						);
+					} else {
+						$value = EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row[ $field->get_qualified_column() ]
+						);
+					}
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value;
+					if ($field_name == 'REG_final_price') {
+						// add a column named Currency after the final price
+						$reg_csv_array[ (string) __("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code;
+					}
+				}
+				// get pretty status
+				$stati = EEM_Status::instance()->localized_status(
+					array(
+						$reg_row['Registration.STS_ID']     => __('unknown', 'event_espresso'),
+						$reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'),
+					),
+					false,
+					'sentence'
+				);
+				$reg_csv_array[ (string) __("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ];
+				// get pretty transaction status
+				$reg_csv_array[ (string) __("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
+				$reg_csv_array[ (string) __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+					? EEH_Export::prepare_value_from_db_for_display(
+						EEM_Transaction::instance(),
+						'TXN_total',
+						$reg_row['TransactionTable.TXN_total'],
+						'localized_float'
+					) : '0.00';
+				$reg_csv_array[ (string) __('Amount Paid', 'event_espresso') ] = $is_primary_reg
+					? EEH_Export::prepare_value_from_db_for_display(
+						EEM_Transaction::instance(),
+						'TXN_paid',
+						$reg_row['TransactionTable.TXN_paid'],
+						'localized_float'
+					) : '0.00';
+				$payment_methods = array();
+				$gateway_txn_ids_etc = array();
+				$payment_times = array();
+				if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+					$payments_info = EEM_Payment::instance()->get_all_wpdb_results(
+						array(
+							array(
+								'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+								'STS_ID' => EEM_Payment::status_id_approved,
+							),
+							'force_join' => array('Payment_Method'),
+						),
+						ARRAY_A,
+						'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
+					);
+					foreach ($payments_info as $payment_method_and_gateway_txn_id) {
+						$payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
+							? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
+						$gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id'])
+							? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
+						$payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time'])
+							? $payment_method_and_gateway_txn_id['payment_time'] : '';
+					}
+				}
+				$reg_csv_array[ (string) __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
+				$reg_csv_array[ (string) __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
+				$reg_csv_array[ (string) __('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+					',',
+					$gateway_txn_ids_etc
+				);
+				// get whether or not the user has checked in
+				$reg_csv_array[ (string) __("Check-Ins", "event_espresso") ] = $reg_model->count_related(
+					$reg_row['Registration.REG_ID'],
+					'Checkin'
+				);
+				// get ticket of registration and its price
+				$ticket_model = EE_Registry::instance()->load_model('Ticket');
+				if ($reg_row['Ticket.TKT_ID']) {
+					$ticket_name = EEH_Export::prepare_value_from_db_for_display(
+						$ticket_model,
+						'TKT_name',
+						$reg_row['Ticket.TKT_name']
+					);
+					$datetimes_strings = array();
+					foreach (EEM_Datetime::instance()->get_all_wpdb_results(
+						array(
+							array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
+							'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+							'default_where_conditions' => 'none',
+						)
+					) as $datetime) {
+						$datetimes_strings[] = EEH_Export::prepare_value_from_db_for_display(
+							EEM_Datetime::instance(),
+							'DTT_EVT_start',
+							$datetime['Datetime.DTT_EVT_start']
+						);
+					}
+				} else {
+					$ticket_name = __('Unknown', 'event_espresso');
+					$datetimes_strings = array(__('Unknown', 'event_espresso'));
+				}
+				$reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+				$reg_csv_array[ (string) __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
+				// get datetime(s) of registration
+				// add attendee columns
+				foreach ($att_fields_to_include as $att_field_name) {
+					$field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
+					if ($reg_row['Attendee_CPT.ID']) {
+						if ($att_field_name == 'STA_ID') {
+							$value = EEM_State::instance()->get_var(
+								array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
+								'STA_name'
+							);
+						} elseif ($att_field_name == 'CNT_ISO') {
+							$value = EEM_Country::instance()->get_var(
+								array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
+								'CNT_name'
+							);
+						} else {
+							$value = EEH_Export::prepare_value_from_db_for_display(
+								EEM_Attendee::instance(),
+								$att_field_name,
+								$reg_row[ $field_obj->get_qualified_column() ]
+							);
+						}
+					} else {
+						$value = '';
+					}
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
+				}
+				// make sure each registration has the same questions in the same order
+				foreach ($question_labels as $question_label) {
+					if (! isset($reg_csv_array[ $question_label ])) {
+						$reg_csv_array[ $question_label ] = null;
+					}
+				}
+				$answers = EEM_Answer::instance()->get_all_wpdb_results(array(
+					array('REG_ID' => $reg_row['Registration.REG_ID']),
+					'force_join' => array('Question'),
+				));
+				// now fill out the questions THEY answered
+				foreach ($answers as $answer_row) {
+					if ($answer_row['Question.QST_ID']) {
+						$question_label = EEH_Export::prepare_value_from_db_for_display(
+							EEM_Question::instance(),
+							'QST_admin_label',
+							$answer_row['Question.QST_admin_label']
+						);
+					} else {
+						$question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
+					}
+					if (isset($answer_row['Question.QST_type'])
+						&& $answer_row['Question.QST_type'] == EEM_Question::QST_type_state
+					) {
+						$reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
+							$answer_row['Answer.ANS_value']
+						);
+					} else {
+						// this isn't for html, so don't show html entities
+						$reg_csv_array[ $question_label ] = html_entity_decode(
+							EEH_Export::prepare_value_from_db_for_display(
+								EEM_Answer::instance(),
+								'ANS_value',
+								$answer_row['Answer.ANS_value']
+							)
+						);
+					}
+				}
 
-                /**
-                 * Filter to change the contents of each row of the registrations report CSV file.
-                 * This can be used to add or remote columns from the CSV file, or change their values.
-                 * Note when using: all rows in the CSV should have the same columns.
-                 * @param array $reg_csv_array keys are the column names, values are their cell values
-                 * @param array $reg_row one entry from EEM_Registration::get_all_wpdb_results()
-                 */
-                $registrations_csv_ready_array[] = apply_filters(
-                    'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
-                    $reg_csv_array,
-                    $reg_row
-                );
-            }
-        }
-        // if we couldn't export anything, we want to at least show the column headers
-        if (empty($registrations_csv_ready_array)) {
-            $reg_csv_array = array();
-            $model_and_fields_to_include = array(
-                'Registration' => $reg_fields_to_include,
-                'Attendee'     => $att_fields_to_include,
-            );
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                foreach ($field_list as $field_name) {
-                    $field = $model->field_settings_for($field_name);
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
-                }
-            }
-            $registrations_csv_ready_array[] = $reg_csv_array;
-        }
-        return $registrations_csv_ready_array;
-    }
+				/**
+				 * Filter to change the contents of each row of the registrations report CSV file.
+				 * This can be used to add or remote columns from the CSV file, or change their values.
+				 * Note when using: all rows in the CSV should have the same columns.
+				 * @param array $reg_csv_array keys are the column names, values are their cell values
+				 * @param array $reg_row one entry from EEM_Registration::get_all_wpdb_results()
+				 */
+				$registrations_csv_ready_array[] = apply_filters(
+					'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
+					$reg_csv_array,
+					$reg_row
+				);
+			}
+		}
+		// if we couldn't export anything, we want to at least show the column headers
+		if (empty($registrations_csv_ready_array)) {
+			$reg_csv_array = array();
+			$model_and_fields_to_include = array(
+				'Registration' => $reg_fields_to_include,
+				'Attendee'     => $att_fields_to_include,
+			);
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field = $model->field_settings_for($field_name);
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
+				}
+			}
+			$registrations_csv_ready_array[] = $reg_csv_array;
+		}
+		return $registrations_csv_ready_array;
+	}
 
 
-    /**
-     * Counts total unit to process
-     *
-     * @deprecated since 4.9.19
-     * @param int|array $event_id
-     * @return int
-     */
-    public function count_units_to_process($event_id)
-    {
-        // use the legacy filter
-        if ($event_id) {
-            $query_params[0]['EVT_ID'] = $event_id;
-        } else {
-            $query_params['force_join'][] = 'Event';
-        }
-        return \EEM_Registration::instance()->count($query_params);
-    }
+	/**
+	 * Counts total unit to process
+	 *
+	 * @deprecated since 4.9.19
+	 * @param int|array $event_id
+	 * @return int
+	 */
+	public function count_units_to_process($event_id)
+	{
+		// use the legacy filter
+		if ($event_id) {
+			$query_params[0]['EVT_ID'] = $event_id;
+		} else {
+			$query_params['force_join'][] = 'Event';
+		}
+		return \EEM_Registration::instance()->count($query_params);
+	}
 
 
-    /**
-     * Performs any clean-up logic when we know the job is completed.
-     * In this case, we delete the temporary file
-     *
-     * @param JobParameters $job_parameters
-     * @return boolean
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        $this->_file_helper->delete(
-            \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed.
+	 * In this case, we delete the temporary file
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return boolean
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		$this->_file_helper->delete(
+			\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -45,7 +45,7 @@ 
     public function create_job(JobParameters $job_parameters)
     {
         $event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+        if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
             throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
         }
         $filepath = $this->create_file_from_job_with_name(
@@ -82,7 +82,7 @@ 
                 $query_params['force_join'][] = 'Event';
             }
         }
-        if (! isset($query_params['force_join'])) {
+        if ( ! isset($query_params['force_join'])) {
             $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
         }
         $job_parameters->add_extra_data('query_params', $query_params);
@@ -172,10 +172,10 @@ 
         $question_where_params = array();
         foreach ($reg_where_params as $key => $val) {
             if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val);
+                $question_where_params[$key] = $this->_change_registration_where_params_to_question_where_params($val);
             } else {
                 // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+                $question_where_params['Question_Group.Event.Registration.'.$key] = $val;
             }
         }
         return $question_where_params;
@@ -268,9 +268,9 @@ 
         foreach ($registration_rows as $reg_row) {
             if (is_array($reg_row)) {
                 $reg_csv_array = array();
-                if (! $event_id) {
+                if ( ! $event_id) {
                     // get the event's name and Id
-                    $reg_csv_array[ (string) __('Event', 'event_espresso') ] = sprintf(
+                    $reg_csv_array[(string) __('Event', 'event_espresso')] = sprintf(
                         /* translators: 1: event name, 2: event ID */
                         __('%1$s (%2$s)', 'event_espresso'),
                         EEH_Export::prepare_value_from_db_for_display(
@@ -318,13 +318,13 @@ 
                         $value = EEH_Export::prepare_value_from_db_for_display(
                             $reg_model,
                             $field_name,
-                            $reg_row[ $field->get_qualified_column() ]
+                            $reg_row[$field->get_qualified_column()]
                         );
                     }
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value;
+                    $reg_csv_array[EEH_Export::get_column_name_for_field($field)] = $value;
                     if ($field_name == 'REG_final_price') {
                         // add a column named Currency after the final price
-                        $reg_csv_array[ (string) __("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code;
+                        $reg_csv_array[(string) __("Currency", "event_espresso")] = \EE_Config::instance()->currency->code;
                     }
                 }
                 // get pretty status
@@ -336,17 +336,17 @@ 
                     false,
                     'sentence'
                 );
-                $reg_csv_array[ (string) __("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ];
+                $reg_csv_array[(string) __("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']];
                 // get pretty transaction status
-                $reg_csv_array[ (string) __("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-                $reg_csv_array[ (string) __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+                $reg_csv_array[(string) __("Transaction Status", 'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']];
+                $reg_csv_array[(string) __('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
                     ? EEH_Export::prepare_value_from_db_for_display(
                         EEM_Transaction::instance(),
                         'TXN_total',
                         $reg_row['TransactionTable.TXN_total'],
                         'localized_float'
                     ) : '0.00';
-                $reg_csv_array[ (string) __('Amount Paid', 'event_espresso') ] = $is_primary_reg
+                $reg_csv_array[(string) __('Amount Paid', 'event_espresso')] = $is_primary_reg
                     ? EEH_Export::prepare_value_from_db_for_display(
                         EEM_Transaction::instance(),
                         'TXN_paid',
@@ -377,14 +377,14 @@ 
                             ? $payment_method_and_gateway_txn_id['payment_time'] : '';
                     }
                 }
-                $reg_csv_array[ (string) __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-                $reg_csv_array[ (string) __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-                $reg_csv_array[ (string) __('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+                $reg_csv_array[(string) __('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
+                $reg_csv_array[(string) __('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
+                $reg_csv_array[(string) __('Gateway Transaction ID(s)', 'event_espresso')] = implode(
                     ',',
                     $gateway_txn_ids_etc
                 );
                 // get whether or not the user has checked in
-                $reg_csv_array[ (string) __("Check-Ins", "event_espresso") ] = $reg_model->count_related(
+                $reg_csv_array[(string) __("Check-Ins", "event_espresso")] = $reg_model->count_related(
                     $reg_row['Registration.REG_ID'],
                     'Checkin'
                 );
@@ -414,8 +414,8 @@ 
                     $ticket_name = __('Unknown', 'event_espresso');
                     $datetimes_strings = array(__('Unknown', 'event_espresso'));
                 }
-                $reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-                $reg_csv_array[ (string) __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
+                $reg_csv_array[(string) $ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
+                $reg_csv_array[(string) __("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
                 // get datetime(s) of registration
                 // add attendee columns
                 foreach ($att_fields_to_include as $att_field_name) {
@@ -435,18 +435,18 @@ 
                             $value = EEH_Export::prepare_value_from_db_for_display(
                                 EEM_Attendee::instance(),
                                 $att_field_name,
-                                $reg_row[ $field_obj->get_qualified_column() ]
+                                $reg_row[$field_obj->get_qualified_column()]
                             );
                         }
                     } else {
                         $value = '';
                     }
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
+                    $reg_csv_array[EEH_Export::get_column_name_for_field($field_obj)] = $value;
                 }
                 // make sure each registration has the same questions in the same order
                 foreach ($question_labels as $question_label) {
-                    if (! isset($reg_csv_array[ $question_label ])) {
-                        $reg_csv_array[ $question_label ] = null;
+                    if ( ! isset($reg_csv_array[$question_label])) {
+                        $reg_csv_array[$question_label] = null;
                     }
                 }
                 $answers = EEM_Answer::instance()->get_all_wpdb_results(array(
@@ -467,12 +467,12 @@ 
                     if (isset($answer_row['Question.QST_type'])
                         && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state
                     ) {
-                        $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
+                        $reg_csv_array[$question_label] = EEM_State::instance()->get_state_name_by_ID(
                             $answer_row['Answer.ANS_value']
                         );
                     } else {
                         // this isn't for html, so don't show html entities
-                        $reg_csv_array[ $question_label ] = html_entity_decode(
+                        $reg_csv_array[$question_label] = html_entity_decode(
                             EEH_Export::prepare_value_from_db_for_display(
                                 EEM_Answer::instance(),
                                 'ANS_value',
@@ -507,7 +507,7 @@ 
                 $model = EE_Registry::instance()->load_model($model_name);
                 foreach ($field_list as $field_name) {
                     $field = $model->field_settings_for($field_name);
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
+                    $reg_csv_array[EEH_Export::get_column_name_for_field($field)] = null;
                 }
             }
             $registrations_csv_ready_array[] = $reg_csv_array;

core/libraries/form_sections/inputs/EE_Country_Select_Input.php

Indentation +70 added lines, -70 removed lines

@@ -14,80 +14,80 @@
  */
 class EE_Country_Select_Input extends EE_Select_Input
 {
-    /**
-     * $input_settings key used for detecting the "get" option
-     */
-    const OPTION_GET_KEY = 'get';
+	/**
+	 * $input_settings key used for detecting the "get" option
+	 */
+	const OPTION_GET_KEY = 'get';
 
-    /**
-     * indicates that ALL countries should be retrieved from the db for the input
-     */
-    const OPTION_GET_ALL = 'all';
+	/**
+	 * indicates that ALL countries should be retrieved from the db for the input
+	 */
+	const OPTION_GET_ALL = 'all';
 
-    /**
-     * indicates that only ACTIVE countries should be retrieved from the db for the input
-     */
-    const OPTION_GET_ACTIVE = 'active';
+	/**
+	 * indicates that only ACTIVE countries should be retrieved from the db for the input
+	 */
+	const OPTION_GET_ACTIVE = 'active';
 
 
-    /**
-     * @param array $country_options
-     * @param array $input_settings
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($country_options = null, $input_settings = array())
-    {
-        $get = isset($input_settings[ self::OPTION_GET_KEY ])
-            ? $input_settings[ self::OPTION_GET_KEY ]
-            : self::OPTION_GET_ACTIVE;
-        $country_options = apply_filters(
-            'FHEE__EE_Country_Select_Input____construct__country_options',
-            $this->get_country_answer_options($country_options, $get),
-            $this,
-            $get
-        );
-        $input_settings['html_class'] = isset($input_settings['html_class'])
-            ? $input_settings['html_class'] . ' ee-country-select-js'
-            : 'ee-country-select-js';
-        parent::__construct($country_options, $input_settings);
-    }
+	/**
+	 * @param array $country_options
+	 * @param array $input_settings
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($country_options = null, $input_settings = array())
+	{
+		$get = isset($input_settings[ self::OPTION_GET_KEY ])
+			? $input_settings[ self::OPTION_GET_KEY ]
+			: self::OPTION_GET_ACTIVE;
+		$country_options = apply_filters(
+			'FHEE__EE_Country_Select_Input____construct__country_options',
+			$this->get_country_answer_options($country_options, $get),
+			$this,
+			$get
+		);
+		$input_settings['html_class'] = isset($input_settings['html_class'])
+			? $input_settings['html_class'] . ' ee-country-select-js'
+			: 'ee-country-select-js';
+		parent::__construct($country_options, $input_settings);
+	}
 
 
-    /**
-     * get_country_answer_options
-     *
-     * @param array  $country_options
-     * @param string $get
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_country_answer_options($country_options = null, $get = self::OPTION_GET_ACTIVE)
-    {
-        // if passed something that is NOT an array
-        if (! is_array($country_options)) {
-            // get possibly cached list of countries
-            $countries = $get === self::OPTION_GET_ALL
-                ? EEM_Country::instance()->get_all_countries()
-                : EEM_Country::instance()->get_all_active_countries();
-            if (! empty($countries)) {
-                $country_options[''] = '';
-                foreach ($countries as $country) {
-                    if ($country instanceof EE_Country) {
-                        $country_options[ $country->ID() ] = $country->name();
-                    }
-                }
-            } else {
-                $country_options = array();
-            }
-        }
-        return $country_options;
-    }
+	/**
+	 * get_country_answer_options
+	 *
+	 * @param array  $country_options
+	 * @param string $get
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_country_answer_options($country_options = null, $get = self::OPTION_GET_ACTIVE)
+	{
+		// if passed something that is NOT an array
+		if (! is_array($country_options)) {
+			// get possibly cached list of countries
+			$countries = $get === self::OPTION_GET_ALL
+				? EEM_Country::instance()->get_all_countries()
+				: EEM_Country::instance()->get_all_active_countries();
+			if (! empty($countries)) {
+				$country_options[''] = '';
+				foreach ($countries as $country) {
+					if ($country instanceof EE_Country) {
+						$country_options[ $country->ID() ] = $country->name();
+					}
+				}
+			} else {
+				$country_options = array();
+			}
+		}
+		return $country_options;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -41,8 +41,8 @@ 
      */
     public function __construct($country_options = null, $input_settings = array())
     {
-        $get = isset($input_settings[ self::OPTION_GET_KEY ])
-            ? $input_settings[ self::OPTION_GET_KEY ]
+        $get = isset($input_settings[self::OPTION_GET_KEY])
+            ? $input_settings[self::OPTION_GET_KEY]
             : self::OPTION_GET_ACTIVE;
         $country_options = apply_filters(
             'FHEE__EE_Country_Select_Input____construct__country_options',
@@ -51,7 +51,7 @@ 
             $get
         );
         $input_settings['html_class'] = isset($input_settings['html_class'])
-            ? $input_settings['html_class'] . ' ee-country-select-js'
+            ? $input_settings['html_class'].' ee-country-select-js'
             : 'ee-country-select-js';
         parent::__construct($country_options, $input_settings);
     }
@@ -72,16 +72,16 @@ 
     public function get_country_answer_options($country_options = null, $get = self::OPTION_GET_ACTIVE)
     {
         // if passed something that is NOT an array
-        if (! is_array($country_options)) {
+        if ( ! is_array($country_options)) {
             // get possibly cached list of countries
             $countries = $get === self::OPTION_GET_ALL
                 ? EEM_Country::instance()->get_all_countries()
                 : EEM_Country::instance()->get_all_active_countries();
-            if (! empty($countries)) {
+            if ( ! empty($countries)) {
                 $country_options[''] = '';
                 foreach ($countries as $country) {
                     if ($country instanceof EE_Country) {
-                        $country_options[ $country->ID() ] = $country->name();
+                        $country_options[$country->ID()] = $country->name();
                     }
                 }
             } else {

core/libraries/form_sections/inputs/EE_State_Select_Input.php

Indentation +54 added lines, -54 removed lines

@@ -13,60 +13,60 @@
 class EE_State_Select_Input extends EE_Select_Input
 {
 
-    /**
-     * @param array $state_options
-     * @param array $input_settings
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($state_options, $input_settings = array())
-    {
-        $state_options = apply_filters(
-            'FHEE__EE_State_Select_Input____construct__state_options',
-            $this->get_state_answer_options($state_options),
-            $this
-        );
-        $input_settings['html_class'] = isset($input_settings['html_class'])
-            ? $input_settings['html_class'] . ' ee-state-select-js'
-            : 'ee-state-select-js';
-        parent::__construct($state_options, $input_settings);
-    }
+	/**
+	 * @param array $state_options
+	 * @param array $input_settings
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($state_options, $input_settings = array())
+	{
+		$state_options = apply_filters(
+			'FHEE__EE_State_Select_Input____construct__state_options',
+			$this->get_state_answer_options($state_options),
+			$this
+		);
+		$input_settings['html_class'] = isset($input_settings['html_class'])
+			? $input_settings['html_class'] . ' ee-state-select-js'
+			: 'ee-state-select-js';
+		parent::__construct($state_options, $input_settings);
+	}
 
 
-    /**
-     * get_state_answer_options
-     *
-     * @param array $state_options
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_state_answer_options($state_options = null)
-    {
-        // if passed something that is NOT an array
-        if (! is_array($state_options) || empty($state_options)) {
-            // get possibly cached list of states
-            $states = EEM_State::instance()->get_all_active_states();
-        }
-        if (is_array($state_options) && reset($state_options) instanceof EE_State) {
-            $states = $state_options;
-            $state_options = array();
-        }
-        if (! empty($states)) {
-            // set the default
-            $state_options[''][''] = '';
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
-                }
-            }
-        }
-        return $state_options;
-    }
+	/**
+	 * get_state_answer_options
+	 *
+	 * @param array $state_options
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_state_answer_options($state_options = null)
+	{
+		// if passed something that is NOT an array
+		if (! is_array($state_options) || empty($state_options)) {
+			// get possibly cached list of states
+			$states = EEM_State::instance()->get_all_active_states();
+		}
+		if (is_array($state_options) && reset($state_options) instanceof EE_State) {
+			$states = $state_options;
+			$state_options = array();
+		}
+		if (! empty($states)) {
+			// set the default
+			$state_options[''][''] = '';
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+				}
+			}
+		}
+		return $state_options;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -30,7 +30,7 @@ 
             $this
         );
         $input_settings['html_class'] = isset($input_settings['html_class'])
-            ? $input_settings['html_class'] . ' ee-state-select-js'
+            ? $input_settings['html_class'].' ee-state-select-js'
             : 'ee-state-select-js';
         parent::__construct($state_options, $input_settings);
     }
@@ -50,7 +50,7 @@ 
     public function get_state_answer_options($state_options = null)
     {
         // if passed something that is NOT an array
-        if (! is_array($state_options) || empty($state_options)) {
+        if ( ! is_array($state_options) || empty($state_options)) {
             // get possibly cached list of states
             $states = EEM_State::instance()->get_all_active_states();
         }
@@ -58,12 +58,12 @@ 
             $states = $state_options;
             $state_options = array();
         }
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             // set the default
             $state_options[''][''] = '';
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+                    $state_options[$state->country()->name()][$state->ID()] = $state->name();
                 }
             }
         }

core/services/address/CountrySubRegionDao.php

Doc Comments +1 added lines, -1 removed lines

@@ -156,7 +156,7 @@
 
     /**
      * @param string $url
-     * @return array
+     * @return string
      */
     private function retrieveJsonData($url)
     {

Spacing +5 added lines, -5 removed lines

@@ -78,7 +78,7 @@ 
         $data = [];
         if (empty($this->countries)) {
             $this->data_version = $this->getCountrySubRegionDataVersion();
-            $data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
+            $data = $this->retrieveJsonData(self::REPO_URL.'countries.json');
         }
         if (empty($data)) {
             EE_Error::add_error(
@@ -88,7 +88,7 @@ 
                 __LINE__
             );
         }
-        if (! $has_sub_regions
+        if ( ! $has_sub_regions
             || (isset($data->version) && version_compare($data->version, $this->data_version))
         ) {
             if (isset($data->countries)
@@ -137,7 +137,7 @@ 
      */
     private function processCountryData($CNT_ISO, $countries = array())
     {
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $key => $country) {
                 if ($country instanceof stdClass
                     && $country->code === $CNT_ISO
@@ -145,7 +145,7 @@ 
                     && ! empty($country->filename)
                 ) {
                     $country->sub_regions = $this->retrieveJsonData(
-                        self::REPO_URL . 'countries/' . $country->filename . '.json'
+                        self::REPO_URL.'countries/'.$country->filename.'.json'
                     );
                     return $this->saveSubRegionData($country, $country->sub_regions);
                 }
@@ -205,7 +205,7 @@ 
             foreach ($sub_regions as $sub_region) {
                 // remove country code from sub region code
                 $abbrev = str_replace(
-                    $country->code . '-',
+                    $country->code.'-',
                     '',
                     sanitize_text_field($sub_region->code)
                 );

Indentation +204 added lines, -204 removed lines

@@ -24,208 +24,208 @@
 class CountrySubRegionDao
 {
 
-    const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
-
-    const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
-
-    /**
-     * @var EEM_State $state_model
-     */
-    private $state_model;
-
-    /**
-     * @var JsonValidator $json_validator
-     */
-    private $json_validator;
-
-    /**
-     * @var string $data_version
-     */
-    private $data_version;
-
-    /**
-     * @var array $countries
-     */
-    private $countries = array();
-
-
-    /**
-     * CountrySubRegionDao constructor.
-     *
-     * @param EEM_State     $state_model
-     * @param JsonValidator $json_validator
-     */
-    public function __construct(EEM_State $state_model, JsonValidator $json_validator)
-    {
-        $this->state_model = $state_model;
-        $this->json_validator = $json_validator;
-    }
-
-
-    /**
-     * @param EE_Country $country_object
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function saveCountrySubRegions(EE_Country $country_object)
-    {
-        $CNT_ISO = $country_object->ID();
-        $has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
-        $data = [];
-        if (empty($this->countries)) {
-            $this->data_version = $this->getCountrySubRegionDataVersion();
-            $data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
-        }
-        if (empty($data)) {
-            EE_Error::add_error(
-                'Country Subregion Data could not be retrieved',
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-        }
-        if (! $has_sub_regions
-            || (isset($data->version) && version_compare($data->version, $this->data_version))
-        ) {
-            if (isset($data->countries)
-                && $this->processCountryData($CNT_ISO, $data->countries) > 0
-            ) {
-                $this->countries = $data->countries;
-                $this->updateCountrySubRegionDataVersion($data->version);
-            }
-        }
-    }
-
-
-    /**
-     * @since 4.9.70.p
-     * @return string
-     */
-    private function getCountrySubRegionDataVersion()
-    {
-        return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
-    }
-
-
-    /**
-     * @param string $version
-     */
-    private function updateCountrySubRegionDataVersion($version = '')
-    {
-        // add version option if it has never been added before, or update existing
-        if ($this->data_version === null) {
-            add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
-        } else {
-            update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
-        }
-    }
-
-
-    /**
-     * @param string $CNT_ISO
-     * @param array  $countries
-     * @since 4.9.70.p
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function processCountryData($CNT_ISO, $countries = array())
-    {
-        if (! empty($countries)) {
-            foreach ($countries as $key => $country) {
-                if ($country instanceof stdClass
-                    && $country->code === $CNT_ISO
-                    && empty($country->sub_regions)
-                    && ! empty($country->filename)
-                ) {
-                    $country->sub_regions = $this->retrieveJsonData(
-                        self::REPO_URL . 'countries/' . $country->filename . '.json'
-                    );
-                    return $this->saveSubRegionData($country, $country->sub_regions);
-                }
-            }
-        }
-        return 0;
-    }
-
-
-    /**
-     * @param string $url
-     * @return array
-     */
-    private function retrieveJsonData($url)
-    {
-        if (empty($url)) {
-            EE_Error::add_error(
-                'No URL was provided!',
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-            return array();
-        }
-        $request = wp_safe_remote_get($url);
-        if ($request instanceof WP_Error) {
-            EE_Error::add_error(
-                $request->get_error_message(),
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-            return array();
-        }
-        $body = wp_remote_retrieve_body($request);
-        $json = json_decode($body);
-        if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
-            return $json;
-        }
-        return array();
-    }
-
-
-    /**
-     * @param stdClass $country
-     * @param array    $sub_regions
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function saveSubRegionData(stdClass $country, $sub_regions = array())
-    {
-        $results = 0;
-        if (is_array($sub_regions)) {
-            foreach ($sub_regions as $sub_region) {
-                // remove country code from sub region code
-                $abbrev = str_replace(
-                    $country->code . '-',
-                    '',
-                    sanitize_text_field($sub_region->code)
-                );
-                // but NOT if sub region code results in only a number
-                if (absint($abbrev) !== 0) {
-                    $abbrev = sanitize_text_field($sub_region->code);
-                }
-                if ($this->state_model->insert(
-                    array(
-                        // STA_ID CNT_ISO STA_abbrev STA_name STA_active
-                        'CNT_ISO'    => $country->code,
-                        'STA_abbrev' => $abbrev,
-                        'STA_name'   => sanitize_text_field($sub_region->name),
-                        'STA_active' => 1,
-                    )
-                )) {
-                    $results++;
-                }
-            }
-        }
-        return $results;
-    }
+	const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
+
+	const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
+
+	/**
+	 * @var EEM_State $state_model
+	 */
+	private $state_model;
+
+	/**
+	 * @var JsonValidator $json_validator
+	 */
+	private $json_validator;
+
+	/**
+	 * @var string $data_version
+	 */
+	private $data_version;
+
+	/**
+	 * @var array $countries
+	 */
+	private $countries = array();
+
+
+	/**
+	 * CountrySubRegionDao constructor.
+	 *
+	 * @param EEM_State     $state_model
+	 * @param JsonValidator $json_validator
+	 */
+	public function __construct(EEM_State $state_model, JsonValidator $json_validator)
+	{
+		$this->state_model = $state_model;
+		$this->json_validator = $json_validator;
+	}
+
+
+	/**
+	 * @param EE_Country $country_object
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function saveCountrySubRegions(EE_Country $country_object)
+	{
+		$CNT_ISO = $country_object->ID();
+		$has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
+		$data = [];
+		if (empty($this->countries)) {
+			$this->data_version = $this->getCountrySubRegionDataVersion();
+			$data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
+		}
+		if (empty($data)) {
+			EE_Error::add_error(
+				'Country Subregion Data could not be retrieved',
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+		}
+		if (! $has_sub_regions
+			|| (isset($data->version) && version_compare($data->version, $this->data_version))
+		) {
+			if (isset($data->countries)
+				&& $this->processCountryData($CNT_ISO, $data->countries) > 0
+			) {
+				$this->countries = $data->countries;
+				$this->updateCountrySubRegionDataVersion($data->version);
+			}
+		}
+	}
+
+
+	/**
+	 * @since 4.9.70.p
+	 * @return string
+	 */
+	private function getCountrySubRegionDataVersion()
+	{
+		return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
+	}
+
+
+	/**
+	 * @param string $version
+	 */
+	private function updateCountrySubRegionDataVersion($version = '')
+	{
+		// add version option if it has never been added before, or update existing
+		if ($this->data_version === null) {
+			add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
+		} else {
+			update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
+		}
+	}
+
+
+	/**
+	 * @param string $CNT_ISO
+	 * @param array  $countries
+	 * @since 4.9.70.p
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function processCountryData($CNT_ISO, $countries = array())
+	{
+		if (! empty($countries)) {
+			foreach ($countries as $key => $country) {
+				if ($country instanceof stdClass
+					&& $country->code === $CNT_ISO
+					&& empty($country->sub_regions)
+					&& ! empty($country->filename)
+				) {
+					$country->sub_regions = $this->retrieveJsonData(
+						self::REPO_URL . 'countries/' . $country->filename . '.json'
+					);
+					return $this->saveSubRegionData($country, $country->sub_regions);
+				}
+			}
+		}
+		return 0;
+	}
+
+
+	/**
+	 * @param string $url
+	 * @return array
+	 */
+	private function retrieveJsonData($url)
+	{
+		if (empty($url)) {
+			EE_Error::add_error(
+				'No URL was provided!',
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+			return array();
+		}
+		$request = wp_safe_remote_get($url);
+		if ($request instanceof WP_Error) {
+			EE_Error::add_error(
+				$request->get_error_message(),
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+			return array();
+		}
+		$body = wp_remote_retrieve_body($request);
+		$json = json_decode($body);
+		if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
+			return $json;
+		}
+		return array();
+	}
+
+
+	/**
+	 * @param stdClass $country
+	 * @param array    $sub_regions
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function saveSubRegionData(stdClass $country, $sub_regions = array())
+	{
+		$results = 0;
+		if (is_array($sub_regions)) {
+			foreach ($sub_regions as $sub_region) {
+				// remove country code from sub region code
+				$abbrev = str_replace(
+					$country->code . '-',
+					'',
+					sanitize_text_field($sub_region->code)
+				);
+				// but NOT if sub region code results in only a number
+				if (absint($abbrev) !== 0) {
+					$abbrev = sanitize_text_field($sub_region->code);
+				}
+				if ($this->state_model->insert(
+					array(
+						// STA_ID CNT_ISO STA_abbrev STA_name STA_active
+						'CNT_ISO'    => $country->code,
+						'STA_abbrev' => $abbrev,
+						'STA_name'   => sanitize_text_field($sub_region->name),
+						'STA_active' => 1,
+					)
+				)) {
+					$results++;
+				}
+			}
+		}
+		return $results;
+	}
 }