eventespresso / event-espresso-core

core/admin/EE_Admin_Hooks.core.php

Spacing +42 added lines, -42 removed lines

@@ -226,7 +226,7 @@ 
         $this->_set_defaults();
         $this->_set_hooks_properties();
         // first let's verify we're on the right page
-        if (! isset($this->_req_data['page']) || $this->_req_data['page'] !== $this->_adminpage_obj->page_slug) {
+        if ( ! isset($this->_req_data['page']) || $this->_req_data['page'] !== $this->_adminpage_obj->page_slug) {
             return;
         }
         // get out nothing more to be done here.
@@ -274,9 +274,9 @@ 
     public function enqueue_scripts_styles()
     {
 
-        if (! empty($this->_scripts_styles)) {
+        if ( ! empty($this->_scripts_styles)) {
             // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
+            if ( ! isset($this->_scripts_styles['registers'])) {
                 $msg[] = esc_html__(
                     'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
                     'event_espresso'
@@ -286,7 +286,7 @@ 
                         'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
                         'event_espresso'
                     ),
-                    '<strong>' . $this->caller . '</strong>'
+                    '<strong>'.$this->caller.'</strong>'
                 );
                 throw new EE_Error(implode('||', $msg));
             }
@@ -306,7 +306,7 @@ 
                 $footer  = $details['footer'];
                 // let's make sure that we set the 'registers' type if it's not set!
                 // We need it later to determine which enqueue we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+                $this->_scripts_styles['registers'][$ref]['type'] = $type;
                 // let's make sure we're not missing any REQUIRED parameters
                 if (empty($url)) {
                     $msg[] = sprintf(
@@ -318,7 +318,7 @@ 
                             'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
                             'event_espresso'
                         ),
-                        '<strong>' . $this->caller . '</strong>',
+                        '<strong>'.$this->caller.'</strong>',
                         $ref
                     );
                     throw new EE_Error(implode('||', $msg));
@@ -334,7 +334,7 @@ 
                     );
             }
             // k now let's do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
+            if ( ! isset($this->_scripts_styles['enqueues'])) {
                 return;
             }  //not sure if we should throw an error here or not.
 
@@ -342,22 +342,22 @@ 
                 // make sure $routes is an array
                 $routes = (array) $routes;
                 if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+                    $this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
                         : wp_enqueue_style($ref);
                     // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+                    if (isset($this->_scripts_styles['localize'][$ref])) {
+                        foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
                             wp_localize_script(
                                 $ref,
                                 $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
+                                $this->_scripts_styles['localize'][$ref][$object_name]
                             );
                         }
                     }
                 }
             }
             // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
+            if ( ! isset($this->_scripts_styles['deregisters'])) {
                 return;
             }
             foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
@@ -424,20 +424,20 @@ 
         // change "the_message" to "the message"
         $class_name = str_replace('_', ' ', $this->_name);
         // change "the message" to "The_Message_Admin_Page"
-        $class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        $class_name = str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
         // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $class_name . '.core.php';
+        $decaf_file = EE_ADMIN_PAGES.$this->_name.'/'.$class_name.'.core.php';
         if (is_readable($decaf_file)) {
             require_once($decaf_file);
         }
         // now we have to do require for extended file (if needed)
         if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $class_name . '.core.php');
+            require_once(EE_CORE_CAF_ADMIN_EXTEND.$this->_name.'/Extend_'.$class_name.'.core.php');
             // and extend the class name as well
-            $class_name = 'Extend_' . $class_name;
+            $class_name = 'Extend_'.$class_name;
         }
         // let's make sure the class exists
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
             $msg[] = sprintf(
                 esc_html__(
@@ -477,28 +477,28 @@ 
         // first the actions
         // note that these action hooks will have the $query_args value available.
         $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_early_'.$this->_current_route)) {
             add_action(
                 'AHEE__'
                 . $admin_class_name
                 . '___redirect_after_action__before_redirect_modification_'
                 . $this->_current_route,
-                [$this, '_redirect_action_early_' . $this->_current_route],
+                [$this, '_redirect_action_early_'.$this->_current_route],
                 10
             );
         }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_'.$this->_current_route)) {
             add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_action_' . $this->_current_route],
+                'AHEE_redirect_'.$admin_class_name.$this->_current_route,
+                [$this, '_redirect_action_'.$this->_current_route],
                 10
             );
         }
         // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_filter_'.$this->_current_route)) {
             add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_filter_' . $this->_current_route],
+                'FHEE_redirect_'.$admin_class_name.$this->_current_route,
+                [$this, '_redirect_filter_'.$this->_current_route],
                 10,
                 2
             );
@@ -523,12 +523,12 @@ 
                 'argnum'   => 1,
                 'priority' => 10,
             ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug.'_'.$this->_current_route => [
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
             ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug                               => [
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
@@ -545,21 +545,21 @@ 
             ],
         ];
         foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+            if (method_exists($this, $this->_current_route.'_'.$hook)) {
+                if (isset($this->_wp_action_filters_priority[$hook])) {
+                    $args['priority'] = $this->_wp_action_filters_priority[$hook];
                 }
                 if ($args['type'] == 'action') {
                     add_action(
                         $hook,
-                        [$this, $this->_current_route . '_' . $hook],
+                        [$this, $this->_current_route.'_'.$hook],
                         $args['priority'],
                         $args['argnum']
                     );
                 } else {
                     add_filter(
                         $hook,
-                        [$this, $this->_current_route . '_' . $hook],
+                        [$this, $this->_current_route.'_'.$hook],
                         $args['priority'],
                         $args['argnum']
                     );
@@ -583,11 +583,11 @@ 
         } //get out there's nothing to take care of.
         foreach ($this->_ajax_func as $action => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = esc_html__(
                     'There is no corresponding method for the hook labeled in the _ajax_func array',
                     'event_espresso'
-                ) . '<br />';
+                ).'<br />';
                 $msg[] = sprintf(
                     esc_html__(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -598,7 +598,7 @@ 
                 );
                 throw new EE_Error(implode('||', $msg));
             }
-            add_action('wp_ajax_' . $action, [$this, $method]);
+            add_action('wp_ajax_'.$action, [$this, $method]);
         }
     }
 
@@ -618,11 +618,11 @@ 
         // We need to determine what page_route we are on!
         foreach ($this->_init_func as $route => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = esc_html__(
                     'There is no corresponding method for the hook labeled in the _init_func array',
                     'event_espresso'
-                ) . '<br />';
+                ).'<br />';
                 $msg[] = sprintf(
                     esc_html__(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -665,7 +665,7 @@ 
     {
 
         foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
+            if ( ! isset($box['page_route'])) {
                 continue;
             }
             // we don't have a valid array
@@ -713,11 +713,11 @@ 
         $screen_id      = is_object($current_screen) ? $current_screen->id : null;
         $func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
         // set defaults
-        $defaults      = [
+        $defaults = [
             'callback_args' => [],
             'context'       => 'advanced',
             'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
+            'id'            => $this->caller.'_'.$func.'_metabox',
             'label'         => $this->caller,
             'page'          => isset($args['page']) ? $args['page'] : $screen_id,
             'priority'      => 'default',
@@ -731,7 +731,7 @@ 
         $page          = $args['page'];
         $priority      = $args['priority'];
         // make sure method exists
-        if (! method_exists($this, $func)) {
+        if ( ! method_exists($this, $func)) {
             $msg[] =
                 esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
                 . '<br />';
@@ -760,7 +760,7 @@ 
             'context' => 'default',
             'id'      => isset($args['id'])
                 ? $args['id']
-                : $this->_current_route . '_' . $this->caller . '_' . $func . '_metabox',
+                : $this->_current_route.'_'.$this->caller.'_'.$func.'_metabox',
             'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
         ];
         $args     = wp_parse_args($args, $defaults);

Indentation +754 added lines, -754 removed lines

@@ -14,758 +14,758 @@
  */
 abstract class EE_Admin_Hooks extends EE_Base
 {
-    /**
-     * we're just going to use this to hold the name of the caller class (child class name)
-     *
-     * @var string
-     */
-    public $caller;
-
-
-    /**
-     * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
-     * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
-     * used later to make sure we require the needed files.
-     *
-     * @var bool
-     */
-    protected $_extend;
-
-
-    /**
-     * child classes MUST set this property so that the page object can be loaded correctly
-     *
-     * @var string
-     */
-    protected $_name;
-
-
-    /**
-     * This is set by child classes and is an associative array of ajax hooks in the format:
-     * array(
-     *    'ajax_action_ref' => 'executing_method'; //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_ajax_func;
-
-
-    /**
-     * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
-     * array(
-     *    'page_route' => 'executing_method' //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_init_func;
-
-
-    /**
-     * This is an array of methods that output metabox content for the given page route.  Use the following format:
-     * [
-     *      0 => [
-     *          'page_route' => 'string_for_page_route',    must correspond to a page route in the class being connected
-     *                                                      with (i.e. "edit_event") If this is in an array then the
-     *                                                      same params below will be used but the metabox will be
-     *                                                      added to each route.
-     *          'func' =>  'executing_method',              must be public (i.e. public function executing_method
-     *                                                      ($post, $callback_args){} ).
-     *                                                      Note if you include callback args in the array then you
-     *                                                      need to declare them in the method arguments.
-     *          'id' => 'identifier_for_metabox',           so it can be removed by addons
-     *                                                      (optional, class will set it automatically)
-     *          'priority' => 'default',                    default 'default' (optional)
-     *          'label' => esc_html__('Localized Title', 'event_espresso'),
-     *          'context' => 'advanced'                     advanced is default (optional),
-     *      ]
-     *      'callback_args' => array() //any callback args to include (optional)
-     * ]
-     * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
-     *
-     * @var array
-     */
-    protected $_metaboxes;
-
-
-    /**
-     * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
-     * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
-     * array: array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
-     *        that are in the class being connected with (i.e. 'edit', or 'create_new').
-     *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
-     *        'context' => 'normal', //the context for the metabox being removed (has to match)
-     *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
-     *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
-     *        id for the screen the metabox is on.
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_remove_metaboxes;
-
-
-    /**
-     * This parent class takes care of loading the scripts and styles if the child class has set the properties for
-     * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
-     * second array index is for indicating what routes each script/style loads on. array(
-     * 'registers' => array(
-     *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
-     *        argument to link scripts together.
-     *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
-     *            'url' => 'http://urltoscript.css.js',
-     *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
-     *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
-     *            gets loaded before the one you are setting here.
-     *            'footer' => TRUE //defaults to true (styles don't use this parameter)
-     *        ),
-     *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
-     *    the script gets enqueued on.
-     *        'script_ref' => array('route_one', 'route_two')
-     *    ),
-     *    'localize' => array( //this allows you to set a localized object.  Indicate which script the object is being
-     *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
-     *    the object.
-     *        'scrip_ref' => array(
-     *            'NAME_OF_JS_OBJECT' => array(
-     *                'translate_ref' => esc_html__('localized_string', 'event_espresso'),
-     *                'some_data' => 5
-     *            )
-     *        )
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_scripts_styles;
-
-
-    /**
-     * This is a property that will contain the current route.
-     *
-     * @var string;
-     */
-    protected $_current_route;
-
-
-    /**
-     * this optional property can be set by child classes to override the priority for the automatic action/filter hook
-     * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
-     *    'wp_hook_reference' => 1
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_wp_action_filters_priority;
-
-
-    /**
-     * This just holds a merged array of the request vars
-     *
-     * @var array
-     */
-    protected $_req_data;
-
-    /**
-     * @var array
-     */
-    protected $_scripts;
-
-    /**
-     * @var array
-     */
-    protected $_styles;
-
-    /**
-     * This just holds an instance of the page object for this hook
-     *
-     * @var EE_Admin_Page
-     */
-    protected $_page_object;
-
-
-    /**
-     * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT
-     */
-    protected $_adminpage_obj;
-
-
-    /**
-     * Holds EE_Registry object
-     *
-     * @var EE_Registry
-     */
-    protected $EE = null;
-
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Admin_Page $admin_page
-     * @throws EE_Error
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        $this->_adminpage_obj = $admin_page;
-        $this->request        = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $this->_req_data      = $this->request->requestParams();
-        $this->_set_defaults();
-        $this->_set_hooks_properties();
-        // first let's verify we're on the right page
-        if (! isset($this->_req_data['page']) || $this->_req_data['page'] !== $this->_adminpage_obj->page_slug) {
-            return;
-        }
-        // get out nothing more to be done here.
-        // allow for extends to modify properties
-        if (method_exists($this, '_extend_properties')) {
-            $this->_extend_properties();
-        }
-        $this->_set_page_object();
-        $this->_init_hooks();
-        $this->_load_custom_methods();
-        $this->_load_routed_hooks();
-        add_action('admin_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
-        add_action('admin_enqueue_scripts', [$this, 'add_metaboxes'], 20);
-        add_action('admin_enqueue_scripts', [$this, 'remove_metaboxes'], 15);
-        $this->_ajax_hooks();
-    }
-
-
-    /**
-     * used by child classes to set the following properties:
-     * $_ajax_func (optional)
-     * $_init_func (optional)
-     * $_metaboxes (optional)
-     * $_scripts (optional)
-     * $_styles (optional)
-     * $_name (required)
-     * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
-     * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
-     * really early on page load (just after admin_init) if they want to have them registered for handling early.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_hooks_properties();
-
-
-    /**
-     * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
-     * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
-     * registered the scripts and styles using wp_register_script and wp_register_style functions.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_scripts_styles()
-    {
-
-        if (! empty($this->_scripts_styles)) {
-            // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
-                $msg[] = esc_html__(
-                    'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
-                    'event_espresso'
-                );
-                $msg[] = sprintf(
-                    esc_html__(
-                        'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $this->caller . '</strong>'
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            $defaults = [
-                'type'    => 'js',
-                'url'     => '',
-                'depends' => [],
-                'version' => EVENT_ESPRESSO_VERSION,
-                'footer'  => true,
-            ];
-            foreach ($this->_scripts_styles['registers'] as $ref => $details) {
-                $details = wp_parse_args($details, $defaults);
-                $type    = $details['type'];
-                $url     = $details['url'];
-                $depends = $details['depends'];
-                $version = $details['version'];
-                $footer  = $details['footer'];
-                // let's make sure that we set the 'registers' type if it's not set!
-                // We need it later to determine which enqueue we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
-                // let's make sure we're not missing any REQUIRED parameters
-                if (empty($url)) {
-                    $msg[] = sprintf(
-                        esc_html__('Missing the url for the requested %s', 'event_espresso'),
-                        $type == 'js' ? 'script' : 'stylesheet'
-                    );
-                    $msg[] = sprintf(
-                        esc_html__(
-                            'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $this->caller . '</strong>',
-                        $ref
-                    );
-                    throw new EE_Error(implode('||', $msg));
-                }
-                // made it here so let's do the appropriate registration
-                $type == 'js'
-                    ? wp_register_script($ref, $url, $depends, $version, $footer)
-                    : wp_register_style(
-                        $ref,
-                        $url,
-                        $depends,
-                        $version
-                    );
-            }
-            // k now let's do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
-                return;
-            }  //not sure if we should throw an error here or not.
-
-            foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
-                // make sure $routes is an array
-                $routes = (array) $routes;
-                if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
-                        : wp_enqueue_style($ref);
-                    // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
-                            wp_localize_script(
-                                $ref,
-                                $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
-                            );
-                        }
-                    }
-                }
-            }
-            // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
-                return;
-            }
-            foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
-                $defaults = ['type' => 'js'];
-                $details  = wp_parse_args($details, $defaults);
-                $details['type'] === 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
-            }
-        }
-    }
-
-
-    /**
-     * just set the defaults for the hooks properties.
-     *
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        $this->_ajax_func                  = [];
-        $this->_init_func                  = [];
-        $this->_metaboxes                  = [];
-        $this->_scripts                    = [];
-        $this->_styles                     = [];
-        $this->_wp_action_filters_priority = [];
-        $this->_current_route              = $this->getCurrentRoute();
-        $this->caller                      = get_class($this);
-        $this->_extend                     = (bool) stripos($this->caller, 'Extend');
-    }
-
-
-    /**
-     * A helper for determining the current route.
-     *
-     * @return string
-     */
-    private function getCurrentRoute()
-    {
-        $action = $this->request->getRequestParam('action');
-        // list tables do something else with 'action' for bulk actions.
-        $action = $action !== '-1' && $action !== '' ? $action : 'default';
-        $route  = $this->request->getRequestParam('route');
-        // we set a 'route' variable in some cases where action is being used by something else.
-        return $action === 'default' && $route !== '' ? $route : $action;
-    }
-
-
-    /**
-     * this sets the _page_object property
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _set_page_object()
-    {
-        // first make sure $this->_name is set
-        if (empty($this->_name)) {
-            $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // change "the_message" to "the message"
-        $class_name = str_replace('_', ' ', $this->_name);
-        // change "the message" to "The_Message_Admin_Page"
-        $class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-        // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $class_name . '.core.php';
-        if (is_readable($decaf_file)) {
-            require_once($decaf_file);
-        }
-        // now we have to do require for extended file (if needed)
-        if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $class_name . '.core.php');
-            // and extend the class name as well
-            $class_name = 'Extend_' . $class_name;
-        }
-        // let's make sure the class exists
-        if (! class_exists($class_name)) {
-            $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__(
-                    'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
-                    'event_espresso'
-                ),
-                $class_name
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $this->_page_object = LoaderFactory::getLoader()->getShared($class_name, [false]);
-    }
-
-
-    /**
-     * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
-     * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
-     * $this->_req_data (all the _POST and _GET data) is available to your methods.
-     *
-     * @return void
-     */
-    private function _load_custom_methods()
-    {
-        /**
-         * method cannot be named 'default' (@see http://us3.php
-         * .net/manual/en/reserved.keywords.php) so need to
-         * handle routes that are "default"
-         *
-         * @since 4.3.0
-         */
-        $method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
-        // these run before the Admin_Page route executes.
-        if (method_exists($this, $method_callback)) {
-            call_user_func([$this, $method_callback]);
-        }
-        // these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
-        // first the actions
-        // note that these action hooks will have the $query_args value available.
-        $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
-            add_action(
-                'AHEE__'
-                . $admin_class_name
-                . '___redirect_after_action__before_redirect_modification_'
-                . $this->_current_route,
-                [$this, '_redirect_action_early_' . $this->_current_route],
-                10
-            );
-        }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
-            add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_action_' . $this->_current_route],
-                10
-            );
-        }
-        // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
-            add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_filter_' . $this->_current_route],
-                10,
-                2
-            );
-        }
-    }
-
-
-    /**
-     * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
-     * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
-     * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
-     *
-     * @return void
-     */
-    private function _load_routed_hooks()
-    {
-
-        // this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
-        $hook_filter_array = [
-            'admin_footer'                                                                            => [
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views'                                                                   => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => [
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-        ];
-        foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
-                }
-                if ($args['type'] == 'action') {
-                    add_action(
-                        $hook,
-                        [$this, $this->_current_route . '_' . $hook],
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                } else {
-                    add_filter(
-                        $hook,
-                        [$this, $this->_current_route . '_' . $hook],
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop throught the $_ajax_func array and add_actions for the array.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    private function _ajax_hooks()
-    {
-
-        if (empty($this->_ajax_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        foreach ($this->_ajax_func as $action => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = esc_html__(
-                    'There is no corresponding method for the hook labeled in the _ajax_func array',
-                    'event_espresso'
-                ) . '<br />';
-                $msg[] = sprintf(
-                    esc_html__(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            add_action('wp_ajax_' . $action, [$this, $method]);
-        }
-    }
-
-
-    /**
-     * Loop throught the $_init_func array and add_actions for the array.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _init_hooks()
-    {
-        if (empty($this->_init_func)) {
-            return;
-        }
-        // get out there's nothing to take care of.
-        // We need to determine what page_route we are on!
-        foreach ($this->_init_func as $route => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = esc_html__(
-                    'There is no corresponding method for the hook labeled in the _init_func array',
-                    'event_espresso'
-                ) . '<br />';
-                $msg[] = sprintf(
-                    esc_html__(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            if ($route == $this->_current_route) {
-                add_action('admin_init', [$this, $method]);
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _metaboxes property and add_metaboxes accordingly
-     * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_metaboxes()
-    {
-        if (empty($this->_metaboxes)) {
-            return;
-        } //get out we don't have any metaboxes to set for this connection
-        $this->_handle_metabox_array($this->_metaboxes);
-    }
-
-
-    /**
-     * @param array $boxes
-     * @param bool  $add
-     * @throws EE_Error
-     */
-    private function _handle_metabox_array(array $boxes, $add = true)
-    {
-
-        foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
-                continue;
-            }
-            // we don't have a valid array
-            // let's make sure $box['page_route'] is an array so the "foreach" will work.
-            $box['page_route'] = (array) $box['page_route'];
-            foreach ($box['page_route'] as $route) {
-                if ($route != $this->_current_route) {
-                    continue;
-                } //get out we only add metaboxes for set route.
-                if ($add) {
-                    $this->_add_metabox($box);
-                } else {
-                    $this->_remove_metabox($box);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function remove_metaboxes()
-    {
-
-        if (empty($this->_remove_metaboxes)) {
-            return;
-        } //get out there are no metaboxes to remove
-        $this->_handle_metabox_array($this->_remove_metaboxes, false);
-    }
-
-
-    /**
-     * This just handles adding a metabox
-     *
-     * @param array $args an array of args that have been set for this metabox by the child class
-     * @throws EE_Error
-     */
-    private function _add_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id      = is_object($current_screen) ? $current_screen->id : null;
-        $func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        // set defaults
-        $defaults      = [
-            'callback_args' => [],
-            'context'       => 'advanced',
-            'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
-            'label'         => $this->caller,
-            'page'          => isset($args['page']) ? $args['page'] : $screen_id,
-            'priority'      => 'default',
-        ];
-        $args          = wp_parse_args($args, $defaults);
-        $callback_args = $args['callback_args'];
-        $context       = $args['context'];
-        $func          = $args['func'];
-        $id            = $args['id'];
-        $label         = $args['label'];
-        $page          = $args['page'];
-        $priority      = $args['priority'];
-        // make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] =
-                esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
-                . '<br />';
-            $msg[] = sprintf(
-                esc_html__(
-                    'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                    'event_espresso'
-                ),
-                $func,
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // everything checks out so let's add the metabox
-        add_meta_box($id, $label, [$this, $func], $page, $context, $priority, $callback_args);
-    }
-
-
-    private function _remove_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id      = is_object($current_screen) ? $current_screen->id : null;
-        $func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        // set defaults
-        $defaults = [
-            'context' => 'default',
-            'id'      => isset($args['id'])
-                ? $args['id']
-                : $this->_current_route . '_' . $this->caller . '_' . $func . '_metabox',
-            'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
-        ];
-        $args     = wp_parse_args($args, $defaults);
-        $context  = $args['context'];
-        $id       = $args['id'];
-        $screen   = $args['screen'];
-        // everything checks out so lets remove the box!
-        remove_meta_box($id, $screen, $context);
-    }
+	/**
+	 * we're just going to use this to hold the name of the caller class (child class name)
+	 *
+	 * @var string
+	 */
+	public $caller;
+
+
+	/**
+	 * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
+	 * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
+	 * used later to make sure we require the needed files.
+	 *
+	 * @var bool
+	 */
+	protected $_extend;
+
+
+	/**
+	 * child classes MUST set this property so that the page object can be loaded correctly
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+
+	/**
+	 * This is set by child classes and is an associative array of ajax hooks in the format:
+	 * array(
+	 *    'ajax_action_ref' => 'executing_method'; //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_ajax_func;
+
+
+	/**
+	 * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
+	 * array(
+	 *    'page_route' => 'executing_method' //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_init_func;
+
+
+	/**
+	 * This is an array of methods that output metabox content for the given page route.  Use the following format:
+	 * [
+	 *      0 => [
+	 *          'page_route' => 'string_for_page_route',    must correspond to a page route in the class being connected
+	 *                                                      with (i.e. "edit_event") If this is in an array then the
+	 *                                                      same params below will be used but the metabox will be
+	 *                                                      added to each route.
+	 *          'func' =>  'executing_method',              must be public (i.e. public function executing_method
+	 *                                                      ($post, $callback_args){} ).
+	 *                                                      Note if you include callback args in the array then you
+	 *                                                      need to declare them in the method arguments.
+	 *          'id' => 'identifier_for_metabox',           so it can be removed by addons
+	 *                                                      (optional, class will set it automatically)
+	 *          'priority' => 'default',                    default 'default' (optional)
+	 *          'label' => esc_html__('Localized Title', 'event_espresso'),
+	 *          'context' => 'advanced'                     advanced is default (optional),
+	 *      ]
+	 *      'callback_args' => array() //any callback args to include (optional)
+	 * ]
+	 * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
+	 *
+	 * @var array
+	 */
+	protected $_metaboxes;
+
+
+	/**
+	 * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
+	 * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
+	 * array: array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
+	 *        that are in the class being connected with (i.e. 'edit', or 'create_new').
+	 *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
+	 *        'context' => 'normal', //the context for the metabox being removed (has to match)
+	 *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
+	 *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
+	 *        id for the screen the metabox is on.
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_remove_metaboxes;
+
+
+	/**
+	 * This parent class takes care of loading the scripts and styles if the child class has set the properties for
+	 * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
+	 * second array index is for indicating what routes each script/style loads on. array(
+	 * 'registers' => array(
+	 *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
+	 *        argument to link scripts together.
+	 *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
+	 *            'url' => 'http://urltoscript.css.js',
+	 *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
+	 *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
+	 *            gets loaded before the one you are setting here.
+	 *            'footer' => TRUE //defaults to true (styles don't use this parameter)
+	 *        ),
+	 *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
+	 *    the script gets enqueued on.
+	 *        'script_ref' => array('route_one', 'route_two')
+	 *    ),
+	 *    'localize' => array( //this allows you to set a localized object.  Indicate which script the object is being
+	 *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
+	 *    the object.
+	 *        'scrip_ref' => array(
+	 *            'NAME_OF_JS_OBJECT' => array(
+	 *                'translate_ref' => esc_html__('localized_string', 'event_espresso'),
+	 *                'some_data' => 5
+	 *            )
+	 *        )
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_scripts_styles;
+
+
+	/**
+	 * This is a property that will contain the current route.
+	 *
+	 * @var string;
+	 */
+	protected $_current_route;
+
+
+	/**
+	 * this optional property can be set by child classes to override the priority for the automatic action/filter hook
+	 * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
+	 *    'wp_hook_reference' => 1
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_wp_action_filters_priority;
+
+
+	/**
+	 * This just holds a merged array of the request vars
+	 *
+	 * @var array
+	 */
+	protected $_req_data;
+
+	/**
+	 * @var array
+	 */
+	protected $_scripts;
+
+	/**
+	 * @var array
+	 */
+	protected $_styles;
+
+	/**
+	 * This just holds an instance of the page object for this hook
+	 *
+	 * @var EE_Admin_Page
+	 */
+	protected $_page_object;
+
+
+	/**
+	 * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT
+	 */
+	protected $_adminpage_obj;
+
+
+	/**
+	 * Holds EE_Registry object
+	 *
+	 * @var EE_Registry
+	 */
+	protected $EE = null;
+
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Admin_Page $admin_page
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		$this->_adminpage_obj = $admin_page;
+		$this->request        = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$this->_req_data      = $this->request->requestParams();
+		$this->_set_defaults();
+		$this->_set_hooks_properties();
+		// first let's verify we're on the right page
+		if (! isset($this->_req_data['page']) || $this->_req_data['page'] !== $this->_adminpage_obj->page_slug) {
+			return;
+		}
+		// get out nothing more to be done here.
+		// allow for extends to modify properties
+		if (method_exists($this, '_extend_properties')) {
+			$this->_extend_properties();
+		}
+		$this->_set_page_object();
+		$this->_init_hooks();
+		$this->_load_custom_methods();
+		$this->_load_routed_hooks();
+		add_action('admin_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
+		add_action('admin_enqueue_scripts', [$this, 'add_metaboxes'], 20);
+		add_action('admin_enqueue_scripts', [$this, 'remove_metaboxes'], 15);
+		$this->_ajax_hooks();
+	}
+
+
+	/**
+	 * used by child classes to set the following properties:
+	 * $_ajax_func (optional)
+	 * $_init_func (optional)
+	 * $_metaboxes (optional)
+	 * $_scripts (optional)
+	 * $_styles (optional)
+	 * $_name (required)
+	 * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
+	 * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
+	 * really early on page load (just after admin_init) if they want to have them registered for handling early.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_hooks_properties();
+
+
+	/**
+	 * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
+	 * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
+	 * registered the scripts and styles using wp_register_script and wp_register_style functions.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_scripts_styles()
+	{
+
+		if (! empty($this->_scripts_styles)) {
+			// first let's do all the registrations
+			if (! isset($this->_scripts_styles['registers'])) {
+				$msg[] = esc_html__(
+					'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
+					'event_espresso'
+				);
+				$msg[] = sprintf(
+					esc_html__(
+						'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
+						'event_espresso'
+					),
+					'<strong>' . $this->caller . '</strong>'
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			$defaults = [
+				'type'    => 'js',
+				'url'     => '',
+				'depends' => [],
+				'version' => EVENT_ESPRESSO_VERSION,
+				'footer'  => true,
+			];
+			foreach ($this->_scripts_styles['registers'] as $ref => $details) {
+				$details = wp_parse_args($details, $defaults);
+				$type    = $details['type'];
+				$url     = $details['url'];
+				$depends = $details['depends'];
+				$version = $details['version'];
+				$footer  = $details['footer'];
+				// let's make sure that we set the 'registers' type if it's not set!
+				// We need it later to determine which enqueue we do
+				$this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+				// let's make sure we're not missing any REQUIRED parameters
+				if (empty($url)) {
+					$msg[] = sprintf(
+						esc_html__('Missing the url for the requested %s', 'event_espresso'),
+						$type == 'js' ? 'script' : 'stylesheet'
+					);
+					$msg[] = sprintf(
+						esc_html__(
+							'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
+							'event_espresso'
+						),
+						'<strong>' . $this->caller . '</strong>',
+						$ref
+					);
+					throw new EE_Error(implode('||', $msg));
+				}
+				// made it here so let's do the appropriate registration
+				$type == 'js'
+					? wp_register_script($ref, $url, $depends, $version, $footer)
+					: wp_register_style(
+						$ref,
+						$url,
+						$depends,
+						$version
+					);
+			}
+			// k now let's do the enqueues
+			if (! isset($this->_scripts_styles['enqueues'])) {
+				return;
+			}  //not sure if we should throw an error here or not.
+
+			foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
+				// make sure $routes is an array
+				$routes = (array) $routes;
+				if (in_array($this->_current_route, $routes)) {
+					$this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+						: wp_enqueue_style($ref);
+					// if we have a localization for the script let's do that too.
+					if (isset($this->_scripts_styles['localize'][ $ref ])) {
+						foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+							wp_localize_script(
+								$ref,
+								$object_name,
+								$this->_scripts_styles['localize'][ $ref ][ $object_name ]
+							);
+						}
+					}
+				}
+			}
+			// let's do the deregisters
+			if (! isset($this->_scripts_styles['deregisters'])) {
+				return;
+			}
+			foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
+				$defaults = ['type' => 'js'];
+				$details  = wp_parse_args($details, $defaults);
+				$details['type'] === 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
+			}
+		}
+	}
+
+
+	/**
+	 * just set the defaults for the hooks properties.
+	 *
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		$this->_ajax_func                  = [];
+		$this->_init_func                  = [];
+		$this->_metaboxes                  = [];
+		$this->_scripts                    = [];
+		$this->_styles                     = [];
+		$this->_wp_action_filters_priority = [];
+		$this->_current_route              = $this->getCurrentRoute();
+		$this->caller                      = get_class($this);
+		$this->_extend                     = (bool) stripos($this->caller, 'Extend');
+	}
+
+
+	/**
+	 * A helper for determining the current route.
+	 *
+	 * @return string
+	 */
+	private function getCurrentRoute()
+	{
+		$action = $this->request->getRequestParam('action');
+		// list tables do something else with 'action' for bulk actions.
+		$action = $action !== '-1' && $action !== '' ? $action : 'default';
+		$route  = $this->request->getRequestParam('route');
+		// we set a 'route' variable in some cases where action is being used by something else.
+		return $action === 'default' && $route !== '' ? $route : $action;
+	}
+
+
+	/**
+	 * this sets the _page_object property
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _set_page_object()
+	{
+		// first make sure $this->_name is set
+		if (empty($this->_name)) {
+			$msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// change "the_message" to "the message"
+		$class_name = str_replace('_', ' ', $this->_name);
+		// change "the message" to "The_Message_Admin_Page"
+		$class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+		// first default file (if exists)
+		$decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $class_name . '.core.php';
+		if (is_readable($decaf_file)) {
+			require_once($decaf_file);
+		}
+		// now we have to do require for extended file (if needed)
+		if ($this->_extend) {
+			require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $class_name . '.core.php');
+			// and extend the class name as well
+			$class_name = 'Extend_' . $class_name;
+		}
+		// let's make sure the class exists
+		if (! class_exists($class_name)) {
+			$msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__(
+					'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
+					'event_espresso'
+				),
+				$class_name
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$this->_page_object = LoaderFactory::getLoader()->getShared($class_name, [false]);
+	}
+
+
+	/**
+	 * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
+	 * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
+	 * $this->_req_data (all the _POST and _GET data) is available to your methods.
+	 *
+	 * @return void
+	 */
+	private function _load_custom_methods()
+	{
+		/**
+		 * method cannot be named 'default' (@see http://us3.php
+		 * .net/manual/en/reserved.keywords.php) so need to
+		 * handle routes that are "default"
+		 *
+		 * @since 4.3.0
+		 */
+		$method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
+		// these run before the Admin_Page route executes.
+		if (method_exists($this, $method_callback)) {
+			call_user_func([$this, $method_callback]);
+		}
+		// these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
+		// first the actions
+		// note that these action hooks will have the $query_args value available.
+		$admin_class_name = get_class($this->_adminpage_obj);
+		if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+			add_action(
+				'AHEE__'
+				. $admin_class_name
+				. '___redirect_after_action__before_redirect_modification_'
+				. $this->_current_route,
+				[$this, '_redirect_action_early_' . $this->_current_route],
+				10
+			);
+		}
+		if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+			add_action(
+				'AHEE_redirect_' . $admin_class_name . $this->_current_route,
+				[$this, '_redirect_action_' . $this->_current_route],
+				10
+			);
+		}
+		// let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
+		if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+			add_filter(
+				'FHEE_redirect_' . $admin_class_name . $this->_current_route,
+				[$this, '_redirect_filter_' . $this->_current_route],
+				10,
+				2
+			);
+		}
+	}
+
+
+	/**
+	 * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
+	 * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
+	 * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
+	 *
+	 * @return void
+	 */
+	private function _load_routed_hooks()
+	{
+
+		// this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
+		$hook_filter_array = [
+			'admin_footer'                                                                            => [
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views'                                                                   => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => [
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+		];
+		foreach ($hook_filter_array as $hook => $args) {
+			if (method_exists($this, $this->_current_route . '_' . $hook)) {
+				if (isset($this->_wp_action_filters_priority[ $hook ])) {
+					$args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+				}
+				if ($args['type'] == 'action') {
+					add_action(
+						$hook,
+						[$this, $this->_current_route . '_' . $hook],
+						$args['priority'],
+						$args['argnum']
+					);
+				} else {
+					add_filter(
+						$hook,
+						[$this, $this->_current_route . '_' . $hook],
+						$args['priority'],
+						$args['argnum']
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_ajax_func array and add_actions for the array.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _ajax_hooks()
+	{
+
+		if (empty($this->_ajax_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		foreach ($this->_ajax_func as $action => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = esc_html__(
+					'There is no corresponding method for the hook labeled in the _ajax_func array',
+					'event_espresso'
+				) . '<br />';
+				$msg[] = sprintf(
+					esc_html__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			add_action('wp_ajax_' . $action, [$this, $method]);
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_init_func array and add_actions for the array.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _init_hooks()
+	{
+		if (empty($this->_init_func)) {
+			return;
+		}
+		// get out there's nothing to take care of.
+		// We need to determine what page_route we are on!
+		foreach ($this->_init_func as $route => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = esc_html__(
+					'There is no corresponding method for the hook labeled in the _init_func array',
+					'event_espresso'
+				) . '<br />';
+				$msg[] = sprintf(
+					esc_html__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			if ($route == $this->_current_route) {
+				add_action('admin_init', [$this, $method]);
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _metaboxes property and add_metaboxes accordingly
+	 * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_metaboxes()
+	{
+		if (empty($this->_metaboxes)) {
+			return;
+		} //get out we don't have any metaboxes to set for this connection
+		$this->_handle_metabox_array($this->_metaboxes);
+	}
+
+
+	/**
+	 * @param array $boxes
+	 * @param bool  $add
+	 * @throws EE_Error
+	 */
+	private function _handle_metabox_array(array $boxes, $add = true)
+	{
+
+		foreach ($boxes as $box) {
+			if (! isset($box['page_route'])) {
+				continue;
+			}
+			// we don't have a valid array
+			// let's make sure $box['page_route'] is an array so the "foreach" will work.
+			$box['page_route'] = (array) $box['page_route'];
+			foreach ($box['page_route'] as $route) {
+				if ($route != $this->_current_route) {
+					continue;
+				} //get out we only add metaboxes for set route.
+				if ($add) {
+					$this->_add_metabox($box);
+				} else {
+					$this->_remove_metabox($box);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function remove_metaboxes()
+	{
+
+		if (empty($this->_remove_metaboxes)) {
+			return;
+		} //get out there are no metaboxes to remove
+		$this->_handle_metabox_array($this->_remove_metaboxes, false);
+	}
+
+
+	/**
+	 * This just handles adding a metabox
+	 *
+	 * @param array $args an array of args that have been set for this metabox by the child class
+	 * @throws EE_Error
+	 */
+	private function _add_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id      = is_object($current_screen) ? $current_screen->id : null;
+		$func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		// set defaults
+		$defaults      = [
+			'callback_args' => [],
+			'context'       => 'advanced',
+			'func'          => $func,
+			'id'            => $this->caller . '_' . $func . '_metabox',
+			'label'         => $this->caller,
+			'page'          => isset($args['page']) ? $args['page'] : $screen_id,
+			'priority'      => 'default',
+		];
+		$args          = wp_parse_args($args, $defaults);
+		$callback_args = $args['callback_args'];
+		$context       = $args['context'];
+		$func          = $args['func'];
+		$id            = $args['id'];
+		$label         = $args['label'];
+		$page          = $args['page'];
+		$priority      = $args['priority'];
+		// make sure method exists
+		if (! method_exists($this, $func)) {
+			$msg[] =
+				esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
+				. '<br />';
+			$msg[] = sprintf(
+				esc_html__(
+					'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+					'event_espresso'
+				),
+				$func,
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// everything checks out so let's add the metabox
+		add_meta_box($id, $label, [$this, $func], $page, $context, $priority, $callback_args);
+	}
+
+
+	private function _remove_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id      = is_object($current_screen) ? $current_screen->id : null;
+		$func           = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		// set defaults
+		$defaults = [
+			'context' => 'default',
+			'id'      => isset($args['id'])
+				? $args['id']
+				: $this->_current_route . '_' . $this->caller . '_' . $func . '_metabox',
+			'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
+		];
+		$args     = wp_parse_args($args, $defaults);
+		$context  = $args['context'];
+		$id       = $args['id'];
+		$screen   = $args['screen'];
+		// everything checks out so lets remove the box!
+		remove_meta_box($id, $screen, $context);
+	}
 }

core/admin/EE_Admin_Page_Loader.core.php

Spacing +46 added lines, -46 removed lines

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

Indentation +661 added lines, -661 removed lines

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

core/admin/EE_Admin_Page_Menu_Map.core.php

Spacing +5 added lines, -5 removed lines

@@ -145,7 +145,7 @@ 
         // verify that required keys are present in the incoming array.
         $missing = array_diff((array) $required, array_keys((array) $menu_args));
 
-        if (! empty($missing)) {
+        if ( ! empty($missing)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -184,7 +184,7 @@ 
                     $value = (string) $value;
                     break;
             }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
+            if ( ! EEH_Class_Tools::has_property($this, $prop)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -201,7 +201,7 @@ 
 
         // filter capabilities (both static and dynamic)
         $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+        $this->capability = apply_filters('FHEE_'.$this->menu_slug.'_capability', $this->capability, null);
 
         // Might need to change parent slug depending on maintenance mode.
         if (
@@ -247,7 +247,7 @@ 
                  [self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY],
                  true
              ))
-            || (! $network_admin
+            || ( ! $network_admin
                 && in_array(
                     $show_on_menu_int,
                     [self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY],
@@ -259,7 +259,7 @@ 
             $wp_page_slug = '';
         }
 
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+        if ( ! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
             try {
                 $this->admin_init_page->set_page_dependencies($wp_page_slug);
             } catch (EE_Error $e) {

Indentation +255 added lines, -255 removed lines

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

modules/ticket_sales_monitor/EED_Ticket_Sales_Monitor.module.php

Spacing +79 added lines, -79 removed lines

@@ -183,7 +183,7 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
         }
         do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
         $expired_ticket_IDs = array();
@@ -194,29 +194,29 @@ 
         $timestamp = $session_lifespan->expiration();
         $expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
         if (self::debug) {
-            echo self::$nl . ' . time(): ' . time();
-            echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
-            echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
-            echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
-            echo self::$nl . ' . timestamp: ' . $timestamp;
-            echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
+            echo self::$nl.' . time(): '.time();
+            echo self::$nl.' . time() as date: '.date('Y-m-d H:i a');
+            echo self::$nl.' . session expiration: '.$session_lifespan->expiration();
+            echo self::$nl.' . session expiration as date: '.date('Y-m-d H:i a', $session_lifespan->expiration());
+            echo self::$nl.' . timestamp: '.$timestamp;
+            echo self::$nl.' . $expired_ticket_line_items: '.count($expired_ticket_line_items);
         }
-        if (! empty($expired_ticket_line_items)) {
+        if ( ! empty($expired_ticket_line_items)) {
             foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
-                if (! $expired_ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $expired_ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                $expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
+                $expired_ticket_IDs[$expired_ticket_line_item->OBJ_ID()] = $expired_ticket_line_item->OBJ_ID();
                 if (self::debug) {
-                    echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
-                    echo self::$nl . ' . $expired_ticket_line_item->timestamp(): '
+                    echo self::$nl.' . $expired_ticket_line_item->OBJ_ID(): '.$expired_ticket_line_item->OBJ_ID();
+                    echo self::$nl.' . $expired_ticket_line_item->timestamp(): '
                          . date(
                              'Y-m-d h:i a',
                              $expired_ticket_line_item->timestamp(true)
                          );
                 }
             }
-            if (! empty($expired_ticket_IDs)) {
+            if ( ! empty($expired_ticket_IDs)) {
                 EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
                     \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
                     array(),
@@ -255,8 +255,8 @@ 
         }
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-            echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
+            echo self::$nl.self::$nl.'<b> RETURNED QTY: '.$qty.'</b>';
         }
         return $qty;
     }
@@ -275,36 +275,36 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             return 0;
         }
         if (self::debug) {
-            echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
+            echo self::$nl.'<b> . ticket->ID: '.$ticket->ID().'</b>';
+            echo self::$nl.' . original ticket->reserved: '.$ticket->reserved();
         }
         $ticket->refresh_from_db();
         // first let's determine the ticket availability based on sales
         $available = $ticket->qty('saleable');
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
-            echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-            echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo self::$nl . ' . . . available: ' . $available;
+            echo self::$nl.' . . . ticket->qty: '.$ticket->qty();
+            echo self::$nl.' . . . ticket->sold: '.$ticket->sold();
+            echo self::$nl.' . . . ticket->reserved: '.$ticket->reserved();
+            echo self::$nl.' . . . ticket->qty(saleable): '.$ticket->qty('saleable');
+            echo self::$nl.' . . . available: '.$available;
         }
         if ($available < 1) {
             $this->_ticket_sold_out($ticket);
             return 0;
         }
         if (self::debug) {
-            echo self::$nl . ' . . . qty: ' . $qty;
+            echo self::$nl.' . . . qty: '.$qty;
         }
         if ($available < $qty) {
             $qty = $available;
             if (self::debug) {
-                echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
+                echo self::$nl.' . . . QTY ADJUSTED: '.$qty;
             }
             $this->_ticket_quantity_decremented($ticket);
         }
@@ -328,9 +328,9 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
+            echo self::$nl.self::$nl.' . . . INCREASE RESERVED: '.$quantity;
         }
-        return $ticket->increaseReserved($quantity, 'TicketSalesMonitor:' . __LINE__);
+        return $ticket->increaseReserved($quantity, 'TicketSalesMonitor:'.__LINE__);
     }
 
 
@@ -344,12 +344,12 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
-            echo self::$nl . ' . . . ticket->reserved before: ' . $ticket->reserved();
+            echo self::$nl.' . . . ticket->ID: '.$ticket->ID();
+            echo self::$nl.' . . . ticket->reserved before: '.$ticket->reserved();
         }
-        $ticket->decreaseReserved($quantity, true, 'TicketSalesMonitor:' . __LINE__);
+        $ticket->decreaseReserved($quantity, true, 'TicketSalesMonitor:'.__LINE__);
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->reserved after: ' . $ticket->reserved();
+            echo self::$nl.' . . . ticket->reserved after: '.$ticket->reserved();
         }
         return $ticket->save() ? 1 : 0;
     }
@@ -367,8 +367,8 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -386,8 +386,8 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -438,7 +438,7 @@ 
         if ($ticket instanceof EE_Ticket) {
             $ticket->add_extra_meta(
                 EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                __LINE__ . ') ' . __METHOD__ . '()'
+                __LINE__.') '.__METHOD__.'()'
             );
             if ($quantity > 0) {
                 EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
@@ -461,7 +461,7 @@ 
     {
         $ticket->add_extra_meta(
             EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-            __LINE__ . ') ' . __METHOD__ . '()'
+            __LINE__.') '.__METHOD__.'()'
         );
         EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
     }
@@ -497,7 +497,7 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         $refresh_msg = '';
         $none_added_msg = '';
@@ -508,7 +508,7 @@ 
             );
             $none_added_msg = esc_html__('No tickets were added for the event.', 'event_espresso');
         }
-        if (! empty($this->sold_out_tickets)) {
+        if ( ! empty($this->sold_out_tickets)) {
             EE_Error::add_attention(
                 sprintf(
                     apply_filters(
@@ -531,7 +531,7 @@ 
             // and reset the cart
             EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
         }
-        if (! empty($this->decremented_tickets)) {
+        if ( ! empty($this->decremented_tickets)) {
             EE_Error::add_attention(
                 sprintf(
                     apply_filters(
@@ -569,9 +569,9 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
-            echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . transaction->ID: '.$transaction->ID();
+            echo self::$nl.' . TXN status_ID: '.$transaction->status_ID();
         }
         // check if 'finalize_registration' step has been completed...
         $finalized = $transaction->reg_step_completed('finalize_registration');
@@ -583,13 +583,13 @@ 
                 __LINE__,
                 array('finalized' => $finalized),
                 false,
-                'EE_Transaction: ' . $transaction->ID()
+                'EE_Transaction: '.$transaction->ID()
             );
         }
         // how many tickets were released
         $count = 0;
         if (self::debug) {
-            echo self::$nl . ' . . . TXN finalized: ' . $finalized;
+            echo self::$nl.' . . . TXN finalized: '.$finalized;
         }
         $release_tickets_with_TXN_status = array(
             EEM_Transaction::failed_status_code,
@@ -598,28 +598,28 @@ 
         );
         $events = array();
         // if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
-        if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+        if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
             // cancel any reserved tickets for registrations that were not approved
             $registrations = $transaction->registrations();
             if (self::debug) {
-                echo self::$nl . ' . . . # registrations: ' . count($registrations);
+                echo self::$nl.' . . . # registrations: '.count($registrations);
                 $reg = reset($registrations);
                 $ticket = $reg->ticket();
                 if ($ticket instanceof EE_Ticket) {
                     $ticket->add_extra_meta(
                         EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
+                        __LINE__.') Release All Tickets TXN:'.$transaction->ID()
                     );
                 }
             }
-            if (! empty($registrations)) {
+            if ( ! empty($registrations)) {
                 foreach ($registrations as $registration) {
                     if (
                         $registration instanceof EE_Registration
                         && $this->_release_reserved_ticket_for_registration($registration, $transaction)
                     ) {
                         $count++;
-                        $events[ $registration->event_ID() ] = $registration->event();
+                        $events[$registration->event_ID()] = $registration->event();
                     }
                 }
             }
@@ -650,10 +650,10 @@ 
         $STS_ID = $transaction->status_ID();
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . registration->ID: ' . $registration->ID();
-            echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
-            echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . registration->ID: '.$registration->ID();
+            echo self::$nl.' . . registration->status_ID: '.$registration->status_ID();
+            echo self::$nl.' . . transaction->status_ID(): '.$STS_ID;
         }
         if (
 // release Tickets for Failed Transactions and Abandoned Transactions
@@ -666,12 +666,12 @@ 
             )
         ) {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
+                echo self::$nl.self::$nl.' . . RELEASE RESERVED TICKET';
                 $rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-                echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
+                echo self::$nl.' . . . registration HAS_RESERVED_TICKET_KEY: ';
                 var_dump($rsrvd);
             }
-            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:' . __LINE__);
+            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:'.__LINE__);
             return 1;
         }
         return 0;
@@ -701,7 +701,7 @@ 
         }
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         // first check of the session has a valid Checkout object
         $checkout = $session->checkout();
@@ -713,12 +713,12 @@ 
         $cart = $session->cart();
         if ($cart instanceof EE_Cart) {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
+                echo self::$nl.self::$nl.' cart instance of EE_Cart: ';
             }
             EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
         } else {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' invalid EE_Cart: ';
+                echo self::$nl.self::$nl.' invalid EE_Cart: ';
                 var_export($cart, true);
             }
         }
@@ -740,39 +740,39 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         $ticket_line_items = $cart->get_tickets();
         if (empty($ticket_line_items)) {
             return;
         }
         if (self::debug) {
-            echo '<br /> . ticket_line_item count: ' . count($ticket_line_items);
+            echo '<br /> . ticket_line_item count: '.count($ticket_line_items);
         }
         foreach ($ticket_line_items as $ticket_line_item) {
             if (self::debug) {
-                echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+                echo self::$nl.' . ticket_line_item->ID(): '.$ticket_line_item->ID();
             }
             if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
                 if (self::debug) {
-                    echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+                    echo self::$nl.' . . ticket_line_item->OBJ_ID(): '.$ticket_line_item->OBJ_ID();
                 }
                 $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
                 if ($ticket instanceof EE_Ticket) {
                     if (self::debug) {
-                        echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
-                        echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+                        echo self::$nl.' . . ticket->ID(): '.$ticket->ID();
+                        echo self::$nl.' . . ticket_line_item->quantity(): '.$ticket_line_item->quantity();
                     }
                     $ticket->add_extra_meta(
                         EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
+                        __LINE__.') '.__METHOD__.'() SID = '.$session->id()
                     );
                     $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
                 }
             }
         }
         if (self::debug) {
-            echo self::$nl . self::$nl . ' RESET COMPLETED ';
+            echo self::$nl.self::$nl.' RESET COMPLETED ';
         }
     }
 
@@ -814,7 +814,7 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
         if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
@@ -863,7 +863,7 @@ 
                     __LINE__,
                     array($transaction),
                     false,
-                    'EE_Transaction: ' . $transaction->ID()
+                    'EE_Transaction: '.$transaction->ID()
                 );
             }
             return;
@@ -880,7 +880,7 @@ 
                         __LINE__,
                         array($payment),
                         false,
-                        'EE_Transaction: ' . $transaction->ID()
+                        'EE_Transaction: '.$transaction->ID()
                     );
                 }
                 return;
@@ -942,7 +942,7 @@ 
             }
             $total_line_item = $transaction->total_line_item();
             // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
+            if ( ! $total_line_item instanceof EE_Line_Item) {
                 throw new DomainException(
                     esc_html__(
                         'Transaction does not have a valid Total Line Item associated with it.',
@@ -980,7 +980,7 @@ 
         $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
         foreach ($ticket_line_items as $ticket_line_item) {
             if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[ $ticket_line_item->ID() ] = $ticket_line_item;
+                $valid_reserved_tickets[$ticket_line_item->ID()] = $ticket_line_item;
             }
         }
         return $valid_reserved_tickets;
@@ -1013,7 +1013,7 @@ 
         $total_tickets_released = 0;
         $sold_out_events = array();
         foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
+            if ( ! $ticket_with_reservations instanceof EE_Ticket) {
                 continue;
             }
             // The $valid_reserved_ticket_line_items tells us what the reserved count on their tickets (and datetimes)
@@ -1035,9 +1035,9 @@ 
             if ($expired_reservations_count > 0) {
                 $ticket_with_reservations->add_extra_meta(
                     EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                    __LINE__ . ') ' . $source . '()'
+                    __LINE__.') '.$source.'()'
                 );
-                $ticket_with_reservations->decreaseReserved($expired_reservations_count, true, 'TicketSalesMonitor:' . __LINE__);
+                $ticket_with_reservations->decreaseReserved($expired_reservations_count, true, 'TicketSalesMonitor:'.__LINE__);
                 $total_tickets_released += $expired_reservations_count;
                 $event = $ticket_with_reservations->get_related_event();
                 // track sold out events
@@ -1073,7 +1073,7 @@ 
     {
         /** @type WPDB $wpdb */
         global $wpdb;
-        if (! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'
@@ -1082,7 +1082,7 @@ 
         }
         return $wpdb->query(
             $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+                'DELETE FROM '.EEM_Line_Item::instance()->table().'
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
                 // use GMT time because that's what LIN_timestamps are in
                 date('Y-m-d H:i:s', $timestamp)

Indentation +1067 added lines, -1067 removed lines

@@ -19,1073 +19,1073 @@
  */
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
-    const debug = false;
-
-    private static $nl = '';
-
-    /**
-     * an array of raw ticket data from EED_Ticket_Selector
-     *
-     * @var array $ticket_selections
-     */
-    protected $ticket_selections = array();
-
-    /**
-     * the raw ticket data from EED_Ticket_Selector is organized in rows
-     * according to how they are displayed in the actual Ticket_Selector
-     * this tracks the current row being processed
-     *
-     * @var int $current_row
-     */
-    protected $current_row = 0;
-
-    /**
-     * an array for tracking names of tickets that have sold out
-     *
-     * @var array $sold_out_tickets
-     */
-    protected $sold_out_tickets = array();
-
-    /**
-     * an array for tracking names of tickets that have had their quantities reduced
-     *
-     * @var array $decremented_tickets
-     */
-    protected $decremented_tickets = array();
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::$nl = defined('EE_TESTS_DIR') ? "\n" : '<br />';
-        // release tickets for expired carts
-        add_action(
-            'EED_Ticket_Selector__process_ticket_selections__before',
-            array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
-            1
-        );
-        // check ticket reserves AFTER MER does it's check (hence priority 20)
-        add_filter(
-            'FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
-            array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
-            20,
-            3
-        );
-        // add notices for sold out tickets
-        add_action(
-            'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            array('EED_Ticket_Sales_Monitor', 'post_notices'),
-            10
-        );
-
-        // handle tickets deleted from cart
-        add_action(
-            'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
-            array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
-            10,
-            2
-        );
-        // handle emptied carts
-        add_action(
-            'AHEE__EE_Session__reset_cart__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10,
-            1
-        );
-        // handle cancelled registrations
-        add_action(
-            'AHEE__EE_Session__reset_checkout__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
-            10,
-            1
-        );
-        // cron tasks
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
-            10,
-            1
-        );
-    }
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Ticket_Sales_Monitor::set_hooks();
-    }
-
-
-    /**
-     * @return EED_Ticket_Sales_Monitor|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return    void
-     */
-    public function run($WP_Query)
-    {
-    }
-
-
-
-    /********************************** PRE_TICKET_SALES  **********************************/
-
-
-    /**
-     * Retrieves grand totals from the line items that have no TXN ID
-     * and timestamps less than the current time minus the session lifespan.
-     * These are carts that have been abandoned before the "registrant" even attempted to checkout.
-     * We're going to release the tickets for these line items before attempting to add more to the cart.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     */
-    public static function release_tickets_for_expired_carts()
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-        }
-        do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
-        $expired_ticket_IDs = array();
-        /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-        $session_lifespan = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\values\session\SessionLifespan'
-        );
-        $timestamp = $session_lifespan->expiration();
-        $expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
-        if (self::debug) {
-            echo self::$nl . ' . time(): ' . time();
-            echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
-            echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
-            echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
-            echo self::$nl . ' . timestamp: ' . $timestamp;
-            echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
-        }
-        if (! empty($expired_ticket_line_items)) {
-            foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
-                if (! $expired_ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
-                if (self::debug) {
-                    echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
-                    echo self::$nl . ' . $expired_ticket_line_item->timestamp(): '
-                         . date(
-                             'Y-m-d h:i a',
-                             $expired_ticket_line_item->timestamp(true)
-                         );
-                }
-            }
-            if (! empty($expired_ticket_IDs)) {
-                EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-                    \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
-                    array(),
-                    __FUNCTION__
-                );
-                // now  let's get rid of expired line items so that they can't interfere with tracking
-                EED_Ticket_Sales_Monitor::clear_expired_line_items_with_no_transaction($timestamp);
-            }
-        }
-        do_action(
-            'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
-            $expired_ticket_IDs,
-            $expired_ticket_line_items
-        );
-    }
-
-
-
-    /********************************** VALIDATE_TICKET_SALE  **********************************/
-
-
-    /**
-     * callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
-     *
-     * @param int       $qty
-     * @param EE_Ticket $ticket
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public static function validate_ticket_sale($qty, EE_Ticket $ticket)
-    {
-        $qty = absint($qty);
-        if ($qty > 0) {
-            $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
-        }
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-            echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
-        }
-        return $qty;
-    }
-
-
-    /**
-     * checks whether an individual ticket is available for purchase based on datetime, and ticket details
-     *
-     * @param   EE_Ticket $ticket
-     * @param int         $qty
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        if (! $ticket instanceof EE_Ticket) {
-            return 0;
-        }
-        if (self::debug) {
-            echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->refresh_from_db();
-        // first let's determine the ticket availability based on sales
-        $available = $ticket->qty('saleable');
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
-            echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-            echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo self::$nl . ' . . . available: ' . $available;
-        }
-        if ($available < 1) {
-            $this->_ticket_sold_out($ticket);
-            return 0;
-        }
-        if (self::debug) {
-            echo self::$nl . ' . . . qty: ' . $qty;
-        }
-        if ($available < $qty) {
-            $qty = $available;
-            if (self::debug) {
-                echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
-            }
-            $this->_ticket_quantity_decremented($ticket);
-        }
-        if ($this->_reserve_ticket($ticket, $qty)) {
-            return $qty;
-        } else {
-            return 0;
-        }
-    }
-
-
-    /**
-     * increments ticket reserved based on quantity passed
-     *
-     * @param    EE_Ticket $ticket
-     * @param int          $quantity
-     * @return bool indicating success or failure
-     * @throws EE_Error
-     */
-    protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
-        }
-        return $ticket->increaseReserved($quantity, 'TicketSalesMonitor:' . __LINE__);
-    }
-
-
-    /**
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
-            echo self::$nl . ' . . . ticket->reserved before: ' . $ticket->reserved();
-        }
-        $ticket->decreaseReserved($quantity, true, 'TicketSalesMonitor:' . __LINE__);
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->reserved after: ' . $ticket->reserved();
-        }
-        return $ticket->save() ? 1 : 0;
-    }
-
-
-    /**
-     * removes quantities within the ticket selector based on zero ticket availability
-     *
-     * @param    EE_Ticket $ticket
-     * @return    void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_sold_out(EE_Ticket $ticket)
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-    /**
-     * adjusts quantities within the ticket selector based on decreased ticket availability
-     *
-     * @param    EE_Ticket $ticket
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_quantity_decremented(EE_Ticket $ticket)
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-    /**
-     * builds string out of ticket and event name
-     *
-     * @param    EE_Ticket $ticket
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_and_event_name(EE_Ticket $ticket)
-    {
-        $event = $ticket->get_related_event();
-        if ($event instanceof EE_Event) {
-            $ticket_name = sprintf(
-                _x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
-                $ticket->name(),
-                $event->name()
-            );
-        } else {
-            $ticket_name = $ticket->name();
-        }
-        return $ticket_name;
-    }
-
-
-
-    /********************************** EVENT CART  **********************************/
-
-
-    /**
-     * releases or reserves ticket(s) based on quantity passed
-     *
-     * @param  EE_Line_Item $line_item
-     * @param  int          $quantity
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
-        if ($ticket instanceof EE_Ticket) {
-            $ticket->add_extra_meta(
-                EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                __LINE__ . ') ' . __METHOD__ . '()'
-            );
-            if ($quantity > 0) {
-                EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
-            } else {
-                EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-            }
-        }
-    }
-
-
-    /**
-     * releases reserved ticket(s) based on quantity passed
-     *
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
-    {
-        $ticket->add_extra_meta(
-            EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-            __LINE__ . ') ' . __METHOD__ . '()'
-        );
-        EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-    }
-
-
-
-    /********************************** POST_NOTICES  **********************************/
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function post_notices()
-    {
-        EED_Ticket_Sales_Monitor::instance()->_post_notices();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _post_notices()
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $refresh_msg = '';
-        $none_added_msg = '';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $refresh_msg = esc_html__(
-                'Please refresh the page to view updated ticket quantities.',
-                'event_espresso'
-            );
-            $none_added_msg = esc_html__('No tickets were added for the event.', 'event_espresso');
-        }
-        if (! empty($this->sold_out_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
-                        esc_html__(
-                            'We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso'
-                        )
-                    ),
-                    '<br />',
-                    implode('<br />', $this->sold_out_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            // alter code flow in the Ticket Selector for better UX
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
-            $this->sold_out_tickets = array();
-            // and reset the cart
-            EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
-        }
-        if (! empty($this->decremented_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
-                        esc_html__(
-                            'We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso'
-                        )
-                    ),
-                    '<br />',
-                    implode('<br />', $this->decremented_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            $this->decremented_tickets = array();
-        }
-    }
-
-
-
-    /********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
-
-
-    /**
-     * releases reserved tickets for all registrations of an EE_Transaction
-     * by default, will NOT release tickets for finalized transactions
-     *
-     * @param    EE_Transaction $transaction
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
-            echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
-        }
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        if (self::debug) {
-            // DEBUG LOG
-            EEH_Debug_Tools::log(
-                __CLASS__,
-                __FUNCTION__,
-                __LINE__,
-                array('finalized' => $finalized),
-                false,
-                'EE_Transaction: ' . $transaction->ID()
-            );
-        }
-        // how many tickets were released
-        $count = 0;
-        if (self::debug) {
-            echo self::$nl . ' . . . TXN finalized: ' . $finalized;
-        }
-        $release_tickets_with_TXN_status = array(
-            EEM_Transaction::failed_status_code,
-            EEM_Transaction::abandoned_status_code,
-            EEM_Transaction::incomplete_status_code,
-        );
-        $events = array();
-        // if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
-        if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
-            // cancel any reserved tickets for registrations that were not approved
-            $registrations = $transaction->registrations();
-            if (self::debug) {
-                echo self::$nl . ' . . . # registrations: ' . count($registrations);
-                $reg = reset($registrations);
-                $ticket = $reg->ticket();
-                if ($ticket instanceof EE_Ticket) {
-                    $ticket->add_extra_meta(
-                        EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
-                    );
-                }
-            }
-            if (! empty($registrations)) {
-                foreach ($registrations as $registration) {
-                    if (
-                        $registration instanceof EE_Registration
-                        && $this->_release_reserved_ticket_for_registration($registration, $transaction)
-                    ) {
-                        $count++;
-                        $events[ $registration->event_ID() ] = $registration->event();
-                    }
-                }
-            }
-        }
-        if ($events !== array()) {
-            foreach ($events as $event) {
-                /** @var EE_Event $event */
-                $event->perform_sold_out_status_check();
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * releases reserved tickets for an EE_Registration
-     * by default, will NOT release tickets for APPROVED registrations
-     *
-     * @param EE_Registration $registration
-     * @param EE_Transaction  $transaction
-     * @return int
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket_for_registration(
-        EE_Registration $registration,
-        EE_Transaction $transaction
-    ) {
-        $STS_ID = $transaction->status_ID();
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . registration->ID: ' . $registration->ID();
-            echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
-            echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
-        }
-        if (
+	const debug = false;
+
+	private static $nl = '';
+
+	/**
+	 * an array of raw ticket data from EED_Ticket_Selector
+	 *
+	 * @var array $ticket_selections
+	 */
+	protected $ticket_selections = array();
+
+	/**
+	 * the raw ticket data from EED_Ticket_Selector is organized in rows
+	 * according to how they are displayed in the actual Ticket_Selector
+	 * this tracks the current row being processed
+	 *
+	 * @var int $current_row
+	 */
+	protected $current_row = 0;
+
+	/**
+	 * an array for tracking names of tickets that have sold out
+	 *
+	 * @var array $sold_out_tickets
+	 */
+	protected $sold_out_tickets = array();
+
+	/**
+	 * an array for tracking names of tickets that have had their quantities reduced
+	 *
+	 * @var array $decremented_tickets
+	 */
+	protected $decremented_tickets = array();
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::$nl = defined('EE_TESTS_DIR') ? "\n" : '<br />';
+		// release tickets for expired carts
+		add_action(
+			'EED_Ticket_Selector__process_ticket_selections__before',
+			array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
+			1
+		);
+		// check ticket reserves AFTER MER does it's check (hence priority 20)
+		add_filter(
+			'FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
+			array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
+			20,
+			3
+		);
+		// add notices for sold out tickets
+		add_action(
+			'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			array('EED_Ticket_Sales_Monitor', 'post_notices'),
+			10
+		);
+
+		// handle tickets deleted from cart
+		add_action(
+			'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
+			array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
+			10,
+			2
+		);
+		// handle emptied carts
+		add_action(
+			'AHEE__EE_Session__reset_cart__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10,
+			1
+		);
+		// handle cancelled registrations
+		add_action(
+			'AHEE__EE_Session__reset_checkout__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
+			10,
+			1
+		);
+		// cron tasks
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Ticket_Sales_Monitor::set_hooks();
+	}
+
+
+	/**
+	 * @return EED_Ticket_Sales_Monitor|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function run($WP_Query)
+	{
+	}
+
+
+
+	/********************************** PRE_TICKET_SALES  **********************************/
+
+
+	/**
+	 * Retrieves grand totals from the line items that have no TXN ID
+	 * and timestamps less than the current time minus the session lifespan.
+	 * These are carts that have been abandoned before the "registrant" even attempted to checkout.
+	 * We're going to release the tickets for these line items before attempting to add more to the cart.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 */
+	public static function release_tickets_for_expired_carts()
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+		}
+		do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
+		$expired_ticket_IDs = array();
+		/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+		$session_lifespan = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\values\session\SessionLifespan'
+		);
+		$timestamp = $session_lifespan->expiration();
+		$expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
+		if (self::debug) {
+			echo self::$nl . ' . time(): ' . time();
+			echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
+			echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
+			echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
+			echo self::$nl . ' . timestamp: ' . $timestamp;
+			echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
+		}
+		if (! empty($expired_ticket_line_items)) {
+			foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
+				if (! $expired_ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
+				if (self::debug) {
+					echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
+					echo self::$nl . ' . $expired_ticket_line_item->timestamp(): '
+						 . date(
+							 'Y-m-d h:i a',
+							 $expired_ticket_line_item->timestamp(true)
+						 );
+				}
+			}
+			if (! empty($expired_ticket_IDs)) {
+				EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+					\EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
+					array(),
+					__FUNCTION__
+				);
+				// now  let's get rid of expired line items so that they can't interfere with tracking
+				EED_Ticket_Sales_Monitor::clear_expired_line_items_with_no_transaction($timestamp);
+			}
+		}
+		do_action(
+			'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
+			$expired_ticket_IDs,
+			$expired_ticket_line_items
+		);
+	}
+
+
+
+	/********************************** VALIDATE_TICKET_SALE  **********************************/
+
+
+	/**
+	 * callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
+	 *
+	 * @param int       $qty
+	 * @param EE_Ticket $ticket
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public static function validate_ticket_sale($qty, EE_Ticket $ticket)
+	{
+		$qty = absint($qty);
+		if ($qty > 0) {
+			$qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
+		}
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+			echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
+		}
+		return $qty;
+	}
+
+
+	/**
+	 * checks whether an individual ticket is available for purchase based on datetime, and ticket details
+	 *
+	 * @param   EE_Ticket $ticket
+	 * @param int         $qty
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		if (! $ticket instanceof EE_Ticket) {
+			return 0;
+		}
+		if (self::debug) {
+			echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
+			echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->refresh_from_db();
+		// first let's determine the ticket availability based on sales
+		$available = $ticket->qty('saleable');
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
+			echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
+			echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
+			echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
+			echo self::$nl . ' . . . available: ' . $available;
+		}
+		if ($available < 1) {
+			$this->_ticket_sold_out($ticket);
+			return 0;
+		}
+		if (self::debug) {
+			echo self::$nl . ' . . . qty: ' . $qty;
+		}
+		if ($available < $qty) {
+			$qty = $available;
+			if (self::debug) {
+				echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
+			}
+			$this->_ticket_quantity_decremented($ticket);
+		}
+		if ($this->_reserve_ticket($ticket, $qty)) {
+			return $qty;
+		} else {
+			return 0;
+		}
+	}
+
+
+	/**
+	 * increments ticket reserved based on quantity passed
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @param int          $quantity
+	 * @return bool indicating success or failure
+	 * @throws EE_Error
+	 */
+	protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
+		}
+		return $ticket->increaseReserved($quantity, 'TicketSalesMonitor:' . __LINE__);
+	}
+
+
+	/**
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
+			echo self::$nl . ' . . . ticket->reserved before: ' . $ticket->reserved();
+		}
+		$ticket->decreaseReserved($quantity, true, 'TicketSalesMonitor:' . __LINE__);
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->reserved after: ' . $ticket->reserved();
+		}
+		return $ticket->save() ? 1 : 0;
+	}
+
+
+	/**
+	 * removes quantities within the ticket selector based on zero ticket availability
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return    void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_sold_out(EE_Ticket $ticket)
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+	/**
+	 * adjusts quantities within the ticket selector based on decreased ticket availability
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_quantity_decremented(EE_Ticket $ticket)
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+	/**
+	 * builds string out of ticket and event name
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_and_event_name(EE_Ticket $ticket)
+	{
+		$event = $ticket->get_related_event();
+		if ($event instanceof EE_Event) {
+			$ticket_name = sprintf(
+				_x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
+				$ticket->name(),
+				$event->name()
+			);
+		} else {
+			$ticket_name = $ticket->name();
+		}
+		return $ticket_name;
+	}
+
+
+
+	/********************************** EVENT CART  **********************************/
+
+
+	/**
+	 * releases or reserves ticket(s) based on quantity passed
+	 *
+	 * @param  EE_Line_Item $line_item
+	 * @param  int          $quantity
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
+		if ($ticket instanceof EE_Ticket) {
+			$ticket->add_extra_meta(
+				EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+				__LINE__ . ') ' . __METHOD__ . '()'
+			);
+			if ($quantity > 0) {
+				EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
+			} else {
+				EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+			}
+		}
+	}
+
+
+	/**
+	 * releases reserved ticket(s) based on quantity passed
+	 *
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
+	{
+		$ticket->add_extra_meta(
+			EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+			__LINE__ . ') ' . __METHOD__ . '()'
+		);
+		EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+	}
+
+
+
+	/********************************** POST_NOTICES  **********************************/
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function post_notices()
+	{
+		EED_Ticket_Sales_Monitor::instance()->_post_notices();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _post_notices()
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$refresh_msg = '';
+		$none_added_msg = '';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$refresh_msg = esc_html__(
+				'Please refresh the page to view updated ticket quantities.',
+				'event_espresso'
+			);
+			$none_added_msg = esc_html__('No tickets were added for the event.', 'event_espresso');
+		}
+		if (! empty($this->sold_out_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
+						esc_html__(
+							'We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso'
+						)
+					),
+					'<br />',
+					implode('<br />', $this->sold_out_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			// alter code flow in the Ticket Selector for better UX
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
+			$this->sold_out_tickets = array();
+			// and reset the cart
+			EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
+		}
+		if (! empty($this->decremented_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
+						esc_html__(
+							'We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso'
+						)
+					),
+					'<br />',
+					implode('<br />', $this->decremented_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			$this->decremented_tickets = array();
+		}
+	}
+
+
+
+	/********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
+
+
+	/**
+	 * releases reserved tickets for all registrations of an EE_Transaction
+	 * by default, will NOT release tickets for finalized transactions
+	 *
+	 * @param    EE_Transaction $transaction
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
+			echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
+		}
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		if (self::debug) {
+			// DEBUG LOG
+			EEH_Debug_Tools::log(
+				__CLASS__,
+				__FUNCTION__,
+				__LINE__,
+				array('finalized' => $finalized),
+				false,
+				'EE_Transaction: ' . $transaction->ID()
+			);
+		}
+		// how many tickets were released
+		$count = 0;
+		if (self::debug) {
+			echo self::$nl . ' . . . TXN finalized: ' . $finalized;
+		}
+		$release_tickets_with_TXN_status = array(
+			EEM_Transaction::failed_status_code,
+			EEM_Transaction::abandoned_status_code,
+			EEM_Transaction::incomplete_status_code,
+		);
+		$events = array();
+		// if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
+		if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+			// cancel any reserved tickets for registrations that were not approved
+			$registrations = $transaction->registrations();
+			if (self::debug) {
+				echo self::$nl . ' . . . # registrations: ' . count($registrations);
+				$reg = reset($registrations);
+				$ticket = $reg->ticket();
+				if ($ticket instanceof EE_Ticket) {
+					$ticket->add_extra_meta(
+						EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+						__LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
+					);
+				}
+			}
+			if (! empty($registrations)) {
+				foreach ($registrations as $registration) {
+					if (
+						$registration instanceof EE_Registration
+						&& $this->_release_reserved_ticket_for_registration($registration, $transaction)
+					) {
+						$count++;
+						$events[ $registration->event_ID() ] = $registration->event();
+					}
+				}
+			}
+		}
+		if ($events !== array()) {
+			foreach ($events as $event) {
+				/** @var EE_Event $event */
+				$event->perform_sold_out_status_check();
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * releases reserved tickets for an EE_Registration
+	 * by default, will NOT release tickets for APPROVED registrations
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Transaction  $transaction
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket_for_registration(
+		EE_Registration $registration,
+		EE_Transaction $transaction
+	) {
+		$STS_ID = $transaction->status_ID();
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . registration->ID: ' . $registration->ID();
+			echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
+			echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
+		}
+		if (
 // release Tickets for Failed Transactions and Abandoned Transactions
-            $STS_ID === EEM_Transaction::failed_status_code
-            || $STS_ID === EEM_Transaction::abandoned_status_code
-            || (
-                // also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
-                $STS_ID === EEM_Transaction::incomplete_status_code
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-            )
-        ) {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
-                $rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-                echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
-                var_dump($rsrvd);
-            }
-            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:' . __LINE__);
-            return 1;
-        }
-        return 0;
-    }
-
-
-
-    /********************************** SESSION_CART_RESET  **********************************/
-
-
-    /**
-     * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
-     *
-     * @param EE_Session $session
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function session_cart_reset(EE_Session $session)
-    {
-        // don't release tickets if checkout was already reset
-        if (did_action('AHEE__EE_Session__reset_checkout__before_reset')) {
-            return;
-        }
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // first check of the session has a valid Checkout object
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            // and use that to clear ticket reservations because it will update the associated registration meta data
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-            return;
-        }
-        $cart = $session->cart();
-        if ($cart instanceof EE_Cart) {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
-            }
-            EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
-        } else {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' invalid EE_Cart: ';
-                var_export($cart, true);
-            }
-        }
-    }
-
-
-    /**
-     * releases reserved tickets in the EE_Cart
-     *
-     * @param EE_Cart $cart
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _session_cart_reset(EE_Cart $cart, EE_Session $session)
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $ticket_line_items = $cart->get_tickets();
-        if (empty($ticket_line_items)) {
-            return;
-        }
-        if (self::debug) {
-            echo '<br /> . ticket_line_item count: ' . count($ticket_line_items);
-        }
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (self::debug) {
-                echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
-            }
-            if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
-                if (self::debug) {
-                    echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
-                }
-                $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
-                if ($ticket instanceof EE_Ticket) {
-                    if (self::debug) {
-                        echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
-                        echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
-                    }
-                    $ticket->add_extra_meta(
-                        EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
-                    );
-                    $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
-                }
-            }
-        }
-        if (self::debug) {
-            echo self::$nl . self::$nl . ' RESET COMPLETED ';
-        }
-    }
-
-
-
-    /********************************** SESSION_CHECKOUT_RESET  **********************************/
-
-
-    /**
-     * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
-     *
-     * @param EE_Session $session
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function session_checkout_reset(EE_Session $session)
-    {
-        // don't release tickets if cart was already reset
-        if (did_action('AHEE__EE_Session__reset_cart__before_reset')) {
-            return;
-        }
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-        }
-    }
-
-
-    /**
-     * releases reserved tickets for the EE_Checkout->transaction
-     *
-     * @param EE_Checkout $checkout
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    protected function _session_checkout_reset(EE_Checkout $checkout)
-    {
-        // self::debug hardcoded to false
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
-        if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
-    }
-
-
-
-    /********************************** SESSION_EXPIRED_RESET  **********************************/
-
-
-    /**
-     * @param    EE_Session $session
-     * @return    void
-     */
-    public static function session_expired_reset(EE_Session $session)
-    {
-    }
-
-
-
-    /********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
-
-
-    /**
-     * releases reserved tickets for all registrations of an ABANDONED EE_Transaction
-     * by default, will NOT release tickets for free transactions, or any that have received a payment
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function process_abandoned_transactions(EE_Transaction $transaction)
-    {
-        // is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
-        if ($transaction->is_free() || $transaction->paid() > 0) {
-            // self::debug hardcoded to false
-            if (self::debug) {
-                // DEBUG LOG
-                EEH_Debug_Tools::log(
-                    __CLASS__,
-                    __FUNCTION__,
-                    __LINE__,
-                    array($transaction),
-                    false,
-                    'EE_Transaction: ' . $transaction->ID()
-                );
-            }
-            return;
-        }
-        // have their been any successful payments made ?
-        $payments = $transaction->payments();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
-                if (self::debug) {
-                    // DEBUG LOG
-                    EEH_Debug_Tools::log(
-                        __CLASS__,
-                        __FUNCTION__,
-                        __LINE__,
-                        array($payment),
-                        false,
-                        'EE_Transaction: ' . $transaction->ID()
-                    );
-                }
-                return;
-            }
-        }
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
-
-
-    /**
-     * releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function process_failed_transactions(EE_Transaction $transaction)
-    {
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** RESET RESERVATION COUNTS  *********************************/
-
-
-    /**
-     * Resets the ticket and datetime reserved counts.
-     *
-     * For all the tickets with reservations, recalculates what their actual reserved counts should be based
-     * on the valid transactions.
-     *
-     * @return int number of tickets whose reservations were released.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws UnexpectedEntityException
-     * @throws ReflectionException
-     */
-    public static function reset_reservation_counts()
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        /** @var EE_Transaction[] $transactions_in_progress */
-        $transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
-        foreach ($transactions_in_progress as $transaction) {
-            // if this TXN has been fully completed, then skip it
-            if ($transaction->reg_step_completed('finalize_registration')) {
-                continue;
-            }
-            $total_line_item = $transaction->total_line_item();
-            // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
-                throw new DomainException(
-                    esc_html__(
-                        'Transaction does not have a valid Total Line Item associated with it.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
-        foreach ($total_line_items as $total_line_item) {
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $tickets_with_reservations = EEM_Ticket::instance()->get_tickets_with_reservations();
-        return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-            $tickets_with_reservations,
-            $valid_reserved_tickets,
-            __FUNCTION__
-        );
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return EE_Line_Item[]
-     */
-    private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[ $ticket_line_item->ID() ] = $ticket_line_item;
-            }
-        }
-        return $valid_reserved_tickets;
-    }
-
-
-    /**
-     * Releases ticket and datetime reservations (ie, reduces the number of reserved spots on them).
-     *
-     * Given the list of tickets which have reserved spots on them, uses the complete list of line items for tickets
-     * whose transactions aren't complete and also aren't yet expired (ie, they're incomplete and younger than the
-     * session's expiry time) to update the ticket (and their datetimes') reserved counts.
-     *
-     * @param EE_Ticket[]    $tickets_with_reservations all tickets with TKT_reserved > 0
-     * @param EE_Line_Item[] $valid_reserved_ticket_line_items all line items for tickets and incomplete transactions
-     *                       whose session has NOT expired. We will use these to determine the number of ticket
-     *                       reservations are now invalid. We don't use the list of invalid ticket line items because
-     *                       we don't know which of those have already been taken into account when reducing ticket
-     *                       reservation counts, and which haven't.
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected static function release_reservations_for_tickets(
-        array $tickets_with_reservations,
-        array $valid_reserved_ticket_line_items = array(),
-        $source = ''
-    ) {
-        $total_tickets_released = 0;
-        $sold_out_events = array();
-        foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
-                continue;
-            }
-            // The $valid_reserved_ticket_line_items tells us what the reserved count on their tickets (and datetimes)
-            // SHOULD be. Instead of just directly updating the list, we're going to use EE_Ticket::decreaseReserved()
-            // to try to avoid race conditions, so instead of just finding the number to update TO, we're going to find
-            // the number to RELEASE. It's the same end result, just different path.
-            // Begin by assuming we're going to release all the reservations on this ticket.
-            $expired_reservations_count = $ticket_with_reservations->reserved();
-            // Now reduce that number using the list of current valid reservations.
-            foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
-                if (
-                    $valid_reserved_ticket_line_item instanceof EE_Line_Item
-                    && $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
-                ) {
-                    $expired_reservations_count -= $valid_reserved_ticket_line_item->quantity();
-                }
-            }
-            // Only bother saving the tickets and datetimes if we're actually going to release some spots.
-            if ($expired_reservations_count > 0) {
-                $ticket_with_reservations->add_extra_meta(
-                    EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                    __LINE__ . ') ' . $source . '()'
-                );
-                $ticket_with_reservations->decreaseReserved($expired_reservations_count, true, 'TicketSalesMonitor:' . __LINE__);
-                $total_tickets_released += $expired_reservations_count;
-                $event = $ticket_with_reservations->get_related_event();
-                // track sold out events
-                if ($event instanceof EE_Event && $event->is_sold_out()) {
-                    $sold_out_events[] = $event;
-                }
-            }
-        }
-        // Double check whether sold out events should remain sold out after releasing tickets
-        if ($sold_out_events !== array()) {
-            foreach ($sold_out_events as $sold_out_event) {
-                /** @var EE_Event $sold_out_event */
-                $sold_out_event->perform_sold_out_status_check();
-            }
-        }
-        return $total_tickets_released;
-    }
-
-
-
-    /********************************** SHUTDOWN  **********************************/
-
-
-    /**
-     * @param int $timestamp
-     * @return false|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function clear_expired_line_items_with_no_transaction($timestamp = 0)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp = $session_lifespan->expiration();
-        }
-        return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+			$STS_ID === EEM_Transaction::failed_status_code
+			|| $STS_ID === EEM_Transaction::abandoned_status_code
+			|| (
+				// also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
+				$STS_ID === EEM_Transaction::incomplete_status_code
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+			)
+		) {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
+				$rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
+				echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
+				var_dump($rsrvd);
+			}
+			$registration->release_reserved_ticket(true, 'TicketSalesMonitor:' . __LINE__);
+			return 1;
+		}
+		return 0;
+	}
+
+
+
+	/********************************** SESSION_CART_RESET  **********************************/
+
+
+	/**
+	 * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
+	 *
+	 * @param EE_Session $session
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function session_cart_reset(EE_Session $session)
+	{
+		// don't release tickets if checkout was already reset
+		if (did_action('AHEE__EE_Session__reset_checkout__before_reset')) {
+			return;
+		}
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// first check of the session has a valid Checkout object
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			// and use that to clear ticket reservations because it will update the associated registration meta data
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+			return;
+		}
+		$cart = $session->cart();
+		if ($cart instanceof EE_Cart) {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
+			}
+			EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
+		} else {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' invalid EE_Cart: ';
+				var_export($cart, true);
+			}
+		}
+	}
+
+
+	/**
+	 * releases reserved tickets in the EE_Cart
+	 *
+	 * @param EE_Cart $cart
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _session_cart_reset(EE_Cart $cart, EE_Session $session)
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$ticket_line_items = $cart->get_tickets();
+		if (empty($ticket_line_items)) {
+			return;
+		}
+		if (self::debug) {
+			echo '<br /> . ticket_line_item count: ' . count($ticket_line_items);
+		}
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (self::debug) {
+				echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+			}
+			if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
+				if (self::debug) {
+					echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+				}
+				$ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
+				if ($ticket instanceof EE_Ticket) {
+					if (self::debug) {
+						echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
+						echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+					}
+					$ticket->add_extra_meta(
+						EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+						__LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
+					);
+					$this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
+				}
+			}
+		}
+		if (self::debug) {
+			echo self::$nl . self::$nl . ' RESET COMPLETED ';
+		}
+	}
+
+
+
+	/********************************** SESSION_CHECKOUT_RESET  **********************************/
+
+
+	/**
+	 * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
+	 *
+	 * @param EE_Session $session
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function session_checkout_reset(EE_Session $session)
+	{
+		// don't release tickets if cart was already reset
+		if (did_action('AHEE__EE_Session__reset_cart__before_reset')) {
+			return;
+		}
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+		}
+	}
+
+
+	/**
+	 * releases reserved tickets for the EE_Checkout->transaction
+	 *
+	 * @param EE_Checkout $checkout
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	protected function _session_checkout_reset(EE_Checkout $checkout)
+	{
+		// self::debug hardcoded to false
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
+		if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
+	}
+
+
+
+	/********************************** SESSION_EXPIRED_RESET  **********************************/
+
+
+	/**
+	 * @param    EE_Session $session
+	 * @return    void
+	 */
+	public static function session_expired_reset(EE_Session $session)
+	{
+	}
+
+
+
+	/********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
+
+
+	/**
+	 * releases reserved tickets for all registrations of an ABANDONED EE_Transaction
+	 * by default, will NOT release tickets for free transactions, or any that have received a payment
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function process_abandoned_transactions(EE_Transaction $transaction)
+	{
+		// is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
+		if ($transaction->is_free() || $transaction->paid() > 0) {
+			// self::debug hardcoded to false
+			if (self::debug) {
+				// DEBUG LOG
+				EEH_Debug_Tools::log(
+					__CLASS__,
+					__FUNCTION__,
+					__LINE__,
+					array($transaction),
+					false,
+					'EE_Transaction: ' . $transaction->ID()
+				);
+			}
+			return;
+		}
+		// have their been any successful payments made ?
+		$payments = $transaction->payments();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
+				if (self::debug) {
+					// DEBUG LOG
+					EEH_Debug_Tools::log(
+						__CLASS__,
+						__FUNCTION__,
+						__LINE__,
+						array($payment),
+						false,
+						'EE_Transaction: ' . $transaction->ID()
+					);
+				}
+				return;
+			}
+		}
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
+
+
+	/**
+	 * releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function process_failed_transactions(EE_Transaction $transaction)
+	{
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** RESET RESERVATION COUNTS  *********************************/
+
+
+	/**
+	 * Resets the ticket and datetime reserved counts.
+	 *
+	 * For all the tickets with reservations, recalculates what their actual reserved counts should be based
+	 * on the valid transactions.
+	 *
+	 * @return int number of tickets whose reservations were released.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws UnexpectedEntityException
+	 * @throws ReflectionException
+	 */
+	public static function reset_reservation_counts()
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		/** @var EE_Transaction[] $transactions_in_progress */
+		$transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
+		foreach ($transactions_in_progress as $transaction) {
+			// if this TXN has been fully completed, then skip it
+			if ($transaction->reg_step_completed('finalize_registration')) {
+				continue;
+			}
+			$total_line_item = $transaction->total_line_item();
+			// $transaction_in_progress->line
+			if (! $total_line_item instanceof EE_Line_Item) {
+				throw new DomainException(
+					esc_html__(
+						'Transaction does not have a valid Total Line Item associated with it.',
+						'event_espresso'
+					)
+				);
+			}
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
+		foreach ($total_line_items as $total_line_item) {
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$tickets_with_reservations = EEM_Ticket::instance()->get_tickets_with_reservations();
+		return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+			$tickets_with_reservations,
+			$valid_reserved_tickets,
+			__FUNCTION__
+		);
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return EE_Line_Item[]
+	 */
+	private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if ($ticket_line_item instanceof EE_Line_Item) {
+				$valid_reserved_tickets[ $ticket_line_item->ID() ] = $ticket_line_item;
+			}
+		}
+		return $valid_reserved_tickets;
+	}
+
+
+	/**
+	 * Releases ticket and datetime reservations (ie, reduces the number of reserved spots on them).
+	 *
+	 * Given the list of tickets which have reserved spots on them, uses the complete list of line items for tickets
+	 * whose transactions aren't complete and also aren't yet expired (ie, they're incomplete and younger than the
+	 * session's expiry time) to update the ticket (and their datetimes') reserved counts.
+	 *
+	 * @param EE_Ticket[]    $tickets_with_reservations all tickets with TKT_reserved > 0
+	 * @param EE_Line_Item[] $valid_reserved_ticket_line_items all line items for tickets and incomplete transactions
+	 *                       whose session has NOT expired. We will use these to determine the number of ticket
+	 *                       reservations are now invalid. We don't use the list of invalid ticket line items because
+	 *                       we don't know which of those have already been taken into account when reducing ticket
+	 *                       reservation counts, and which haven't.
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected static function release_reservations_for_tickets(
+		array $tickets_with_reservations,
+		array $valid_reserved_ticket_line_items = array(),
+		$source = ''
+	) {
+		$total_tickets_released = 0;
+		$sold_out_events = array();
+		foreach ($tickets_with_reservations as $ticket_with_reservations) {
+			if (! $ticket_with_reservations instanceof EE_Ticket) {
+				continue;
+			}
+			// The $valid_reserved_ticket_line_items tells us what the reserved count on their tickets (and datetimes)
+			// SHOULD be. Instead of just directly updating the list, we're going to use EE_Ticket::decreaseReserved()
+			// to try to avoid race conditions, so instead of just finding the number to update TO, we're going to find
+			// the number to RELEASE. It's the same end result, just different path.
+			// Begin by assuming we're going to release all the reservations on this ticket.
+			$expired_reservations_count = $ticket_with_reservations->reserved();
+			// Now reduce that number using the list of current valid reservations.
+			foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
+				if (
+					$valid_reserved_ticket_line_item instanceof EE_Line_Item
+					&& $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
+				) {
+					$expired_reservations_count -= $valid_reserved_ticket_line_item->quantity();
+				}
+			}
+			// Only bother saving the tickets and datetimes if we're actually going to release some spots.
+			if ($expired_reservations_count > 0) {
+				$ticket_with_reservations->add_extra_meta(
+					EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+					__LINE__ . ') ' . $source . '()'
+				);
+				$ticket_with_reservations->decreaseReserved($expired_reservations_count, true, 'TicketSalesMonitor:' . __LINE__);
+				$total_tickets_released += $expired_reservations_count;
+				$event = $ticket_with_reservations->get_related_event();
+				// track sold out events
+				if ($event instanceof EE_Event && $event->is_sold_out()) {
+					$sold_out_events[] = $event;
+				}
+			}
+		}
+		// Double check whether sold out events should remain sold out after releasing tickets
+		if ($sold_out_events !== array()) {
+			foreach ($sold_out_events as $sold_out_event) {
+				/** @var EE_Event $sold_out_event */
+				$sold_out_event->perform_sold_out_status_check();
+			}
+		}
+		return $total_tickets_released;
+	}
+
+
+
+	/********************************** SHUTDOWN  **********************************/
+
+
+	/**
+	 * @param int $timestamp
+	 * @return false|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function clear_expired_line_items_with_no_transaction($timestamp = 0)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp = $session_lifespan->expiration();
+		}
+		return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
-                // use GMT time because that's what LIN_timestamps are in
-                date('Y-m-d H:i:s', $timestamp)
-            )
-        );
-    }
+				// use GMT time because that's what LIN_timestamps are in
+				date('Y-m-d H:i:s', $timestamp)
+			)
+		);
+	}
 }

modules/thank_you_page/templates/thank-you-page-registration-details.template.php

Spacing +2 added lines, -2 removed lines

@@ -21,7 +21,7 @@ 
     $event_name    = '';
     $wait_list     = false;
     foreach ($registrations as $registration) {
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             continue;
         }
         if ($event_name != $registration->event_name() && ! empty($event_name)) { ?>
@@ -55,7 +55,7 @@ 
             <tbody>
             <?php
         }
-        if ($is_primary || (! $is_primary && $reg_url_link == $registration->reg_url_link())) { ?>
+        if ($is_primary || ( ! $is_primary && $reg_url_link == $registration->reg_url_link())) { ?>
             <tr>
                 <td width="40%">
                     <?php

Indentation +62 added lines, -62 removed lines

@@ -14,24 +14,24 @@ 
 
 <div class="ee-registration-details-dv">
     <?php
-    $registrations = $transaction->registrations();
-    $registrations = is_array($registrations) ? $registrations : [];
-    $reg_count     = count($registrations);
-    $reg_cntr      = 0;
-    $event_name    = '';
-    $wait_list     = false;
-    foreach ($registrations as $registration) {
-        if (! $registration instanceof EE_Registration) {
-            continue;
-        }
-        if ($event_name != $registration->event_name() && ! empty($event_name)) { ?>
+	$registrations = $transaction->registrations();
+	$registrations = is_array($registrations) ? $registrations : [];
+	$reg_count     = count($registrations);
+	$reg_cntr      = 0;
+	$event_name    = '';
+	$wait_list     = false;
+	foreach ($registrations as $registration) {
+		if (! $registration instanceof EE_Registration) {
+			continue;
+		}
+		if ($event_name != $registration->event_name() && ! empty($event_name)) { ?>
             </tbody>
             </table>
             <?php
-        }
-        $reg_cntr++;
-        if ($event_name != $registration->event_name()) {
-            ?>
+		}
+		$reg_cntr++;
+		if ($event_name != $registration->event_name()) {
+			?>
             <h5>
                 <span class="smaller-text grey-text">
                     <?php esc_html_e('for', 'event_espresso'); ?> :
@@ -54,23 +54,23 @@ 
             </thead>
             <tbody>
             <?php
-        }
-        if ($is_primary || (! $is_primary && $reg_url_link == $registration->reg_url_link())) { ?>
+		}
+		if ($is_primary || (! $is_primary && $reg_url_link == $registration->reg_url_link())) { ?>
             <tr>
                 <td width="40%">
                     <?php
-                    if ($registration->attendee() instanceof EE_Attendee) {
-                        echo esc_html($registration->attendee()->full_name(true));
-                    }
-                    ?>
+					if ($registration->attendee() instanceof EE_Attendee) {
+						echo esc_html($registration->attendee()->full_name(true));
+					}
+					?>
                     <p class="tiny-text" style="margin: .75em 0 0;">
                         <?php if ($registration->count_question_groups()) { ?>
                             <a class="ee-icon-only-lnk"
                                href="<?php echo esc_url_raw($registration->edit_attendee_information_url()); ?>"
                                title="<?php esc_attr_e(
-                                   'Click here to edit Attendee Information',
-                                   'event_espresso'
-                               ); ?>"
+								   'Click here to edit Attendee Information',
+								   'event_espresso'
+							   ); ?>"
                             >
                                 <span class="ee-icon ee-icon-user-edit"></span>
                                 <?php esc_html_e('edit info', 'event_espresso'); ?>
@@ -78,15 +78,15 @@ 
                         <?php } ?>
                         <a class="ee-resend-reg-confirmation-email ee-icon-only-lnk"
                            href="<?php echo esc_url_raw(
-                               add_query_arg(
-                                   ['token' => $registration->reg_url_link(), 'resend_reg_confirmation' => 'true'],
-                                   EE_Registry::instance()->CFG->core->thank_you_page_url()
-                               )
-                           ); ?>"
+							   add_query_arg(
+								   ['token' => $registration->reg_url_link(), 'resend_reg_confirmation' => 'true'],
+								   EE_Registry::instance()->CFG->core->thank_you_page_url()
+							   )
+						   ); ?>"
                            title="<?php esc_attr_e(
-                               'Click here to resend the Registration Confirmation email',
-                               'event_espresso'
-                           ); ?>"
+							   'Click here to resend the Registration Confirmation email',
+							   'event_espresso'
+						   ); ?>"
                            rel="<?php echo esc_attr($registration->reg_url_link()); ?>"
                         >
                             <span class="dashicons dashicons-email-alt"></span>
@@ -100,27 +100,27 @@ 
                 <td width="35%" class="jst-left">
                     <?php $registration->e_pretty_status(true) ?>
                     <?php
-                    if ($registration->status_ID() === EEM_Registration::status_id_wait_list) {
-                        $wait_list = true;
-                    }
-                    ?>
+					if ($registration->status_ID() === EEM_Registration::status_id_wait_list) {
+						$wait_list = true;
+					}
+					?>
                 </td>
             </tr>
             <?php do_action(
-                'AHEE__thank_you_page_registration_details_template__after_registration_table_row',
-                $registration
-            ); ?>
+				'AHEE__thank_you_page_registration_details_template__after_registration_table_row',
+				$registration
+			); ?>
             <?php
-            $event_name = $registration->event_name();
-        }
-        if ($reg_cntr >= $reg_count) {
-            ?>
+			$event_name = $registration->event_name();
+		}
+		if ($reg_cntr >= $reg_count) {
+			?>
             </tbody>
             </table>
             <?php
-        }
-    }
-    ?>
+		}
+	}
+	?>
     <?php if ($is_primary && $SPCO_attendee_information_url) { ?>
         <p class="small-text jst-rght">
             <a href='<?php echo esc_url_raw($SPCO_attendee_information_url) ?>'>
@@ -129,22 +129,22 @@ 
         </p>
     <?php } ?>
     <?php
-    if ($wait_list) {
-        echo apply_filters(
-            'AFEE__thank_you_page_registration_details_template__wait_list_notice',
-            sprintf(
-                esc_html__(
-                    '%1$sre: Wait List Registrations%2$sPlease note that the total cost listed below in the Transaction Details is for ALL registrations, including those that are on the wait list, even though they can not be currently paid for. If any spaces become available however, you may be notified by the Event admin and have the opportunity to secure the remaining tickets by making a payment for them.%3$s',
-                    'event_espresso'
-                ),
-                '<h6 class="" style="margin-bottom:.25em;"><span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>',
-                '</h6 ><p class="ee-wait-list-notice">',
-                '</p ><br />'
-            )
-        );
-    }
-    do_action('AHEE__thank_you_page_registration_details_template__after_registration_details');
-    ?>
+	if ($wait_list) {
+		echo apply_filters(
+			'AFEE__thank_you_page_registration_details_template__wait_list_notice',
+			sprintf(
+				esc_html__(
+					'%1$sre: Wait List Registrations%2$sPlease note that the total cost listed below in the Transaction Details is for ALL registrations, including those that are on the wait list, even though they can not be currently paid for. If any spaces become available however, you may be notified by the Event admin and have the opportunity to secure the remaining tickets by making a payment for them.%3$s',
+					'event_espresso'
+				),
+				'<h6 class="" style="margin-bottom:.25em;"><span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>',
+				'</h6 ><p class="ee-wait-list-notice">',
+				'</p ><br />'
+			)
+		);
+	}
+	do_action('AHEE__thank_you_page_registration_details_template__after_registration_details');
+	?>
 
 </div>
 <!-- end of .registration-details -->

modules/thank_you_page/templates/thank-you-page-transaction-details.template.php

Indentation +6 added lines, -6 removed lines

@@ -28,8 +28,8 @@ 
                 <label><?php esc_html_e('Amount Owing: ', 'event_espresso'); ?></label>
             </td>
             <td class="<?php echo ($transaction->paid() == $transaction->total())
-                ? 'ee-transaction-paid'
-                : 'ee-transaction-unpaid' ?>">
+				? 'ee-transaction-paid'
+				: 'ee-transaction-unpaid' ?>">
                 <?php echo EEH_Template::format_currency($transaction->remaining()); // already escaped ?>
             </td>
         </tr>
@@ -39,7 +39,7 @@ 
             </td>
             <td>
                 <?php $transaction->e_pretty_status(true);
-                if ($show_try_pay_again_link && ! $transaction->is_completed()) { ?>
+				if ($show_try_pay_again_link && ! $transaction->is_completed()) { ?>
                     &nbsp; <span class="small-text">
                         <a href='<?php echo esc_url_raw($SPCO_payment_options_url) ?>'>
                             <?php esc_html_e('View Payment Options', 'event_espresso'); ?>
@@ -57,9 +57,9 @@ 
             </td>
         </tr>
         <?php do_action(
-            'AHEE__thank_you_page_transaction_details_template__after_transaction_table_row',
-            $transaction
-        ); ?>
+			'AHEE__thank_you_page_transaction_details_template__after_transaction_table_row',
+			$transaction
+		); ?>
         </tbody>
     </table>
 

modules/thank_you_page/EED_Thank_You_Page.module.php

Spacing +25 added lines, -25 removed lines

@@ -129,8 +129,8 @@ 
      */
     public static function set_definitions()
     {
-        define('THANK_YOU_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('THANK_YOU_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+        define('THANK_YOU_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
+        define('THANK_YOU_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/');
     }
 
 
@@ -147,7 +147,7 @@ 
             return $this->_current_txn;
         }
         $TXN_model = EE_Registry::instance()->load_model('Transaction');
-        if (! $TXN_model instanceof EEM_Transaction) {
+        if ( ! $TXN_model instanceof EEM_Transaction) {
             EE_Error::add_error(
                 esc_html__('The transaction model could not be established.', 'event_espresso'),
                 __FILE__,
@@ -185,7 +185,7 @@ 
      */
     public function get_txn_payments($since = 0)
     {
-        if (! $this->get_txn()) {
+        if ( ! $this->get_txn()) {
             return [];
         }
         $args = array('order_by' => array('PAY_timestamp' => 'ASC'));
@@ -327,7 +327,7 @@ 
     {
         wp_register_script(
             'thank_you_page',
-            THANK_YOU_ASSETS_URL . 'thank_you_page.js',
+            THANK_YOU_ASSETS_URL.'thank_you_page.js',
             array('espresso_core', 'heartbeat'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -347,9 +347,9 @@ 
     public function init()
     {
         $this->_get_reg_url_link();
-        if (! $this->get_txn()) {
+        if ( ! $this->get_txn()) {
             echo EEH_HTML::div(
-                EEH_HTML::h4(esc_html__('We\'re sorry...', 'event_espresso')) .
+                EEH_HTML::h4(esc_html__('We\'re sorry...', 'event_espresso')).
                 sprintf(
                     esc_html__(
                         'This is a system page for displaying transaction information after a purchase.%1$sYou are most likely seeing this notice because you have navigated to this page%1$sthrough some means other than completing a transaction.%1$sSorry for the disappointment, but you will most likely find nothing of interest here.%1$s%1$s',
@@ -440,12 +440,12 @@ 
     public function thank_you_page_results()
     {
         $this->init();
-        if (! $this->_current_txn instanceof EE_Transaction) {
+        if ( ! $this->_current_txn instanceof EE_Transaction) {
             return EE_Error::get_notices();
         }
         // link to receipt
         $template_args['TXN_receipt_url'] = $this->_current_txn->receipt_url();
-        if (! empty($template_args['TXN_receipt_url'])) {
+        if ( ! empty($template_args['TXN_receipt_url'])) {
             $template_args['order_conf_desc'] = esc_html__(
                 '%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation or click the button below to view / download / print a full description of your purchases and registration information.',
                 'event_espresso'
@@ -463,7 +463,7 @@ 
             add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_ajax_content'));
         }
         return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-overview.template.php',
+            THANK_YOU_TEMPLATES_PATH.'thank-you-page-overview.template.php',
             $template_args
         );
     }
@@ -513,7 +513,7 @@ 
             '$SPCO_attendee_information_url'
         );
         echo EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-registration-details.template.php',
+            THANK_YOU_TEMPLATES_PATH.'thank-you-page-registration-details.template.php',
             $template_args
         );
     }
@@ -585,7 +585,7 @@ 
      */
     public function get_ajax_content()
     {
-        if (! $this->get_txn()) {
+        if ( ! $this->get_txn()) {
             return;
         }
         // first determine which event(s) require pre-approval or not
@@ -596,9 +596,9 @@ 
                 $event = $registration->event();
                 if ($event instanceof EE_Event) {
                     if ($registration->is_not_approved() && $registration->event() instanceof EE_Event) {
-                        $events_requiring_pre_approval[ $event->ID() ] = $event;
+                        $events_requiring_pre_approval[$event->ID()] = $event;
                     } else {
-                        $events[ $event->ID() ] = $event;
+                        $events[$event->ID()] = $event;
                     }
                 }
             }
@@ -616,7 +616,7 @@ 
      */
     public function display_details_for_events($events = array())
     {
-        if (! empty($events)) {
+        if ( ! empty($events)) {
             ?>
             <div id="espresso-thank-you-page-ajax-content-dv">
                 <div id="espresso-thank-you-page-ajax-transaction-dv"></div>
@@ -629,7 +629,7 @@ 
                                 'event_espresso'
                             ); ?></span>
                     </div>
-                    <?php if (! $this->_is_offline_payment_method && ! $this->_payments_closed) : ?>
+                    <?php if ( ! $this->_is_offline_payment_method && ! $this->_payments_closed) : ?>
                         <p id="ee-ajax-loading-pg" class="highlight-bg small-text clear">
                             <?php echo apply_filters(
                                 'EED_Thank_You_Page__get_ajax_content__waiting_for_IPN_msg',
@@ -662,7 +662,7 @@ 
      */
     public function display_details_for_events_requiring_pre_approval($events = array())
     {
-        if (! empty($events)) {
+        if ( ! empty($events)) {
             ?>
             <div id="espresso-thank-you-page-not-approved-message-dv">
                 <h4 class="orange-text"><?php esc_html_e('Important Notice:', 'event_espresso'); ?></h4>
@@ -719,7 +719,7 @@ 
             '$SPCO_payment_options_url'
         );
         return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-transaction-details.template.php',
+            THANK_YOU_TEMPLATES_PATH.'thank-you-page-transaction-details.template.php',
             $template_args
         );
     }
@@ -735,7 +735,7 @@ 
     public function get_payment_row_html(EE_Payment $payment = null)
     {
         $html = '';
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             return '';
         }
         if (
@@ -749,25 +749,25 @@ 
             $payment->set_status(EEM_Payment::status_id_pending);
         }
         $payment_declined_msg = $payment->STS_ID() === EEM_Payment::status_id_declined
-            ? '<br /><span class="small-text">' . esc_html($payment->gateway_response()) . '</span>'
+            ? '<br /><span class="small-text">'.esc_html($payment->gateway_response()).'</span>'
             : '';
         $html .= '
             <tr>
                 <td>
-                    ' . esc_html($payment->timestamp()) . '
+                    ' . esc_html($payment->timestamp()).'
                 </td>
                 <td>
                     ' . (
             $payment->payment_method() instanceof EE_Payment_Method
                 ? esc_html($payment->payment_method()->name())
                 : esc_html__('Unknown', 'event_espresso')
-            ) . '
+            ).'
                 </td>
                 <td class="jst-rght">
-                    ' . EEH_Template::format_currency($payment->amount()) . '
+                    ' . EEH_Template::format_currency($payment->amount()).'
                 </td>
                 <td class="jst-rght" style="line-height:1;">
-                    ' . $payment->pretty_status(true) . $payment_declined_msg . '
+                    ' . $payment->pretty_status(true).$payment_declined_msg.'
                 </td>
             </tr>';
         do_action('AHEE__thank_you_page_payment_details_template__after_each_payment', $payment);
@@ -825,7 +825,7 @@ 
             '$SPCO_payment_options_url'
         );
         return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-payment-details.template.php',
+            THANK_YOU_TEMPLATES_PATH.'thank-you-page-payment-details.template.php',
             $template_args
         );
     }

Indentation +789 added lines, -789 removed lines

@@ -10,613 +10,613 @@ 
  */
 class EED_Thank_You_Page extends EED_Module
 {
-    /**
-     * time in seconds to wait for the IPN to arrive before telling the registrant to bugger off ( 1200s = 20 minutes )
-     */
-    const IPN_wait_time = 1200;
-
-    /**
-     * The transaction specified by the reg_url_link passed from the Request, or from the Session
-     *
-     * @var EE_Transaction $_current_txn
-     */
-    private $_current_txn;
-
-    /**
-     * @var EE_Registration $_primary_registrant
-     */
-    private $_primary_registrant;
-
-    /**
-     * The reg_url_link passed from the Request, or from the Session
-     *
-     * @var string $_reg_url_link
-     */
-    private $_reg_url_link;
-
-    /**
-     * whether the incoming reg_url_link is for the primary registrant or not
-     *
-     * @var boolean $_is_primary
-     */
-    private $_is_primary;
-
-    /**
-     * The URL for revisiting the SPCO attendee information step
-     *
-     * @var string $_SPCO_attendee_information_url
-     */
-    private $_SPCO_attendee_information_url;
-
-    /**
-     * The URL for revisiting the SPCO payment options step
-     *
-     * @var string $_SPCO_payment_options_url
-     */
-    private $_SPCO_payment_options_url;
-
-    /**
-     * whether to display the Payment Options link
-     *
-     * @var boolean $_show_try_pay_again_link
-     */
-    private $_show_try_pay_again_link = false;
-
-    /**
-     * whether payments are allowed at this time
-     *
-     * @var boolean $_payments_closed
-     */
-    private $_payments_closed = false;
-
-    /**
-     * whether the selected payment method is Bank, Check , Invoice, etc
-     *
-     * @var boolean $_is_offline_payment_method
-     */
-    private $_is_offline_payment_method = true;
-
-
-    /**
-     * @return EED_Module|EED_Thank_You_Page
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        add_action('wp_loaded', array('EED_Thank_You_Page', 'set_definitions'), 2);
-    }
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action(
-            'wp_ajax_espresso_resend_reg_confirmation_email',
-            array('EED_Thank_You_Page', 'resend_reg_confirmation_email'),
-            10,
-            2
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_resend_reg_confirmation_email',
-            array('EED_Thank_You_Page', 'resend_reg_confirmation_email'),
-            10,
-            2
-        );
-    }
-
-
-    /**
-     * set_definitions
-     *
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('THANK_YOU_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('THANK_YOU_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
-    }
-
-
-    /**
-     * get_txn
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_txn()
-    {
-        if ($this->_current_txn instanceof EE_Transaction) {
-            return $this->_current_txn;
-        }
-        $TXN_model = EE_Registry::instance()->load_model('Transaction');
-        if (! $TXN_model instanceof EEM_Transaction) {
-            EE_Error::add_error(
-                esc_html__('The transaction model could not be established.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        // get the transaction. yes, we may have just loaded it, but it may have been updated, or this may be via an ajax request
-        $this->_current_txn = $TXN_model->get_transaction_from_reg_url_link($this->_reg_url_link);
-        // verify TXN
-        if (WP_DEBUG && ! $this->_current_txn instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No transaction information could be retrieved or the transaction data is not of the correct type.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $this->_current_txn;
-    }
-
-
-    /**
-     * get_txn_payments
-     *
-     * @param int $since
-     * @return EE_Payment[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_txn_payments($since = 0)
-    {
-        if (! $this->get_txn()) {
-            return [];
-        }
-        $args = array('order_by' => array('PAY_timestamp' => 'ASC'));
-        if ($since > 0) {
-            $args[0] = array('PAY_timestamp' => array('>', $since));
-        }
-        // get array of payments with most recent first
-        return $this->_current_txn->payments($args);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOfflinePaymentMethod()
-    {
-        return $this->_is_offline_payment_method;
-    }
-
-
-
-
-    /**
-     * get_reg_url_link
-     *
-     * @return void
-     */
-    private function _get_reg_url_link()
-    {
-        if ($this->_reg_url_link) {
-            return;
-        }
-        // check for reg_url_link
-        $reg_url_link = self::getRequest()->getRequestParam('e_reg_url_link');
-        // only do thank you page stuff if we have a REG_url_link in the url
-        if (WP_DEBUG && ! $reg_url_link) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No transaction information could be retrieved because the registration URL link is missing or invalid.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->set_reg_url_link($reg_url_link);
-    }
-
-
-    /**
-     * set_reg_url_link
-     *
-     * @param string $reg_url_link
-     */
-    public function set_reg_url_link($reg_url_link = null)
-    {
-        $this->_reg_url_link = ! empty($reg_url_link) ? $reg_url_link : $this->_reg_url_link;
-    }
-
-
-    /**
-     * run - initial module setup
-     * this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * load_resources
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_resources()
-    {
-        $this->_get_reg_url_link();
-        // resend_reg_confirmation_email ?
-        if (self::getRequest()->requestParamIsSet('resend')) {
-            EED_Thank_You_Page::resend_reg_confirmation_email();
-        }
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        $this->_translate_strings();
-        // load assets
-        add_action('wp_enqueue_scripts', array($this, 'load_js'), 10);
-    }
-
-
-    /**
-     * load_js
-     *
-     * @return void
-     */
-    protected function _translate_strings()
-    {
-        EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->_reg_url_link;
-        EE_Registry::$i18n_js_strings['initial_access'] = time();
-        EE_Registry::$i18n_js_strings['IPN_wait_time'] = EED_Thank_You_Page::IPN_wait_time;
-        EE_Registry::$i18n_js_strings['TXN_complete'] = EEM_Transaction::complete_status_code;
-        EE_Registry::$i18n_js_strings['TXN_incomplete'] = EEM_Transaction::incomplete_status_code;
-        EE_Registry::$i18n_js_strings['checking_for_new_payments'] = __(
-            'checking for new payments...',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['loading_payment_info'] = __(
-            'loading payment information...',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['server_error'] = __(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['slow_IPN'] = apply_filters(
-            'EED_Thank_You_Page__load_js__slow_IPN',
-            sprintf(
-                __(
-                    '%sThe Payment Notification appears to be taking longer than usual to arrive. Maybe check back later or just wait for your payment and registration confirmation results to be sent to you via email. We apologize for any inconvenience this may have caused.%s',
-                    'event_espresso'
-                ),
-                '<div id="espresso-thank-you-page-slow-IPN-dv" class="ee-attention jst-left">',
-                '</div>'
-            )
-        );
-    }
-
-
-    /**
-     * load_js
-     *
-     * @return void
-     */
-    public function load_js()
-    {
-        wp_register_script(
-            'thank_you_page',
-            THANK_YOU_ASSETS_URL . 'thank_you_page.js',
-            array('espresso_core', 'heartbeat'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('thank_you_page');
-        wp_enqueue_style('espresso_default');
-    }
-
-
-    /**
-     * init
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function init()
-    {
-        $this->_get_reg_url_link();
-        if (! $this->get_txn()) {
-            echo EEH_HTML::div(
-                EEH_HTML::h4(esc_html__('We\'re sorry...', 'event_espresso')) .
-                sprintf(
-                    esc_html__(
-                        'This is a system page for displaying transaction information after a purchase.%1$sYou are most likely seeing this notice because you have navigated to this page%1$sthrough some means other than completing a transaction.%1$sSorry for the disappointment, but you will most likely find nothing of interest here.%1$s%1$s',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                '',
-                'ee-attention'
-            );
-            return;
-        }
-        // if we've made it to the Thank You page, then let's toggle any "Failed" transactions to "Incomplete"
-        if ($this->_current_txn->status_ID() === EEM_Transaction::failed_status_code) {
-            $this->_current_txn->set_status(EEM_Transaction::incomplete_status_code);
-            $this->_current_txn->save();
-        }
-        $this->_primary_registrant = $this->_current_txn->primary_registration() instanceof EE_Registration
-            ? $this->_current_txn->primary_registration()
-            : null;
-        $this->_is_primary = $this->_primary_registrant->reg_url_link() === $this->_reg_url_link;
-        $show_try_pay_again_link_default = apply_filters(
-            'AFEE__EED_Thank_You_Page__init__show_try_pay_again_link_default',
-            true
-        );
-        $this->_show_try_pay_again_link = $show_try_pay_again_link_default;
-        // txn status ?
-        if ($this->_current_txn->is_completed()) {
-            $this->_show_try_pay_again_link = $show_try_pay_again_link_default;
-        } elseif (
-            $this->_current_txn->is_incomplete()
-            && ($this->_primary_registrant->is_approved()
-                || $this->_primary_registrant->is_pending_payment())
-        ) {
-            $this->_show_try_pay_again_link = true;
-        } elseif ($this->_primary_registrant->is_approved() || $this->_primary_registrant->is_pending_payment()) {
-            // its pending
-            $this->_show_try_pay_again_link = isset(
-                EE_Registry::instance()->CFG->registration->show_pending_payment_options
-            )
-                                              && EE_Registry::instance()->CFG
-                                                  ->registration->show_pending_payment_options
-                ? true
-                : $show_try_pay_again_link_default;
-        }
-        $this->_payments_closed = ! $this->_current_txn->payment_method() instanceof EE_Payment_Method;
-        $this->_is_offline_payment_method = false;
-        if (
+	/**
+	 * time in seconds to wait for the IPN to arrive before telling the registrant to bugger off ( 1200s = 20 minutes )
+	 */
+	const IPN_wait_time = 1200;
+
+	/**
+	 * The transaction specified by the reg_url_link passed from the Request, or from the Session
+	 *
+	 * @var EE_Transaction $_current_txn
+	 */
+	private $_current_txn;
+
+	/**
+	 * @var EE_Registration $_primary_registrant
+	 */
+	private $_primary_registrant;
+
+	/**
+	 * The reg_url_link passed from the Request, or from the Session
+	 *
+	 * @var string $_reg_url_link
+	 */
+	private $_reg_url_link;
+
+	/**
+	 * whether the incoming reg_url_link is for the primary registrant or not
+	 *
+	 * @var boolean $_is_primary
+	 */
+	private $_is_primary;
+
+	/**
+	 * The URL for revisiting the SPCO attendee information step
+	 *
+	 * @var string $_SPCO_attendee_information_url
+	 */
+	private $_SPCO_attendee_information_url;
+
+	/**
+	 * The URL for revisiting the SPCO payment options step
+	 *
+	 * @var string $_SPCO_payment_options_url
+	 */
+	private $_SPCO_payment_options_url;
+
+	/**
+	 * whether to display the Payment Options link
+	 *
+	 * @var boolean $_show_try_pay_again_link
+	 */
+	private $_show_try_pay_again_link = false;
+
+	/**
+	 * whether payments are allowed at this time
+	 *
+	 * @var boolean $_payments_closed
+	 */
+	private $_payments_closed = false;
+
+	/**
+	 * whether the selected payment method is Bank, Check , Invoice, etc
+	 *
+	 * @var boolean $_is_offline_payment_method
+	 */
+	private $_is_offline_payment_method = true;
+
+
+	/**
+	 * @return EED_Module|EED_Thank_You_Page
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		add_action('wp_loaded', array('EED_Thank_You_Page', 'set_definitions'), 2);
+	}
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action(
+			'wp_ajax_espresso_resend_reg_confirmation_email',
+			array('EED_Thank_You_Page', 'resend_reg_confirmation_email'),
+			10,
+			2
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_resend_reg_confirmation_email',
+			array('EED_Thank_You_Page', 'resend_reg_confirmation_email'),
+			10,
+			2
+		);
+	}
+
+
+	/**
+	 * set_definitions
+	 *
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('THANK_YOU_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('THANK_YOU_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+	}
+
+
+	/**
+	 * get_txn
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_txn()
+	{
+		if ($this->_current_txn instanceof EE_Transaction) {
+			return $this->_current_txn;
+		}
+		$TXN_model = EE_Registry::instance()->load_model('Transaction');
+		if (! $TXN_model instanceof EEM_Transaction) {
+			EE_Error::add_error(
+				esc_html__('The transaction model could not be established.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		// get the transaction. yes, we may have just loaded it, but it may have been updated, or this may be via an ajax request
+		$this->_current_txn = $TXN_model->get_transaction_from_reg_url_link($this->_reg_url_link);
+		// verify TXN
+		if (WP_DEBUG && ! $this->_current_txn instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__(
+					'No transaction information could be retrieved or the transaction data is not of the correct type.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $this->_current_txn;
+	}
+
+
+	/**
+	 * get_txn_payments
+	 *
+	 * @param int $since
+	 * @return EE_Payment[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_txn_payments($since = 0)
+	{
+		if (! $this->get_txn()) {
+			return [];
+		}
+		$args = array('order_by' => array('PAY_timestamp' => 'ASC'));
+		if ($since > 0) {
+			$args[0] = array('PAY_timestamp' => array('>', $since));
+		}
+		// get array of payments with most recent first
+		return $this->_current_txn->payments($args);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOfflinePaymentMethod()
+	{
+		return $this->_is_offline_payment_method;
+	}
+
+
+
+
+	/**
+	 * get_reg_url_link
+	 *
+	 * @return void
+	 */
+	private function _get_reg_url_link()
+	{
+		if ($this->_reg_url_link) {
+			return;
+		}
+		// check for reg_url_link
+		$reg_url_link = self::getRequest()->getRequestParam('e_reg_url_link');
+		// only do thank you page stuff if we have a REG_url_link in the url
+		if (WP_DEBUG && ! $reg_url_link) {
+			EE_Error::add_error(
+				esc_html__(
+					'No transaction information could be retrieved because the registration URL link is missing or invalid.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->set_reg_url_link($reg_url_link);
+	}
+
+
+	/**
+	 * set_reg_url_link
+	 *
+	 * @param string $reg_url_link
+	 */
+	public function set_reg_url_link($reg_url_link = null)
+	{
+		$this->_reg_url_link = ! empty($reg_url_link) ? $reg_url_link : $this->_reg_url_link;
+	}
+
+
+	/**
+	 * run - initial module setup
+	 * this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * load_resources
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_resources()
+	{
+		$this->_get_reg_url_link();
+		// resend_reg_confirmation_email ?
+		if (self::getRequest()->requestParamIsSet('resend')) {
+			EED_Thank_You_Page::resend_reg_confirmation_email();
+		}
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		$this->_translate_strings();
+		// load assets
+		add_action('wp_enqueue_scripts', array($this, 'load_js'), 10);
+	}
+
+
+	/**
+	 * load_js
+	 *
+	 * @return void
+	 */
+	protected function _translate_strings()
+	{
+		EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->_reg_url_link;
+		EE_Registry::$i18n_js_strings['initial_access'] = time();
+		EE_Registry::$i18n_js_strings['IPN_wait_time'] = EED_Thank_You_Page::IPN_wait_time;
+		EE_Registry::$i18n_js_strings['TXN_complete'] = EEM_Transaction::complete_status_code;
+		EE_Registry::$i18n_js_strings['TXN_incomplete'] = EEM_Transaction::incomplete_status_code;
+		EE_Registry::$i18n_js_strings['checking_for_new_payments'] = __(
+			'checking for new payments...',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['loading_payment_info'] = __(
+			'loading payment information...',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['server_error'] = __(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['slow_IPN'] = apply_filters(
+			'EED_Thank_You_Page__load_js__slow_IPN',
+			sprintf(
+				__(
+					'%sThe Payment Notification appears to be taking longer than usual to arrive. Maybe check back later or just wait for your payment and registration confirmation results to be sent to you via email. We apologize for any inconvenience this may have caused.%s',
+					'event_espresso'
+				),
+				'<div id="espresso-thank-you-page-slow-IPN-dv" class="ee-attention jst-left">',
+				'</div>'
+			)
+		);
+	}
+
+
+	/**
+	 * load_js
+	 *
+	 * @return void
+	 */
+	public function load_js()
+	{
+		wp_register_script(
+			'thank_you_page',
+			THANK_YOU_ASSETS_URL . 'thank_you_page.js',
+			array('espresso_core', 'heartbeat'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('thank_you_page');
+		wp_enqueue_style('espresso_default');
+	}
+
+
+	/**
+	 * init
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function init()
+	{
+		$this->_get_reg_url_link();
+		if (! $this->get_txn()) {
+			echo EEH_HTML::div(
+				EEH_HTML::h4(esc_html__('We\'re sorry...', 'event_espresso')) .
+				sprintf(
+					esc_html__(
+						'This is a system page for displaying transaction information after a purchase.%1$sYou are most likely seeing this notice because you have navigated to this page%1$sthrough some means other than completing a transaction.%1$sSorry for the disappointment, but you will most likely find nothing of interest here.%1$s%1$s',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				'',
+				'ee-attention'
+			);
+			return;
+		}
+		// if we've made it to the Thank You page, then let's toggle any "Failed" transactions to "Incomplete"
+		if ($this->_current_txn->status_ID() === EEM_Transaction::failed_status_code) {
+			$this->_current_txn->set_status(EEM_Transaction::incomplete_status_code);
+			$this->_current_txn->save();
+		}
+		$this->_primary_registrant = $this->_current_txn->primary_registration() instanceof EE_Registration
+			? $this->_current_txn->primary_registration()
+			: null;
+		$this->_is_primary = $this->_primary_registrant->reg_url_link() === $this->_reg_url_link;
+		$show_try_pay_again_link_default = apply_filters(
+			'AFEE__EED_Thank_You_Page__init__show_try_pay_again_link_default',
+			true
+		);
+		$this->_show_try_pay_again_link = $show_try_pay_again_link_default;
+		// txn status ?
+		if ($this->_current_txn->is_completed()) {
+			$this->_show_try_pay_again_link = $show_try_pay_again_link_default;
+		} elseif (
+			$this->_current_txn->is_incomplete()
+			&& ($this->_primary_registrant->is_approved()
+				|| $this->_primary_registrant->is_pending_payment())
+		) {
+			$this->_show_try_pay_again_link = true;
+		} elseif ($this->_primary_registrant->is_approved() || $this->_primary_registrant->is_pending_payment()) {
+			// its pending
+			$this->_show_try_pay_again_link = isset(
+				EE_Registry::instance()->CFG->registration->show_pending_payment_options
+			)
+											  && EE_Registry::instance()->CFG
+												  ->registration->show_pending_payment_options
+				? true
+				: $show_try_pay_again_link_default;
+		}
+		$this->_payments_closed = ! $this->_current_txn->payment_method() instanceof EE_Payment_Method;
+		$this->_is_offline_payment_method = false;
+		if (
 // if payment method is unknown
-            ! $this->_current_txn->payment_method() instanceof EE_Payment_Method
-            || (
-                // or is an offline payment method
-                $this->_current_txn->payment_method() instanceof EE_Payment_Method
-                && $this->_current_txn->payment_method()->is_off_line()
-            )
-        ) {
-            $this->_is_offline_payment_method = true;
-        }
-        // link to SPCO
-        $revisit_spco_url = add_query_arg(
-            array('ee' => '_register', 'revisit' => true, 'e_reg_url_link' => $this->_reg_url_link),
-            EE_Registry::instance()->CFG->core->reg_page_url()
-        );
-        // link to SPCO payment_options
-        $this->_SPCO_payment_options_url = $this->_primary_registrant instanceof EE_Registration
-            ? $this->_primary_registrant->payment_overview_url()
-            : add_query_arg(
-                array('step' => 'payment_options'),
-                $revisit_spco_url
-            );
-        // link to SPCO attendee_information
-        $this->_SPCO_attendee_information_url = $this->_primary_registrant instanceof EE_Registration
-            ? $this->_primary_registrant->edit_attendee_information_url()
-            : false;
-        do_action('AHEE__EED_Thank_You_Page__init_end', $this->_current_txn);
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-    }
-
-
-    /**
-     * display_thank_you_page_results
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function thank_you_page_results()
-    {
-        $this->init();
-        if (! $this->_current_txn instanceof EE_Transaction) {
-            return EE_Error::get_notices();
-        }
-        // link to receipt
-        $template_args['TXN_receipt_url'] = $this->_current_txn->receipt_url();
-        if (! empty($template_args['TXN_receipt_url'])) {
-            $template_args['order_conf_desc'] = esc_html__(
-                '%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation or click the button below to view / download / print a full description of your purchases and registration information.',
-                'event_espresso'
-            );
-        } else {
-            $template_args['order_conf_desc'] = esc_html__(
-                '%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation.',
-                'event_espresso'
-            );
-        }
-        $template_args['transaction'] = $this->_current_txn;
-        $template_args['revisit'] = self::getRequest()->getRequestParam('revisit', false, 'bool');
-        add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_registration_details'));
-        if ($this->_is_primary && ! $this->_current_txn->is_free()) {
-            add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_ajax_content'));
-        }
-        return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-overview.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * _update_server_wait_time
-     *
-     * @param array $thank_you_page_data thank you page portion of the incoming JSON array from the WP heartbeat data
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _update_server_wait_time($thank_you_page_data = array())
-    {
-        $response['espresso_thank_you_page'] = array(
-            'still_waiting' => isset($thank_you_page_data['initial_access'])
-                ? time() - $thank_you_page_data['initial_access']
-                : 0,
-            'txn_status'    => $this->_current_txn->status_ID(),
-        );
-        return $response;
-    }
-
-
-    /**
-     * get_registration_details
-     *
-     * @throws EE_Error
-     */
-    public function get_registration_details()
-    {
-        // prepare variables for displaying
-        $template_args = array();
-        $template_args['transaction'] = $this->_current_txn;
-        $template_args['reg_url_link'] = $this->_reg_url_link;
-        $template_args['is_primary'] = $this->_is_primary;
-        $template_args['SPCO_attendee_information_url'] = $this->_SPCO_attendee_information_url;
-        $template_args['resend_reg_confirmation_url'] = add_query_arg(
-            array('token' => $this->_reg_url_link, 'resend_reg_confirmation' => 'true'),
-            EE_Registry::instance()->CFG->core->thank_you_page_url()
-        );
-        // verify template arguments
-        EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['SPCO_attendee_information_url'],
-            '$SPCO_attendee_information_url'
-        );
-        echo EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-registration-details.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * resend_reg_confirmation_email
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function resend_reg_confirmation_email()
-    {
-        $reg_url_link = self::getRequest()->getRequestParam('token');
-        // was a REG_ID passed ?
-        if ($reg_url_link) {
-            $registration = EEM_Registration::instance()->get_one(
-                array(array('REG_url_link' => $reg_url_link))
-            );
-            if ($registration instanceof EE_Registration) {
-                // resend email
-                EED_Messages::process_resend(array('_REG_ID' => $registration->ID()));
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'The Registration Confirmation email could not be sent because a valid Registration could not be retrieved from the database.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'The Registration Confirmation email could not be sent because a registration token is missing or invalid.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // request sent via AJAX ?
-        if (EE_FRONT_AJAX) {
-            echo wp_json_encode(EE_Error::get_notices(false));
-            die();
-            // or was JS disabled ?
-        } else {
-            // save errors so that they get picked up on the next request
-            EE_Error::get_notices(true, true);
-            wp_safe_redirect(
-                add_query_arg(
-                    array('e_reg_url_link' => $reg_url_link),
-                    EE_Registry::instance()->CFG->core->thank_you_page_url()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * get_ajax_content
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ajax_content()
-    {
-        if (! $this->get_txn()) {
-            return;
-        }
-        // first determine which event(s) require pre-approval or not
-        $events = array();
-        $events_requiring_pre_approval = array();
-        foreach ($this->_current_txn->registrations() as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $event = $registration->event();
-                if ($event instanceof EE_Event) {
-                    if ($registration->is_not_approved() && $registration->event() instanceof EE_Event) {
-                        $events_requiring_pre_approval[ $event->ID() ] = $event;
-                    } else {
-                        $events[ $event->ID() ] = $event;
-                    }
-                }
-            }
-        }
-        $this->display_details_for_events_requiring_pre_approval($events_requiring_pre_approval);
-        $this->display_details_for_events($events);
-    }
-
-
-    /**
-     * display_details_for_events
-     *
-     * @param EE_Event[] $events
-     * @return void
-     */
-    public function display_details_for_events($events = array())
-    {
-        if (! empty($events)) {
-            ?>
+			! $this->_current_txn->payment_method() instanceof EE_Payment_Method
+			|| (
+				// or is an offline payment method
+				$this->_current_txn->payment_method() instanceof EE_Payment_Method
+				&& $this->_current_txn->payment_method()->is_off_line()
+			)
+		) {
+			$this->_is_offline_payment_method = true;
+		}
+		// link to SPCO
+		$revisit_spco_url = add_query_arg(
+			array('ee' => '_register', 'revisit' => true, 'e_reg_url_link' => $this->_reg_url_link),
+			EE_Registry::instance()->CFG->core->reg_page_url()
+		);
+		// link to SPCO payment_options
+		$this->_SPCO_payment_options_url = $this->_primary_registrant instanceof EE_Registration
+			? $this->_primary_registrant->payment_overview_url()
+			: add_query_arg(
+				array('step' => 'payment_options'),
+				$revisit_spco_url
+			);
+		// link to SPCO attendee_information
+		$this->_SPCO_attendee_information_url = $this->_primary_registrant instanceof EE_Registration
+			? $this->_primary_registrant->edit_attendee_information_url()
+			: false;
+		do_action('AHEE__EED_Thank_You_Page__init_end', $this->_current_txn);
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+	}
+
+
+	/**
+	 * display_thank_you_page_results
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function thank_you_page_results()
+	{
+		$this->init();
+		if (! $this->_current_txn instanceof EE_Transaction) {
+			return EE_Error::get_notices();
+		}
+		// link to receipt
+		$template_args['TXN_receipt_url'] = $this->_current_txn->receipt_url();
+		if (! empty($template_args['TXN_receipt_url'])) {
+			$template_args['order_conf_desc'] = esc_html__(
+				'%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation or click the button below to view / download / print a full description of your purchases and registration information.',
+				'event_espresso'
+			);
+		} else {
+			$template_args['order_conf_desc'] = esc_html__(
+				'%1$sCongratulations%2$sYour registration has been successfully processed.%3$sCheck your email for your registration confirmation.',
+				'event_espresso'
+			);
+		}
+		$template_args['transaction'] = $this->_current_txn;
+		$template_args['revisit'] = self::getRequest()->getRequestParam('revisit', false, 'bool');
+		add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_registration_details'));
+		if ($this->_is_primary && ! $this->_current_txn->is_free()) {
+			add_action('AHEE__thank_you_page_overview_template__content', array($this, 'get_ajax_content'));
+		}
+		return EEH_Template::locate_template(
+			THANK_YOU_TEMPLATES_PATH . 'thank-you-page-overview.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * _update_server_wait_time
+	 *
+	 * @param array $thank_you_page_data thank you page portion of the incoming JSON array from the WP heartbeat data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _update_server_wait_time($thank_you_page_data = array())
+	{
+		$response['espresso_thank_you_page'] = array(
+			'still_waiting' => isset($thank_you_page_data['initial_access'])
+				? time() - $thank_you_page_data['initial_access']
+				: 0,
+			'txn_status'    => $this->_current_txn->status_ID(),
+		);
+		return $response;
+	}
+
+
+	/**
+	 * get_registration_details
+	 *
+	 * @throws EE_Error
+	 */
+	public function get_registration_details()
+	{
+		// prepare variables for displaying
+		$template_args = array();
+		$template_args['transaction'] = $this->_current_txn;
+		$template_args['reg_url_link'] = $this->_reg_url_link;
+		$template_args['is_primary'] = $this->_is_primary;
+		$template_args['SPCO_attendee_information_url'] = $this->_SPCO_attendee_information_url;
+		$template_args['resend_reg_confirmation_url'] = add_query_arg(
+			array('token' => $this->_reg_url_link, 'resend_reg_confirmation' => 'true'),
+			EE_Registry::instance()->CFG->core->thank_you_page_url()
+		);
+		// verify template arguments
+		EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['SPCO_attendee_information_url'],
+			'$SPCO_attendee_information_url'
+		);
+		echo EEH_Template::locate_template(
+			THANK_YOU_TEMPLATES_PATH . 'thank-you-page-registration-details.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * resend_reg_confirmation_email
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function resend_reg_confirmation_email()
+	{
+		$reg_url_link = self::getRequest()->getRequestParam('token');
+		// was a REG_ID passed ?
+		if ($reg_url_link) {
+			$registration = EEM_Registration::instance()->get_one(
+				array(array('REG_url_link' => $reg_url_link))
+			);
+			if ($registration instanceof EE_Registration) {
+				// resend email
+				EED_Messages::process_resend(array('_REG_ID' => $registration->ID()));
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'The Registration Confirmation email could not be sent because a valid Registration could not be retrieved from the database.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'The Registration Confirmation email could not be sent because a registration token is missing or invalid.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// request sent via AJAX ?
+		if (EE_FRONT_AJAX) {
+			echo wp_json_encode(EE_Error::get_notices(false));
+			die();
+			// or was JS disabled ?
+		} else {
+			// save errors so that they get picked up on the next request
+			EE_Error::get_notices(true, true);
+			wp_safe_redirect(
+				add_query_arg(
+					array('e_reg_url_link' => $reg_url_link),
+					EE_Registry::instance()->CFG->core->thank_you_page_url()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * get_ajax_content
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ajax_content()
+	{
+		if (! $this->get_txn()) {
+			return;
+		}
+		// first determine which event(s) require pre-approval or not
+		$events = array();
+		$events_requiring_pre_approval = array();
+		foreach ($this->_current_txn->registrations() as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$event = $registration->event();
+				if ($event instanceof EE_Event) {
+					if ($registration->is_not_approved() && $registration->event() instanceof EE_Event) {
+						$events_requiring_pre_approval[ $event->ID() ] = $event;
+					} else {
+						$events[ $event->ID() ] = $event;
+					}
+				}
+			}
+		}
+		$this->display_details_for_events_requiring_pre_approval($events_requiring_pre_approval);
+		$this->display_details_for_events($events);
+	}
+
+
+	/**
+	 * display_details_for_events
+	 *
+	 * @param EE_Event[] $events
+	 * @return void
+	 */
+	public function display_details_for_events($events = array())
+	{
+		if (! empty($events)) {
+			?>
             <div id="espresso-thank-you-page-ajax-content-dv">
                 <div id="espresso-thank-you-page-ajax-transaction-dv"></div>
                 <div id="espresso-thank-you-page-ajax-payment-dv"></div>
@@ -624,19 +624,19 @@ 
                     <div id="ee-ajax-loading-dv" class="float-left lt-blue-text">
                         <span class="dashicons dashicons-upload"></span><span id="ee-ajax-loading-msg-spn">
                             <?php esc_html_e(
-                                'loading transaction and payment information...',
-                                'event_espresso'
-                            ); ?></span>
+								'loading transaction and payment information...',
+								'event_espresso'
+							); ?></span>
                     </div>
                     <?php if (! $this->_is_offline_payment_method && ! $this->_payments_closed) : ?>
                         <p id="ee-ajax-loading-pg" class="highlight-bg small-text clear">
                             <?php echo apply_filters(
-                                'EED_Thank_You_Page__get_ajax_content__waiting_for_IPN_msg',
-                                esc_html__(
-                                    'Some payment gateways can take 15 minutes or more to return their payment notification, so please be patient if you require payment confirmation as soon as possible. Please note that as soon as everything is finalized, we will send your full payment and registration confirmation results to you via email.',
-                                    'event_espresso'
-                                )
-                            ); ?>
+								'EED_Thank_You_Page__get_ajax_content__waiting_for_IPN_msg',
+								esc_html__(
+									'Some payment gateways can take 15 minutes or more to return their payment notification, so please be patient if you require payment confirmation as soon as possible. Please note that as soon as everything is finalized, we will send your full payment and registration confirmation results to you via email.',
+									'event_espresso'
+								)
+							); ?>
                             <br/>
                             <span class="jst-rght ee-block small-text lt-grey-text">
                                 <?php esc_html_e('current wait time ', 'event_espresso'); ?>
@@ -647,120 +647,120 @@ 
                 <div class="clear"></div>
             </div>
             <?php
-        }
-    }
-
-
-    /**
-     * display_details_for_events_requiring_pre_approval
-     *
-     * @param EE_Event[] $events
-     * @return void
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function display_details_for_events_requiring_pre_approval($events = array())
-    {
-        if (! empty($events)) {
-            ?>
+		}
+	}
+
+
+	/**
+	 * display_details_for_events_requiring_pre_approval
+	 *
+	 * @param EE_Event[] $events
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function display_details_for_events_requiring_pre_approval($events = array())
+	{
+		if (! empty($events)) {
+			?>
             <div id="espresso-thank-you-page-not-approved-message-dv">
                 <h4 class="orange-text"><?php esc_html_e('Important Notice:', 'event_espresso'); ?></h4>
                 <p id="events-requiring-pre-approval-pg" class="small-text">
                     <?php echo apply_filters(
-                        'AHEE__EED_Thank_You_Page__get_ajax_content__not_approved_message',
-                        esc_html__(
-                            'The following Event(s) you have registered for do not require payment at this time and will not be billed for during this transaction. Billing will only occur after all attendees have been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
-                            'event_espresso'
-                        )
-                    ); ?>
+						'AHEE__EED_Thank_You_Page__get_ajax_content__not_approved_message',
+						esc_html__(
+							'The following Event(s) you have registered for do not require payment at this time and will not be billed for during this transaction. Billing will only occur after all attendees have been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
+							'event_espresso'
+						)
+					); ?>
                 </p>
                 <ul class="events-requiring-pre-approval-ul">
                     <?php
-                    foreach ($events as $event) {
-                        if ($event instanceof EE_Event) {
-                            echo '<li><span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>',
-                            esc_html($event->name()),
-                            '</li>';
-                        }
-                    } ?>
+					foreach ($events as $event) {
+						if ($event instanceof EE_Event) {
+							echo '<li><span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>',
+							esc_html($event->name()),
+							'</li>';
+						}
+					} ?>
                 </ul>
                 <div class="clear"></div>
             </div>
             <?php
-        }
-    }
-
-
-    /**
-     * get_transaction_details
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_transaction_details()
-    {
-        // prepare variables for displaying
-        $template_args = array();
-        $template_args['transaction'] = $this->_current_txn;
-        $template_args['reg_url_link'] = $this->_reg_url_link;
-        $template_args['primary_registrant_name'] = $this->_primary_registrant->attendee()->full_name(true);
-        // link to SPCO payment_options
-        $template_args['show_try_pay_again_link'] = $this->_show_try_pay_again_link;
-        $template_args['SPCO_payment_options_url'] = $this->_SPCO_payment_options_url;
-        // verify template arguments
-        EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['show_try_pay_again_link'],
-            '$show_try_pay_again_link'
-        );
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['SPCO_payment_options_url'],
-            '$SPCO_payment_options_url'
-        );
-        return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-transaction-details.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * get_payment_row_html
-     *
-     * @param EE_Payment $payment
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_payment_row_html(EE_Payment $payment = null)
-    {
-        $html = '';
-        if (! $payment instanceof EE_Payment) {
-            return '';
-        }
-        if (
-            $payment->payment_method() instanceof EE_Payment_Method
-            && $payment->status() === EEM_Payment::status_id_failed
-            && $payment->payment_method()->is_off_site()
-        ) {
-            // considering the registrant has made it to the Thank You page,
-            // any failed payments may actually be pending and the IPN is just slow
-            // so let's
-            $payment->set_status(EEM_Payment::status_id_pending);
-        }
-        $payment_declined_msg = $payment->STS_ID() === EEM_Payment::status_id_declined
-            ? '<br /><span class="small-text">' . esc_html($payment->gateway_response()) . '</span>'
-            : '';
-        $html .= '
+		}
+	}
+
+
+	/**
+	 * get_transaction_details
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_transaction_details()
+	{
+		// prepare variables for displaying
+		$template_args = array();
+		$template_args['transaction'] = $this->_current_txn;
+		$template_args['reg_url_link'] = $this->_reg_url_link;
+		$template_args['primary_registrant_name'] = $this->_primary_registrant->attendee()->full_name(true);
+		// link to SPCO payment_options
+		$template_args['show_try_pay_again_link'] = $this->_show_try_pay_again_link;
+		$template_args['SPCO_payment_options_url'] = $this->_SPCO_payment_options_url;
+		// verify template arguments
+		EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['show_try_pay_again_link'],
+			'$show_try_pay_again_link'
+		);
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['SPCO_payment_options_url'],
+			'$SPCO_payment_options_url'
+		);
+		return EEH_Template::locate_template(
+			THANK_YOU_TEMPLATES_PATH . 'thank-you-page-transaction-details.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * get_payment_row_html
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_payment_row_html(EE_Payment $payment = null)
+	{
+		$html = '';
+		if (! $payment instanceof EE_Payment) {
+			return '';
+		}
+		if (
+			$payment->payment_method() instanceof EE_Payment_Method
+			&& $payment->status() === EEM_Payment::status_id_failed
+			&& $payment->payment_method()->is_off_site()
+		) {
+			// considering the registrant has made it to the Thank You page,
+			// any failed payments may actually be pending and the IPN is just slow
+			// so let's
+			$payment->set_status(EEM_Payment::status_id_pending);
+		}
+		$payment_declined_msg = $payment->STS_ID() === EEM_Payment::status_id_declined
+			? '<br /><span class="small-text">' . esc_html($payment->gateway_response()) . '</span>'
+			: '';
+		$html .= '
             <tr>
                 <td>
                     ' . esc_html($payment->timestamp()) . '
                 </td>
                 <td>
                     ' . (
-            $payment->payment_method() instanceof EE_Payment_Method
-                ? esc_html($payment->payment_method()->name())
-                : esc_html__('Unknown', 'event_espresso')
-            ) . '
+			$payment->payment_method() instanceof EE_Payment_Method
+				? esc_html($payment->payment_method()->name())
+				: esc_html__('Unknown', 'event_espresso')
+			) . '
                 </td>
                 <td class="jst-rght">
                     ' . EEH_Template::format_currency($payment->amount()) . '
@@ -769,81 +769,81 @@ 
                     ' . $payment->pretty_status(true) . $payment_declined_msg . '
                 </td>
             </tr>';
-        do_action('AHEE__thank_you_page_payment_details_template__after_each_payment', $payment);
-        return $html;
-    }
-
-
-    /**
-     * get_payment_details
-     *
-     * @param EE_Payment[] $payments
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_payment_details($payments = array())
-    {
-        // prepare variables for displaying
-        $template_args = array();
-        $template_args['transaction'] = $this->_current_txn;
-        $template_args['reg_url_link'] = $this->_reg_url_link;
-        $template_args['payments'] = array();
-        foreach ($payments as $payment) {
-            $template_args['payments'][] = $this->get_payment_row_html($payment);
-        }
-        // create a hacky payment object, but dont save it
-        $payment = EE_Payment::new_instance(
-            array(
-                'TXN_ID'        => $this->_current_txn->ID(),
-                'STS_ID'        => EEM_Payment::status_id_pending,
-                'PAY_timestamp' => time(),
-                'PAY_amount'    => $this->_current_txn->total(),
-                'PMD_ID'        => $this->_current_txn->payment_method_ID(),
-            )
-        );
-        $payment_method = $this->_current_txn->payment_method();
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base) {
-            $template_args['gateway_content'] = $payment_method->type_obj()->payment_overview_content($payment);
-        } else {
-            $template_args['gateway_content'] = '';
-        }
-        // link to SPCO payment_options
-        $template_args['show_try_pay_again_link'] = $this->_show_try_pay_again_link;
-        $template_args['SPCO_payment_options_url'] = $this->_SPCO_payment_options_url;
-        // verify template arguments
-        EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
-        EEH_Template_Validator::verify_isnt_null($template_args['payments'], '$payments');
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['show_try_pay_again_link'],
-            '$show_try_pay_again_link'
-        );
-        EEH_Template_Validator::verify_isnt_null($template_args['gateway_content'], '$gateway_content');
-        EEH_Template_Validator::verify_isnt_null(
-            $template_args['SPCO_payment_options_url'],
-            '$SPCO_payment_options_url'
-        );
-        return EEH_Template::locate_template(
-            THANK_YOU_TEMPLATES_PATH . 'thank-you-page-payment-details.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * get_payment_details
-     *
-     * @param array $payments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_new_payments($payments = array())
-    {
-        $payments_html = '';
-        // prepare variables for displaying
-        foreach ($payments as $payment) {
-            $payments_html .= $this->get_payment_row_html($payment);
-        }
-        return $payments_html;
-    }
+		do_action('AHEE__thank_you_page_payment_details_template__after_each_payment', $payment);
+		return $html;
+	}
+
+
+	/**
+	 * get_payment_details
+	 *
+	 * @param EE_Payment[] $payments
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_payment_details($payments = array())
+	{
+		// prepare variables for displaying
+		$template_args = array();
+		$template_args['transaction'] = $this->_current_txn;
+		$template_args['reg_url_link'] = $this->_reg_url_link;
+		$template_args['payments'] = array();
+		foreach ($payments as $payment) {
+			$template_args['payments'][] = $this->get_payment_row_html($payment);
+		}
+		// create a hacky payment object, but dont save it
+		$payment = EE_Payment::new_instance(
+			array(
+				'TXN_ID'        => $this->_current_txn->ID(),
+				'STS_ID'        => EEM_Payment::status_id_pending,
+				'PAY_timestamp' => time(),
+				'PAY_amount'    => $this->_current_txn->total(),
+				'PMD_ID'        => $this->_current_txn->payment_method_ID(),
+			)
+		);
+		$payment_method = $this->_current_txn->payment_method();
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base) {
+			$template_args['gateway_content'] = $payment_method->type_obj()->payment_overview_content($payment);
+		} else {
+			$template_args['gateway_content'] = '';
+		}
+		// link to SPCO payment_options
+		$template_args['show_try_pay_again_link'] = $this->_show_try_pay_again_link;
+		$template_args['SPCO_payment_options_url'] = $this->_SPCO_payment_options_url;
+		// verify template arguments
+		EEH_Template_Validator::verify_instanceof($template_args['transaction'], '$transaction', 'EE_Transaction');
+		EEH_Template_Validator::verify_isnt_null($template_args['payments'], '$payments');
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['show_try_pay_again_link'],
+			'$show_try_pay_again_link'
+		);
+		EEH_Template_Validator::verify_isnt_null($template_args['gateway_content'], '$gateway_content');
+		EEH_Template_Validator::verify_isnt_null(
+			$template_args['SPCO_payment_options_url'],
+			'$SPCO_payment_options_url'
+		);
+		return EEH_Template::locate_template(
+			THANK_YOU_TEMPLATES_PATH . 'thank-you-page-payment-details.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * get_payment_details
+	 *
+	 * @param array $payments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_new_payments($payments = array())
+	{
+		$payments_html = '';
+		// prepare variables for displaying
+		foreach ($payments as $payment) {
+			$payments_html .= $this->get_payment_row_html($payment);
+		}
+		return $payments_html;
+	}
 }

modules/single_page_checkout/templates/registration_page_wrapper.template.php

Spacing +3 added lines, -3 removed lines

@@ -14,7 +14,7 @@ 
 
 <div id="ee-single-page-checkout-dv" class="">
     <?php
-    if (! $empty_cart) {
+    if ( ! $empty_cart) {
         if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) { ?>
             <p id="spco-registration-time-limit-pg" class="spco-steps-pg ee-attention important-notice"
                style="display: none;">
@@ -31,7 +31,7 @@ 
                 <span id="spco-registration-expiration-spn" class="" style="display:none;"></span>
             </p>
         <?php }
-        if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
+        if ( ! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
             ?>
             <h2 id="spco-steps-big-hdr" class="spco-steps-big-hdr">
                 <?php esc_html_e(' Steps', 'event_espresso'); ?>
@@ -77,7 +77,7 @@ 
         foreach ($reg_steps as $reg_step) {
             if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
                 $slug = $reg_step->slug();
-                do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
+                do_action('AHEE__'.$slug.'__reg_step_start', $reg_step);
                 // todo: deprecate hook AHEE__registration_page_attendee_information__start
                 ?>
                 <div id="spco-<?php echo esc_attr($slug); ?>-dv"

Indentation +43 added lines, -43 removed lines

@@ -16,38 +16,38 @@ 
 
 <div id="ee-single-page-checkout-dv" class="">
     <?php
-    if (! $empty_cart) {
-        if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) { ?>
+	if (! $empty_cart) {
+		if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) { ?>
             <p id="spco-registration-time-limit-pg" class="spco-steps-pg ee-attention important-notice"
                style="display: none;">
                 <?php echo sprintf(
-                    apply_filters(
-                        'FHEE__registration_page_wrapper_template___time_limit',
-                        esc_html__('You have %1$s to complete your registration.', 'event_espresso')
-                    ),
-                    '<span id="spco-registration-time-limit-spn" class="spco-registration-time-limit-spn">'
-                    . $registration_time_limit
-                    . '</span>'
-                );
-                ?>
+					apply_filters(
+						'FHEE__registration_page_wrapper_template___time_limit',
+						esc_html__('You have %1$s to complete your registration.', 'event_espresso')
+					),
+					'<span id="spco-registration-time-limit-spn" class="spco-registration-time-limit-spn">'
+					. $registration_time_limit
+					. '</span>'
+				);
+				?>
                 <span id="spco-registration-expiration-spn" class="" style="display:none;"></span>
             </p>
         <?php }
-        if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
-            ?>
+		if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
+			?>
             <h2 id="spco-steps-big-hdr" class="spco-steps-big-hdr">
                 <?php esc_html_e(' Steps', 'event_espresso'); ?>
             </h2>
 
             <div id="spco-steps-display-dv">
                 <?php
-                $step_nmbr = 1;
-                $total_steps = count($reg_steps) - 1;
-                foreach ($reg_steps as $reg_step) {
-                    if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
-                        $slug = $reg_step->slug();
-                        $step_display_dv_class = $reg_step->is_current_step() ? 'active-step' : 'inactive-step';
-                        ?>
+				$step_nmbr = 1;
+				$total_steps = count($reg_steps) - 1;
+				foreach ($reg_steps as $reg_step) {
+					if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
+						$slug = $reg_step->slug();
+						$step_display_dv_class = $reg_step->is_current_step() ? 'active-step' : 'inactive-step';
+						?>
                         <div id="spco-step-<?php echo esc_attr($slug); ?>-display-dv"
                              class="spco-step-display-dv <?php echo esc_attr($step_display_dv_class); ?> steps-<?php echo esc_attr($total_steps); ?>"
                         >
@@ -60,28 +60,28 @@ 
                         </div>
 
                         <?php
-                        if ($step_nmbr < $total_steps) { ?>
+						if ($step_nmbr < $total_steps) { ?>
                             <div class="spco-step-arrow-dv">&raquo;</div>
                             <?php
-                        }
-                        $step_nmbr++;
-                    }
-                }
-                ?>
+						}
+						$step_nmbr++;
+					}
+				}
+				?>
                 <div class="clear-float"></div>
             </div>
 
             <?php
-        }
+		}
 
-        do_action('AHEE__SPCO__before_registration_steps');
-        $step_nmbr = 1;
-        foreach ($reg_steps as $reg_step) {
-            if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
-                $slug = $reg_step->slug();
-                do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
-                // todo: deprecate hook AHEE__registration_page_attendee_information__start
-                ?>
+		do_action('AHEE__SPCO__before_registration_steps');
+		$step_nmbr = 1;
+		foreach ($reg_steps as $reg_step) {
+			if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
+				$slug = $reg_step->slug();
+				do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
+				// todo: deprecate hook AHEE__registration_page_attendee_information__start
+				?>
                 <div id="spco-<?php echo esc_attr($slug); ?>-dv"
                      class="spco-step-dv <?php echo esc_attr($reg_step->div_class()); ?>"
                 >
@@ -89,20 +89,20 @@ 
                     <?php do_action('AHEE__SPCO_after_reg_step_form', $slug, $next_step); ?>
                 </div>
                 <?php $step_nmbr++;
-            }
-        }
-        do_action('AHEE__SPCO__after_registration_steps');
-    } else {
-        ?>
+			}
+		}
+		do_action('AHEE__SPCO__after_registration_steps');
+	} else {
+		?>
         <h3 id="spco-empty-cart-hdr" class="spco-step-title-hdr">
             <?php esc_html_e('Nothing in your Event Queue', 'event_espresso'); ?>
         </h3>
         <p><?php echo wp_kses($empty_msg, AllowedTags::getWithFormTags()); ?></p>
         <?php echo wp_kses($cookies_not_set_msg, AllowedTags::getWithFormTags()); ?>
         <?php
-    }
-    do_action('AHEE__SPCO__reg_form_footer');
-    ?>
+	}
+	do_action('AHEE__SPCO__reg_form_footer');
+	?>
 
 </div>
 

modules/single_page_checkout/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Spacing +93 added lines, -93 removed lines

@@ -65,11 +65,11 @@ 
 
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+        EE_Registry::$i18n_js_strings['required_field'] = esc_html__(
             ' is a required question.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+        EE_Registry::$i18n_js_strings['required_multi_field'] = esc_html__(
             ' is a required question. Please enter a value for at least one of the options.',
             'event_espresso'
         );
@@ -77,7 +77,7 @@ 
             'Please answer all required questions correctly before proceeding.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+        EE_Registry::$i18n_js_strings['attendee_info_copied'] = sprintf(
             esc_html_x(
                 'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
                 'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
@@ -85,11 +85,11 @@ 
             ),
             '<br/>'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+        EE_Registry::$i18n_js_strings['attendee_info_copy_error'] = esc_html__(
             'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+        EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
             'You must enter a valid email address.',
             'event_espresso'
         );
@@ -152,7 +152,7 @@ 
         ];
 
         // if this isn't a revisit, and they have the privacy consent box enabled, add it
-        if (! $this->checkout->revisit && $reg_config->isConsentCheckboxEnabled()) {
+        if ( ! $this->checkout->revisit && $reg_config->isConsentCheckboxEnabled()) {
             $extra_inputs_section->add_subsections(
                 [
                     'consent_box' => new EE_Form_Section_Proper(
@@ -201,15 +201,15 @@ 
                     $registration instanceof EE_Registration
                     && $this->checkout->visit_allows_processing_of_this_registration($registration)
                 ) {
-                    $subsections[ $registration->reg_url_link() ]                       =
+                    $subsections[$registration->reg_url_link()]                       =
                         $this->_registrations_reg_form($registration);
-                    $template_args['registrations'][ $registration->reg_url_link() ]    = $registration;
-                    $template_args['ticket_count'][ $registration->ticket()->ID() ]     = isset(
-                        $template_args['ticket_count'][ $registration->ticket()->ID() ]
+                    $template_args['registrations'][$registration->reg_url_link()]    = $registration;
+                    $template_args['ticket_count'][$registration->ticket()->ID()]     = isset(
+                        $template_args['ticket_count'][$registration->ticket()->ID()]
                     )
-                        ? $template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+                        ? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
                         : 1;
-                    $ticket_line_item                                                   =
+                    $ticket_line_item =
                         EEH_Line_Item::get_line_items_by_object_type_and_IDs(
                             $this->checkout->cart->get_grand_total(),
                             'Ticket',
@@ -218,7 +218,7 @@ 
                     $ticket_line_item                                                   = is_array($ticket_line_item)
                         ? reset($ticket_line_item)
                         : $ticket_line_item;
-                    $template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+                    $template_args['ticket_line_item'][$registration->ticket()->ID()] =
                         $Line_Item_Display->display_line_item($ticket_line_item);
                     if ($registration->is_primary_registrant()) {
                         $primary_registrant = $registration->reg_url_link();
@@ -232,10 +232,10 @@ 
                     : $this->_auto_copy_attendee_info();
                 // generate hidden input
                 if (
-                    isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+                    isset($subsections[$primary_registrant])
+                    && $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
                 ) {
-                    $subsections[ $primary_registrant ]->add_subsections(
+                    $subsections[$primary_registrant]->add_subsections(
                         $copy_options,
                         'primary_registrant',
                         false
@@ -247,8 +247,8 @@ 
         // Set the registration form template (default: one form per ticket details table).
         // We decide the template to used based on the number of forms.
         $this->_template = $this->reg_form_count > 1
-            ? SPCO_REG_STEPS_PATH . $this->_slug . '/attendee_info_main.template.php'
-            : SPCO_REG_STEPS_PATH . $this->_slug . '/attendee_info_single.template.php';
+            ? SPCO_REG_STEPS_PATH . $this->_slug.'/attendee_info_main.template.php'
+            : SPCO_REG_STEPS_PATH.$this->_slug.'/attendee_info_single.template.php';
 
         return new EE_Form_Section_Proper(
             [
@@ -282,7 +282,7 @@ 
         $form_args = [];
         // verify that registration has valid event
         if ($registration->event() instanceof EE_Event) {
-            $field_name      = 'Event_Question_Group.'
+            $field_name = 'Event_Question_Group.'
                                . EEM_Event_Question_Group::instance()->fieldNameForContext(
                                    $registration->is_primary_registrant()
                                );
@@ -305,7 +305,7 @@ 
             if ($question_groups) {
                 // array of params to pass to parent constructor
                 $form_args = [
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+                    'html_id'         => 'ee-registration-'.$registration->reg_url_link(),
                     'html_class'      => 'ee-reg-form-attendee-dv',
                     'html_style'      => $this->checkout->admin_request
                         ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
@@ -327,7 +327,7 @@ 
                 ];
                 foreach ($question_groups as $question_group) {
                     if ($question_group instanceof EE_Question_Group) {
-                        $form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
+                        $form_args['subsections'][$question_group->identifier()] = $this->_question_group_reg_form(
                             $registration,
                             $question_group
                         );
@@ -361,7 +361,7 @@ 
         $attendee_nmbr++;
 
         // Increment the reg forms number if form is valid.
-        if (! empty($form_args)) {
+        if ( ! empty($form_args)) {
             $this->reg_form_count++;
         }
 
@@ -384,7 +384,7 @@ 
         // generate hidden input
         return new EE_Hidden_Input(
             [
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+                'html_id' => 'additional-attendee-reg-info-'.$registration->reg_url_link(),
                 'default' => $additional_attendee_reg_info,
             ]
         );
@@ -405,12 +405,12 @@ 
     {
         // array of params to pass to parent constructor
         $form_args = [
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
+            'html_id'         => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-'.$registration->ID(),
             'html_class'      => $this->checkout->admin_request
                 ? 'form-table ee-reg-form-qstn-grp-dv'
                 : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-'
-                                 . $registration->ID() . '-lbl',
+            'html_label_id'   => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-'
+                                 . $registration->ID().'-lbl',
             'subsections'     => [
                 'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
             ],
@@ -421,7 +421,7 @@ 
         // where params
         $query_params = ['QST_deleted' => 0];
         // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
+        if ( ! $this->checkout->admin_request) {
             $query_params['QST_admin_only'] = ['!=', true];
         }
         $questions = $question_group->get_many_related(
@@ -455,7 +455,7 @@ 
                 $identifier                              = $question->is_system_question()
                     ? $question->system_ID()
                     : $question->ID();
-                $form_args['subsections'][ $identifier ] = $this->reg_form_question($registration, $question);
+                $form_args['subsections'][$identifier] = $this->reg_form_question($registration, $question);
             }
         }
         $form_args['subsections'] = apply_filters(
@@ -567,7 +567,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . '/_auto_copy_attendee_info.template.php',
+                SPCO_REG_STEPS_PATH.$this->_slug.'/_auto_copy_attendee_info.template.php',
                 apply_filters(
                     'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
                     []
@@ -596,20 +596,20 @@ 
             if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
                 // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
                 if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name                          = $registration->ticket()->name();
-                    $item_name                          .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
+                    $item_name = $registration->ticket()->name();
+                    $item_name .= $registration->ticket()->description() !== ''
+                        ? ' - '.$registration->ticket()->description()
                         : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-'
+                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-'
                                                 . $registration->ticket()->ID()
-                                                . ']' ] =
+                                                . ']'] =
                         new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+                            '<h6 class="spco-copy-attendee-event-hdr">'.$item_name.'</h6>'
                         );
-                    $prev_ticket                        = $registration->ticket()->ID();
+                    $prev_ticket = $registration->ticket()->ID();
                 }
 
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] =
+                $copy_attendee_info_inputs['spco_copy_attendee_chk['.$registration->ID().']'] =
                     new EE_Checkbox_Multi_Input(
                         [
                             $registration->ID() => sprintf(
@@ -618,7 +618,7 @@ 
                             ),
                         ],
                         [
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+                            'html_id'                 => 'spco-copy-attendee-chk-'.$registration->reg_url_link(),
                             'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
                             'display_html_label_text' => false,
                         ]
@@ -664,7 +664,7 @@ 
             $registration,
             $question->system_ID()
         );
-        $answer       = $answer_value === null
+        $answer = $answer_value === null
             ? EEM_Answer::instance()->get_one(
                 [['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
             )
@@ -683,14 +683,14 @@ 
         }
         // verify instance
         if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
+            if ( ! empty($answer_value)) {
                 $answer->set('ANS_value', $answer_value);
             }
             $answer->cache('Question', $question);
             // remember system ID had a bug where sometimes it could be null
             $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
+                ? $question->system_ID().'-'.$registration->reg_url_link()
+                : $question->ID().'-'.$registration->reg_url_link();
             $registration->cache('Answer', $answer, $answer_cache_id);
         }
         return $this->_generate_question_input($registration, $question, $answer);
@@ -713,7 +713,7 @@ 
         $identifier                               = $question->is_system_question()
             ? $question->system_ID()
             : $question->ID();
-        $this->_required_questions[ $identifier ] = $question->required();
+        $this->_required_questions[$identifier] = $question->required();
         add_filter(
             'FHEE__EE_Question__generate_form_input__country_options',
             [$this, 'use_cached_countries_for_form_input'],
@@ -726,18 +726,18 @@ 
             10,
             4
         );
-        $input_constructor_args                  = [
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+        $input_constructor_args = [
+            'html_name'        => 'ee_reg_qstn['.$registration->ID().']['.$identifier.']',
+            'html_id'          => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
+            'html_class'       => 'ee-reg-qstn ee-reg-qstn-'.$identifier,
+            'html_label_id'    => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
             'html_label_class' => 'ee-reg-qstn',
         ];
         $input_constructor_args['html_label_id'] .= '-lbl';
         if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id']       .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+            $input_constructor_args['html_name']     .= '['.$answer->ID().']';
+            $input_constructor_args['html_id']       .= '-'.$answer->ID();
+            $input_constructor_args['html_label_id'] .= '-'.$answer->ID();
         }
         $form_input = $question->generate_form_input(
             $registration,
@@ -781,10 +781,10 @@ 
         $countries = $this->checkout->action === 'process_reg_step'
             ? EEM_Country::instance()->get_all_countries()
             : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
+                    $country_options[$country->ID()] = $country->name();
                 }
             }
         }
@@ -830,10 +830,10 @@ 
         $states        = $this->checkout->action === 'process_reg_step'
             ? EEM_State::instance()->get_all_states()
             : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+                    $state_options[$state->country()->name()][$state->ID()] = $state->name();
                 }
             }
         }
@@ -877,7 +877,7 @@ 
             );
             return false;
         }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+        if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
             EE_Error::add_error(
                 esc_html__(
                     'A valid transaction could not be initiated for processing your registrations.',
@@ -904,7 +904,7 @@ 
                     '(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
                     'event_espresso'
                 ),
-                '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
+                '<a href="'.get_post_type_archive_link('espresso_events').'" >',
                 '</a>',
                 '<br />'
             );
@@ -924,7 +924,7 @@ 
             // but return immediately if the previous step exited early due to errors
             return false;
         }
-        if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+        if ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
             // generate a correctly translated string for all possible singular/plural combinations
             if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
                 $error_msg = sprintf(
@@ -1007,7 +1007,7 @@ 
         // grab the saved registrations from the transaction
         foreach ($registrations as $registration) {
             // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 EE_Error::add_error(
                     esc_html__(
                         'An invalid Registration object was discovered when attempting to process your registration information.',
@@ -1021,12 +1021,12 @@ 
             }
             $reg_url_link = $registration->reg_url_link();
             // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
+            if ( ! empty($reg_url_link)) {
                 // should this registration be processed during this visit ?
                 if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
                     // if NOT revisiting, then let's save the registration now,
                     // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
+                    if ( ! $this->checkout->revisit) {
                         $registration->save();
                     }
                     /**
@@ -1052,18 +1052,18 @@ 
 
                     // Houston, we have a registration!
                     $att_nmbr++;
-                    $this->_attendee_data[ $reg_url_link ] = [];
+                    $this->_attendee_data[$reg_url_link] = [];
                     // grab any existing related answer objects
                     $this->_registration_answers = $registration->answers();
                     // unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-                    if (isset($valid_data[ $reg_url_link ])) {
+                    if (isset($valid_data[$reg_url_link])) {
                         // do we need to copy basic info from primary attendee ?
-                        $copy_primary = isset($valid_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                        && absint($valid_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
+                        $copy_primary = isset($valid_data[$reg_url_link]['additional_attendee_reg_info'])
+                                        && absint($valid_data[$reg_url_link]['additional_attendee_reg_info']) === 0;
                         // filter form input data for this registration
-                        $valid_data[ $reg_url_link ] = (array) apply_filters(
+                        $valid_data[$reg_url_link] = (array) apply_filters(
                             'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-                            $valid_data[ $reg_url_link ]
+                            $valid_data[$reg_url_link]
                         );
                         if (isset($valid_data['primary_attendee'])) {
                             $primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
@@ -1072,8 +1072,8 @@ 
                             unset($valid_data['primary_attendee']);
                         }
                         // now loop through our array of valid post data && process attendee reg forms
-                        foreach ($valid_data[ $reg_url_link ] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections, true)) {
+                        foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
+                            if ( ! in_array($form_section, $non_input_form_sections, true)) {
                                 foreach ($form_inputs as $form_input => $input_value) {
                                     // check for critical inputs
                                     if (
@@ -1090,13 +1090,13 @@ 
                                         && ! empty($input_value)
                                         && $reg_url_link === $primary_registrant['line_item_id']
                                     ) {
-                                        $primary_registrant[ $form_input ] = $input_value;
+                                        $primary_registrant[$form_input] = $input_value;
                                     } elseif (
                                         $copy_primary
                                               && $input_value === null
-                                              && isset($primary_registrant[ $form_input ])
+                                              && isset($primary_registrant[$form_input])
                                     ) {
-                                        $input_value = $primary_registrant[ $form_input ];
+                                        $input_value = $primary_registrant[$form_input];
                                     }
                                     // now attempt to save the input data
                                     if (
@@ -1136,15 +1136,15 @@ 
                         $attendee = $this->checkout->primary_attendee_obj;
                     } else {
                         // ensure critical details are set for additional attendees
-                        $this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
+                        $this->_attendee_data[$reg_url_link] = $att_nmbr > 1
                             ? $this->_copy_critical_attendee_details_from_primary_registrant(
-                                $this->_attendee_data[ $reg_url_link ]
+                                $this->_attendee_data[$reg_url_link]
                             )
-                            : $this->_attendee_data[ $reg_url_link ];
+                            : $this->_attendee_data[$reg_url_link];
                         // execute create attendee command (which may return an existing attendee)
                         $attendee = EE_Registry::instance()->BUS->execute(
                             new CreateAttendeeCommand(
-                                $this->_attendee_data[ $reg_url_link ],
+                                $this->_attendee_data[$reg_url_link],
                                 $registration
                             )
                         );
@@ -1155,7 +1155,7 @@ 
                     }
                     // add relation to registration, set attendee ID, and cache attendee
                     $this->_associate_attendee_with_registration($registration, $attendee);
-                    if (! $registration->attendee() instanceof EE_Attendee) {
+                    if ( ! $registration->attendee() instanceof EE_Attendee) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html_x(
@@ -1205,7 +1205,7 @@ 
                     __LINE__
                 );
                 // remove malformed data
-                unset($valid_data[ $reg_url_link ]);
+                unset($valid_data[$reg_url_link]);
                 return false;
             }
         } // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
@@ -1255,10 +1255,10 @@ 
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
         $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
+            ? $form_input.'-'.$registration->reg_url_link()
             : (string) $form_input;
-        $answer_is_obj   = isset($this->_registration_answers[ $answer_cache_id ])
-                           && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer;
+        $answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
+                           && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer;
         // rename form_inputs if they are EE_Attendee properties
         switch ((string) $form_input) {
             case 'state':
@@ -1274,24 +1274,24 @@ 
                 break;
 
             default:
-                $ATT_input = 'ATT_' . $form_input;
+                $ATT_input = 'ATT_'.$form_input;
                 $attendee_property = EEM_Attendee::instance()->has_field($ATT_input);
-                $form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
+                $form_input        = $attendee_property ? 'ATT_'.$form_input : $form_input;
         }
         // if this form input has a corresponding attendee property
         if ($attendee_property) {
-            $this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
+            $this->_attendee_data[$registration->reg_url_link()][$form_input] = $input_value;
             if ($answer_is_obj) {
                 // and delete the corresponding answer since we won't be storing this data in that object
-                $registration->_remove_relation_to($this->_registration_answers[ $answer_cache_id ], 'Answer');
-                $this->_registration_answers[ $answer_cache_id ]->delete_permanently();
+                $registration->_remove_relation_to($this->_registration_answers[$answer_cache_id], 'Answer');
+                $this->_registration_answers[$answer_cache_id]->delete_permanently();
             }
             return true;
         }
         if ($answer_is_obj) {
             // save this data to the answer object
-            $this->_registration_answers[ $answer_cache_id ]->set_value($input_value);
-            $result = $this->_registration_answers[ $answer_cache_id ]->save();
+            $this->_registration_answers[$answer_cache_id]->set_value($input_value);
+            $result = $this->_registration_answers[$answer_cache_id]->save();
             return $result !== false;
         }
         foreach ($this->_registration_answers as $answer) {
@@ -1318,7 +1318,7 @@ 
     ) {
         if (empty($input_value)) {
             // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[ $form_input ]) || ! $this->_required_questions[ $form_input ]) {
+            if ( ! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
                 return true;
             }
             switch ($form_input) {
@@ -1416,7 +1416,7 @@ 
                 false
             )
         ) {
-            $address_details           = [
+            $address_details = [
                 'ATT_address',
                 'ATT_address2',
                 'ATT_city',
@@ -1429,10 +1429,10 @@ 
         }
         foreach ($critical_attendee_details as $critical_attendee_detail) {
             if (
-                ! isset($attendee_data[ $critical_attendee_detail ])
-                || empty($attendee_data[ $critical_attendee_detail ])
+                ! isset($attendee_data[$critical_attendee_detail])
+                || empty($attendee_data[$critical_attendee_detail])
             ) {
-                $attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
+                $attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(
                     $critical_attendee_detail
                 );
             }

Indentation +1451 added lines, -1451 removed lines

@@ -17,1458 +17,1458 @@
  */
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step
 {
-    /**
-     * @type bool $_print_copy_info
-     */
-    private $_print_copy_info = false;
-
-    /**
-     * @type array $_attendee_data
-     */
-    private $_attendee_data = [];
-
-    /**
-     * @type array $_required_questions
-     */
-    private $_required_questions = [];
-
-    /**
-     * @type array $_registration_answers
-     */
-    private $_registration_answers = [];
-
-    /**
-     * @type int $reg_form_count
-     */
-    protected $reg_form_count = 0;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->request  = EED_Single_Page_Checkout::getRequest();
-        $this->_slug    = 'attendee_information';
-        $this->_name    = esc_html__('Attendee Information', 'event_espresso');
-        $this->checkout = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
-        );
-    }
-
-
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
-            ' is a required question.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
-            ' is a required question. Please enter a value for at least one of the options.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
-            'Please answer all required questions correctly before proceeding.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
-            esc_html_x(
-                'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
-                'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
-                'event_espresso'
-            ),
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
-            'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
-            'You must enter a valid email address.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
-            'You must enter a valid email address and answer all other required questions before you can proceed.',
-            'event_espresso'
-        );
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step()
-    {
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function generate_reg_form()
-    {
-        /**
-         * @var $reg_config EE_Registration_Config
-         */
-        $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
-
-        $this->_print_copy_info = $reg_config->copyAttendeeInfo();
-
-        // Init reg forms count.
-        $this->reg_form_count = 0;
-
-        $primary_registrant = null;
-        // autoload Line_Item_Display classes
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display = new EE_Line_Item_Display();
-        // calculate taxes
-        $Line_Item_Display->display_line_item(
-            $this->checkout->cart->get_grand_total(),
-            ['set_tax_rate' => true]
-        );
-        /** @var $subsections EE_Form_Section_Proper[] */
-        $extra_inputs_section = $this->reg_step_hidden_inputs();
-        $subsections          = [
-            'default_hidden_inputs' => $extra_inputs_section,
-        ];
-
-        // if this isn't a revisit, and they have the privacy consent box enabled, add it
-        if (! $this->checkout->revisit && $reg_config->isConsentCheckboxEnabled()) {
-            $extra_inputs_section->add_subsections(
-                [
-                    'consent_box' => new EE_Form_Section_Proper(
-                        [
-                            'layout_strategy' =>
-                                new EE_Template_Layout(
-                                    [
-                                        'input_template_file' => SPCO_REG_STEPS_PATH
-                                                                 . $this->_slug
-                                                                 . '/privacy_consent.template.php',
-                                    ]
-                                ),
-                            'subsections'     => [
-                                'consent' => new EE_Checkbox_Multi_Input(
-                                    [
-                                        'consent' => $reg_config->getConsentCheckboxLabelText(),
-                                    ],
-                                    [
-                                        'required'                          => true,
-                                        'required_validation_error_message' => esc_html__(
-                                            'You must consent to these terms in order to register.',
-                                            'event_espresso'
-                                        ),
-                                        'html_label_text'                   => '',
-                                    ]
-                                ),
-                            ],
-                        ]
-                    ),
-                ],
-                null,
-                false
-            );
-        }
-        $template_args = [
-            'revisit'       => $this->checkout->revisit,
-            'registrations' => [],
-            'ticket_count'  => [],
-        ];
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        if ($registrations) {
-            foreach ($registrations as $registration) {
-                // can this registration be processed during this visit ?
-                if (
-                    $registration instanceof EE_Registration
-                    && $this->checkout->visit_allows_processing_of_this_registration($registration)
-                ) {
-                    $subsections[ $registration->reg_url_link() ]                       =
-                        $this->_registrations_reg_form($registration);
-                    $template_args['registrations'][ $registration->reg_url_link() ]    = $registration;
-                    $template_args['ticket_count'][ $registration->ticket()->ID() ]     = isset(
-                        $template_args['ticket_count'][ $registration->ticket()->ID() ]
-                    )
-                        ? $template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
-                        : 1;
-                    $ticket_line_item                                                   =
-                        EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                            $this->checkout->cart->get_grand_total(),
-                            'Ticket',
-                            [$registration->ticket()->ID()]
-                        );
-                    $ticket_line_item                                                   = is_array($ticket_line_item)
-                        ? reset($ticket_line_item)
-                        : $ticket_line_item;
-                    $template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
-                        $Line_Item_Display->display_line_item($ticket_line_item);
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $registration->reg_url_link();
-                    }
-                }
-            }
-
-            if ($primary_registrant && count($registrations) > 1) {
-                $copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
-                    ? $this->_copy_attendee_info_form()
-                    : $this->_auto_copy_attendee_info();
-                // generate hidden input
-                if (
-                    isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
-                ) {
-                    $subsections[ $primary_registrant ]->add_subsections(
-                        $copy_options,
-                        'primary_registrant',
-                        false
-                    );
-                }
-            }
-        }
-
-        // Set the registration form template (default: one form per ticket details table).
-        // We decide the template to used based on the number of forms.
-        $this->_template = $this->reg_form_count > 1
-            ? SPCO_REG_STEPS_PATH . $this->_slug . '/attendee_info_main.template.php'
-            : SPCO_REG_STEPS_PATH . $this->_slug . '/attendee_info_single.template.php';
-
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => $this->_template, // layout_template
-                        'template_args'        => $template_args,
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _registrations_reg_form(EE_Registration $registration)
-    {
-        static $attendee_nmbr = 1;
-        $form_args = [];
-        // verify that registration has valid event
-        if ($registration->event() instanceof EE_Event) {
-            $field_name      = 'Event_Question_Group.'
-                               . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                                   $registration->is_primary_registrant()
-                               );
-            $question_groups = $registration->event()->question_groups(
-                apply_filters(
-                // @codingStandardsIgnoreStart
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-                    // @codingStandardsIgnoreEnd
-                    [
-                        [
-                            'Event.EVT_ID' => $registration->event()->ID(),
-                            $field_name    => true,
-                            'QSG_deleted'  => false
-                        ],
-                        'order_by' => ['QSG_order' => 'ASC'],
-                    ],
-                    $registration,
-                    $this
-                )
-            );
-            if ($question_groups) {
-                // array of params to pass to parent constructor
-                $form_args = [
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => [],
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        [
-                            'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
-                            'legend_text'  => sprintf(
-                                esc_html_x(
-                                    'Attendee %d',
-                                    'Attendee 123',
-                                    'event_espresso'
-                                ),
-                                $attendee_nmbr
-                            ),
-                        ]
-                    ),
-                ];
-                foreach ($question_groups as $question_group) {
-                    if ($question_group instanceof EE_Question_Group) {
-                        $form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
-                            $registration,
-                            $question_group
-                        );
-                    }
-                }
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
-                    $registration
-                );
-
-                /**
-                 * @var $reg_config EE_Registration_Config
-                 */
-                $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
-
-                // If we have question groups for additional attendees, then display the copy options
-                $this->_print_copy_info = apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form___printCopyInfo',
-                    $attendee_nmbr > 1 && $reg_config->copyAttendeeInfo(),
-                    $attendee_nmbr
-                );
-
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
-                        $registration
-                    );
-                }
-            }
-        }
-        $attendee_nmbr++;
-
-        // Increment the reg forms number if form is valid.
-        if (! empty($form_args)) {
-            $this->reg_form_count++;
-        }
-
-        return ! empty($form_args)
-            ? new EE_Form_Section_Proper($form_args)
-            : new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param bool            $additional_attendee_reg_info
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    private function _additional_attendee_reg_info_input(
-        EE_Registration $registration,
-        $additional_attendee_reg_info = true
-    ) {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            [
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
-                'default' => $additional_attendee_reg_info,
-            ]
-        );
-    }
-
-
-    /**
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
-    {
-        // array of params to pass to parent constructor
-        $form_args = [
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
-            'html_class'      => $this->checkout->admin_request
-                ? 'form-table ee-reg-form-qstn-grp-dv'
-                : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-'
-                                 . $registration->ID() . '-lbl',
-            'subsections'     => [
-                'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
-            ],
-            'layout_strategy' => $this->checkout->admin_request
-                ? new EE_Admin_Two_Column_Layout()
-                : new EE_Div_Per_Section_Layout(),
-        ];
-        // where params
-        $query_params = ['QST_deleted' => 0];
-        // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
-            $query_params['QST_admin_only'] = ['!=', true];
-        }
-        $questions = $question_group->get_many_related(
-            'Question',
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
-                [
-                    $query_params,
-                    'order_by' => [
-                        'Question_Group_Question.QGQ_order' => 'ASC',
-                    ],
-                ],
-                $question_group,
-                $registration,
-                $this
-            )
-        );
-        // filter for additional content before questions
-        $form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
-        // loop thru questions
-        foreach ($questions as $question) {
-            if ($question instanceof EE_Question) {
-                $identifier                              = $question->is_system_question()
-                    ? $question->system_ID()
-                    : $question->ID();
-                $form_args['subsections'][ $identifier ] = $this->reg_form_question($registration, $question);
-            }
-        }
-        $form_args['subsections'] = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
-            $form_args['subsections'],
-            $registration,
-            $question_group,
-            $this
-        );
-        // filter for additional content after questions
-        $form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
-        // d($form_args);
-        $question_group_reg_form = new EE_Form_Section_Proper($form_args);
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            $question_group_reg_form,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param EE_Question_Group $question_group
-     * @return    EE_Form_Section_HTML
-     */
-    private function _question_group_header(EE_Question_Group $question_group)
-    {
-        $html = '';
-        // group_name
-        if ($question_group->show_group_name() && $question_group->name() !== '') {
-            if ($this->checkout->admin_request) {
-                $html .= EEH_HTML::br();
-                $html .= EEH_HTML::h3(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title title',
-                    'font-size: 1.3em; padding-left:0;'
-                );
-            } else {
-                $html .= EEH_HTML::h4(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title section-title'
-                );
-            }
-        }
-        // group_desc
-        if ($question_group->show_group_desc() && $question_group->desc() !== '') {
-            $html .= EEH_HTML::p(
-                $question_group->desc(),
-                '',
-                $this->checkout->admin_request
-                    ? 'ee-reg-form-qstn-grp-desc-pg'
-                    : 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
-            );
-        }
-        return new EE_Form_Section_HTML($html);
-    }
-
-
-    /**
-     * @return    EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _copy_attendee_info_form()
-    {
-        // array of params to pass to parent constructor
-        return new EE_Form_Section_Proper(
-            [
-                'subsections'     => $this->_copy_attendee_info_inputs(),
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file'     => SPCO_REG_STEPS_PATH
-                                                      . $this->_slug
-                                                      . '/copy_attendee_info.template.php',
-                        'begin_template_file'      => null,
-                        'input_template_file'      => null,
-                        'subsection_template_file' => null,
-                        'end_template_file'        => null,
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return EE_Form_Section_HTML
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _auto_copy_attendee_info()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . '/_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-                    []
-                )
-            )
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _copy_attendee_info_inputs()
-    {
-        $copy_attendee_info_inputs = [];
-        $prev_ticket               = null;
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        foreach ($registrations as $registration) {
-            // for all  attendees other than the primary attendee
-            if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
-                // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-                if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name                          = $registration->ticket()->name();
-                    $item_name                          .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
-                        : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-'
-                                                . $registration->ticket()->ID()
-                                                . ']' ] =
-                        new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
-                        );
-                    $prev_ticket                        = $registration->ticket()->ID();
-                }
-
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] =
-                    new EE_Checkbox_Multi_Input(
-                        [
-                            $registration->ID() => sprintf(
-                                esc_html_x('Attendee #%s', 'Attendee #123', 'event_espresso'),
-                                $registration->count()
-                            ),
-                        ],
-                        [
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
-                            'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
-                            'display_html_label_text' => false,
-                        ]
-                    );
-            }
-        }
-        return $copy_attendee_info_inputs;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return    EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    private function _additional_primary_registrant_inputs(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            [
-                'html_id' => 'primary_registrant',
-                'default' => $registration->reg_url_link(),
-            ]
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_form_question(EE_Registration $registration, EE_Question $question)
-    {
-
-        // if this question was for an attendee detail, then check for that answer
-        $answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
-            $registration,
-            $question->system_ID()
-        );
-        $answer       = $answer_value === null
-            ? EEM_Answer::instance()->get_one(
-                [['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
-            )
-            : null;
-        // if NOT returning to edit an existing registration
-        // OR if this question is for an attendee property
-        // OR we still don't have an EE_Answer object
-        if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
-            // create an EE_Answer object for storing everything in
-            $answer = EE_Answer::new_instance(
-                [
-                    'QST_ID' => $question->ID(),
-                    'REG_ID' => $registration->ID(),
-                ]
-            );
-        }
-        // verify instance
-        if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
-                $answer->set('ANS_value', $answer_value);
-            }
-            $answer->cache('Question', $question);
-            // remember system ID had a bug where sometimes it could be null
-            $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
-            $registration->cache('Answer', $answer, $answer_cache_id);
-        }
-        return $this->_generate_question_input($registration, $question, $answer);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param                 $answer
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
-    {
-        $identifier                               = $question->is_system_question()
-            ? $question->system_ID()
-            : $question->ID();
-        $this->_required_questions[ $identifier ] = $question->required();
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            [$this, 'use_cached_countries_for_form_input'],
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            [$this, 'use_cached_states_for_form_input'],
-            10,
-            4
-        );
-        $input_constructor_args                  = [
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_label_class' => 'ee-reg-qstn',
-        ];
-        $input_constructor_args['html_label_id'] .= '-lbl';
-        if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id']       .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
-        }
-        $form_input = $question->generate_form_input(
-            $registration,
-            $answer,
-            $input_constructor_args
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            [$this, 'use_cached_countries_for_form_input']
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            [$this, 'use_cached_states_for_form_input']
-        );
-        return $form_input;
-    }
-
-
-    /**
-     * Gets the list of countries for the form input
-     *
-     * @param array|null      $countries_list
-     * @param EE_Question     $question
-     * @param EE_Registration $registration
-     * @param EE_Answer       $answer
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function use_cached_countries_for_form_input(
-        $countries_list,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ) {
-        $country_options = ['' => ''];
-        // get possibly cached list of countries
-        $countries = $this->checkout->action === 'process_reg_step'
-            ? EEM_Country::instance()->get_all_countries()
-            : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
-                }
-            }
-        }
-        if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_one(
-                [['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
-
-
-    /**
-     * Gets the list of states for the form input
-     *
-     * @param array|null      $states_list
-     * @param EE_Question     $question
-     * @param EE_Registration $registration
-     * @param EE_Answer       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function use_cached_states_for_form_input(
-        $states_list,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ) {
-        $state_options = ['' => ['' => '']];
-        $states        = $this->checkout->action === 'process_reg_step'
-            ? EEM_State::instance()->get_all_states()
-            : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
-                }
-            }
-        }
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_reg_step()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // grab validated data from form
-        $valid_data = $this->checkout->current_step->valid_data();
-        // if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-        if (empty($valid_data)) {
-            EE_Error::add_error(
-                esc_html__('No valid question responses were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid transaction could not be initiated for processing your registrations.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // get cached registrations
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        // verify we got the goods
-        if (empty($registrations)) {
-            // combine the old translated string with a new one, in order to not break translations
-            $error_message = esc_html__(
-                'Your form data could not be applied to any valid registrations.',
-                'event_espresso'
-            )
-            . sprintf(
-                esc_html_x(
-                    '%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
-                    '(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
-                    'event_espresso'
-                ),
-                '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
-                '</a>',
-                '<br />'
-            );
-            EE_Error::add_error(
-                $error_message,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // extract attendee info from form data and save to model objects
-        $registrations_processed = $this->_process_registrations($registrations, $valid_data);
-        // if first pass thru SPCO,
-        // then let's check processed registrations against the total number of tickets in the cart
-        if ($registrations_processed === false) {
-            // but return immediately if the previous step exited early due to errors
-            return false;
-        }
-        if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
-            // generate a correctly translated string for all possible singular/plural combinations
-            if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
-                $error_msg = sprintf(
-                    esc_html_x(
-                        'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
-                        'There was 1 ticket in the Event Queue, but 2 registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
-                $error_msg = sprintf(
-                    esc_html_x(
-                        'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                        'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } else {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            }
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // mark this reg step as completed
-        $this->set_completed();
-        $this->_set_success_message(
-            esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
-        );
-        // do action in case a plugin wants to do something with the data submitted in step 1.
-        // passes EE_Single_Page_Checkout, and it's posted data
-        do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
-        return true;
-    }
-
-
-    /**
-     *    _process_registrations
-     *
-     * @param EE_Registration[] $registrations
-     * @param array[][]         $valid_data
-     * @return bool|int
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _process_registrations($registrations = [], $valid_data = [])
-    {
-        // load resources and set some defaults
-        EE_Registry::instance()->load_model('Attendee');
-        // holder for primary registrant attendee object
-        $this->checkout->primary_attendee_obj = null;
-        // array for tracking reg form data for the primary registrant
-        $primary_registrant = [
-            'line_item_id' => null,
-        ];
-        $copy_primary       = false;
-        // reg form sections that do not contain inputs
-        $non_input_form_sections = [
-            'primary_registrant',
-            'additional_attendee_reg_info',
-            'spco_copy_attendee_chk',
-        ];
-        // attendee counter
-        $att_nmbr = 0;
-        // grab the saved registrations from the transaction
-        foreach ($registrations as $registration) {
-            // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to process your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $reg_url_link = $registration->reg_url_link();
-            // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
-                // should this registration be processed during this visit ?
-                if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
-                    // if NOT revisiting, then let's save the registration now,
-                    // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
-                        $registration->save();
-                    }
-                    /**
-                     * This allows plugins to trigger a fail on processing of a
-                     * registration for any conditions they may have for it to pass.
-                     *
-                     * @var bool   if true is returned by the plugin then the
-                     *            registration processing is halted.
-                     */
-                    if (
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
-                            false,
-                            $att_nmbr,
-                            $registration,
-                            $registrations,
-                            $valid_data,
-                            $this
-                        )
-                    ) {
-                        return false;
-                    }
-
-                    // Houston, we have a registration!
-                    $att_nmbr++;
-                    $this->_attendee_data[ $reg_url_link ] = [];
-                    // grab any existing related answer objects
-                    $this->_registration_answers = $registration->answers();
-                    // unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-                    if (isset($valid_data[ $reg_url_link ])) {
-                        // do we need to copy basic info from primary attendee ?
-                        $copy_primary = isset($valid_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                        && absint($valid_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
-                        // filter form input data for this registration
-                        $valid_data[ $reg_url_link ] = (array) apply_filters(
-                            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-                            $valid_data[ $reg_url_link ]
-                        );
-                        if (isset($valid_data['primary_attendee'])) {
-                            $primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
-                                ? $valid_data['primary_attendee']
-                                : false;
-                            unset($valid_data['primary_attendee']);
-                        }
-                        // now loop through our array of valid post data && process attendee reg forms
-                        foreach ($valid_data[ $reg_url_link ] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections, true)) {
-                                foreach ($form_inputs as $form_input => $input_value) {
-                                    // check for critical inputs
-                                    if (
-                                        ! $this->_verify_critical_attendee_details_are_set_and_validate_email(
-                                            $form_input,
-                                            $input_value
-                                        )
-                                    ) {
-                                        return false;
-                                    }
-                                    // store a bit of data about the primary attendee
-                                    if (
-                                        $att_nmbr === 1
-                                        && ! empty($input_value)
-                                        && $reg_url_link === $primary_registrant['line_item_id']
-                                    ) {
-                                        $primary_registrant[ $form_input ] = $input_value;
-                                    } elseif (
-                                        $copy_primary
-                                              && $input_value === null
-                                              && isset($primary_registrant[ $form_input ])
-                                    ) {
-                                        $input_value = $primary_registrant[ $form_input ];
-                                    }
-                                    // now attempt to save the input data
-                                    if (
-                                        ! $this->_save_registration_form_input(
-                                            $registration,
-                                            $form_input,
-                                            $input_value
-                                        )
-                                    ) {
-                                        EE_Error::add_error(
-                                            sprintf(
-                                                esc_html_x(
-                                                    'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
-                                                    'Unable to save registration form data for the form input: "form input name" with the submitted value: "form input value"',
-                                                    'event_espresso'
-                                                ),
-                                                $form_input,
-                                                $input_value
-                                            ),
-                                            __FILE__,
-                                            __FUNCTION__,
-                                            __LINE__
-                                        );
-                                        return false;
-                                    }
-                                }
-                            }
-                        }  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
-                    }
-                    // this registration does not require additional attendee information ?
-                    if (
-                        $copy_primary
-                        && $att_nmbr > 1
-                        && $this->checkout->primary_attendee_obj instanceof EE_Attendee
-                    ) {
-                        // just copy the primary registrant
-                        $attendee = $this->checkout->primary_attendee_obj;
-                    } else {
-                        // ensure critical details are set for additional attendees
-                        $this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
-                            ? $this->_copy_critical_attendee_details_from_primary_registrant(
-                                $this->_attendee_data[ $reg_url_link ]
-                            )
-                            : $this->_attendee_data[ $reg_url_link ];
-                        // execute create attendee command (which may return an existing attendee)
-                        $attendee = EE_Registry::instance()->BUS->execute(
-                            new CreateAttendeeCommand(
-                                $this->_attendee_data[ $reg_url_link ],
-                                $registration
-                            )
-                        );
-                        // who's #1 ?
-                        if ($att_nmbr === 1) {
-                            $this->checkout->primary_attendee_obj = $attendee;
-                        }
-                    }
-                    // add relation to registration, set attendee ID, and cache attendee
-                    $this->_associate_attendee_with_registration($registration, $attendee);
-                    if (! $registration->attendee() instanceof EE_Attendee) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html_x(
-                                    'Registration %s has an invalid or missing Attendee object.',
-                                    'Registration 123-456-789 has an invalid or missing Attendee object.',
-                                    'event_espresso'
-                                ),
-                                $reg_url_link
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                    /** @type EE_Registration_Processor $registration_processor */
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-                    // at this point, we should have enough details about the registrant to consider the registration
-                    // NOT incomplete
-                    $registration_processor->toggle_incomplete_registration_status_to_default(
-                        $registration,
-                        false,
-                        new Context(
-                            'spco_reg_step_attendee_information_process_registrations',
-                            esc_html__(
-                                'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
-                    // abandoned
-                    $this->checkout->transaction->toggle_failed_transaction_status();
-                    // if we've gotten this far, then let's save what we have
-                    $registration->save();
-                    // add relation between TXN and registration
-                    $this->_associate_registration_with_transaction($registration);
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid or missing line item ID was encountered while attempting to process the registration form.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                // remove malformed data
-                unset($valid_data[ $reg_url_link ]);
-                return false;
-            }
-        } // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
-        return $att_nmbr;
-    }
-
-
-    /**
-     *    _save_registration_form_input
-     *
-     * @param EE_Registration $registration
-     * @param string          $form_input
-     * @param string          $input_value
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _save_registration_form_input(
-        EE_Registration $registration,
-        $form_input = '',
-        $input_value = ''
-    ) {
-        // If email_confirm is sent it's not saved
-        if ((string) $form_input === 'email_confirm') {
-            return true;
-        }
-
-        // allow for plugins to hook in and do their own processing of the form input.
-        // For plugins to bypass normal processing here, they just need to return a boolean value.
-        if (
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
-                false,
-                $registration,
-                $form_input,
-                $input_value,
-                $this
-            )
-        ) {
-            return true;
-        }
-        /*
+	/**
+	 * @type bool $_print_copy_info
+	 */
+	private $_print_copy_info = false;
+
+	/**
+	 * @type array $_attendee_data
+	 */
+	private $_attendee_data = [];
+
+	/**
+	 * @type array $_required_questions
+	 */
+	private $_required_questions = [];
+
+	/**
+	 * @type array $_registration_answers
+	 */
+	private $_registration_answers = [];
+
+	/**
+	 * @type int $reg_form_count
+	 */
+	protected $reg_form_count = 0;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->request  = EED_Single_Page_Checkout::getRequest();
+		$this->_slug    = 'attendee_information';
+		$this->_name    = esc_html__('Attendee Information', 'event_espresso');
+		$this->checkout = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
+		);
+	}
+
+
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+			' is a required question.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+			' is a required question. Please enter a value for at least one of the options.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
+			'Please answer all required questions correctly before proceeding.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+			esc_html_x(
+				'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
+				'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
+				'event_espresso'
+			),
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+			'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+			'You must enter a valid email address.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
+			'You must enter a valid email address and answer all other required questions before you can proceed.',
+			'event_espresso'
+		);
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function generate_reg_form()
+	{
+		/**
+		 * @var $reg_config EE_Registration_Config
+		 */
+		$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
+
+		$this->_print_copy_info = $reg_config->copyAttendeeInfo();
+
+		// Init reg forms count.
+		$this->reg_form_count = 0;
+
+		$primary_registrant = null;
+		// autoload Line_Item_Display classes
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display = new EE_Line_Item_Display();
+		// calculate taxes
+		$Line_Item_Display->display_line_item(
+			$this->checkout->cart->get_grand_total(),
+			['set_tax_rate' => true]
+		);
+		/** @var $subsections EE_Form_Section_Proper[] */
+		$extra_inputs_section = $this->reg_step_hidden_inputs();
+		$subsections          = [
+			'default_hidden_inputs' => $extra_inputs_section,
+		];
+
+		// if this isn't a revisit, and they have the privacy consent box enabled, add it
+		if (! $this->checkout->revisit && $reg_config->isConsentCheckboxEnabled()) {
+			$extra_inputs_section->add_subsections(
+				[
+					'consent_box' => new EE_Form_Section_Proper(
+						[
+							'layout_strategy' =>
+								new EE_Template_Layout(
+									[
+										'input_template_file' => SPCO_REG_STEPS_PATH
+																 . $this->_slug
+																 . '/privacy_consent.template.php',
+									]
+								),
+							'subsections'     => [
+								'consent' => new EE_Checkbox_Multi_Input(
+									[
+										'consent' => $reg_config->getConsentCheckboxLabelText(),
+									],
+									[
+										'required'                          => true,
+										'required_validation_error_message' => esc_html__(
+											'You must consent to these terms in order to register.',
+											'event_espresso'
+										),
+										'html_label_text'                   => '',
+									]
+								),
+							],
+						]
+					),
+				],
+				null,
+				false
+			);
+		}
+		$template_args = [
+			'revisit'       => $this->checkout->revisit,
+			'registrations' => [],
+			'ticket_count'  => [],
+		];
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
+				// can this registration be processed during this visit ?
+				if (
+					$registration instanceof EE_Registration
+					&& $this->checkout->visit_allows_processing_of_this_registration($registration)
+				) {
+					$subsections[ $registration->reg_url_link() ]                       =
+						$this->_registrations_reg_form($registration);
+					$template_args['registrations'][ $registration->reg_url_link() ]    = $registration;
+					$template_args['ticket_count'][ $registration->ticket()->ID() ]     = isset(
+						$template_args['ticket_count'][ $registration->ticket()->ID() ]
+					)
+						? $template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+						: 1;
+					$ticket_line_item                                                   =
+						EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+							$this->checkout->cart->get_grand_total(),
+							'Ticket',
+							[$registration->ticket()->ID()]
+						);
+					$ticket_line_item                                                   = is_array($ticket_line_item)
+						? reset($ticket_line_item)
+						: $ticket_line_item;
+					$template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+						$Line_Item_Display->display_line_item($ticket_line_item);
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $registration->reg_url_link();
+					}
+				}
+			}
+
+			if ($primary_registrant && count($registrations) > 1) {
+				$copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
+					? $this->_copy_attendee_info_form()
+					: $this->_auto_copy_attendee_info();
+				// generate hidden input
+				if (
+					isset($subsections[ $primary_registrant ])
+					&& $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+				) {
+					$subsections[ $primary_registrant ]->add_subsections(
+						$copy_options,
+						'primary_registrant',
+						false
+					);
+				}
+			}
+		}
+
+		// Set the registration form template (default: one form per ticket details table).
+		// We decide the template to used based on the number of forms.
+		$this->_template = $this->reg_form_count > 1
+			? SPCO_REG_STEPS_PATH . $this->_slug . '/attendee_info_main.template.php'
+			: SPCO_REG_STEPS_PATH . $this->_slug . '/attendee_info_single.template.php';
+
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => $this->_template, // layout_template
+						'template_args'        => $template_args,
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _registrations_reg_form(EE_Registration $registration)
+	{
+		static $attendee_nmbr = 1;
+		$form_args = [];
+		// verify that registration has valid event
+		if ($registration->event() instanceof EE_Event) {
+			$field_name      = 'Event_Question_Group.'
+							   . EEM_Event_Question_Group::instance()->fieldNameForContext(
+								   $registration->is_primary_registrant()
+							   );
+			$question_groups = $registration->event()->question_groups(
+				apply_filters(
+				// @codingStandardsIgnoreStart
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+					// @codingStandardsIgnoreEnd
+					[
+						[
+							'Event.EVT_ID' => $registration->event()->ID(),
+							$field_name    => true,
+							'QSG_deleted'  => false
+						],
+						'order_by' => ['QSG_order' => 'ASC'],
+					],
+					$registration,
+					$this
+				)
+			);
+			if ($question_groups) {
+				// array of params to pass to parent constructor
+				$form_args = [
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => [],
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						[
+							'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
+							'legend_text'  => sprintf(
+								esc_html_x(
+									'Attendee %d',
+									'Attendee 123',
+									'event_espresso'
+								),
+								$attendee_nmbr
+							),
+						]
+					),
+				];
+				foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
+							$registration,
+							$question_group
+						);
+					}
+				}
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
+					$registration
+				);
+
+				/**
+				 * @var $reg_config EE_Registration_Config
+				 */
+				$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
+
+				// If we have question groups for additional attendees, then display the copy options
+				$this->_print_copy_info = apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form___printCopyInfo',
+					$attendee_nmbr > 1 && $reg_config->copyAttendeeInfo(),
+					$attendee_nmbr
+				);
+
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
+						$registration
+					);
+				}
+			}
+		}
+		$attendee_nmbr++;
+
+		// Increment the reg forms number if form is valid.
+		if (! empty($form_args)) {
+			$this->reg_form_count++;
+		}
+
+		return ! empty($form_args)
+			? new EE_Form_Section_Proper($form_args)
+			: new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param bool            $additional_attendee_reg_info
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	private function _additional_attendee_reg_info_input(
+		EE_Registration $registration,
+		$additional_attendee_reg_info = true
+	) {
+		// generate hidden input
+		return new EE_Hidden_Input(
+			[
+				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'default' => $additional_attendee_reg_info,
+			]
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
+	{
+		// array of params to pass to parent constructor
+		$form_args = [
+			'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
+			'html_class'      => $this->checkout->admin_request
+				? 'form-table ee-reg-form-qstn-grp-dv'
+				: 'ee-reg-form-qstn-grp-dv',
+			'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-'
+								 . $registration->ID() . '-lbl',
+			'subsections'     => [
+				'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
+			],
+			'layout_strategy' => $this->checkout->admin_request
+				? new EE_Admin_Two_Column_Layout()
+				: new EE_Div_Per_Section_Layout(),
+		];
+		// where params
+		$query_params = ['QST_deleted' => 0];
+		// don't load admin only questions on the frontend
+		if (! $this->checkout->admin_request) {
+			$query_params['QST_admin_only'] = ['!=', true];
+		}
+		$questions = $question_group->get_many_related(
+			'Question',
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
+				[
+					$query_params,
+					'order_by' => [
+						'Question_Group_Question.QGQ_order' => 'ASC',
+					],
+				],
+				$question_group,
+				$registration,
+				$this
+			)
+		);
+		// filter for additional content before questions
+		$form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
+		// loop thru questions
+		foreach ($questions as $question) {
+			if ($question instanceof EE_Question) {
+				$identifier                              = $question->is_system_question()
+					? $question->system_ID()
+					: $question->ID();
+				$form_args['subsections'][ $identifier ] = $this->reg_form_question($registration, $question);
+			}
+		}
+		$form_args['subsections'] = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
+			$form_args['subsections'],
+			$registration,
+			$question_group,
+			$this
+		);
+		// filter for additional content after questions
+		$form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
+		// d($form_args);
+		$question_group_reg_form = new EE_Form_Section_Proper($form_args);
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			$question_group_reg_form,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param EE_Question_Group $question_group
+	 * @return    EE_Form_Section_HTML
+	 */
+	private function _question_group_header(EE_Question_Group $question_group)
+	{
+		$html = '';
+		// group_name
+		if ($question_group->show_group_name() && $question_group->name() !== '') {
+			if ($this->checkout->admin_request) {
+				$html .= EEH_HTML::br();
+				$html .= EEH_HTML::h3(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title title',
+					'font-size: 1.3em; padding-left:0;'
+				);
+			} else {
+				$html .= EEH_HTML::h4(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title section-title'
+				);
+			}
+		}
+		// group_desc
+		if ($question_group->show_group_desc() && $question_group->desc() !== '') {
+			$html .= EEH_HTML::p(
+				$question_group->desc(),
+				'',
+				$this->checkout->admin_request
+					? 'ee-reg-form-qstn-grp-desc-pg'
+					: 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
+			);
+		}
+		return new EE_Form_Section_HTML($html);
+	}
+
+
+	/**
+	 * @return    EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _copy_attendee_info_form()
+	{
+		// array of params to pass to parent constructor
+		return new EE_Form_Section_Proper(
+			[
+				'subsections'     => $this->_copy_attendee_info_inputs(),
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file'     => SPCO_REG_STEPS_PATH
+													  . $this->_slug
+													  . '/copy_attendee_info.template.php',
+						'begin_template_file'      => null,
+						'input_template_file'      => null,
+						'subsection_template_file' => null,
+						'end_template_file'        => null,
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return EE_Form_Section_HTML
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _auto_copy_attendee_info()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $this->_slug . '/_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+					[]
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+		$copy_attendee_info_inputs = [];
+		$prev_ticket               = null;
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		foreach ($registrations as $registration) {
+			// for all  attendees other than the primary attendee
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
+				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
+				if ($registration->ticket()->ID() !== $prev_ticket) {
+					$item_name                          = $registration->ticket()->name();
+					$item_name                          .= $registration->ticket()->description() !== ''
+						? ' - ' . $registration->ticket()->description()
+						: '';
+					$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-'
+												. $registration->ticket()->ID()
+												. ']' ] =
+						new EE_Form_Section_HTML(
+							'<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+						);
+					$prev_ticket                        = $registration->ticket()->ID();
+				}
+
+				$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] =
+					new EE_Checkbox_Multi_Input(
+						[
+							$registration->ID() => sprintf(
+								esc_html_x('Attendee #%s', 'Attendee #123', 'event_espresso'),
+								$registration->count()
+							),
+						],
+						[
+							'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+							'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
+							'display_html_label_text' => false,
+						]
+					);
+			}
+		}
+		return $copy_attendee_info_inputs;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return    EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	private function _additional_primary_registrant_inputs(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			[
+				'html_id' => 'primary_registrant',
+				'default' => $registration->reg_url_link(),
+			]
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_form_question(EE_Registration $registration, EE_Question $question)
+	{
+
+		// if this question was for an attendee detail, then check for that answer
+		$answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
+			$registration,
+			$question->system_ID()
+		);
+		$answer       = $answer_value === null
+			? EEM_Answer::instance()->get_one(
+				[['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
+			)
+			: null;
+		// if NOT returning to edit an existing registration
+		// OR if this question is for an attendee property
+		// OR we still don't have an EE_Answer object
+		if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
+			// create an EE_Answer object for storing everything in
+			$answer = EE_Answer::new_instance(
+				[
+					'QST_ID' => $question->ID(),
+					'REG_ID' => $registration->ID(),
+				]
+			);
+		}
+		// verify instance
+		if ($answer instanceof EE_Answer) {
+			if (! empty($answer_value)) {
+				$answer->set('ANS_value', $answer_value);
+			}
+			$answer->cache('Question', $question);
+			// remember system ID had a bug where sometimes it could be null
+			$answer_cache_id = $question->is_system_question()
+				? $question->system_ID() . '-' . $registration->reg_url_link()
+				: $question->ID() . '-' . $registration->reg_url_link();
+			$registration->cache('Answer', $answer, $answer_cache_id);
+		}
+		return $this->_generate_question_input($registration, $question, $answer);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param                 $answer
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
+	{
+		$identifier                               = $question->is_system_question()
+			? $question->system_ID()
+			: $question->ID();
+		$this->_required_questions[ $identifier ] = $question->required();
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			[$this, 'use_cached_countries_for_form_input'],
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			[$this, 'use_cached_states_for_form_input'],
+			10,
+			4
+		);
+		$input_constructor_args                  = [
+			'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
+			'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
+			'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_label_class' => 'ee-reg-qstn',
+		];
+		$input_constructor_args['html_label_id'] .= '-lbl';
+		if ($answer instanceof EE_Answer && $answer->ID()) {
+			$input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
+			$input_constructor_args['html_id']       .= '-' . $answer->ID();
+			$input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+		}
+		$form_input = $question->generate_form_input(
+			$registration,
+			$answer,
+			$input_constructor_args
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			[$this, 'use_cached_countries_for_form_input']
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			[$this, 'use_cached_states_for_form_input']
+		);
+		return $form_input;
+	}
+
+
+	/**
+	 * Gets the list of countries for the form input
+	 *
+	 * @param array|null      $countries_list
+	 * @param EE_Question     $question
+	 * @param EE_Registration $registration
+	 * @param EE_Answer       $answer
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function use_cached_countries_for_form_input(
+		$countries_list,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	) {
+		$country_options = ['' => ''];
+		// get possibly cached list of countries
+		$countries = $this->checkout->action === 'process_reg_step'
+			? EEM_Country::instance()->get_all_countries()
+			: EEM_Country::instance()->get_all_active_countries();
+		if (! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[ $country->ID() ] = $country->name();
+				}
+			}
+		}
+		if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_one(
+				[['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
+
+
+	/**
+	 * Gets the list of states for the form input
+	 *
+	 * @param array|null      $states_list
+	 * @param EE_Question     $question
+	 * @param EE_Registration $registration
+	 * @param EE_Answer       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function use_cached_states_for_form_input(
+		$states_list,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	) {
+		$state_options = ['' => ['' => '']];
+		$states        = $this->checkout->action === 'process_reg_step'
+			? EEM_State::instance()->get_all_states()
+			: EEM_State::instance()->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+				}
+			}
+		}
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_reg_step()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// grab validated data from form
+		$valid_data = $this->checkout->current_step->valid_data();
+		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
+		if (empty($valid_data)) {
+			EE_Error::add_error(
+				esc_html__('No valid question responses were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid transaction could not be initiated for processing your registrations.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// get cached registrations
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		// verify we got the goods
+		if (empty($registrations)) {
+			// combine the old translated string with a new one, in order to not break translations
+			$error_message = esc_html__(
+				'Your form data could not be applied to any valid registrations.',
+				'event_espresso'
+			)
+			. sprintf(
+				esc_html_x(
+					'%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
+					'(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
+					'event_espresso'
+				),
+				'<a href="' . get_post_type_archive_link('espresso_events') . '" >',
+				'</a>',
+				'<br />'
+			);
+			EE_Error::add_error(
+				$error_message,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// extract attendee info from form data and save to model objects
+		$registrations_processed = $this->_process_registrations($registrations, $valid_data);
+		// if first pass thru SPCO,
+		// then let's check processed registrations against the total number of tickets in the cart
+		if ($registrations_processed === false) {
+			// but return immediately if the previous step exited early due to errors
+			return false;
+		}
+		if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+			// generate a correctly translated string for all possible singular/plural combinations
+			if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
+				$error_msg = sprintf(
+					esc_html_x(
+						'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
+						'There was 1 ticket in the Event Queue, but 2 registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
+				$error_msg = sprintf(
+					esc_html_x(
+						'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+						'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} else {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			}
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// mark this reg step as completed
+		$this->set_completed();
+		$this->_set_success_message(
+			esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
+		);
+		// do action in case a plugin wants to do something with the data submitted in step 1.
+		// passes EE_Single_Page_Checkout, and it's posted data
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
+		return true;
+	}
+
+
+	/**
+	 *    _process_registrations
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param array[][]         $valid_data
+	 * @return bool|int
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _process_registrations($registrations = [], $valid_data = [])
+	{
+		// load resources and set some defaults
+		EE_Registry::instance()->load_model('Attendee');
+		// holder for primary registrant attendee object
+		$this->checkout->primary_attendee_obj = null;
+		// array for tracking reg form data for the primary registrant
+		$primary_registrant = [
+			'line_item_id' => null,
+		];
+		$copy_primary       = false;
+		// reg form sections that do not contain inputs
+		$non_input_form_sections = [
+			'primary_registrant',
+			'additional_attendee_reg_info',
+			'spco_copy_attendee_chk',
+		];
+		// attendee counter
+		$att_nmbr = 0;
+		// grab the saved registrations from the transaction
+		foreach ($registrations as $registration) {
+			// verify EE_Registration object
+			if (! $registration instanceof EE_Registration) {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to process your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$reg_url_link = $registration->reg_url_link();
+			// reg_url_link exists ?
+			if (! empty($reg_url_link)) {
+				// should this registration be processed during this visit ?
+				if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
+					// if NOT revisiting, then let's save the registration now,
+					// so that we have a REG_ID to use when generating other objects
+					if (! $this->checkout->revisit) {
+						$registration->save();
+					}
+					/**
+					 * This allows plugins to trigger a fail on processing of a
+					 * registration for any conditions they may have for it to pass.
+					 *
+					 * @var bool   if true is returned by the plugin then the
+					 *            registration processing is halted.
+					 */
+					if (
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
+							false,
+							$att_nmbr,
+							$registration,
+							$registrations,
+							$valid_data,
+							$this
+						)
+					) {
+						return false;
+					}
+
+					// Houston, we have a registration!
+					$att_nmbr++;
+					$this->_attendee_data[ $reg_url_link ] = [];
+					// grab any existing related answer objects
+					$this->_registration_answers = $registration->answers();
+					// unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
+					if (isset($valid_data[ $reg_url_link ])) {
+						// do we need to copy basic info from primary attendee ?
+						$copy_primary = isset($valid_data[ $reg_url_link ]['additional_attendee_reg_info'])
+										&& absint($valid_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
+						// filter form input data for this registration
+						$valid_data[ $reg_url_link ] = (array) apply_filters(
+							'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+							$valid_data[ $reg_url_link ]
+						);
+						if (isset($valid_data['primary_attendee'])) {
+							$primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
+								? $valid_data['primary_attendee']
+								: false;
+							unset($valid_data['primary_attendee']);
+						}
+						// now loop through our array of valid post data && process attendee reg forms
+						foreach ($valid_data[ $reg_url_link ] as $form_section => $form_inputs) {
+							if (! in_array($form_section, $non_input_form_sections, true)) {
+								foreach ($form_inputs as $form_input => $input_value) {
+									// check for critical inputs
+									if (
+										! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+											$form_input,
+											$input_value
+										)
+									) {
+										return false;
+									}
+									// store a bit of data about the primary attendee
+									if (
+										$att_nmbr === 1
+										&& ! empty($input_value)
+										&& $reg_url_link === $primary_registrant['line_item_id']
+									) {
+										$primary_registrant[ $form_input ] = $input_value;
+									} elseif (
+										$copy_primary
+											  && $input_value === null
+											  && isset($primary_registrant[ $form_input ])
+									) {
+										$input_value = $primary_registrant[ $form_input ];
+									}
+									// now attempt to save the input data
+									if (
+										! $this->_save_registration_form_input(
+											$registration,
+											$form_input,
+											$input_value
+										)
+									) {
+										EE_Error::add_error(
+											sprintf(
+												esc_html_x(
+													'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
+													'Unable to save registration form data for the form input: "form input name" with the submitted value: "form input value"',
+													'event_espresso'
+												),
+												$form_input,
+												$input_value
+											),
+											__FILE__,
+											__FUNCTION__,
+											__LINE__
+										);
+										return false;
+									}
+								}
+							}
+						}  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
+					}
+					// this registration does not require additional attendee information ?
+					if (
+						$copy_primary
+						&& $att_nmbr > 1
+						&& $this->checkout->primary_attendee_obj instanceof EE_Attendee
+					) {
+						// just copy the primary registrant
+						$attendee = $this->checkout->primary_attendee_obj;
+					} else {
+						// ensure critical details are set for additional attendees
+						$this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
+							? $this->_copy_critical_attendee_details_from_primary_registrant(
+								$this->_attendee_data[ $reg_url_link ]
+							)
+							: $this->_attendee_data[ $reg_url_link ];
+						// execute create attendee command (which may return an existing attendee)
+						$attendee = EE_Registry::instance()->BUS->execute(
+							new CreateAttendeeCommand(
+								$this->_attendee_data[ $reg_url_link ],
+								$registration
+							)
+						);
+						// who's #1 ?
+						if ($att_nmbr === 1) {
+							$this->checkout->primary_attendee_obj = $attendee;
+						}
+					}
+					// add relation to registration, set attendee ID, and cache attendee
+					$this->_associate_attendee_with_registration($registration, $attendee);
+					if (! $registration->attendee() instanceof EE_Attendee) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html_x(
+									'Registration %s has an invalid or missing Attendee object.',
+									'Registration 123-456-789 has an invalid or missing Attendee object.',
+									'event_espresso'
+								),
+								$reg_url_link
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+					/** @type EE_Registration_Processor $registration_processor */
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+					// at this point, we should have enough details about the registrant to consider the registration
+					// NOT incomplete
+					$registration_processor->toggle_incomplete_registration_status_to_default(
+						$registration,
+						false,
+						new Context(
+							'spco_reg_step_attendee_information_process_registrations',
+							esc_html__(
+								'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
+								'event_espresso'
+							)
+						)
+					);
+					// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
+					// abandoned
+					$this->checkout->transaction->toggle_failed_transaction_status();
+					// if we've gotten this far, then let's save what we have
+					$registration->save();
+					// add relation between TXN and registration
+					$this->_associate_registration_with_transaction($registration);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid or missing line item ID was encountered while attempting to process the registration form.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				// remove malformed data
+				unset($valid_data[ $reg_url_link ]);
+				return false;
+			}
+		} // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
+		return $att_nmbr;
+	}
+
+
+	/**
+	 *    _save_registration_form_input
+	 *
+	 * @param EE_Registration $registration
+	 * @param string          $form_input
+	 * @param string          $input_value
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _save_registration_form_input(
+		EE_Registration $registration,
+		$form_input = '',
+		$input_value = ''
+	) {
+		// If email_confirm is sent it's not saved
+		if ((string) $form_input === 'email_confirm') {
+			return true;
+		}
+
+		// allow for plugins to hook in and do their own processing of the form input.
+		// For plugins to bypass normal processing here, they just need to return a boolean value.
+		if (
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
+				false,
+				$registration,
+				$form_input,
+				$input_value,
+				$this
+			)
+		) {
+			return true;
+		}
+		/*
          * $answer_cache_id is the key used to find the EE_Answer we want
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
-        $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
-            : (string) $form_input;
-        $answer_is_obj   = isset($this->_registration_answers[ $answer_cache_id ])
-                           && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer;
-        // rename form_inputs if they are EE_Attendee properties
-        switch ((string) $form_input) {
-            case 'state':
-            case 'STA_ID':
-                $attendee_property = true;
-                $form_input        = 'STA_ID';
-                break;
-
-            case 'country':
-            case 'CNT_ISO':
-                $attendee_property = true;
-                $form_input        = 'CNT_ISO';
-                break;
-
-            default:
-                $ATT_input = 'ATT_' . $form_input;
-                $attendee_property = EEM_Attendee::instance()->has_field($ATT_input);
-                $form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
-        }
-        // if this form input has a corresponding attendee property
-        if ($attendee_property) {
-            $this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
-            if ($answer_is_obj) {
-                // and delete the corresponding answer since we won't be storing this data in that object
-                $registration->_remove_relation_to($this->_registration_answers[ $answer_cache_id ], 'Answer');
-                $this->_registration_answers[ $answer_cache_id ]->delete_permanently();
-            }
-            return true;
-        }
-        if ($answer_is_obj) {
-            // save this data to the answer object
-            $this->_registration_answers[ $answer_cache_id ]->set_value($input_value);
-            $result = $this->_registration_answers[ $answer_cache_id ]->save();
-            return $result !== false;
-        }
-        foreach ($this->_registration_answers as $answer) {
-            if ($answer instanceof EE_Answer && (string) $answer->question_ID() === $answer_cache_id) {
-                $answer->set_value($input_value);
-                $result = $answer->save();
-                return $result !== false;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    _verify_critical_attendee_details_are_set
-     *
-     * @param string $form_input
-     * @param string $input_value
-     * @return boolean
-     */
-    private function _verify_critical_attendee_details_are_set_and_validate_email(
-        $form_input = '',
-        $input_value = ''
-    ) {
-        if (empty($input_value)) {
-            // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[ $form_input ]) || ! $this->_required_questions[ $form_input ]) {
-                return true;
-            }
-            switch ($form_input) {
-                case 'fname':
-                    EE_Error::add_error(
-                        esc_html__('First Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                case 'lname':
-                    EE_Error::add_error(
-                        esc_html__('Last Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                case 'email':
-                    EE_Error::add_error(
-                        esc_html__('Please enter a valid email address.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     *    _associate_attendee_with_registration
-     *
-     * @param EE_Registration $registration
-     * @param EE_Attendee     $attendee
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
-    {
-        // add relation to attendee
-        $registration->_add_relation_to($attendee, 'Attendee');
-        $registration->set_attendee_id($attendee->ID());
-        $registration->update_cache_after_object_save('Attendee', $attendee);
-    }
-
-
-    /**
-     *    _associate_registration_with_transaction
-     *
-     * @param EE_Registration $registration
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _associate_registration_with_transaction(EE_Registration $registration)
-    {
-        // add relation to registration
-        $this->checkout->transaction->_add_relation_to($registration, 'Registration');
-        $this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
-    }
-
-
-    /**
-     *    _copy_critical_attendee_details_from_primary_registrant
-     *    ensures that all attendees at least have data for first name, last name, and email address
-     *
-     * @param array $attendee_data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = [])
-    {
-        // bare minimum critical details include first name, last name, email address
-        $critical_attendee_details = ['ATT_fname', 'ATT_lname', 'ATT_email'];
-        // add address info to critical details?
-        if (
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-                false
-            )
-        ) {
-            $address_details           = [
-                'ATT_address',
-                'ATT_address2',
-                'ATT_city',
-                'STA_ID',
-                'CNT_ISO',
-                'ATT_zip',
-                'ATT_phone',
-            ];
-            $critical_attendee_details = array_merge($critical_attendee_details, $address_details);
-        }
-        foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (
-                ! isset($attendee_data[ $critical_attendee_detail ])
-                || empty($attendee_data[ $critical_attendee_detail ])
-            ) {
-                $attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
-                    $critical_attendee_detail
-                );
-            }
-        }
-        return $attendee_data;
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to edit their attendee information
-     *    this gets called AFTER the process_reg_step() method above
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_reg_step()
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect     = true;
-            $this->checkout->redirect_url = add_query_arg(
-                [
-                    'e_reg_url_link' => $this->checkout->reg_url_link,
-                    'revisit'        => true,
-                ],
-                $this->checkout->thank_you_page_url
-            );
-            $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-            return true;
-        }
-        return false;
-    }
+		$answer_cache_id = $this->checkout->reg_url_link
+			? $form_input . '-' . $registration->reg_url_link()
+			: (string) $form_input;
+		$answer_is_obj   = isset($this->_registration_answers[ $answer_cache_id ])
+						   && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer;
+		// rename form_inputs if they are EE_Attendee properties
+		switch ((string) $form_input) {
+			case 'state':
+			case 'STA_ID':
+				$attendee_property = true;
+				$form_input        = 'STA_ID';
+				break;
+
+			case 'country':
+			case 'CNT_ISO':
+				$attendee_property = true;
+				$form_input        = 'CNT_ISO';
+				break;
+
+			default:
+				$ATT_input = 'ATT_' . $form_input;
+				$attendee_property = EEM_Attendee::instance()->has_field($ATT_input);
+				$form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
+		}
+		// if this form input has a corresponding attendee property
+		if ($attendee_property) {
+			$this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
+			if ($answer_is_obj) {
+				// and delete the corresponding answer since we won't be storing this data in that object
+				$registration->_remove_relation_to($this->_registration_answers[ $answer_cache_id ], 'Answer');
+				$this->_registration_answers[ $answer_cache_id ]->delete_permanently();
+			}
+			return true;
+		}
+		if ($answer_is_obj) {
+			// save this data to the answer object
+			$this->_registration_answers[ $answer_cache_id ]->set_value($input_value);
+			$result = $this->_registration_answers[ $answer_cache_id ]->save();
+			return $result !== false;
+		}
+		foreach ($this->_registration_answers as $answer) {
+			if ($answer instanceof EE_Answer && (string) $answer->question_ID() === $answer_cache_id) {
+				$answer->set_value($input_value);
+				$result = $answer->save();
+				return $result !== false;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    _verify_critical_attendee_details_are_set
+	 *
+	 * @param string $form_input
+	 * @param string $input_value
+	 * @return boolean
+	 */
+	private function _verify_critical_attendee_details_are_set_and_validate_email(
+		$form_input = '',
+		$input_value = ''
+	) {
+		if (empty($input_value)) {
+			// if the form input isn't marked as being required, then just return
+			if (! isset($this->_required_questions[ $form_input ]) || ! $this->_required_questions[ $form_input ]) {
+				return true;
+			}
+			switch ($form_input) {
+				case 'fname':
+					EE_Error::add_error(
+						esc_html__('First Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				case 'lname':
+					EE_Error::add_error(
+						esc_html__('Last Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				case 'email':
+					EE_Error::add_error(
+						esc_html__('Please enter a valid email address.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 *    _associate_attendee_with_registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Attendee     $attendee
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
+	{
+		// add relation to attendee
+		$registration->_add_relation_to($attendee, 'Attendee');
+		$registration->set_attendee_id($attendee->ID());
+		$registration->update_cache_after_object_save('Attendee', $attendee);
+	}
+
+
+	/**
+	 *    _associate_registration_with_transaction
+	 *
+	 * @param EE_Registration $registration
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _associate_registration_with_transaction(EE_Registration $registration)
+	{
+		// add relation to registration
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
+	}
+
+
+	/**
+	 *    _copy_critical_attendee_details_from_primary_registrant
+	 *    ensures that all attendees at least have data for first name, last name, and email address
+	 *
+	 * @param array $attendee_data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = [])
+	{
+		// bare minimum critical details include first name, last name, email address
+		$critical_attendee_details = ['ATT_fname', 'ATT_lname', 'ATT_email'];
+		// add address info to critical details?
+		if (
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+				false
+			)
+		) {
+			$address_details           = [
+				'ATT_address',
+				'ATT_address2',
+				'ATT_city',
+				'STA_ID',
+				'CNT_ISO',
+				'ATT_zip',
+				'ATT_phone',
+			];
+			$critical_attendee_details = array_merge($critical_attendee_details, $address_details);
+		}
+		foreach ($critical_attendee_details as $critical_attendee_detail) {
+			if (
+				! isset($attendee_data[ $critical_attendee_detail ])
+				|| empty($attendee_data[ $critical_attendee_detail ])
+			) {
+				$attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
+					$critical_attendee_detail
+				);
+			}
+		}
+		return $attendee_data;
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to edit their attendee information
+	 *    this gets called AFTER the process_reg_step() method above
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_reg_step()
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect     = true;
+			$this->checkout->redirect_url = add_query_arg(
+				[
+					'e_reg_url_link' => $this->checkout->reg_url_link,
+					'revisit'        => true,
+				],
+				$this->checkout->thank_you_page_url
+			);
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+			return true;
+		}
+		return false;
+	}
 }