eventespresso / event-espresso-core

core/admin/EE_Admin_Page_Loader.core.php

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 
 use EventEspresso\core\domain\entities\notifications\PersistentAdminNotice;
-use EventEspresso\core\exceptions\InvalidDataTypeException;
 
 /**
  * Event Espresso

Indentation +673 added lines, -673 removed lines

@@ -24,677 +24,677 @@
 class EE_Admin_Page_Loader
 {
 
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var \EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = array();
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = array();
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = array();
-
-
-    /**
-     * _current_caf_extend_slug
-     * This property is used for holding the page slug that is required for referencing the correct
-     * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
-     *
-     * @var array
-     */
-    private $_current_caf_extend_slug;
-
-    /**
-     * _prepped_menu_maps
-     * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
-     *
-     * @since  4.4.0
-     * @var EE_Admin_Page_Menu_Map[]
-     */
-    private $_prepped_menu_maps = array();
-
-
-    /**
-     * _admin_menu_groups
-     * array that holds the group headings and details for
-     *
-     * @access private
-     * @var array
-     */
-    private $_admin_menu_groups = array();
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     * @return \EE_Admin_Page_Loader
-     */
-    public function __construct()
-    {
-        // load menu_map classes
-        EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
-        // define the default "groups" for the admin_pages
-        $this->_set_menu_groups();
-
-        // let's do a scan and see what installed pages we have
-        $this->_get_installed_pages();
-        // set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
-        add_action('admin_menu', array($this, 'set_menus'));
-        add_action('network_admin_menu', array($this, 'set_network_menus'));
-    }
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function _define_caffeinated_constants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-    /**
-     * _set_menu_groups
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_menu_groups()
-    {
-
-        // set array of EE_Admin_Page_Menu_Group objects
-        $groups = array(
-            'main'       => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Main', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
-                    'menu_slug'    => 'main',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 0,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'management' => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Management', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'management',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 10,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'settings'   => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Settings', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'settings',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 30,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'templates'  => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Templates', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'templates',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 40,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'extras'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'              => __('Extras', 'event_espresso'),
-                    'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_slug'               => 'extras',
-                    'capability'              => 'ee_read_ee',
-                    'menu_order'              => 50,
-                    'parent_slug'             => 'espresso_events',
-                    'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                )
-            ),
-            'tools'      => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __("Tools", "event_espresso"),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'tools',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 60,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'addons'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_label'   => __('Add-ons', 'event_espresso'),
-                    'menu_slug'    => 'addons',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 20,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-        );
-        $this->_admin_menu_groups = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            $groups
-        );
-    }
-
-
-    /**
-     * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
-     * slug.  The other utility with this function is it validates that all the groups are instances of
-     * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
-     *
-     * @since  4.4.0
-     * @throws \EE_Error
-     * @return EE_Admin_Page_Menu_Group[]
-     */
-    private function _rearrange_menu_groups()
-    {
-        $groups = array();
-        // first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
-        usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
-        foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
-                            'event_espresso'
-                        ),
-                        print_r($group, true)
-                    )
-                );
-            }
-            $groups[ $group->menu_slug ] = $group;
-        }
-        return $groups;
-    }
-
-
-    /**
-     * _get_installed_pages
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _get_installed_pages()
-    {
-        $installed_refs = array();
-        $exclude = array('assets', 'templates');
-        // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
-        if ($admin_screens) {
-            foreach ($admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
-                }
-            }
-        }
-        if (empty($installed_refs)) {
-            $error_msg[] = __(
-                'There are no EE_Admin pages detected, it looks like EE did not install properly',
-                'event_espresso'
-            );
-            $error_msg[] = $error_msg[0] . "\r\n"
-                           . sprintf(
-                               __(
-                                   'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                                   'event_espresso'
-                               ),
-                               EE_ADMIN_PAGES
-                           );
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        // this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-        $installed_refs = $this->_set_caffeinated($installed_refs);
-        // allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        $installed_refs = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $installed_refs
-        );
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-        // loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = array();
-        foreach ($installed_refs as $page => $path) {
-            // set autoloaders for our admin page classes based on included path information
-            EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
-            // build list of installed pages
-            $this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
-            // verify returned object
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
-                    continue;
-                }
-                // skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
-                if (empty($maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-                ) {
-                    unset($installed_refs[ $page ]);
-                    continue;
-                }
-                $menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[ $menu_slug ] = $page;
-                // flag for register hooks on extended pages b/c extended pages use the default INIT.
-                $extend = false;
-                // now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[ $page ])) {
-                    $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function ($path_to_file) use ($caf_path) {
-                            return $caf_path;
-                        }
-                    );
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page) {
-                            return $caf_admin_page;
-                        }
-                    );
-                    $extend = true;
-                }
-                // let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
-                $hooks_ref = array_merge($hooks_ref, $extended_hooks);
-            }
-        }
-        // the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
-        // first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        // now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            require_once($path);
-        }
-        // make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        // we need to loop again to run any early code
-        foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[ $page ]->do_initial_loads();
-            }
-        }
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object($page_slug = '')
-    {
-        if (isset($this->_installed_pages[ $page_slug ])) {
-            return $this->_installed_pages[ $page_slug ]->loaded_page_object();
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_classname_for_admin_page
-     * generates an "Admin Page" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-    }
-
-
-    /**
-     * _get_classname_for_admin_init_page
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_init_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param  string $page page_reference
-     * @param string  $path
-     * @throws EE_Error
-     * @return object|bool  return page object if valid, bool false if not.
-     */
-    private function _load_admin_page($page = '', $path = '')
-    {
-        $class_name = $this->_get_classname_for_admin_init_page($page);
-        EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
-            $inner_error_msg = '<br />'
-                               . sprintf(
-                                   esc_html__(
-                                       'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                                       'event_espresso'
-                                   ),
-                                   '<strong>' . $class_name . '</strong>'
-                               );
-            $error_msg[] = sprintf(
-                __('Something went wrong with loading the %s admin page.', 'event_espresso'),
-                $page
-            );
-            $error_msg[] = $error_msg[0]
-                           . "\r\n"
-                           . sprintf(
-                               esc_html__(
-                                   'There is no Init class in place for the %s admin page.',
-                                   'event_espresso'
-                               ),
-                               $page
-                           )
-                           . $inner_error_msg;
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        $a = new ReflectionClass($class_name);
-        return $a->newInstance();
-    }
-
-
-    /**
-     * set_menus
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @access private
-     * @return void
-     */
-    public function set_menus()
-    {
-        // prep the menu pages (sort, group.)
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(false);
-            }
-        }
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     */
-    public function set_network_menus()
-    {
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(true);
-            }
-        }
-    }
-
-
-    /**
-     * _prep_pages
-     * sets the _prepped_menu_maps property
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _prep_pages()
-    {
-        $pages_array = array();
-        // rearrange _admin_menu_groups to be indexed by group slug.
-        $menu_groups = $this->_rearrange_menu_groups();
-        foreach ($this->_installed_pages as $page) {
-            if ($page instanceof EE_Admin_page_Init) {
-                $page_map = $page->get_menu_map();
-                // if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
-                if (is_array($page_map) || empty($page_map)) {
-                    new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
-                        sprintf(
-                            __(
-                                'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
-                                'event_espresso'
-                            ),
-                            $page->label
-                        )
-                    );
-                    continue;
-                }
-                // if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
-                                'event_espresso'
-                            ),
-                            $page->label,
-                            $page_map
-                        )
-                    );
-                }
-                // use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
-                if (empty($page_map->maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level()
-                       == EE_Maintenance_Mode::level_2_complete_maintenance) {
-                    continue;
-                }
-                // assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[ $page_map->menu_group ][] = $page_map;
-            }
-        }
-        if (empty($pages_array)) {
-            throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
-        }
-        // let's sort the groups, make sure it's a valid group, add header (if to show).
-        foreach ($pages_array as $group => $menu_maps) {
-            // valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
-                continue;
-            }
-            // sort pages.
-            usort($menu_maps, array($this, '_sort_menu_maps'));
-            // prepend header
-            array_unshift($menu_maps, $menu_groups[ $group ]);
-            // reset $pages_array with prepped data
-            $pages_array[ $group ] = $menu_maps;
-        }
-        // now let's setup the _prepped_menu_maps property
-        foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[ $group ])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
-            }
-        }/**/
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     */
-    private function _set_caffeinated($installed_refs)
-    {
-
-        // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin') || (defined('EE_DECAF') && EE_DECAF)) {
-            return $installed_refs;
-        }
-        $this->_define_caffeinated_constants();
-        $exclude = array('tickets');
-        // okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
-        if ($new_admin_screens) {
-            foreach ($new_admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different NEW EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
-                }
-            }
-        }
-        // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
-        if ($extends) {
-            foreach ($extends as $extend) {
-                if (is_dir($extend)) {
-                    $extend_ref = basename($extend);
-                    // now let's make sure there is a file that matches the expected format
-                    $filename = str_replace(
-                        ' ',
-                        '_',
-                        ucwords(
-                            str_replace(
-                                '_',
-                                ' ',
-                                $extend_ref
-                            )
-                        )
-                    );
-                    $filename = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
-                        array('\\', '/'),
-                        '/',
-                        EE_CORE_CAF_ADMIN
-                        . 'extend/'
-                        . $extend_ref
-                        . '/'
-                        . $filename
-                        . '.core.php'
-                    );
-                    $this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
-                }
-            }
-        }
-        // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks = array();
-        $hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
-        if ($hooks) {
-            foreach ($hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
-                    $classname = str_replace('.class.php', '', $classname);
-                    if (class_exists($classname)) {
-                        $a = new ReflectionClass($classname);
-                        $ee_admin_hooks[] = $a->newInstance();
-                    }
-                }
-            }
-        }/**/
-        $ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-        return $installed_refs;
-    }
-
-
-    /**
-     * Utility method for sorting the _menu_maps (callback for usort php function)
-     *
-     * @since  4.4.0
-     * @param  EE_Admin_Page_Menu_Map $a menu_map object
-     * @param  EE_Admin_Page_Menu_Map $b being compared to
-     * @return int    sort order
-     */
-    private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
-    {
-        if ($a->menu_order == $b->menu_order) {
-            return 0;
-        }
-        return ($a->menu_order < $b->menu_order) ? -1 : 1;
-    }
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link()
-    {
-        return false;
-    }
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var \EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = array();
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = array();
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = array();
+
+
+	/**
+	 * _current_caf_extend_slug
+	 * This property is used for holding the page slug that is required for referencing the correct
+	 * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
+	 *
+	 * @var array
+	 */
+	private $_current_caf_extend_slug;
+
+	/**
+	 * _prepped_menu_maps
+	 * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
+	 *
+	 * @since  4.4.0
+	 * @var EE_Admin_Page_Menu_Map[]
+	 */
+	private $_prepped_menu_maps = array();
+
+
+	/**
+	 * _admin_menu_groups
+	 * array that holds the group headings and details for
+	 *
+	 * @access private
+	 * @var array
+	 */
+	private $_admin_menu_groups = array();
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 * @return \EE_Admin_Page_Loader
+	 */
+	public function __construct()
+	{
+		// load menu_map classes
+		EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
+		// define the default "groups" for the admin_pages
+		$this->_set_menu_groups();
+
+		// let's do a scan and see what installed pages we have
+		$this->_get_installed_pages();
+		// set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
+		add_action('admin_menu', array($this, 'set_menus'));
+		add_action('network_admin_menu', array($this, 'set_network_menus'));
+	}
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _define_caffeinated_constants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+	/**
+	 * _set_menu_groups
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_menu_groups()
+	{
+
+		// set array of EE_Admin_Page_Menu_Group objects
+		$groups = array(
+			'main'       => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Main', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
+					'menu_slug'    => 'main',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 0,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'management' => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Management', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'management',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 10,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'settings'   => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Settings', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'settings',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 30,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'templates'  => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Templates', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'templates',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 40,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'extras'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'              => __('Extras', 'event_espresso'),
+					'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_slug'               => 'extras',
+					'capability'              => 'ee_read_ee',
+					'menu_order'              => 50,
+					'parent_slug'             => 'espresso_events',
+					'maintenance_mode_parent' => 'espresso_maintenance_settings',
+				)
+			),
+			'tools'      => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __("Tools", "event_espresso"),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'tools',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 60,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'addons'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_label'   => __('Add-ons', 'event_espresso'),
+					'menu_slug'    => 'addons',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 20,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+		);
+		$this->_admin_menu_groups = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			$groups
+		);
+	}
+
+
+	/**
+	 * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
+	 * slug.  The other utility with this function is it validates that all the groups are instances of
+	 * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
+	 *
+	 * @since  4.4.0
+	 * @throws \EE_Error
+	 * @return EE_Admin_Page_Menu_Group[]
+	 */
+	private function _rearrange_menu_groups()
+	{
+		$groups = array();
+		// first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
+		usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
+		foreach ($this->_admin_menu_groups as $group) {
+			if (! $group instanceof EE_Admin_Page_Menu_Group) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
+							'event_espresso'
+						),
+						print_r($group, true)
+					)
+				);
+			}
+			$groups[ $group->menu_slug ] = $group;
+		}
+		return $groups;
+	}
+
+
+	/**
+	 * _get_installed_pages
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _get_installed_pages()
+	{
+		$installed_refs = array();
+		$exclude = array('assets', 'templates');
+		// grab everything in the  admin core directory
+		$admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+		if ($admin_screens) {
+			foreach ($admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different EE admin pages
+					$installed_refs[ basename($admin_screen) ] = $admin_screen;
+				}
+			}
+		}
+		if (empty($installed_refs)) {
+			$error_msg[] = __(
+				'There are no EE_Admin pages detected, it looks like EE did not install properly',
+				'event_espresso'
+			);
+			$error_msg[] = $error_msg[0] . "\r\n"
+						   . sprintf(
+							   __(
+								   'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+								   'event_espresso'
+							   ),
+							   EE_ADMIN_PAGES
+						   );
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		// this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+		$installed_refs = $this->_set_caffeinated($installed_refs);
+		// allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		$installed_refs = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$installed_refs
+		);
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+		// loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = array();
+		foreach ($installed_refs as $page => $path) {
+			// set autoloaders for our admin page classes based on included path information
+			EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
+			// build list of installed pages
+			$this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
+			// verify returned object
+			if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
+				if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+					continue;
+				}
+				// skip if in full maintenance mode and maintenance_mode_parent is set
+				$maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
+				if (empty($maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+				) {
+					unset($installed_refs[ $page ]);
+					continue;
+				}
+				$menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
+				$this->_menu_slugs[ $menu_slug ] = $page;
+				// flag for register hooks on extended pages b/c extended pages use the default INIT.
+				$extend = false;
+				// now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
+				if (isset($this->_caffeinated_extends[ $page ])) {
+					$this->_current_caf_extend_slug = $page;
+					$admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
+					$caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
+					$caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
+						function ($path_to_file) use ($caf_path) {
+							return $caf_path;
+						}
+					);
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
+						function ($admin_page) use ($caf_admin_page) {
+							return $caf_admin_page;
+						}
+					);
+					$extend = true;
+				}
+				// let's do the registered hooks
+				$extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
+				$hooks_ref = array_merge($hooks_ref, $extended_hooks);
+			}
+		}
+		// the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
+		// first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		// now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			require_once($path);
+		}
+		// make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		// we need to loop again to run any early code
+		foreach ($installed_refs as $page => $path) {
+			if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
+				$this->_installed_pages[ $page ]->do_initial_loads();
+			}
+		}
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object($page_slug = '')
+	{
+		if (isset($this->_installed_pages[ $page_slug ])) {
+			return $this->_installed_pages[ $page_slug ]->loaded_page_object();
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_classname_for_admin_page
+	 * generates an "Admin Page" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+	}
+
+
+	/**
+	 * _get_classname_for_admin_init_page
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_init_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param  string $page page_reference
+	 * @param string  $path
+	 * @throws EE_Error
+	 * @return object|bool  return page object if valid, bool false if not.
+	 */
+	private function _load_admin_page($page = '', $path = '')
+	{
+		$class_name = $this->_get_classname_for_admin_init_page($page);
+		EE_Registry::instance()->load_file($path, $class_name, 'core');
+		if (! class_exists($class_name)) {
+			$inner_error_msg = '<br />'
+							   . sprintf(
+								   esc_html__(
+									   'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+									   'event_espresso'
+								   ),
+								   '<strong>' . $class_name . '</strong>'
+							   );
+			$error_msg[] = sprintf(
+				__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+				$page
+			);
+			$error_msg[] = $error_msg[0]
+						   . "\r\n"
+						   . sprintf(
+							   esc_html__(
+								   'There is no Init class in place for the %s admin page.',
+								   'event_espresso'
+							   ),
+							   $page
+						   )
+						   . $inner_error_msg;
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		$a = new ReflectionClass($class_name);
+		return $a->newInstance();
+	}
+
+
+	/**
+	 * set_menus
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function set_menus()
+	{
+		// prep the menu pages (sort, group.)
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(false);
+			}
+		}
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 */
+	public function set_network_menus()
+	{
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(true);
+			}
+		}
+	}
+
+
+	/**
+	 * _prep_pages
+	 * sets the _prepped_menu_maps property
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _prep_pages()
+	{
+		$pages_array = array();
+		// rearrange _admin_menu_groups to be indexed by group slug.
+		$menu_groups = $this->_rearrange_menu_groups();
+		foreach ($this->_installed_pages as $page) {
+			if ($page instanceof EE_Admin_page_Init) {
+				$page_map = $page->get_menu_map();
+				// if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
+				if (is_array($page_map) || empty($page_map)) {
+					new PersistentAdminNotice(
+						'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+						sprintf(
+							__(
+								'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
+								'event_espresso'
+							),
+							$page->label
+						)
+					);
+					continue;
+				}
+				// if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
+				if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
+								'event_espresso'
+							),
+							$page->label,
+							$page_map
+						)
+					);
+				}
+				// use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
+				if (empty($page_map->maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level()
+					   == EE_Maintenance_Mode::level_2_complete_maintenance) {
+					continue;
+				}
+				// assign to group (remember $page_map has the admin page stored in it).
+				$pages_array[ $page_map->menu_group ][] = $page_map;
+			}
+		}
+		if (empty($pages_array)) {
+			throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
+		}
+		// let's sort the groups, make sure it's a valid group, add header (if to show).
+		foreach ($pages_array as $group => $menu_maps) {
+			// valid_group?
+			if (! array_key_exists($group, $menu_groups)) {
+				continue;
+			}
+			// sort pages.
+			usort($menu_maps, array($this, '_sort_menu_maps'));
+			// prepend header
+			array_unshift($menu_maps, $menu_groups[ $group ]);
+			// reset $pages_array with prepped data
+			$pages_array[ $group ] = $menu_maps;
+		}
+		// now let's setup the _prepped_menu_maps property
+		foreach ($menu_groups as $group => $group_objs) {
+			if (isset($pages_array[ $group ])) {
+				$this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
+			}
+		}/**/
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 */
+	private function _set_caffeinated($installed_refs)
+	{
+
+		// first let's check if there IS a caffeinated folder. If there is not then lets get out.
+		if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin') || (defined('EE_DECAF') && EE_DECAF)) {
+			return $installed_refs;
+		}
+		$this->_define_caffeinated_constants();
+		$exclude = array('tickets');
+		// okay let's setup an "New" pages first (we'll return installed refs later)
+		$new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+		if ($new_admin_screens) {
+			foreach ($new_admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different NEW EE admin pages
+					$installed_refs[ basename($admin_screen) ] = $admin_screen;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
+				}
+			}
+		}
+		// let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+		if ($extends) {
+			foreach ($extends as $extend) {
+				if (is_dir($extend)) {
+					$extend_ref = basename($extend);
+					// now let's make sure there is a file that matches the expected format
+					$filename = str_replace(
+						' ',
+						'_',
+						ucwords(
+							str_replace(
+								'_',
+								' ',
+								$extend_ref
+							)
+						)
+					);
+					$filename = 'Extend_' . $filename . '_Admin_Page';
+					$this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
+						array('\\', '/'),
+						'/',
+						EE_CORE_CAF_ADMIN
+						. 'extend/'
+						. $extend_ref
+						. '/'
+						. $filename
+						. '.core.php'
+					);
+					$this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
+				}
+			}
+		}
+		// let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks = array();
+		$hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+		if ($hooks) {
+			foreach ($hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+					$classname = str_replace('.class.php', '', $classname);
+					if (class_exists($classname)) {
+						$a = new ReflectionClass($classname);
+						$ee_admin_hooks[] = $a->newInstance();
+					}
+				}
+			}
+		}/**/
+		$ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+		return $installed_refs;
+	}
+
+
+	/**
+	 * Utility method for sorting the _menu_maps (callback for usort php function)
+	 *
+	 * @since  4.4.0
+	 * @param  EE_Admin_Page_Menu_Map $a menu_map object
+	 * @param  EE_Admin_Page_Menu_Map $b being compared to
+	 * @return int    sort order
+	 */
+	private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
+	{
+		if ($a->menu_order == $b->menu_order) {
+			return 0;
+		}
+		return ($a->menu_order < $b->menu_order) ? -1 : 1;
+	}
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link()
+	{
+		return false;
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -120,13 +120,13 @@ 
      */
     private function _define_caffeinated_constants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -237,7 +237,7 @@ 
         // first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
         usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
         foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
+            if ( ! $group instanceof EE_Admin_Page_Menu_Group) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -248,7 +248,7 @@ 
                     )
                 );
             }
-            $groups[ $group->menu_slug ] = $group;
+            $groups[$group->menu_slug] = $group;
         }
         return $groups;
     }
@@ -267,13 +267,13 @@ 
         $installed_refs = array();
         $exclude = array('assets', 'templates');
         // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+        $admin_screens = glob(EE_ADMIN_PAGES.'*', GLOB_ONLYDIR);
         if ($admin_screens) {
             foreach ($admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
                 if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
                     // these folders represent the different EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
+                    $installed_refs[basename($admin_screen)] = $admin_screen;
                 }
             }
         }
@@ -282,7 +282,7 @@ 
                 'There are no EE_Admin pages detected, it looks like EE did not install properly',
                 'event_espresso'
             );
-            $error_msg[] = $error_msg[0] . "\r\n"
+            $error_msg[] = $error_msg[0]."\r\n"
                            . sprintf(
                                __(
                                    'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
@@ -309,46 +309,46 @@ 
             // set autoloaders for our admin page classes based on included path information
             EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
             // build list of installed pages
-            $this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
+            $this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
             // verify returned object
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+                if ( ! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
                     continue;
                 }
                 // skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
+                $maintenance_mode_parent = $this->_installed_pages[$page]->get_menu_map()->maintenance_mode_parent;
                 if (empty($maintenance_mode_parent)
                     && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
                 ) {
-                    unset($installed_refs[ $page ]);
+                    unset($installed_refs[$page]);
                     continue;
                 }
-                $menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[ $menu_slug ] = $page;
+                $menu_slug = $this->_installed_pages[$page]->get_menu_map()->menu_slug;
+                $this->_menu_slugs[$menu_slug] = $page;
                 // flag for register hooks on extended pages b/c extended pages use the default INIT.
                 $extend = false;
                 // now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[ $page ])) {
+                if (isset($this->_caffeinated_extends[$page])) {
                     $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
+                    $admin_page_name = $this->_installed_pages[$page]->get_admin_page_name();
+                    $caf_path = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['path'];
+                    $caf_admin_page = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['admin_page'];
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function ($path_to_file) use ($caf_path) {
+                        function($path_to_file) use ($caf_path) {
                             return $caf_path;
                         }
                     );
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page) {
+                        function($admin_page) use ($caf_admin_page) {
                             return $caf_admin_page;
                         }
                     );
                     $extend = true;
                 }
                 // let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
+                $extended_hooks = $this->_installed_pages[$page]->register_hooks($extend);
                 $hooks_ref = array_merge($hooks_ref, $extended_hooks);
             }
         }
@@ -364,8 +364,8 @@ 
         $ee_menu_slugs = $this->_menu_slugs;
         // we need to loop again to run any early code
         foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[ $page ]->do_initial_loads();
+            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+                $this->_installed_pages[$page]->do_initial_loads();
             }
         }
         do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
@@ -380,8 +380,8 @@ 
      */
     public function get_admin_page_object($page_slug = '')
     {
-        if (isset($this->_installed_pages[ $page_slug ])) {
-            return $this->_installed_pages[ $page_slug ]->loaded_page_object();
+        if (isset($this->_installed_pages[$page_slug])) {
+            return $this->_installed_pages[$page_slug]->loaded_page_object();
         }
         return null;
     }
@@ -397,7 +397,7 @@ 
     private function _get_classname_for_admin_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
     }
 
 
@@ -411,7 +411,7 @@ 
     private function _get_classname_for_admin_init_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -428,14 +428,14 @@ 
     {
         $class_name = $this->_get_classname_for_admin_init_page($page);
         EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             $inner_error_msg = '<br />'
                                . sprintf(
                                    esc_html__(
                                        'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                                        'event_espresso'
                                    ),
-                                   '<strong>' . $class_name . '</strong>'
+                                   '<strong>'.$class_name.'</strong>'
                                );
             $error_msg[] = sprintf(
                 __('Something went wrong with loading the %s admin page.', 'event_espresso'),
@@ -515,7 +515,7 @@ 
                 // if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
                 if (is_array($page_map) || empty($page_map)) {
                     new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+                        'menu_map_warning_'.str_replace(' ', '_', $page->label).'_'.EVENT_ESPRESSO_VERSION,
                         sprintf(
                             __(
                                 'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
@@ -527,7 +527,7 @@ 
                     continue;
                 }
                 // if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+                if ( ! $page_map instanceof EE_Admin_Page_Menu_Map) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -546,7 +546,7 @@ 
                     continue;
                 }
                 // assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[ $page_map->menu_group ][] = $page_map;
+                $pages_array[$page_map->menu_group][] = $page_map;
             }
         }
         if (empty($pages_array)) {
@@ -555,20 +555,20 @@ 
         // let's sort the groups, make sure it's a valid group, add header (if to show).
         foreach ($pages_array as $group => $menu_maps) {
             // valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
+            if ( ! array_key_exists($group, $menu_groups)) {
                 continue;
             }
             // sort pages.
             usort($menu_maps, array($this, '_sort_menu_maps'));
             // prepend header
-            array_unshift($menu_maps, $menu_groups[ $group ]);
+            array_unshift($menu_maps, $menu_groups[$group]);
             // reset $pages_array with prepped data
-            $pages_array[ $group ] = $menu_maps;
+            $pages_array[$group] = $menu_maps;
         }
         // now let's setup the _prepped_menu_maps property
         foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[ $group ])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
+            if (isset($pages_array[$group])) {
+                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[$group]);
             }
         }/**/
     }
@@ -596,26 +596,26 @@ 
     {
 
         // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin') || (defined('EE_DECAF') && EE_DECAF)) {
+        if ( ! is_dir(EE_PLUGIN_DIR_PATH.'caffeinated/admin') || (defined('EE_DECAF') && EE_DECAF)) {
             return $installed_refs;
         }
         $this->_define_caffeinated_constants();
         $exclude = array('tickets');
         // okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+        $new_admin_screens = glob(EE_CORE_CAF_ADMIN.'new/*', GLOB_ONLYDIR);
         if ($new_admin_screens) {
             foreach ($new_admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
                 if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
                     // these folders represent the different NEW EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
+                    $installed_refs[basename($admin_screen)] = $admin_screen;
                     // set autoloaders for our admin page classes based on included path information
                     EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
                 }
             }
         }
         // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+        $extends = glob(EE_CORE_CAF_ADMIN.'extend/*', GLOB_ONLYDIR);
         if ($extends) {
             foreach ($extends as $extend) {
                 if (is_dir($extend)) {
@@ -632,8 +632,8 @@ 
                             )
                         )
                     );
-                    $filename = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
+                    $filename = 'Extend_'.$filename.'_Admin_Page';
+                    $this->_caffeinated_extends[$extend_ref]['path'] = str_replace(
                         array('\\', '/'),
                         '/',
                         EE_CORE_CAF_ADMIN
@@ -643,7 +643,7 @@ 
                         . $filename
                         . '.core.php'
                     );
-                    $this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
+                    $this->_caffeinated_extends[$extend_ref]['admin_page'] = $filename;
                     // set autoloaders for our admin page classes based on included path information
                     EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
                 }
@@ -651,12 +651,12 @@ 
         }
         // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks = array();
-        $hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+        $hooks = glob(EE_CORE_CAF_ADMIN.'hooks/*.class.php');
         if ($hooks) {
             foreach ($hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+                    $classname = str_replace(EE_CORE_CAF_ADMIN.'hooks/', '', $hook);
                     $classname = str_replace('.class.php', '', $classname);
                     if (class_exists($classname)) {
                         $a = new ReflectionClass($classname);

core/admin/EE_Admin_Page_Menu_Map.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
      *
      * @param  array $menu_args           An array of arguments used to setup the menu
      *                                    properties on construct.
-     * @param  array $required            An array of keys that should be in the $menu_args, this
+     * @param  string[] $required            An array of keys that should be in the $menu_args, this
      *                                    is used to validate that the items that should be defined
      *                                    are present.
      * @return void

Indentation +357 added lines, -357 removed lines

@@ -11,257 +11,257 @@ 
 {
 
 
-    /**
-     * The title for the menu page. (the page the menu links to)
-     *
-     * @since  4.4.0
-     * @var string
-     */
-    public $title;
-
-
-    /**
-     * The label for the menu item. (What shows up in the actual menu).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_label;
-
-
-    /**
-     * What menu item is the parent of this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $parent_slug;
-
-
-    /**
-     * What capability is required to access this page.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $capability = 'administrator';
-
-
-    /**
-     * What slug should be used to reference this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_slug;
-
-
-    /**
-     * The callback for displaying the page that the menu references.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_callback;
-
-
-    /**
-     * The EE_Admin_Page_Init attached to this map.
-     *
-     * @var EE_Admin_Page_Init
-     */
-    public $admin_init_page;
-
-
-    /**
-     * The EE specific group this menu item belongs in (group slug).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_group;
-
-
-    /**
-     * What order this item should be in the menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    public $menu_order;
-
-
-    const NONE = 0;
-    const BLOG_ADMIN_ONLY = 1;
-    const BLOG_AND_NETWORK_ADMIN = 2;
-    const NETWORK_ADMIN_ONLY = 3;
-
-
-    /**
-     * Whether this item is displayed in the menu or not.
-     * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
-     * admin menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    public $show_on_menu = self::BLOG_ADMIN_ONLY;
-
-
-    /**
-     * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
-     * EE_Maintenance_Mode::level_2_complete_maintenance is active.
-     *
-     * @var bool
-     */
-    public $maintenance_mode_parent = '';
-
-
-    /**
-     * Constructor.
-     *
-     * @since 4.4.0
-     *
-     * @param  array $menu_args           An array of arguments used to setup the menu
-     *                                    properties on construct.
-     * @param  array $required            An array of keys that should be in the $menu_args, this
-     *                                    is used to validate that the items that should be defined
-     *                                    are present.
-     * @return void
-     */
-    public function __construct($menu_args, $required)
-    {
-        // filter all args before processing so plugins can manipulate various settings for menus.
-        $menu_args = apply_filters(
-            'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
-            $menu_args,
-            $required,
-            get_class($this)
-        );
-
-
-        // verify that required keys are present in the incoming array.
-        $missing = array_diff((array) $required, array_keys((array) $menu_args));
-
-        if (! empty($missing)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%s is missing some expected keys in the argument array.  The following keys are missing: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    implode(', ', $missing)
-                )
-            );
-        }
-
-        // made it here okay, so let's set the properties!
-        foreach ($menu_args as $prop => $value) {
-            switch ($prop) {
-                case 'show_on_menu':
-                    $value = (int) $value;
-                    break;
-                case 'admin_init_page':
-                    if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
-                        throw new EE_Error(
-                            sprintf(
-                                __(
-                                    'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
-                                    'event_espresso'
-                                ),
-                                print_r($value, true)
-                            )
-                        );
-                    }
-                    break;
-                case 'menu_callback':
-                    break;
-
-                default:
-                    $value = (string) $value;
-                    break;
-            }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        $prop
-                    )
-                );
-            }
-            $this->{$prop} = $value;
-        }
-
-        // filter capabilities (both static and dynamic)
-        $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
-
-        // Might need to change parent slug depending on maintenance mode.
-        if (! empty($this->maintenance_mode_parent)
-            && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            $this->parent_slug = $this->maintenance_mode_parent;
-        }
-
-        // if empty menu_callback let's set default (but only if we have admin page init object)
-        if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
-            $this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
-        }
-    }
-
-
-    /**
-     * This method should define how the menu page gets added for this particular item
-     * and go ahead and define it.  Note that child classes MUST also return the result of
-     * the function used to register the WordPress admin page (the wp_page_slug string)
-     *
-     * @since  4.4.0
-     * @return string wp_page_slug.
-     */
-    abstract protected function _add_menu_page();
-
-
-    /**
-     * Called by client code to use this menu map for registering a WordPress admin page
-     *
-     * @param boolean $network_admin whether this is being added to the network admin page or not
-     * @since  4.4.0
-     */
-    public function add_menu_page($network_admin = false)
-    {
-
-        $show_on_menu_int = (int) $this->show_on_menu;
-        if (($network_admin
-             && in_array(
-                 $show_on_menu_int,
-                 array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY),
-                 true
-             ))
-            ||
-            (! $network_admin
-             && in_array(
-                 $show_on_menu_int,
-                 array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
-                 true
-             ))) {
-            $wp_page_slug = $this->_add_menu_page();
-        } else {
-            $wp_page_slug = '';
-        }
-
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
-            try {
-                $this->admin_init_page->set_page_dependencies($wp_page_slug);
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-    }
+	/**
+	 * The title for the menu page. (the page the menu links to)
+	 *
+	 * @since  4.4.0
+	 * @var string
+	 */
+	public $title;
+
+
+	/**
+	 * The label for the menu item. (What shows up in the actual menu).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_label;
+
+
+	/**
+	 * What menu item is the parent of this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $parent_slug;
+
+
+	/**
+	 * What capability is required to access this page.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $capability = 'administrator';
+
+
+	/**
+	 * What slug should be used to reference this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_slug;
+
+
+	/**
+	 * The callback for displaying the page that the menu references.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_callback;
+
+
+	/**
+	 * The EE_Admin_Page_Init attached to this map.
+	 *
+	 * @var EE_Admin_Page_Init
+	 */
+	public $admin_init_page;
+
+
+	/**
+	 * The EE specific group this menu item belongs in (group slug).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_group;
+
+
+	/**
+	 * What order this item should be in the menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	public $menu_order;
+
+
+	const NONE = 0;
+	const BLOG_ADMIN_ONLY = 1;
+	const BLOG_AND_NETWORK_ADMIN = 2;
+	const NETWORK_ADMIN_ONLY = 3;
+
+
+	/**
+	 * Whether this item is displayed in the menu or not.
+	 * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
+	 * admin menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	public $show_on_menu = self::BLOG_ADMIN_ONLY;
+
+
+	/**
+	 * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
+	 * EE_Maintenance_Mode::level_2_complete_maintenance is active.
+	 *
+	 * @var bool
+	 */
+	public $maintenance_mode_parent = '';
+
+
+	/**
+	 * Constructor.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @param  array $menu_args           An array of arguments used to setup the menu
+	 *                                    properties on construct.
+	 * @param  array $required            An array of keys that should be in the $menu_args, this
+	 *                                    is used to validate that the items that should be defined
+	 *                                    are present.
+	 * @return void
+	 */
+	public function __construct($menu_args, $required)
+	{
+		// filter all args before processing so plugins can manipulate various settings for menus.
+		$menu_args = apply_filters(
+			'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
+			$menu_args,
+			$required,
+			get_class($this)
+		);
+
+
+		// verify that required keys are present in the incoming array.
+		$missing = array_diff((array) $required, array_keys((array) $menu_args));
+
+		if (! empty($missing)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%s is missing some expected keys in the argument array.  The following keys are missing: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					implode(', ', $missing)
+				)
+			);
+		}
+
+		// made it here okay, so let's set the properties!
+		foreach ($menu_args as $prop => $value) {
+			switch ($prop) {
+				case 'show_on_menu':
+					$value = (int) $value;
+					break;
+				case 'admin_init_page':
+					if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
+						throw new EE_Error(
+							sprintf(
+								__(
+									'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
+									'event_espresso'
+								),
+								print_r($value, true)
+							)
+						);
+					}
+					break;
+				case 'menu_callback':
+					break;
+
+				default:
+					$value = (string) $value;
+					break;
+			}
+			if (! EEH_Class_Tools::has_property($this, $prop)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?',
+							'event_espresso'
+						),
+						get_class($this),
+						$prop
+					)
+				);
+			}
+			$this->{$prop} = $value;
+		}
+
+		// filter capabilities (both static and dynamic)
+		$this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
+		$this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+
+		// Might need to change parent slug depending on maintenance mode.
+		if (! empty($this->maintenance_mode_parent)
+			&& EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			$this->parent_slug = $this->maintenance_mode_parent;
+		}
+
+		// if empty menu_callback let's set default (but only if we have admin page init object)
+		if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+			$this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
+		}
+	}
+
+
+	/**
+	 * This method should define how the menu page gets added for this particular item
+	 * and go ahead and define it.  Note that child classes MUST also return the result of
+	 * the function used to register the WordPress admin page (the wp_page_slug string)
+	 *
+	 * @since  4.4.0
+	 * @return string wp_page_slug.
+	 */
+	abstract protected function _add_menu_page();
+
+
+	/**
+	 * Called by client code to use this menu map for registering a WordPress admin page
+	 *
+	 * @param boolean $network_admin whether this is being added to the network admin page or not
+	 * @since  4.4.0
+	 */
+	public function add_menu_page($network_admin = false)
+	{
+
+		$show_on_menu_int = (int) $this->show_on_menu;
+		if (($network_admin
+			 && in_array(
+				 $show_on_menu_int,
+				 array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY),
+				 true
+			 ))
+			||
+			(! $network_admin
+			 && in_array(
+				 $show_on_menu_int,
+				 array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
+				 true
+			 ))) {
+			$wp_page_slug = $this->_add_menu_page();
+		} else {
+			$wp_page_slug = '';
+		}
+
+		if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+			try {
+				$this->admin_init_page->set_page_dependencies($wp_page_slug);
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+	}
 }
 
 
@@ -275,75 +275,75 @@ 
 class EE_Admin_Page_Main_Menu extends EE_Admin_Page_Menu_Map
 {
 
-    /**
-     * If included int incoming params, then this class will also register a Sub Menue Admin page with a different
-     * subtitle than the main menu item.
-     *
-     * @since 4.4.0
-     *
-     * @var string
-     */
-    public $subtitle;
-
-    /**
-     * The page to a icon used for this menu.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var string
-     */
-    public $icon_url;
-
-
-    /**
-     * What position in the main menu order for the WP admin menu this menu item
-     * should show.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var integer
-     */
-    public $position;
-
-
-    public function __construct($menu_args)
-    {
-        $required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
-
-        parent::__construct($menu_args, $required);
-
-        $this->position = ! empty($this->position) ? (int) $this->position : $this->position;
-    }
-
-
-    /**
-     * Uses the proper WP utility for registering a menu page for the main WP pages.
-     */
-    protected function _add_menu_page()
-    {
-        $main = add_menu_page(
-            $this->title,
-            $this->menu_label,
-            $this->capability,
-            $this->parent_slug,
-            $this->menu_callback,
-            $this->icon_url,
-            $this->position
-        );
-        if (! empty($this->subtitle)) {
-            add_submenu_page(
-                $this->parent_slug,
-                $this->subtitle,
-                $this->subtitle,
-                $this->capability,
-                $this->menu_slug,
-                $this->menu_callback
-            );
-        }
-        return $main;
-    }
+	/**
+	 * If included int incoming params, then this class will also register a Sub Menue Admin page with a different
+	 * subtitle than the main menu item.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @var string
+	 */
+	public $subtitle;
+
+	/**
+	 * The page to a icon used for this menu.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var string
+	 */
+	public $icon_url;
+
+
+	/**
+	 * What position in the main menu order for the WP admin menu this menu item
+	 * should show.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var integer
+	 */
+	public $position;
+
+
+	public function __construct($menu_args)
+	{
+		$required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
+
+		parent::__construct($menu_args, $required);
+
+		$this->position = ! empty($this->position) ? (int) $this->position : $this->position;
+	}
+
+
+	/**
+	 * Uses the proper WP utility for registering a menu page for the main WP pages.
+	 */
+	protected function _add_menu_page()
+	{
+		$main = add_menu_page(
+			$this->title,
+			$this->menu_label,
+			$this->capability,
+			$this->parent_slug,
+			$this->menu_callback,
+			$this->icon_url,
+			$this->position
+		);
+		if (! empty($this->subtitle)) {
+			add_submenu_page(
+				$this->parent_slug,
+				$this->subtitle,
+				$this->subtitle,
+				$this->capability,
+				$this->menu_slug,
+				$this->menu_callback
+			);
+		}
+		return $main;
+	}
 } //end EE_Admin_Page_Main_Menu
 
 
@@ -357,23 +357,23 @@ 
 class EE_Admin_Page_Sub_Menu extends EE_Admin_Page_Main_Menu
 {
 
-    public function __construct($menu_args)
-    {
-        parent::__construct($menu_args);
-    }
-
-
-    protected function _add_menu_page()
-    {
-        return add_submenu_page(
-            $this->parent_slug,
-            $this->title,
-            $this->menu_label,
-            $this->capability,
-            $this->menu_slug,
-            $this->menu_callback
-        );
-    }
+	public function __construct($menu_args)
+	{
+		parent::__construct($menu_args);
+	}
+
+
+	protected function _add_menu_page()
+	{
+		return add_submenu_page(
+			$this->parent_slug,
+			$this->title,
+			$this->menu_label,
+			$this->capability,
+			$this->menu_slug,
+			$this->menu_callback
+		);
+	}
 }
 
 
@@ -392,28 +392,28 @@ 
 {
 
 
-    public function __construct($menu_args = array())
-    {
-        $required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
-        parent::__construct($menu_args, $required);
-    }
+	public function __construct($menu_args = array())
+	{
+		$required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
+		parent::__construct($menu_args, $required);
+	}
 
 
-    protected function _add_menu_page()
-    {
-        return add_submenu_page(
-            $this->parent_slug,
-            $this->menu_label,
-            $this->_group_link(),
-            $this->capability,
-            $this->menu_slug,
-            '__return_false'
-        );
-    }
+	protected function _add_menu_page()
+	{
+		return add_submenu_page(
+			$this->parent_slug,
+			$this->menu_label,
+			$this->_group_link(),
+			$this->capability,
+			$this->menu_slug,
+			'__return_false'
+		);
+	}
 
 
-    private function _group_link()
-    {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
-    }
+	private function _group_link()
+	{
+		return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -143,7 +143,7 @@ 
         // verify that required keys are present in the incoming array.
         $missing = array_diff((array) $required, array_keys((array) $menu_args));
 
-        if (! empty($missing)) {
+        if ( ! empty($missing)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -182,7 +182,7 @@ 
                     $value = (string) $value;
                     break;
             }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
+            if ( ! EEH_Class_Tools::has_property($this, $prop)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -199,10 +199,10 @@ 
 
         // filter capabilities (both static and dynamic)
         $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+        $this->capability = apply_filters('FHEE_'.$this->menu_slug.'_capability', $this->capability, null);
 
         // Might need to change parent slug depending on maintenance mode.
-        if (! empty($this->maintenance_mode_parent)
+        if ( ! empty($this->maintenance_mode_parent)
             && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
         ) {
             $this->parent_slug = $this->maintenance_mode_parent;
@@ -243,7 +243,7 @@ 
                  true
              ))
             ||
-            (! $network_admin
+            ( ! $network_admin
              && in_array(
                  $show_on_menu_int,
                  array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
@@ -254,7 +254,7 @@ 
             $wp_page_slug = '';
         }
 
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+        if ( ! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
             try {
                 $this->admin_init_page->set_page_dependencies($wp_page_slug);
             } catch (EE_Error $e) {
@@ -332,7 +332,7 @@ 
             $this->icon_url,
             $this->position
         );
-        if (! empty($this->subtitle)) {
+        if ( ! empty($this->subtitle)) {
             add_submenu_page(
                 $this->parent_slug,
                 $this->subtitle,
@@ -414,6 +414,6 @@ 
 
     private function _group_link()
     {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+        return '<span class="ee_menu_group"  onclick="return false;">'.$this->menu_label.'</span>';
     }
 }

core/admin/EE_Help_Tour.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
      *
      * @access public
      * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
+     * @return EE_Help_Tour
      */
     public function __construct($caf = false)
     {

Indentation +264 added lines, -264 removed lines

@@ -15,268 +15,268 @@
 abstract class EE_Help_Tour extends EE_Base
 {
 
-    /**
-     * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
-     * constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_label = '';
-
-
-    /**
-     * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
-     * cookies for the tour. Set this in the constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_slug = '';
-
-
-    /**
-     * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
-     * setting up a tour on a given page. format for array is: array(
-     *        0 => array(
-     *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
-     *            precendence even if you also set class.
-     *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
-     *            this param. The first element for that class is the anchor. If the class or the id are empty then the
-     *            stop will be a modal on the page anchored to the main body.
-     *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
-     *            'button_text' => 'custom text for button', //optional
-     *            'content' => 'The content for the stop', //required
-     *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
-     *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
-     *            when this tour has been set to run on timer.
-     *            'options' => array(
-     *                //override any of the global options set via the help_tour "option_callback" for the joyride
-     *                instance on this specific stop.
-     *                )
-     *            )
-     *        );
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_stops = array();
-
-
-    /**
-     * This contains any stop specific options for the tour.
-     * defaults are set but child classes can override.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_options = array();
-
-
-    /**
-     * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_req_data = array();
-
-
-    /**
-     * a flag that is set on init for whether this help_tour is happening on a caf install or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-    /**
-     * _constructor
-     * initialized the tour object and sets up important properties required to setup the tour.
-     *
-     * @access public
-     * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
-     */
-    public function __construct($caf = false)
-    {
-        $this->_is_caf = $caf;
-        $this->_req_data = array_merge($_GET, $_POST);
-        $this->_set_tour_properties();
-        $this->_set_tour_stops();
-        $this->_set_tour_options();
-
-        // make sure the last tour stop has "end tour" for its button
-        $end = array_pop($this->_stops);
-        $end['button_text'] = __('End Tour', 'event_espresso');
-        // add back to stops
-        $this->_stops[] = $end;
-    }
-
-
-    /**
-     * required method that has the sole purpose of setting up the tour $_label and $_slug properties
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_properties();
-
-
-    /**
-     * required method that's sole purpose is to setup the $_stops property
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_stops();
-
-
-    /**
-     * The method can optionally be overridden by child classes to set the _options array if there are any default
-     * options the child wishes to override for a this tour. See property definition for more info
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_tour_options($options = array())
-    {
-        $defaults = array(
-            'tipLocation'           => 'bottom',
-            // 'top', 'bottom', 'right', 'left' in relation to parent
-            'nubPosition'           => 'auto',
-            // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
-            'tipAdjustmentY'        => 0,
-            // allow for adjustment of tip
-            'tipAdjustmentX'        => 0,
-            // allow for adjustment of tip
-            'scroll'                => true,
-            // whether to scrollTo the next step or not
-            'scrollSpeed'           => 300,
-            // Page scrolling speed in ms
-            'timer'                 => 0,
-            // 0 = off, all other numbers = time(ms)
-            'autoStart'             => true,
-            // true or false - false tour starts when restart called
-            'startTimerOnClick'     => true,
-            // true/false to start timer on first click
-            'nextButton'            => true,
-            // true/false for next button visibility
-            'button_text'           => __('Next', 'event_espresso'),
-            'tipAnimation'          => 'fade',
-            // 'pop' or 'fade' in each tip
-            'pauseAfter'            => array(),
-            // array of indexes where to pause the tour after
-            'tipAnimationFadeSpeed' => 300,
-            // if 'fade'- speed in ms of transition
-            'cookieMonster'         => true,
-            // true/false for whether cookies are used
-            'cookieName'            => $this->get_slug(),
-            // choose your own cookie name (setup will add the prefix for the specific page joyride)
-            'cookieDomain'          => false,
-            // set to false or yoursite.com
-            // 'tipContainer' => 'body',            // Where the tip be attached if not inline
-            'modal'                 => false,
-            // Whether to cover page with modal during the tour
-            'expose'                => false,
-            // Whether to expose the elements at each step in the tour (requires modal:true),
-            'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
-            // A method to call after an element has been exposed
-            'preRideCallback'       => 'EEHelpTour_preRideCallback',
-            // A method to call before the tour starts (passed index, tip, and cloned exposed element)
-            'postRideCallback'      => 'EEHelpTour_postRideCallback',
-            // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
-            'preStepCallback'       => 'EEHelpTour_preStepCallback',
-            // A method to call before each step
-            'postStepCallback'      => 'EEHelpTour_postStepCallback',
-            // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
-        );
-
-        $options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
-        $this->_options = $options;
-    }
-
-
-    /**
-     * getter functions to return all the properties for the tour.
-     */
-
-
-    /**
-     * get_slug
-     *
-     * @return string slug for the tour
-     */
-    public function get_slug()
-    {
-        if (empty($this->_slug)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_slug;
-    }
-
-
-    /**
-     * get_label
-     *
-     * @return string
-     */
-    public function get_label()
-    {
-        if (empty($this->_label)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_label;
-    }
-
-
-    /**
-     * get_stops
-     *
-     * @return array
-     */
-    public function get_stops()
-    {
-        foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
-            }
-        }
-        return $this->_stops;
-    }
-
-
-    /**
-     * get options
-     *
-     * @return array
-     */
-    public function get_options()
-    {
-        // let's make sure there are not pauses set
-        foreach ($this->_stops as $ind => $stop) {
-            if (isset($stop['pause_after']) && $stop['pause_after']) {
-                $this->_options['pauseAfter'][] = $ind;
-            }
-        }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
-    }
+	/**
+	 * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
+	 * constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_label = '';
+
+
+	/**
+	 * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
+	 * cookies for the tour. Set this in the constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_slug = '';
+
+
+	/**
+	 * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
+	 * setting up a tour on a given page. format for array is: array(
+	 *        0 => array(
+	 *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
+	 *            precendence even if you also set class.
+	 *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
+	 *            this param. The first element for that class is the anchor. If the class or the id are empty then the
+	 *            stop will be a modal on the page anchored to the main body.
+	 *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
+	 *            'button_text' => 'custom text for button', //optional
+	 *            'content' => 'The content for the stop', //required
+	 *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
+	 *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
+	 *            when this tour has been set to run on timer.
+	 *            'options' => array(
+	 *                //override any of the global options set via the help_tour "option_callback" for the joyride
+	 *                instance on this specific stop.
+	 *                )
+	 *            )
+	 *        );
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_stops = array();
+
+
+	/**
+	 * This contains any stop specific options for the tour.
+	 * defaults are set but child classes can override.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_options = array();
+
+
+	/**
+	 * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_req_data = array();
+
+
+	/**
+	 * a flag that is set on init for whether this help_tour is happening on a caf install or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+	/**
+	 * _constructor
+	 * initialized the tour object and sets up important properties required to setup the tour.
+	 *
+	 * @access public
+	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
+	 * @return void
+	 */
+	public function __construct($caf = false)
+	{
+		$this->_is_caf = $caf;
+		$this->_req_data = array_merge($_GET, $_POST);
+		$this->_set_tour_properties();
+		$this->_set_tour_stops();
+		$this->_set_tour_options();
+
+		// make sure the last tour stop has "end tour" for its button
+		$end = array_pop($this->_stops);
+		$end['button_text'] = __('End Tour', 'event_espresso');
+		// add back to stops
+		$this->_stops[] = $end;
+	}
+
+
+	/**
+	 * required method that has the sole purpose of setting up the tour $_label and $_slug properties
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_properties();
+
+
+	/**
+	 * required method that's sole purpose is to setup the $_stops property
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_stops();
+
+
+	/**
+	 * The method can optionally be overridden by child classes to set the _options array if there are any default
+	 * options the child wishes to override for a this tour. See property definition for more info
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_tour_options($options = array())
+	{
+		$defaults = array(
+			'tipLocation'           => 'bottom',
+			// 'top', 'bottom', 'right', 'left' in relation to parent
+			'nubPosition'           => 'auto',
+			// override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
+			'tipAdjustmentY'        => 0,
+			// allow for adjustment of tip
+			'tipAdjustmentX'        => 0,
+			// allow for adjustment of tip
+			'scroll'                => true,
+			// whether to scrollTo the next step or not
+			'scrollSpeed'           => 300,
+			// Page scrolling speed in ms
+			'timer'                 => 0,
+			// 0 = off, all other numbers = time(ms)
+			'autoStart'             => true,
+			// true or false - false tour starts when restart called
+			'startTimerOnClick'     => true,
+			// true/false to start timer on first click
+			'nextButton'            => true,
+			// true/false for next button visibility
+			'button_text'           => __('Next', 'event_espresso'),
+			'tipAnimation'          => 'fade',
+			// 'pop' or 'fade' in each tip
+			'pauseAfter'            => array(),
+			// array of indexes where to pause the tour after
+			'tipAnimationFadeSpeed' => 300,
+			// if 'fade'- speed in ms of transition
+			'cookieMonster'         => true,
+			// true/false for whether cookies are used
+			'cookieName'            => $this->get_slug(),
+			// choose your own cookie name (setup will add the prefix for the specific page joyride)
+			'cookieDomain'          => false,
+			// set to false or yoursite.com
+			// 'tipContainer' => 'body',            // Where the tip be attached if not inline
+			'modal'                 => false,
+			// Whether to cover page with modal during the tour
+			'expose'                => false,
+			// Whether to expose the elements at each step in the tour (requires modal:true),
+			'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
+			// A method to call after an element has been exposed
+			'preRideCallback'       => 'EEHelpTour_preRideCallback',
+			// A method to call before the tour starts (passed index, tip, and cloned exposed element)
+			'postRideCallback'      => 'EEHelpTour_postRideCallback',
+			// a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
+			'preStepCallback'       => 'EEHelpTour_preStepCallback',
+			// A method to call before each step
+			'postStepCallback'      => 'EEHelpTour_postStepCallback',
+			// A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
+		);
+
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
+		$this->_options = $options;
+	}
+
+
+	/**
+	 * getter functions to return all the properties for the tour.
+	 */
+
+
+	/**
+	 * get_slug
+	 *
+	 * @return string slug for the tour
+	 */
+	public function get_slug()
+	{
+		if (empty($this->_slug)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_slug;
+	}
+
+
+	/**
+	 * get_label
+	 *
+	 * @return string
+	 */
+	public function get_label()
+	{
+		if (empty($this->_label)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_label;
+	}
+
+
+	/**
+	 * get_stops
+	 *
+	 * @return array
+	 */
+	public function get_stops()
+	{
+		foreach ($this->_stops as $ind => $stop) {
+			if (! isset($stop['button_text'])) {
+				$this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+			}
+		}
+		return $this->_stops;
+	}
+
+
+	/**
+	 * get options
+	 *
+	 * @return array
+	 */
+	public function get_options()
+	{
+		// let's make sure there are not pauses set
+		foreach ($this->_stops as $ind => $stop) {
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
+				$this->_options['pauseAfter'][] = $ind;
+			}
+		}
+		return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -256,8 +256,8 @@ 
     public function get_stops()
     {
         foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+            if ( ! isset($stop['button_text'])) {
+                $this->_stops[$ind]['button_text'] = $this->_options['button_text'];
             }
         }
         return $this->_stops;
@@ -277,6 +277,6 @@ 
                 $this->_options['pauseAfter'][] = $ind;
             }
         }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+        return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
     }
 }

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

Doc Comments -1 removed lines

@@ -62,7 +62,6 @@
     /**
      * Creates a 4.1 price base type
      * @global type $wpdb
-     * @param array $old_price
      * @param int $new_reg_id
      * @return int
      */

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

Doc Comments +2 added lines, -3 removed lines

@@ -85,7 +85,7 @@ 
      * (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
+     * @param array $old_attendee
      * @return array row of datetime from DB
      */
     private function _try_to_find_datetime($old_attendee)
@@ -121,8 +121,7 @@ 
     /**
      * 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
+     * @param int $new_datetime
      * @return int new Check-in id
      */
     private function _insert_checkin_record($new_reg_id, $new_datetime)

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_event_question_group.dmsstage.php

Doc Comments +3 added lines

@@ -98,6 +98,9 @@
         $this->get_migration_script()->set_mapping($this->_old_table, $old_event['id'], $this->_new_table, $new_event_question_group_ids);
     }
 
+    /**
+     * @param boolean $primary
+     */
     private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
     {
         global $wpdb;

Indentation +104 added lines, -106 removed lines

@@ -16,15 +16,13 @@ 
             'EQG_primary'=>new EE_Boolean_Field('EQG_primary', __('Flag indicating question is only for primary attendees','event_espresso'), false, false)
         )
     );
-
-
  *
  */
 class EE_DMS_4_1_0_event_question_group extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_table;
-    public function _migrate_old_row($old_row)
-    {
+	private $_new_table;
+	public function _migrate_old_row($old_row)
+	{
 //      $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)));
@@ -34,8 +32,8 @@ 
 //          $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);
 
-            $this->_insert_new_event_question_groups($old_row);
-    }
+			$this->_insert_new_event_question_groups($old_row);
+	}
 //  function _migration_step($num_items=50){
 //      global $wpdb;
 //      $start_at_record = $this->count_records_migrated();
@@ -55,109 +53,109 @@ 
 //      $count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
 //      return $count;
 //  }
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_detail";
-        $this->_extra_where_sql = 'WHERE event_status!="D"';
-        $this->_new_table = $wpdb->prefix."esp_event_question_group";
-        $this->_pretty_name = __("Question Groups in each Event", "event_espresso");
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_detail";
+		$this->_extra_where_sql = 'WHERE event_status!="D"';
+		$this->_new_table = $wpdb->prefix."esp_event_question_group";
+		$this->_pretty_name = __("Question Groups in each Event", "event_espresso");
+		parent::__construct();
+	}
 
-    /**
-     * Attempts to insert a new question group inthe new format given an old one
-     * @global type $wpdb
-     * @param array $old_event
-     * @return void
-     */
-    private function _insert_new_event_question_groups($old_event)
-    {
-        $new_event_question_group_ids = array();
-        $question_groups_for_primary = maybe_unserialize($old_event['question_groups']);
-        if (is_array($question_groups_for_primary)) {
-            foreach ($question_groups_for_primary as $old_question_group_id) {
-                $new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, true);
-                if ($new_id) {
-                    $new_event_question_group_ids[] = $new_id;
-                }
-            }
-        }
-        $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (isset($event_meta['add_attendee_question_groups'])) {
-            if (is_array($event_meta['add_attendee_question_groups'])) {
-                foreach ($event_meta['add_attendee_question_groups'] as $old_question_group_id) {
-                    $new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, false);
-                    if ($new_id) {
-                        $new_event_question_group_ids[] = $new_id;
-                    }
-                }
-            }
-        }
+	/**
+	 * Attempts to insert a new question group inthe new format given an old one
+	 * @global type $wpdb
+	 * @param array $old_event
+	 * @return void
+	 */
+	private function _insert_new_event_question_groups($old_event)
+	{
+		$new_event_question_group_ids = array();
+		$question_groups_for_primary = maybe_unserialize($old_event['question_groups']);
+		if (is_array($question_groups_for_primary)) {
+			foreach ($question_groups_for_primary as $old_question_group_id) {
+				$new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, true);
+				if ($new_id) {
+					$new_event_question_group_ids[] = $new_id;
+				}
+			}
+		}
+		$event_meta = maybe_unserialize($old_event['event_meta']);
+		if (isset($event_meta['add_attendee_question_groups'])) {
+			if (is_array($event_meta['add_attendee_question_groups'])) {
+				foreach ($event_meta['add_attendee_question_groups'] as $old_question_group_id) {
+					$new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, false);
+					if ($new_id) {
+						$new_event_question_group_ids[] = $new_id;
+					}
+				}
+			}
+		}
 
 
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_event['id'], $this->_new_table, $new_event_question_group_ids);
-    }
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_event['id'], $this->_new_table, $new_event_question_group_ids);
+	}
 
-    private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
-    {
-        global $wpdb;
-        $new_question_group_id = $this->get_migration_script()->get_mapping_new_pk(
-            $wpdb->prefix . "events_qst_group",
-            intval($old_question_group_id),
-            $wpdb->prefix . "esp_question_group"
-        );
+	private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
+	{
+		global $wpdb;
+		$new_question_group_id = $this->get_migration_script()->get_mapping_new_pk(
+			$wpdb->prefix . "events_qst_group",
+			intval($old_question_group_id),
+			$wpdb->prefix . "esp_question_group"
+		);
 
-        if (! $new_question_group_id) {
-            $this->add_error(
-                sprintf(
-                    // translators: %s question ID, %s event ID
-                    __("Could not find 4.1 question ID for 3.1 question id #%s on event $%s", "event_espresso"),
-                    $old_question_group_id,
-                    $old_event['id']
-                )
-            );
-            return 0;
-        }
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk(
-            $wpdb->prefix . "events_detail",
-            intval($old_event['id']),
-            $wpdb->posts
-        );
-        if (! $new_question_group_id) {
-            $this->add_error(
-                sprintf(
-                    // translators: %s event ID
-                    __("Could not find 4.1 event 3.1 event id #%s", "event_espresso"),
-                    $old_event['id']
-                )
-            );
-            return 0;
-        }
-        $cols_n_values = array(
-            'EVT_ID'=>$new_event_id,
-            'QSG_ID'=>$new_question_group_id,
-            'EQG_primary' => $primary
-        );
+		if (! $new_question_group_id) {
+			$this->add_error(
+				sprintf(
+					// translators: %s question ID, %s event ID
+					__("Could not find 4.1 question ID for 3.1 question id #%s on event $%s", "event_espresso"),
+					$old_question_group_id,
+					$old_event['id']
+				)
+			);
+			return 0;
+		}
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk(
+			$wpdb->prefix . "events_detail",
+			intval($old_event['id']),
+			$wpdb->posts
+		);
+		if (! $new_question_group_id) {
+			$this->add_error(
+				sprintf(
+					// translators: %s event ID
+					__("Could not find 4.1 event 3.1 event id #%s", "event_espresso"),
+					$old_event['id']
+				)
+			);
+			return 0;
+		}
+		$cols_n_values = array(
+			'EVT_ID'=>$new_event_id,
+			'QSG_ID'=>$new_question_group_id,
+			'EQG_primary' => $primary
+		);
 
-        $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// QSG_ID
-            '%d',// EQG_primary
-        );
-        $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_event,
-                    $this->_new_table,
-                    $cols_n_values,
-                    $datatypes
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+		$datatypes = array(
+			'%d',// EVT_ID
+			'%d',// QSG_ID
+			'%d',// EQG_primary
+		);
+		$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_event,
+					$this->_new_table,
+					$cols_n_values,
+					$datatypes
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -103,12 +103,12 @@ 
     {
         global $wpdb;
         $new_question_group_id = $this->get_migration_script()->get_mapping_new_pk(
-            $wpdb->prefix . "events_qst_group",
+            $wpdb->prefix."events_qst_group",
             intval($old_question_group_id),
-            $wpdb->prefix . "esp_question_group"
+            $wpdb->prefix."esp_question_group"
         );
 
-        if (! $new_question_group_id) {
+        if ( ! $new_question_group_id) {
             $this->add_error(
                 sprintf(
                     // translators: %s question ID, %s event ID
@@ -120,11 +120,11 @@ 
             return 0;
         }
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk(
-            $wpdb->prefix . "events_detail",
+            $wpdb->prefix."events_detail",
             intval($old_event['id']),
             $wpdb->posts
         );
-        if (! $new_question_group_id) {
+        if ( ! $new_question_group_id) {
             $this->add_error(
                 sprintf(
                     // translators: %s event ID
@@ -141,12 +141,12 @@ 
         );
 
         $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// QSG_ID
-            '%d',// EQG_primary
+            '%d', // EVT_ID
+            '%d', // QSG_ID
+            '%d', // EQG_primary
         );
         $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,

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

Doc Comments +3 added lines, -3 removed lines

@@ -426,7 +426,7 @@ 
 
     /**
      * @param $old_event
-     * @param $new_cpt_id
+     * @param integer $new_cpt_id
      * @return int
      */
     private function _insert_event_meta($old_event, $new_cpt_id)
@@ -693,8 +693,8 @@ 
 
 
     /**
-     * @param $new_event_id
-     * @param $new_venue_id
+     * @param integer $new_event_id
+     * @param integer $new_venue_id
      * @return int
      */
     private function _insert_new_venue_to_event($new_event_id, $new_venue_id)

Indentation +634 added lines, -639 removed lines

@@ -84,8 +84,6 @@ 
   KEY `submitted` (`submitted`),
   KEY `likes` (`likes`)
 ) ENGINE=InnoDB AUTO_INCREMENT=63 DEFAULT CHARSET=utf8$$
-
-
  *
  * 4.1 Event model:
  * $this->_tables = array(
@@ -124,7 +122,6 @@ 
                 'EVT_donations'=>new EE_Boolean_Field('EVT_donations', __("Accept Donations?", "event_espresso"), false, false)
 
             ));
-
  *
  * 3.1's start end table
  *
@@ -137,8 +134,6 @@ 
   PRIMARY KEY (`id`),
   KEY `event_id` (`event_id`)
 ) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8$$
-
-
  *
  * and 4.1 Datetime model's tables and fields:
  * $this->_tables = array(
@@ -160,172 +155,172 @@ 
  */
 class EE_DMS_4_1_0_events extends EE_Data_Migration_Script_Stage
 {
-    private $_old_table;
-    private $_old_start_end_table;
-    private $_new_table;
-    private $_new_meta_table;
-    private $_new_datetime_table;
-
-
-
-    /**
-     * Just initializes the status of the migration
-     * @throws EE_Error
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_detail";
-        $this->_old_start_end_table = $wpdb->prefix."events_start_end";
-        $this->_new_table = $wpdb->prefix."posts";
-        $this->_new_meta_table = $wpdb->prefix."esp_event_meta";
-        $this->_new_datetime_table = $wpdb->prefix."esp_datetime";
-        $this->_pretty_name = __("Events", "event_espresso");
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     * @return int
-     */
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table . ' WHERE event_status !="D"');
-        return intval($count);
-    }
-
-
-
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
-     * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
-     * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
-     * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
-     * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     */
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        global $wpdb;
-        // because the migration of each event can be a LOT more work, make each step smaller
-        $num_items_to_migrate = max(1, $num_items_to_migrate/5);
-        $events = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table WHERE event_status!='D' LIMIT %d,%d", $this->count_records_migrated(), $num_items_to_migrate), ARRAY_A);
-        $items_migrated_this_step = 0;
-
-        foreach ($events as $event_row) {
-            $guid = null;
-            // insert new 4.1 Attendee object using $wpdb
-            $post_id = $this->_insert_cpt($event_row);
-            if ($post_id) {
-                $this->get_migration_script()->set_mapping($this->_old_table, $event_row['id'], $this->_new_table, $post_id);
-                $meta_id = $this->_insert_event_meta($event_row, $post_id);
-                if ($meta_id) {
-                    $this->get_migration_script()->set_mapping($this->_old_table, $event_row['id'], $this->_new_meta_table, $meta_id);
-                }
-                $this->_convert_start_end_times($event_row, $post_id);
-                $event_meta = maybe_unserialize($event_row['event_meta']);
-                $guid = isset($event_meta['event_thumbnail_url']) ? $event_meta['event_thumbnail_url'] : null;
-                $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $post_id, $this);
-
-                // maybe create a venue from info on the event?
-                $new_venue_id = $this->_maybe_create_venue($event_row);
-                if ($new_venue_id) {
-                    $this->_insert_new_venue_to_event($post_id, $new_venue_id);
-                }
-                $this->_add_post_metas($event_row, $post_id);
-            }
-            $items_migrated_this_step++;
-            if ($guid) {
-                // if we had to check for an image attachment
-                // then let's call it a day (avoid timing out, because this took a long time)
-                break;
-            }
-        }
-        if ($this->count_records_migrated() + $items_migrated_this_step >= $this->count_records_to_migrate()) {
-            $this->set_status(EE_Data_Migration_Manager::status_completed);
-        }
-        return $items_migrated_this_step;
-    }
-
-    /**
-     * Stores any extra 3.1 "event_meta" column things as post meta
-     * @param array $old_event
-     * @param int $post_id
-     * @return void
-     */
-    private function _add_post_metas($old_event, $post_id)
-    {
-        $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (! $event_meta || ! is_array($event_meta)) {
-            return;
-        }
-        unset($event_meta['date_submitted']);// factored into CPT
-        unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
-        unset($event_meta['default_payment_status']);// dido
-        unset($event_meta['event_thumbnail_url']);// used to find post featured image
-        foreach ($event_meta as $meta_key => $meta_value) {
-            if ($meta_key) {// if the meta key is just an empty string, ignore it
-                $success = add_post_meta($post_id, $meta_key, $meta_value, true);
-                if (! $success) {
-                    $this->add_error(sprintf(__("Could not add post meta for CPT with ID #%d. Meta key: '%s',meta value:'%d' for 3.1 event: %s", "event_espresso"), $post_id, $meta_key, $meta_value, implode(",", $old_event)));
-                }
-            }
-        }
-        if ($old_event['alt_email']) {
-            add_post_meta($post_id, 'alt_email', $old_event['alt_email']);
-        }
-        if ($old_event['recurrence_id']) {
-            add_post_meta($post_id, 'recurrence_id', $old_event['recurrence_id']);
-        }
-    }
-
-
-
-    /**
-     * Finds a unique slug for this event, given its name (we could have simply used
-     * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
-     * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
-     * @param string $event_name (the name of the event for reading by humans)
-     * @param string $old_identifier the old EE3 identifier (a long unique string)
-     * @param string $new_post_status a post status
-     * @return string
-     */
-    private function _find_unique_slug($event_name, $old_identifier = '', $new_post_status = 'publish')
-    {
-        $count = 0;
-        $original_name = $event_name ? sanitize_title($event_name) : $old_identifier;
-        return wp_unique_post_slug($original_name, 0, $new_post_status, 'espresso_events', 0);
-    }
-
-    /**
-     * returns whether or not there is a post that has this same slug (post_title)
-     * @global wpdb $wpdb
-     * @param string $slug
-     * @return boolean
-     */
-    private function _other_post_exists_with_that_slug($slug)
-    {
-        global $wpdb;
-        $query = $wpdb->prepare("SELECT COUNT(ID) FROM {$this->_new_table} WHERE event_status != 'D' AND post_name = %s", $slug);
-        $count = $wpdb->get_var($query);
-        return (boolean) intval($count);
-    }
-
-
-
-    /**
-     * @param $old_event
-     * @return int
-     */
-    private function _insert_cpt($old_event)
-    {
-        global $wpdb;
-        // convert 3.1 event status to 4.1 CPT status
-        // for reference, 3.1 event stati available for setting are:
+	private $_old_table;
+	private $_old_start_end_table;
+	private $_new_table;
+	private $_new_meta_table;
+	private $_new_datetime_table;
+
+
+
+	/**
+	 * Just initializes the status of the migration
+	 * @throws EE_Error
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_detail";
+		$this->_old_start_end_table = $wpdb->prefix."events_start_end";
+		$this->_new_table = $wpdb->prefix."posts";
+		$this->_new_meta_table = $wpdb->prefix."esp_event_meta";
+		$this->_new_datetime_table = $wpdb->prefix."esp_datetime";
+		$this->_pretty_name = __("Events", "event_espresso");
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 * @return int
+	 */
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$count = $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table . ' WHERE event_status !="D"');
+		return intval($count);
+	}
+
+
+
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
+	 * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
+	 * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
+	 * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
+	 * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 */
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		global $wpdb;
+		// because the migration of each event can be a LOT more work, make each step smaller
+		$num_items_to_migrate = max(1, $num_items_to_migrate/5);
+		$events = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table WHERE event_status!='D' LIMIT %d,%d", $this->count_records_migrated(), $num_items_to_migrate), ARRAY_A);
+		$items_migrated_this_step = 0;
+
+		foreach ($events as $event_row) {
+			$guid = null;
+			// insert new 4.1 Attendee object using $wpdb
+			$post_id = $this->_insert_cpt($event_row);
+			if ($post_id) {
+				$this->get_migration_script()->set_mapping($this->_old_table, $event_row['id'], $this->_new_table, $post_id);
+				$meta_id = $this->_insert_event_meta($event_row, $post_id);
+				if ($meta_id) {
+					$this->get_migration_script()->set_mapping($this->_old_table, $event_row['id'], $this->_new_meta_table, $meta_id);
+				}
+				$this->_convert_start_end_times($event_row, $post_id);
+				$event_meta = maybe_unserialize($event_row['event_meta']);
+				$guid = isset($event_meta['event_thumbnail_url']) ? $event_meta['event_thumbnail_url'] : null;
+				$this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $post_id, $this);
+
+				// maybe create a venue from info on the event?
+				$new_venue_id = $this->_maybe_create_venue($event_row);
+				if ($new_venue_id) {
+					$this->_insert_new_venue_to_event($post_id, $new_venue_id);
+				}
+				$this->_add_post_metas($event_row, $post_id);
+			}
+			$items_migrated_this_step++;
+			if ($guid) {
+				// if we had to check for an image attachment
+				// then let's call it a day (avoid timing out, because this took a long time)
+				break;
+			}
+		}
+		if ($this->count_records_migrated() + $items_migrated_this_step >= $this->count_records_to_migrate()) {
+			$this->set_status(EE_Data_Migration_Manager::status_completed);
+		}
+		return $items_migrated_this_step;
+	}
+
+	/**
+	 * Stores any extra 3.1 "event_meta" column things as post meta
+	 * @param array $old_event
+	 * @param int $post_id
+	 * @return void
+	 */
+	private function _add_post_metas($old_event, $post_id)
+	{
+		$event_meta = maybe_unserialize($old_event['event_meta']);
+		if (! $event_meta || ! is_array($event_meta)) {
+			return;
+		}
+		unset($event_meta['date_submitted']);// factored into CPT
+		unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
+		unset($event_meta['default_payment_status']);// dido
+		unset($event_meta['event_thumbnail_url']);// used to find post featured image
+		foreach ($event_meta as $meta_key => $meta_value) {
+			if ($meta_key) {// if the meta key is just an empty string, ignore it
+				$success = add_post_meta($post_id, $meta_key, $meta_value, true);
+				if (! $success) {
+					$this->add_error(sprintf(__("Could not add post meta for CPT with ID #%d. Meta key: '%s',meta value:'%d' for 3.1 event: %s", "event_espresso"), $post_id, $meta_key, $meta_value, implode(",", $old_event)));
+				}
+			}
+		}
+		if ($old_event['alt_email']) {
+			add_post_meta($post_id, 'alt_email', $old_event['alt_email']);
+		}
+		if ($old_event['recurrence_id']) {
+			add_post_meta($post_id, 'recurrence_id', $old_event['recurrence_id']);
+		}
+	}
+
+
+
+	/**
+	 * Finds a unique slug for this event, given its name (we could have simply used
+	 * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
+	 * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
+	 * @param string $event_name (the name of the event for reading by humans)
+	 * @param string $old_identifier the old EE3 identifier (a long unique string)
+	 * @param string $new_post_status a post status
+	 * @return string
+	 */
+	private function _find_unique_slug($event_name, $old_identifier = '', $new_post_status = 'publish')
+	{
+		$count = 0;
+		$original_name = $event_name ? sanitize_title($event_name) : $old_identifier;
+		return wp_unique_post_slug($original_name, 0, $new_post_status, 'espresso_events', 0);
+	}
+
+	/**
+	 * returns whether or not there is a post that has this same slug (post_title)
+	 * @global wpdb $wpdb
+	 * @param string $slug
+	 * @return boolean
+	 */
+	private function _other_post_exists_with_that_slug($slug)
+	{
+		global $wpdb;
+		$query = $wpdb->prepare("SELECT COUNT(ID) FROM {$this->_new_table} WHERE event_status != 'D' AND post_name = %s", $slug);
+		$count = $wpdb->get_var($query);
+		return (boolean) intval($count);
+	}
+
+
+
+	/**
+	 * @param $old_event
+	 * @return int
+	 */
+	private function _insert_cpt($old_event)
+	{
+		global $wpdb;
+		// convert 3.1 event status to 4.1 CPT status
+		// for reference, 3.1 event stati available for setting are:
 //      $status = array(array('id' => 'A', 'text' => __('Public', 'event_espresso')), array('id' => 'S', 'text' => __('Waitlist', 'event_espresso')), array('id' => 'O', 'text' => __('Ongoing', 'event_espresso')), array('id' => 'R', 'text' => __('Draft', 'event_espresso')), array('id' => 'D', 'text' => __('Deleted', 'event_espresso')));
 //      and the json api uses the following to convert from 3.1 to 4.0
 //      'S'=>'secondary/waitlist',
@@ -339,486 +334,486 @@ 
 //      4.1 Event Post stati are the normal post statis
 //      (publish,future,draft,pending,private,trash,auto-draft,inherit)
 //      and 3 custom ones: cancelled,postponed,sold_out
-        $status_conversions = array(
-            'R'=>'draft',
-            'X'=>'draft',// 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
-            'P'=>'pending',
-            'IA'=>'draft',// draft and in the past
+		$status_conversions = array(
+			'R'=>'draft',
+			'X'=>'draft',// 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
+			'P'=>'pending',
+			'IA'=>'draft',// draft and in the past
 // IA=inactive in 3.1: events were switched to this when they expired. in 4.1 that's just calculated
-            'O'=>'publish',// @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
-            'A'=>'publish',
-            'S'=>'draft',// @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
-            'D'=>'trash',
-        );
-        $post_status = $status_conversions[ $old_event['event_status'] ];
-        // check if we've sold out
-        if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
-            $post_status = 'sold_out';
-        }
+			'O'=>'publish',// @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
+			'A'=>'publish',
+			'S'=>'draft',// @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
+			'D'=>'trash',
+		);
+		$post_status = $status_conversions[ $old_event['event_status'] ];
+		// check if we've sold out
+		if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
+			$post_status = 'sold_out';
+		}
 //      FYI postponed and cancelled don't exist in 3.1
-        $cols_n_values = array(
-            'post_title'=>stripslashes($old_event['event_name']),// EVT_name
-            'post_content'=>stripslashes($old_event['event_desc']),// EVT_desc
-            'post_name'=>$this->_find_unique_slug($old_event['event_name'], $old_event['event_identifier'], $post_status),// EVT_slug
-            'post_date'=>$old_event['submitted'],// EVT_created NOT
-            'post_date_gmt'=>get_gmt_from_date($old_event['submitted']),
-            'post_excerpt'=>'',// EVT_short_desc
-            'post_modified'=>$old_event['submitted'],// EVT_modified
-            'post_modified_gmt'=>get_gmt_from_date($old_event['submitted']),
-            'post_author'=>$old_event['wp_user'],// EVT_wp_user
-            'post_parent'=>0,// parent maybe get this from some REM field?
-            'menu_order'=>0,// EVT_order
-            'post_type'=>'espresso_events',// post_type
-            'post_status'=>$post_status,// status
-        );
-        $cols_n_values_with_no_invalid_text = array();
-        foreach ($cols_n_values as $col => $value) {
-            $value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
-            if (! is_wp_error($value_sans_invalid_chars)) {
-                $cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
-            } else {
-                // otherwise leave it as-is. It will blow everything up and stop the migration
-                $cols_n_values_with_no_invalid_text[ $col ] = $value;
-            }
-        }
-        $cols_n_values = $cols_n_values_with_no_invalid_text;
-        $datatypes = array(
-            '%s',// EVT_name
-            '%s',// EVT_desc
-            '%s',// EVT_slug
-            '%s',// EVT_created
-            '%s',
-            '%s',// EVT_short_desc
-            '%s',// EVT_modified
-            '%s',
-            '%s',// EVT_wp_user
-            '%d',// post_parent
-            '%d',// EVT_order
-            '%s',// post_type
-            '%s',// status
-        );
-        $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_event, $this->_new_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-    /**
-     * Counts all the registrations for the event in the 3.1 DB. (takes into account attendee rows which represent various registrations)
-     * @global wpdb $wpdb
-     * @param int $event_id
-     * @return int
-     */
-    public static function count_registrations($event_id)
-    {
-        global $wpdb;
-        $count = $wpdb->get_var($wpdb->prepare("SELECT sum(quantity) FROM {$wpdb->prefix}events_attendee WHERE event_id=%d", $event_id));
-        return intval($count);
-    }
-
-
-
-    /**
-     * @param $old_event
-     * @param $new_cpt_id
-     * @return int
-     */
-    private function _insert_event_meta($old_event, $new_cpt_id)
-    {
-        global $wpdb;
-        $event_meta = maybe_unserialize($old_event['event_meta']);
+		$cols_n_values = array(
+			'post_title'=>stripslashes($old_event['event_name']),// EVT_name
+			'post_content'=>stripslashes($old_event['event_desc']),// EVT_desc
+			'post_name'=>$this->_find_unique_slug($old_event['event_name'], $old_event['event_identifier'], $post_status),// EVT_slug
+			'post_date'=>$old_event['submitted'],// EVT_created NOT
+			'post_date_gmt'=>get_gmt_from_date($old_event['submitted']),
+			'post_excerpt'=>'',// EVT_short_desc
+			'post_modified'=>$old_event['submitted'],// EVT_modified
+			'post_modified_gmt'=>get_gmt_from_date($old_event['submitted']),
+			'post_author'=>$old_event['wp_user'],// EVT_wp_user
+			'post_parent'=>0,// parent maybe get this from some REM field?
+			'menu_order'=>0,// EVT_order
+			'post_type'=>'espresso_events',// post_type
+			'post_status'=>$post_status,// status
+		);
+		$cols_n_values_with_no_invalid_text = array();
+		foreach ($cols_n_values as $col => $value) {
+			$value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
+			if (! is_wp_error($value_sans_invalid_chars)) {
+				$cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
+			} else {
+				// otherwise leave it as-is. It will blow everything up and stop the migration
+				$cols_n_values_with_no_invalid_text[ $col ] = $value;
+			}
+		}
+		$cols_n_values = $cols_n_values_with_no_invalid_text;
+		$datatypes = array(
+			'%s',// EVT_name
+			'%s',// EVT_desc
+			'%s',// EVT_slug
+			'%s',// EVT_created
+			'%s',
+			'%s',// EVT_short_desc
+			'%s',// EVT_modified
+			'%s',
+			'%s',// EVT_wp_user
+			'%d',// post_parent
+			'%d',// EVT_order
+			'%s',// post_type
+			'%s',// status
+		);
+		$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_event, $this->_new_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+	/**
+	 * Counts all the registrations for the event in the 3.1 DB. (takes into account attendee rows which represent various registrations)
+	 * @global wpdb $wpdb
+	 * @param int $event_id
+	 * @return int
+	 */
+	public static function count_registrations($event_id)
+	{
+		global $wpdb;
+		$count = $wpdb->get_var($wpdb->prepare("SELECT sum(quantity) FROM {$wpdb->prefix}events_attendee WHERE event_id=%d", $event_id));
+		return intval($count);
+	}
+
+
+
+	/**
+	 * @param $old_event
+	 * @param $new_cpt_id
+	 * @return int
+	 */
+	private function _insert_event_meta($old_event, $new_cpt_id)
+	{
+		global $wpdb;
+		$event_meta = maybe_unserialize($old_event['event_meta']);
 //      for reference, 3.1 'default_payment_status' are: $default_payment_status = array(
 //  array('id' => "", 'text' => 'No Change'),
 //  array('id' => 'Incomplete', 'text' => 'Incomplete'),
 //  array('id' => 'Pending', 'text' => 'Pending'),
 //  //array('id' => 'Completed', 'text' => 'Completed')
 // );
-        $default_reg_status = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(isset($event_meta['default_payment_status']) ? $event_meta['default_payment_status'] : '', intval($old_event['require_pre_approval']));
-        $cols_n_values = array(
-            'EVT_ID'=>$new_cpt_id,// EVT_ID_fk
-            'EVT_display_desc'=> 'Y' == $old_event['display_desc'],
-            'EVT_display_ticket_selector'=> 'Y'== $old_event['display_reg_form'],
-            'EVT_visible_on'=> $this->get_migration_script()->convert_date_string_to_utc($this, $old_event, current_time('mysql'), $old_event['timezone_string']),// don't use the old 'visible_on', as it wasn't ever used
-            'EVT_additional_limit'=> $old_event['allow_multiple'] == 'N' ? 1 : $old_event['additional_limit'],
-            'EVT_default_registration_status' => $default_reg_status,
-            'EVT_member_only'=>$old_event['member_only'],
-            'EVT_phone'=> $old_event['phone'],
-            'EVT_allow_overflow' => 'Y' == $old_event['allow_overflow'],
-            'EVT_timezone_string'=> $old_event['timezone_string'],
-            'EVT_external_URL'=>$old_event['externalURL'],
-            'EVT_donations'=>false// doesnt exist in 3.1
-
-        );
-        $datatypes = array(
-            '%s',// EVT_ID
-            '%d',// EVT_display_desc
-            '%d',// EVT_display_ticket_selector
-            '%s',// EVT_visible_on
-            '%d',// EVT_additional_limit
-            '%s',// EVT_default_registration_status
-            '%d',// EVT_member_only
-            '%s',// EVT_phone
-            '%d',// EVT_allow_overflow
-            '%s',// EVT_timezone_string
-            '%s',// EVT_external_URL
-            '%d',// EVT_donations
-        );
-        $success = $wpdb->insert(
-            $this->_new_meta_table,
-            $cols_n_values,
-            $datatypes
-        );
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-
-    /**
-     * @param $old_event
-     * @return int
-     */
-    private function _maybe_create_venue($old_event)
-    {
-        if ($old_event['address'] ||
-                $old_event['address2'] ||
-                $old_event['city'] ||
-                $old_event['state'] ||
-                $old_event['zip'] ||
-                $old_event['venue_title'] ||
-                $old_event['venue_url'] ||
-                $old_event['venue_image'] ||
-                $old_event['venue_phone'] ||
-                $old_event['virtual_url'] ||
-                $old_event['virtual_phone']
-                ) {
-            $old_id = $this->_duplicate_venue_exists($old_event);
-            if ($old_id) {
-                return $old_id;
-            }
-            $new_id = $this->_insert_venue_into_posts($old_event);
-            if ($new_id) {
-                $this->_insert_venue_into_meta_table($new_id, $old_event);
-                $guid = isset($old_event['venue_image']) ? $old_event['venue_image']  : null;
-                $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
-            }
-            // we don't bother recording the conversion from old events to venues as that
-            // will complicate finding the conversion from old venues to new events
-            return $new_id;
-        } else {
-            return 0;
-        }
-    }
-
-    /**
-     * Assuming there is venue data on this event, check if there is a duplicate venue already in the system for it.
-     * If so, return it. Otherwise return NULL.
-     * @param array $old_event
-     * @return int duplicate venue id
-     */
-    private function _duplicate_venue_exists($old_event)
-    {
-        global $wpdb;
-        $conditions = array(
-            'VNU_address' => $old_event ['address'],
-            'VNU_address2' => $old_event['address2'],
-            'VNU_city' => $old_event['city'],
-            'VNU_zip' => $old_event['zip'],
-            'post_title'=> $this->_get_venue_title_for_event($old_event),
-            'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
-            'VNU_url'=>$old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
-        );
-        $sql_conditions = array();
-        foreach ($conditions as $column => $value) {
-            $sql_conditions [] = $wpdb->prepare("$column = %s", $value);
-        }
-        $query = "SELECT VNU_ID
+		$default_reg_status = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(isset($event_meta['default_payment_status']) ? $event_meta['default_payment_status'] : '', intval($old_event['require_pre_approval']));
+		$cols_n_values = array(
+			'EVT_ID'=>$new_cpt_id,// EVT_ID_fk
+			'EVT_display_desc'=> 'Y' == $old_event['display_desc'],
+			'EVT_display_ticket_selector'=> 'Y'== $old_event['display_reg_form'],
+			'EVT_visible_on'=> $this->get_migration_script()->convert_date_string_to_utc($this, $old_event, current_time('mysql'), $old_event['timezone_string']),// don't use the old 'visible_on', as it wasn't ever used
+			'EVT_additional_limit'=> $old_event['allow_multiple'] == 'N' ? 1 : $old_event['additional_limit'],
+			'EVT_default_registration_status' => $default_reg_status,
+			'EVT_member_only'=>$old_event['member_only'],
+			'EVT_phone'=> $old_event['phone'],
+			'EVT_allow_overflow' => 'Y' == $old_event['allow_overflow'],
+			'EVT_timezone_string'=> $old_event['timezone_string'],
+			'EVT_external_URL'=>$old_event['externalURL'],
+			'EVT_donations'=>false// doesnt exist in 3.1
+
+		);
+		$datatypes = array(
+			'%s',// EVT_ID
+			'%d',// EVT_display_desc
+			'%d',// EVT_display_ticket_selector
+			'%s',// EVT_visible_on
+			'%d',// EVT_additional_limit
+			'%s',// EVT_default_registration_status
+			'%d',// EVT_member_only
+			'%s',// EVT_phone
+			'%d',// EVT_allow_overflow
+			'%s',// EVT_timezone_string
+			'%s',// EVT_external_URL
+			'%d',// EVT_donations
+		);
+		$success = $wpdb->insert(
+			$this->_new_meta_table,
+			$cols_n_values,
+			$datatypes
+		);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+
+	/**
+	 * @param $old_event
+	 * @return int
+	 */
+	private function _maybe_create_venue($old_event)
+	{
+		if ($old_event['address'] ||
+				$old_event['address2'] ||
+				$old_event['city'] ||
+				$old_event['state'] ||
+				$old_event['zip'] ||
+				$old_event['venue_title'] ||
+				$old_event['venue_url'] ||
+				$old_event['venue_image'] ||
+				$old_event['venue_phone'] ||
+				$old_event['virtual_url'] ||
+				$old_event['virtual_phone']
+				) {
+			$old_id = $this->_duplicate_venue_exists($old_event);
+			if ($old_id) {
+				return $old_id;
+			}
+			$new_id = $this->_insert_venue_into_posts($old_event);
+			if ($new_id) {
+				$this->_insert_venue_into_meta_table($new_id, $old_event);
+				$guid = isset($old_event['venue_image']) ? $old_event['venue_image']  : null;
+				$this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
+			}
+			// we don't bother recording the conversion from old events to venues as that
+			// will complicate finding the conversion from old venues to new events
+			return $new_id;
+		} else {
+			return 0;
+		}
+	}
+
+	/**
+	 * Assuming there is venue data on this event, check if there is a duplicate venue already in the system for it.
+	 * If so, return it. Otherwise return NULL.
+	 * @param array $old_event
+	 * @return int duplicate venue id
+	 */
+	private function _duplicate_venue_exists($old_event)
+	{
+		global $wpdb;
+		$conditions = array(
+			'VNU_address' => $old_event ['address'],
+			'VNU_address2' => $old_event['address2'],
+			'VNU_city' => $old_event['city'],
+			'VNU_zip' => $old_event['zip'],
+			'post_title'=> $this->_get_venue_title_for_event($old_event),
+			'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
+			'VNU_url'=>$old_event['venue_url'],// VNU_url
+			'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
+			'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
+		);
+		$sql_conditions = array();
+		foreach ($conditions as $column => $value) {
+			$sql_conditions [] = $wpdb->prepare("$column = %s", $value);
+		}
+		$query = "SELECT VNU_ID
 					FROM
 		{$wpdb->posts} as p INNER JOIN
 		{$wpdb->prefix}esp_venue_meta as v ON p.ID = v.VNU_ID
 			WHERE " . implode(" AND ", $sql_conditions) . " LIMIT 1";
-        $id = $wpdb->get_var($query);
-        return $id;
-    }
-
-    /**
-     * Gets teh venue's title or makes one up if there is none
-     * @param array $event_data_array keys are events_details columns and values are their values
-     * @return string
-     */
-    protected function _get_venue_title_for_event($event_data_array)
-    {
-        return $event_data_array['venue_title'] ? stripslashes($event_data_array['venue_title']) : stripslashes(sprintf(__('Venue of %s', 'event_espresso'), $event_data_array['event_name']));
-    }
-
-    /**
-     * Inserts the CPT
-     *
-     * @param array $old_event keys are cols, values are col values
-     * @return int
-     */
-    private function _insert_venue_into_posts($old_event)
-    {
-        global $wpdb;
-        $insertion_array = array(
-                    'post_title'=> $this->_get_venue_title_for_event($old_event),// VNU_name
-                    'post_content'=>'',// VNU_desc
-                    'post_name'=> $this->_find_unique_slug($old_event['venue_title'], sanitize_title('venue-of-' . $old_event['event_name'])),// VNU_identifier
-                    'post_date'=>current_time('mysql'),// VNU_created
-                    'post_date_gmt'=>get_gmt_from_date(current_time('mysql')),
-                    'post_excerpt'=>'',// VNU_short_desc arbitrary only 50 characters
-                    'post_modified'=>current_time('mysql'),// VNU_modified
-                    'post_modified_gmt'=>get_gmt_from_date(current_time('mysql')),
-                    'post_author'=>$old_event['wp_user'],// VNU_wp_user
-                    'post_parent'=>0,// parent
-                    'menu_order'=>0,// VNU_order
-                    'post_type'=>'espresso_venues'// post_type
-                );
-        $datatypes_array = array(
-                    '%s',// VNU_name
-                    '%s',// VNU_desc
-                    '%s',// VNU_identifier
-                    '%s',// VNU_created
-                    '%s',
-                    '%s',// VNU_short_desc
-                    '%s',// VNU_modified
-                    '%s',
-                    '%d',// VNU_wp_user
-                    '%d',// parent
-                    '%d',// VNU_order
-                    '%s',// post_type
-                );
-        $success = $wpdb->insert(
-            $wpdb->posts,
-            $insertion_array,
-            $datatypes_array
-        );
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_event,
-                    $this->_new_table,
-                    $insertion_array,
-                    $datatypes_array
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-    /**
-     * Inserts into the venue_meta table
-     * @param int $cpt_id
-     * @param array $old_event
-     * @return int
-     */
-    private function _insert_venue_into_meta_table($cpt_id, $old_event)
-    {
-        global $wpdb;
-
-        // assume the country is the same as the organization's old settings
-        $country_iso = $this->get_migration_script()->get_default_country_iso();
-        // find the state from the venue, or the organization, or just guess california
-        if (! $old_event['state']) {
-            $old_org_options = get_option('events_organization_settings');
-            $state_name = stripslashes($old_org_options['organization_state']);
-        } else {
-            $state_name = $old_event['state'];
-        }
-        if (! $state_name) {
-            $state_name = 'CA';
-        }
-        // get a state ID with the same name, if possible
-        try {
-            $state = $this->get_migration_script()->get_or_create_state($state_name, $country_iso);
-            $state_id = $state['STA_ID'];
-        } catch (EE_Error $e) {
-            $this->add_error($e->getMessage());
-            $state_id = 0;
-        }
-        // now insert into meta table
-        $insertion_array = array(
-            'VNU_ID'=>$cpt_id,// VNU_ID_fk
-            'VNU_address'=>stripslashes($old_event['address']),// VNU_address
-            'VNU_address2'=>stripslashes($old_event['address2']),// VNU_address2
-            'VNU_city'=>stripslashes($old_event['city']),// VNU_city
-            'STA_ID'=>$state_id,// STA_ID
-            'CNT_ISO'=>$country_iso,// CNT_ISO
-            'VNU_zip'=>$old_event['zip'],// VNU_zip
-            'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
-            'VNU_capacity'=>-1,// VNU_capacity
-            'VNU_url'=>$old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
-            'VNU_google_map_link'=>'',// VNU_google_map_link
-            'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
-        );
-        $datatypes = array(
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
-        );
-        $success = $wpdb->insert($wpdb->prefix."esp_venue_meta", $insertion_array, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $insertion_array, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-
-
-    /**
-     * @param $new_event_id
-     * @param $new_venue_id
-     * @return int
-     */
-    private function _insert_new_venue_to_event($new_event_id, $new_venue_id)
-    {
-        global $wpdb;
-        if (! $new_event_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id));
-            return 0;
-        }
-        if (! $new_venue_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id));
-            return 0;
-        }
-        $cols_n_values = array(
-            'EVT_ID'=>$new_event_id,
-            'VNU_ID'=>$new_venue_id,
-            'EVV_primary'=>true
-        );
-        $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
-        );
-        $success = $wpdb->insert($wpdb->prefix."esp_event_venue", $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    array(),
-                    $this->_new_table,
-                    $cols_n_values,
-                    $datatypes
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-    /**
-     * Converts all the 3.1 start-end times for the event to 4.1 datetimes
-     * @global wpdb $wpdb
-     * @param array $old_event results of get_results(...,ARRAY_A)
-     * @param int $new_cpt_id new post ID
-     * @return void (if there are errors though, adds them to the stage's error list
-     */
-    private function _convert_start_end_times($old_event, $new_cpt_id)
-    {
-        $start_end_times = $this->_get_old_start_end_times($old_event['id']);
-        foreach ($start_end_times as $start_end_time) {
-            $datetime_id = $this->_insert_new_datetime($start_end_time, $old_event, $new_cpt_id);
-            if ($datetime_id) {
-                $this->get_migration_script()->set_mapping($this->_old_start_end_table, $start_end_time['id'], $this->_new_datetime_table, $datetime_id);
-            }
-        }
-    }
-    /**
-     * Queries the 3.1 wp_events_start_end table to get all the start and end times for the event
-     * @global wpdb $wpdb
-     * @param int $old_event_id
-     * @return array
-     */
-    private function _get_old_start_end_times($old_event_id)
-    {
-        global $wpdb;
-        return $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_start_end_table WHERE event_id=%d", $old_event_id), ARRAY_A);
-    }
-    /**
-     * Inserts a 4.1 datetime given the 3.1 start_end db row and event_details row
-     * @param array $start_end_time_row
-     * @param array $old_event_row
-     * @param int $new_cpt_id
-     * @return int ID of new datetime
-     */
-    private function _insert_new_datetime($start_end_time_row, $old_event_row, $new_cpt_id)
-    {
-        global $wpdb;
-        $start_date = $old_event_row['start_date'];
-        $start_time = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['start_time']);
-        $end_date = $old_event_row['end_date'];
-        $end_time = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['end_time']);
-        $existing_datetimes = $this->_count_other_datetimes_exist_for_new_event($new_cpt_id);
-        $start_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$start_date $start_time:00", $old_event_row['timezone_string']);
-        $end_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$end_date $end_time:00", $old_event_row['timezone_string']);
-        $cols_n_values = array(
-            'EVT_ID'=>$new_cpt_id,// EVT_ID
-            'DTT_EVT_start'=>$start_datetime_utc,// DTT_EVT_start
-            'DTT_EVT_end'=> $end_datetime_utc,// DTT_EVT_end
-            'DTT_reg_limit'=>intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit'] : $old_event_row['reg_limit'],// DTT_reg_limit
-            'DTT_sold'=>0,// note: we will increment this as registrations are added during the migration
+		$id = $wpdb->get_var($query);
+		return $id;
+	}
+
+	/**
+	 * Gets teh venue's title or makes one up if there is none
+	 * @param array $event_data_array keys are events_details columns and values are their values
+	 * @return string
+	 */
+	protected function _get_venue_title_for_event($event_data_array)
+	{
+		return $event_data_array['venue_title'] ? stripslashes($event_data_array['venue_title']) : stripslashes(sprintf(__('Venue of %s', 'event_espresso'), $event_data_array['event_name']));
+	}
+
+	/**
+	 * Inserts the CPT
+	 *
+	 * @param array $old_event keys are cols, values are col values
+	 * @return int
+	 */
+	private function _insert_venue_into_posts($old_event)
+	{
+		global $wpdb;
+		$insertion_array = array(
+					'post_title'=> $this->_get_venue_title_for_event($old_event),// VNU_name
+					'post_content'=>'',// VNU_desc
+					'post_name'=> $this->_find_unique_slug($old_event['venue_title'], sanitize_title('venue-of-' . $old_event['event_name'])),// VNU_identifier
+					'post_date'=>current_time('mysql'),// VNU_created
+					'post_date_gmt'=>get_gmt_from_date(current_time('mysql')),
+					'post_excerpt'=>'',// VNU_short_desc arbitrary only 50 characters
+					'post_modified'=>current_time('mysql'),// VNU_modified
+					'post_modified_gmt'=>get_gmt_from_date(current_time('mysql')),
+					'post_author'=>$old_event['wp_user'],// VNU_wp_user
+					'post_parent'=>0,// parent
+					'menu_order'=>0,// VNU_order
+					'post_type'=>'espresso_venues'// post_type
+				);
+		$datatypes_array = array(
+					'%s',// VNU_name
+					'%s',// VNU_desc
+					'%s',// VNU_identifier
+					'%s',// VNU_created
+					'%s',
+					'%s',// VNU_short_desc
+					'%s',// VNU_modified
+					'%s',
+					'%d',// VNU_wp_user
+					'%d',// parent
+					'%d',// VNU_order
+					'%s',// post_type
+				);
+		$success = $wpdb->insert(
+			$wpdb->posts,
+			$insertion_array,
+			$datatypes_array
+		);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_event,
+					$this->_new_table,
+					$insertion_array,
+					$datatypes_array
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+	/**
+	 * Inserts into the venue_meta table
+	 * @param int $cpt_id
+	 * @param array $old_event
+	 * @return int
+	 */
+	private function _insert_venue_into_meta_table($cpt_id, $old_event)
+	{
+		global $wpdb;
+
+		// assume the country is the same as the organization's old settings
+		$country_iso = $this->get_migration_script()->get_default_country_iso();
+		// find the state from the venue, or the organization, or just guess california
+		if (! $old_event['state']) {
+			$old_org_options = get_option('events_organization_settings');
+			$state_name = stripslashes($old_org_options['organization_state']);
+		} else {
+			$state_name = $old_event['state'];
+		}
+		if (! $state_name) {
+			$state_name = 'CA';
+		}
+		// get a state ID with the same name, if possible
+		try {
+			$state = $this->get_migration_script()->get_or_create_state($state_name, $country_iso);
+			$state_id = $state['STA_ID'];
+		} catch (EE_Error $e) {
+			$this->add_error($e->getMessage());
+			$state_id = 0;
+		}
+		// now insert into meta table
+		$insertion_array = array(
+			'VNU_ID'=>$cpt_id,// VNU_ID_fk
+			'VNU_address'=>stripslashes($old_event['address']),// VNU_address
+			'VNU_address2'=>stripslashes($old_event['address2']),// VNU_address2
+			'VNU_city'=>stripslashes($old_event['city']),// VNU_city
+			'STA_ID'=>$state_id,// STA_ID
+			'CNT_ISO'=>$country_iso,// CNT_ISO
+			'VNU_zip'=>$old_event['zip'],// VNU_zip
+			'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
+			'VNU_capacity'=>-1,// VNU_capacity
+			'VNU_url'=>$old_event['venue_url'],// VNU_url
+			'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
+			'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
+			'VNU_google_map_link'=>'',// VNU_google_map_link
+			'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
+		);
+		$datatypes = array(
+			'%d',// VNU_ID_fk
+			'%s',// VNU_address
+			'%s',// VNU_address2
+			'%s',// VNU_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// VNU_zip
+			'%s',// VNU_phone
+			'%d',// VNU_capacity
+			'%s',// VNU_url
+			'%s',// VNU_virtual_phone
+			'%s',// VNU_virtual_url
+			'%s',// VNU_google_map_link
+			'%d',// VNU_enable_for_gmap
+		);
+		$success = $wpdb->insert($wpdb->prefix."esp_venue_meta", $insertion_array, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $insertion_array, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+
+
+	/**
+	 * @param $new_event_id
+	 * @param $new_venue_id
+	 * @return int
+	 */
+	private function _insert_new_venue_to_event($new_event_id, $new_venue_id)
+	{
+		global $wpdb;
+		if (! $new_event_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id));
+			return 0;
+		}
+		if (! $new_venue_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id));
+			return 0;
+		}
+		$cols_n_values = array(
+			'EVT_ID'=>$new_event_id,
+			'VNU_ID'=>$new_venue_id,
+			'EVV_primary'=>true
+		);
+		$datatypes = array(
+			'%d',// EVT_ID
+			'%d',// VNU_ID
+			'%d',// EVT_primary
+		);
+		$success = $wpdb->insert($wpdb->prefix."esp_event_venue", $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					array(),
+					$this->_new_table,
+					$cols_n_values,
+					$datatypes
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+	/**
+	 * Converts all the 3.1 start-end times for the event to 4.1 datetimes
+	 * @global wpdb $wpdb
+	 * @param array $old_event results of get_results(...,ARRAY_A)
+	 * @param int $new_cpt_id new post ID
+	 * @return void (if there are errors though, adds them to the stage's error list
+	 */
+	private function _convert_start_end_times($old_event, $new_cpt_id)
+	{
+		$start_end_times = $this->_get_old_start_end_times($old_event['id']);
+		foreach ($start_end_times as $start_end_time) {
+			$datetime_id = $this->_insert_new_datetime($start_end_time, $old_event, $new_cpt_id);
+			if ($datetime_id) {
+				$this->get_migration_script()->set_mapping($this->_old_start_end_table, $start_end_time['id'], $this->_new_datetime_table, $datetime_id);
+			}
+		}
+	}
+	/**
+	 * Queries the 3.1 wp_events_start_end table to get all the start and end times for the event
+	 * @global wpdb $wpdb
+	 * @param int $old_event_id
+	 * @return array
+	 */
+	private function _get_old_start_end_times($old_event_id)
+	{
+		global $wpdb;
+		return $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_start_end_table WHERE event_id=%d", $old_event_id), ARRAY_A);
+	}
+	/**
+	 * Inserts a 4.1 datetime given the 3.1 start_end db row and event_details row
+	 * @param array $start_end_time_row
+	 * @param array $old_event_row
+	 * @param int $new_cpt_id
+	 * @return int ID of new datetime
+	 */
+	private function _insert_new_datetime($start_end_time_row, $old_event_row, $new_cpt_id)
+	{
+		global $wpdb;
+		$start_date = $old_event_row['start_date'];
+		$start_time = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['start_time']);
+		$end_date = $old_event_row['end_date'];
+		$end_time = $this->get_migration_script()->convertTimeFromAMPM($start_end_time_row['end_time']);
+		$existing_datetimes = $this->_count_other_datetimes_exist_for_new_event($new_cpt_id);
+		$start_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$start_date $start_time:00", $old_event_row['timezone_string']);
+		$end_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$end_date $end_time:00", $old_event_row['timezone_string']);
+		$cols_n_values = array(
+			'EVT_ID'=>$new_cpt_id,// EVT_ID
+			'DTT_EVT_start'=>$start_datetime_utc,// DTT_EVT_start
+			'DTT_EVT_end'=> $end_datetime_utc,// DTT_EVT_end
+			'DTT_reg_limit'=>intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit'] : $old_event_row['reg_limit'],// DTT_reg_limit
+			'DTT_sold'=>0,// note: we will increment this as registrations are added during the migration
 //          'DTT_is_primary'=> 0 == $existing_datetimes ,//DTT_is_primary... if count==0, then we'll call it the 'primary'
-            'DTT_order'=> $existing_datetimes,// DTT_order, just give it the same order as the count of how many datetimes already exist
-            'DTT_parent'=>0,
-            'DTT_deleted'=>false
-        );
-        $datatypes = array(
-            '%d',// EVT_Id
-            '%s',// DTT_EVT_start
-            '%s',// DTT_EVT_end
-            '%d',// DTT_reg_limit
-            '%d',// DTT_sold
+			'DTT_order'=> $existing_datetimes,// DTT_order, just give it the same order as the count of how many datetimes already exist
+			'DTT_parent'=>0,
+			'DTT_deleted'=>false
+		);
+		$datatypes = array(
+			'%d',// EVT_Id
+			'%s',// DTT_EVT_start
+			'%s',// DTT_EVT_end
+			'%d',// DTT_reg_limit
+			'%d',// DTT_sold
 //          '%d',//DTT_is_primary
-            '%d',// DTT_order
-            '%d',// DTT_parent
-            '%d',// DTT_deleted
-        );
-        $success = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_start_end_table, array_merge($old_event_row, $start_end_time_row), $this->_new_datetime_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
-
-    /**
-     * Checks if there's a 4.1 datetime for this event already. This is mostly only handy
-     * when deciding whether a datetime we're about ot insert should be the 'primary' or not
-     * @global wpdb $wpdb
-     * @param int $cpt_event_id
-     * @return int
-     */
-    private function _count_other_datetimes_exist_for_new_event($cpt_event_id)
-    {
-        global $wpdb;
-        $count = $wpdb->get_var($wpdb->prepare("SELECT COUNT(*) FROM $this->_new_datetime_table WHERE EVT_ID=%d", $cpt_event_id));
-        return intval($count);
-    }
+			'%d',// DTT_order
+			'%d',// DTT_parent
+			'%d',// DTT_deleted
+		);
+		$success = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_start_end_table, array_merge($old_event_row, $start_end_time_row), $this->_new_datetime_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
+
+	/**
+	 * Checks if there's a 4.1 datetime for this event already. This is mostly only handy
+	 * when deciding whether a datetime we're about ot insert should be the 'primary' or not
+	 * @global wpdb $wpdb
+	 * @param int $cpt_event_id
+	 * @return int
+	 */
+	private function _count_other_datetimes_exist_for_new_event($cpt_event_id)
+	{
+		global $wpdb;
+		$count = $wpdb->get_var($wpdb->prepare("SELECT COUNT(*) FROM $this->_new_datetime_table WHERE EVT_ID=%d", $cpt_event_id));
+		return intval($count);
+	}
 }

Spacing +132 added lines, -132 removed lines

@@ -193,7 +193,7 @@ 
     public function _count_records_to_migrate()
     {
         global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table . ' WHERE event_status !="D"');
+        $count = $wpdb->get_var("SELECT COUNT(*) FROM ".$this->_old_table.' WHERE event_status !="D"');
         return intval($count);
     }
 
@@ -212,7 +212,7 @@ 
     {
         global $wpdb;
         // because the migration of each event can be a LOT more work, make each step smaller
-        $num_items_to_migrate = max(1, $num_items_to_migrate/5);
+        $num_items_to_migrate = max(1, $num_items_to_migrate / 5);
         $events = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table WHERE event_status!='D' LIMIT %d,%d", $this->count_records_migrated(), $num_items_to_migrate), ARRAY_A);
         $items_migrated_this_step = 0;
 
@@ -260,17 +260,17 @@ 
     private function _add_post_metas($old_event, $post_id)
     {
         $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (! $event_meta || ! is_array($event_meta)) {
+        if ( ! $event_meta || ! is_array($event_meta)) {
             return;
         }
-        unset($event_meta['date_submitted']);// factored into CPT
-        unset($event_meta['additional_attendee_reg_info']);// factored into event meta table
-        unset($event_meta['default_payment_status']);// dido
-        unset($event_meta['event_thumbnail_url']);// used to find post featured image
+        unset($event_meta['date_submitted']); // factored into CPT
+        unset($event_meta['additional_attendee_reg_info']); // factored into event meta table
+        unset($event_meta['default_payment_status']); // dido
+        unset($event_meta['event_thumbnail_url']); // used to find post featured image
         foreach ($event_meta as $meta_key => $meta_value) {
             if ($meta_key) {// if the meta key is just an empty string, ignore it
                 $success = add_post_meta($post_id, $meta_key, $meta_value, true);
-                if (! $success) {
+                if ( ! $success) {
                     $this->add_error(sprintf(__("Could not add post meta for CPT with ID #%d. Meta key: '%s',meta value:'%d' for 3.1 event: %s", "event_espresso"), $post_id, $meta_key, $meta_value, implode(",", $old_event)));
                 }
             }
@@ -341,68 +341,68 @@ 
 //      and 3 custom ones: cancelled,postponed,sold_out
         $status_conversions = array(
             'R'=>'draft',
-            'X'=>'draft',// 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
+            'X'=>'draft', // 4.1 doesn't have a "not approved for publishing" status. this is what posts are set to that aren't approved
             'P'=>'pending',
-            'IA'=>'draft',// draft and in the past
+            'IA'=>'draft', // draft and in the past
 // IA=inactive in 3.1: events were switched to this when they expired. in 4.1 that's just calculated
-            'O'=>'publish',// @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
+            'O'=>'publish', // @todo: will be an event type later; if this is the status, set the end date WAAAY later; and add term for 'ongoing'
             'A'=>'publish',
-            'S'=>'draft',// @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
+            'S'=>'draft', // @todo: is it ok to just mark secondary/waitlist events as DRAFTS?
             'D'=>'trash',
         );
-        $post_status = $status_conversions[ $old_event['event_status'] ];
+        $post_status = $status_conversions[$old_event['event_status']];
         // check if we've sold out
         if (intval($old_event['reg_limit']) <= self::count_registrations($old_event['id'])) {
             $post_status = 'sold_out';
         }
 //      FYI postponed and cancelled don't exist in 3.1
         $cols_n_values = array(
-            'post_title'=>stripslashes($old_event['event_name']),// EVT_name
-            'post_content'=>stripslashes($old_event['event_desc']),// EVT_desc
-            'post_name'=>$this->_find_unique_slug($old_event['event_name'], $old_event['event_identifier'], $post_status),// EVT_slug
-            'post_date'=>$old_event['submitted'],// EVT_created NOT
+            'post_title'=>stripslashes($old_event['event_name']), // EVT_name
+            'post_content'=>stripslashes($old_event['event_desc']), // EVT_desc
+            'post_name'=>$this->_find_unique_slug($old_event['event_name'], $old_event['event_identifier'], $post_status), // EVT_slug
+            'post_date'=>$old_event['submitted'], // EVT_created NOT
             'post_date_gmt'=>get_gmt_from_date($old_event['submitted']),
-            'post_excerpt'=>'',// EVT_short_desc
-            'post_modified'=>$old_event['submitted'],// EVT_modified
+            'post_excerpt'=>'', // EVT_short_desc
+            'post_modified'=>$old_event['submitted'], // EVT_modified
             'post_modified_gmt'=>get_gmt_from_date($old_event['submitted']),
-            'post_author'=>$old_event['wp_user'],// EVT_wp_user
-            'post_parent'=>0,// parent maybe get this from some REM field?
-            'menu_order'=>0,// EVT_order
-            'post_type'=>'espresso_events',// post_type
-            'post_status'=>$post_status,// status
+            'post_author'=>$old_event['wp_user'], // EVT_wp_user
+            'post_parent'=>0, // parent maybe get this from some REM field?
+            'menu_order'=>0, // EVT_order
+            'post_type'=>'espresso_events', // post_type
+            'post_status'=>$post_status, // status
         );
         $cols_n_values_with_no_invalid_text = array();
         foreach ($cols_n_values as $col => $value) {
             $value_sans_invalid_chars = $wpdb->strip_invalid_text_for_column($this->_new_table, $col, $value);
-            if (! is_wp_error($value_sans_invalid_chars)) {
-                $cols_n_values_with_no_invalid_text[ $col ] = $value_sans_invalid_chars;
+            if ( ! is_wp_error($value_sans_invalid_chars)) {
+                $cols_n_values_with_no_invalid_text[$col] = $value_sans_invalid_chars;
             } else {
                 // otherwise leave it as-is. It will blow everything up and stop the migration
-                $cols_n_values_with_no_invalid_text[ $col ] = $value;
+                $cols_n_values_with_no_invalid_text[$col] = $value;
             }
         }
         $cols_n_values = $cols_n_values_with_no_invalid_text;
         $datatypes = array(
-            '%s',// EVT_name
-            '%s',// EVT_desc
-            '%s',// EVT_slug
-            '%s',// EVT_created
+            '%s', // EVT_name
+            '%s', // EVT_desc
+            '%s', // EVT_slug
+            '%s', // EVT_created
             '%s',
-            '%s',// EVT_short_desc
-            '%s',// EVT_modified
+            '%s', // EVT_short_desc
+            '%s', // EVT_modified
             '%s',
-            '%s',// EVT_wp_user
-            '%d',// post_parent
-            '%d',// EVT_order
-            '%s',// post_type
-            '%s',// status
+            '%s', // EVT_wp_user
+            '%d', // post_parent
+            '%d', // EVT_order
+            '%s', // post_type
+            '%s', // status
         );
         $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_event, $this->_new_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -441,10 +441,10 @@ 
 // );
         $default_reg_status = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(isset($event_meta['default_payment_status']) ? $event_meta['default_payment_status'] : '', intval($old_event['require_pre_approval']));
         $cols_n_values = array(
-            'EVT_ID'=>$new_cpt_id,// EVT_ID_fk
+            'EVT_ID'=>$new_cpt_id, // EVT_ID_fk
             'EVT_display_desc'=> 'Y' == $old_event['display_desc'],
-            'EVT_display_ticket_selector'=> 'Y'== $old_event['display_reg_form'],
-            'EVT_visible_on'=> $this->get_migration_script()->convert_date_string_to_utc($this, $old_event, current_time('mysql'), $old_event['timezone_string']),// don't use the old 'visible_on', as it wasn't ever used
+            'EVT_display_ticket_selector'=> 'Y' == $old_event['display_reg_form'],
+            'EVT_visible_on'=> $this->get_migration_script()->convert_date_string_to_utc($this, $old_event, current_time('mysql'), $old_event['timezone_string']), // don't use the old 'visible_on', as it wasn't ever used
             'EVT_additional_limit'=> $old_event['allow_multiple'] == 'N' ? 1 : $old_event['additional_limit'],
             'EVT_default_registration_status' => $default_reg_status,
             'EVT_member_only'=>$old_event['member_only'],
@@ -456,25 +456,25 @@ 
 
         );
         $datatypes = array(
-            '%s',// EVT_ID
-            '%d',// EVT_display_desc
-            '%d',// EVT_display_ticket_selector
-            '%s',// EVT_visible_on
-            '%d',// EVT_additional_limit
-            '%s',// EVT_default_registration_status
-            '%d',// EVT_member_only
-            '%s',// EVT_phone
-            '%d',// EVT_allow_overflow
-            '%s',// EVT_timezone_string
-            '%s',// EVT_external_URL
-            '%d',// EVT_donations
+            '%s', // EVT_ID
+            '%d', // EVT_display_desc
+            '%d', // EVT_display_ticket_selector
+            '%s', // EVT_visible_on
+            '%d', // EVT_additional_limit
+            '%s', // EVT_default_registration_status
+            '%d', // EVT_member_only
+            '%s', // EVT_phone
+            '%d', // EVT_allow_overflow
+            '%s', // EVT_timezone_string
+            '%s', // EVT_external_URL
+            '%d', // EVT_donations
         );
         $success = $wpdb->insert(
             $this->_new_meta_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_event, $this->_new_meta_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -508,7 +508,7 @@ 
             $new_id = $this->_insert_venue_into_posts($old_event);
             if ($new_id) {
                 $this->_insert_venue_into_meta_table($new_id, $old_event);
-                $guid = isset($old_event['venue_image']) ? $old_event['venue_image']  : null;
+                $guid = isset($old_event['venue_image']) ? $old_event['venue_image'] : null;
                 $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
             }
             // we don't bother recording the conversion from old events to venues as that
@@ -534,10 +534,10 @@ 
             'VNU_city' => $old_event['city'],
             'VNU_zip' => $old_event['zip'],
             'post_title'=> $this->_get_venue_title_for_event($old_event),
-            'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
-            'VNU_url'=>$old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
+            'VNU_phone'=>$old_event['venue_phone'], // VNU_phone
+            'VNU_url'=>$old_event['venue_url'], // VNU_url
+            'VNU_virtual_phone'=>$old_event['virtual_phone'], // VNU_virtual_phone
+            'VNU_virtual_url'=>$old_event['virtual_url'], // VNU_virtual_url
         );
         $sql_conditions = array();
         foreach ($conditions as $column => $value) {
@@ -547,7 +547,7 @@ 
 					FROM
 		{$wpdb->posts} as p INNER JOIN
 		{$wpdb->prefix}esp_venue_meta as v ON p.ID = v.VNU_ID
-			WHERE " . implode(" AND ", $sql_conditions) . " LIMIT 1";
+			WHERE ".implode(" AND ", $sql_conditions)." LIMIT 1";
         $id = $wpdb->get_var($query);
         return $id;
     }
@@ -572,39 +572,39 @@ 
     {
         global $wpdb;
         $insertion_array = array(
-                    'post_title'=> $this->_get_venue_title_for_event($old_event),// VNU_name
-                    'post_content'=>'',// VNU_desc
-                    'post_name'=> $this->_find_unique_slug($old_event['venue_title'], sanitize_title('venue-of-' . $old_event['event_name'])),// VNU_identifier
-                    'post_date'=>current_time('mysql'),// VNU_created
+                    'post_title'=> $this->_get_venue_title_for_event($old_event), // VNU_name
+                    'post_content'=>'', // VNU_desc
+                    'post_name'=> $this->_find_unique_slug($old_event['venue_title'], sanitize_title('venue-of-'.$old_event['event_name'])), // VNU_identifier
+                    'post_date'=>current_time('mysql'), // VNU_created
                     'post_date_gmt'=>get_gmt_from_date(current_time('mysql')),
-                    'post_excerpt'=>'',// VNU_short_desc arbitrary only 50 characters
-                    'post_modified'=>current_time('mysql'),// VNU_modified
+                    'post_excerpt'=>'', // VNU_short_desc arbitrary only 50 characters
+                    'post_modified'=>current_time('mysql'), // VNU_modified
                     'post_modified_gmt'=>get_gmt_from_date(current_time('mysql')),
-                    'post_author'=>$old_event['wp_user'],// VNU_wp_user
-                    'post_parent'=>0,// parent
-                    'menu_order'=>0,// VNU_order
+                    'post_author'=>$old_event['wp_user'], // VNU_wp_user
+                    'post_parent'=>0, // parent
+                    'menu_order'=>0, // VNU_order
                     'post_type'=>'espresso_venues'// post_type
                 );
         $datatypes_array = array(
-                    '%s',// VNU_name
-                    '%s',// VNU_desc
-                    '%s',// VNU_identifier
-                    '%s',// VNU_created
+                    '%s', // VNU_name
+                    '%s', // VNU_desc
+                    '%s', // VNU_identifier
+                    '%s', // VNU_created
                     '%s',
-                    '%s',// VNU_short_desc
-                    '%s',// VNU_modified
+                    '%s', // VNU_short_desc
+                    '%s', // VNU_modified
                     '%s',
-                    '%d',// VNU_wp_user
-                    '%d',// parent
-                    '%d',// VNU_order
-                    '%s',// post_type
+                    '%d', // VNU_wp_user
+                    '%d', // parent
+                    '%d', // VNU_order
+                    '%s', // post_type
                 );
         $success = $wpdb->insert(
             $wpdb->posts,
             $insertion_array,
             $datatypes_array
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -632,13 +632,13 @@ 
         // assume the country is the same as the organization's old settings
         $country_iso = $this->get_migration_script()->get_default_country_iso();
         // find the state from the venue, or the organization, or just guess california
-        if (! $old_event['state']) {
+        if ( ! $old_event['state']) {
             $old_org_options = get_option('events_organization_settings');
             $state_name = stripslashes($old_org_options['organization_state']);
         } else {
             $state_name = $old_event['state'];
         }
-        if (! $state_name) {
+        if ( ! $state_name) {
             $state_name = 'CA';
         }
         // get a state ID with the same name, if possible
@@ -651,39 +651,39 @@ 
         }
         // now insert into meta table
         $insertion_array = array(
-            'VNU_ID'=>$cpt_id,// VNU_ID_fk
-            'VNU_address'=>stripslashes($old_event['address']),// VNU_address
-            'VNU_address2'=>stripslashes($old_event['address2']),// VNU_address2
-            'VNU_city'=>stripslashes($old_event['city']),// VNU_city
-            'STA_ID'=>$state_id,// STA_ID
-            'CNT_ISO'=>$country_iso,// CNT_ISO
-            'VNU_zip'=>$old_event['zip'],// VNU_zip
-            'VNU_phone'=>$old_event['venue_phone'],// VNU_phone
-            'VNU_capacity'=>-1,// VNU_capacity
-            'VNU_url'=>$old_event['venue_url'],// VNU_url
-            'VNU_virtual_phone'=>$old_event['virtual_phone'],// VNU_virtual_phone
-            'VNU_virtual_url'=>$old_event['virtual_url'],// VNU_virtual_url
-            'VNU_google_map_link'=>'',// VNU_google_map_link
+            'VNU_ID'=>$cpt_id, // VNU_ID_fk
+            'VNU_address'=>stripslashes($old_event['address']), // VNU_address
+            'VNU_address2'=>stripslashes($old_event['address2']), // VNU_address2
+            'VNU_city'=>stripslashes($old_event['city']), // VNU_city
+            'STA_ID'=>$state_id, // STA_ID
+            'CNT_ISO'=>$country_iso, // CNT_ISO
+            'VNU_zip'=>$old_event['zip'], // VNU_zip
+            'VNU_phone'=>$old_event['venue_phone'], // VNU_phone
+            'VNU_capacity'=>-1, // VNU_capacity
+            'VNU_url'=>$old_event['venue_url'], // VNU_url
+            'VNU_virtual_phone'=>$old_event['virtual_phone'], // VNU_virtual_phone
+            'VNU_virtual_url'=>$old_event['virtual_url'], // VNU_virtual_url
+            'VNU_google_map_link'=>'', // VNU_google_map_link
             'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
         );
         $datatypes = array(
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
+            '%d', // VNU_ID_fk
+            '%s', // VNU_address
+            '%s', // VNU_address2
+            '%s', // VNU_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // VNU_zip
+            '%s', // VNU_phone
+            '%d', // VNU_capacity
+            '%s', // VNU_url
+            '%s', // VNU_virtual_phone
+            '%s', // VNU_virtual_url
+            '%s', // VNU_google_map_link
+            '%d', // VNU_enable_for_gmap
         );
         $success = $wpdb->insert($wpdb->prefix."esp_venue_meta", $insertion_array, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_event, $this->_new_meta_table, $insertion_array, $datatypes));
             return 0;
         }
@@ -700,11 +700,11 @@ 
     private function _insert_new_venue_to_event($new_event_id, $new_venue_id)
     {
         global $wpdb;
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(sprintf(__("Could not find 4.1 event id for 3.1 event #%d.", "event_espresso"), $new_event_id));
             return 0;
         }
-        if (! $new_venue_id) {
+        if ( ! $new_venue_id) {
             $this->add_error(sprintf(__("Could not find 4.1 venue id for 3.1 venue #%d.", "event_espresso"), $new_venue_id));
             return 0;
         }
@@ -714,12 +714,12 @@ 
             'EVV_primary'=>true
         );
         $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// VNU_ID
-            '%d',// EVT_primary
+            '%d', // EVT_ID
+            '%d', // VNU_ID
+            '%d', // EVT_primary
         );
         $success = $wpdb->insert($wpdb->prefix."esp_event_venue", $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,
@@ -779,29 +779,29 @@ 
         $start_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$start_date $start_time:00", $old_event_row['timezone_string']);
         $end_datetime_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $start_end_time_row, "$end_date $end_time:00", $old_event_row['timezone_string']);
         $cols_n_values = array(
-            'EVT_ID'=>$new_cpt_id,// EVT_ID
-            'DTT_EVT_start'=>$start_datetime_utc,// DTT_EVT_start
-            'DTT_EVT_end'=> $end_datetime_utc,// DTT_EVT_end
-            'DTT_reg_limit'=>intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit'] : $old_event_row['reg_limit'],// DTT_reg_limit
-            'DTT_sold'=>0,// note: we will increment this as registrations are added during the migration
+            'EVT_ID'=>$new_cpt_id, // EVT_ID
+            'DTT_EVT_start'=>$start_datetime_utc, // DTT_EVT_start
+            'DTT_EVT_end'=> $end_datetime_utc, // DTT_EVT_end
+            'DTT_reg_limit'=>intval($start_end_time_row['reg_limit']) ? $start_end_time_row['reg_limit'] : $old_event_row['reg_limit'], // DTT_reg_limit
+            'DTT_sold'=>0, // note: we will increment this as registrations are added during the migration
 //          'DTT_is_primary'=> 0 == $existing_datetimes ,//DTT_is_primary... if count==0, then we'll call it the 'primary'
-            'DTT_order'=> $existing_datetimes,// DTT_order, just give it the same order as the count of how many datetimes already exist
+            'DTT_order'=> $existing_datetimes, // DTT_order, just give it the same order as the count of how many datetimes already exist
             'DTT_parent'=>0,
             'DTT_deleted'=>false
         );
         $datatypes = array(
-            '%d',// EVT_Id
-            '%s',// DTT_EVT_start
-            '%s',// DTT_EVT_end
-            '%d',// DTT_reg_limit
-            '%d',// DTT_sold
+            '%d', // EVT_Id
+            '%s', // DTT_EVT_start
+            '%s', // DTT_EVT_end
+            '%d', // DTT_reg_limit
+            '%d', // DTT_sold
 //          '%d',//DTT_is_primary
-            '%d',// DTT_order
-            '%d',// DTT_parent
-            '%d',// DTT_deleted
+            '%d', // DTT_order
+            '%d', // DTT_parent
+            '%d', // DTT_deleted
         );
         $success = $wpdb->insert($this->_new_datetime_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_start_end_table, array_merge($old_event_row, $start_end_time_row), $this->_new_datetime_table, $cols_n_values, $datatypes));
             return 0;
         }

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

Doc Comments -1 removed lines

@@ -273,7 +273,6 @@
     /**
      * Creates a 4.1 member price discount
      * @global type $wpdb
-     * @param type $old_price
      * @return int
      */
     private function _insert_new_global_surcharge_price($org_options)

Spacing +33 added lines, -33 removed lines

@@ -110,17 +110,17 @@ 
         $old_org_options = get_option('events_organization_settings');
         foreach ($this->_org_options_we_know_how_to_migrate as $option_name) {
             // only bother migrating if there's a setting to migrate. Otherwise we'll just use the default
-            if (isset($old_org_options[ $option_name ])) {
-                $this->_handle_org_option($option_name, $old_org_options[ $option_name ]);
+            if (isset($old_org_options[$option_name])) {
+                $this->_handle_org_option($option_name, $old_org_options[$option_name]);
             }
-            if ($option_name=='surcharge') {
+            if ($option_name == 'surcharge') {
                 $this->_insert_new_global_surcharge_price($old_org_options);
             }
             $items_actually_migrated++;
         }
 
         $success = EE_Config::instance()->update_espresso_config(false, true);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'), EE_Error::get_notices(false)));
             EE_Error::overwrite_errors();
         }
@@ -176,24 +176,24 @@ 
                 $c->organization->email = $value;
                 break;
             case 'default_payment_status':
-                $c->registration->default_STS_ID =  $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
+                $c->registration->default_STS_ID = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
                 break;
             case 'organization_country':
-                $iso =$this->get_migration_script()->get_iso_from_3_1_country_id($value);
+                $iso = $this->get_migration_script()->get_iso_from_3_1_country_id($value);
                 $c->organization->CNT_ISO = $iso;
                 $country_row = $this->get_migration_script()->get_or_create_country($iso);
-                if (! $country_row) {
+                if ( ! $country_row) {
                     $this->add_error(sprintf(__("Could not set country's currency config because no country exists for ISO %s", "event_espresso"), $iso));
                 }
                 // can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them)
-                $c->currency->code = $country_row['CNT_cur_code'];          // currency code: USD, CAD, EUR
-                $c->currency->name = $country_row['CNT_cur_single'];    // Dollar
-                $c->currency->plural = $country_row['CNT_cur_plural'];  // Dollars
-                $c->currency->sign =  $country_row['CNT_cur_sign'];             // currency sign: $
-                $c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN);        // currency sign before or after: $TRUE  or  FALSE$
-                $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc'];    // decimal places: 2 = 0.00  3 = 0.000
-                $c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk'];    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $c->currency->thsnds = $country_row['CNT_cur_thsnds'];  // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+                $c->currency->code = $country_row['CNT_cur_code']; // currency code: USD, CAD, EUR
+                $c->currency->name = $country_row['CNT_cur_single']; // Dollar
+                $c->currency->plural = $country_row['CNT_cur_plural']; // Dollars
+                $c->currency->sign = $country_row['CNT_cur_sign']; // currency sign: $
+                $c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN); // currency sign before or after: $TRUE  or  FALSE$
+                $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc']; // decimal places: 2 = 0.00  3 = 0.000
+                $c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk']; // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+                $c->currency->thsnds = $country_row['CNT_cur_thsnds']; // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
   //            $c->currency = new EE_Currency_Config($c->organization->CNT_ISO);break;
   //        case 'currency_symbol': ignore the currency symbol. we'll just go by their country.
   //            $c->currency->sign = $value;break;
@@ -280,7 +280,7 @@ 
     {
         $amount = floatval($org_options['surcharge']);
         // dont createa a price if the surcharge is 0
-        if ($amount <=.01) {
+        if ($amount <= .01) {
             return 0;
         }
         if ($org_options['surcharge_type'] == 'flat_rate') {
@@ -301,18 +301,18 @@ 
 
         );
         $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
         );
         $price_table = $wpdb->prefix."esp_price";
         $success = $wpdb->insert($price_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion(
                 'org_options',
                 array(
@@ -342,8 +342,8 @@ 
       'payment_message',
       'message',
       'default_payment_status',
-      'surcharge',// unused?
-      'country_id',// unused?
+      'surcharge', // unused?
+      'country_id', // unused?
       'organization_country',
 //    'currency_symbol',
       'expire_on_registration_end',
@@ -355,13 +355,13 @@ 
       'show_pending_payment_options',
       'show_reg_footer',
       'skip_confirmation_page',
-      'allow_mer_discounts',// no equiv
-      'allow_mer_vouchers',// no equiv
+      'allow_mer_discounts', // no equiv
+      'allow_mer_vouchers', // no equiv
       'display_short_description_in_event_list',
       'display_description_on_multi_reg_page',
       'display_address_in_event_list',
       'display_address_in_regform',
-      'use_custom_post_types',// no equiv
+      'use_custom_post_types', // no equiv
       'display_ical_download',
       'display_featured_image',
       'themeroller',
@@ -380,11 +380,11 @@ 
       'espresso_dashboard_widget',
       'time_reg_limit',
 //    'use_attendee_pre_approval', removed in 4.1- instead this is factored into the default reg status
-      'use_personnel_manager',// no equiv
+      'use_personnel_manager', // no equiv
       'use_event_timezones',
       'full_logging',
-      'surcharge_type',// unused
-      'surcharge_text',// unused
+      'surcharge_type', // unused
+      'surcharge_text', // unused
       'affiliate_id',
       'site_license_key',
     );

Indentation +270 added lines, -270 removed lines

@@ -103,286 +103,286 @@
 class EE_DMS_4_1_0_org_options extends EE_Data_Migration_Script_Stage
 {
 
-    public function _migration_step($num_items = 50)
-    {
+	public function _migration_step($num_items = 50)
+	{
 
-        $items_actually_migrated = 0;
-        $old_org_options = get_option('events_organization_settings');
-        foreach ($this->_org_options_we_know_how_to_migrate as $option_name) {
-            // only bother migrating if there's a setting to migrate. Otherwise we'll just use the default
-            if (isset($old_org_options[ $option_name ])) {
-                $this->_handle_org_option($option_name, $old_org_options[ $option_name ]);
-            }
-            if ($option_name=='surcharge') {
-                $this->_insert_new_global_surcharge_price($old_org_options);
-            }
-            $items_actually_migrated++;
-        }
+		$items_actually_migrated = 0;
+		$old_org_options = get_option('events_organization_settings');
+		foreach ($this->_org_options_we_know_how_to_migrate as $option_name) {
+			// only bother migrating if there's a setting to migrate. Otherwise we'll just use the default
+			if (isset($old_org_options[ $option_name ])) {
+				$this->_handle_org_option($option_name, $old_org_options[ $option_name ]);
+			}
+			if ($option_name=='surcharge') {
+				$this->_insert_new_global_surcharge_price($old_org_options);
+			}
+			$items_actually_migrated++;
+		}
 
-        $success = EE_Config::instance()->update_espresso_config(false, true);
-        if (! $success) {
-            $this->add_error(sprintf(__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'), EE_Error::get_notices(false)));
-            EE_Error::overwrite_errors();
-        }
-        EE_Network_Config::instance()->update_config(false, false);
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            // we may have added new pages and this might be necessary
-            flush_rewrite_rules();
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
-    public function _count_records_to_migrate()
-    {
-        $count_of_options_to_migrate = count($this->_org_options_we_know_how_to_migrate);
-        return $count_of_options_to_migrate;
-    }
-    public function __construct()
-    {
-        $this->_pretty_name = __("Organization Options/Config", "event_espresso");
-        $this->_org_options_we_know_how_to_migrate = apply_filters('FHEE__EE_DMS_4_1_0_org_options__org_options_we_know_how_to_migrate', $this->_org_options_we_know_how_to_migrate);
-        parent::__construct();
-    }
+		$success = EE_Config::instance()->update_espresso_config(false, true);
+		if (! $success) {
+			$this->add_error(sprintf(__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'), EE_Error::get_notices(false)));
+			EE_Error::overwrite_errors();
+		}
+		EE_Network_Config::instance()->update_config(false, false);
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			// we may have added new pages and this might be necessary
+			flush_rewrite_rules();
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
+	public function _count_records_to_migrate()
+	{
+		$count_of_options_to_migrate = count($this->_org_options_we_know_how_to_migrate);
+		return $count_of_options_to_migrate;
+	}
+	public function __construct()
+	{
+		$this->_pretty_name = __("Organization Options/Config", "event_espresso");
+		$this->_org_options_we_know_how_to_migrate = apply_filters('FHEE__EE_DMS_4_1_0_org_options__org_options_we_know_how_to_migrate', $this->_org_options_we_know_how_to_migrate);
+		parent::__construct();
+	}
 
-    private function _handle_org_option($option_name, $value)
-    {
-        $c = EE_Config::instance();
-        $cn = EE_Network_Config::instance();
-        switch ($option_name) {
-            case 'organization':
-                $c->organization->name = $value;
-                break;
-            case 'organization_street1':
-                $c->organization->address_1 = $value;
-                break;
-            case 'organization_street2':
-                $c->organization->address_2 = $value;
-                break;
-            case 'organization_city':
-                $c->organization->city = $value;
-                break;
-            case 'organization_state':
-                try {
-                    $state = $this->get_migration_script()->get_or_create_state($value);
-                    $state_id = $state['STA_ID'];
-                    $c->organization->STA_ID = $state_id;
-                } catch (EE_Error $e) {
-                }
-                break;
-            case 'organization_zip':
-                $c->organization->zip = $value;
-                break;
-            case 'contact_email':
-                $c->organization->email = $value;
-                break;
-            case 'default_payment_status':
-                $c->registration->default_STS_ID =  $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
-                break;
-            case 'organization_country':
-                $iso =$this->get_migration_script()->get_iso_from_3_1_country_id($value);
-                $c->organization->CNT_ISO = $iso;
-                $country_row = $this->get_migration_script()->get_or_create_country($iso);
-                if (! $country_row) {
-                    $this->add_error(sprintf(__("Could not set country's currency config because no country exists for ISO %s", "event_espresso"), $iso));
-                }
-                // can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them)
-                $c->currency->code = $country_row['CNT_cur_code'];          // currency code: USD, CAD, EUR
-                $c->currency->name = $country_row['CNT_cur_single'];    // Dollar
-                $c->currency->plural = $country_row['CNT_cur_plural'];  // Dollars
-                $c->currency->sign =  $country_row['CNT_cur_sign'];             // currency sign: $
-                $c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN);        // currency sign before or after: $TRUE  or  FALSE$
-                $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc'];    // decimal places: 2 = 0.00  3 = 0.000
-                $c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk'];    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $c->currency->thsnds = $country_row['CNT_cur_thsnds'];  // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+	private function _handle_org_option($option_name, $value)
+	{
+		$c = EE_Config::instance();
+		$cn = EE_Network_Config::instance();
+		switch ($option_name) {
+			case 'organization':
+				$c->organization->name = $value;
+				break;
+			case 'organization_street1':
+				$c->organization->address_1 = $value;
+				break;
+			case 'organization_street2':
+				$c->organization->address_2 = $value;
+				break;
+			case 'organization_city':
+				$c->organization->city = $value;
+				break;
+			case 'organization_state':
+				try {
+					$state = $this->get_migration_script()->get_or_create_state($value);
+					$state_id = $state['STA_ID'];
+					$c->organization->STA_ID = $state_id;
+				} catch (EE_Error $e) {
+				}
+				break;
+			case 'organization_zip':
+				$c->organization->zip = $value;
+				break;
+			case 'contact_email':
+				$c->organization->email = $value;
+				break;
+			case 'default_payment_status':
+				$c->registration->default_STS_ID =  $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
+				break;
+			case 'organization_country':
+				$iso =$this->get_migration_script()->get_iso_from_3_1_country_id($value);
+				$c->organization->CNT_ISO = $iso;
+				$country_row = $this->get_migration_script()->get_or_create_country($iso);
+				if (! $country_row) {
+					$this->add_error(sprintf(__("Could not set country's currency config because no country exists for ISO %s", "event_espresso"), $iso));
+				}
+				// can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them)
+				$c->currency->code = $country_row['CNT_cur_code'];          // currency code: USD, CAD, EUR
+				$c->currency->name = $country_row['CNT_cur_single'];    // Dollar
+				$c->currency->plural = $country_row['CNT_cur_plural'];  // Dollars
+				$c->currency->sign =  $country_row['CNT_cur_sign'];             // currency sign: $
+				$c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN);        // currency sign before or after: $TRUE  or  FALSE$
+				$c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc'];    // decimal places: 2 = 0.00  3 = 0.000
+				$c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk'];    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$c->currency->thsnds = $country_row['CNT_cur_thsnds'];  // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
   //            $c->currency = new EE_Currency_Config($c->organization->CNT_ISO);break;
   //        case 'currency_symbol': ignore the currency symbol. we'll just go by their country.
   //            $c->currency->sign = $value;break;
-            case 'show_pending_payment_options':
-                $c->registration->show_pending_payment_options = ($value == 'Y');
-                break;
-            case 'display_address_in_regform':
-                $c->template_settings->display_address_in_regform = ($value == 'Y');
-                break;
-            case 'default_logo_url':
-                $c->organization->logo_url = $value;
-                break;
-            case 'event_page_id':
-                // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
-                // to ESPRESSO_THANK_YOU
-                $reg_page_post = get_post($value);
-                $reg_page_post->post_content = str_replace("[ESPRESSO_EVENTS]", "[ESPRESSO_CHECKOUT]", $reg_page_post->post_content);
-                wp_update_post($reg_page_post);
-                $c->core->reg_page_id = $value;
-                break;
-            case 'return_url':
-                // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
-                // to ESPRESSO_THANK_YOU
-                $thank_you_page_post = get_post($value);
-                $thank_you_page_post->post_content = str_replace("[ESPRESSO_PAYMENTS]", "[ESPRESSO_THANK_YOU]", $thank_you_page_post->post_content);
-                wp_update_post($thank_you_page_post);
-                $c->core->thank_you_page_id = $value;
-                break;
-            case 'cancel_return':
-                $c->core->cancel_page_id = $value;
+			case 'show_pending_payment_options':
+				$c->registration->show_pending_payment_options = ($value == 'Y');
+				break;
+			case 'display_address_in_regform':
+				$c->template_settings->display_address_in_regform = ($value == 'Y');
+				break;
+			case 'default_logo_url':
+				$c->organization->logo_url = $value;
+				break;
+			case 'event_page_id':
+				// also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
+				// to ESPRESSO_THANK_YOU
+				$reg_page_post = get_post($value);
+				$reg_page_post->post_content = str_replace("[ESPRESSO_EVENTS]", "[ESPRESSO_CHECKOUT]", $reg_page_post->post_content);
+				wp_update_post($reg_page_post);
+				$c->core->reg_page_id = $value;
+				break;
+			case 'return_url':
+				// also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
+				// to ESPRESSO_THANK_YOU
+				$thank_you_page_post = get_post($value);
+				$thank_you_page_post->post_content = str_replace("[ESPRESSO_PAYMENTS]", "[ESPRESSO_THANK_YOU]", $thank_you_page_post->post_content);
+				wp_update_post($thank_you_page_post);
+				$c->core->thank_you_page_id = $value;
+				break;
+			case 'cancel_return':
+				$c->core->cancel_page_id = $value;
 
-                break;
-            case 'notify_url':
-                $c->core->txn_page_id = $value;
-                break;
-            case 'use_captcha':
-                $c->registration->use_captcha = ($value == 'Y');
-                break;
-            case 'recaptcha_publickey':
-                $c->registration->recaptcha_publickey = $value;
-                break;
-            case 'recaptcha_privatekey':
-                $c->registration->recaptcha_privatekey = $value;
-                break;
-            case 'recaptcha_theme':
-                $c->registration->recaptcha_theme = $value;
-                break;
-            case 'recaptcha_width':
-                $c->registration->recaptcha_width = $value;
-                break;
-            case 'recaptcha_language':
-                $c->registration->recaptcha_language = $value;
-                break;
-            case 'espresso_dashboard_widget':
-                $c->admin->use_dashboard_widget = ($value == 'Y');
-                break;
-            case 'use_personnel_manager':
-                $c->admin->use_personnel_manager = ($value == 'Y');
-                break;
-            case 'use_event_timezones':
-                $c->admin->use_event_timezones = ($value == 'Y');
-                break;
-            case 'affiliate_id':
-                $c->admin->affiliate_id = $value;
-                break;
-            case 'site_license_key':
-                $cn->core->site_license_key = $value;
-                break;
-            default:
-                do_action('AHEE__EE_DMS_4_1_0__handle_org_option', $option_name, $value);
-        }
-    }
+				break;
+			case 'notify_url':
+				$c->core->txn_page_id = $value;
+				break;
+			case 'use_captcha':
+				$c->registration->use_captcha = ($value == 'Y');
+				break;
+			case 'recaptcha_publickey':
+				$c->registration->recaptcha_publickey = $value;
+				break;
+			case 'recaptcha_privatekey':
+				$c->registration->recaptcha_privatekey = $value;
+				break;
+			case 'recaptcha_theme':
+				$c->registration->recaptcha_theme = $value;
+				break;
+			case 'recaptcha_width':
+				$c->registration->recaptcha_width = $value;
+				break;
+			case 'recaptcha_language':
+				$c->registration->recaptcha_language = $value;
+				break;
+			case 'espresso_dashboard_widget':
+				$c->admin->use_dashboard_widget = ($value == 'Y');
+				break;
+			case 'use_personnel_manager':
+				$c->admin->use_personnel_manager = ($value == 'Y');
+				break;
+			case 'use_event_timezones':
+				$c->admin->use_event_timezones = ($value == 'Y');
+				break;
+			case 'affiliate_id':
+				$c->admin->affiliate_id = $value;
+				break;
+			case 'site_license_key':
+				$cn->core->site_license_key = $value;
+				break;
+			default:
+				do_action('AHEE__EE_DMS_4_1_0__handle_org_option', $option_name, $value);
+		}
+	}
 
-    /**
-     * Creates a 4.1 member price discount
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
-    private function _insert_new_global_surcharge_price($org_options)
-    {
-        $amount = floatval($org_options['surcharge']);
-        // dont createa a price if the surcharge is 0
-        if ($amount <=.01) {
-            return 0;
-        }
-        if ($org_options['surcharge_type'] == 'flat_rate') {
-            $price_type = EE_DMS_4_1_0_prices::price_type_flat_surcharge;
-        } else {
-            $price_type = EE_DMS_4_1_0_prices::price_type_percent_surcharge;
-        }
-        global $wpdb;
-        $cols_n_values = array(
-            'PRT_ID'=>$price_type,
-            'PRC_amount'=>$amount,
-            'PRC_name'=>  $org_options['surcharge_text'],
-            'PRC_is_default'=>true,
-            'PRC_overrides'=>false,
-            'PRC_order'=>100,
-            'PRC_deleted'=>false,
-            'PRC_parent'=>null
+	/**
+	 * Creates a 4.1 member price discount
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
+	private function _insert_new_global_surcharge_price($org_options)
+	{
+		$amount = floatval($org_options['surcharge']);
+		// dont createa a price if the surcharge is 0
+		if ($amount <=.01) {
+			return 0;
+		}
+		if ($org_options['surcharge_type'] == 'flat_rate') {
+			$price_type = EE_DMS_4_1_0_prices::price_type_flat_surcharge;
+		} else {
+			$price_type = EE_DMS_4_1_0_prices::price_type_percent_surcharge;
+		}
+		global $wpdb;
+		$cols_n_values = array(
+			'PRT_ID'=>$price_type,
+			'PRC_amount'=>$amount,
+			'PRC_name'=>  $org_options['surcharge_text'],
+			'PRC_is_default'=>true,
+			'PRC_overrides'=>false,
+			'PRC_order'=>100,
+			'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
-        );
-        $price_table = $wpdb->prefix."esp_price";
-        $success = $wpdb->insert($price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion(
-                'org_options',
-                array(
-                        'surcharge'=>$org_options['surcharge'],
-                        'surcharge_type'=>$org_options['surcharge_type'],
-                        'surcharge_text'=>$org_options['surcharge_text']),
-                $price_table,
-                $cols_n_values,
-                $datatypes
-            ));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		);
+		$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
+		);
+		$price_table = $wpdb->prefix."esp_price";
+		$success = $wpdb->insert($price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion(
+				'org_options',
+				array(
+						'surcharge'=>$org_options['surcharge'],
+						'surcharge_type'=>$org_options['surcharge_type'],
+						'surcharge_text'=>$org_options['surcharge_text']),
+				$price_table,
+				$cols_n_values,
+				$datatypes
+			));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    protected $_org_options_we_know_how_to_migrate = array(
-      'organization',
-      'organization_street1',
-      'organization_street2',
-      'organization_city',
-      'organization_state',
-      'organization_zip',
-      'contact_email',
-      'default_mail',
-      'payment_subject',
-      'payment_message',
-      'message',
-      'default_payment_status',
-      'surcharge',// unused?
-      'country_id',// unused?
-      'organization_country',
+	protected $_org_options_we_know_how_to_migrate = array(
+	  'organization',
+	  'organization_street1',
+	  'organization_street2',
+	  'organization_city',
+	  'organization_state',
+	  'organization_zip',
+	  'contact_email',
+	  'default_mail',
+	  'payment_subject',
+	  'payment_message',
+	  'message',
+	  'default_payment_status',
+	  'surcharge',// unused?
+	  'country_id',// unused?
+	  'organization_country',
 //    'currency_symbol',
-      'expire_on_registration_end',
-      'email_before_payment',
-      'email_fancy_headers',
-      'enable_default_style',
-      'event_ssl_active',
-      'selected_style',
-      'show_pending_payment_options',
-      'show_reg_footer',
-      'skip_confirmation_page',
-      'allow_mer_discounts',// no equiv
-      'allow_mer_vouchers',// no equiv
-      'display_short_description_in_event_list',
-      'display_description_on_multi_reg_page',
-      'display_address_in_event_list',
-      'display_address_in_regform',
-      'use_custom_post_types',// no equiv
-      'display_ical_download',
-      'display_featured_image',
-      'themeroller',
-      'default_logo_url',
-      'event_page_id',
-      'return_url',
-      'cancel_return',
-      'notify_url',
-      'events_in_dashboard',
-      'use_captcha',
-      'recaptcha_publickey',
-      'recaptcha_privatekey',
-      'recaptcha_theme',
-      'recaptcha_width',
-      'recaptcha_language',
-      'espresso_dashboard_widget',
-      'time_reg_limit',
+	  'expire_on_registration_end',
+	  'email_before_payment',
+	  'email_fancy_headers',
+	  'enable_default_style',
+	  'event_ssl_active',
+	  'selected_style',
+	  'show_pending_payment_options',
+	  'show_reg_footer',
+	  'skip_confirmation_page',
+	  'allow_mer_discounts',// no equiv
+	  'allow_mer_vouchers',// no equiv
+	  'display_short_description_in_event_list',
+	  'display_description_on_multi_reg_page',
+	  'display_address_in_event_list',
+	  'display_address_in_regform',
+	  'use_custom_post_types',// no equiv
+	  'display_ical_download',
+	  'display_featured_image',
+	  'themeroller',
+	  'default_logo_url',
+	  'event_page_id',
+	  'return_url',
+	  'cancel_return',
+	  'notify_url',
+	  'events_in_dashboard',
+	  'use_captcha',
+	  'recaptcha_publickey',
+	  'recaptcha_privatekey',
+	  'recaptcha_theme',
+	  'recaptcha_width',
+	  'recaptcha_language',
+	  'espresso_dashboard_widget',
+	  'time_reg_limit',
 //    'use_attendee_pre_approval', removed in 4.1- instead this is factored into the default reg status
-      'use_personnel_manager',// no equiv
-      'use_event_timezones',
-      'full_logging',
-      'surcharge_type',// unused
-      'surcharge_text',// unused
-      'affiliate_id',
-      'site_license_key',
-    );
+	  'use_personnel_manager',// no equiv
+	  'use_event_timezones',
+	  'full_logging',
+	  'surcharge_type',// unused
+	  'surcharge_text',// unused
+	  'affiliate_id',
+	  'site_license_key',
+	);
 }

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

Doc Comments +3 added lines, -4 removed lines

@@ -349,8 +349,8 @@ 
     /**
      * Adds a join between a ticket and a price
      * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
+     * @param integer $new_ticket_id
+     * @param integer $new_price_id
      * @return int
      */
     private function _insert_ticket_price_relation($new_ticket_id, $new_price_id)
@@ -376,8 +376,7 @@ 
     /**
      * Adds a join between a ticket and a datetime
      * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
+     * @param integer $new_ticket_id
      * @return int
      */
     private function _insert_datetime_ticket_relation($new_datetime_id, $new_ticket_id)

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;