eventespresso / event-espresso-core

core/helpers/EEH_URL.helper.php

Indentation +252 added lines, -252 removed lines

@@ -14,280 +14,280 @@
 class EEH_URL
 {
 
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *
-     * @access public
-     * @param array  $args
-     * @param string $url
-     * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
-     * @return string
-     */
-    public static function add_query_args_and_nonce($args = [], $url = '', $exclude_nonce = false)
-    {
-        // check that an action exists and add nonce
-        if (! $exclude_nonce) {
-            if (isset($args['action']) && ! empty($args['action'])) {
-                $args = array_merge(
-                    $args,
-                    [
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
-                    ]
-                );
-            } else {
-                $args = array_merge(
-                    $args,
-                    [
-                        'action'        => 'default',
-                        'default_nonce' => wp_create_nonce('default_nonce'),
-                    ]
-                );
-            }
-        }
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *
+	 * @access public
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce($args = [], $url = '', $exclude_nonce = false)
+	{
+		// check that an action exists and add nonce
+		if (! $exclude_nonce) {
+			if (isset($args['action']) && ! empty($args['action'])) {
+				$args = array_merge(
+					$args,
+					[
+						$args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
+					]
+				);
+			} else {
+				$args = array_merge(
+					$args,
+					[
+						'action'        => 'default',
+						'default_nonce' => wp_create_nonce('default_nonce'),
+					]
+				);
+			}
+		}
 
-        $action  = EEH_URL::getRequest()->getRequestParam('action');
-        // finally, let's always add a return address (if present) :)
-        if ($action !== '') {
-            $args['return'] = $action;
-        }
+		$action  = EEH_URL::getRequest()->getRequestParam('action');
+		// finally, let's always add a return address (if present) :)
+		if ($action !== '') {
+			$args['return'] = $action;
+		}
 
-        return add_query_arg($args, $url);
-    }
+		return add_query_arg($args, $url);
+	}
 
 
-    /**
-     * Returns whether not the remote file exists.
-     * Checking via GET because HEAD requests are blocked on some server configurations.
-     *
-     * @param string $url
-     * @param array  $args the arguments that should be passed through to the wp_remote_request call.
-     * @return boolean
-     */
-    public static function remote_file_exists($url, $args = [])
-    {
-        $results = wp_remote_request(
-            $url,
-            array_merge(
-                [
-                    'method'      => 'GET',
-                    'redirection' => 1,
-                ],
-                $args
-            )
-        );
-        return ! $results instanceof WP_Error
-               && isset($results['response']['code'])
-               && $results['response']['code'] == '200';
-    }
+	/**
+	 * Returns whether not the remote file exists.
+	 * Checking via GET because HEAD requests are blocked on some server configurations.
+	 *
+	 * @param string $url
+	 * @param array  $args the arguments that should be passed through to the wp_remote_request call.
+	 * @return boolean
+	 */
+	public static function remote_file_exists($url, $args = [])
+	{
+		$results = wp_remote_request(
+			$url,
+			array_merge(
+				[
+					'method'      => 'GET',
+					'redirection' => 1,
+				],
+				$args
+			)
+		);
+		return ! $results instanceof WP_Error
+			   && isset($results['response']['code'])
+			   && $results['response']['code'] == '200';
+	}
 
 
-    /**
-     * refactor_url
-     * primarily used for removing the query string from a URL
-     *
-     * @param string $url
-     * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
-     * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
-     * @return string
-     */
-    public static function refactor_url($url = '', $remove_query = true, $base_url_only = false)
-    {
-        // break apart incoming URL
-        $url_bits = parse_url($url);
-        // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'https://';
-        // domain
-        $host = isset($url_bits['host']) ? $url_bits['host'] : '';
-        // if only the base URL is requested, then return that now
-        if ($base_url_only) {
-            return $scheme . $host;
-        }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
-        $user = isset($url_bits['user']) ? $url_bits['user'] : '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
-        $path = isset($url_bits['path']) ? $url_bits['path'] : '';
-        // if the query string is not required, then return what we have so far
-        if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
-        }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
-    }
+	/**
+	 * refactor_url
+	 * primarily used for removing the query string from a URL
+	 *
+	 * @param string $url
+	 * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
+	 * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
+	 * @return string
+	 */
+	public static function refactor_url($url = '', $remove_query = true, $base_url_only = false)
+	{
+		// break apart incoming URL
+		$url_bits = parse_url($url);
+		// HTTP or HTTPS ?
+		$scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'https://';
+		// domain
+		$host = isset($url_bits['host']) ? $url_bits['host'] : '';
+		// if only the base URL is requested, then return that now
+		if ($base_url_only) {
+			return $scheme . $host;
+		}
+		$port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+		$user = isset($url_bits['user']) ? $url_bits['user'] : '';
+		$pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
+		$pass = ($user || $pass) ? $pass . '@' : '';
+		$path = isset($url_bits['path']) ? $url_bits['path'] : '';
+		// if the query string is not required, then return what we have so far
+		if ($remove_query) {
+			return $scheme . $user . $pass . $host . $port . $path;
+		}
+		$query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
+		$fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
+		return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+	}
 
 
-    /**
-     * get_query_string
-     * returns just the query string from a URL, formatted by default into an array of key value pairs
-     *
-     * @param string $url
-     * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
-     *                         simply return the query string
-     * @return string|array
-     */
-    public static function get_query_string($url = '', $as_array = true)
-    {
-        // decode, then break apart incoming URL
-        $url_bits = parse_url(html_entity_decode($url));
-        // grab query string from URL
-        $query = isset($url_bits['query']) ? $url_bits['query'] : '';
-        // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
-            return $query;
-        }
-        // if no query string exists then just return an empty array now
-        if (empty($query)) {
-            return [];
-        }
-        // empty array to hold results
-        $query_params = [];
-        // now break apart the query string into separate params
-        $query = explode('&', $query);
-        // loop thru our query params
-        foreach ($query as $query_args) {
-            // break apart the key value pairs
-            $query_args = explode('=', $query_args);
-            // and add to our results array
-            $query_params[ $query_args[0] ] = $query_args[1];
-        }
-        return $query_params;
-    }
+	/**
+	 * get_query_string
+	 * returns just the query string from a URL, formatted by default into an array of key value pairs
+	 *
+	 * @param string $url
+	 * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
+	 *                         simply return the query string
+	 * @return string|array
+	 */
+	public static function get_query_string($url = '', $as_array = true)
+	{
+		// decode, then break apart incoming URL
+		$url_bits = parse_url(html_entity_decode($url));
+		// grab query string from URL
+		$query = isset($url_bits['query']) ? $url_bits['query'] : '';
+		// if we don't want the query string formatted into an array of key => value pairs, then just return it as is
+		if (! $as_array) {
+			return $query;
+		}
+		// if no query string exists then just return an empty array now
+		if (empty($query)) {
+			return [];
+		}
+		// empty array to hold results
+		$query_params = [];
+		// now break apart the query string into separate params
+		$query = explode('&', $query);
+		// loop thru our query params
+		foreach ($query as $query_args) {
+			// break apart the key value pairs
+			$query_args = explode('=', $query_args);
+			// and add to our results array
+			$query_params[ $query_args[0] ] = $query_args[1];
+		}
+		return $query_params;
+	}
 
 
-    /**
-     * prevent_prefetching
-     *
-     * @return void
-     */
-    public static function prevent_prefetching()
-    {
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
-        // with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
+	/**
+	 * prevent_prefetching
+	 *
+	 * @return void
+	 */
+	public static function prevent_prefetching()
+	{
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
+		// with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
 
 
-    /**
-     * This generates a unique site-specific string.
-     * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
-     * urls.
-     *
-     * @param string $prefix Use this to prefix the string with something.
-     * @return string
-     */
-    public static function generate_unique_token($prefix = '')
-    {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
-    }
+	/**
+	 * This generates a unique site-specific string.
+	 * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
+	 * urls.
+	 *
+	 * @param string $prefix Use this to prefix the string with something.
+	 * @return string
+	 */
+	public static function generate_unique_token($prefix = '')
+	{
+		$token = md5(uniqid() . mt_rand());
+		return $prefix ? $prefix . '_' . $token : $token;
+	}
 
 
-    /**
-     * filter_input_server_url
-     * uses filter_input() to sanitize one of the INPUT_SERVER URL values
-     * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
-     *
-     * @param string $server_variable
-     * @return string
-     */
-    public static function filter_input_server_url($server_variable = 'REQUEST_URI')
-    {
-        $URL              = '';
-        $server_variables = [
-            'REQUEST_URI' => 1,
-            'HTTP_HOST'   => 1,
-            'PHP_SELF'    => 1,
-        ];
-        $server_variable  = strtoupper($server_variable);
-        // whitelist INPUT_SERVER var
-        if (isset($server_variables[ $server_variable ])) {
-            $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
-            if (empty($URL) || $URL !== $_SERVER[ $server_variable ]) {
-                // fallback sanitization if the above fails or URL has changed after filtering
-                $URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
-            }
-        }
-        return $URL;
-    }
+	/**
+	 * filter_input_server_url
+	 * uses filter_input() to sanitize one of the INPUT_SERVER URL values
+	 * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
+	 *
+	 * @param string $server_variable
+	 * @return string
+	 */
+	public static function filter_input_server_url($server_variable = 'REQUEST_URI')
+	{
+		$URL              = '';
+		$server_variables = [
+			'REQUEST_URI' => 1,
+			'HTTP_HOST'   => 1,
+			'PHP_SELF'    => 1,
+		];
+		$server_variable  = strtoupper($server_variable);
+		// whitelist INPUT_SERVER var
+		if (isset($server_variables[ $server_variable ])) {
+			$URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
+			if (empty($URL) || $URL !== $_SERVER[ $server_variable ]) {
+				// fallback sanitization if the above fails or URL has changed after filtering
+				$URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
+			}
+		}
+		return $URL;
+	}
 
 
-    /**
-     * Gets the current page's full URL.
-     *
-     * @return string
-     */
-    public static function current_url()
-    {
-        $url = '';
-        if (
-            EEH_URL::getRequest()->serverParamIsSet('HTTP_HOST')
-            && EEH_URL::getRequest()->serverParamIsSet('REQUEST_URI')
-        ) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= EEH_URL::filter_input_server_url();
-        }
-        return $url;
-    }
+	/**
+	 * Gets the current page's full URL.
+	 *
+	 * @return string
+	 */
+	public static function current_url()
+	{
+		$url = '';
+		if (
+			EEH_URL::getRequest()->serverParamIsSet('HTTP_HOST')
+			&& EEH_URL::getRequest()->serverParamIsSet('REQUEST_URI')
+		) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= EEH_URL::filter_input_server_url();
+		}
+		return $url;
+	}
 
 
-    /**
-     * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
-     *
-     * @param array $query_parameters An array of query_parameters to remove from the current url.
-     * @return string
-     * @since 4.9.46.rc.029
-     */
-    public static function current_url_without_query_paramaters(array $query_parameters)
-    {
-        return remove_query_arg($query_parameters, EEH_URL::current_url());
-    }
+	/**
+	 * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
+	 *
+	 * @param array $query_parameters An array of query_parameters to remove from the current url.
+	 * @return string
+	 * @since 4.9.46.rc.029
+	 */
+	public static function current_url_without_query_paramaters(array $query_parameters)
+	{
+		return remove_query_arg($query_parameters, EEH_URL::current_url());
+	}
 
 
-    /**
-     * @param string $location
-     * @param int    $status
-     * @param string $exit_notice
-     */
-    public static function safeRedirectAndExit($location, $status = 302, $exit_notice = '')
-    {
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect($location, $status);
-        exit($exit_notice);
-    }
+	/**
+	 * @param string $location
+	 * @param int    $status
+	 * @param string $exit_notice
+	 */
+	public static function safeRedirectAndExit($location, $status = 302, $exit_notice = '')
+	{
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect($location, $status);
+		exit($exit_notice);
+	}
 
 
-    /**
-     * Slugifies text for usage in a URL.
-     *
-     * Currently, this isn't just calling `sanitize_title()` on it, because that percent-encodes unicode characters,
-     * and WordPress chokes on them when used as CPT and custom taxonomy slugs.
-     *
-     * @param string $text
-     * @param string $fallback
-     * @return string which can be used in a URL
-     * @since 4.9.66.p
-     */
-    public static function slugify($text, $fallback)
-    {
-        // url decode after sanitizing title to restore unicode characters,
-        // see https://github.com/eventespresso/event-espresso-core/issues/575
-        return urldecode(sanitize_title($text, $fallback));
-    }
+	/**
+	 * Slugifies text for usage in a URL.
+	 *
+	 * Currently, this isn't just calling `sanitize_title()` on it, because that percent-encodes unicode characters,
+	 * and WordPress chokes on them when used as CPT and custom taxonomy slugs.
+	 *
+	 * @param string $text
+	 * @param string $fallback
+	 * @return string which can be used in a URL
+	 * @since 4.9.66.p
+	 */
+	public static function slugify($text, $fallback)
+	{
+		// url decode after sanitizing title to restore unicode characters,
+		// see https://github.com/eventespresso/event-espresso-core/issues/575
+		return urldecode(sanitize_title($text, $fallback));
+	}
 
 
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    protected static function getRequest()
-    {
-        static $request;
-        if (! $request instanceof RequestInterface) {
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        }
-        return $request;
-    }
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	protected static function getRequest()
+	{
+		static $request;
+		if (! $request instanceof RequestInterface) {
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		}
+		return $request;
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -27,12 +27,12 @@ 
     public static function add_query_args_and_nonce($args = [], $url = '', $exclude_nonce = false)
     {
         // check that an action exists and add nonce
-        if (! $exclude_nonce) {
+        if ( ! $exclude_nonce) {
             if (isset($args['action']) && ! empty($args['action'])) {
                 $args = array_merge(
                     $args,
                     [
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
+                        $args['action'].'_nonce' => wp_create_nonce($args['action'].'_nonce'),
                     ]
                 );
             } else {
@@ -46,7 +46,7 @@ 
             }
         }
 
-        $action  = EEH_URL::getRequest()->getRequestParam('action');
+        $action = EEH_URL::getRequest()->getRequestParam('action');
         // finally, let's always add a return address (if present) :)
         if ($action !== '') {
             $args['return'] = $action;
@@ -96,25 +96,25 @@ 
         // break apart incoming URL
         $url_bits = parse_url($url);
         // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'https://';
+        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'].'://' : 'https://';
         // domain
         $host = isset($url_bits['host']) ? $url_bits['host'] : '';
         // if only the base URL is requested, then return that now
         if ($base_url_only) {
-            return $scheme . $host;
+            return $scheme.$host;
         }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+        $port = isset($url_bits['port']) ? ':'.$url_bits['port'] : '';
         $user = isset($url_bits['user']) ? $url_bits['user'] : '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
+        $pass = isset($url_bits['pass']) ? ':'.$url_bits['pass'] : '';
+        $pass = ($user || $pass) ? $pass.'@' : '';
         $path = isset($url_bits['path']) ? $url_bits['path'] : '';
         // if the query string is not required, then return what we have so far
         if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
+            return $scheme.$user.$pass.$host.$port.$path;
         }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+        $query    = isset($url_bits['query']) ? '?'.$url_bits['query'] : '';
+        $fragment = isset($url_bits['fragment']) ? '#'.$url_bits['fragment'] : '';
+        return $scheme.$user.$pass.$host.$port.$path.$query.$fragment;
     }
 
 
@@ -134,7 +134,7 @@ 
         // grab query string from URL
         $query = isset($url_bits['query']) ? $url_bits['query'] : '';
         // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
+        if ( ! $as_array) {
             return $query;
         }
         // if no query string exists then just return an empty array now
@@ -150,7 +150,7 @@ 
             // break apart the key value pairs
             $query_args = explode('=', $query_args);
             // and add to our results array
-            $query_params[ $query_args[0] ] = $query_args[1];
+            $query_params[$query_args[0]] = $query_args[1];
         }
         return $query_params;
     }
@@ -179,8 +179,8 @@ 
      */
     public static function generate_unique_token($prefix = '')
     {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
+        $token = md5(uniqid().mt_rand());
+        return $prefix ? $prefix.'_'.$token : $token;
     }
 
 
@@ -200,13 +200,13 @@ 
             'HTTP_HOST'   => 1,
             'PHP_SELF'    => 1,
         ];
-        $server_variable  = strtoupper($server_variable);
+        $server_variable = strtoupper($server_variable);
         // whitelist INPUT_SERVER var
-        if (isset($server_variables[ $server_variable ])) {
+        if (isset($server_variables[$server_variable])) {
             $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
-            if (empty($URL) || $URL !== $_SERVER[ $server_variable ]) {
+            if (empty($URL) || $URL !== $_SERVER[$server_variable]) {
                 // fallback sanitization if the above fails or URL has changed after filtering
-                $URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
+                $URL = wp_sanitize_redirect($_SERVER[$server_variable]);
             }
         }
         return $URL;
@@ -285,7 +285,7 @@ 
     protected static function getRequest()
     {
         static $request;
-        if (! $request instanceof RequestInterface) {
+        if ( ! $request instanceof RequestInterface) {
             $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
         }
         return $request;

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();
+	}
 }

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.015');
-        }
+		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.015');
+		}
 
-        /**
-         * 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);
+	}
 }