eventespresso / event-espresso-core

core/admin/EE_Admin_Page_Init.core.php

Indentation +446 added lines, -446 removed lines

@@ -17,451 +17,451 @@
 abstract class EE_Admin_Page_Init extends EE_Base
 {
 
-    // identity properties (set in _set_defaults and _set_init_properties)
-    public $label;
+	// identity properties (set in _set_defaults and _set_init_properties)
+	public $label;
 
-    /**
-     * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
-     * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
-     *
-     * @var string
-     */
-    public $capability;
-
-
-    /**
-     * This holds the menu map object for this admin page.
-     *
-     * @var EE_Admin_Page_Menu_Map
-     */
-    protected $_menu_map;
-
-    /**
-     * deprecated
-     */
-    public $menu_label;
-
-    public $menu_slug;
-
-
-    // set in _set_defaults
-    protected $_folder_name;
-
-    protected $_folder_path;
-
-    protected $_file_name;
-
-    public $hook_file;
-
-    protected $_wp_page_slug;
-
-    protected $_routing;
-
-
-    // will hold page object.
-    protected $_loaded_page_object;
-
-
-    // for caf
-    protected $_files_hooked;
-
-    protected $_hook_paths;
-
-    // load_page?
-    private $_load_page;
-
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-
-    /**
-     * @Constructor
-     * @return void
-     */
-    public function __construct(RequestInterface $request = null)
-    {
-        $this->loader = LoaderFactory::getLoader();
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : $this->loader->getShared(RequestInterface::class);
-        // set global defaults
-        $this->_set_defaults();
-        // set properties that are always available with objects.
-        $this->_set_init_properties();
-        // global styles/scripts across all wp admin pages
-        add_action('admin_enqueue_scripts', [$this, 'load_wp_global_scripts_styles'], 5);
-        // load initial stuff.
-        $this->_set_file_and_folder_name();
-        $this->_set_menu_map();
-        if (! $this->verifyMenuMapSet()) {
-            return;
-        }
-        // set default capability
-        $this->_set_capability();
-    }
-
-
-    /**
-     * _set_init_properties
-     * Child classes use to set the following properties:
-     * $label
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_init_properties();
-
-
-    /**
-     * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
-     * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or EE_Admin_Page_Sub_Menu.
-     *
-     * @since 4.4.0
-     * @ return void.
-     */
-    protected function _set_menu_map()
-    {
-        return [];
-    }
-
-
-    /**
-     * @return bool
-     * @since   4.10.14.p
-     */
-    private function verifyMenuMapSet()
-    {
-        if (empty($this->_menu_map) || is_array($this->_menu_map)) {
-            EE_Error::doing_it_wrong(
-                get_class($this) . '::$_menu_map',
-                sprintf(
-                    esc_html__(
-                        'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                ),
-                '4.4.0'
-            );
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * returns the menu map for this admin page
-     *
-     * @return EE_Admin_Page_Menu_Map
-     * @since 4.4.0
-     */
-    public function get_menu_map()
-    {
-        return $this->_menu_map;
-    }
-
-
-    /**
-     * This loads scripts and styles for the EE_Admin system
-     * that must be available on ALL WP admin pages (i.e. EE_menu items)
-     *
-     * @return void
-     */
-    public function load_wp_global_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
-            ['dashicons'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_menu');
-    }
-
-
-    /**
-     * this sets default properties (might be overridden in _set_init_properties);
-     *
-     * @return  void
-     */
-    private function _set_defaults()
-    {
-        $this->_file_name    = $this->_folder_name = $this->_wp_page_slug = $this->capability = null;
-        $this->_routing      = true;
-        $this->_load_page    = false;
-        $this->_files_hooked = $this->_hook_paths = [];
-        // menu_map
-        $this->_menu_map = $this->get_menu_map();
-    }
-
-
-    protected function _set_capability()
-    {
-        $capability       = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
-        $this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
-    }
-
-
-    /**
-     * initialize_admin_page
-     * This method is what executes the loading of the specific page class for the given dir_name as called by the
-     * EE_Admin_Init class.
-     *
-     * @return void
-     * @uses    _initialize_admin_page()
-     */
-    public function initialize_admin_page()
-    {
-        // let's check user access first
-        $this->_check_user_access();
-        if (! is_object($this->_loaded_page_object)) {
-            return;
-        }
-        $this->_loaded_page_object->route_admin_request();
-    }
-
-
-    /**
-     * @param string $wp_page_slug
-     * @throws EE_Error
-     */
-    public function set_page_dependencies($wp_page_slug)
-    {
-        if (! $this->_load_page) {
-            return;
-        }
-        if (! is_object($this->_loaded_page_object)) {
-            $msg[] = esc_html__(
-                'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
-                'event_espresso'
-            );
-            $msg[] = $msg[0] . "\r\n"
-                     . sprintf(
-                         esc_html__(
-                             'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
-                             'event_espresso'
-                         ),
-                         $this->_file_name,
-                         $this->_file_name,
-                         $this->_folder_path . $this->_file_name,
-                         $this->_menu_map->menu_slug
-                     );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-        $page_hook = 'load-' . $wp_page_slug;
-        // hook into page load hook so all page specific stuff gets loaded.
-        if (! empty($wp_page_slug)) {
-            add_action($page_hook, [$this->_loaded_page_object, 'load_page_dependencies']);
-        }
-    }
-
-
-    /**
-     * This executes the initial page loads for EE_Admin pages to take care of any ajax or other code needing to run
-     * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
-     *
-     * @return void
-     */
-    public function do_initial_loads()
-    {
-        // no loading or initializing if menu map is setup incorrectly.
-        if (empty($this->_menu_map) || is_array($this->_menu_map)) {
-            return;
-        }
-        $this->_initialize_admin_page();
-    }
-
-
-    /**
-     * all we're doing here is setting the $_file_name property for later use.
-     *
-     * @return void
-     */
-    private function _set_file_and_folder_name()
-    {
-        $bt = debug_backtrace();
-        // for more reliable determination of folder name
-        // we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
-        $class = get_class($this);
-        foreach ($bt as $index => $values) {
-            if (isset($values['class']) && $values['class'] == $class) {
-                $file_index         = $index - 1;
-                $this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
-                if (! empty($this->_folder_name)) {
-                    break;
-                }
-            }
-        }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
-        $this->_file_name   = preg_replace('/^ee/', 'EE', $this->_folder_name);
-        $this->_file_name   = ucwords(str_replace('_', ' ', $this->_file_name));
-        $this->_file_name   = str_replace(' ', '_', $this->_file_name);
-    }
-
-
-    /**
-     * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
-     * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
-     * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
-     * events_Messages_Hooks.class.php
-     *
-     * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
-     *                     files/classes
-     * @return array
-     */
-    public function register_hooks($extend = false)
-    {
-
-        // get a list of files in the directory that have the "Hook" in their name an
-        // if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
-        if ($extend) {
-            $hook_files_glob_path = apply_filters(
-                'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
-                EE_CORE_CAF_ADMIN_EXTEND
-                . $this->_folder_name
-                . '/*'
-                . $this->_file_name
-                . '_Hooks_Extend.class.php'
-            );
-            $this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
-        }
-        // loop through decaf folders
-        $hook_files_glob_path = apply_filters(
-            'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
-        );
-        $this->_hook_paths    = array_merge(
-            $this->_register_hook_files($hook_files_glob_path),
-            $this->_hook_paths
-        );  // making sure any extended hook paths are later in the array than the core hook paths!
-        return $this->_hook_paths;
-    }
-
-
-    protected function _register_hook_files($hook_files_glob_path, $extend = false)
-    {
-        $hook_paths = glob($hook_files_glob_path);
-        if (empty($hook_paths)) {
-            return [];
-        }
-        foreach ($hook_paths as $file) {
-            // lets get the linked admin.
-            $hook_file = $extend
-                ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
-                : str_replace($this->_folder_path, '', $file);
-            $replace         = $extend
-                ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
-                : '_' . $this->_file_name . '_Hooks.class.php';
-            $rel_admin       = str_replace($replace, '', $hook_file);
-            $rel_admin       = strtolower($rel_admin);
-            // make sure we haven't already got a hook setup for this page path
-            if (in_array($rel_admin, $this->_files_hooked)) {
-                continue;
-            }
-            $this->hook_file = $hook_file;
-            $rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
-            add_filter($rel_admin_hook, [$this, 'load_admin_hook']);
-            $this->_files_hooked[] = $rel_admin;
-        }
-        return $hook_paths;
-    }
-
-
-    public function load_admin_hook($registered_pages)
-    {
-        return array_merge((array) $this->hook_file, $registered_pages);
-    }
-
-
-    /**
-     * _initialize_admin_page
-     *
-     * @see  initialize_admin_page() for info
-     */
-    protected function _initialize_admin_page()
-    {
-        // JUST CHECK WE'RE ON RIGHT PAGE.
-        $page = $this->request->getRequestParam('page');
-        $page = $this->request->getRequestParam('current_page', $page);
-        $menu_slug = $this->_menu_map->menu_slug;
-
-
-        if ($this->_routing && ($page === '' || $page !== $menu_slug)) {
-            // not on the right page so let's get out.
-            return;
-        }
-        $this->_load_page = true;
-
-        // we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page  = $this->_file_name . '_Admin_Page';
-        $hook_suffix = "{$menu_slug}_{$admin_page}";
-        $admin_page  = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
-            $admin_page
-        );
-        if (empty($admin_page)) {
-            return;
-        }
-        // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path . $admin_page . '.core.php');
-        // so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be:
-        // FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
-        $path_to_file = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
-            $path_to_file
-        );
-        if (! is_readable($path_to_file)) {
-            return;
-        }
-        // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
-        do_action("AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_{$menu_slug}");
-        require_once($path_to_file);
-        $this->_loaded_page_object = $this->loader->getShared($admin_page, [$this->_routing]);
-
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
-        do_action("AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_{$menu_slug}");
-    }
-
-
-    public function get_admin_page_name()
-    {
-        return $this->_file_name . '_Admin_Page';
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function loaded_page_object()
-    {
-        return $this->_loaded_page_object;
-    }
-
-    /**
-     * _check_user_access
-     * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
-     * WordPress die message.
-     *
-     * @return void  wp_die if fail
-     */
-    private function _check_user_access()
-    {
-        if (
-            ! EE_Registry::instance()->CAP->current_user_can(
-                $this->_menu_map->capability,
-                $this->_menu_map->menu_slug
-            )
-        ) {
-            wp_die(esc_html__('You don\'t have access to this page.', 'event_espresso'), '', ['back_link' => true]);
-        }
-    }
+	/**
+	 * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
+	 * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
+	 *
+	 * @var string
+	 */
+	public $capability;
+
+
+	/**
+	 * This holds the menu map object for this admin page.
+	 *
+	 * @var EE_Admin_Page_Menu_Map
+	 */
+	protected $_menu_map;
+
+	/**
+	 * deprecated
+	 */
+	public $menu_label;
+
+	public $menu_slug;
+
+
+	// set in _set_defaults
+	protected $_folder_name;
+
+	protected $_folder_path;
+
+	protected $_file_name;
+
+	public $hook_file;
+
+	protected $_wp_page_slug;
+
+	protected $_routing;
+
+
+	// will hold page object.
+	protected $_loaded_page_object;
+
+
+	// for caf
+	protected $_files_hooked;
+
+	protected $_hook_paths;
+
+	// load_page?
+	private $_load_page;
+
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+
+	/**
+	 * @Constructor
+	 * @return void
+	 */
+	public function __construct(RequestInterface $request = null)
+	{
+		$this->loader = LoaderFactory::getLoader();
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: $this->loader->getShared(RequestInterface::class);
+		// set global defaults
+		$this->_set_defaults();
+		// set properties that are always available with objects.
+		$this->_set_init_properties();
+		// global styles/scripts across all wp admin pages
+		add_action('admin_enqueue_scripts', [$this, 'load_wp_global_scripts_styles'], 5);
+		// load initial stuff.
+		$this->_set_file_and_folder_name();
+		$this->_set_menu_map();
+		if (! $this->verifyMenuMapSet()) {
+			return;
+		}
+		// set default capability
+		$this->_set_capability();
+	}
+
+
+	/**
+	 * _set_init_properties
+	 * Child classes use to set the following properties:
+	 * $label
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_init_properties();
+
+
+	/**
+	 * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
+	 * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or EE_Admin_Page_Sub_Menu.
+	 *
+	 * @since 4.4.0
+	 * @ return void.
+	 */
+	protected function _set_menu_map()
+	{
+		return [];
+	}
+
+
+	/**
+	 * @return bool
+	 * @since   4.10.14.p
+	 */
+	private function verifyMenuMapSet()
+	{
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
+			EE_Error::doing_it_wrong(
+				get_class($this) . '::$_menu_map',
+				sprintf(
+					esc_html__(
+						'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
+						'event_espresso'
+					),
+					get_class($this)
+				),
+				'4.4.0'
+			);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * returns the menu map for this admin page
+	 *
+	 * @return EE_Admin_Page_Menu_Map
+	 * @since 4.4.0
+	 */
+	public function get_menu_map()
+	{
+		return $this->_menu_map;
+	}
+
+
+	/**
+	 * This loads scripts and styles for the EE_Admin system
+	 * that must be available on ALL WP admin pages (i.e. EE_menu items)
+	 *
+	 * @return void
+	 */
+	public function load_wp_global_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_menu',
+			EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+			['dashicons'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_menu');
+	}
+
+
+	/**
+	 * this sets default properties (might be overridden in _set_init_properties);
+	 *
+	 * @return  void
+	 */
+	private function _set_defaults()
+	{
+		$this->_file_name    = $this->_folder_name = $this->_wp_page_slug = $this->capability = null;
+		$this->_routing      = true;
+		$this->_load_page    = false;
+		$this->_files_hooked = $this->_hook_paths = [];
+		// menu_map
+		$this->_menu_map = $this->get_menu_map();
+	}
+
+
+	protected function _set_capability()
+	{
+		$capability       = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
+		$this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
+	}
+
+
+	/**
+	 * initialize_admin_page
+	 * This method is what executes the loading of the specific page class for the given dir_name as called by the
+	 * EE_Admin_Init class.
+	 *
+	 * @return void
+	 * @uses    _initialize_admin_page()
+	 */
+	public function initialize_admin_page()
+	{
+		// let's check user access first
+		$this->_check_user_access();
+		if (! is_object($this->_loaded_page_object)) {
+			return;
+		}
+		$this->_loaded_page_object->route_admin_request();
+	}
+
+
+	/**
+	 * @param string $wp_page_slug
+	 * @throws EE_Error
+	 */
+	public function set_page_dependencies($wp_page_slug)
+	{
+		if (! $this->_load_page) {
+			return;
+		}
+		if (! is_object($this->_loaded_page_object)) {
+			$msg[] = esc_html__(
+				'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
+				'event_espresso'
+			);
+			$msg[] = $msg[0] . "\r\n"
+					 . sprintf(
+						 esc_html__(
+							 'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
+							 'event_espresso'
+						 ),
+						 $this->_file_name,
+						 $this->_file_name,
+						 $this->_folder_path . $this->_file_name,
+						 $this->_menu_map->menu_slug
+					 );
+			throw new EE_Error(implode('||', $msg));
+		}
+		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
+		$page_hook = 'load-' . $wp_page_slug;
+		// hook into page load hook so all page specific stuff gets loaded.
+		if (! empty($wp_page_slug)) {
+			add_action($page_hook, [$this->_loaded_page_object, 'load_page_dependencies']);
+		}
+	}
+
+
+	/**
+	 * This executes the initial page loads for EE_Admin pages to take care of any ajax or other code needing to run
+	 * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
+	 *
+	 * @return void
+	 */
+	public function do_initial_loads()
+	{
+		// no loading or initializing if menu map is setup incorrectly.
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
+			return;
+		}
+		$this->_initialize_admin_page();
+	}
+
+
+	/**
+	 * all we're doing here is setting the $_file_name property for later use.
+	 *
+	 * @return void
+	 */
+	private function _set_file_and_folder_name()
+	{
+		$bt = debug_backtrace();
+		// for more reliable determination of folder name
+		// we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
+		$class = get_class($this);
+		foreach ($bt as $index => $values) {
+			if (isset($values['class']) && $values['class'] == $class) {
+				$file_index         = $index - 1;
+				$this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
+				if (! empty($this->_folder_name)) {
+					break;
+				}
+			}
+		}
+		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
+		$this->_file_name   = preg_replace('/^ee/', 'EE', $this->_folder_name);
+		$this->_file_name   = ucwords(str_replace('_', ' ', $this->_file_name));
+		$this->_file_name   = str_replace(' ', '_', $this->_file_name);
+	}
+
+
+	/**
+	 * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
+	 * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
+	 * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
+	 * events_Messages_Hooks.class.php
+	 *
+	 * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
+	 *                     files/classes
+	 * @return array
+	 */
+	public function register_hooks($extend = false)
+	{
+
+		// get a list of files in the directory that have the "Hook" in their name an
+		// if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
+		if ($extend) {
+			$hook_files_glob_path = apply_filters(
+				'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
+				EE_CORE_CAF_ADMIN_EXTEND
+				. $this->_folder_name
+				. '/*'
+				. $this->_file_name
+				. '_Hooks_Extend.class.php'
+			);
+			$this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
+		}
+		// loop through decaf folders
+		$hook_files_glob_path = apply_filters(
+			'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
+			$this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+		);
+		$this->_hook_paths    = array_merge(
+			$this->_register_hook_files($hook_files_glob_path),
+			$this->_hook_paths
+		);  // making sure any extended hook paths are later in the array than the core hook paths!
+		return $this->_hook_paths;
+	}
+
+
+	protected function _register_hook_files($hook_files_glob_path, $extend = false)
+	{
+		$hook_paths = glob($hook_files_glob_path);
+		if (empty($hook_paths)) {
+			return [];
+		}
+		foreach ($hook_paths as $file) {
+			// lets get the linked admin.
+			$hook_file = $extend
+				? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
+				: str_replace($this->_folder_path, '', $file);
+			$replace         = $extend
+				? '_' . $this->_file_name . '_Hooks_Extend.class.php'
+				: '_' . $this->_file_name . '_Hooks.class.php';
+			$rel_admin       = str_replace($replace, '', $hook_file);
+			$rel_admin       = strtolower($rel_admin);
+			// make sure we haven't already got a hook setup for this page path
+			if (in_array($rel_admin, $this->_files_hooked)) {
+				continue;
+			}
+			$this->hook_file = $hook_file;
+			$rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
+			add_filter($rel_admin_hook, [$this, 'load_admin_hook']);
+			$this->_files_hooked[] = $rel_admin;
+		}
+		return $hook_paths;
+	}
+
+
+	public function load_admin_hook($registered_pages)
+	{
+		return array_merge((array) $this->hook_file, $registered_pages);
+	}
+
+
+	/**
+	 * _initialize_admin_page
+	 *
+	 * @see  initialize_admin_page() for info
+	 */
+	protected function _initialize_admin_page()
+	{
+		// JUST CHECK WE'RE ON RIGHT PAGE.
+		$page = $this->request->getRequestParam('page');
+		$page = $this->request->getRequestParam('current_page', $page);
+		$menu_slug = $this->_menu_map->menu_slug;
+
+
+		if ($this->_routing && ($page === '' || $page !== $menu_slug)) {
+			// not on the right page so let's get out.
+			return;
+		}
+		$this->_load_page = true;
+
+		// we don't need to do a page_request check here because it's only called via WP menu system.
+		$admin_page  = $this->_file_name . '_Admin_Page';
+		$hook_suffix = "{$menu_slug}_{$admin_page}";
+		$admin_page  = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
+			$admin_page
+		);
+		if (empty($admin_page)) {
+			return;
+		}
+		// define requested admin page class name then load the file and instantiate
+		$path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path . $admin_page . '.core.php');
+		// so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be:
+		// FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+		$path_to_file = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
+			$path_to_file
+		);
+		if (! is_readable($path_to_file)) {
+			return;
+		}
+		// This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
+		do_action("AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_{$menu_slug}");
+		require_once($path_to_file);
+		$this->_loaded_page_object = $this->loader->getShared($admin_page, [$this->_routing]);
+
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
+		do_action("AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_{$menu_slug}");
+	}
+
+
+	public function get_admin_page_name()
+	{
+		return $this->_file_name . '_Admin_Page';
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function loaded_page_object()
+	{
+		return $this->_loaded_page_object;
+	}
+
+	/**
+	 * _check_user_access
+	 * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
+	 * WordPress die message.
+	 *
+	 * @return void  wp_die if fail
+	 */
+	private function _check_user_access()
+	{
+		if (
+			! EE_Registry::instance()->CAP->current_user_can(
+				$this->_menu_map->capability,
+				$this->_menu_map->menu_slug
+			)
+		) {
+			wp_die(esc_html__('You don\'t have access to this page.', 'event_espresso'), '', ['back_link' => true]);
+		}
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -100,7 +100,7 @@ 
         // load initial stuff.
         $this->_set_file_and_folder_name();
         $this->_set_menu_map();
-        if (! $this->verifyMenuMapSet()) {
+        if ( ! $this->verifyMenuMapSet()) {
             return;
         }
         // set default capability
@@ -140,7 +140,7 @@ 
     {
         if (empty($this->_menu_map) || is_array($this->_menu_map)) {
             EE_Error::doing_it_wrong(
-                get_class($this) . '::$_menu_map',
+                get_class($this).'::$_menu_map',
                 sprintf(
                     esc_html__(
                         'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
@@ -178,7 +178,7 @@ 
     {
         wp_register_style(
             'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+            EE_ADMIN_URL.'assets/admin-menu-styles.css',
             ['dashicons'],
             EVENT_ESPRESSO_VERSION
         );
@@ -205,7 +205,7 @@ 
     protected function _set_capability()
     {
         $capability       = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
-        $this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
+        $this->capability = apply_filters('FHEE_'.$this->_menu_map->menu_slug.'_capability', $capability);
     }
 
 
@@ -221,7 +221,7 @@ 
     {
         // let's check user access first
         $this->_check_user_access();
-        if (! is_object($this->_loaded_page_object)) {
+        if ( ! is_object($this->_loaded_page_object)) {
             return;
         }
         $this->_loaded_page_object->route_admin_request();
@@ -234,15 +234,15 @@ 
      */
     public function set_page_dependencies($wp_page_slug)
     {
-        if (! $this->_load_page) {
+        if ( ! $this->_load_page) {
             return;
         }
-        if (! is_object($this->_loaded_page_object)) {
+        if ( ! is_object($this->_loaded_page_object)) {
             $msg[] = esc_html__(
                 'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
                 'event_espresso'
             );
-            $msg[] = $msg[0] . "\r\n"
+            $msg[] = $msg[0]."\r\n"
                      . sprintf(
                          esc_html__(
                              'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
@@ -250,15 +250,15 @@ 
                          ),
                          $this->_file_name,
                          $this->_file_name,
-                         $this->_folder_path . $this->_file_name,
+                         $this->_folder_path.$this->_file_name,
                          $this->_menu_map->menu_slug
                      );
             throw new EE_Error(implode('||', $msg));
         }
         $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-        $page_hook = 'load-' . $wp_page_slug;
+        $page_hook = 'load-'.$wp_page_slug;
         // hook into page load hook so all page specific stuff gets loaded.
-        if (! empty($wp_page_slug)) {
+        if ( ! empty($wp_page_slug)) {
             add_action($page_hook, [$this->_loaded_page_object, 'load_page_dependencies']);
         }
     }
@@ -294,13 +294,13 @@ 
         foreach ($bt as $index => $values) {
             if (isset($values['class']) && $values['class'] == $class) {
                 $file_index         = $index - 1;
-                $this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
-                if (! empty($this->_folder_name)) {
+                $this->_folder_name = basename(dirname($bt[$file_index]['file']));
+                if ( ! empty($this->_folder_name)) {
                     break;
                 }
             }
         }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
+        $this->_folder_path = EE_ADMIN_PAGES.$this->_folder_name.'/';
         $this->_file_name   = preg_replace('/^ee/', 'EE', $this->_folder_name);
         $this->_file_name   = ucwords(str_replace('_', ' ', $this->_file_name));
         $this->_file_name   = str_replace(' ', '_', $this->_file_name);
@@ -331,17 +331,17 @@ 
                 . $this->_file_name
                 . '_Hooks_Extend.class.php'
             );
-            $this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
+            $this->_hook_paths = $this->_register_hook_files($hook_files_glob_path, $extend);
         }
         // loop through decaf folders
         $hook_files_glob_path = apply_filters(
             'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+            $this->_folder_path.'*'.$this->_file_name.'_Hooks.class.php'
         );
-        $this->_hook_paths    = array_merge(
+        $this->_hook_paths = array_merge(
             $this->_register_hook_files($hook_files_glob_path),
             $this->_hook_paths
-        );  // making sure any extended hook paths are later in the array than the core hook paths!
+        ); // making sure any extended hook paths are later in the array than the core hook paths!
         return $this->_hook_paths;
     }
 
@@ -355,11 +355,11 @@ 
         foreach ($hook_paths as $file) {
             // lets get the linked admin.
             $hook_file = $extend
-                ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
+                ? str_replace(EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.'/', '', $file)
                 : str_replace($this->_folder_path, '', $file);
             $replace         = $extend
-                ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
-                : '_' . $this->_file_name . '_Hooks.class.php';
+                ? '_'.$this->_file_name.'_Hooks_Extend.class.php'
+                : '_'.$this->_file_name.'_Hooks.class.php';
             $rel_admin       = str_replace($replace, '', $hook_file);
             $rel_admin       = strtolower($rel_admin);
             // make sure we haven't already got a hook setup for this page path
@@ -367,7 +367,7 @@ 
                 continue;
             }
             $this->hook_file = $hook_file;
-            $rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
+            $rel_admin_hook = 'FHEE_do_other_page_hooks_'.$rel_admin;
             add_filter($rel_admin_hook, [$this, 'load_admin_hook']);
             $this->_files_hooked[] = $rel_admin;
         }
@@ -401,7 +401,7 @@ 
         $this->_load_page = true;
 
         // we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page  = $this->_file_name . '_Admin_Page';
+        $admin_page  = $this->_file_name.'_Admin_Page';
         $hook_suffix = "{$menu_slug}_{$admin_page}";
         $admin_page  = apply_filters(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
@@ -411,14 +411,14 @@ 
             return;
         }
         // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path . $admin_page . '.core.php');
+        $path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path.$admin_page.'.core.php');
         // so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be:
         // FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
         $path_to_file = apply_filters(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
             $path_to_file
         );
-        if (! is_readable($path_to_file)) {
+        if ( ! is_readable($path_to_file)) {
             return;
         }
         // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
@@ -434,7 +434,7 @@ 
 
     public function get_admin_page_name()
     {
-        return $this->_file_name . '_Admin_Page';
+        return $this->_file_name.'_Admin_Page';
     }
 
 

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.10.15.rc.011');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.10.15.rc.011');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/libraries/form_sections/form_handlers/SequentialStepFormManager.php

Indentation +579 added lines, -579 removed lines

@@ -30,583 +30,583 @@
 abstract class SequentialStepFormManager
 {
 
-    /**
-     * a simplified URL with no form related parameters
-     * that will be used to build the form's redirect URLs
-     *
-     * @var string $base_url
-     */
-    private $base_url = '';
-
-    /**
-     * the key used for the URL param that denotes the current form step
-     * defaults to 'ee-form-step'
-     *
-     * @var string $form_step_url_key
-     */
-    private $form_step_url_key = '';
-
-    /**
-     * @var string $default_form_step
-     */
-    private $default_form_step = '';
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * @var string $progress_step_style
-     */
-    private $progress_step_style = '';
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var Collection $form_steps
-     */
-    protected $form_steps;
-
-    /**
-     * @var ProgressStepManager $progress_step_manager
-     */
-    protected $progress_step_manager;
-
-
-    /**
-     * @return Collection|null
-     */
-    abstract protected function getFormStepsCollection();
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * StepsManager constructor
-     *
-     * @param string                           $base_url
-     * @param string                           $default_form_step
-     * @param string                           $form_action
-     * @param string                           $form_config
-     * @param EE_Request|RequestInterface|null $request
-     * @param string                           $progress_step_style
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $base_url,
-        $default_form_step,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        $progress_step_style = 'number_bubbles',
-        $request = null
-    ) {
-        $this->setBaseUrl($base_url);
-        $this->setDefaultFormStep($default_form_step);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setProgressStepStyle($progress_step_style);
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function baseUrl()
-    {
-        if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
-            add_query_arg(
-                array($this->form_step_url_key => $this->getCurrentStep()->slug()),
-                $this->base_url
-            );
-        }
-        return $this->base_url;
-    }
-
-
-    /**
-     * @param string $base_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function setBaseUrl($base_url)
-    {
-        if (! is_string($base_url)) {
-            throw new InvalidDataTypeException('$base_url', $base_url, 'string');
-        }
-        if (empty($base_url)) {
-            throw new InvalidArgumentException(
-                esc_html__('The base URL can not be an empty string.', 'event_espresso')
-            );
-        }
-        $this->base_url = $base_url;
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidDataTypeException
-     */
-    public function formStepUrlKey()
-    {
-        if (empty($this->form_step_url_key)) {
-            $this->setFormStepUrlKey();
-        }
-        return $this->form_step_url_key;
-    }
-
-
-    /**
-     * @param string $form_step_url_key
-     * @throws InvalidDataTypeException
-     */
-    public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
-    {
-        if (! is_string($form_step_url_key)) {
-            throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
-        }
-        $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function defaultFormStep()
-    {
-        return $this->default_form_step;
-    }
-
-
-    /**
-     * @param $default_form_step
-     * @throws InvalidDataTypeException
-     */
-    protected function setDefaultFormStep($default_form_step)
-    {
-        if (! is_string($default_form_step)) {
-            throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
-        }
-        $this->default_form_step = $default_form_step;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    protected function setCurrentStepFromRequest()
-    {
-        $current_step_slug = $this->request()->getRequestParam($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
-            throw new InvalidIdentifierException(
-                $current_step_slug,
-                $this->defaultFormStep(),
-                sprintf(
-                    esc_html__('The "%1$s" form step could not be set.', 'event_espresso'),
-                    $current_step_slug
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return SequentialStepFormInterface|object
-     * @throws InvalidFormHandlerException
-     */
-    public function getCurrentStep()
-    {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
-            throw new InvalidFormHandlerException($this->form_steps->current());
-        }
-        return $this->form_steps->current();
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function formAction()
-    {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
-            $this->form_action = $this->baseUrl();
-        }
-        return $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_action_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function addFormActionArgs($form_action_args = array())
-    {
-        if (! is_array($form_action_args)) {
-            throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
-        }
-        $form_action_args = ! empty($form_action_args)
-            ? $form_action_args
-            : array($this->formStepUrlKey() => $this->form_steps->current()->slug());
-        $this->getCurrentStep()->setFormAction(
-            add_query_arg($form_action_args, $this->formAction())
-        );
-        $this->form_action = $this->getCurrentStep()->formAction();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     */
-    public function setFormConfig($form_config)
-    {
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function progressStepStyle()
-    {
-        return $this->progress_step_style;
-    }
-
-
-    /**
-     * @param string $progress_step_style
-     */
-    public function setProgressStepStyle($progress_step_style)
-    {
-        $this->progress_step_style = $progress_step_style;
-    }
-
-
-    /**
-     * @return RequestInterface
-     */
-    public function request()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @return Collection|null
-     * @throws InvalidInterfaceException
-     */
-    protected function getProgressStepsCollection()
-    {
-        static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
-            $collection = new ProgressStepCollection();
-        }
-        return $collection;
-    }
-
-
-    /**
-     * @param Collection $progress_steps_collection
-     * @return ProgressStepManager
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     */
-    protected function generateProgressSteps(Collection $progress_steps_collection)
-    {
-        $current_step = $this->getCurrentStep();
-        /** @var SequentialStepForm $form_step */
-        foreach ($this->form_steps as $form_step) {
-            // is this step active ?
-            if (! $form_step->initialize()) {
-                continue;
-            }
-            $progress_steps_collection->add(
-                new ProgressStep(
-                    $form_step->order(),
-                    $form_step->slug(),
-                    $form_step->slug(),
-                    $form_step->formName()
-                ),
-                $form_step->slug()
-            );
-        }
-        // set collection pointer back to current step
-        $this->form_steps->setCurrentUsingObject($current_step);
-        return new ProgressStepManager(
-            $this->progressStepStyle(),
-            $this->defaultFormStep(),
-            $this->formStepUrlKey(),
-            $progress_steps_collection
-        );
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildForm()
-    {
-        $this->buildCurrentStepFormForDisplay();
-    }
-
-
-    /**
-     * @param array $form_data
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function processForm($form_data = array())
-    {
-        $this->buildCurrentStepFormForProcessing();
-        $this->processCurrentStepForm($form_data);
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForDisplay()
-    {
-        $form_step = $this->buildCurrentStepForm();
-        // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-            wp_safe_redirect($form_step->formAction());
-        }
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForProcessing()
-    {
-        $this->buildCurrentStepForm(false);
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return SequentialStepFormInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    private function buildCurrentStepForm($for_display = true)
-    {
-        $this->form_steps = $this->getFormStepsCollection();
-        $this->setCurrentStepFromRequest();
-        $form_step = $this->getCurrentStep();
-        if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
-            $form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
-        }
-        if ($for_display && $form_step->displayable()) {
-            $this->progress_step_manager = $this->generateProgressSteps(
-                $this->getProgressStepsCollection()
-            );
-            $this->progress_step_manager->setCurrentStep(
-                $form_step->slug()
-            );
-            // mark all previous progress steps as completed
-            $this->progress_step_manager->setPreviousStepsCompleted();
-            $this->progress_step_manager->enqueueStylesAndScripts();
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-        } else {
-            $form_step->setRedirectUrl($this->baseUrl());
-            $form_step->addRedirectArgs(
-                array($this->formStepUrlKey() => $this->form_steps->current()->slug())
-            );
-        }
-        $form_step->generate();
-        if ($for_display) {
-            $form_step->enqueueStylesAndScripts();
-        }
-        return $form_step;
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayProgressSteps($return_as_string = true)
-    {
-        $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
-            return '';
-        }
-        $progress_steps = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
-            ''
-        );
-        $progress_steps .= $this->progress_step_manager->displaySteps();
-        $progress_steps .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
-            ''
-        );
-        if ($return_as_string) {
-            return $progress_steps;
-        }
-        echo $progress_steps; // already escaped
-        return '';
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayCurrentStepForm($return_as_string = true)
-    {
-        if ($return_as_string) {
-            return $this->getCurrentStep()->display();
-        }
-        echo $this->getCurrentStep()->display(); // already escaped
-        return '';
-    }
-
-
-    /**
-     * @param array $form_data
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function processCurrentStepForm($form_data = array())
-    {
-        // grab instance of current step because after calling next() below,
-        // any calls to getCurrentStep() will return the "next" step because we advanced
-        $current_step = $this->getCurrentStep();
-        try {
-            // form processing should either throw exceptions or return true
-            $current_step->process($form_data);
-        } catch (Exception $e) {
-            // something went wrong, convert the Exception to an EE_Error
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            // prevent redirect to next step or other if exception was thrown
-            if (
-                $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
-                || $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
-            ) {
-                $current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
-            }
-        }
-        // save notices to a transient so that when we redirect back
-        // to the display portion for this step
-        // those notices can be displayed
-        EE_Error::get_notices(false, true);
-        $this->redirectForm($current_step);
-    }
-
-
-    /**
-     * handles where to go to next
-     *
-     * @param SequentialStepFormInterface $current_step
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function redirectForm(SequentialStepFormInterface $current_step)
-    {
-        $redirect_step = $current_step;
-        switch ($current_step->redirectTo()) {
-            case SequentialStepForm::REDIRECT_TO_OTHER:
-                // going somewhere else, so just check out now
-                wp_safe_redirect($redirect_step->redirectUrl());
-                exit();
-            case SequentialStepForm::REDIRECT_TO_PREV_STEP:
-                $redirect_step = $this->form_steps->previous();
-                break;
-            case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
-                $this->form_steps->next();
-                if ($this->form_steps->valid()) {
-                    $redirect_step = $this->form_steps->current();
-                }
-                break;
-            case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
-            default:
-                // $redirect_step is already set
-        }
-        $current_step->setRedirectUrl($this->baseUrl());
-        $current_step->addRedirectArgs(
-            // use the slug for whatever step we are redirecting too
-            array($this->formStepUrlKey() => $redirect_step->slug())
-        );
-        wp_safe_redirect($current_step->redirectUrl());
-        exit();
-    }
+	/**
+	 * a simplified URL with no form related parameters
+	 * that will be used to build the form's redirect URLs
+	 *
+	 * @var string $base_url
+	 */
+	private $base_url = '';
+
+	/**
+	 * the key used for the URL param that denotes the current form step
+	 * defaults to 'ee-form-step'
+	 *
+	 * @var string $form_step_url_key
+	 */
+	private $form_step_url_key = '';
+
+	/**
+	 * @var string $default_form_step
+	 */
+	private $default_form_step = '';
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * @var string $progress_step_style
+	 */
+	private $progress_step_style = '';
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var Collection $form_steps
+	 */
+	protected $form_steps;
+
+	/**
+	 * @var ProgressStepManager $progress_step_manager
+	 */
+	protected $progress_step_manager;
+
+
+	/**
+	 * @return Collection|null
+	 */
+	abstract protected function getFormStepsCollection();
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * StepsManager constructor
+	 *
+	 * @param string                           $base_url
+	 * @param string                           $default_form_step
+	 * @param string                           $form_action
+	 * @param string                           $form_config
+	 * @param EE_Request|RequestInterface|null $request
+	 * @param string                           $progress_step_style
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$base_url,
+		$default_form_step,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		$progress_step_style = 'number_bubbles',
+		$request = null
+	) {
+		$this->setBaseUrl($base_url);
+		$this->setDefaultFormStep($default_form_step);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setProgressStepStyle($progress_step_style);
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function baseUrl()
+	{
+		if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
+			add_query_arg(
+				array($this->form_step_url_key => $this->getCurrentStep()->slug()),
+				$this->base_url
+			);
+		}
+		return $this->base_url;
+	}
+
+
+	/**
+	 * @param string $base_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function setBaseUrl($base_url)
+	{
+		if (! is_string($base_url)) {
+			throw new InvalidDataTypeException('$base_url', $base_url, 'string');
+		}
+		if (empty($base_url)) {
+			throw new InvalidArgumentException(
+				esc_html__('The base URL can not be an empty string.', 'event_espresso')
+			);
+		}
+		$this->base_url = $base_url;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidDataTypeException
+	 */
+	public function formStepUrlKey()
+	{
+		if (empty($this->form_step_url_key)) {
+			$this->setFormStepUrlKey();
+		}
+		return $this->form_step_url_key;
+	}
+
+
+	/**
+	 * @param string $form_step_url_key
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
+	{
+		if (! is_string($form_step_url_key)) {
+			throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
+		}
+		$this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function defaultFormStep()
+	{
+		return $this->default_form_step;
+	}
+
+
+	/**
+	 * @param $default_form_step
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setDefaultFormStep($default_form_step)
+	{
+		if (! is_string($default_form_step)) {
+			throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
+		}
+		$this->default_form_step = $default_form_step;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setCurrentStepFromRequest()
+	{
+		$current_step_slug = $this->request()->getRequestParam($this->formStepUrlKey(), $this->defaultFormStep());
+		if (! $this->form_steps->setCurrent($current_step_slug)) {
+			throw new InvalidIdentifierException(
+				$current_step_slug,
+				$this->defaultFormStep(),
+				sprintf(
+					esc_html__('The "%1$s" form step could not be set.', 'event_espresso'),
+					$current_step_slug
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return SequentialStepFormInterface|object
+	 * @throws InvalidFormHandlerException
+	 */
+	public function getCurrentStep()
+	{
+		if (! $this->form_steps->current() instanceof SequentialStepForm) {
+			throw new InvalidFormHandlerException($this->form_steps->current());
+		}
+		return $this->form_steps->current();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function formAction()
+	{
+		if (! is_string($this->form_action) || empty($this->form_action)) {
+			$this->form_action = $this->baseUrl();
+		}
+		return $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_action_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function addFormActionArgs($form_action_args = array())
+	{
+		if (! is_array($form_action_args)) {
+			throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
+		}
+		$form_action_args = ! empty($form_action_args)
+			? $form_action_args
+			: array($this->formStepUrlKey() => $this->form_steps->current()->slug());
+		$this->getCurrentStep()->setFormAction(
+			add_query_arg($form_action_args, $this->formAction())
+		);
+		$this->form_action = $this->getCurrentStep()->formAction();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 */
+	public function setFormConfig($form_config)
+	{
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function progressStepStyle()
+	{
+		return $this->progress_step_style;
+	}
+
+
+	/**
+	 * @param string $progress_step_style
+	 */
+	public function setProgressStepStyle($progress_step_style)
+	{
+		$this->progress_step_style = $progress_step_style;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 */
+	public function request()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @return Collection|null
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getProgressStepsCollection()
+	{
+		static $collection = null;
+		if (! $collection instanceof ProgressStepCollection) {
+			$collection = new ProgressStepCollection();
+		}
+		return $collection;
+	}
+
+
+	/**
+	 * @param Collection $progress_steps_collection
+	 * @return ProgressStepManager
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 */
+	protected function generateProgressSteps(Collection $progress_steps_collection)
+	{
+		$current_step = $this->getCurrentStep();
+		/** @var SequentialStepForm $form_step */
+		foreach ($this->form_steps as $form_step) {
+			// is this step active ?
+			if (! $form_step->initialize()) {
+				continue;
+			}
+			$progress_steps_collection->add(
+				new ProgressStep(
+					$form_step->order(),
+					$form_step->slug(),
+					$form_step->slug(),
+					$form_step->formName()
+				),
+				$form_step->slug()
+			);
+		}
+		// set collection pointer back to current step
+		$this->form_steps->setCurrentUsingObject($current_step);
+		return new ProgressStepManager(
+			$this->progressStepStyle(),
+			$this->defaultFormStep(),
+			$this->formStepUrlKey(),
+			$progress_steps_collection
+		);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildForm()
+	{
+		$this->buildCurrentStepFormForDisplay();
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processForm($form_data = array())
+	{
+		$this->buildCurrentStepFormForProcessing();
+		$this->processCurrentStepForm($form_data);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForDisplay()
+	{
+		$form_step = $this->buildCurrentStepForm();
+		// no displayable content ? then skip straight to processing
+		if (! $form_step->displayable()) {
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+			wp_safe_redirect($form_step->formAction());
+		}
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForProcessing()
+	{
+		$this->buildCurrentStepForm(false);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return SequentialStepFormInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	private function buildCurrentStepForm($for_display = true)
+	{
+		$this->form_steps = $this->getFormStepsCollection();
+		$this->setCurrentStepFromRequest();
+		$form_step = $this->getCurrentStep();
+		if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
+			$form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
+		}
+		if ($for_display && $form_step->displayable()) {
+			$this->progress_step_manager = $this->generateProgressSteps(
+				$this->getProgressStepsCollection()
+			);
+			$this->progress_step_manager->setCurrentStep(
+				$form_step->slug()
+			);
+			// mark all previous progress steps as completed
+			$this->progress_step_manager->setPreviousStepsCompleted();
+			$this->progress_step_manager->enqueueStylesAndScripts();
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+		} else {
+			$form_step->setRedirectUrl($this->baseUrl());
+			$form_step->addRedirectArgs(
+				array($this->formStepUrlKey() => $this->form_steps->current()->slug())
+			);
+		}
+		$form_step->generate();
+		if ($for_display) {
+			$form_step->enqueueStylesAndScripts();
+		}
+		return $form_step;
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayProgressSteps($return_as_string = true)
+	{
+		$form_step = $this->getCurrentStep();
+		if (! $form_step->displayable()) {
+			return '';
+		}
+		$progress_steps = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
+			''
+		);
+		$progress_steps .= $this->progress_step_manager->displaySteps();
+		$progress_steps .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
+			''
+		);
+		if ($return_as_string) {
+			return $progress_steps;
+		}
+		echo $progress_steps; // already escaped
+		return '';
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayCurrentStepForm($return_as_string = true)
+	{
+		if ($return_as_string) {
+			return $this->getCurrentStep()->display();
+		}
+		echo $this->getCurrentStep()->display(); // already escaped
+		return '';
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function processCurrentStepForm($form_data = array())
+	{
+		// grab instance of current step because after calling next() below,
+		// any calls to getCurrentStep() will return the "next" step because we advanced
+		$current_step = $this->getCurrentStep();
+		try {
+			// form processing should either throw exceptions or return true
+			$current_step->process($form_data);
+		} catch (Exception $e) {
+			// something went wrong, convert the Exception to an EE_Error
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			// prevent redirect to next step or other if exception was thrown
+			if (
+				$current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
+				|| $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
+			) {
+				$current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
+			}
+		}
+		// save notices to a transient so that when we redirect back
+		// to the display portion for this step
+		// those notices can be displayed
+		EE_Error::get_notices(false, true);
+		$this->redirectForm($current_step);
+	}
+
+
+	/**
+	 * handles where to go to next
+	 *
+	 * @param SequentialStepFormInterface $current_step
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function redirectForm(SequentialStepFormInterface $current_step)
+	{
+		$redirect_step = $current_step;
+		switch ($current_step->redirectTo()) {
+			case SequentialStepForm::REDIRECT_TO_OTHER:
+				// going somewhere else, so just check out now
+				wp_safe_redirect($redirect_step->redirectUrl());
+				exit();
+			case SequentialStepForm::REDIRECT_TO_PREV_STEP:
+				$redirect_step = $this->form_steps->previous();
+				break;
+			case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
+				$this->form_steps->next();
+				if ($this->form_steps->valid()) {
+					$redirect_step = $this->form_steps->current();
+				}
+				break;
+			case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
+			default:
+				// $redirect_step is already set
+		}
+		$current_step->setRedirectUrl($this->baseUrl());
+		$current_step->addRedirectArgs(
+			// use the slug for whatever step we are redirecting too
+			array($this->formStepUrlKey() => $redirect_step->slug())
+		);
+		wp_safe_redirect($current_step->redirectUrl());
+		exit();
+	}
 }