eventespresso / event-espresso-core

core/EE_Data_Migration_Manager.core.php

Indentation +1234 added lines, -1234 removed lines

@@ -32,1238 +32,1238 @@
 class EE_Data_Migration_Manager implements ResettableInterface
 {
 
-    /**
-     *
-     * @var EE_Registry
-     */
-    // protected $EE;
-    /**
-     * name of the wordpress option which stores an array of data about
-     */
-    const data_migrations_option_name = 'ee_data_migration';
-
-
-    const data_migration_script_option_prefix = 'ee_data_migration_script_';
-
-    const data_migration_script_mapping_option_prefix = 'ee_dms_map_';
-
-    /**
-     * name of the wordpress option which stores the database' current version. IE, the code may be at version 4.2.0,
-     * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc.
-     */
-    const current_database_state = 'ee_data_migration_current_db_state';
-
-    /**
-     * Special status string returned when we're positive there are no more data migration
-     * scripts that can be run.
-     */
-    const status_no_more_migration_scripts = 'no_more_migration_scripts';
-    /**
-     * string indicating the migration should continue
-     */
-    const status_continue = 'status_continue';
-    /**
-     * string indicating the migration has completed and should be ended
-     */
-    const status_completed = 'status_completed';
-    /**
-     * string indicating a fatal error occurred and the data migration should be completely aborted
-     */
-    const status_fatal_error = 'status_fatal_error';
-
-    /**
-     * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent
-     * during migration)
-     */
-    const step_size = 50;
-
-    /**
-     * option name that stores the queue of ee plugins needing to have
-     * their data initialized (or re-initialized) once we are done migrations
-     */
-    const db_init_queue_option_name = 'ee_db_init_queue';
-    /**
-     * Array of information concerning data migrations that have ran in the history
-     * of this EE installation. Keys should be the name of the version the script upgraded to
-     *
-     * @var EE_Data_Migration_Script_Base[]
-     */
-    private $_data_migrations_ran = null;
-    /**
-     * The last ran script. It's nice to store this somewhere accessible, as its easiest
-     * to know which was the last run by which is the newest wp option; but in most of the code
-     * we just use the local $_data_migration_ran array, which organized the scripts differently
-     *
-     * @var EE_Data_Migration_Script_Base
-     */
-    private $_last_ran_script = null;
-
-    /**
-     * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script.
-     *
-     * @var EE_Data_Migration_Script_Base
-     */
-    private $_last_ran_incomplete_script = null;
-    /**
-     * array where keys are classnames, and values are filepaths of all the known migration scripts
-     *
-     * @var array
-     */
-    private $_data_migration_class_to_filepath_map;
-
-    /**
-     * the following 4 properties are fully set on construction.
-     * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished
-     * one, we may want to start the next one); whereas the last two indicate whether to continue running a single
-     * data migration script
-     *
-     * @var array
-     */
-    public $stati_that_indicate_to_continue_migrations = array();
-
-    public $stati_that_indicate_to_stop_migrations = array();
-
-    public $stati_that_indicate_to_continue_single_migration_script = array();
-
-    public $stati_that_indicate_to_stop_single_migration_script = array();
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    protected $_table_manager;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-    /**
-     * @var array $script_migration_versions
-     */
-    protected $script_migration_versions;
-
-    /**
-     * @var EE_Data_Migration_Manager $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Data_Migration_Manager instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Data_Migration_Manager) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning,
-     * all new usages of the singleton should be made with Classname::instance()) and returns it
-     *
-     * @return EE_Data_Migration_Manager
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * constructor
-     */
-    private function __construct()
-    {
-        $this->stati_that_indicate_to_continue_migrations = array(
-            self::status_continue,
-            self::status_completed,
-        );
-        $this->stati_that_indicate_to_stop_migrations = array(
-            self::status_fatal_error,
-            self::status_no_more_migration_scripts,
-        );
-        $this->stati_that_indicate_to_continue_single_migration_script = array(
-            self::status_continue,
-        );
-        $this->stati_that_indicate_to_stop_single_migration_script = array(
-            self::status_completed,
-            self::status_fatal_error
-            // note: status_no_more_migration_scripts doesn't apply
-        );
-        // make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class
-        // to be defined, because right now it doesn't get autoloaded on its own
-        EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), true);
-        EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), true);
-        $this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true);
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-    }
-
-
-    /**
-     * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what
-     * the option names are like, but generally they're like
-     * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that).
-     * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived,
-     * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php (eg
-     * EE_DMS_Core_4_1_0.dms.php)
-     *
-     * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set)
-     * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of
-     *               that plugin (eg '4.1.0')
-     */
-    private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name)
-    {
-        $plugin_slug_and_version_string = str_replace(
-            EE_Data_Migration_Manager::data_migration_script_option_prefix,
-            "",
-            $option_name
-        );
-        // check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style)
-        $parts = explode(".", $plugin_slug_and_version_string);
-
-        if (count($parts) == 4) {
-            // it's 4.2-style.eg Core.4.1.0
-            $plugin_slug = $parts[0];// eg Core
-            $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
-        } else {
-            // it's 4.1-style: eg 4.1.0
-            $plugin_slug = 'Core';
-            $version_string = $plugin_slug_and_version_string;// eg 4.1.0
-        }
-        return array($plugin_slug, $version_string);
-    }
-
-    /**
-     * Gets the DMS class from the wordpress option, otherwise throws an EE_Error if it's not
-     * for a known DMS class.
-     *
-     * @param string $dms_option_name
-     * @param string $dms_option_value (serialized)
-     * @return EE_Data_Migration_Script_Base
-     * @throws EE_Error
-     */
-    private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value)
-    {
-        $data_migration_data = maybe_unserialize($dms_option_value);
-        if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) {
-            $class = new $data_migration_data['class'];
-            if ($class instanceof EE_Data_Migration_Script_Base) {
-                $class->instantiate_from_array_of_properties($data_migration_data);
-                return $class;
-            } else {
-                // huh, so its an object but not a data migration script?? that shouldn't happen
-                // just leave it as an array (which will probably just get ignored)
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists",
-                            'event_espresso'
-                        ),
-                        $data_migration_data['class']
-                    )
-                );
-            }
-        } else {
-            // so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists
-            throw new EE_Error(
-                sprintf(__("The wp option  with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name)
-            );
-        }
-    }
-
-    /**
-     * Gets the array describing what data migrations have run. Also has a side-effect of recording which was the last
-     * ran, and which was the last ran which hasn't finished yet
-     *
-     * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy
-     *               arrays in there - which should probably be ignored)
-     */
-    public function get_data_migrations_ran()
-    {
-        if (! $this->_data_migrations_ran) {
-            // setup autoloaders for each of the scripts in there
-            $this->get_all_data_migration_scripts_available();
-            $data_migrations_options = $this->get_all_migration_script_options(
-            );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
-
-            $data_migrations_ran = array();
-            // convert into data migration script classes where possible
-            foreach ($data_migrations_options as $data_migration_option) {
-                list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name(
-                    $data_migration_option['option_name']
-                );
-
-                try {
-                    $class = $this->_get_dms_class_from_wp_option(
-                        $data_migration_option['option_name'],
-                        $data_migration_option['option_value']
-                    );
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
-                    // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration
-                    $this->_last_ran_script = $class;
-                    if (! $class->is_completed()) {
-                        // sometimes we also like to know which was the last incomplete script (or if there are any at all)
-                        $this->_last_ran_incomplete_script = $class;
-                    }
-                } catch (EE_Error $e) {
-                    // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
-                        $data_migration_option['option_value']
-                    );
-                }
-            }
-            // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
-            $this->_data_migrations_ran = $data_migrations_ran;
-            if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
-                $this->_data_migrations_ran = array();
-            }
-        }
-        return $this->_data_migrations_ran;
-    }
-
-
-    /**
-     *
-     * @param string $script_name eg 'DMS_Core_4_1_0'
-     * @param string $old_table   eg 'wp_events_detail'
-     * @param string $old_pk      eg 'wp_esp_posts'
-     * @param        $new_table
-     * @return mixed string or int
-     */
-    public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table)
-    {
-        $script = EE_Registry::instance()->load_dms($script_name);
-        $mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table);
-        return $mapping;
-    }
-
-    /**
-     * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that
-     * the last option returned in this array is the most-recently ran DMS option
-     *
-     * @return array
-     */
-    public function get_all_migration_script_options()
-    {
-        global $wpdb;
-        return $wpdb->get_results(
-            "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC",
-            ARRAY_A
-        );
-    }
-
-    /**
-     * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded
-     *
-     * @return array where each value is the full folder path of a folder containing data migration scripts, WITH
-     *               slashes at the end of the folder name.
-     */
-    public function get_data_migration_script_folders()
-    {
-        return apply_filters(
-            'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            array('Core' => EE_CORE . 'data_migration_scripts')
-        );
-    }
-
-    /**
-     * Gets the version the migration script upgrades to
-     *
-     * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0'
-     * @return array {
-     * @type string  $slug                  like 'Core','Calendar',etc
-     * @type string  $version               like 4.3.0
-     *                                      }
-     * @throws EE_Error
-     */
-    public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
-    {
-        if (isset($this->script_migration_versions[ $migration_script_name ])) {
-            return $this->script_migration_versions[ $migration_script_name ];
-        }
-        $dms_info = $this->parse_dms_classname($migration_script_name);
-        $this->script_migration_versions[ $migration_script_name ] = array(
-            'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
-            'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'],
-        );
-        return $this->script_migration_versions[ $migration_script_name ];
-    }
-
-    /**
-     * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0'
-     *
-     * @param string $classname
-     * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints)
-     * @throws EE_Error
-     */
-    public function parse_dms_classname($classname)
-    {
-        $matches = array();
-        preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
-        if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ",
-                        "event_espresso"
-                    ),
-                    $classname
-                )
-            );
-        }
-        return array(
-            'slug'          => $matches[1],
-            'major_version' => intval($matches[2]),
-            'minor_version' => intval($matches[3]),
-            'micro_version' => intval($matches[4]),
-        );
-    }
-
-    /**
-     * Ensures that the option indicating the current DB version is set. This should only be
-     * a concern when activating EE for the first time, THEORETICALLY.
-     * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise
-     * to 4.1.x.
-     *
-     * @return string of current db state
-     */
-    public function ensure_current_database_state_is_set()
-    {
-        $espresso_db_core_updates = get_option('espresso_db_update', array());
-        $db_state = get_option(EE_Data_Migration_Manager::current_database_state);
-        if (! $db_state) {
-            // mark the DB as being in the state as the last version in there.
-            // this is done to trigger maintenance mode and do data migration scripts
-            // if the admin installed this version of EE over 3.1.x or 4.0.x
-            // otherwise, the normal maintenance mode code is fine
-            $previous_versions_installed = array_keys($espresso_db_core_updates);
-            $previous_version_installed = end($previous_versions_installed);
-            if (version_compare('4.1.0', $previous_version_installed)) {
-                // last installed version was less than 4.1
-                // so we want the data migrations to happen. SO, we're going to say the DB is at that state
-                $db_state = array('Core' => $previous_version_installed);
-            } else {
-                $db_state = array('Core' => EVENT_ESPRESSO_VERSION);
-            }
-            update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
-        }
-        // in 4.1, $db_state would have only been a simple string like '4.1.0',
-        // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
-        // db, and possibly other keys for other addons like 'Calendar','Permissions',etc
-        if (! is_array($db_state)) {
-            $db_state = array('Core' => $db_state);
-            update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
-        }
-        return $db_state;
-    }
-
-    /**
-     * Checks if there are any data migration scripts that ought to be run. If found,
-     * returns the instantiated classes. If none are found (ie, they've all already been run
-     * or they don't apply), returns an empty array
-     *
-     * @return EE_Data_Migration_Script_Base[]
-     */
-    public function check_for_applicable_data_migration_scripts()
-    {
-        // get the option describing what options have already run
-        $scripts_ran = $this->get_data_migrations_ran();
-        // $scripts_ran = array('4.1.0.core'=>array('monkey'=>null));
-        $script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available();
-
-
-        $current_database_state = $this->ensure_current_database_state_is_set();
-        // determine which have already been run
-        $script_classes_that_should_run_per_iteration = array();
-        $iteration = 0;
-        $next_database_state_to_consider = $current_database_state;
-        $theoretical_database_state = null;
-        do {
-            // the next state after the currently-considered one will start off looking the same as the current, but we may make additions...
-            $theoretical_database_state = $next_database_state_to_consider;
-            // the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?)
-            foreach ($script_class_and_filepaths_available as $classname => $filepath) {
-                $migrates_to_version = $this->script_migrates_to_version($classname);
-                $script_converts_plugin_slug = $migrates_to_version['slug'];
-                $script_converts_to_version = $migrates_to_version['version'];
-                // check if this version script is DONE or not; or if it's never been ran
-                if (! $scripts_ran ||
-                    ! isset($scripts_ran[ $script_converts_plugin_slug ]) ||
-                    ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) {
-                    // we haven't ran this conversion script before
-                    // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available
-                    $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis());
-                    /* @var $script EE_Data_Migration_Script_Base */
-                    $can_migrate = $script->can_migrate_from_version($theoretical_database_state);
-                    if ($can_migrate) {
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
-                        $migrates_to_version = $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
-                    }
-                } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) {
-                    // this script has been ran, or at least started
-                    $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
-                    if ($script->get_status() != self::status_completed) {
-                        // this script is already underway... keep going with it
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
-                        $migrates_to_version = $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
-                    } else {
-                        // it must have a status that indicates it has finished, so we don't want to try and run it again
-                    }
-                } else {
-                    // it exists but it's not  a proper data migration script
-                    // maybe the script got renamed? or was simply removed from EE?
-                    // either way, its certainly not runnable!
-                }
-            }
-            $iteration++;
-        } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6);
-        // ok we have all the scripts that should run, now let's make them into flat array
-        $scripts_that_should_run = array();
-        foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
-            ksort($scripts_at_priority);
-            foreach ($scripts_at_priority as $scripts) {
-                foreach ($scripts as $script) {
-                    $scripts_that_should_run[ get_class($script) ] = $script;
-                }
-            }
-        }
-
-        do_action(
-            'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run',
-            $scripts_that_should_run
-        );
-        return $scripts_that_should_run;
-    }
-
-
-    /**
-     * Gets the script which is currently being ran, if there is one. If $include_completed_scripts is set to TRUE
-     * it will return the last ran script even if its complete.
-     * This means: if you want to find the currently-executing script, leave it as FALSE.
-     * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE.
-     *
-     * @param bool $include_completed_scripts
-     * @return EE_Data_Migration_Script_Base
-     */
-    public function get_last_ran_script($include_completed_scripts = false)
-    {
-        // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script
-        if (! $this->_data_migrations_ran) {
-            $this->get_data_migrations_ran();
-        }
-        if ($include_completed_scripts) {
-            return $this->_last_ran_script;
-        } else {
-            return $this->_last_ran_incomplete_script;
-        }
-    }
-
-
-    /**
-     * Runs the data migration scripts (well, each request to this method calls one of the
-     * data migration scripts' migration_step() functions).
-     *
-     * @param int   $step_size
-     * @throws EE_Error
-     * @return array {
-     *                                  // where the first item is one EE_Data_Migration_Script_Base's stati,
-     *                                  //and the second item is a string describing what was done
-     * @type int    $records_to_migrate from the current migration script
-     * @type int    $records_migrated
-     * @type string $status             one of EE_Data_Migration_Manager::status_*
-     * @type string $script             verbose name of the current DMS
-     * @type string $message            string describing what was done during this step
-     *                                  }
-     */
-    public function migration_step($step_size = 0)
-    {
-
-        // bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535
-        if (class_exists('EE_CPT_Strategy')) {
-            remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5);
-        }
-
-        try {
-            $currently_executing_script = $this->get_last_ran_script();
-            if (! $currently_executing_script) {
-                // Find the next script that needs to execute
-                $scripts = $this->check_for_applicable_data_migration_scripts();
-                if (! $scripts) {
-                    // huh, no more scripts to run... apparently we're done!
-                    // but dont forget to make sure initial data is there
-                    // we should be good to allow them to exit maintenance mode now
-                    EE_Maintenance_Mode::instance()->set_maintenance_level(
-                        intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
-                    );
-                    // saving migrations ran should actually be unnecessary, but leaving in place just in case
-                    // remember this migration was finished (even if we timeout initing db for core and plugins)
-                    $this->_save_migrations_ran();
-                    // make sure DB was updated AFTER we've recorded the migration was done
-                    $this->initialize_db_for_enqueued_ee_plugins();
-                    return array(
-                        'records_to_migrate' => 1,
-                        'records_migrated'   => 1,
-                        'status'             => self::status_no_more_migration_scripts,
-                        'script'             => __("Data Migration Completed Successfully", "event_espresso"),
-                        'message'            => __("All done!", "event_espresso"),
-                    );
-                }
-                $currently_executing_script = array_shift($scripts);
-                // and add to the array/wp option showing the scripts ran
-
-                $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script));
-                $plugin_slug = $migrates_to['slug'];
-                $version = $migrates_to['version'];
-                $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
-            }
-            $current_script_name = get_class($currently_executing_script);
-        } catch (Exception $e) {
-            // an exception occurred while trying to get migration scripts
-
-            $message = sprintf(
-                __("Error Message: %sStack Trace:%s", "event_espresso"),
-                $e->getMessage() . '<br>',
-                $e->getTraceAsString()
-            );
-            // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations
-            // but that's ok-- it's just an FYI to support that we couldn't even run any data migrations
-            $this->add_error_to_migrations_ran(
-                sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message)
-            );
-            return array(
-                'records_to_migrate' => 1,
-                'records_migrated'   => 0,
-                'status'             => self::status_fatal_error,
-                'script'             => __("Error loading data migration scripts", "event_espresso"),
-                'message'            => $message,
-            );
-        }
-        // ok so we definitely have a data migration script
-        try {
-            // how big of a bite do we want to take? Allow users to easily override via their wp-config
-            if (absint($step_size) < 1) {
-                $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE)
-                    ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size;
-            }
-            // do what we came to do!
-            $currently_executing_script->migration_step($step_size);
-            // can we wrap it up and verify default data?
-            $init_dbs = false;
-            switch ($currently_executing_script->get_status()) {
-                case EE_Data_Migration_Manager::status_continue:
-                    $response_array = array(
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => EE_Data_Migration_Manager::status_continue,
-                        'message'            => $currently_executing_script->get_feedback_message(),
-                        'script'             => $currently_executing_script->pretty_name(),
-                    );
-                    break;
-                case EE_Data_Migration_Manager::status_completed:
-                    // ok so THAT script has completed
-                    $this->update_current_database_state_to($this->script_migrates_to_version($current_script_name));
-                    $response_array = array(
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => EE_Data_Migration_Manager::status_completed,
-                        'message'            => $currently_executing_script->get_feedback_message(),
-                        'script'             => sprintf(
-                            __("%s Completed", 'event_espresso'),
-                            $currently_executing_script->pretty_name()
-                        ),
-                    );
-                    // check if there are any more after this one.
-                    $scripts_remaining = $this->check_for_applicable_data_migration_scripts();
-                    if (! $scripts_remaining) {
-                        // we should be good to allow them to exit maintenance mode now
-                        EE_Maintenance_Mode::instance()->set_maintenance_level(
-                            intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
-                        );
-                        // huh, no more scripts to run... apparently we're done!
-                        // but dont forget to make sure initial data is there
-                        $init_dbs = true;
-                        $response_array['status'] = self::status_no_more_migration_scripts;
-                    }
-                    break;
-                default:
-                    $response_array = array(
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => $currently_executing_script->get_status(),
-                        'message'            => sprintf(
-                            __("Minor errors occurred during %s: %s", "event_espresso"),
-                            $currently_executing_script->pretty_name(),
-                            implode(", ", $currently_executing_script->get_errors())
-                        ),
-                        'script'             => $currently_executing_script->pretty_name(),
-                    );
-                    break;
-            }
-        } catch (Exception $e) {
-            // ok so some exception was thrown which killed the data migration script
-            // double-check we have a real script
-            if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) {
-                $script_name = $currently_executing_script->pretty_name();
-                $currently_executing_script->set_broken();
-                $currently_executing_script->add_error($e->getMessage());
-            } else {
-                $script_name = __("Error getting Migration Script", "event_espresso");
-            }
-            $response_array = array(
-                'records_to_migrate' => 1,
-                'records_migrated'   => 0,
-                'status'             => self::status_fatal_error,
-                'message'            => sprintf(
-                    __("A fatal error occurred during the migration: %s", "event_espresso"),
-                    $e->getMessage()
-                ),
-                'script'             => $script_name,
-            );
-        }
-        $successful_save = $this->_save_migrations_ran();
-        if ($successful_save !== true) {
-            // ok so the current wp option didn't save. that's tricky, because we'd like to update it
-            // and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION!
-            // however, if we throw an exception, and return that, then the next request
-            // won't have as much info in it, and it may be able to save
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.",
-                        "event_espresso"
-                    ),
-                    $successful_save
-                )
-            );
-        }
-        // if we're all done, initialize EE plugins' default data etc.
-        if ($init_dbs) {
-            $this->initialize_db_for_enqueued_ee_plugins();
-        }
-        return $response_array;
-    }
-
-
-    /**
-     * Echo out JSON response to migration script AJAX requests. Takes precautions
-     * to buffer output so that we don't throw junk into our json.
-     *
-     * @return array with keys:
-     * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie,
-     * it's NOT the count of hwo many remain)
-     * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete =
-     * records_migrated/records_to_migrate)
-     * 'status'=>a string, one of EE_Data_migration_Manager::status_*
-     * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into
-     * errors, notifications, and successes
-     * 'script'=>a pretty name of the script currently running
-     */
-    public function response_to_migration_ajax_request()
-    {
-        ob_start();
-        try {
-            $response = $this->migration_step();
-        } catch (Exception $e) {
-            $response = array(
-                'records_to_migrate' => 0,
-                'records_migrated'   => 0,
-                'status'             => EE_Data_Migration_Manager::status_fatal_error,
-                'message'            => sprintf(
-                    __("Unknown fatal error occurred: %s", "event_espresso"),
-                    $e->getMessage()
-                ),
-                'script'             => 'Unknown',
-            );
-            $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
-        }
-        $warnings_etc = @ob_get_contents();
-        ob_end_clean();
-        $response['message'] .= $warnings_etc;
-        return $response;
-    }
-
-    /**
-     * Updates the wordpress option that keeps track of which which EE version the database
-     * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35)
-     *
-     * @param array $slug_and_version {
-     * @type string $slug             like 'Core' or 'Calendar',
-     * @type string $version          like '4.1.0'
-     *                                }
-     * @return void
-     */
-    public function update_current_database_state_to($slug_and_version = null)
-    {
-        if (! $slug_and_version) {
-            // no version was provided, assume it should be at the current code version
-            $slug_and_version = array('slug' => 'Core', 'version' => espresso_version());
-        }
-        $current_database_state = get_option(self::current_database_state);
-        $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
-        update_option(self::current_database_state, $current_database_state);
-    }
-
-    /**
-     * Determines if the database is currently at a state matching what's indicated in $slug and $version.
-     *
-     * @param array $slug_and_version {
-     * @type string $slug             like 'Core' or 'Calendar',
-     * @type string $version          like '4.1.0'
-     *                                }
-     * @return boolean
-     */
-    public function database_needs_updating_to($slug_and_version)
-    {
-
-        $slug = $slug_and_version['slug'];
-        $version = $slug_and_version['version'];
-        $current_database_state = get_option(self::current_database_state);
-        if (! isset($current_database_state[ $slug ])) {
-            return true;
-        } else {
-            // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
-            $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
-            $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
-            $needs_updating = false;
-            foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
-                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
-                    $needs_updating = true;
-                    break;
-                }
-            }
-            return $needs_updating;
-        }
-    }
-
-
-    /**
-     * Gets all the data migration scripts available in the core folder and folders
-     * in addons. Has the side effect of adding them for autoloading
-     *
-     * @return array keys are expected classnames, values are their filepaths
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_all_data_migration_scripts_available()
-    {
-        if (! $this->_data_migration_class_to_filepath_map) {
-            $this->_data_migration_class_to_filepath_map = array();
-            foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
-                // strip any placeholders added to classname to make it a unique array key
-                $eeAddonClass = trim($eeAddonClass, '*');
-                $eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass)
-                    ? $eeAddonClass
-                    : '';
-                $folder_path = EEH_File::end_with_directory_separator($folder_path);
-                $files = glob($folder_path . '*.dms.php');
-                if (empty($files)) {
-                    continue;
-                }
-                foreach ($files as $file) {
-                    $pos_of_last_slash = strrpos($file, DS);
-                    $classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1));
-                    $migrates_to = $this->script_migrates_to_version($classname, $eeAddonClass);
-                    $slug = $migrates_to['slug'];
-                    // check that the slug as contained in the DMS is associated with
-                    // the slug of an addon or core
-                    if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) {
-                        EE_Error::doing_it_wrong(
-                            __FUNCTION__,
-                            sprintf(
-                                esc_html__(
-                                    'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ',
-                                    'event_espresso'
-                                ),
-                                $classname,
-                                $slug,
-                                implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name()))
-                            ),
-                            '4.3.0.alpha.019'
-                        );
-                    }
-                    $this->_data_migration_class_to_filepath_map[ $classname ] = $file;
-                }
-            }
-            EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
-        }
-        return $this->_data_migration_class_to_filepath_map;
-    }
-
-
-    /**
-     * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs
-     * from each addon, and check if they need updating,
-     *
-     * @return boolean
-     */
-    public function addons_need_updating()
-    {
-        return false;
-    }
-
-    /**
-     * Adds this error string to the data_migrations_ran array, but we dont necessarily know
-     * where to put it, so we just throw it in there... better than nothing...
-     *
-     * @param string $error_message
-     * @throws EE_Error
-     */
-    public function add_error_to_migrations_ran($error_message)
-    {
-        // get last-ran migration script
-        global $wpdb;
-        $last_migration_script_option = $wpdb->get_row(
-            "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1",
-            ARRAY_A
-        );
-
-        $last_ran_migration_script_properties = isset($last_migration_script_option['option_value'])
-            ? maybe_unserialize($last_migration_script_option['option_value']) : null;
-        // now, tread lightly because we're here because a FATAL non-catchable error
-        // was thrown last time when we were trying to run a data migration script
-        // so the fatal error could have happened while getting the migration script
-        // or doing running it...
-        $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace(
-            EE_Data_Migration_Manager::data_migration_script_option_prefix,
-            "",
-            $last_migration_script_option['option_name']
-        ) : null;
-
-        // check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet
-        // because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done)
-        if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) {
-            // ok then just add this error to its list of errors
-            $last_ran_migration_script_properties['_errors'][] = $error_message;
-            $last_ran_migration_script_properties['_status'] = self::status_fatal_error;
-        } else {
-            // so we don't even know which script was last running
-            // use the data migration error stub, which is designed specifically for this type of thing
-            $general_migration_error = new EE_DMS_Unknown_1_0_0();
-            $general_migration_error->add_error($error_message);
-            $general_migration_error->set_broken();
-            $last_ran_migration_script_properties = $general_migration_error->properties_as_array();
-            $versions_migrated_to = 'Unknown.1.0.0';
-            // now just to make sure appears as last (in case the were previously a fatal error like this)
-            // delete the old one
-            delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
-        }
-        update_option(
-            self::data_migration_script_option_prefix . $versions_migrated_to,
-            $last_ran_migration_script_properties
-        );
-    }
-
-    /**
-     * saves what data migrations have ran to the database
-     *
-     * @return mixed TRUE if successfully saved migrations ran, string if an error occurred
-     */
-    protected function _save_migrations_ran()
-    {
-        if ($this->_data_migrations_ran == null) {
-            $this->get_data_migrations_ran();
-        }
-        // now, we don't want to save actual classes to the DB because that's messy
-        $successful_updates = true;
-        foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
-            foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
-                $plugin_slug_for_use_in_option_name = $plugin_slug . ".";
-                $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
-                $old_option_value = get_option($option_name);
-                if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
-                    $script_array_for_saving = $array_or_migration_obj->properties_as_array();
-                    if ($old_option_value != $script_array_for_saving) {
-                        $successful_updates = update_option($option_name, $script_array_for_saving);
-                    }
-                } else {// we don't know what this array-thing is. So just save it as-is
-                    if ($old_option_value != $array_or_migration_obj) {
-                        $successful_updates = update_option($option_name, $array_or_migration_obj);
-                    }
-                }
-                if (! $successful_updates) {
-                    global $wpdb;
-                    return $wpdb->last_error;
-                }
-            }
-        }
-        return true;
-        // $updated = update_option(self::data_migrations_option_name, $array_of_migrations);
-        // if ($updated !== true) {
-        //     global $wpdb;
-        //     return $wpdb->last_error;
-        // } else {
-        //     return true;
-        // }
-        // wp_mail(
-        //     "michael@eventespresso.com",
-        //     time() . " price debug info",
-        //     "updated: $updated, last error: $last_error, byte length of option: " . strlen(
-        //         serialize($array_of_migrations)
-        //     )
-        // );
-    }
-
-    /**
-     * Takes an array of data migration script properties and re-creates the class from
-     * them. The argument $properties_array is assumed to have been made by
-     * EE_Data_Migration_Script_Base::properties_as_array()
-     *
-     * @param array $properties_array
-     * @return EE_Data_Migration_Script_Base
-     * @throws EE_Error
-     */
-    public function _instantiate_script_from_properties_array($properties_array)
-    {
-        if (! isset($properties_array['class'])) {
-            throw new EE_Error(
-                sprintf(
-                    __("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
-                    implode(",", $properties_array)
-                )
-            );
-        }
-        $class_name = $properties_array['class'];
-        if (! class_exists($class_name)) {
-            throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name));
-        }
-        $class = new $class_name;
-        if (! $class instanceof EE_Data_Migration_Script_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"),
-                    $class_name,
-                    get_class($class)
-                )
-            );
-        }
-        $class->instantiate_from_array_of_properties($properties_array);
-        return $class;
-    }
-
-    /**
-     * Gets the classname for the most up-to-date DMS (ie, the one that will finally
-     * leave the DB in a state usable by the current plugin code).
-     *
-     * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core'
-     * @return string
-     */
-    public function get_most_up_to_date_dms($plugin_slug = 'Core')
-    {
-        $class_to_filepath_map = $this->get_all_data_migration_scripts_available();
-        $most_up_to_date_dms_classname = null;
-        foreach ($class_to_filepath_map as $classname => $filepath) {
-            if ($most_up_to_date_dms_classname === null) {
-                $migrates_to = $this->script_migrates_to_version($classname);
-                $this_plugin_slug = $migrates_to['slug'];
-                if ($this_plugin_slug == $plugin_slug) {
-                    // if it's for core, it wins
-                    $most_up_to_date_dms_classname = $classname;
-                }
-                // if it wasn't for core, we must keep searching for one that is!
-                continue;
-            } else {
-                $champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname);
-                $contender_migrates_to = $this->script_migrates_to_version($classname);
-                if ($contender_migrates_to['slug'] == $plugin_slug
-                    && version_compare(
-                        $champion_migrates_to['version'],
-                        $contender_migrates_to['version'],
-                        '<'
-                    )) {
-                    // so the contenders version is higher and its for Core
-                    $most_up_to_date_dms_classname = $classname;
-                }
-            }
-        }
-        return $most_up_to_date_dms_classname;
-    }
-
-    /**
-     * Gets the migration script specified but ONLY if it has already ran.
-     *
-     * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has ran, you would run the following code:
-     * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !==
-     * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or
-     * other addon) DMS has ran, in case the current DMS depends on it.
-     *
-     * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
-     *                            period. Eg '4.1.0'
-     * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
-     * @return EE_Data_Migration_Script_Base
-     */
-    public function get_migration_ran($version, $plugin_slug = 'Core')
-    {
-        $migrations_ran = $this->get_data_migrations_ran();
-        if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
-            return $migrations_ran[ $plugin_slug ][ $version ];
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Resets the borked data migration scripts so they're no longer borked
-     * so we can again attempt to migrate
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function reattempt()
-    {
-        // find if the last-ran script was borked
-        // set it as being non-borked (we shouldn't ever get DMSs that we don't recognize)
-        // add an 'error' saying that we attempted to reset
-        // does it have a stage that was borked too? if so make it no longer borked
-        // add an 'error' saying we attempted to reset
-        $last_ran_script = $this->get_last_ran_script();
-        if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) {
-            // if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it)
-            $last_ran_script->set_completed();
-        } elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) {
-            $last_ran_script->reattempt();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s',
-                        'event_espresso'
-                    ),
-                    print_r($last_ran_script, true)
-                )
-            );
-        }
-        return $this->_save_migrations_ran();
-    }
-
-    /**
-     * Gets whether or not this particular migration has run or not
-     *
-     * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
-     *                            period. Eg '4.1.0'
-     * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
-     * @return boolean
-     */
-    public function migration_has_ran($version, $plugin_slug = 'Core')
-    {
-        return $this->get_migration_ran($version, $plugin_slug) !== null;
-    }
-
-    /**
-     * Enqueues this ee plugin to have its data initialized
-     *
-     * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value
-     */
-    public function enqueue_db_initialization_for($plugin_slug)
-    {
-        $queue = $this->get_db_initialization_queue();
-        if (! in_array($plugin_slug, $queue)) {
-            $queue[] = $plugin_slug;
-        }
-        update_option(self::db_init_queue_option_name, $queue);
-    }
-
-    /**
-     * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon
-     * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is
-     * in the queue, calls EE_System::initialize_db_if_no_migrations_required().
-     */
-    public function initialize_db_for_enqueued_ee_plugins()
-    {
-        $queue = $this->get_db_initialization_queue();
-        foreach ($queue as $plugin_slug) {
-            $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
-            if (! $most_up_to_date_dms) {
-                // if there is NO DMS for this plugin, obviously there's no schema to verify anyways
-                $verify_db = false;
-            } else {
-                $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms);
-                $verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to);
-            }
-            if ($plugin_slug == 'Core') {
-                EE_System::instance()->initialize_db_if_no_migrations_required(
-                    false,
-                    $verify_db
-                );
-            } else {
-                // just loop through the addons to make sure their database is setup
-                foreach (EE_Registry::instance()->addons as $addon) {
-                    if ($addon->name() == $plugin_slug) {
-                        $addon->initialize_db_if_no_migrations_required($verify_db);
-                        break;
-                    }
-                }
-            }
-        }
-        // because we just initialized the DBs for the enqueued ee plugins
-        // we don't need to keep remembering which ones needed to be initialized
-        delete_option(self::db_init_queue_option_name);
-    }
-
-    /**
-     * Gets a numerically-indexed array of plugin slugs that need to have their databases
-     * (re-)initialized after migrations are complete. ie, each element should be either
-     * 'Core', or the return value of EE_Addon::name() for an addon
-     *
-     * @return array
-     */
-    public function get_db_initialization_queue()
-    {
-        return get_option(self::db_init_queue_option_name, array());
-    }
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-    /**
-     * Gets the injected table manager, or throws an exception
-     *
-     * @return TableManager
-     * @throws EE_Error
-     */
-    protected function _get_table_manager()
-    {
-        if ($this->_table_manager instanceof TableManager) {
-            return $this->_table_manager;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table manager class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 *
+	 * @var EE_Registry
+	 */
+	// protected $EE;
+	/**
+	 * name of the wordpress option which stores an array of data about
+	 */
+	const data_migrations_option_name = 'ee_data_migration';
+
+
+	const data_migration_script_option_prefix = 'ee_data_migration_script_';
+
+	const data_migration_script_mapping_option_prefix = 'ee_dms_map_';
+
+	/**
+	 * name of the wordpress option which stores the database' current version. IE, the code may be at version 4.2.0,
+	 * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc.
+	 */
+	const current_database_state = 'ee_data_migration_current_db_state';
+
+	/**
+	 * Special status string returned when we're positive there are no more data migration
+	 * scripts that can be run.
+	 */
+	const status_no_more_migration_scripts = 'no_more_migration_scripts';
+	/**
+	 * string indicating the migration should continue
+	 */
+	const status_continue = 'status_continue';
+	/**
+	 * string indicating the migration has completed and should be ended
+	 */
+	const status_completed = 'status_completed';
+	/**
+	 * string indicating a fatal error occurred and the data migration should be completely aborted
+	 */
+	const status_fatal_error = 'status_fatal_error';
+
+	/**
+	 * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent
+	 * during migration)
+	 */
+	const step_size = 50;
+
+	/**
+	 * option name that stores the queue of ee plugins needing to have
+	 * their data initialized (or re-initialized) once we are done migrations
+	 */
+	const db_init_queue_option_name = 'ee_db_init_queue';
+	/**
+	 * Array of information concerning data migrations that have ran in the history
+	 * of this EE installation. Keys should be the name of the version the script upgraded to
+	 *
+	 * @var EE_Data_Migration_Script_Base[]
+	 */
+	private $_data_migrations_ran = null;
+	/**
+	 * The last ran script. It's nice to store this somewhere accessible, as its easiest
+	 * to know which was the last run by which is the newest wp option; but in most of the code
+	 * we just use the local $_data_migration_ran array, which organized the scripts differently
+	 *
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	private $_last_ran_script = null;
+
+	/**
+	 * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script.
+	 *
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	private $_last_ran_incomplete_script = null;
+	/**
+	 * array where keys are classnames, and values are filepaths of all the known migration scripts
+	 *
+	 * @var array
+	 */
+	private $_data_migration_class_to_filepath_map;
+
+	/**
+	 * the following 4 properties are fully set on construction.
+	 * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished
+	 * one, we may want to start the next one); whereas the last two indicate whether to continue running a single
+	 * data migration script
+	 *
+	 * @var array
+	 */
+	public $stati_that_indicate_to_continue_migrations = array();
+
+	public $stati_that_indicate_to_stop_migrations = array();
+
+	public $stati_that_indicate_to_continue_single_migration_script = array();
+
+	public $stati_that_indicate_to_stop_single_migration_script = array();
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	protected $_table_manager;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+	/**
+	 * @var array $script_migration_versions
+	 */
+	protected $script_migration_versions;
+
+	/**
+	 * @var EE_Data_Migration_Manager $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Data_Migration_Manager instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Data_Migration_Manager) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning,
+	 * all new usages of the singleton should be made with Classname::instance()) and returns it
+	 *
+	 * @return EE_Data_Migration_Manager
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * constructor
+	 */
+	private function __construct()
+	{
+		$this->stati_that_indicate_to_continue_migrations = array(
+			self::status_continue,
+			self::status_completed,
+		);
+		$this->stati_that_indicate_to_stop_migrations = array(
+			self::status_fatal_error,
+			self::status_no_more_migration_scripts,
+		);
+		$this->stati_that_indicate_to_continue_single_migration_script = array(
+			self::status_continue,
+		);
+		$this->stati_that_indicate_to_stop_single_migration_script = array(
+			self::status_completed,
+			self::status_fatal_error
+			// note: status_no_more_migration_scripts doesn't apply
+		);
+		// make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class
+		// to be defined, because right now it doesn't get autoloaded on its own
+		EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), true);
+		EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), true);
+		$this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true);
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+	}
+
+
+	/**
+	 * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what
+	 * the option names are like, but generally they're like
+	 * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that).
+	 * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived,
+	 * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php (eg
+	 * EE_DMS_Core_4_1_0.dms.php)
+	 *
+	 * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set)
+	 * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of
+	 *               that plugin (eg '4.1.0')
+	 */
+	private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name)
+	{
+		$plugin_slug_and_version_string = str_replace(
+			EE_Data_Migration_Manager::data_migration_script_option_prefix,
+			"",
+			$option_name
+		);
+		// check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style)
+		$parts = explode(".", $plugin_slug_and_version_string);
+
+		if (count($parts) == 4) {
+			// it's 4.2-style.eg Core.4.1.0
+			$plugin_slug = $parts[0];// eg Core
+			$version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
+		} else {
+			// it's 4.1-style: eg 4.1.0
+			$plugin_slug = 'Core';
+			$version_string = $plugin_slug_and_version_string;// eg 4.1.0
+		}
+		return array($plugin_slug, $version_string);
+	}
+
+	/**
+	 * Gets the DMS class from the wordpress option, otherwise throws an EE_Error if it's not
+	 * for a known DMS class.
+	 *
+	 * @param string $dms_option_name
+	 * @param string $dms_option_value (serialized)
+	 * @return EE_Data_Migration_Script_Base
+	 * @throws EE_Error
+	 */
+	private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value)
+	{
+		$data_migration_data = maybe_unserialize($dms_option_value);
+		if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) {
+			$class = new $data_migration_data['class'];
+			if ($class instanceof EE_Data_Migration_Script_Base) {
+				$class->instantiate_from_array_of_properties($data_migration_data);
+				return $class;
+			} else {
+				// huh, so its an object but not a data migration script?? that shouldn't happen
+				// just leave it as an array (which will probably just get ignored)
+				throw new EE_Error(
+					sprintf(
+						__(
+							"Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists",
+							'event_espresso'
+						),
+						$data_migration_data['class']
+					)
+				);
+			}
+		} else {
+			// so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists
+			throw new EE_Error(
+				sprintf(__("The wp option  with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name)
+			);
+		}
+	}
+
+	/**
+	 * Gets the array describing what data migrations have run. Also has a side-effect of recording which was the last
+	 * ran, and which was the last ran which hasn't finished yet
+	 *
+	 * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy
+	 *               arrays in there - which should probably be ignored)
+	 */
+	public function get_data_migrations_ran()
+	{
+		if (! $this->_data_migrations_ran) {
+			// setup autoloaders for each of the scripts in there
+			$this->get_all_data_migration_scripts_available();
+			$data_migrations_options = $this->get_all_migration_script_options(
+			);// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
+
+			$data_migrations_ran = array();
+			// convert into data migration script classes where possible
+			foreach ($data_migrations_options as $data_migration_option) {
+				list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name(
+					$data_migration_option['option_name']
+				);
+
+				try {
+					$class = $this->_get_dms_class_from_wp_option(
+						$data_migration_option['option_name'],
+						$data_migration_option['option_value']
+					);
+					$data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
+					// ok so far THIS is the 'last-ran-script'... unless we find another on next iteration
+					$this->_last_ran_script = $class;
+					if (! $class->is_completed()) {
+						// sometimes we also like to know which was the last incomplete script (or if there are any at all)
+						$this->_last_ran_incomplete_script = $class;
+					}
+				} catch (EE_Error $e) {
+					// ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs
+					$data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
+						$data_migration_option['option_value']
+					);
+				}
+			}
+			// so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
+			$this->_data_migrations_ran = $data_migrations_ran;
+			if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
+				$this->_data_migrations_ran = array();
+			}
+		}
+		return $this->_data_migrations_ran;
+	}
+
+
+	/**
+	 *
+	 * @param string $script_name eg 'DMS_Core_4_1_0'
+	 * @param string $old_table   eg 'wp_events_detail'
+	 * @param string $old_pk      eg 'wp_esp_posts'
+	 * @param        $new_table
+	 * @return mixed string or int
+	 */
+	public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table)
+	{
+		$script = EE_Registry::instance()->load_dms($script_name);
+		$mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table);
+		return $mapping;
+	}
+
+	/**
+	 * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that
+	 * the last option returned in this array is the most-recently ran DMS option
+	 *
+	 * @return array
+	 */
+	public function get_all_migration_script_options()
+	{
+		global $wpdb;
+		return $wpdb->get_results(
+			"SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC",
+			ARRAY_A
+		);
+	}
+
+	/**
+	 * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded
+	 *
+	 * @return array where each value is the full folder path of a folder containing data migration scripts, WITH
+	 *               slashes at the end of the folder name.
+	 */
+	public function get_data_migration_script_folders()
+	{
+		return apply_filters(
+			'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
+			array('Core' => EE_CORE . 'data_migration_scripts')
+		);
+	}
+
+	/**
+	 * Gets the version the migration script upgrades to
+	 *
+	 * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0'
+	 * @return array {
+	 * @type string  $slug                  like 'Core','Calendar',etc
+	 * @type string  $version               like 4.3.0
+	 *                                      }
+	 * @throws EE_Error
+	 */
+	public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
+	{
+		if (isset($this->script_migration_versions[ $migration_script_name ])) {
+			return $this->script_migration_versions[ $migration_script_name ];
+		}
+		$dms_info = $this->parse_dms_classname($migration_script_name);
+		$this->script_migration_versions[ $migration_script_name ] = array(
+			'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
+			'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'],
+		);
+		return $this->script_migration_versions[ $migration_script_name ];
+	}
+
+	/**
+	 * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0'
+	 *
+	 * @param string $classname
+	 * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints)
+	 * @throws EE_Error
+	 */
+	public function parse_dms_classname($classname)
+	{
+		$matches = array();
+		preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
+		if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ",
+						"event_espresso"
+					),
+					$classname
+				)
+			);
+		}
+		return array(
+			'slug'          => $matches[1],
+			'major_version' => intval($matches[2]),
+			'minor_version' => intval($matches[3]),
+			'micro_version' => intval($matches[4]),
+		);
+	}
+
+	/**
+	 * Ensures that the option indicating the current DB version is set. This should only be
+	 * a concern when activating EE for the first time, THEORETICALLY.
+	 * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise
+	 * to 4.1.x.
+	 *
+	 * @return string of current db state
+	 */
+	public function ensure_current_database_state_is_set()
+	{
+		$espresso_db_core_updates = get_option('espresso_db_update', array());
+		$db_state = get_option(EE_Data_Migration_Manager::current_database_state);
+		if (! $db_state) {
+			// mark the DB as being in the state as the last version in there.
+			// this is done to trigger maintenance mode and do data migration scripts
+			// if the admin installed this version of EE over 3.1.x or 4.0.x
+			// otherwise, the normal maintenance mode code is fine
+			$previous_versions_installed = array_keys($espresso_db_core_updates);
+			$previous_version_installed = end($previous_versions_installed);
+			if (version_compare('4.1.0', $previous_version_installed)) {
+				// last installed version was less than 4.1
+				// so we want the data migrations to happen. SO, we're going to say the DB is at that state
+				$db_state = array('Core' => $previous_version_installed);
+			} else {
+				$db_state = array('Core' => EVENT_ESPRESSO_VERSION);
+			}
+			update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
+		}
+		// in 4.1, $db_state would have only been a simple string like '4.1.0',
+		// but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
+		// db, and possibly other keys for other addons like 'Calendar','Permissions',etc
+		if (! is_array($db_state)) {
+			$db_state = array('Core' => $db_state);
+			update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
+		}
+		return $db_state;
+	}
+
+	/**
+	 * Checks if there are any data migration scripts that ought to be run. If found,
+	 * returns the instantiated classes. If none are found (ie, they've all already been run
+	 * or they don't apply), returns an empty array
+	 *
+	 * @return EE_Data_Migration_Script_Base[]
+	 */
+	public function check_for_applicable_data_migration_scripts()
+	{
+		// get the option describing what options have already run
+		$scripts_ran = $this->get_data_migrations_ran();
+		// $scripts_ran = array('4.1.0.core'=>array('monkey'=>null));
+		$script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available();
+
+
+		$current_database_state = $this->ensure_current_database_state_is_set();
+		// determine which have already been run
+		$script_classes_that_should_run_per_iteration = array();
+		$iteration = 0;
+		$next_database_state_to_consider = $current_database_state;
+		$theoretical_database_state = null;
+		do {
+			// the next state after the currently-considered one will start off looking the same as the current, but we may make additions...
+			$theoretical_database_state = $next_database_state_to_consider;
+			// the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?)
+			foreach ($script_class_and_filepaths_available as $classname => $filepath) {
+				$migrates_to_version = $this->script_migrates_to_version($classname);
+				$script_converts_plugin_slug = $migrates_to_version['slug'];
+				$script_converts_to_version = $migrates_to_version['version'];
+				// check if this version script is DONE or not; or if it's never been ran
+				if (! $scripts_ran ||
+					! isset($scripts_ran[ $script_converts_plugin_slug ]) ||
+					! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) {
+					// we haven't ran this conversion script before
+					// now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available
+					$script = new $classname($this->_get_table_manager(), $this->_get_table_analysis());
+					/* @var $script EE_Data_Migration_Script_Base */
+					$can_migrate = $script->can_migrate_from_version($theoretical_database_state);
+					if ($can_migrate) {
+						$script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+						$migrates_to_version = $script->migrates_to_version();
+						$next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
+						unset($script_class_and_filepaths_available[ $classname ]);
+					}
+				} elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) {
+					// this script has been ran, or at least started
+					$script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
+					if ($script->get_status() != self::status_completed) {
+						// this script is already underway... keep going with it
+						$script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+						$migrates_to_version = $script->migrates_to_version();
+						$next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
+						unset($script_class_and_filepaths_available[ $classname ]);
+					} else {
+						// it must have a status that indicates it has finished, so we don't want to try and run it again
+					}
+				} else {
+					// it exists but it's not  a proper data migration script
+					// maybe the script got renamed? or was simply removed from EE?
+					// either way, its certainly not runnable!
+				}
+			}
+			$iteration++;
+		} while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6);
+		// ok we have all the scripts that should run, now let's make them into flat array
+		$scripts_that_should_run = array();
+		foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
+			ksort($scripts_at_priority);
+			foreach ($scripts_at_priority as $scripts) {
+				foreach ($scripts as $script) {
+					$scripts_that_should_run[ get_class($script) ] = $script;
+				}
+			}
+		}
+
+		do_action(
+			'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run',
+			$scripts_that_should_run
+		);
+		return $scripts_that_should_run;
+	}
+
+
+	/**
+	 * Gets the script which is currently being ran, if there is one. If $include_completed_scripts is set to TRUE
+	 * it will return the last ran script even if its complete.
+	 * This means: if you want to find the currently-executing script, leave it as FALSE.
+	 * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE.
+	 *
+	 * @param bool $include_completed_scripts
+	 * @return EE_Data_Migration_Script_Base
+	 */
+	public function get_last_ran_script($include_completed_scripts = false)
+	{
+		// make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script
+		if (! $this->_data_migrations_ran) {
+			$this->get_data_migrations_ran();
+		}
+		if ($include_completed_scripts) {
+			return $this->_last_ran_script;
+		} else {
+			return $this->_last_ran_incomplete_script;
+		}
+	}
+
+
+	/**
+	 * Runs the data migration scripts (well, each request to this method calls one of the
+	 * data migration scripts' migration_step() functions).
+	 *
+	 * @param int   $step_size
+	 * @throws EE_Error
+	 * @return array {
+	 *                                  // where the first item is one EE_Data_Migration_Script_Base's stati,
+	 *                                  //and the second item is a string describing what was done
+	 * @type int    $records_to_migrate from the current migration script
+	 * @type int    $records_migrated
+	 * @type string $status             one of EE_Data_Migration_Manager::status_*
+	 * @type string $script             verbose name of the current DMS
+	 * @type string $message            string describing what was done during this step
+	 *                                  }
+	 */
+	public function migration_step($step_size = 0)
+	{
+
+		// bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535
+		if (class_exists('EE_CPT_Strategy')) {
+			remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5);
+		}
+
+		try {
+			$currently_executing_script = $this->get_last_ran_script();
+			if (! $currently_executing_script) {
+				// Find the next script that needs to execute
+				$scripts = $this->check_for_applicable_data_migration_scripts();
+				if (! $scripts) {
+					// huh, no more scripts to run... apparently we're done!
+					// but dont forget to make sure initial data is there
+					// we should be good to allow them to exit maintenance mode now
+					EE_Maintenance_Mode::instance()->set_maintenance_level(
+						intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
+					);
+					// saving migrations ran should actually be unnecessary, but leaving in place just in case
+					// remember this migration was finished (even if we timeout initing db for core and plugins)
+					$this->_save_migrations_ran();
+					// make sure DB was updated AFTER we've recorded the migration was done
+					$this->initialize_db_for_enqueued_ee_plugins();
+					return array(
+						'records_to_migrate' => 1,
+						'records_migrated'   => 1,
+						'status'             => self::status_no_more_migration_scripts,
+						'script'             => __("Data Migration Completed Successfully", "event_espresso"),
+						'message'            => __("All done!", "event_espresso"),
+					);
+				}
+				$currently_executing_script = array_shift($scripts);
+				// and add to the array/wp option showing the scripts ran
+
+				$migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script));
+				$plugin_slug = $migrates_to['slug'];
+				$version = $migrates_to['version'];
+				$this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
+			}
+			$current_script_name = get_class($currently_executing_script);
+		} catch (Exception $e) {
+			// an exception occurred while trying to get migration scripts
+
+			$message = sprintf(
+				__("Error Message: %sStack Trace:%s", "event_espresso"),
+				$e->getMessage() . '<br>',
+				$e->getTraceAsString()
+			);
+			// record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations
+			// but that's ok-- it's just an FYI to support that we couldn't even run any data migrations
+			$this->add_error_to_migrations_ran(
+				sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message)
+			);
+			return array(
+				'records_to_migrate' => 1,
+				'records_migrated'   => 0,
+				'status'             => self::status_fatal_error,
+				'script'             => __("Error loading data migration scripts", "event_espresso"),
+				'message'            => $message,
+			);
+		}
+		// ok so we definitely have a data migration script
+		try {
+			// how big of a bite do we want to take? Allow users to easily override via their wp-config
+			if (absint($step_size) < 1) {
+				$step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE)
+					? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size;
+			}
+			// do what we came to do!
+			$currently_executing_script->migration_step($step_size);
+			// can we wrap it up and verify default data?
+			$init_dbs = false;
+			switch ($currently_executing_script->get_status()) {
+				case EE_Data_Migration_Manager::status_continue:
+					$response_array = array(
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => EE_Data_Migration_Manager::status_continue,
+						'message'            => $currently_executing_script->get_feedback_message(),
+						'script'             => $currently_executing_script->pretty_name(),
+					);
+					break;
+				case EE_Data_Migration_Manager::status_completed:
+					// ok so THAT script has completed
+					$this->update_current_database_state_to($this->script_migrates_to_version($current_script_name));
+					$response_array = array(
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => EE_Data_Migration_Manager::status_completed,
+						'message'            => $currently_executing_script->get_feedback_message(),
+						'script'             => sprintf(
+							__("%s Completed", 'event_espresso'),
+							$currently_executing_script->pretty_name()
+						),
+					);
+					// check if there are any more after this one.
+					$scripts_remaining = $this->check_for_applicable_data_migration_scripts();
+					if (! $scripts_remaining) {
+						// we should be good to allow them to exit maintenance mode now
+						EE_Maintenance_Mode::instance()->set_maintenance_level(
+							intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
+						);
+						// huh, no more scripts to run... apparently we're done!
+						// but dont forget to make sure initial data is there
+						$init_dbs = true;
+						$response_array['status'] = self::status_no_more_migration_scripts;
+					}
+					break;
+				default:
+					$response_array = array(
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => $currently_executing_script->get_status(),
+						'message'            => sprintf(
+							__("Minor errors occurred during %s: %s", "event_espresso"),
+							$currently_executing_script->pretty_name(),
+							implode(", ", $currently_executing_script->get_errors())
+						),
+						'script'             => $currently_executing_script->pretty_name(),
+					);
+					break;
+			}
+		} catch (Exception $e) {
+			// ok so some exception was thrown which killed the data migration script
+			// double-check we have a real script
+			if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) {
+				$script_name = $currently_executing_script->pretty_name();
+				$currently_executing_script->set_broken();
+				$currently_executing_script->add_error($e->getMessage());
+			} else {
+				$script_name = __("Error getting Migration Script", "event_espresso");
+			}
+			$response_array = array(
+				'records_to_migrate' => 1,
+				'records_migrated'   => 0,
+				'status'             => self::status_fatal_error,
+				'message'            => sprintf(
+					__("A fatal error occurred during the migration: %s", "event_espresso"),
+					$e->getMessage()
+				),
+				'script'             => $script_name,
+			);
+		}
+		$successful_save = $this->_save_migrations_ran();
+		if ($successful_save !== true) {
+			// ok so the current wp option didn't save. that's tricky, because we'd like to update it
+			// and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION!
+			// however, if we throw an exception, and return that, then the next request
+			// won't have as much info in it, and it may be able to save
+			throw new EE_Error(
+				sprintf(
+					__(
+						"The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.",
+						"event_espresso"
+					),
+					$successful_save
+				)
+			);
+		}
+		// if we're all done, initialize EE plugins' default data etc.
+		if ($init_dbs) {
+			$this->initialize_db_for_enqueued_ee_plugins();
+		}
+		return $response_array;
+	}
+
+
+	/**
+	 * Echo out JSON response to migration script AJAX requests. Takes precautions
+	 * to buffer output so that we don't throw junk into our json.
+	 *
+	 * @return array with keys:
+	 * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie,
+	 * it's NOT the count of hwo many remain)
+	 * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete =
+	 * records_migrated/records_to_migrate)
+	 * 'status'=>a string, one of EE_Data_migration_Manager::status_*
+	 * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into
+	 * errors, notifications, and successes
+	 * 'script'=>a pretty name of the script currently running
+	 */
+	public function response_to_migration_ajax_request()
+	{
+		ob_start();
+		try {
+			$response = $this->migration_step();
+		} catch (Exception $e) {
+			$response = array(
+				'records_to_migrate' => 0,
+				'records_migrated'   => 0,
+				'status'             => EE_Data_Migration_Manager::status_fatal_error,
+				'message'            => sprintf(
+					__("Unknown fatal error occurred: %s", "event_espresso"),
+					$e->getMessage()
+				),
+				'script'             => 'Unknown',
+			);
+			$this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
+		}
+		$warnings_etc = @ob_get_contents();
+		ob_end_clean();
+		$response['message'] .= $warnings_etc;
+		return $response;
+	}
+
+	/**
+	 * Updates the wordpress option that keeps track of which which EE version the database
+	 * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35)
+	 *
+	 * @param array $slug_and_version {
+	 * @type string $slug             like 'Core' or 'Calendar',
+	 * @type string $version          like '4.1.0'
+	 *                                }
+	 * @return void
+	 */
+	public function update_current_database_state_to($slug_and_version = null)
+	{
+		if (! $slug_and_version) {
+			// no version was provided, assume it should be at the current code version
+			$slug_and_version = array('slug' => 'Core', 'version' => espresso_version());
+		}
+		$current_database_state = get_option(self::current_database_state);
+		$current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
+		update_option(self::current_database_state, $current_database_state);
+	}
+
+	/**
+	 * Determines if the database is currently at a state matching what's indicated in $slug and $version.
+	 *
+	 * @param array $slug_and_version {
+	 * @type string $slug             like 'Core' or 'Calendar',
+	 * @type string $version          like '4.1.0'
+	 *                                }
+	 * @return boolean
+	 */
+	public function database_needs_updating_to($slug_and_version)
+	{
+
+		$slug = $slug_and_version['slug'];
+		$version = $slug_and_version['version'];
+		$current_database_state = get_option(self::current_database_state);
+		if (! isset($current_database_state[ $slug ])) {
+			return true;
+		} else {
+			// just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
+			$version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
+			$version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
+			$needs_updating = false;
+			foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
+				if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
+					$needs_updating = true;
+					break;
+				}
+			}
+			return $needs_updating;
+		}
+	}
+
+
+	/**
+	 * Gets all the data migration scripts available in the core folder and folders
+	 * in addons. Has the side effect of adding them for autoloading
+	 *
+	 * @return array keys are expected classnames, values are their filepaths
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_all_data_migration_scripts_available()
+	{
+		if (! $this->_data_migration_class_to_filepath_map) {
+			$this->_data_migration_class_to_filepath_map = array();
+			foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
+				// strip any placeholders added to classname to make it a unique array key
+				$eeAddonClass = trim($eeAddonClass, '*');
+				$eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass)
+					? $eeAddonClass
+					: '';
+				$folder_path = EEH_File::end_with_directory_separator($folder_path);
+				$files = glob($folder_path . '*.dms.php');
+				if (empty($files)) {
+					continue;
+				}
+				foreach ($files as $file) {
+					$pos_of_last_slash = strrpos($file, DS);
+					$classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1));
+					$migrates_to = $this->script_migrates_to_version($classname, $eeAddonClass);
+					$slug = $migrates_to['slug'];
+					// check that the slug as contained in the DMS is associated with
+					// the slug of an addon or core
+					if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) {
+						EE_Error::doing_it_wrong(
+							__FUNCTION__,
+							sprintf(
+								esc_html__(
+									'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ',
+									'event_espresso'
+								),
+								$classname,
+								$slug,
+								implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name()))
+							),
+							'4.3.0.alpha.019'
+						);
+					}
+					$this->_data_migration_class_to_filepath_map[ $classname ] = $file;
+				}
+			}
+			EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
+		}
+		return $this->_data_migration_class_to_filepath_map;
+	}
+
+
+	/**
+	 * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs
+	 * from each addon, and check if they need updating,
+	 *
+	 * @return boolean
+	 */
+	public function addons_need_updating()
+	{
+		return false;
+	}
+
+	/**
+	 * Adds this error string to the data_migrations_ran array, but we dont necessarily know
+	 * where to put it, so we just throw it in there... better than nothing...
+	 *
+	 * @param string $error_message
+	 * @throws EE_Error
+	 */
+	public function add_error_to_migrations_ran($error_message)
+	{
+		// get last-ran migration script
+		global $wpdb;
+		$last_migration_script_option = $wpdb->get_row(
+			"SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1",
+			ARRAY_A
+		);
+
+		$last_ran_migration_script_properties = isset($last_migration_script_option['option_value'])
+			? maybe_unserialize($last_migration_script_option['option_value']) : null;
+		// now, tread lightly because we're here because a FATAL non-catchable error
+		// was thrown last time when we were trying to run a data migration script
+		// so the fatal error could have happened while getting the migration script
+		// or doing running it...
+		$versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace(
+			EE_Data_Migration_Manager::data_migration_script_option_prefix,
+			"",
+			$last_migration_script_option['option_name']
+		) : null;
+
+		// check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet
+		// because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done)
+		if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) {
+			// ok then just add this error to its list of errors
+			$last_ran_migration_script_properties['_errors'][] = $error_message;
+			$last_ran_migration_script_properties['_status'] = self::status_fatal_error;
+		} else {
+			// so we don't even know which script was last running
+			// use the data migration error stub, which is designed specifically for this type of thing
+			$general_migration_error = new EE_DMS_Unknown_1_0_0();
+			$general_migration_error->add_error($error_message);
+			$general_migration_error->set_broken();
+			$last_ran_migration_script_properties = $general_migration_error->properties_as_array();
+			$versions_migrated_to = 'Unknown.1.0.0';
+			// now just to make sure appears as last (in case the were previously a fatal error like this)
+			// delete the old one
+			delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
+		}
+		update_option(
+			self::data_migration_script_option_prefix . $versions_migrated_to,
+			$last_ran_migration_script_properties
+		);
+	}
+
+	/**
+	 * saves what data migrations have ran to the database
+	 *
+	 * @return mixed TRUE if successfully saved migrations ran, string if an error occurred
+	 */
+	protected function _save_migrations_ran()
+	{
+		if ($this->_data_migrations_ran == null) {
+			$this->get_data_migrations_ran();
+		}
+		// now, we don't want to save actual classes to the DB because that's messy
+		$successful_updates = true;
+		foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
+			foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
+				$plugin_slug_for_use_in_option_name = $plugin_slug . ".";
+				$option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
+				$old_option_value = get_option($option_name);
+				if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
+					$script_array_for_saving = $array_or_migration_obj->properties_as_array();
+					if ($old_option_value != $script_array_for_saving) {
+						$successful_updates = update_option($option_name, $script_array_for_saving);
+					}
+				} else {// we don't know what this array-thing is. So just save it as-is
+					if ($old_option_value != $array_or_migration_obj) {
+						$successful_updates = update_option($option_name, $array_or_migration_obj);
+					}
+				}
+				if (! $successful_updates) {
+					global $wpdb;
+					return $wpdb->last_error;
+				}
+			}
+		}
+		return true;
+		// $updated = update_option(self::data_migrations_option_name, $array_of_migrations);
+		// if ($updated !== true) {
+		//     global $wpdb;
+		//     return $wpdb->last_error;
+		// } else {
+		//     return true;
+		// }
+		// wp_mail(
+		//     "michael@eventespresso.com",
+		//     time() . " price debug info",
+		//     "updated: $updated, last error: $last_error, byte length of option: " . strlen(
+		//         serialize($array_of_migrations)
+		//     )
+		// );
+	}
+
+	/**
+	 * Takes an array of data migration script properties and re-creates the class from
+	 * them. The argument $properties_array is assumed to have been made by
+	 * EE_Data_Migration_Script_Base::properties_as_array()
+	 *
+	 * @param array $properties_array
+	 * @return EE_Data_Migration_Script_Base
+	 * @throws EE_Error
+	 */
+	public function _instantiate_script_from_properties_array($properties_array)
+	{
+		if (! isset($properties_array['class'])) {
+			throw new EE_Error(
+				sprintf(
+					__("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
+					implode(",", $properties_array)
+				)
+			);
+		}
+		$class_name = $properties_array['class'];
+		if (! class_exists($class_name)) {
+			throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name));
+		}
+		$class = new $class_name;
+		if (! $class instanceof EE_Data_Migration_Script_Base) {
+			throw new EE_Error(
+				sprintf(
+					__("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"),
+					$class_name,
+					get_class($class)
+				)
+			);
+		}
+		$class->instantiate_from_array_of_properties($properties_array);
+		return $class;
+	}
+
+	/**
+	 * Gets the classname for the most up-to-date DMS (ie, the one that will finally
+	 * leave the DB in a state usable by the current plugin code).
+	 *
+	 * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core'
+	 * @return string
+	 */
+	public function get_most_up_to_date_dms($plugin_slug = 'Core')
+	{
+		$class_to_filepath_map = $this->get_all_data_migration_scripts_available();
+		$most_up_to_date_dms_classname = null;
+		foreach ($class_to_filepath_map as $classname => $filepath) {
+			if ($most_up_to_date_dms_classname === null) {
+				$migrates_to = $this->script_migrates_to_version($classname);
+				$this_plugin_slug = $migrates_to['slug'];
+				if ($this_plugin_slug == $plugin_slug) {
+					// if it's for core, it wins
+					$most_up_to_date_dms_classname = $classname;
+				}
+				// if it wasn't for core, we must keep searching for one that is!
+				continue;
+			} else {
+				$champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname);
+				$contender_migrates_to = $this->script_migrates_to_version($classname);
+				if ($contender_migrates_to['slug'] == $plugin_slug
+					&& version_compare(
+						$champion_migrates_to['version'],
+						$contender_migrates_to['version'],
+						'<'
+					)) {
+					// so the contenders version is higher and its for Core
+					$most_up_to_date_dms_classname = $classname;
+				}
+			}
+		}
+		return $most_up_to_date_dms_classname;
+	}
+
+	/**
+	 * Gets the migration script specified but ONLY if it has already ran.
+	 *
+	 * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has ran, you would run the following code:
+	 * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !==
+	 * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or
+	 * other addon) DMS has ran, in case the current DMS depends on it.
+	 *
+	 * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
+	 *                            period. Eg '4.1.0'
+	 * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
+	 * @return EE_Data_Migration_Script_Base
+	 */
+	public function get_migration_ran($version, $plugin_slug = 'Core')
+	{
+		$migrations_ran = $this->get_data_migrations_ran();
+		if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
+			return $migrations_ran[ $plugin_slug ][ $version ];
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Resets the borked data migration scripts so they're no longer borked
+	 * so we can again attempt to migrate
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function reattempt()
+	{
+		// find if the last-ran script was borked
+		// set it as being non-borked (we shouldn't ever get DMSs that we don't recognize)
+		// add an 'error' saying that we attempted to reset
+		// does it have a stage that was borked too? if so make it no longer borked
+		// add an 'error' saying we attempted to reset
+		$last_ran_script = $this->get_last_ran_script();
+		if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) {
+			// if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it)
+			$last_ran_script->set_completed();
+		} elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) {
+			$last_ran_script->reattempt();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s',
+						'event_espresso'
+					),
+					print_r($last_ran_script, true)
+				)
+			);
+		}
+		return $this->_save_migrations_ran();
+	}
+
+	/**
+	 * Gets whether or not this particular migration has run or not
+	 *
+	 * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
+	 *                            period. Eg '4.1.0'
+	 * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
+	 * @return boolean
+	 */
+	public function migration_has_ran($version, $plugin_slug = 'Core')
+	{
+		return $this->get_migration_ran($version, $plugin_slug) !== null;
+	}
+
+	/**
+	 * Enqueues this ee plugin to have its data initialized
+	 *
+	 * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value
+	 */
+	public function enqueue_db_initialization_for($plugin_slug)
+	{
+		$queue = $this->get_db_initialization_queue();
+		if (! in_array($plugin_slug, $queue)) {
+			$queue[] = $plugin_slug;
+		}
+		update_option(self::db_init_queue_option_name, $queue);
+	}
+
+	/**
+	 * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon
+	 * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is
+	 * in the queue, calls EE_System::initialize_db_if_no_migrations_required().
+	 */
+	public function initialize_db_for_enqueued_ee_plugins()
+	{
+		$queue = $this->get_db_initialization_queue();
+		foreach ($queue as $plugin_slug) {
+			$most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
+			if (! $most_up_to_date_dms) {
+				// if there is NO DMS for this plugin, obviously there's no schema to verify anyways
+				$verify_db = false;
+			} else {
+				$most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms);
+				$verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to);
+			}
+			if ($plugin_slug == 'Core') {
+				EE_System::instance()->initialize_db_if_no_migrations_required(
+					false,
+					$verify_db
+				);
+			} else {
+				// just loop through the addons to make sure their database is setup
+				foreach (EE_Registry::instance()->addons as $addon) {
+					if ($addon->name() == $plugin_slug) {
+						$addon->initialize_db_if_no_migrations_required($verify_db);
+						break;
+					}
+				}
+			}
+		}
+		// because we just initialized the DBs for the enqueued ee plugins
+		// we don't need to keep remembering which ones needed to be initialized
+		delete_option(self::db_init_queue_option_name);
+	}
+
+	/**
+	 * Gets a numerically-indexed array of plugin slugs that need to have their databases
+	 * (re-)initialized after migrations are complete. ie, each element should be either
+	 * 'Core', or the return value of EE_Addon::name() for an addon
+	 *
+	 * @return array
+	 */
+	public function get_db_initialization_queue()
+	{
+		return get_option(self::db_init_queue_option_name, array());
+	}
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+	/**
+	 * Gets the injected table manager, or throws an exception
+	 *
+	 * @return TableManager
+	 * @throws EE_Error
+	 */
+	protected function _get_table_manager()
+	{
+		if ($this->_table_manager instanceof TableManager) {
+			return $this->_table_manager;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table manager class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }

Spacing +61 added lines, -61 removed lines

@@ -157,7 +157,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Data_Migration_Manager) {
+        if ( ! self::$_instance instanceof EE_Data_Migration_Manager) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -233,12 +233,12 @@ 
 
         if (count($parts) == 4) {
             // it's 4.2-style.eg Core.4.1.0
-            $plugin_slug = $parts[0];// eg Core
-            $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
+            $plugin_slug = $parts[0]; // eg Core
+            $version_string = $parts[1].".".$parts[2].".".$parts[3]; // eg 4.1.0
         } else {
             // it's 4.1-style: eg 4.1.0
             $plugin_slug = 'Core';
-            $version_string = $plugin_slug_and_version_string;// eg 4.1.0
+            $version_string = $plugin_slug_and_version_string; // eg 4.1.0
         }
         return array($plugin_slug, $version_string);
     }
@@ -290,11 +290,11 @@ 
      */
     public function get_data_migrations_ran()
     {
-        if (! $this->_data_migrations_ran) {
+        if ( ! $this->_data_migrations_ran) {
             // setup autoloaders for each of the scripts in there
             $this->get_all_data_migration_scripts_available();
             $data_migrations_options = $this->get_all_migration_script_options(
-            );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
+            ); // get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
 
             $data_migrations_ran = array();
             // convert into data migration script classes where possible
@@ -308,23 +308,23 @@ 
                         $data_migration_option['option_name'],
                         $data_migration_option['option_value']
                     );
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
+                    $data_migrations_ran[$plugin_slug][$version_string] = $class;
                     // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration
                     $this->_last_ran_script = $class;
-                    if (! $class->is_completed()) {
+                    if ( ! $class->is_completed()) {
                         // sometimes we also like to know which was the last incomplete script (or if there are any at all)
                         $this->_last_ran_incomplete_script = $class;
                     }
                 } catch (EE_Error $e) {
                     // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
+                    $data_migrations_ran[$plugin_slug][$version_string] = maybe_unserialize(
                         $data_migration_option['option_value']
                     );
                 }
             }
             // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
             $this->_data_migrations_ran = $data_migrations_ran;
-            if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
+            if ( ! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
                 $this->_data_migrations_ran = array();
             }
         }
@@ -357,7 +357,7 @@ 
     {
         global $wpdb;
         return $wpdb->get_results(
-            "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC",
+            "SELECT * FROM {$wpdb->options} WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id ASC",
             ARRAY_A
         );
     }
@@ -372,7 +372,7 @@ 
     {
         return apply_filters(
             'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            array('Core' => EE_CORE . 'data_migration_scripts')
+            array('Core' => EE_CORE.'data_migration_scripts')
         );
     }
 
@@ -388,15 +388,15 @@ 
      */
     public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
     {
-        if (isset($this->script_migration_versions[ $migration_script_name ])) {
-            return $this->script_migration_versions[ $migration_script_name ];
+        if (isset($this->script_migration_versions[$migration_script_name])) {
+            return $this->script_migration_versions[$migration_script_name];
         }
         $dms_info = $this->parse_dms_classname($migration_script_name);
-        $this->script_migration_versions[ $migration_script_name ] = array(
+        $this->script_migration_versions[$migration_script_name] = array(
             'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
-            'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'],
+            'version' => $dms_info['major_version'].".".$dms_info['minor_version'].".".$dms_info['micro_version'],
         );
-        return $this->script_migration_versions[ $migration_script_name ];
+        return $this->script_migration_versions[$migration_script_name];
     }
 
     /**
@@ -410,7 +410,7 @@ 
     {
         $matches = array();
         preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
-        if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
+        if ( ! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -441,7 +441,7 @@ 
     {
         $espresso_db_core_updates = get_option('espresso_db_update', array());
         $db_state = get_option(EE_Data_Migration_Manager::current_database_state);
-        if (! $db_state) {
+        if ( ! $db_state) {
             // mark the DB as being in the state as the last version in there.
             // this is done to trigger maintenance mode and do data migration scripts
             // if the admin installed this version of EE over 3.1.x or 4.0.x
@@ -460,7 +460,7 @@ 
         // in 4.1, $db_state would have only been a simple string like '4.1.0',
         // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
         // db, and possibly other keys for other addons like 'Calendar','Permissions',etc
-        if (! is_array($db_state)) {
+        if ( ! is_array($db_state)) {
             $db_state = array('Core' => $db_state);
             update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
         }
@@ -497,29 +497,29 @@ 
                 $script_converts_plugin_slug = $migrates_to_version['slug'];
                 $script_converts_to_version = $migrates_to_version['version'];
                 // check if this version script is DONE or not; or if it's never been ran
-                if (! $scripts_ran ||
-                    ! isset($scripts_ran[ $script_converts_plugin_slug ]) ||
-                    ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) {
+                if ( ! $scripts_ran ||
+                    ! isset($scripts_ran[$script_converts_plugin_slug]) ||
+                    ! isset($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version])) {
                     // we haven't ran this conversion script before
                     // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available
                     $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis());
                     /* @var $script EE_Data_Migration_Script_Base */
                     $can_migrate = $script->can_migrate_from_version($theoretical_database_state);
                     if ($can_migrate) {
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+                        $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script;
                         $migrates_to_version = $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
+                        $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version'];
+                        unset($script_class_and_filepaths_available[$classname]);
                     }
-                } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) {
+                } elseif ($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version] instanceof EE_Data_Migration_Script_Base) {
                     // this script has been ran, or at least started
-                    $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
+                    $script = $scripts_ran[$script_converts_plugin_slug][$script_converts_to_version];
                     if ($script->get_status() != self::status_completed) {
                         // this script is already underway... keep going with it
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+                        $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script;
                         $migrates_to_version = $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
+                        $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version'];
+                        unset($script_class_and_filepaths_available[$classname]);
                     } else {
                         // it must have a status that indicates it has finished, so we don't want to try and run it again
                     }
@@ -530,14 +530,14 @@ 
                 }
             }
             $iteration++;
-        } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6);
+        }while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6);
         // ok we have all the scripts that should run, now let's make them into flat array
         $scripts_that_should_run = array();
         foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
             ksort($scripts_at_priority);
             foreach ($scripts_at_priority as $scripts) {
                 foreach ($scripts as $script) {
-                    $scripts_that_should_run[ get_class($script) ] = $script;
+                    $scripts_that_should_run[get_class($script)] = $script;
                 }
             }
         }
@@ -562,7 +562,7 @@ 
     public function get_last_ran_script($include_completed_scripts = false)
     {
         // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script
-        if (! $this->_data_migrations_ran) {
+        if ( ! $this->_data_migrations_ran) {
             $this->get_data_migrations_ran();
         }
         if ($include_completed_scripts) {
@@ -599,10 +599,10 @@ 
 
         try {
             $currently_executing_script = $this->get_last_ran_script();
-            if (! $currently_executing_script) {
+            if ( ! $currently_executing_script) {
                 // Find the next script that needs to execute
                 $scripts = $this->check_for_applicable_data_migration_scripts();
-                if (! $scripts) {
+                if ( ! $scripts) {
                     // huh, no more scripts to run... apparently we're done!
                     // but dont forget to make sure initial data is there
                     // we should be good to allow them to exit maintenance mode now
@@ -628,7 +628,7 @@ 
                 $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script));
                 $plugin_slug = $migrates_to['slug'];
                 $version = $migrates_to['version'];
-                $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
+                $this->_data_migrations_ran[$plugin_slug][$version] = $currently_executing_script;
             }
             $current_script_name = get_class($currently_executing_script);
         } catch (Exception $e) {
@@ -636,7 +636,7 @@ 
 
             $message = sprintf(
                 __("Error Message: %sStack Trace:%s", "event_espresso"),
-                $e->getMessage() . '<br>',
+                $e->getMessage().'<br>',
                 $e->getTraceAsString()
             );
             // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations
@@ -688,7 +688,7 @@ 
                     );
                     // check if there are any more after this one.
                     $scripts_remaining = $this->check_for_applicable_data_migration_scripts();
-                    if (! $scripts_remaining) {
+                    if ( ! $scripts_remaining) {
                         // we should be good to allow them to exit maintenance mode now
                         EE_Maintenance_Mode::instance()->set_maintenance_level(
                             intval(EE_Maintenance_Mode::level_0_not_in_maintenance)
@@ -788,7 +788,7 @@ 
                 ),
                 'script'             => 'Unknown',
             );
-            $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
+            $this->add_error_to_migrations_ran($e->getMessage()."; Stack trace:".$e->getTraceAsString());
         }
         $warnings_etc = @ob_get_contents();
         ob_end_clean();
@@ -808,12 +808,12 @@ 
      */
     public function update_current_database_state_to($slug_and_version = null)
     {
-        if (! $slug_and_version) {
+        if ( ! $slug_and_version) {
             // no version was provided, assume it should be at the current code version
             $slug_and_version = array('slug' => 'Core', 'version' => espresso_version());
         }
         $current_database_state = get_option(self::current_database_state);
-        $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
+        $current_database_state[$slug_and_version['slug']] = $slug_and_version['version'];
         update_option(self::current_database_state, $current_database_state);
     }
 
@@ -832,15 +832,15 @@ 
         $slug = $slug_and_version['slug'];
         $version = $slug_and_version['version'];
         $current_database_state = get_option(self::current_database_state);
-        if (! isset($current_database_state[ $slug ])) {
+        if ( ! isset($current_database_state[$slug])) {
             return true;
         } else {
             // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
-            $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
+            $version_parts_current_db_state = array_slice(explode('.', $current_database_state[$slug]), 0, 3);
             $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
             $needs_updating = false;
             foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
-                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
+                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[$offset]) {
                     $needs_updating = true;
                     break;
                 }
@@ -862,7 +862,7 @@ 
      */
     public function get_all_data_migration_scripts_available()
     {
-        if (! $this->_data_migration_class_to_filepath_map) {
+        if ( ! $this->_data_migration_class_to_filepath_map) {
             $this->_data_migration_class_to_filepath_map = array();
             foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
                 // strip any placeholders added to classname to make it a unique array key
@@ -871,7 +871,7 @@ 
                     ? $eeAddonClass
                     : '';
                 $folder_path = EEH_File::end_with_directory_separator($folder_path);
-                $files = glob($folder_path . '*.dms.php');
+                $files = glob($folder_path.'*.dms.php');
                 if (empty($files)) {
                     continue;
                 }
@@ -897,7 +897,7 @@ 
                             '4.3.0.alpha.019'
                         );
                     }
-                    $this->_data_migration_class_to_filepath_map[ $classname ] = $file;
+                    $this->_data_migration_class_to_filepath_map[$classname] = $file;
                 }
             }
             EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
@@ -929,7 +929,7 @@ 
         // get last-ran migration script
         global $wpdb;
         $last_migration_script_option = $wpdb->get_row(
-            "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1",
+            "SELECT * FROM $wpdb->options WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id DESC LIMIT 1",
             ARRAY_A
         );
 
@@ -961,10 +961,10 @@ 
             $versions_migrated_to = 'Unknown.1.0.0';
             // now just to make sure appears as last (in case the were previously a fatal error like this)
             // delete the old one
-            delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
+            delete_option(self::data_migration_script_option_prefix.$versions_migrated_to);
         }
         update_option(
-            self::data_migration_script_option_prefix . $versions_migrated_to,
+            self::data_migration_script_option_prefix.$versions_migrated_to,
             $last_ran_migration_script_properties
         );
     }
@@ -983,8 +983,8 @@ 
         $successful_updates = true;
         foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
             foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
-                $plugin_slug_for_use_in_option_name = $plugin_slug . ".";
-                $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
+                $plugin_slug_for_use_in_option_name = $plugin_slug.".";
+                $option_name = self::data_migration_script_option_prefix.$plugin_slug_for_use_in_option_name.$version_string;
                 $old_option_value = get_option($option_name);
                 if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
                     $script_array_for_saving = $array_or_migration_obj->properties_as_array();
@@ -996,7 +996,7 @@ 
                         $successful_updates = update_option($option_name, $array_or_migration_obj);
                     }
                 }
-                if (! $successful_updates) {
+                if ( ! $successful_updates) {
                     global $wpdb;
                     return $wpdb->last_error;
                 }
@@ -1030,7 +1030,7 @@ 
      */
     public function _instantiate_script_from_properties_array($properties_array)
     {
-        if (! isset($properties_array['class'])) {
+        if ( ! isset($properties_array['class'])) {
             throw new EE_Error(
                 sprintf(
                     __("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
@@ -1039,11 +1039,11 @@ 
             );
         }
         $class_name = $properties_array['class'];
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name));
         }
         $class = new $class_name;
-        if (! $class instanceof EE_Data_Migration_Script_Base) {
+        if ( ! $class instanceof EE_Data_Migration_Script_Base) {
             throw new EE_Error(
                 sprintf(
                     __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"),
@@ -1110,8 +1110,8 @@ 
     public function get_migration_ran($version, $plugin_slug = 'Core')
     {
         $migrations_ran = $this->get_data_migrations_ran();
-        if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
-            return $migrations_ran[ $plugin_slug ][ $version ];
+        if (isset($migrations_ran[$plugin_slug]) && isset($migrations_ran[$plugin_slug][$version])) {
+            return $migrations_ran[$plugin_slug][$version];
         } else {
             return null;
         }
@@ -1172,7 +1172,7 @@ 
     public function enqueue_db_initialization_for($plugin_slug)
     {
         $queue = $this->get_db_initialization_queue();
-        if (! in_array($plugin_slug, $queue)) {
+        if ( ! in_array($plugin_slug, $queue)) {
             $queue[] = $plugin_slug;
         }
         update_option(self::db_init_queue_option_name, $queue);
@@ -1188,7 +1188,7 @@ 
         $queue = $this->get_db_initialization_queue();
         foreach ($queue as $plugin_slug) {
             $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
-            if (! $most_up_to_date_dms) {
+            if ( ! $most_up_to_date_dms) {
                 // if there is NO DMS for this plugin, obviously there's no schema to verify anyways
                 $verify_db = false;
             } else {

core/espresso_definitions.php

Indentation +11 added lines, -11 removed lines

@@ -7,16 +7,16 @@ 
 define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 // used to be DIRECTORY_SEPARATOR, but that caused issues on windows
 if (! defined('DS')) {
-    define('DS', '/');
+	define('DS', '/');
 }
 if (! defined('PS')) {
-    define('PS', PATH_SEPARATOR);
+	define('PS', PATH_SEPARATOR);
 }
 if (! defined('SP')) {
-    define('SP', ' ');
+	define('SP', ' ');
 }
 if (! defined('EENL')) {
-    define('EENL', "\n");
+	define('EENL', "\n");
 }
 // define the plugin directory and URL
 define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
@@ -70,16 +70,16 @@ 
 define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
 // check for DOMPDF fonts in uploads
 if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+	define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
 }
 // ajax constants
 define(
-    'EE_FRONT_AJAX',
-    isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax'])
+	'EE_FRONT_AJAX',
+	isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax'])
 );
 define(
-    'EE_ADMIN_AJAX',
-    isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax'])
+	'EE_ADMIN_AJAX',
+	isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax'])
 );
 // just a handy constant occasionally needed for finding values representing infinity in the DB
 // you're better to use this than its straight value (currently -1) in case you ever
@@ -87,9 +87,9 @@ 
 define('EE_INF_IN_DB', -1);
 define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
 if (! defined('EE_DEBUG')) {
-    define('EE_DEBUG', false);
+	define('EE_DEBUG', false);
 }
 // for older WP versions
 if (! defined('MONTH_IN_SECONDS')) {
-    define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+	define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
 }

Spacing +45 added lines, -45 removed lines

@@ -6,71 +6,71 @@ 
 define('EE_MIN_PHP_VER_RECOMMENDED', '5.6.32');
 define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 // used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-if (! defined('DS')) {
+if ( ! defined('DS')) {
     define('DS', '/');
 }
-if (! defined('PS')) {
+if ( ! defined('PS')) {
     define('PS', PATH_SEPARATOR);
 }
-if (! defined('SP')) {
+if ( ! defined('SP')) {
     define('SP', ' ');
 }
-if (! defined('EENL')) {
+if ( ! defined('EENL')) {
     define('EENL', "\n");
 }
 // define the plugin directory and URL
 define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-define('EE_PLUGIN_DIR_PATH', dirname(EVENT_ESPRESSO_MAIN_FILE) . DS);
+define('EE_PLUGIN_DIR_PATH', dirname(EVENT_ESPRESSO_MAIN_FILE).DS);
 define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
 // main root folder paths
-define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
-define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
-define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
-define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
-define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
-define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
-define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
-define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
+define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH.'admin_pages'.DS);
+define('EE_CORE', EE_PLUGIN_DIR_PATH.'core'.DS);
+define('EE_MODULES', EE_PLUGIN_DIR_PATH.'modules'.DS);
+define('EE_PUBLIC', EE_PLUGIN_DIR_PATH.'public'.DS);
+define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH.'shortcodes'.DS);
+define('EE_WIDGETS', EE_PLUGIN_DIR_PATH.'widgets'.DS);
+define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH.'payment_methods'.DS);
+define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH.'caffeinated'.DS);
 // core system paths
-define('EE_ADMIN', EE_CORE . 'admin' . DS);
-define('EE_CPTS', EE_CORE . 'CPTs' . DS);
-define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
-define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
-define('EE_BUSINESS', EE_CORE . 'business' . DS);
-define('EE_MODELS', EE_CORE . 'db_models' . DS);
-define('EE_HELPERS', EE_CORE . 'helpers' . DS);
-define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
-define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
-define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
-define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
-define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
+define('EE_ADMIN', EE_CORE.'admin'.DS);
+define('EE_CPTS', EE_CORE.'CPTs'.DS);
+define('EE_CLASSES', EE_CORE.'db_classes'.DS);
+define('EE_INTERFACES', EE_CORE.'interfaces'.DS);
+define('EE_BUSINESS', EE_CORE.'business'.DS);
+define('EE_MODELS', EE_CORE.'db_models'.DS);
+define('EE_HELPERS', EE_CORE.'helpers'.DS);
+define('EE_LIBRARIES', EE_CORE.'libraries'.DS);
+define('EE_TEMPLATES', EE_CORE.'templates'.DS);
+define('EE_THIRD_PARTY', EE_CORE.'third_party_libs'.DS);
+define('EE_GLOBAL_ASSETS', EE_TEMPLATES.'global_assets'.DS);
+define('EE_FORM_SECTIONS', EE_LIBRARIES.'form_sections'.DS);
 // gateways
-define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
-define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
+define('EE_GATEWAYS', EE_MODULES.'gateways'.DS);
+define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL.'modules'.DS.'gateways'.DS);
 // asset URL paths
-define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
-define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
-define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
-define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
-define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL.'core'.DS.'templates'.DS);
+define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL.'global_assets'.DS);
+define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL.'images'.DS);
+define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL.'core'.DS.'third_party_libs'.DS);
+define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL.'core/helpers/assets/');
+define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL.'core/libraries/');
 // define upload paths
 $uploads = wp_upload_dir();
 // define the uploads directory and URL
-define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
-define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
+define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'].DS.'espresso'.DS);
+define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'].DS.'espresso'.DS);
 // define the templates directory and URL
-define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
-define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
+define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'].DS.'espresso'.DS.'templates'.DS);
+define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'].DS.'espresso'.DS.'templates'.DS);
 // define the gateway directory and URL
-define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
-define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
+define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'].DS.'espresso'.DS.'gateways'.DS);
+define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'].DS.'espresso'.DS.'gateways'.DS);
 // languages folder/path
-define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
-define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
+define('EE_LANGUAGES_SAFE_LOC', '..'.DS.'uploads'.DS.'espresso'.DS.'languages'.DS);
+define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'languages'.DS);
 // check for DOMPDF fonts in uploads
-if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR.'fonts'.DS)) {
+    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'fonts'.DS);
 }
 // ajax constants
 define(
@@ -86,10 +86,10 @@ 
 // want to change its default value! or find when -1 means infinity
 define('EE_INF_IN_DB', -1);
 define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
-if (! defined('EE_DEBUG')) {
+if ( ! defined('EE_DEBUG')) {
     define('EE_DEBUG', false);
 }
 // for older WP versions
-if (! defined('MONTH_IN_SECONDS')) {
+if ( ! defined('MONTH_IN_SECONDS')) {
     define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
 }

caffeinated/modules/recaptcha_invisible/InvisibleRecaptcha.php

Indentation +238 added lines, -238 removed lines

@@ -27,268 +27,268 @@
 class InvisibleRecaptcha
 {
 
-    const URL_GOOGLE_RECAPTCHA_API          = 'https://www.google.com/recaptcha/api/siteverify';
+	const URL_GOOGLE_RECAPTCHA_API          = 'https://www.google.com/recaptcha/api/siteverify';
 
-    const SESSION_DATA_KEY_RECAPTCHA_PASSED = 'recaptcha_passed';
+	const SESSION_DATA_KEY_RECAPTCHA_PASSED = 'recaptcha_passed';
 
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private $config;
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private $config;
 
-    /**
-     * @var EE_Session $session
-     */
-    private $session;
+	/**
+	 * @var EE_Session $session
+	 */
+	private $session;
 
-    /**
-     * @var boolean $recaptcha_passed
-     */
-    private $recaptcha_passed;
+	/**
+	 * @var boolean $recaptcha_passed
+	 */
+	private $recaptcha_passed;
 
 
-    /**
-     * InvisibleRecaptcha constructor.
-     *
-     * @param EE_Registration_Config $registration_config
-     * @param EE_Session             $session
-     */
-    public function __construct(EE_Registration_Config $registration_config, EE_Session $session)
-    {
-        $this->config = $registration_config;
-        $this->session = $session;
-    }
+	/**
+	 * InvisibleRecaptcha constructor.
+	 *
+	 * @param EE_Registration_Config $registration_config
+	 * @param EE_Session             $session
+	 */
+	public function __construct(EE_Registration_Config $registration_config, EE_Session $session)
+	{
+		$this->config = $registration_config;
+		$this->session = $session;
+	}
 
 
-    /**
-     * @return boolean
-     */
-    public function useInvisibleRecaptcha()
-    {
-        return $this->config->use_captcha && $this->config->recaptcha_theme === 'invisible';
-    }
+	/**
+	 * @return boolean
+	 */
+	public function useInvisibleRecaptcha()
+	{
+		return $this->config->use_captcha && $this->config->recaptcha_theme === 'invisible';
+	}
 
 
-    /**
-     * @param array $input_settings
-     * @return EE_Invisible_Recaptcha_Input
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DomainException
-     */
-    public function getInput(array $input_settings = array())
-    {
-        return new EE_Invisible_Recaptcha_Input(
-            $input_settings,
-            $this->config
-        );
-    }
+	/**
+	 * @param array $input_settings
+	 * @return EE_Invisible_Recaptcha_Input
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DomainException
+	 */
+	public function getInput(array $input_settings = array())
+	{
+		return new EE_Invisible_Recaptcha_Input(
+			$input_settings,
+			$this->config
+		);
+	}
 
 
-    /**
-     * @param array $input_settings
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DomainException
-     */
-    public function getInputHtml(array $input_settings = array())
-    {
-        return $this->getInput($input_settings)->get_html_for_input();
-    }
+	/**
+	 * @param array $input_settings
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DomainException
+	 */
+	public function getInputHtml(array $input_settings = array())
+	{
+		return $this->getInput($input_settings)->get_html_for_input();
+	}
 
 
-    /**
-     * @param EE_Form_Section_Proper $form
-     * @param array                  $input_settings
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public function addToFormSection(EE_Form_Section_Proper $form, array $input_settings = array())
-    {
-        $form->add_subsections(
-            array(
-                'espresso_recaptcha' => $this->getInput($input_settings),
-            ),
-            null,
-            false
-        );
-    }
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 * @param array                  $input_settings
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public function addToFormSection(EE_Form_Section_Proper $form, array $input_settings = array())
+	{
+		$form->add_subsections(
+			array(
+				'espresso_recaptcha' => $this->getInput($input_settings),
+			),
+			null,
+			false
+		);
+	}
 
 
-    /**
-     * @param RequestInterface $request
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public function verifyToken(RequestInterface $request)
-    {
-        static $previous_recaptcha_response = array();
-        $grecaptcha_response = $request->getRequestParam('g-recaptcha-response');
-        // if this token has already been verified, then return previous response
-        if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
-            return $previous_recaptcha_response[ $grecaptcha_response ];
-        }
-        // still here but no g-recaptcha-response ? - verification failed
-        if (! $grecaptcha_response) {
-            EE_Error::add_error(
-                sprintf(
-                    /* translators: 1: missing parameter */
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. Missing "%1$s". Please try again.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    'g-recaptcha-response'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // will update to true if everything passes
-        $previous_recaptcha_response[ $grecaptcha_response ] = false;
-        $response                                            = wp_safe_remote_post(
-            InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
-            array(
-                'body' => array(
-                    'secret'   => $this->config->recaptcha_privatekey,
-                    'response' => $grecaptcha_response,
-                    'remoteip' => $request->ipAddress(),
-                ),
-            )
-        );
-        if ($response instanceof WP_Error) {
-            $this->generateError($response->get_error_messages());
-            return false;
-        }
-        $results = json_decode(wp_remote_retrieve_body($response), true);
-        if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
-            $errors   = array_map(
-                array($this, 'getErrorCode'),
-                $results['error-codes']
-            );
-            if (isset($results['challenge_ts'])) {
-                $errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
-            }
-            $this->generateError(implode(' ', $errors), true);
-        }
-        $previous_recaptcha_response[ $grecaptcha_response ] = true;
-        add_action('shutdown', array($this, 'setSessionData'));
-        return true;
-    }
+	/**
+	 * @param RequestInterface $request
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public function verifyToken(RequestInterface $request)
+	{
+		static $previous_recaptcha_response = array();
+		$grecaptcha_response = $request->getRequestParam('g-recaptcha-response');
+		// if this token has already been verified, then return previous response
+		if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
+			return $previous_recaptcha_response[ $grecaptcha_response ];
+		}
+		// still here but no g-recaptcha-response ? - verification failed
+		if (! $grecaptcha_response) {
+			EE_Error::add_error(
+				sprintf(
+					/* translators: 1: missing parameter */
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. Missing "%1$s". Please try again.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					'g-recaptcha-response'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// will update to true if everything passes
+		$previous_recaptcha_response[ $grecaptcha_response ] = false;
+		$response                                            = wp_safe_remote_post(
+			InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
+			array(
+				'body' => array(
+					'secret'   => $this->config->recaptcha_privatekey,
+					'response' => $grecaptcha_response,
+					'remoteip' => $request->ipAddress(),
+				),
+			)
+		);
+		if ($response instanceof WP_Error) {
+			$this->generateError($response->get_error_messages());
+			return false;
+		}
+		$results = json_decode(wp_remote_retrieve_body($response), true);
+		if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
+			$errors   = array_map(
+				array($this, 'getErrorCode'),
+				$results['error-codes']
+			);
+			if (isset($results['challenge_ts'])) {
+				$errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
+			}
+			$this->generateError(implode(' ', $errors), true);
+		}
+		$previous_recaptcha_response[ $grecaptcha_response ] = true;
+		add_action('shutdown', array($this, 'setSessionData'));
+		return true;
+	}
 
 
-    /**
-     * @param string $error_response
-     * @param bool   $show_errors
-     * @return void
-     * @throws RuntimeException
-     */
-    public function generateError($error_response = '', $show_errors = false)
-    {
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. %1$s %2$s Please try again.',
-                    'event_espresso'
-                ),
-                '<br />',
-                $show_errors || current_user_can('manage_options') ? $error_response : ''
-            )
-        );
-    }
+	/**
+	 * @param string $error_response
+	 * @param bool   $show_errors
+	 * @return void
+	 * @throws RuntimeException
+	 */
+	public function generateError($error_response = '', $show_errors = false)
+	{
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. %1$s %2$s Please try again.',
+					'event_espresso'
+				),
+				'<br />',
+				$show_errors || current_user_can('manage_options') ? $error_response : ''
+			)
+		);
+	}
 
 
-    /**
-     * @param string $error_code
-     * @return string
-     */
-    public function getErrorCode(&$error_code)
-    {
-        $error_codes = array(
-            'missing-input-secret'   => 'The secret parameter is missing.',
-            'invalid-input-secret'   => 'The secret parameter is invalid or malformed.',
-            'missing-input-response' => 'The response parameter is missing.',
-            'invalid-input-response' => 'The response parameter is invalid or malformed.',
-            'bad-request'            => 'The request is invalid or malformed.',
-            'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
-        );
-        return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
-    }
+	/**
+	 * @param string $error_code
+	 * @return string
+	 */
+	public function getErrorCode(&$error_code)
+	{
+		$error_codes = array(
+			'missing-input-secret'   => 'The secret parameter is missing.',
+			'invalid-input-secret'   => 'The secret parameter is invalid or malformed.',
+			'missing-input-response' => 'The response parameter is missing.',
+			'invalid-input-response' => 'The response parameter is invalid or malformed.',
+			'bad-request'            => 'The request is invalid or malformed.',
+			'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
+		);
+		return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
+	}
 
 
-    /**
-     * @return array
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function getLocalizedVars()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso_caffeinated_modules_recaptcha_invisible_InvisibleRecaptcha__getLocalizedVars__localized_vars',
-            array(
-                'siteKey'          => $this->config->recaptcha_publickey,
-                'recaptcha_passed' => $this->recaptchaPassed(),
-                'wp_debug'         => WP_DEBUG,
-                'disable_submit'   => defined('EE_EVENT_QUEUE_BASE_URL'),
-                'failed_message'   => esc_html__(
-                    'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. Please try again.',
-                    'event_espresso'
-                )
-            )
-        );
-    }
+	/**
+	 * @return array
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function getLocalizedVars()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso_caffeinated_modules_recaptcha_invisible_InvisibleRecaptcha__getLocalizedVars__localized_vars',
+			array(
+				'siteKey'          => $this->config->recaptcha_publickey,
+				'recaptcha_passed' => $this->recaptchaPassed(),
+				'wp_debug'         => WP_DEBUG,
+				'disable_submit'   => defined('EE_EVENT_QUEUE_BASE_URL'),
+				'failed_message'   => esc_html__(
+					'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. Please try again.',
+					'event_espresso'
+				)
+			)
+		);
+	}
 
 
-    /**
-     * @return boolean
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function recaptchaPassed()
-    {
-        if ($this->recaptcha_passed !== null) {
-            return $this->recaptcha_passed;
-        }
-        // logged in means you have already passed a turing test of sorts
-        if ($this->useInvisibleRecaptcha() === false || is_user_logged_in()) {
-            $this->recaptcha_passed = true;
-            return $this->recaptcha_passed;
-        }
-        // was test already passed?
-        $this->recaptcha_passed = filter_var(
-            $this->session->get_session_data(
-                InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        return $this->recaptcha_passed;
-    }
+	/**
+	 * @return boolean
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function recaptchaPassed()
+	{
+		if ($this->recaptcha_passed !== null) {
+			return $this->recaptcha_passed;
+		}
+		// logged in means you have already passed a turing test of sorts
+		if ($this->useInvisibleRecaptcha() === false || is_user_logged_in()) {
+			$this->recaptcha_passed = true;
+			return $this->recaptcha_passed;
+		}
+		// was test already passed?
+		$this->recaptcha_passed = filter_var(
+			$this->session->get_session_data(
+				InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		return $this->recaptcha_passed;
+	}
 
 
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function setSessionData()
-    {
-        $this->session->set_session_data(
-            array(InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED => true)
-        );
-    }
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setSessionData()
+	{
+		$this->session->set_session_data(
+			array(InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED => true)
+		);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -135,11 +135,11 @@ 
         static $previous_recaptcha_response = array();
         $grecaptcha_response = $request->getRequestParam('g-recaptcha-response');
         // if this token has already been verified, then return previous response
-        if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
-            return $previous_recaptcha_response[ $grecaptcha_response ];
+        if (isset($previous_recaptcha_response[$grecaptcha_response])) {
+            return $previous_recaptcha_response[$grecaptcha_response];
         }
         // still here but no g-recaptcha-response ? - verification failed
-        if (! $grecaptcha_response) {
+        if ( ! $grecaptcha_response) {
             EE_Error::add_error(
                 sprintf(
                     /* translators: 1: missing parameter */
@@ -158,7 +158,7 @@ 
             return false;
         }
         // will update to true if everything passes
-        $previous_recaptcha_response[ $grecaptcha_response ] = false;
+        $previous_recaptcha_response[$grecaptcha_response] = false;
         $response                                            = wp_safe_remote_post(
             InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
             array(
@@ -175,16 +175,16 @@ 
         }
         $results = json_decode(wp_remote_retrieve_body($response), true);
         if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
-            $errors   = array_map(
+            $errors = array_map(
                 array($this, 'getErrorCode'),
                 $results['error-codes']
             );
             if (isset($results['challenge_ts'])) {
-                $errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
+                $errors[] = 'challenge timestamp: '.$results['challenge_ts'].'.';
             }
             $this->generateError(implode(' ', $errors), true);
         }
-        $previous_recaptcha_response[ $grecaptcha_response ] = true;
+        $previous_recaptcha_response[$grecaptcha_response] = true;
         add_action('shutdown', array($this, 'setSessionData'));
         return true;
     }
@@ -225,7 +225,7 @@ 
             'bad-request'            => 'The request is invalid or malformed.',
             'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
         );
-        return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
+        return isset($error_codes[$error_code]) ? $error_codes[$error_code] : '';
     }
 
 

core/data_migration_scripts/4_5_0_stages/EE_DMS_4_5_0_invoice_settings.dmsstage.php

Spacing +4 added lines, -4 removed lines

@@ -52,11 +52,11 @@ 
     protected function _migration_step($num_items = 1)
     {
         // if this isn't set then something is really wrong
-        if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
+        if ( ! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
             throw new EE_Error(__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
         }
         $invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
-        if (! $invoice_settings) {
+        if ( ! $invoice_settings) {
             $this->add_error(__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
         } else {
             $invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
@@ -89,8 +89,8 @@ 
                 );
             }
             $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-            $overridden_receipt_body= EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path.'invoice_body.template.php', null, false, false, true);
+            $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path.'receipt_body.template.php', null, false, false, true);
             if ($overridden_invoice_body || $overridden_receipt_body) {
                 new PersistentAdminNotice(
                     'invoice_overriding_templates',

Indentation +84 added lines, -84 removed lines

@@ -15,95 +15,95 @@
 class EE_DMS_4_5_0_invoice_settings extends EE_Data_Migration_Script_Stage
 {
 
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = __('Update Invoice Gateway Settings', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = __('Update Invoice Gateway Settings', 'event_espresso');
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _count_records_to_migrate
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @access protected
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return 1;
-    }
+	/**
+	 * _count_records_to_migrate
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @access protected
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return 1;
+	}
 
 
 
-    /**
-     *    _migration_step
-     *
-     * @access protected
-     * @param int $num_items
-     * @throws EE_Error
-     * @return int number of items ACTUALLY migrated
-     * @throws InvalidDataTypeException
-     */
-    protected function _migration_step($num_items = 1)
-    {
-        // if this isn't set then something is really wrong
-        if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
-            throw new EE_Error(__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
-        }
-        $invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
-        if (! $invoice_settings) {
-            $this->add_error(__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
-        } else {
-            $invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
-            $invoice_settings['template_invoice_payee_name'] = $invoice_settings['payable_to'];
-            $invoice_settings['template_invoice_address'] = $invoice_settings['payment_address'];
-            $invoice_settings['template_invoice_email'] = '';
-            $invoice_settings['template_invoice_tax_number'] = '';
-            unset($invoice_settings['pdf_instructions']);
-            unset($invoice_settings['payable_to']);
-            unset($invoice_settings['payment_address']);
-            EE_Config::instance()->gateway->payment_settings['Invoice'] = $invoice_settings;
-            EE_Config::instance()->update_espresso_config(false, false);
+	/**
+	 *    _migration_step
+	 *
+	 * @access protected
+	 * @param int $num_items
+	 * @throws EE_Error
+	 * @return int number of items ACTUALLY migrated
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _migration_step($num_items = 1)
+	{
+		// if this isn't set then something is really wrong
+		if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
+			throw new EE_Error(__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
+		}
+		$invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
+		if (! $invoice_settings) {
+			$this->add_error(__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
+		} else {
+			$invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
+			$invoice_settings['template_invoice_payee_name'] = $invoice_settings['payable_to'];
+			$invoice_settings['template_invoice_address'] = $invoice_settings['payment_address'];
+			$invoice_settings['template_invoice_email'] = '';
+			$invoice_settings['template_invoice_tax_number'] = '';
+			unset($invoice_settings['pdf_instructions']);
+			unset($invoice_settings['payable_to']);
+			unset($invoice_settings['payment_address']);
+			EE_Config::instance()->gateway->payment_settings['Invoice'] = $invoice_settings;
+			EE_Config::instance()->update_espresso_config(false, false);
 
-            // @todo: check 'invoice_css' too because we can't easily affect that so we might need to set a persistent notice
-            // (why is it tough to change? because we want to update the receipt and invoice message template, but
-            // message templates are only initialized AFTER migrations and those two are new in 4.5. So if we wanted to
-            // update them from a DMS, we'd need to have the DMS create the message templates which is quite a lot of code;
-            // also we don't want to build a dependency on the messages code because it is likely to change soon
-            if (isset($invoice_settings['invoice_css'])
-                && ! in_array($invoice_settings['invoice_css'], ['', 'simple.css'])) {
-                new PersistentAdminNotice(
-                    'invoice_css_not_updated',
-                    sprintf(
-                        esc_html__(
-                            'You had previously set your Invoice Payment Method\'s stylesheet to be %1$s, but that setting has moved. PDF and HTML Invoices and Receipts are now Messages, which means you can easily modify them from your Wordpress Dashboard instead of using filters or uploading template files. Please visit Messages -> Receipt and Messages -> Invoice to change their stylesheets.',
-                            'event_espresso'
-                        ),
-                        $invoice_settings['invoice_css']
-                    )
-                );
-            }
-            $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-            $overridden_receipt_body= EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
-            if ($overridden_invoice_body || $overridden_receipt_body) {
-                new PersistentAdminNotice(
-                    'invoice_overriding_templates',
-                    esc_html__(
-                        'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents. We recommend deleting your old Invoice/Receipt templates and modifying the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
-                        'event_espresso'
-                    ),
-                    true
-                );
-            }
-        }
-        // regardless of whether it worked or not, we ought to continue the migration
-        $this->set_completed();
-        return 1;
-    }
+			// @todo: check 'invoice_css' too because we can't easily affect that so we might need to set a persistent notice
+			// (why is it tough to change? because we want to update the receipt and invoice message template, but
+			// message templates are only initialized AFTER migrations and those two are new in 4.5. So if we wanted to
+			// update them from a DMS, we'd need to have the DMS create the message templates which is quite a lot of code;
+			// also we don't want to build a dependency on the messages code because it is likely to change soon
+			if (isset($invoice_settings['invoice_css'])
+				&& ! in_array($invoice_settings['invoice_css'], ['', 'simple.css'])) {
+				new PersistentAdminNotice(
+					'invoice_css_not_updated',
+					sprintf(
+						esc_html__(
+							'You had previously set your Invoice Payment Method\'s stylesheet to be %1$s, but that setting has moved. PDF and HTML Invoices and Receipts are now Messages, which means you can easily modify them from your Wordpress Dashboard instead of using filters or uploading template files. Please visit Messages -> Receipt and Messages -> Invoice to change their stylesheets.',
+							'event_espresso'
+						),
+						$invoice_settings['invoice_css']
+					)
+				);
+			}
+			$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+			$overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
+			$overridden_receipt_body= EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+			if ($overridden_invoice_body || $overridden_receipt_body) {
+				new PersistentAdminNotice(
+					'invoice_overriding_templates',
+					esc_html__(
+						'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents. We recommend deleting your old Invoice/Receipt templates and modifying the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
+						'event_espresso'
+					),
+					true
+				);
+			}
+		}
+		// regardless of whether it worked or not, we ought to continue the migration
+		$this->set_completed();
+		return 1;
+	}
 }

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

Indentation +292 added lines, -292 removed lines

@@ -87,57 +87,57 @@ 
  */
 class EE_DMS_4_1_0_prices extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_price_table;
-    private $_new_ticket_table;
-    private $_new_ticket_price_table;
-    private $_new_datetime_ticket_table;
-    /**
-     * A count of all the different tickets created, used for setting the new ones' TKT_Order
-     * @var int
-     */
-    private $_ticket_count = 0;
-    const price_type_base = 1;
-    const price_type_member_discount = 3;
-    const price_type_percent_surcharge = 4;
-    const price_type_flat_surcharge = 5;
+	private $_new_price_table;
+	private $_new_ticket_table;
+	private $_new_ticket_price_table;
+	private $_new_datetime_ticket_table;
+	/**
+	 * A count of all the different tickets created, used for setting the new ones' TKT_Order
+	 * @var int
+	 */
+	private $_ticket_count = 0;
+	const price_type_base = 1;
+	const price_type_member_discount = 3;
+	const price_type_percent_surcharge = 4;
+	const price_type_flat_surcharge = 5;
 
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Prices", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_prices";
-        $this->select_expression = 'p.*, e.event_status';
-        $this->_extra_where_sql = ' AS p 
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Prices", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_prices";
+		$this->select_expression = 'p.*, e.event_status';
+		$this->_extra_where_sql = ' AS p 
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON p.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_new_price_table = $wpdb->prefix."esp_price";
-        $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
-        $this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
-        $this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        // create the base price
-        $new_price_id = $this->_insert_new_price($old_row);
-        // create the member discount if there is any
-        // commented-out because we may actually NOT be supporting this in 4.1
+		$this->_new_price_table = $wpdb->prefix."esp_price";
+		$this->_new_ticket_table = $wpdb->prefix."esp_ticket";
+		$this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
+		$this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		// create the base price
+		$new_price_id = $this->_insert_new_price($old_row);
+		// create the member discount if there is any
+		// commented-out because we may actually NOT be supporting this in 4.1
 //      if($old_row['event_cost'] != $old_row['member_price']){
 //          $member_price_discount_id = $this->_insert_new_member_price($old_row);
 //      }else{
 //          $member_price_discount_id = 0;
 //      }
-        // create the surcharge if there is any
-        if (floatval($old_row['surcharge']) >= 0.01) {
-            $surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
-        } else {
-            $surcharge_price_id = 0;
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
-        }
-        // associate the ticket to all datetimes for event (ie, this ONE ticket grants access to ALL datetimes, not just one of the attendee's choice.
-        // if the latter were the case, then we'd create a separate ticket for each datetime and ahve their association be one-to-one)
-        // create ticket
+		// create the surcharge if there is any
+		if (floatval($old_row['surcharge']) >= 0.01) {
+			$surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
+		} else {
+			$surcharge_price_id = 0;
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
+		}
+		// associate the ticket to all datetimes for event (ie, this ONE ticket grants access to ALL datetimes, not just one of the attendee's choice.
+		// if the latter were the case, then we'd create a separate ticket for each datetime and ahve their association be one-to-one)
+		// create ticket
 //      $ticket_id = $this->_insert_new_ticket($old_row);
 //      if($ticket_id){
 //          $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $ticket_id);
@@ -149,62 +149,62 @@ 
 //              $this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
 //          }
 //      }
-        // create a ticket for each old price -old datetime combo
-        $tickets_for_old_price = array();
-        foreach ($this->_get_datetime_ids_for_old_event_id($old_row['event_id']) as $new_datetime_id) {
-            $ticket_id = $this->_insert_new_ticket($old_row);
-            $tickets_for_old_price[] = $ticket_id;
-            // associate to old prices
-            $this->_insert_ticket_price_relation($ticket_id, $new_price_id);
-            $this->_insert_ticket_price_relation($ticket_id, $surcharge_price_id);
-            $this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $tickets_for_old_price);
-    }
-    /**
-     * Creates a 4.1 price base type
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
-    private function _insert_new_price($old_price)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'PRT_ID'=>self::price_type_base,
-            'PRC_amount'=>floatval($old_price['event_cost']),
-            'PRC_name'=>$old_price['price_type'],
-            'PRC_is_default'=>false,
-            'PRC_overrides'=>false,
-            'PRC_order'=>0,
-            'PRC_deleted'=>false,
-            'PRC_parent'=>null
+		// create a ticket for each old price -old datetime combo
+		$tickets_for_old_price = array();
+		foreach ($this->_get_datetime_ids_for_old_event_id($old_row['event_id']) as $new_datetime_id) {
+			$ticket_id = $this->_insert_new_ticket($old_row);
+			$tickets_for_old_price[] = $ticket_id;
+			// associate to old prices
+			$this->_insert_ticket_price_relation($ticket_id, $new_price_id);
+			$this->_insert_ticket_price_relation($ticket_id, $surcharge_price_id);
+			$this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $tickets_for_old_price);
+	}
+	/**
+	 * Creates a 4.1 price base type
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
+	private function _insert_new_price($old_price)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'PRT_ID'=>self::price_type_base,
+			'PRC_amount'=>floatval($old_price['event_cost']),
+			'PRC_name'=>$old_price['price_type'],
+			'PRC_is_default'=>false,
+			'PRC_overrides'=>false,
+			'PRC_order'=>0,
+			'PRC_deleted'=>false,
+			'PRC_parent'=>null
 
-        );
-        $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
-        );
-        $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
-    /**
-     * Creates a 4.1 member price discount
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
+		);
+		$datatypes = array(
+			'%d',// PRT_ID
+			'%f',// PRT_amount
+			'%s',// PRC_name
+			'%d',// PRC_is_default
+			'%d',// PRC_overrides
+			'%d',// PRC_order
+			'%d',// PRC_deleted
+			'%d',// PRC_parent
+		);
+		$success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
+	/**
+	 * Creates a 4.1 member price discount
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
 //  private function _insert_new_member_price($old_price){
 //      $discount_amount = floatval($old_price['event_cost']) - floatval($old_price['member_price']);
 //      global $wpdb;
@@ -237,207 +237,207 @@ 
 //      $new_id = $wpdb->insert_id;
 //      return $new_id;
 //  }
-    /**
-     * Creates a 4.1 member price discount
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
-    private function _insert_new_surcharge_price($old_price)
-    {
+	/**
+	 * Creates a 4.1 member price discount
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
+	private function _insert_new_surcharge_price($old_price)
+	{
 
-        if ($old_price['surcharge_type'] == 'flat_rate') {
-            $price_type = self::price_type_flat_surcharge;
-        } else {
-            $price_type = self::price_type_percent_surcharge;
-        }
-        global $wpdb;
-        $cols_n_values = array(
-            'PRT_ID'=>$price_type,
-            'PRC_amount'=>floatval($old_price['surcharge']),
-            'PRC_name'=>  __("Surcharge", "event_espresso"),
-            'PRC_is_default'=>false,
-            'PRC_overrides'=>false,
-            'PRC_order'=>20,
-            'PRC_deleted'=>false,
-            'PRC_parent'=>null
+		if ($old_price['surcharge_type'] == 'flat_rate') {
+			$price_type = self::price_type_flat_surcharge;
+		} else {
+			$price_type = self::price_type_percent_surcharge;
+		}
+		global $wpdb;
+		$cols_n_values = array(
+			'PRT_ID'=>$price_type,
+			'PRC_amount'=>floatval($old_price['surcharge']),
+			'PRC_name'=>  __("Surcharge", "event_espresso"),
+			'PRC_is_default'=>false,
+			'PRC_overrides'=>false,
+			'PRC_order'=>20,
+			'PRC_deleted'=>false,
+			'PRC_parent'=>null
 
-        );
-        $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
-        );
-        $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
-    /**
-     * Inserts a 4.1 ticket based off the 3.1 price, and the price IDs we've already made from the 3.1 price
-     * @param $old_price_row array where keys are columns
-     * @param $new_base_price_id int
-     * @param $new_member_discount_id int
-     * @param $new_surcharge_id int
-     * @return int new ticket id
-     */
-    private function _insert_new_ticket($old_price_row)
-    {
-        global $wpdb;
-        $event_row = $this->_get_event_row($old_price_row['event_id']);
-        if ($old_price_row['surcharge_type'] == 'flat_rate') {
-            $final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
-        } else {// percent surcharge
-            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
-        }
-        $start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
-        $start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
-        $end_date = $event_row['registration_end']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_endT']);
-        $end_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $end_date, $event_row['timezone_string']);
-        $cols_n_values = array(
-            'TTM_ID'=>0,
-            'TKT_name'=>$old_price_row['price_type'],
-            'TKT_description'=>'',
-            'TKT_start_date'=>$start_date_utc,
-            'TKT_end_date'=>$end_date_utc,
-            'TKT_min'=>0,
-            'TKT_max'=>-1,
-            'TKT_price'=>$final_ticket_price,
-            'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
-            'TKT_qty'=> -1,
-            'TKT_uses'=> 1,
-            'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
-            'TKT_is_default'=>false,
-            'TKT_order'=>$this->_get_ticket_count(),
-            'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
-            'TKT_deleted'=>false,
-            'TKT_parent'=>0
+		);
+		$datatypes = array(
+			'%d',// PRT_ID
+			'%f',// PRT_amount
+			'%s',// PRC_name
+			'%d',// PRC_is_default
+			'%d',// PRC_overrides
+			'%d',// PRC_order
+			'%d',// PRC_deleted
+			'%d',// PRC_parent
+		);
+		$success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
+	/**
+	 * Inserts a 4.1 ticket based off the 3.1 price, and the price IDs we've already made from the 3.1 price
+	 * @param $old_price_row array where keys are columns
+	 * @param $new_base_price_id int
+	 * @param $new_member_discount_id int
+	 * @param $new_surcharge_id int
+	 * @return int new ticket id
+	 */
+	private function _insert_new_ticket($old_price_row)
+	{
+		global $wpdb;
+		$event_row = $this->_get_event_row($old_price_row['event_id']);
+		if ($old_price_row['surcharge_type'] == 'flat_rate') {
+			$final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
+		} else {// percent surcharge
+			$final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
+		}
+		$start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
+		$start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
+		$end_date = $event_row['registration_end']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_endT']);
+		$end_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $end_date, $event_row['timezone_string']);
+		$cols_n_values = array(
+			'TTM_ID'=>0,
+			'TKT_name'=>$old_price_row['price_type'],
+			'TKT_description'=>'',
+			'TKT_start_date'=>$start_date_utc,
+			'TKT_end_date'=>$end_date_utc,
+			'TKT_min'=>0,
+			'TKT_max'=>-1,
+			'TKT_price'=>$final_ticket_price,
+			'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
+			'TKT_qty'=> -1,
+			'TKT_uses'=> 1,
+			'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
+			'TKT_is_default'=>false,
+			'TKT_order'=>$this->_get_ticket_count(),
+			'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
+			'TKT_deleted'=>false,
+			'TKT_parent'=>0
 
-        );
-        $datatypes = array(
-            '%d',// TTM_ID
-            '%s',// TKT_name
-            '%s',// TKT_description
-            '%s',// TKT_start_date
-            '%s',// TKT_end_date
-            '%d',// TKT_min
-            '%d',// TKT_max
-            '%f',// TKT_price
-            '%d',// TKT_sold
-            '%d',// TKT_qty
-            '%d',// TKT_uses
-            '%d',// TKT_taxable
-            '%d',// TKT_is_default
-            '%d',// TKT_order
-            '%d',// TKT_row
-            '%d',// TKT_deleted
-            '%d',// TKT_parent
-        );
-        $success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		);
+		$datatypes = array(
+			'%d',// TTM_ID
+			'%s',// TKT_name
+			'%s',// TKT_description
+			'%s',// TKT_start_date
+			'%s',// TKT_end_date
+			'%d',// TKT_min
+			'%d',// TKT_max
+			'%f',// TKT_price
+			'%d',// TKT_sold
+			'%d',// TKT_qty
+			'%d',// TKT_uses
+			'%d',// TKT_taxable
+			'%d',// TKT_is_default
+			'%d',// TKT_order
+			'%d',// TKT_row
+			'%d',// TKT_deleted
+			'%d',// TKT_parent
+		);
+		$success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Adds a join between a ticket and a price
-     * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
-     * @return int
-     */
-    private function _insert_ticket_price_relation($new_ticket_id, $new_price_id)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'TKT_ID'=>$new_ticket_id,
-            'PRC_ID'=>$new_price_id,
-        );
-        $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// PRC_ID
-        );
-        $success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	/**
+	 * Adds a join between a ticket and a price
+	 * @global type $wpdb
+	 * @param type $new_ticket_id
+	 * @param type $new_price_id
+	 * @return int
+	 */
+	private function _insert_ticket_price_relation($new_ticket_id, $new_price_id)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'TKT_ID'=>$new_ticket_id,
+			'PRC_ID'=>$new_price_id,
+		);
+		$datatypes = array(
+			'%d',// TKT_ID
+			'%d',// PRC_ID
+		);
+		$success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Adds a join between a ticket and a datetime
-     * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
-     * @return int
-     */
-    private function _insert_datetime_ticket_relation($new_datetime_id, $new_ticket_id)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'TKT_ID'=>$new_ticket_id,
-            'DTT_ID'=>$new_datetime_id,
-        );
-        $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// DTT_ID
-        );
-        $success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	/**
+	 * Adds a join between a ticket and a datetime
+	 * @global type $wpdb
+	 * @param type $new_ticket_id
+	 * @param type $new_price_id
+	 * @return int
+	 */
+	private function _insert_datetime_ticket_relation($new_datetime_id, $new_ticket_id)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'TKT_ID'=>$new_ticket_id,
+			'DTT_ID'=>$new_datetime_id,
+		);
+		$datatypes = array(
+			'%d',// TKT_ID
+			'%d',// DTT_ID
+		);
+		$success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Simply gets the 3.1 event row data
-     * @global type $wpdb
-     * @param type $event_id
-     * @return array
-     */
-    private function _get_event_row($event_id)
-    {
-        global $wpdb;
-        $old_event_table = $wpdb->prefix."events_detail";
-        return $wpdb->get_row($wpdb->prepare("SELECT * FROM $old_event_table WHERE id=%d", $event_id), ARRAY_A);
-    }
-    /**
-     * Gets a higher ticket count than last time it was called (and is persisted between HTTP requests).
-     * Yes we COULD run a query joining events->datetimes->ticket_datetimes->tickets, but this should work fine too
-     * @return int
-     */
-    private function _get_ticket_count()
-    {
-        return $this->_ticket_count++;
-    }
+	/**
+	 * Simply gets the 3.1 event row data
+	 * @global type $wpdb
+	 * @param type $event_id
+	 * @return array
+	 */
+	private function _get_event_row($event_id)
+	{
+		global $wpdb;
+		$old_event_table = $wpdb->prefix."events_detail";
+		return $wpdb->get_row($wpdb->prepare("SELECT * FROM $old_event_table WHERE id=%d", $event_id), ARRAY_A);
+	}
+	/**
+	 * Gets a higher ticket count than last time it was called (and is persisted between HTTP requests).
+	 * Yes we COULD run a query joining events->datetimes->ticket_datetimes->tickets, but this should work fine too
+	 * @return int
+	 */
+	private function _get_ticket_count()
+	{
+		return $this->_ticket_count++;
+	}
 
-    /**
-     * Using the 3.1 event id, gets the 4.1 datetimes for it
-     * @param int $old_event_id
-     * @return array where values are datetime ids
-     */
-    private function _get_datetime_ids_for_old_event_id($old_event_id)
-    {
-        global $wpdb;
-        $new_cpt_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_id, $wpdb->posts);
-        $datetime_ids = $wpdb->get_col($wpdb->prepare("SELECT DTT_ID FROM {$wpdb->prefix}esp_datetime WHERE EVT_ID=%d", $new_cpt_id));
-        return $datetime_ids;
-    }
+	/**
+	 * Using the 3.1 event id, gets the 4.1 datetimes for it
+	 * @param int $old_event_id
+	 * @return array where values are datetime ids
+	 */
+	private function _get_datetime_ids_for_old_event_id($old_event_id)
+	{
+		global $wpdb;
+		$new_cpt_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_id, $wpdb->posts);
+		$datetime_ids = $wpdb->get_col($wpdb->prepare("SELECT DTT_ID FROM {$wpdb->prefix}esp_datetime WHERE EVT_ID=%d", $new_cpt_id));
+		return $datetime_ids;
+	}
 }
 // @todo: tell users that in 3.1 the limit was on registration PER event,in 4.1 it's limit PER TICKET... SO, if they sell 2 different types of tickets
 //

Spacing +50 added lines, -50 removed lines

@@ -108,7 +108,7 @@ 
         $this->_old_table = $wpdb->prefix."events_prices";
         $this->select_expression = 'p.*, e.event_status';
         $this->_extra_where_sql = ' AS p 
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON p.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON p.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_new_price_table = $wpdb->prefix."esp_price";
         $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
@@ -130,7 +130,7 @@ 
         // create the surcharge if there is any
         if (floatval($old_row['surcharge']) >= 0.01) {
             $surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
+            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id, $surcharge_price_id));
         } else {
             $surcharge_price_id = 0;
             $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
@@ -182,17 +182,17 @@ 
 
         );
         $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
+            '%d', // PRT_ID
+            '%f', // PRT_amount
+            '%s', // PRC_name
+            '%d', // PRC_is_default
+            '%d', // PRC_overrides
+            '%d', // PRC_order
+            '%d', // PRC_deleted
+            '%d', // PRC_parent
         );
         $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -264,17 +264,17 @@ 
 
         );
         $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
+            '%d', // PRT_ID
+            '%f', // PRT_amount
+            '%s', // PRC_name
+            '%d', // PRC_is_default
+            '%d', // PRC_overrides
+            '%d', // PRC_order
+            '%d', // PRC_deleted
+            '%d', // PRC_parent
         );
         $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -296,7 +296,7 @@ 
         if ($old_price_row['surcharge_type'] == 'flat_rate') {
             $final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
         } else {// percent surcharge
-            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
+            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge']) / 100);
         }
         $start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
         $start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
@@ -311,38 +311,38 @@ 
             'TKT_min'=>0,
             'TKT_max'=>-1,
             'TKT_price'=>$final_ticket_price,
-            'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
+            'TKT_sold'=> 0, // note: this will get calculated as we actually add registrations during the migration
             'TKT_qty'=> -1,
             'TKT_uses'=> 1,
-            'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
+            'TKT_taxable'=>false, // so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
             'TKT_is_default'=>false,
             'TKT_order'=>$this->_get_ticket_count(),
-            'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
+            'TKT_row'=>0, // doesn't matter because UI reset this on first save anyways
             'TKT_deleted'=>false,
             'TKT_parent'=>0
 
         );
         $datatypes = array(
-            '%d',// TTM_ID
-            '%s',// TKT_name
-            '%s',// TKT_description
-            '%s',// TKT_start_date
-            '%s',// TKT_end_date
-            '%d',// TKT_min
-            '%d',// TKT_max
-            '%f',// TKT_price
-            '%d',// TKT_sold
-            '%d',// TKT_qty
-            '%d',// TKT_uses
-            '%d',// TKT_taxable
-            '%d',// TKT_is_default
-            '%d',// TKT_order
-            '%d',// TKT_row
-            '%d',// TKT_deleted
-            '%d',// TKT_parent
+            '%d', // TTM_ID
+            '%s', // TKT_name
+            '%s', // TKT_description
+            '%s', // TKT_start_date
+            '%s', // TKT_end_date
+            '%d', // TKT_min
+            '%d', // TKT_max
+            '%f', // TKT_price
+            '%d', // TKT_sold
+            '%d', // TKT_qty
+            '%d', // TKT_uses
+            '%d', // TKT_taxable
+            '%d', // TKT_is_default
+            '%d', // TKT_order
+            '%d', // TKT_row
+            '%d', // TKT_deleted
+            '%d', // TKT_parent
         );
         $success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -365,12 +365,12 @@ 
             'PRC_ID'=>$new_price_id,
         );
         $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// PRC_ID
+            '%d', // TKT_ID
+            '%d', // PRC_ID
         );
         $success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
+        if ( ! $success) {
+            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id, 'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
             return 0;
         }
         $new_id = $wpdb->insert_id;
@@ -392,12 +392,12 @@ 
             'DTT_ID'=>$new_datetime_id,
         );
         $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// DTT_ID
+            '%d', // TKT_ID
+            '%d', // DTT_ID
         );
         $success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
+        if ( ! $success) {
+            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id, 'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
             return 0;
         }
         $new_id = $wpdb->insert_id;

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

Spacing +7 added lines, -7 removed lines

@@ -42,8 +42,8 @@ 
         // join to attendee and then join to events table
         $this->select_expression = 'ans.*, e.event_status';
         $this->_extra_where_sql = ' AS ans 
-            INNER JOIN ' . $wpdb->prefix . 'events_attendee AS att ON ans.attendee_id = att.id
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id = e.id 
+            INNER JOIN ' . $wpdb->prefix.'events_attendee AS att ON ans.attendee_id = att.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id = e.id 
             WHERE e.event_status !="D"';
         $this->_new_answer_table = $wpdb->prefix."esp_answer";
         $this->_new_question_table = $wpdb->prefix."esp_question";
@@ -56,7 +56,7 @@ 
         $old_attendee_table = $wpdb->prefix."events_attendee";
         $new_reg_table = $wpdb->prefix."esp_registration";
         $regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
-        if (! $regs) {
+        if ( ! $regs) {
             $this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
             return false;
         }
@@ -90,12 +90,12 @@ 
             'ANS_value'=>$ans_value
         );
         $datatypes = array(
-            '%d',// REG_ID
-            '%d',// QST_ID
-            '%s',// ANS_value
+            '%d', // REG_ID
+            '%d', // QST_ID
+            '%s', // ANS_value
         );
         $success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
             return 0;
         }

Indentation +93 added lines, -93 removed lines

@@ -32,102 +32,102 @@
 
 class EE_DMS_4_1_0_answers extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_answer_table;
-    private $_new_question_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Answers", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_answer";
-        // join to attendee and then join to events table
-        $this->select_expression = 'ans.*, e.event_status';
-        $this->_extra_where_sql = ' AS ans 
+	private $_new_answer_table;
+	private $_new_question_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Answers", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_answer";
+		// join to attendee and then join to events table
+		$this->select_expression = 'ans.*, e.event_status';
+		$this->_extra_where_sql = ' AS ans 
             INNER JOIN ' . $wpdb->prefix . 'events_attendee AS att ON ans.attendee_id = att.id
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id = e.id 
             WHERE e.event_status !="D"';
-        $this->_new_answer_table = $wpdb->prefix."esp_answer";
-        $this->_new_question_table = $wpdb->prefix."esp_question";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        // get the new REGs for the old answer
-        global $wpdb;
-        $old_attendee_table = $wpdb->prefix."events_attendee";
-        $new_reg_table = $wpdb->prefix."esp_registration";
-        $regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
-        if (! $regs) {
-            $this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
-            return false;
-        }
-        // as inefficient as this sounds, we create an answer per REGISTRATION, (even if the registrations use the same attendee)
-        foreach ($regs as $new_reg_id) {
-            $this->_insert_new_answer($old_row, $new_reg_id);
-        }
-    }
-    /**
-     * Creates a 4.1 price base type
-     * @global type $wpdb
-     * @param array $old_price
-     * @param int $new_reg_id
-     * @return int
-     */
-    private function _insert_new_answer($old_answer, $new_reg_id)
-    {
-        global $wpdb;
-        $old_question_table = $wpdb->prefix."events_question";
-        $new_question_id = $this->get_migration_script()->get_mapping_new_pk($old_question_table, $old_answer['question_id'], $this->_new_question_table);
+		$this->_new_answer_table = $wpdb->prefix."esp_answer";
+		$this->_new_question_table = $wpdb->prefix."esp_question";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		// get the new REGs for the old answer
+		global $wpdb;
+		$old_attendee_table = $wpdb->prefix."events_attendee";
+		$new_reg_table = $wpdb->prefix."esp_registration";
+		$regs = $this->get_migration_script()->get_mapping_new_pk($old_attendee_table, $old_row['attendee_id'], $new_reg_table);
+		if (! $regs) {
+			$this->add_error(sprintf(__("Could not find new registrations for old attendee %d when creating answer %s", "event_espresso"), $old_row['attendee_id'], $this->_json_encode($old_row)));
+			return false;
+		}
+		// as inefficient as this sounds, we create an answer per REGISTRATION, (even if the registrations use the same attendee)
+		foreach ($regs as $new_reg_id) {
+			$this->_insert_new_answer($old_row, $new_reg_id);
+		}
+	}
+	/**
+	 * Creates a 4.1 price base type
+	 * @global type $wpdb
+	 * @param array $old_price
+	 * @param int $new_reg_id
+	 * @return int
+	 */
+	private function _insert_new_answer($old_answer, $new_reg_id)
+	{
+		global $wpdb;
+		$old_question_table = $wpdb->prefix."events_question";
+		$new_question_id = $this->get_migration_script()->get_mapping_new_pk($old_question_table, $old_answer['question_id'], $this->_new_question_table);
 
-        $question_row = $this->_get_question_type_and_system($new_question_id);
-        if ($question_row['QST_system']) {
-            // It's an answer to a system question? EE3 used to store that on both the attendee and the answers column,
-            // but not EE4! It's just stored in the attendee meta table. The answers table is ONLY for answers to custom
-            // questions.
-            return 0;
-        }
-        if (in_array($question_row['QST_type'], array('MULTIPLE'))) {
-            $ans_value = serialize(explode(",", stripslashes($old_answer['answer'])));
-        } else {
-            $ans_value = stripslashes($old_answer['answer']);
-        }
-        $cols_n_values = array(
-            'REG_ID'=>$new_reg_id,
-            'QST_ID'=>$new_question_id,
-            'ANS_value'=>$ans_value
-        );
-        $datatypes = array(
-            '%d',// REG_ID
-            '%d',// QST_ID
-            '%s',// ANS_value
-        );
-        $success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		$question_row = $this->_get_question_type_and_system($new_question_id);
+		if ($question_row['QST_system']) {
+			// It's an answer to a system question? EE3 used to store that on both the attendee and the answers column,
+			// but not EE4! It's just stored in the attendee meta table. The answers table is ONLY for answers to custom
+			// questions.
+			return 0;
+		}
+		if (in_array($question_row['QST_type'], array('MULTIPLE'))) {
+			$ans_value = serialize(explode(",", stripslashes($old_answer['answer'])));
+		} else {
+			$ans_value = stripslashes($old_answer['answer']);
+		}
+		$cols_n_values = array(
+			'REG_ID'=>$new_reg_id,
+			'QST_ID'=>$new_question_id,
+			'ANS_value'=>$ans_value
+		);
+		$datatypes = array(
+			'%d',// REG_ID
+			'%d',// QST_ID
+			'%s',// ANS_value
+		);
+		$success = $wpdb->insert($this->_new_answer_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_answer, $this->_new_answer_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Gets the question's type
-     * @global type $wpdb
-     * @param type $question_id
-     * @return array {
-     *  @type string $QST_type
-     *  @type string $QST_system
-     * }
-     */
-    private function _get_question_type_and_system($question_id)
-    {
-        global $wpdb;
-        $row = $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT QST_type, QST_system FROM ".$this->_new_question_table." WHERE QST_ID=%d LIMIT 1",
-                $question_id
-            ),
-            ARRAY_A
-        );
-        return $row;
-    }
+	/**
+	 * Gets the question's type
+	 * @global type $wpdb
+	 * @param type $question_id
+	 * @return array {
+	 *  @type string $QST_type
+	 *  @type string $QST_system
+	 * }
+	 */
+	private function _get_question_type_and_system($question_id)
+	{
+		global $wpdb;
+		$row = $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT QST_type, QST_system FROM ".$this->_new_question_table." WHERE QST_ID=%d LIMIT 1",
+				$question_id
+			),
+			ARRAY_A
+		);
+		return $row;
+	}
 }

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

Indentation +142 added lines, -142 removed lines

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

Spacing +17 added lines, -17 removed lines

@@ -34,7 +34,7 @@ 
         $this->_old_table = $wpdb->prefix."events_attendee";
         $this->select_expression = 'att.*, e.event_status';
         $this->_extra_where_sql = 'AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_new_table = $wpdb->prefix."esp_checkin";
         parent::__construct();
@@ -44,10 +44,10 @@ 
         global $wpdb;
         $new_reg_table = $wpdb->prefix."esp_registration";
 
-        $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']),intval($old_row['checked_in']))) ;
+        $num_to_checkin_at_this_time = max(array(intval($old_row['checked_in_quantity']), intval($old_row['checked_in'])));
 
         $new_registrations_for_attendee = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $new_reg_table);
-        if (! $new_registrations_for_attendee) {
+        if ( ! $new_registrations_for_attendee) {
             $new_registrations_for_attendee = array();
         }
         $new_datetime = $this->_try_to_find_datetime($old_row);
@@ -55,9 +55,9 @@ 
         // make sure registrations array is numerically indexed starting at 0 (it probably already is)
         $new_registrations_for_attendee = array_values($new_registrations_for_attendee);
         $new_checkin_ids = array();
-        for ($i = 0; $i<abs($num_to_checkin_at_this_time); $i++) {
-            $new_reg_id = $new_registrations_for_attendee[ $i ];
-            if (! $new_reg_id) {
+        for ($i = 0; $i < abs($num_to_checkin_at_this_time); $i++) {
+            $new_reg_id = $new_registrations_for_attendee[$i];
+            if ( ! $new_reg_id) {
                 $this->add_error(sprintf(
                     esc_html__(
                         /* translators: %1$s database row represented in JSON, %2$s number of registrations to check-in
@@ -81,10 +81,10 @@ 
                     $new_reg_id
                 )
             );
-            if (! $existing_checkin_record) {
+            if ( ! $existing_checkin_record) {
                 $new_id = $this->_insert_checkin_record($new_reg_id, $new_datetime);
                 if ($new_id) {
-                    $new_checkin_ids[]= $new_id;
+                    $new_checkin_ids[] = $new_id;
                 }
             }
         }
@@ -112,7 +112,7 @@ 
         global $wpdb;
 
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(
                 sprintf(
                     esc_html__(
@@ -136,8 +136,8 @@ 
         // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
         // the most important condition should be last, as it will be array_shift'ed off last
         $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime), // times match?
+            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id), // events match?
         );
         // start running queries, widening search each time by removing a condition
         $datetime_found = null;
@@ -145,7 +145,7 @@ 
             $full_query = "SELECT * FROM $datetime_table WHERE ".implode(" AND ", $conditions)." LIMIT 1";
             $datetime_found = $wpdb->get_row($full_query, ARRAY_A);
             array_shift($conditions);
-        } while (! $datetime_found && $conditions);
+        }while ( ! $datetime_found && $conditions);
         return $datetime_found;
     }
 
@@ -169,13 +169,13 @@ 
             'CHK_timestamp'=>$new_datetime['DTT_EVT_start']
         );
         $datatypes = array(
-            '%d',// REG_ID
-            '%d',// DTT_ID
-            '%d',// CHK_in
-            '%s',// CHK_timestamp
+            '%d', // REG_ID
+            '%d', // DTT_ID
+            '%d', // CHK_in
+            '%s', // CHK_timestamp
         );
         $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_checkin, $this->_new_table, $cols_n_values, $datatypes));
             return 0;
         }

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

Indentation +157 added lines, -157 removed lines

@@ -38,172 +38,172 @@
  */
 class EE_DMS_4_1_0_line_items extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_line_table;
-    private $_new_transaction_table;
-    private $_new_reg_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Line Items", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_attendee";
-        $this->select_expression = 'att.*, e.event_status';
-        $this->_extra_where_sql = ' AS att
+	private $_new_line_table;
+	private $_new_transaction_table;
+	private $_new_reg_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Line Items", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_attendee";
+		$this->select_expression = 'att.*, e.event_status';
+		$this->_extra_where_sql = ' AS att
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_new_transaction_table = $wpdb->prefix."esp_transaction";
-        $this->_new_line_table = $wpdb->prefix."esp_line_item";
-        $this->_new_reg_table = $wpdb->prefix."esp_registration";
-        parent::__construct();
-    }
+		$this->_new_transaction_table = $wpdb->prefix."esp_transaction";
+		$this->_new_line_table = $wpdb->prefix."esp_line_item";
+		$this->_new_reg_table = $wpdb->prefix."esp_registration";
+		parent::__construct();
+	}
     
-    protected function _migrate_old_row($old_row)
-    {
-        // insert line items if its a primary id
-        if (intval($old_row['is_primary'])) {
-            $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $this->_new_transaction_table);
-            if (! $txn_id) {
-                $this->add_error(sprintf(__("Could not find the transaction for the 3.1 attendee %d from row %s", "event_espresso"), $old_row['id'], $this->_json_encode($old_row)));
-                return;
-            }
-            $txn = $this->_get_txn($txn_id);
-            $new_line_items = $this->_insert_new_line_items($txn, $old_row);
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_line_table, $new_line_items);
-        }
-    }
+	protected function _migrate_old_row($old_row)
+	{
+		// insert line items if its a primary id
+		if (intval($old_row['is_primary'])) {
+			$txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $this->_new_transaction_table);
+			if (! $txn_id) {
+				$this->add_error(sprintf(__("Could not find the transaction for the 3.1 attendee %d from row %s", "event_espresso"), $old_row['id'], $this->_json_encode($old_row)));
+				return;
+			}
+			$txn = $this->_get_txn($txn_id);
+			$new_line_items = $this->_insert_new_line_items($txn, $old_row);
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_line_table, $new_line_items);
+		}
+	}
     
-    private function _get_txn($txn_id)
-    {
-        global $wpdb;
-        $txn = $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->_new_transaction_table WHERE TXN_ID=%d", $txn_id), ARRAY_A);
-        return $txn;
-    }
+	private function _get_txn($txn_id)
+	{
+		global $wpdb;
+		$txn = $wpdb->get_row($wpdb->prepare("SELECT * FROM $this->_new_transaction_table WHERE TXN_ID=%d", $txn_id), ARRAY_A);
+		return $txn;
+	}
     
-    /**
-     * In 4.1, we'd normally need more info than just the registrations to make the line items. Ie, we'd need
-     * the transaction, and tax prices at the time of registration. (And probably promotions and other price factors).
-     * But seeing how these are REGs created from 3.1 attendee data, which have
-     * @param array $transaction
-     * @return array new line item ids
-     */
-    private function _insert_new_line_items($transaction, $old_attendee)
-    {
-        global $wpdb;
-        $regs_on_this_transaction = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_new_reg_table." WHERE TXN_ID=%d", $transaction['TXN_ID']), ARRAY_A);
-        $new_line_item_ids = array();
-        // create a totla line item
-        $total_line_item_id = $this->_insert_new_line_item(array(
-            'LIN_code'=>'total',
-            'TXN_ID'=>$transaction['TXN_ID'],
-            'LIN_name'=>  __("Total", "event_espresso"),
-            'LIN_total'=>$transaction['TXN_total'],
-            'LIN_type'=>'total',
-            'OBJ_ID'=>$transaction['TXN_ID'],
-            'OBJ_type'=>'Transaction'
-        ), $old_attendee);
-        $new_line_item_ids[] = $total_line_item_id;
-        // create a subtotal line item
-        $reg_total = 0;
-        foreach ($regs_on_this_transaction as $new_reg) {
-            $reg_total += floatval($new_reg['REG_final_price']);
-        }
-        $subtotal_line_item_id = $this->_insert_new_line_item(array(
-            'LIN_code'=>'sub-total',
-            'TXN_ID'=>$transaction['TXN_ID'],
-            'LIN_name'=>  __("Subtotal", "event_espresso"),
-            'LIN_total'=>$reg_total,
-            'LIN_parent'=>$total_line_item_id,
-            'LIN_type'=>'sub-total',
-        ), $old_attendee);
-        $new_line_item_ids[] = $subtotal_line_item_id;
-        // group REGs by TKT_ID
-        $regs_by_tkt = array();
-        foreach ($regs_on_this_transaction as $new_reg) {
-            $regs_by_tkt[ $new_reg['TKT_ID'] ][] = $new_reg;
-        }
+	/**
+	 * In 4.1, we'd normally need more info than just the registrations to make the line items. Ie, we'd need
+	 * the transaction, and tax prices at the time of registration. (And probably promotions and other price factors).
+	 * But seeing how these are REGs created from 3.1 attendee data, which have
+	 * @param array $transaction
+	 * @return array new line item ids
+	 */
+	private function _insert_new_line_items($transaction, $old_attendee)
+	{
+		global $wpdb;
+		$regs_on_this_transaction = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_new_reg_table." WHERE TXN_ID=%d", $transaction['TXN_ID']), ARRAY_A);
+		$new_line_item_ids = array();
+		// create a totla line item
+		$total_line_item_id = $this->_insert_new_line_item(array(
+			'LIN_code'=>'total',
+			'TXN_ID'=>$transaction['TXN_ID'],
+			'LIN_name'=>  __("Total", "event_espresso"),
+			'LIN_total'=>$transaction['TXN_total'],
+			'LIN_type'=>'total',
+			'OBJ_ID'=>$transaction['TXN_ID'],
+			'OBJ_type'=>'Transaction'
+		), $old_attendee);
+		$new_line_item_ids[] = $total_line_item_id;
+		// create a subtotal line item
+		$reg_total = 0;
+		foreach ($regs_on_this_transaction as $new_reg) {
+			$reg_total += floatval($new_reg['REG_final_price']);
+		}
+		$subtotal_line_item_id = $this->_insert_new_line_item(array(
+			'LIN_code'=>'sub-total',
+			'TXN_ID'=>$transaction['TXN_ID'],
+			'LIN_name'=>  __("Subtotal", "event_espresso"),
+			'LIN_total'=>$reg_total,
+			'LIN_parent'=>$total_line_item_id,
+			'LIN_type'=>'sub-total',
+		), $old_attendee);
+		$new_line_item_ids[] = $subtotal_line_item_id;
+		// group REGs by TKT_ID
+		$regs_by_tkt = array();
+		foreach ($regs_on_this_transaction as $new_reg) {
+			$regs_by_tkt[ $new_reg['TKT_ID'] ][] = $new_reg;
+		}
         
-        // create individual line items
+		// create individual line items
         
-        foreach ($regs_by_tkt as $ticket_id => $regs) {
-            $count = count($regs);
-            $line_total = 0;
-            foreach ($regs as $new_reg) {
-                $line_total += $new_reg['REG_final_price'];
-            }
-            $a_reg = reset($regs);
-            $new_ticket = $this->_get_new_ticket_row($a_reg['TKT_ID']);
-            $reg_line_item_id = $this->_insert_new_line_item(array(
-                'LIN_code'=> md5('Ticket' . $ticket_id . time()),
-                'TXN_ID'=>$transaction['TXN_ID'],
-                'LIN_name'=>$new_ticket['TKT_name'],
-                'LIN_unit_price'=>$a_reg['REG_final_price'],
-                'LIN_is_taxable'=>false,
-                'LIN_total'=>$line_total,
-                'LIN_quantity'=>$count,
-                'LIN_parent'=>$subtotal_line_item_id,
-                'OBJ_ID'=>$ticket_id,
-                'OBJ_type'=>'Ticket'
-            ), $old_attendee);
-            $new_line_item_ids[] = $reg_line_item_id;
-        }
+		foreach ($regs_by_tkt as $ticket_id => $regs) {
+			$count = count($regs);
+			$line_total = 0;
+			foreach ($regs as $new_reg) {
+				$line_total += $new_reg['REG_final_price'];
+			}
+			$a_reg = reset($regs);
+			$new_ticket = $this->_get_new_ticket_row($a_reg['TKT_ID']);
+			$reg_line_item_id = $this->_insert_new_line_item(array(
+				'LIN_code'=> md5('Ticket' . $ticket_id . time()),
+				'TXN_ID'=>$transaction['TXN_ID'],
+				'LIN_name'=>$new_ticket['TKT_name'],
+				'LIN_unit_price'=>$a_reg['REG_final_price'],
+				'LIN_is_taxable'=>false,
+				'LIN_total'=>$line_total,
+				'LIN_quantity'=>$count,
+				'LIN_parent'=>$subtotal_line_item_id,
+				'OBJ_ID'=>$ticket_id,
+				'OBJ_type'=>'Ticket'
+			), $old_attendee);
+			$new_line_item_ids[] = $reg_line_item_id;
+		}
         
             
         
-        return $new_line_item_ids;
-    }
-    /**
-     * Gets the full ticket by ID
-     * @global type $wpdb
-     * @param type $new_ticket_id
-     * @return array
-     */
-    private function _get_new_ticket_row($new_ticket_id)
-    {
-        global $wpdb;
-        $ticket_row = $wpdb->get_row($wpdb->prepare("SELECT * FROM ".$wpdb->prefix."esp_ticket WHERE TKT_ID=%d", $new_ticket_id), ARRAY_A);
-        return $ticket_row;
-    }
+		return $new_line_item_ids;
+	}
+	/**
+	 * Gets the full ticket by ID
+	 * @global type $wpdb
+	 * @param type $new_ticket_id
+	 * @return array
+	 */
+	private function _get_new_ticket_row($new_ticket_id)
+	{
+		global $wpdb;
+		$ticket_row = $wpdb->get_row($wpdb->prepare("SELECT * FROM ".$wpdb->prefix."esp_ticket WHERE TKT_ID=%d", $new_ticket_id), ARRAY_A);
+		return $ticket_row;
+	}
     
-    private function _insert_new_line_item($cols_n_values, $old_attendee)
-    {
-        global $wpdb;
-        $default_cols_n_values = array(
-            'LIN_code'=>'',
-            'TXN_ID'=>0,
-            'LIN_name'=>'',
-            'LIN_desc'=>'',
-            'LIN_unit_price'=>0,
-            'LIN_percent'=>0,
-            'LIN_is_taxable'=>false,
-            'LIN_order'=>0,
-            'LIN_total'=>0,
-            'LIN_quantity'=>null,
-            'LIN_parent'=>0,
-            'LIN_type'=>'line-item',
-            'OBJ_ID'=>null,
-            'OBJ_type'=>null
-        );
-        $cols_n_values = array_merge($default_cols_n_values, $cols_n_values);
-            $datatypes = array(
-                '%s',// LIN_code
-                '%d',// TXN_ID
-                '%s',// LIN_name
-                '%s',// LIN_desc
-                '%f',// LIN_unit_price
-                '%f',// LIN_percent
-                '%d',// LIN_is_taxable
-                '%d',// LIN_order
-                '%f',// LIN_total
-                '%d',// LIN_quantity
-                '%d',// LIN_parent
-                '%s',// LIN_type
-                '%d',// OBJ_ID
-                '%s',// OBJ_type
-            );
-            $success = $wpdb->insert($this->_new_line_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-            return $wpdb->insert_id;
-    }
+	private function _insert_new_line_item($cols_n_values, $old_attendee)
+	{
+		global $wpdb;
+		$default_cols_n_values = array(
+			'LIN_code'=>'',
+			'TXN_ID'=>0,
+			'LIN_name'=>'',
+			'LIN_desc'=>'',
+			'LIN_unit_price'=>0,
+			'LIN_percent'=>0,
+			'LIN_is_taxable'=>false,
+			'LIN_order'=>0,
+			'LIN_total'=>0,
+			'LIN_quantity'=>null,
+			'LIN_parent'=>0,
+			'LIN_type'=>'line-item',
+			'OBJ_ID'=>null,
+			'OBJ_type'=>null
+		);
+		$cols_n_values = array_merge($default_cols_n_values, $cols_n_values);
+			$datatypes = array(
+				'%s',// LIN_code
+				'%d',// TXN_ID
+				'%s',// LIN_name
+				'%s',// LIN_desc
+				'%f',// LIN_unit_price
+				'%f',// LIN_percent
+				'%d',// LIN_is_taxable
+				'%d',// LIN_order
+				'%f',// LIN_total
+				'%d',// LIN_quantity
+				'%d',// LIN_parent
+				'%s',// LIN_type
+				'%d',// OBJ_ID
+				'%s',// OBJ_type
+			);
+			$success = $wpdb->insert($this->_new_line_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+			return $wpdb->insert_id;
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -48,7 +48,7 @@ 
         $this->_old_table = $wpdb->prefix."events_attendee";
         $this->select_expression = 'att.*, e.event_status';
         $this->_extra_where_sql = ' AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_new_transaction_table = $wpdb->prefix."esp_transaction";
         $this->_new_line_table = $wpdb->prefix."esp_line_item";
@@ -61,7 +61,7 @@ 
         // insert line items if its a primary id
         if (intval($old_row['is_primary'])) {
             $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $this->_new_transaction_table);
-            if (! $txn_id) {
+            if ( ! $txn_id) {
                 $this->add_error(sprintf(__("Could not find the transaction for the 3.1 attendee %d from row %s", "event_espresso"), $old_row['id'], $this->_json_encode($old_row)));
                 return;
             }
@@ -118,7 +118,7 @@ 
         // group REGs by TKT_ID
         $regs_by_tkt = array();
         foreach ($regs_on_this_transaction as $new_reg) {
-            $regs_by_tkt[ $new_reg['TKT_ID'] ][] = $new_reg;
+            $regs_by_tkt[$new_reg['TKT_ID']][] = $new_reg;
         }
         
         // create individual line items
@@ -132,7 +132,7 @@ 
             $a_reg = reset($regs);
             $new_ticket = $this->_get_new_ticket_row($a_reg['TKT_ID']);
             $reg_line_item_id = $this->_insert_new_line_item(array(
-                'LIN_code'=> md5('Ticket' . $ticket_id . time()),
+                'LIN_code'=> md5('Ticket'.$ticket_id.time()),
                 'TXN_ID'=>$transaction['TXN_ID'],
                 'LIN_name'=>$new_ticket['TKT_name'],
                 'LIN_unit_price'=>$a_reg['REG_final_price'],
@@ -184,23 +184,23 @@ 
         );
         $cols_n_values = array_merge($default_cols_n_values, $cols_n_values);
             $datatypes = array(
-                '%s',// LIN_code
-                '%d',// TXN_ID
-                '%s',// LIN_name
-                '%s',// LIN_desc
-                '%f',// LIN_unit_price
-                '%f',// LIN_percent
-                '%d',// LIN_is_taxable
-                '%d',// LIN_order
-                '%f',// LIN_total
-                '%d',// LIN_quantity
-                '%d',// LIN_parent
-                '%s',// LIN_type
-                '%d',// OBJ_ID
-                '%s',// OBJ_type
+                '%s', // LIN_code
+                '%d', // TXN_ID
+                '%s', // LIN_name
+                '%s', // LIN_desc
+                '%f', // LIN_unit_price
+                '%f', // LIN_percent
+                '%d', // LIN_is_taxable
+                '%d', // LIN_order
+                '%f', // LIN_total
+                '%d', // LIN_quantity
+                '%d', // LIN_parent
+                '%s', // LIN_type
+                '%d', // OBJ_ID
+                '%s', // OBJ_type
             );
             $success = $wpdb->insert($this->_new_line_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
             return 0;
         }

core/services/assets/Registry.php

Indentation +584 added lines, -584 removed lines

@@ -23,595 +23,595 @@
 class Registry
 {
 
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
-
-    /**
-     * @var AssetCollection $assets
-     */
-    protected $assets;
-
-    /**
-     * @var I18nRegistry
-     */
-    private $i18n_registry;
-
-    /**
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $jsdata = array();
-
-    /**
-     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
-     * page source.
-     *
-     * @var array
-     */
-    private $script_handles_with_data = array();
-
-
-    /**
-     * Holds the manifest data obtained from registered manifest files.
-     * Manifests are maps of asset chunk name to actual built asset file names.
-     * Shape of this array is:
-     * array(
-     *  'some_namespace_slug' => array(
-     *      'some_chunk_name' => array(
-     *          'js' => 'filename.js'
-     *          'css' => 'filename.js'
-     *      ),
-     *      'url_base' => 'https://baseurl.com/to/assets
-     *  )
-     * )
-     *
-     * @var array
-     */
-    private $manifest_data = array();
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param AssetCollection $assets
-     * @param I18nRegistry    $i18n_registry
-     */
-    public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
-    {
-        $this->assets = $assets;
-        $this->i18n_registry = $i18n_registry;
-        add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-    /**
-     * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
-     * translation handling.
-     *
-     * @return I18nRegistry
-     */
-    public function getI18nRegistry()
-    {
-        return $this->i18n_registry;
-    }
-
-
-    /**
-     * Callback for the wp_enqueue_scripts actions used to register assets.
-     *
-     * @since 4.9.62.p
-     * @throws Exception
-     */
-    public function registerScriptsAndStyles()
-    {
-        try {
-            $this->registerScripts($this->assets->getJavascriptAssets());
-            $this->registerStyles($this->assets->getStylesheetAssets());
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Registers JS assets with WP core
-     *
-     * @since 4.9.62.p
-     * @param JavascriptAsset[] $scripts
-     * @throws AssetRegistrationException
-     * @throws InvalidDataTypeException
-     */
-    public function registerScripts(array $scripts)
-    {
-        foreach ($scripts as $script) {
-            // skip to next script if this has already been done
-            if ($script->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-                $script
-            );
-            $registered = wp_register_script(
-                $script->handle(),
-                $script->source(),
-                $script->dependencies(),
-                $script->version(),
-                $script->loadInFooter()
-            );
-            if (! $registered && $this->debug()) {
-                throw new AssetRegistrationException($script->handle());
-            }
-            $script->setRegistered($registered);
-            if ($script->requiresTranslation()) {
-                $this->registerTranslation($script->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
-                $script
-            );
-        }
-    }
-
-
-    /**
-     * Registers CSS assets with WP core
-     *
-     * @since 4.9.62.p
-     * @param StylesheetAsset[] $styles
-     * @throws InvalidDataTypeException
-     */
-    public function registerStyles(array $styles)
-    {
-        foreach ($styles as $style) {
-            // skip to next style if this has already been done
-            if ($style->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
-                $style
-            );
-            wp_register_style(
-                $style->handle(),
-                $style->source(),
-                $style->dependencies(),
-                $style->version(),
-                $style->media()
-            );
-            $style->setRegistered();
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
-                $style
-            );
-        }
-    }
-
-
-    /**
-     * Call back for the script print in frontend and backend.
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
-     *
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        $this->removeAlreadyRegisteredDataForScriptHandles();
-        wp_add_inline_script(
-            'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
-            'before'
-        );
-        $scripts = $this->assets->getJavascriptAssetsWithData();
-        foreach ($scripts as $script) {
-            $this->addRegisteredScriptHandlesWithData($script->handle());
-            if ($script->hasInlineDataCallback()) {
-                $localize = $script->inlineDataCallback();
-                $localize();
-            }
-        }
-    }
-
-
-    /**
-     * Used to add data to eejs.data object.
-     * Note:  Overriding existing data is not allowed.
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
-     * If the data you add is something like this:
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
-     * It will be exposed in the page source as:
-     *  eejs.data.my_plugin_data.foo == gar
-     *
-     * @param string       $key   Key used to access your data
-     * @param string|array $value Value to attach to key
-     * @throws InvalidArgumentException
-     */
-    public function addData($key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
-     * elements in an array.
-     *
-     * When you use this method, the value you include will be merged with the array on $key.
-     * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
-     * object like this, eejs.data.test = [ my_data,
-     * ]
-     * If there has already been a scalar value attached to the data object given key (via addData for instance), then
-     * this will throw an exception.
-     *
-     * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
-     * key potentially overriding the existing data on merge (specifically with associative arrays).
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData($key, $value)
-    {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
-        ) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
+	const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
+
+	/**
+	 * @var AssetCollection $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var I18nRegistry
+	 */
+	private $i18n_registry;
+
+	/**
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $jsdata = array();
+
+	/**
+	 * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
+	 * page source.
+	 *
+	 * @var array
+	 */
+	private $script_handles_with_data = array();
+
+
+	/**
+	 * Holds the manifest data obtained from registered manifest files.
+	 * Manifests are maps of asset chunk name to actual built asset file names.
+	 * Shape of this array is:
+	 * array(
+	 *  'some_namespace_slug' => array(
+	 *      'some_chunk_name' => array(
+	 *          'js' => 'filename.js'
+	 *          'css' => 'filename.js'
+	 *      ),
+	 *      'url_base' => 'https://baseurl.com/to/assets
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	private $manifest_data = array();
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param AssetCollection $assets
+	 * @param I18nRegistry    $i18n_registry
+	 */
+	public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
+	{
+		$this->assets = $assets;
+		$this->i18n_registry = $i18n_registry;
+		add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+	/**
+	 * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
+	 * translation handling.
+	 *
+	 * @return I18nRegistry
+	 */
+	public function getI18nRegistry()
+	{
+		return $this->i18n_registry;
+	}
+
+
+	/**
+	 * Callback for the wp_enqueue_scripts actions used to register assets.
+	 *
+	 * @since 4.9.62.p
+	 * @throws Exception
+	 */
+	public function registerScriptsAndStyles()
+	{
+		try {
+			$this->registerScripts($this->assets->getJavascriptAssets());
+			$this->registerStyles($this->assets->getStylesheetAssets());
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Registers JS assets with WP core
+	 *
+	 * @since 4.9.62.p
+	 * @param JavascriptAsset[] $scripts
+	 * @throws AssetRegistrationException
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerScripts(array $scripts)
+	{
+		foreach ($scripts as $script) {
+			// skip to next script if this has already been done
+			if ($script->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+				$script
+			);
+			$registered = wp_register_script(
+				$script->handle(),
+				$script->source(),
+				$script->dependencies(),
+				$script->version(),
+				$script->loadInFooter()
+			);
+			if (! $registered && $this->debug()) {
+				throw new AssetRegistrationException($script->handle());
+			}
+			$script->setRegistered($registered);
+			if ($script->requiresTranslation()) {
+				$this->registerTranslation($script->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
+				$script
+			);
+		}
+	}
+
+
+	/**
+	 * Registers CSS assets with WP core
+	 *
+	 * @since 4.9.62.p
+	 * @param StylesheetAsset[] $styles
+	 * @throws InvalidDataTypeException
+	 */
+	public function registerStyles(array $styles)
+	{
+		foreach ($styles as $style) {
+			// skip to next style if this has already been done
+			if ($style->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
+				$style
+			);
+			wp_register_style(
+				$style->handle(),
+				$style->source(),
+				$style->dependencies(),
+				$style->version(),
+				$style->media()
+			);
+			$style->setRegistered();
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
+				$style
+			);
+		}
+	}
+
+
+	/**
+	 * Call back for the script print in frontend and backend.
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
+	 *
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		$this->removeAlreadyRegisteredDataForScriptHandles();
+		wp_add_inline_script(
+			'eejs-core',
+			'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+			'before'
+		);
+		$scripts = $this->assets->getJavascriptAssetsWithData();
+		foreach ($scripts as $script) {
+			$this->addRegisteredScriptHandlesWithData($script->handle());
+			if ($script->hasInlineDataCallback()) {
+				$localize = $script->inlineDataCallback();
+				$localize();
+			}
+		}
+	}
+
+
+	/**
+	 * Used to add data to eejs.data object.
+	 * Note:  Overriding existing data is not allowed.
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
+	 * If the data you add is something like this:
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
+	 * It will be exposed in the page source as:
+	 *  eejs.data.my_plugin_data.foo == gar
+	 *
+	 * @param string       $key   Key used to access your data
+	 * @param string|array $value Value to attach to key
+	 * @throws InvalidArgumentException
+	 */
+	public function addData($key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->jsdata[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
+	 * elements in an array.
+	 *
+	 * When you use this method, the value you include will be merged with the array on $key.
+	 * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
+	 * object like this, eejs.data.test = [ my_data,
+	 * ]
+	 * If there has already been a scalar value attached to the data object given key (via addData for instance), then
+	 * this will throw an exception.
+	 *
+	 * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
+	 * key potentially overriding the existing data on merge (specifically with associative arrays).
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData($key, $value)
+	{
+		if (isset($this->jsdata[ $key ])
+			&& ! is_array($this->jsdata[ $key ])
+		) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                          push values to this data element when it is an array.',
-                        'event_espresso'
-                    ),
-                    $key,
-                    __METHOD__
-                )
-            );
-        }
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
-        } else {
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
-        }
-    }
-
-
-    /**
-     * Used to set content used by javascript for a template.
-     * Note: Overrides of existing registered templates are not allowed.
-     *
-     * @param string $template_reference
-     * @param string $template_content
-     * @throws InvalidArgumentException
-     */
-    public function addTemplate($template_reference, $template_content)
-    {
-        if (! isset($this->jsdata['templates'])) {
-            $this->jsdata['templates'] = array();
-        }
-        //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
-    }
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate($template_reference)
-    {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['templates'][ $template_reference ]
-            : '';
-    }
-
-
-    /**
-     * Retrieve registered data.
-     *
-     * @param string $key Name of key to attach data to.
-     * @return mixed                If there is no for the given key, then false is returned.
-     */
-    public function getData($key)
-    {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
-            : false;
-    }
-
-
-    /**
-     * Verifies whether the given data exists already on the jsdata array.
-     * Overriding data is not allowed.
-     *
-     * @param string $key Index for data.
-     * @return bool        If valid then return true.
-     * @throws InvalidArgumentException if data already exists.
-     */
-    protected function verifyDataNotExisting($key)
-    {
-        if (isset($this->jsdata[ $key ])) {
-            if (! $this->debug()) {
-                return false;
-            }
-            if (is_array($this->jsdata[ $key ])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		if ( ! isset( $this->jsdata[ $key ] ) ) {
+			$this->jsdata[ $key ] = is_array($value) ? $value : [$value];
+		} else {
+			$this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
+		}
+	}
+
+
+	/**
+	 * Used to set content used by javascript for a template.
+	 * Note: Overrides of existing registered templates are not allowed.
+	 *
+	 * @param string $template_reference
+	 * @param string $template_content
+	 * @throws InvalidArgumentException
+	 */
+	public function addTemplate($template_reference, $template_content)
+	{
+		if (! isset($this->jsdata['templates'])) {
+			$this->jsdata['templates'] = array();
+		}
+		//no overrides allowed.
+		if (isset($this->jsdata['templates'][ $template_reference ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->jsdata['templates'][ $template_reference ] = $template_content;
+	}
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate($template_reference)
+	{
+		return isset($this->jsdata['templates'][ $template_reference ])
+			? $this->jsdata['templates'][ $template_reference ]
+			: '';
+	}
+
+
+	/**
+	 * Retrieve registered data.
+	 *
+	 * @param string $key Name of key to attach data to.
+	 * @return mixed                If there is no for the given key, then false is returned.
+	 */
+	public function getData($key)
+	{
+		return isset($this->jsdata[ $key ])
+			? $this->jsdata[ $key ]
+			: false;
+	}
+
+
+	/**
+	 * Verifies whether the given data exists already on the jsdata array.
+	 * Overriding data is not allowed.
+	 *
+	 * @param string $key Index for data.
+	 * @return bool        If valid then return true.
+	 * @throws InvalidArgumentException if data already exists.
+	 */
+	protected function verifyDataNotExisting($key)
+	{
+		if (isset($this->jsdata[ $key ])) {
+			if (! $this->debug()) {
+				return false;
+			}
+			if (is_array($this->jsdata[ $key ])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						__(
+							'The value for %1$s already exists in the Registry::eejs object.
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
                             %2$s method to push your value to the array.',
-                            'event_espresso'
-                        ),
-                        $key,
-                        'pushData()'
-                    )
-                );
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                         allowed.  Consider attaching your value to a different key',
-                        'event_espresso'
-                    ),
-                    $key
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Get the actual asset path for asset manifests.
-     * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
-     *
-     * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
-     *                           asset file location.
-     * @param string $chunk_name
-     * @param string $asset_type
-     * @return string
-     * @since 4.9.59.p
-     */
-    public function getAssetUrl($namespace, $chunk_name, $asset_type)
-    {
-        $url = isset(
-            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
-            $this->manifest_data[ $namespace ]['url_base']
-        )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
-            : $chunk_name;
-
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
-            $url,
-            $namespace,
-            $chunk_name,
-            $asset_type
-        );
-    }
-
-
-
-    /**
-     * Return the url to a js file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getJsUrl($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
-    }
-
-
-    /**
-     * Return the url to a css file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getCssUrl($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     */
-    public function registerManifestFiles()
-    {
-        $manifest_files = $this->assets->getManifestFiles();
-        foreach ($manifest_files as $manifest_file) {
-            $this->registerManifestFile(
-                $manifest_file->assetNamespace(),
-                $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
-            );
-        }
-    }
-
-
-    /**
-     * Used to register a js/css manifest file with the registered_manifest_files property.
-     *
-     * @param string $namespace     Provided to associate the manifest file with a specific namespace.
-     * @param string $url_base      The url base for the manifest file location.
-     * @param string $manifest_file The absolute path to the manifest file.
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     * @since 4.9.59.p
-     */
-    public function registerManifestFile($namespace, $url_base, $manifest_file)
-    {
-        if (isset($this->manifest_data[ $namespace ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The namespace for this manifest file has already been registered, choose a namespace other than %s',
-                        'event_espresso'
-                    ),
-                    $namespace
-                )
-            );
-        }
-        if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
-            if (is_admin()) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
-                            'event_espresso'
-                        ),
-                        'Event Espresso',
-                        $url_base,
-                        'plugins_url',
-                        'WP_PLUGIN_URL'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return;
-        }
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
-        }
-    }
-
-
-    /**
-     * Decodes json from the provided manifest file.
-     *
-     * @since 4.9.59.p
-     * @param string $manifest_file Path to manifest file.
-     * @return array
-     * @throws InvalidFilePathException
-     */
-    private function decodeManifestFile($manifest_file)
-    {
-        if (! file_exists($manifest_file)) {
-            throw new InvalidFilePathException($manifest_file);
-        }
-        return json_decode(file_get_contents($manifest_file), true);
-    }
-
-
-    /**
-     * This is used to set registered script handles that have data.
-     *
-     * @param string $script_handle
-     */
-    private function addRegisteredScriptHandlesWithData($script_handle)
-    {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
-    }
-
-
-    /**i
+						'event_espresso'
+					),
+					$key
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Get the actual asset path for asset manifests.
+	 * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
+	 *
+	 * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
+	 *                           asset file location.
+	 * @param string $chunk_name
+	 * @param string $asset_type
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	public function getAssetUrl($namespace, $chunk_name, $asset_type)
+	{
+		$url = isset(
+			$this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
+			$this->manifest_data[ $namespace ]['url_base']
+		)
+			? $this->manifest_data[ $namespace ]['url_base']
+			  . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
+			: $chunk_name;
+
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
+			$url,
+			$namespace,
+			$chunk_name,
+			$asset_type
+		);
+	}
+
+
+
+	/**
+	 * Return the url to a js file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getJsUrl($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * Return the url to a css file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getCssUrl($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 */
+	public function registerManifestFiles()
+	{
+		$manifest_files = $this->assets->getManifestFiles();
+		foreach ($manifest_files as $manifest_file) {
+			$this->registerManifestFile(
+				$manifest_file->assetNamespace(),
+				$manifest_file->urlBase(),
+				$manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
+			);
+		}
+	}
+
+
+	/**
+	 * Used to register a js/css manifest file with the registered_manifest_files property.
+	 *
+	 * @param string $namespace     Provided to associate the manifest file with a specific namespace.
+	 * @param string $url_base      The url base for the manifest file location.
+	 * @param string $manifest_file The absolute path to the manifest file.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 * @since 4.9.59.p
+	 */
+	public function registerManifestFile($namespace, $url_base, $manifest_file)
+	{
+		if (isset($this->manifest_data[ $namespace ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The namespace for this manifest file has already been registered, choose a namespace other than %s',
+						'event_espresso'
+					),
+					$namespace
+				)
+			);
+		}
+		if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
+			if (is_admin()) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
+							'event_espresso'
+						),
+						'Event Espresso',
+						$url_base,
+						'plugins_url',
+						'WP_PLUGIN_URL'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return;
+		}
+		$this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
+		if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
+			$this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
+		}
+	}
+
+
+	/**
+	 * Decodes json from the provided manifest file.
+	 *
+	 * @since 4.9.59.p
+	 * @param string $manifest_file Path to manifest file.
+	 * @return array
+	 * @throws InvalidFilePathException
+	 */
+	private function decodeManifestFile($manifest_file)
+	{
+		if (! file_exists($manifest_file)) {
+			throw new InvalidFilePathException($manifest_file);
+		}
+		return json_decode(file_get_contents($manifest_file), true);
+	}
+
+
+	/**
+	 * This is used to set registered script handles that have data.
+	 *
+	 * @param string $script_handle
+	 */
+	private function addRegisteredScriptHandlesWithData($script_handle)
+	{
+		$this->script_handles_with_data[ $script_handle ] = $script_handle;
+	}
+
+
+	/**i
      * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
      * Dependency stored in WP_Scripts if its set.
      */
-    private function removeAlreadyRegisteredDataForScriptHandles()
-    {
-        if (empty($this->script_handles_with_data)) {
-            return;
-        }
-        foreach ($this->script_handles_with_data as $script_handle) {
-            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
-        }
-    }
-
-
-    /**
-     * Removes any data dependency registered in WP_Scripts if its set.
-     *
-     * @param string $script_handle
-     */
-    private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
-    {
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
-            global $wp_scripts;
-            $unset_handle = false;
-            if ($wp_scripts->get_data($script_handle, 'data')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
-                $unset_handle = true;
-            }
-            //deal with inline_scripts
-            if ($wp_scripts->get_data($script_handle, 'before')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
-                $unset_handle = true;
-            }
-            if ($wp_scripts->get_data($script_handle, 'after')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
-            }
-            if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
-            }
-        }
-    }
-
-
-    /**
-     * register translations for a registered script
-     *
-     * @param string $handle
-     */
-    public function registerTranslation($handle)
-    {
-        $this->i18n_registry->registerScriptI18n($handle);
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @return bool
-     */
-    private function debug()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__debug',
-            defined('EE_DEBUG') && EE_DEBUG
-        );
-    }
+	private function removeAlreadyRegisteredDataForScriptHandles()
+	{
+		if (empty($this->script_handles_with_data)) {
+			return;
+		}
+		foreach ($this->script_handles_with_data as $script_handle) {
+			$this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
+		}
+	}
+
+
+	/**
+	 * Removes any data dependency registered in WP_Scripts if its set.
+	 *
+	 * @param string $script_handle
+	 */
+	private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
+	{
+		if (isset($this->script_handles_with_data[ $script_handle ])) {
+			global $wp_scripts;
+			$unset_handle = false;
+			if ($wp_scripts->get_data($script_handle, 'data')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['data']);
+				$unset_handle = true;
+			}
+			//deal with inline_scripts
+			if ($wp_scripts->get_data($script_handle, 'before')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['before']);
+				$unset_handle = true;
+			}
+			if ($wp_scripts->get_data($script_handle, 'after')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['after']);
+			}
+			if ($unset_handle) {
+				unset($this->script_handles_with_data[ $script_handle ]);
+			}
+		}
+	}
+
+
+	/**
+	 * register translations for a registered script
+	 *
+	 * @param string $handle
+	 */
+	public function registerTranslation($handle)
+	{
+		$this->i18n_registry->registerScriptI18n($handle);
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @return bool
+	 */
+	private function debug()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__debug',
+			defined('EE_DEBUG') && EE_DEBUG
+		);
+	}
 }

Spacing +37 added lines, -37 removed lines

@@ -147,7 +147,7 @@ 
                 $script->version(),
                 $script->loadInFooter()
             );
-            if (! $registered && $this->debug()) {
+            if ( ! $registered && $this->debug()) {
                 throw new AssetRegistrationException($script->handle());
             }
             $script->setRegistered($registered);
@@ -207,7 +207,7 @@ 
         $this->removeAlreadyRegisteredDataForScriptHandles();
         wp_add_inline_script(
             'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+            'var eejsdata='.wp_json_encode(array('data' => $this->jsdata)),
             'before'
         );
         $scripts = $this->assets->getJavascriptAssetsWithData();
@@ -237,7 +237,7 @@ 
     public function addData($key, $value)
     {
         if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $key ] = $value;
+            $this->jsdata[$key] = $value;
         }
     }
 
@@ -262,10 +262,10 @@ 
      */
     public function pushData($key, $value)
     {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
+        if (isset($this->jsdata[$key])
+            && ! is_array($this->jsdata[$key])
         ) {
-            if (! $this->debug()) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -280,10 +280,10 @@ 
                 )
             );
         }
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
+        if ( ! isset($this->jsdata[$key])) {
+            $this->jsdata[$key] = is_array($value) ? $value : [$value];
         } else {
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
+            $this->jsdata[$key] = array_merge($this->jsdata[$key], (array) $value);
         }
     }
 
@@ -298,12 +298,12 @@ 
      */
     public function addTemplate($template_reference, $template_content)
     {
-        if (! isset($this->jsdata['templates'])) {
+        if ( ! isset($this->jsdata['templates'])) {
             $this->jsdata['templates'] = array();
         }
         //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
+        if (isset($this->jsdata['templates'][$template_reference])) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -316,7 +316,7 @@ 
                 )
             );
         }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
+        $this->jsdata['templates'][$template_reference] = $template_content;
     }
 
 
@@ -328,8 +328,8 @@ 
      */
     public function getTemplate($template_reference)
     {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['templates'][ $template_reference ]
+        return isset($this->jsdata['templates'][$template_reference])
+            ? $this->jsdata['templates'][$template_reference]
             : '';
     }
 
@@ -342,8 +342,8 @@ 
      */
     public function getData($key)
     {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
+        return isset($this->jsdata[$key])
+            ? $this->jsdata[$key]
             : false;
     }
 
@@ -358,11 +358,11 @@ 
      */
     protected function verifyDataNotExisting($key)
     {
-        if (isset($this->jsdata[ $key ])) {
-            if (! $this->debug()) {
+        if (isset($this->jsdata[$key])) {
+            if ( ! $this->debug()) {
                 return false;
             }
-            if (is_array($this->jsdata[ $key ])) {
+            if (is_array($this->jsdata[$key])) {
                 throw new InvalidArgumentException(
                     sprintf(
                         __(
@@ -405,11 +405,11 @@ 
     public function getAssetUrl($namespace, $chunk_name, $asset_type)
     {
         $url = isset(
-            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
-            $this->manifest_data[ $namespace ]['url_base']
+            $this->manifest_data[$namespace][$chunk_name.'.'.$asset_type],
+            $this->manifest_data[$namespace]['url_base']
         )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
+            ? $this->manifest_data[$namespace]['url_base']
+              . $this->manifest_data[$namespace][$chunk_name.'.'.$asset_type]
             : $chunk_name;
 
         return apply_filters(
@@ -461,7 +461,7 @@ 
             $this->registerManifestFile(
                 $manifest_file->assetNamespace(),
                 $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
+                $manifest_file->filepath().Registry::FILE_NAME_BUILD_MANIFEST
             );
         }
     }
@@ -479,8 +479,8 @@ 
      */
     public function registerManifestFile($namespace, $url_base, $manifest_file)
     {
-        if (isset($this->manifest_data[ $namespace ])) {
-            if (! $this->debug()) {
+        if (isset($this->manifest_data[$namespace])) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -513,9 +513,9 @@ 
             }
             return;
         }
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
+        $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file);
+        if ( ! isset($this->manifest_data[$namespace]['url_base'])) {
+            $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base);
         }
     }
 
@@ -530,7 +530,7 @@ 
      */
     private function decodeManifestFile($manifest_file)
     {
-        if (! file_exists($manifest_file)) {
+        if ( ! file_exists($manifest_file)) {
             throw new InvalidFilePathException($manifest_file);
         }
         return json_decode(file_get_contents($manifest_file), true);
@@ -544,7 +544,7 @@ 
      */
     private function addRegisteredScriptHandlesWithData($script_handle)
     {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
+        $this->script_handles_with_data[$script_handle] = $script_handle;
     }
 
 
@@ -570,23 +570,23 @@ 
      */
     private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
     {
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
+        if (isset($this->script_handles_with_data[$script_handle])) {
             global $wp_scripts;
             $unset_handle = false;
             if ($wp_scripts->get_data($script_handle, 'data')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
+                unset($wp_scripts->registered[$script_handle]->extra['data']);
                 $unset_handle = true;
             }
             //deal with inline_scripts
             if ($wp_scripts->get_data($script_handle, 'before')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
+                unset($wp_scripts->registered[$script_handle]->extra['before']);
                 $unset_handle = true;
             }
             if ($wp_scripts->get_data($script_handle, 'after')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
+                unset($wp_scripts->registered[$script_handle]->extra['after']);
             }
             if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
+                unset($this->script_handles_with_data[$script_handle]);
             }
         }
     }