eventespresso / event-espresso-core

core/libraries/messages/messenger/EE_Email_messenger.class.php

Indentation +641 added lines, -641 removed lines

@@ -8,645 +8,645 @@
 class EE_Email_messenger extends EE_messenger
 {
 
-    /**
-     * To field for email
-     * @var string
-     */
-    protected $_to = '';
-
-
-    /**
-     * CC field for email.
-     * @var string
-     */
-    protected $_cc = '';
-
-    /**
-     * From field for email
-     * @var string
-     */
-    protected $_from = '';
-
-
-    /**
-     * Subject field for email
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * Content field for email
-     * @var string
-     */
-    protected $_content = '';
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        //set name and description properties
-        $this->name                = 'email';
-        $this->description         = sprintf(
-            esc_html__(
-                'This messenger delivers messages via email using the built-in %s function included with WordPress',
-                'event_espresso'
-            ),
-            '<code>wp_mail</code>'
-        );
-        $this->label               = array(
-            'singular' => esc_html__('email', 'event_espresso'),
-            'plural'   => esc_html__('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        //we're using defaults so let's call parent constructor that will take care of setting up all the other
-        // properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
-        // message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'cc' => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type' => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        //prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html__('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for
-        // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
-        // they relate to.  This is important for the Messages_admin to know what fields to display to the user.
-        //  Also, notice that the "values" are equal to the field type that messages admin will use to know what
-        // kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
-        // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
-        // displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
-        // will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'To',
-                    'Label for the "To" field for email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'cc'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'CC',
-                    'Label for the "Carbon Copy" field used for additional email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'From',
-                    'Label for the "From" field for email addresses.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'Subject',
-                    'Label for the "Subject" field (short description of contents) for emails.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            html_entity_decode($this->_to, ENT_QUOTES, "UTF-8"),
-            stripslashes(html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8")),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'
-                    ),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        if (! empty($this->_cc)) {
-            $headers[] = 'cc: ' . $this->_cc;
-        }
-
-        //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
-        // header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     * @return string
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        //includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1])
-            ? $parsed_from[1]
-            : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     * @return string
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        //if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        $from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;
-
-        return stripslashes_deep(html_entity_decode($from_name, ENT_QUOTES, "UTF-8"));
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _body($preview = false)
-    {
-        //setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop(
-                stripslashes_deep(
-                    html_entity_decode($this->_content, ENT_QUOTES, "UTF-8")
-                )
-            ),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-            //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
-
-            //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents(
-                    $this->get_variation(
-                        $this->_tmp_pack,
-                        $this->_incoming_message_type->name,
-                        false,
-                        'main',
-                        $this->_variation
-                    ),
-                    true
-                );
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
-                //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
-                $body  = ltrim($CSS->convert(true), ">\n");
-                //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
-                $body  = ltrim($body, "<?");
-            }
-
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        //override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * To field for email
+	 * @var string
+	 */
+	protected $_to = '';
+
+
+	/**
+	 * CC field for email.
+	 * @var string
+	 */
+	protected $_cc = '';
+
+	/**
+	 * From field for email
+	 * @var string
+	 */
+	protected $_from = '';
+
+
+	/**
+	 * Subject field for email
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * Content field for email
+	 * @var string
+	 */
+	protected $_content = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		//set name and description properties
+		$this->name                = 'email';
+		$this->description         = sprintf(
+			esc_html__(
+				'This messenger delivers messages via email using the built-in %s function included with WordPress',
+				'event_espresso'
+			),
+			'<code>wp_mail</code>'
+		);
+		$this->label               = array(
+			'singular' => esc_html__('email', 'event_espresso'),
+			'plural'   => esc_html__('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		//we're using defaults so let's call parent constructor that will take care of setting up all the other
+		// properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		//remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
+		// message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'cc' => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type' => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		//prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html__('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for
+		// shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
+		// they relate to.  This is important for the Messages_admin to know what fields to display to the user.
+		//  Also, notice that the "values" are equal to the field type that messages admin will use to know what
+		// kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
+		// indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
+		// displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
+		// will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'To',
+					'Label for the "To" field for email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'cc'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'CC',
+					'Label for the "Carbon Copy" field used for additional email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'From',
+					'Label for the "From" field for email addresses.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'Subject',
+					'Label for the "Subject" field (short description of contents) for emails.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			html_entity_decode($this->_to, ENT_QUOTES, "UTF-8"),
+			stripslashes(html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8")),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'
+					),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		if (! empty($this->_cc)) {
+			$headers[] = 'cc: ' . $this->_cc;
+		}
+
+		//but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
+		// header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 * @return string
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		//includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1])
+			? $parsed_from[1]
+			: get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 * @return string
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		//if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		$from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;
+
+		return stripslashes_deep(html_entity_decode($from_name, ENT_QUOTES, "UTF-8"));
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _body($preview = false)
+	{
+		//setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop(
+				stripslashes_deep(
+					html_entity_decode($this->_content, ENT_QUOTES, "UTF-8")
+				)
+			),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+			//require CssToInlineStyles library and its dependencies via composer autoloader
+			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+
+			//now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents(
+					$this->get_variation(
+						$this->_tmp_pack,
+						$this->_incoming_message_type->name,
+						false,
+						'main',
+						$this->_variation
+					),
+					true
+				);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
+				//for some reason the library has a bracket and new line at the beginning.  This takes care of that.
+				$body  = ltrim($CSS->convert(true), ">\n");
+				//see https://events.codebasehq.com/projects/event-espresso/tickets/8609
+				$body  = ltrim($body, "<?");
+			}
+
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		//override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -58,7 +58,7 @@ 
             ),
             '<code>wp_mail</code>'
         );
-        $this->label               = array(
+        $this->label = array(
             'singular' => esc_html__('email', 'event_espresso'),
             'plural'   => esc_html__('emails', 'event_espresso'),
         );
@@ -438,7 +438,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -482,13 +482,13 @@ 
         $this->_ensure_has_from_email_address();
         $from    = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8"));
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
-        if (! empty($this->_cc)) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc)) {
+            $headers[] = 'cc: '.$this->_cc;
         }
 
         //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
@@ -598,7 +598,7 @@ 
                 )
             ),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -608,10 +608,10 @@ 
          */
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
             //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents(
                     $this->get_variation(
                         $this->_tmp_pack,

core/exceptions/ExceptionStackTraceDisplay.php

Indentation +280 added lines, -280 removed lines

@@ -8,7 +8,7 @@ 
 use ReflectionMethod;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -26,53 +26,53 @@ 
 
 
 
-    /**
-     * @param Exception $exception
-     * @throws Exception
-     */
-    public function __construct(Exception $exception)
-    {
-        if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
-            $this->displayException($exception);
-        } else {
-            throw $exception;
-        }
-    }
+	/**
+	 * @param Exception $exception
+	 * @throws Exception
+	 */
+	public function __construct(Exception $exception)
+	{
+		if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
+			$this->displayException($exception);
+		} else {
+			throw $exception;
+		}
+	}
 
 
 
-    /**
-     * @access protected
-     * @param Exception $exception
-     * @throws ReflectionException
-     */
-    protected function displayException(Exception $exception)
-    {
-        $error_code = '';
-        $trace_details = '';
-        $time = time();
-        $trace = $exception->getTrace();
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $exception->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // start gathering output
-        $output = $this->exceptionStyles();
-        $output .= '
+	/**
+	 * @access protected
+	 * @param Exception $exception
+	 * @throws ReflectionException
+	 */
+	protected function displayException(Exception $exception)
+	{
+		$error_code = '';
+		$trace_details = '';
+		$time = time();
+		$trace = $exception->getTrace();
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $exception->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// start gathering output
+		$output = $this->exceptionStyles();
+		$output .= '
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // process trace info
-        if (empty($trace)) {
-            $trace_details .= __(
-                'Sorry, but no trace information was available for this exception.',
-                'event_espresso'
-            );
-        } else {
-            $trace_details .= '
+		}
+		// process trace info
+		if (empty($trace)) {
+			$trace_details .= __(
+				'Sorry, but no trace information was available for this exception.',
+				'event_espresso'
+			);
+		} else {
+			$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -80,260 +80,260 @@ 
 					<th scope="col" align="right" style="width:3.5%;">Line</th>
 					<th scope="col" align="left" style="width:40%;">File</th>
 					<th scope="col" align="left">' . __('Class', 'event_espresso') . '->' . __('Method( arguments )',
-                    'event_espresso') . '</th>
+					'event_espresso') . '</th>
 				</tr>';
-            $last_on_stack = count($trace) - 1;
-            // reverse array so that stack is in proper chronological order
-            $sorted_trace = array_reverse($trace);
-            foreach ($sorted_trace as $nmbr => $trace) {
-                $file = isset($trace['file']) ? $trace['file'] : '';
-                $class = isset($trace['class']) ? $trace['class'] : '';
-                $type = isset($trace['type']) ? $trace['type'] : '';
-                $function = isset($trace['function']) ? $trace['function'] : '';
-                $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
-                $line = isset($trace['line']) ? $trace['line'] : '';
-                $zebra = $nmbr % 2 !== 0 ? ' odd' : '';
-                if (empty($file) && ! empty($class)) {
-                    $a = new ReflectionClass($class);
-                    $file = $a->getFileName();
-                    if (empty($line) && ! empty($function)) {
-                        try {
-                            //if $function is a closure, this throws an exception
-                            $b = new ReflectionMethod($class, $function);
-                            $line = $b->getStartLine();
-                        } catch (Exception $closure_exception) {
-                            $line = 'unknown';
-                        }
-                    }
-                }
-                if ($nmbr === $last_on_stack) {
-                    $file = $exception->getFile() !== '' ? $exception->getFile() : $file;
-                    $line = $exception->getLine() !== '' ? $exception->getLine() : $line;
-                    $error_code = $this->generate_error_code($file, $trace['function'], $line);
-                }
-                $file = \EEH_File::standardise_directory_separators($file);
-                $nmbr = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                $line = ! empty($line) ? $line : '&nbsp;';
-                $file = ! empty($file) ? $file : '&nbsp;';
-                $class_display = ! empty($class) ? $class : '';
-                $type = ! empty($type) ? $type : '';
-                $function = ! empty($function) ? $function : '';
-                $args = ! empty($args) ? '( ' . $args . ' )' : '()';
-                $trace_details .= '
+			$last_on_stack = count($trace) - 1;
+			// reverse array so that stack is in proper chronological order
+			$sorted_trace = array_reverse($trace);
+			foreach ($sorted_trace as $nmbr => $trace) {
+				$file = isset($trace['file']) ? $trace['file'] : '';
+				$class = isset($trace['class']) ? $trace['class'] : '';
+				$type = isset($trace['type']) ? $trace['type'] : '';
+				$function = isset($trace['function']) ? $trace['function'] : '';
+				$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+				$args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+				$line = isset($trace['line']) ? $trace['line'] : '';
+				$zebra = $nmbr % 2 !== 0 ? ' odd' : '';
+				if (empty($file) && ! empty($class)) {
+					$a = new ReflectionClass($class);
+					$file = $a->getFileName();
+					if (empty($line) && ! empty($function)) {
+						try {
+							//if $function is a closure, this throws an exception
+							$b = new ReflectionMethod($class, $function);
+							$line = $b->getStartLine();
+						} catch (Exception $closure_exception) {
+							$line = 'unknown';
+						}
+					}
+				}
+				if ($nmbr === $last_on_stack) {
+					$file = $exception->getFile() !== '' ? $exception->getFile() : $file;
+					$line = $exception->getLine() !== '' ? $exception->getLine() : $line;
+					$error_code = $this->generate_error_code($file, $trace['function'], $line);
+				}
+				$file = \EEH_File::standardise_directory_separators($file);
+				$nmbr = ! empty($nmbr) ? $nmbr : '&nbsp;';
+				$line = ! empty($line) ? $line : '&nbsp;';
+				$file = ! empty($file) ? $file : '&nbsp;';
+				$class_display = ! empty($class) ? $class : '';
+				$type = ! empty($type) ? $type : '';
+				$function = ! empty($function) ? $function : '';
+				$args = ! empty($args) ? '( ' . $args . ' )' : '()';
+				$trace_details .= '
 					<tr>
 						<td align="right" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $nmbr
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $nmbr
+								  . '</td>
 						<td align="right" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $line
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $line
+								  . '</td>
 						<td align="left" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $file
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $file
+								  . '</td>
 						<td align="left" valign="top" class="'
-                                  . $zebra
-                                  . '">'
-                                  . $class_display
-                                  . $type
-                                  . $function
-                                  . $args
-                                  . '</td>
+								  . $zebra
+								  . '">'
+								  . $class_display
+								  . $type
+								  . $function
+								  . $args
+								  . '</td>
 					</tr>';
-            }
-            $trace_details .= '
+			}
+			$trace_details .= '
 			 </table>
 			</div>';
-        }
-        $code = $exception->getCode() ? $exception->getCode() : $error_code;
-        // add generic non-identifying messages for non-privileged users
-        if (! WP_DEBUG) {
-            $output .= '<span class="ee-error-user-msg-spn">'
-                       . trim($msg)
-                       . '</span> &nbsp; <sup>'
-                       . $code
-                       . '</sup><br />';
-        } else {
-            // or helpful developer messages if debugging is on
-            $output .= '
+		}
+		$code = $exception->getCode() ? $exception->getCode() : $error_code;
+		// add generic non-identifying messages for non-privileged users
+		if (! WP_DEBUG) {
+			$output .= '<span class="ee-error-user-msg-spn">'
+					   . trim($msg)
+					   . '</span> &nbsp; <sup>'
+					   . $code
+					   . '</sup><br />';
+		} else {
+			// or helpful developer messages if debugging is on
+			$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				'
-                       . sprintf(
-                           __('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
-                           '<strong class="ee-error-dev-msg-str">',
-                           get_class($exception),
-                           '</strong>  &nbsp; <span>',
-                           $code . '</span>'
-                       )
-                       . '<br />
+					   . sprintf(
+						   __('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
+						   '<strong class="ee-error-dev-msg-str">',
+						   get_class($exception),
+						   '</strong>  &nbsp; <span>',
+						   $code . '</span>'
+					   )
+					   . '<br />
 				<span class="big-text">"'
-                       . trim($msg)
-                       . '"</span><br/>
+					   . trim($msg)
+					   . '"</span><br/>
 				<a id="display-ee-error-trace-1'
-                       . $time
-                       . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
-                       . $time
-                       . '">
+					   . $time
+					   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
+					   . $time
+					   . '">
 					'
-                       . __('click to view backtrace and class/method details', 'event_espresso')
-                       . '
+					   . __('click to view backtrace and class/method details', 'event_espresso')
+					   . '
 				</a><br />
 				'
-                       . $exception->getFile()
-                       . sprintf(
-                           __('%1$s( line no: %2$s )%3$s', 'event_espresso'),
-                           ' &nbsp; <span class="small-text lt-grey-text">',
-                           $exception->getLine(),
-                           '</span>'
-                       )
-                       . '
+					   . $exception->getFile()
+					   . sprintf(
+						   __('%1$s( line no: %2$s )%3$s', 'event_espresso'),
+						   ' &nbsp; <span class="small-text lt-grey-text">',
+						   $exception->getLine(),
+						   '</span>'
+					   )
+					   . '
 			</p>
 			<div id="ee-error-trace-1'
-                       . $time
-                       . '-dv" class="ee-error-trace-dv" style="display: none;">
+					   . $time
+					   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                       . $trace_details;
-            if (! empty($class)) {
-                $output .= '
+					   . $trace_details;
+			if (! empty($class)) {
+				$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
 						<h3>' . __('Class Details', 'event_espresso') . '</h3>';
-                $a = new ReflectionClass($class);
-                $output .= '
+				$a = new ReflectionClass($class);
+				$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-            }
-            $output .= '
+			}
+			$output .= '
 			</div>
 		</div>
 		<br />';
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= $this->printScripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-    }
+		$output .= $this->printScripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+	}
 
 
 
-    /**
-     * generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param int   $indent
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
-    {
-        $args = array();
-        $args_count = count($arguments);
-        if ($args_count > 2) {
-            $indent++;
-            $args[] = '<br />';
-        }
-        $x = 0;
-        foreach ($arguments as $arg) {
-            $x++;
-            for ($i = 0; $i < $indent; $i++) {
-                $args[] = ' &nbsp;&nbsp; ';
-            }
-            if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
-                    $args[] = '<br />';
-                    for ($i = 0; $i <= $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                    $args[] = "'" . $arg . "'<br />";
-                } else {
-                    $args[] = " '" . $arg . "'";
-                }
-            } elseif (is_array($arg)) {
-                $arg_count = count($arg);
-                if ($arg_count > 2) {
-                    $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
-                    $indent--;
-                } else if ($arg_count === 0) {
-                    $args[] = ' array()';
-                } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
-                }
-            } elseif ($arg === null) {
-                $args[] = ' null';
-            } elseif (is_bool($arg)) {
-                $args[] = $arg ? ' true' : ' false';
-            } elseif (is_object($arg)) {
-                $args[] = get_class($arg);
-            } elseif (is_resource($arg)) {
-                $args[] = get_resource_type($arg);
-            } else {
-                $args[] = $arg;
-            }
-            if ($x === $args_count) {
-                if ($args_count > 2) {
-                    $args[] = '<br />';
-                    $indent--;
-                    for ($i = 1; $i < $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                }
-            } else {
-                $args[] = $args_count > 2 ? ',<br />' : ', ';
-            }
-        }
-        return implode('', $args);
-    }
+	/**
+	 * generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param int   $indent
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
+	{
+		$args = array();
+		$args_count = count($arguments);
+		if ($args_count > 2) {
+			$indent++;
+			$args[] = '<br />';
+		}
+		$x = 0;
+		foreach ($arguments as $arg) {
+			$x++;
+			for ($i = 0; $i < $indent; $i++) {
+				$args[] = ' &nbsp;&nbsp; ';
+			}
+			if (is_string($arg)) {
+				if (! $array && strlen($arg) > 75) {
+					$args[] = '<br />';
+					for ($i = 0; $i <= $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+					$args[] = "'" . $arg . "'<br />";
+				} else {
+					$args[] = " '" . $arg . "'";
+				}
+			} elseif (is_array($arg)) {
+				$arg_count = count($arg);
+				if ($arg_count > 2) {
+					$indent++;
+					$args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+					$indent--;
+				} else if ($arg_count === 0) {
+					$args[] = ' array()';
+				} else {
+					$args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+				}
+			} elseif ($arg === null) {
+				$args[] = ' null';
+			} elseif (is_bool($arg)) {
+				$args[] = $arg ? ' true' : ' false';
+			} elseif (is_object($arg)) {
+				$args[] = get_class($arg);
+			} elseif (is_resource($arg)) {
+				$args[] = get_resource_type($arg);
+			} else {
+				$args[] = $arg;
+			}
+			if ($x === $args_count) {
+				if ($args_count > 2) {
+					$args[] = '<br />';
+					$indent--;
+					for ($i = 1; $i < $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+				}
+			} else {
+				$args[] = $args_count > 2 ? ',<br />' : ', ';
+			}
+		}
+		return implode('', $args);
+	}
 
 
 
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @access protected
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    protected function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file_bits = explode('.', basename($file));
-        $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @access protected
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	protected function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file_bits = explode('.', basename($file));
+		$error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
 
 
 
-    /**
-     * _exception_styles
-     *
-     * @return string
-     */
-    private function exceptionStyles()
-    {
-        return '
+	/**
+	 * _exception_styles
+	 *
+	 * @return string
+	 */
+	private function exceptionStyles()
+	{
+		return '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -390,30 +390,30 @@ 
 		color: #999;
 	}
 </style>';
-    }
+	}
 
 
 
-    /**
-     * _print_scripts
-     *
-     * @param bool $force_print
-     * @return string
-     */
-    private function printScripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script( 'ee_error_js' );
+	/**
+	 * _print_scripts
+	 *
+	 * @param bool $force_print
+	 * @return string
+	 */
+	private function printScripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script( 'ee_error_js' );
 				wp_localize_script( 'ee_error_js', 'ee_settings', array( 'wp_debug' => WP_DEBUG ) );
-            }
-        } else {
-            return '
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -423,9 +423,9 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
+		}
+		return '';
+	}
 
 
 

Spacing +26 added lines, -26 removed lines

@@ -7,7 +7,7 @@ 
 use ReflectionException;
 use ReflectionMethod;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -61,7 +61,7 @@ 
         $output = $this->exceptionStyles();
         $output .= '
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	<p>';
         }
@@ -79,8 +79,8 @@ 
 					<th scope="col" align="right" style="width:2.5%;">#</th>
 					<th scope="col" align="right" style="width:3.5%;">Line</th>
 					<th scope="col" align="left" style="width:40%;">File</th>
-					<th scope="col" align="left">' . __('Class', 'event_espresso') . '->' . __('Method( arguments )',
-                    'event_espresso') . '</th>
+					<th scope="col" align="left">' . __('Class', 'event_espresso').'->'.__('Method( arguments )',
+                    'event_espresso').'</th>
 				</tr>';
             $last_on_stack = count($trace) - 1;
             // reverse array so that stack is in proper chronological order
@@ -91,7 +91,7 @@ 
                 $type = isset($trace['type']) ? $trace['type'] : '';
                 $function = isset($trace['function']) ? $trace['function'] : '';
                 $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />'.$args.'<br />' : $args;
                 $line = isset($trace['line']) ? $trace['line'] : '';
                 $zebra = $nmbr % 2 !== 0 ? ' odd' : '';
                 if (empty($file) && ! empty($class)) {
@@ -119,7 +119,7 @@ 
                 $class_display = ! empty($class) ? $class : '';
                 $type = ! empty($type) ? $type : '';
                 $function = ! empty($function) ? $function : '';
-                $args = ! empty($args) ? '( ' . $args . ' )' : '()';
+                $args = ! empty($args) ? '( '.$args.' )' : '()';
                 $trace_details .= '
 					<tr>
 						<td align="right" valign="top" class="'
@@ -153,7 +153,7 @@ 
         }
         $code = $exception->getCode() ? $exception->getCode() : $error_code;
         // add generic non-identifying messages for non-privileged users
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '<span class="ee-error-user-msg-spn">'
                        . trim($msg)
                        . '</span> &nbsp; <sup>'
@@ -170,7 +170,7 @@ 
                            '<strong class="ee-error-dev-msg-str">',
                            get_class($exception),
                            '</strong>  &nbsp; <span>',
-                           $code . '</span>'
+                           $code.'</span>'
                        )
                        . '<br />
 				<span class="big-text">"'
@@ -200,14 +200,14 @@ 
                        . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
                        . $trace_details;
-            if (! empty($class)) {
+            if ( ! empty($class)) {
                 $output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
-						<h3>' . __('Class Details', 'event_espresso') . '</h3>';
+						<h3>' . __('Class Details', 'event_espresso').'</h3>';
                 $a = new ReflectionClass($class);
                 $output .= '
-						<pre>' . $a . '</pre>
+						<pre>' . $a.'</pre>
 					</div>
 				</div>';
             }
@@ -218,7 +218,7 @@ 
         }
         // remove last linebreak
         $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	</p>';
         }
@@ -257,25 +257,25 @@ 
                 $args[] = ' &nbsp;&nbsp; ';
             }
             if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
+                if ( ! $array && strlen($arg) > 75) {
                     $args[] = '<br />';
                     for ($i = 0; $i <= $indent; $i++) {
                         $args[] = ' &nbsp;&nbsp; ';
                     }
-                    $args[] = "'" . $arg . "'<br />";
+                    $args[] = "'".$arg."'<br />";
                 } else {
-                    $args[] = " '" . $arg . "'";
+                    $args[] = " '".$arg."'";
                 }
             } elseif (is_array($arg)) {
                 $arg_count = count($arg);
                 if ($arg_count > 2) {
                     $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+                    $args[] = ' array('.$this->_convert_args_to_string($arg, $indent, true).')';
                     $indent--;
                 } else if ($arg_count === 0) {
                     $args[] = ' array()';
                 } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+                    $args[] = ' array( '.$this->_convert_args_to_string($arg).' )';
                 }
             } elseif ($arg === null) {
                 $args[] = ' null';
@@ -319,8 +319,8 @@ 
     {
         $file_bits = explode('.', basename($file));
         $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
+        $error_code .= ! empty($func) ? ' - '.$func : '';
+        $error_code .= ! empty($line) ? ' - '.$line : '';
         return $error_code;
     }
 
@@ -402,26 +402,26 @@ 
      */
     private function printScripts($force_print = false)
     {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+        if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
             if (wp_script_is('ee_error_js', 'enqueued')) {
                 return '';
             }
             if (wp_script_is('ee_error_js', 'registered')) {
                 wp_enqueue_style('espresso_default');
                 wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script( 'ee_error_js' );
-				wp_localize_script( 'ee_error_js', 'ee_settings', array( 'wp_debug' => WP_DEBUG ) );
+                wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
             }
         } else {
             return '
 <script>
 /* <![CDATA[ */
-var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
+var ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
 /* ]]> */
 </script>
-<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
+<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
 ';
         }
         return '';

core/libraries/rest_api/ModelDataTranslator.php

Indentation +789 added lines, -789 removed lines

@@ -11,7 +11,7 @@ 
 use EEM_Base;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -36,792 +36,792 @@ 
 class ModelDataTranslator
 {
 
-    /**
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
-     * fields that COULD contain -1; so we use null
-     */
-    const EE_INF_IN_REST = null;
-
-
-
-    /**
-     * Prepares a possible array of input values from JSON for use by the models
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     */
-    public static function prepareFieldValuesFromJson(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (is_array($original_value_maybe_array)
-            && ! $field_obj instanceof EE_Serialized_Text_Field
-        ) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $requested_version,
-                $timezone_string
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * Prepares an array of field values FOR use in JSON/REST API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $request_version (eg 4.8.36)
-     * @return array
-     */
-    public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value = array();
-            foreach ($original_value_maybe_array as $key => $value) {
-                $new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson($field_obj, $value, $request_version);
-            }
-        } else {
-            $new_value = ModelDataTranslator::prepareFieldValueForJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value;
-    }
-
-
-
-    /**
-     * Prepares incoming data from the json or $_REQUEST parameters for the models'
-     * "$query_params".
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     */
-    public static function prepareFieldValueFromJson(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC' // UTC
-    ) {
-        //check if they accidentally submitted an error value. If so throw an exception
-        if (is_array($original_value)
-            && isset($original_value['error_code'], $original_value['error_message'])) {
-            throw new RestException(
-                'rest_submitted_error_value',
-                sprintf(
-                    esc_html__(
-                        'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
-                        'event_espresso'
-                    ),
-                    $field_obj->get_name()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-        //double-check for serialized PHP. We never accept serialized PHP. No way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
-        $new_value = null;
-        //walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
-        // way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        if ($field_obj instanceof EE_Infinite_Integer_Field
-            && in_array($original_value, array(null, ''), true)
-        ) {
-            $new_value = EE_INF;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            list($offset_sign, $offset_secs) = ModelDataTranslator::parseTimezoneOffset(
-                $field_obj->get_timezone_offset(
-                    new \DateTimeZone($timezone_string),
-                    $original_value
-                )
-            );
-            $offset_string =
-                str_pad(
-                    floor($offset_secs / HOUR_IN_SECONDS),
-                    2,
-                    '0',
-                    STR_PAD_LEFT
-                )
-                . ':'
-                . str_pad(
-                    ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
-                    2,
-                    '0',
-                    STR_PAD_LEFT
-                );
-            $new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
-        } else {
-            $new_value = $original_value;
-        }
-        return $new_value;
-    }
-
-
-
-    /**
-     * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
-     * think that can happen). If $data is an array, recurses into its keys and values
-     * @param mixed $data
-     * @throws RestException
-     * @return void
-     */
-    public static function throwExceptionIfContainsSerializedData($data)
-    {
-        if (is_array($data)) {
-            foreach ($data as $key => $value) {
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
-            }
-        } else {
-            if (is_serialized($data) || is_object($data)) {
-                throw new RestException(
-                    'serialized_data_submission_prohibited',
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parseTimezoneOffset($timezone_offset)
-    {
-        $first_char = substr((string)$timezone_offset, 0, 1);
-        if ($first_char === '+' || $first_char === '-') {
-            $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
-        } else {
-            $offset_sign = '+';
-            $offset_secs = $timezone_offset;
-        }
-        return array($offset_sign, $offset_secs);
-    }
-
-
-
-    /**
-     * Prepares a field's value for display in the API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @return mixed
-     */
-    public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = ModelDataTranslator::EE_INF_IN_REST;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            if (is_string($original_value)) {
-                //did they submit a string of a unix timestamp?
-                if (is_numeric($original_value)) {
-                    $datetime_obj = new \DateTime();
-                    $datetime_obj->setTimestamp((int)$original_value);
-                } else {
-                    //first, check if its a MySQL timestamp in GMT
-                    $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
-                }
-                if (! $datetime_obj instanceof \DateTime) {
-                    //so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
-                    $datetime_obj = $field_obj->prepare_for_set($original_value);
-                }
-                $original_value = $datetime_obj;
-            }
-            if ($original_value instanceof \DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value) || is_float($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } elseif($original_value === null || $original_value === '') {
-                $new_value = null;
-            } else {
-                //so it's not a datetime object, unix timestamp (as string or int),
-                //MySQL timestamp, or even a string in the field object's format. So no idea what it is
-                throw new \EE_Error(
-                    sprintf(
-                        esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
-                            // @codingStandardsIgnoreEnd
-                            'event_espressso'
-                        ),
-                        $original_value,
-                        $field_obj->get_name(),
-                        $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
-                    )
-                );
-            }
-            $new_value = mysql_to_rfc3339($new_value);
-        } else {
-            $new_value = $original_value;
-        }
-        //are we about to send an object? just don't. We have no good way to represent it in JSON.
-        // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
-            $new_value = array(
-                'error_code' => 'php_object_not_return',
-                'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            $new_value,
-            $field_obj,
-            $original_value,
-            $requested_version
-        );
-    }
-
-
-
-    /**
-     * Prepares condition-query-parameters (like what's in where and having) from
-     * the format expected in the API to use in the models
-     *
-     * @param array     $inputted_query_params_of_this_type
-     * @param EEM_Base $model
-     * @param string    $requested_version
-     * @param boolean $writing whether this data will be written to the DB, or if we're just building a query.
-     *                         If we're writing to the DB, we don't expect any operators, or any logic query parameters,
-     *                         and we also won't accept serialized data unless the current user has unfiltered_html.
-     * @return array
-     * @throws \DomainException
-     * @throws RestException
-     * @throws EE_Error
-     */
-    public static function prepareConditionsQueryParamsForModels(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version,
-        $writing = false
-    ) {
-        $query_param_for_models = array();
-        $valid_operators = $model->valid_operators();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $is_gmt_datetime_field = false;
-            $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-                $query_param_key
-            );
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                $query_param_sans_stars,
-                $model
-            );
-            //double-check is it a *_gmt field?
-            if (! $field instanceof EE_Model_Field_Base
-                && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
-            ) {
-                //yep, take off '_gmt', and find the field
-                $query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars);
-                $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                    $query_param_key,
-                    $model
-                );
-                $timezone = 'UTC';
-                $is_gmt_datetime_field = true;
-            } elseif ($field instanceof EE_Datetime_Field) {
-                //so it's not a GMT field. Set the timezone on the model to the default
-                $timezone = \EEH_DTT_Helper::get_valid_timezone_string();
-            } else {
-                //just keep using what's already set for the timezone
-                $timezone = $model->get_timezone();
-            }
-            if ($field instanceof EE_Model_Field_Base) {
-                if (! $writing && is_array($query_param_value)) {
-                    if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
-                        if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                            throw new RestException(
-                                'numerically_indexed_array_of_values_only',
-                                sprintf(
-                                    esc_html__(
-                                        'The array provided for the parameter "%1$s" should be numerically indexed.',
-                                        'event_espresso'
-                                    ),
-                                    $query_param_key
-                                ),
-                                array(
-                                    'status' => 400,
-                                )
-                            );
-                        }
-                    }
-                    //did they specify an operator?
-                    if (isset($query_param_value[0])
-                        && isset($valid_operators[$query_param_value[0]])
-                    ) {
-                        $op = $query_param_value[0];
-                        $translated_value = array($op);
-                        if (array_key_exists($op, $model->valid_in_style_operators())
-                            && isset($query_param_value[1])
-                            && ! isset($query_param_value[2])
-                        ) {
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[1],
-                                $requested_version,
-                                $timezone
-                            );
-                        } elseif (array_key_exists($op, $model->valid_between_style_operators())
-                            && isset($query_param_value[1], $query_param_value[2])
-                            && !isset($query_param_value[3])
-                        ) {
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[1],
-                                $requested_version,
-                                $timezone
-                            );
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[2],
-                                $requested_version,
-                                $timezone
-                            );
-                        } elseif (array_key_exists($op, $model->valid_like_style_operators())
-                            && isset($query_param_value[1])
-                            && ! isset($query_param_value[2])
-                        ) {
-                            //we want to leave this value mostly-as-is (eg don't force it to be a float
-                            //or a boolean or an enum value. Leave it as-is with wildcards etc)
-                            //but do verify it at least doesn't have any serialized data
-                            ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
-                            $translated_value[] = $query_param_value[1];
-                        } elseif (array_key_exists($op, $model->valid_null_style_operators())
-                            && !isset($query_param_value[1])) {
-                            //no arguments should have been provided, so don't look for any
-                        } elseif (isset($query_param_value[1])
-                            && !isset($query_param_value[2])
-                            && ! array_key_exists(
-                                $op,
-                                array_merge(
-                                    $model->valid_in_style_operators(),
-                                    $model->valid_null_style_operators(),
-                                    $model->valid_like_style_operators(),
-                                    $model->valid_between_style_operators()
-                                )
-                            )
-                        ) {
-                            //it's a valid operator, but none of the exceptions. Treat it normally.
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[1],
-                                $requested_version,
-                                $timezone
-                            );
-                        } else {
-                            //so they provided a valid operator, but wrong number of arguments
-                            if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                                throw new RestException(
-                                    'wrong_number_of_arguments',
-                                    sprintf(
-                                        esc_html__(
-                                            'The operator you provided, "%1$s" had the wrong number of arguments',
-                                            'event_espresso'
-                                        ),
-                                        $op
-                                    ),
-                                    array(
-                                        'status' => 400,
-                                    )
-                                );
-                            }
-                            $translated_value = null;
-                        }
-                    } else {
-                        //so they didn't provide a valid operator
-                        if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                            throw new RestException(
-                                'invalid_operator',
-                                sprintf(
-                                    esc_html__(
-                                        'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
-                                        'event_espresso'
-                                    ),
-                                    $query_param_key,
-                                    $query_param_value
-                                ),
-                                array(
-                                    'status' => 400,
-                                )
-                            );
-                        }
-                        //if we aren't in debug mode, then just try our best to fulfill the user's request
-                        $translated_value = null;
-                    }
-                } else {
-                    $translated_value = ModelDataTranslator::prepareFieldValueFromJson(
-                        $field,
-                        $query_param_value,
-                        $requested_version,
-                        $timezone
-                    );
-                }
-                if (
-                    (isset($query_param_for_models[$query_param_key]) && $is_gmt_datetime_field)
-                    ||
-                    $translated_value === null
-                ) {
-                    //they have already provided a non-gmt field, ignore the gmt one. That's what WP core
-                    //currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
-                    //OR we couldn't create a translated value from their input
-                    continue;
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so this param doesn't correspond to a field eh?
-                if ($writing) {
-                    //always tell API clients about invalid parameters when they're creating data. Otherwise,
-                    //they are probably going to create invalid data
-                    throw new RestException(
-                        'invalid_field',
-                        sprintf(
-                            esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
-                            $query_param_key
-                        )
-                    );
-                } else {
-                    //so it's not for a field, is it a logic query param key?
-                    if (in_array(
-                        $query_param_sans_stars,
-                        $model->logic_query_param_keys()
-                    )) {
-                        $query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                            $query_param_value,
-                            $model,
-                            $requested_version
-                        );
-                    } elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                        //only tell API clients they got it wrong if we're in debug mode
-                        //otherwise try our best ot fulfill their request by ignoring this invalid data
-                        throw new RestException(
-                            'invalid_parameter',
-                            sprintf(
-                                esc_html__(
-                                    'You provided an invalid parameter, with key "%1$s"',
-                                    'event_espresso'
-                                ),
-                                $query_param_sans_stars
-                            ),
-                            array(
-                                'status' => 400,
-                            )
-                        );
-                    }
-                }
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
-     * gmt date field name
-     *
-     * @param string $field_name
-     * @return boolean
-     */
-    public static function isGmtDateFieldName($field_name)
-    {
-        return substr(
-            ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
-            -4,
-            4
-        ) === '_gmt';
-    }
-
-
-
-    /**
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function removeGmtFromFieldName($field_name)
-    {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-            $field_name
-        );
-        $query_param_sans_gmt_and_sans_stars = substr(
-            $query_param_sans_stars,
-            0,
-            strrpos(
-                $field_name,
-                '_gmt'
-            )
-        );
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
-    }
-
-
-
-    /**
-     * Takes a field name from the REST API and prepares it for the model querying
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function prepareFieldNameFromJson($field_name)
-    {
-        if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return ModelDataTranslator::removeGmtFromFieldName($field_name);
-        }
-        return $field_name;
-    }
-
-
-
-    /**
-     * Takes array of field names from REST API and prepares for models
-     *
-     * @param array $field_names
-     * @return array of field names (possibly include model prefixes)
-     */
-    public static function prepareFieldNamesFromJson(array $field_names)
-    {
-        $new_array = array();
-        foreach ($field_names as $key => $field_name) {
-            $new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Takes array where array keys are field names (possibly with model path prefixes)
-     * from the REST API and prepares them for model querying
-     *
-     * @param array $field_names_as_keys
-     * @return array
-     */
-    public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
-    {
-        $new_array = array();
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value;
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Prepares an array of model query params for use in the REST API
-     *
-     * @param array     $model_query_params
-     * @param EEM_Base $model
-     * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
-     *                                     REST API
-     * @return array which can be passed into the EE4 REST API when querying a model resource
-     * @throws EE_Error
-     */
-    public static function prepareQueryParamsForRestApi(
-        array $model_query_params,
-        EEM_Base $model,
-        $requested_version = null
-    ) {
-        if ($requested_version === null) {
-            $requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
-        }
-        $rest_query_params = $model_query_params;
-        if (isset($model_query_params[0])) {
-            $rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params['having'],
-                $model,
-                $requested_version
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
-            $rest_query_params,
-            $model_query_params,
-            $model,
-            $requested_version
-        );
-    }
-
-
-
-    /**
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
-     *
-     * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
-     *                                                      passed into EEM_Base::get_all()
-     * @param EEM_Base $model
-     * @param string    $requested_version                  eg "4.8.36"
-     * @return array ready for use in the rest api query params
-     * @throws EE_Error
-     * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
-     *                                     (which would be really unusual)
-     */
-    public static function prepareConditionsQueryParamsForRestApi(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
-                $model
-            );
-            if ($field instanceof EE_Model_Field_Base) {
-                //did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
-                            $field,
-                            $value,
-                            $requested_version
-                        );
-                    }
-                } else {
-                    $translated_value = ModelDataTranslator::prepareFieldValueForJson(
-                        $field,
-                        $query_param_value,
-                        $requested_version
-                    );
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                    $query_param_value,
-                    $model,
-                    $requested_version
-                );
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        } else {
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-            return $condition_query_param_sans_star;
-        }
-    }
-
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @param EEM_Base $model
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
-    {
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
-        //which will help us find the database table and column
-        $query_param_parts = explode('.', $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '_extract_column_name is empty when trying to extract column and table name from %s',
-                        'event_espresso'
-                    ),
-                    $query_param_name
-                )
-            );
-        }
-        $number_of_parts = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-        } else {// $number_of_parts >= 2
-            //the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
-        }
-        try {
-            return $model->field_settings_for($field_name, false);
-        } catch (EE_Error $e) {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * Returns true if $data can be easily represented in JSON.
-     * Basically, objects and resources can't be represented in JSON easily.
-     * @param mixed $data
-     * @return bool
-     */
-    protected static function isRepresentableInJson($data)
-    {
-        return is_scalar($data)
-               || is_array($data)
-               || is_null($data);
-    }
+	/**
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
+	 * fields that COULD contain -1; so we use null
+	 */
+	const EE_INF_IN_REST = null;
+
+
+
+	/**
+	 * Prepares a possible array of input values from JSON for use by the models
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 */
+	public static function prepareFieldValuesFromJson(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (is_array($original_value_maybe_array)
+			&& ! $field_obj instanceof EE_Serialized_Text_Field
+		) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$requested_version,
+				$timezone_string
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of field values FOR use in JSON/REST API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $request_version (eg 4.8.36)
+	 * @return array
+	 */
+	public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value = array();
+			foreach ($original_value_maybe_array as $key => $value) {
+				$new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson($field_obj, $value, $request_version);
+			}
+		} else {
+			$new_value = ModelDataTranslator::prepareFieldValueForJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value;
+	}
+
+
+
+	/**
+	 * Prepares incoming data from the json or $_REQUEST parameters for the models'
+	 * "$query_params".
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 */
+	public static function prepareFieldValueFromJson(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC' // UTC
+	) {
+		//check if they accidentally submitted an error value. If so throw an exception
+		if (is_array($original_value)
+			&& isset($original_value['error_code'], $original_value['error_message'])) {
+			throw new RestException(
+				'rest_submitted_error_value',
+				sprintf(
+					esc_html__(
+						'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
+						'event_espresso'
+					),
+					$field_obj->get_name()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+		//double-check for serialized PHP. We never accept serialized PHP. No way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
+		$new_value = null;
+		//walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
+		// way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		if ($field_obj instanceof EE_Infinite_Integer_Field
+			&& in_array($original_value, array(null, ''), true)
+		) {
+			$new_value = EE_INF;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			list($offset_sign, $offset_secs) = ModelDataTranslator::parseTimezoneOffset(
+				$field_obj->get_timezone_offset(
+					new \DateTimeZone($timezone_string),
+					$original_value
+				)
+			);
+			$offset_string =
+				str_pad(
+					floor($offset_secs / HOUR_IN_SECONDS),
+					2,
+					'0',
+					STR_PAD_LEFT
+				)
+				. ':'
+				. str_pad(
+					($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
+					2,
+					'0',
+					STR_PAD_LEFT
+				);
+			$new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
+		} else {
+			$new_value = $original_value;
+		}
+		return $new_value;
+	}
+
+
+
+	/**
+	 * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
+	 * think that can happen). If $data is an array, recurses into its keys and values
+	 * @param mixed $data
+	 * @throws RestException
+	 * @return void
+	 */
+	public static function throwExceptionIfContainsSerializedData($data)
+	{
+		if (is_array($data)) {
+			foreach ($data as $key => $value) {
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
+			}
+		} else {
+			if (is_serialized($data) || is_object($data)) {
+				throw new RestException(
+					'serialized_data_submission_prohibited',
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parseTimezoneOffset($timezone_offset)
+	{
+		$first_char = substr((string)$timezone_offset, 0, 1);
+		if ($first_char === '+' || $first_char === '-') {
+			$offset_sign = $first_char;
+			$offset_secs = substr((string)$timezone_offset, 1);
+		} else {
+			$offset_sign = '+';
+			$offset_secs = $timezone_offset;
+		}
+		return array($offset_sign, $offset_secs);
+	}
+
+
+
+	/**
+	 * Prepares a field's value for display in the API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @return mixed
+	 */
+	public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = ModelDataTranslator::EE_INF_IN_REST;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			if (is_string($original_value)) {
+				//did they submit a string of a unix timestamp?
+				if (is_numeric($original_value)) {
+					$datetime_obj = new \DateTime();
+					$datetime_obj->setTimestamp((int)$original_value);
+				} else {
+					//first, check if its a MySQL timestamp in GMT
+					$datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
+				}
+				if (! $datetime_obj instanceof \DateTime) {
+					//so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
+					$datetime_obj = $field_obj->prepare_for_set($original_value);
+				}
+				$original_value = $datetime_obj;
+			}
+			if ($original_value instanceof \DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value) || is_float($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} elseif($original_value === null || $original_value === '') {
+				$new_value = null;
+			} else {
+				//so it's not a datetime object, unix timestamp (as string or int),
+				//MySQL timestamp, or even a string in the field object's format. So no idea what it is
+				throw new \EE_Error(
+					sprintf(
+						esc_html__(
+						// @codingStandardsIgnoreStart
+							'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
+							// @codingStandardsIgnoreEnd
+							'event_espressso'
+						),
+						$original_value,
+						$field_obj->get_name(),
+						$field_obj->get_model_name(),
+						$field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+					)
+				);
+			}
+			$new_value = mysql_to_rfc3339($new_value);
+		} else {
+			$new_value = $original_value;
+		}
+		//are we about to send an object? just don't. We have no good way to represent it in JSON.
+		// can't just check using is_object() because that missed PHP incomplete objects
+		if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+			$new_value = array(
+				'error_code' => 'php_object_not_return',
+				'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			$new_value,
+			$field_obj,
+			$original_value,
+			$requested_version
+		);
+	}
+
+
+
+	/**
+	 * Prepares condition-query-parameters (like what's in where and having) from
+	 * the format expected in the API to use in the models
+	 *
+	 * @param array     $inputted_query_params_of_this_type
+	 * @param EEM_Base $model
+	 * @param string    $requested_version
+	 * @param boolean $writing whether this data will be written to the DB, or if we're just building a query.
+	 *                         If we're writing to the DB, we don't expect any operators, or any logic query parameters,
+	 *                         and we also won't accept serialized data unless the current user has unfiltered_html.
+	 * @return array
+	 * @throws \DomainException
+	 * @throws RestException
+	 * @throws EE_Error
+	 */
+	public static function prepareConditionsQueryParamsForModels(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version,
+		$writing = false
+	) {
+		$query_param_for_models = array();
+		$valid_operators = $model->valid_operators();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$is_gmt_datetime_field = false;
+			$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+				$query_param_key
+			);
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
+				$query_param_sans_stars,
+				$model
+			);
+			//double-check is it a *_gmt field?
+			if (! $field instanceof EE_Model_Field_Base
+				&& ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
+			) {
+				//yep, take off '_gmt', and find the field
+				$query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars);
+				$field = ModelDataTranslator::deduceFieldFromQueryParam(
+					$query_param_key,
+					$model
+				);
+				$timezone = 'UTC';
+				$is_gmt_datetime_field = true;
+			} elseif ($field instanceof EE_Datetime_Field) {
+				//so it's not a GMT field. Set the timezone on the model to the default
+				$timezone = \EEH_DTT_Helper::get_valid_timezone_string();
+			} else {
+				//just keep using what's already set for the timezone
+				$timezone = $model->get_timezone();
+			}
+			if ($field instanceof EE_Model_Field_Base) {
+				if (! $writing && is_array($query_param_value)) {
+					if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
+						if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+							throw new RestException(
+								'numerically_indexed_array_of_values_only',
+								sprintf(
+									esc_html__(
+										'The array provided for the parameter "%1$s" should be numerically indexed.',
+										'event_espresso'
+									),
+									$query_param_key
+								),
+								array(
+									'status' => 400,
+								)
+							);
+						}
+					}
+					//did they specify an operator?
+					if (isset($query_param_value[0])
+						&& isset($valid_operators[$query_param_value[0]])
+					) {
+						$op = $query_param_value[0];
+						$translated_value = array($op);
+						if (array_key_exists($op, $model->valid_in_style_operators())
+							&& isset($query_param_value[1])
+							&& ! isset($query_param_value[2])
+						) {
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[1],
+								$requested_version,
+								$timezone
+							);
+						} elseif (array_key_exists($op, $model->valid_between_style_operators())
+							&& isset($query_param_value[1], $query_param_value[2])
+							&& !isset($query_param_value[3])
+						) {
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[1],
+								$requested_version,
+								$timezone
+							);
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[2],
+								$requested_version,
+								$timezone
+							);
+						} elseif (array_key_exists($op, $model->valid_like_style_operators())
+							&& isset($query_param_value[1])
+							&& ! isset($query_param_value[2])
+						) {
+							//we want to leave this value mostly-as-is (eg don't force it to be a float
+							//or a boolean or an enum value. Leave it as-is with wildcards etc)
+							//but do verify it at least doesn't have any serialized data
+							ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
+							$translated_value[] = $query_param_value[1];
+						} elseif (array_key_exists($op, $model->valid_null_style_operators())
+							&& !isset($query_param_value[1])) {
+							//no arguments should have been provided, so don't look for any
+						} elseif (isset($query_param_value[1])
+							&& !isset($query_param_value[2])
+							&& ! array_key_exists(
+								$op,
+								array_merge(
+									$model->valid_in_style_operators(),
+									$model->valid_null_style_operators(),
+									$model->valid_like_style_operators(),
+									$model->valid_between_style_operators()
+								)
+							)
+						) {
+							//it's a valid operator, but none of the exceptions. Treat it normally.
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[1],
+								$requested_version,
+								$timezone
+							);
+						} else {
+							//so they provided a valid operator, but wrong number of arguments
+							if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+								throw new RestException(
+									'wrong_number_of_arguments',
+									sprintf(
+										esc_html__(
+											'The operator you provided, "%1$s" had the wrong number of arguments',
+											'event_espresso'
+										),
+										$op
+									),
+									array(
+										'status' => 400,
+									)
+								);
+							}
+							$translated_value = null;
+						}
+					} else {
+						//so they didn't provide a valid operator
+						if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+							throw new RestException(
+								'invalid_operator',
+								sprintf(
+									esc_html__(
+										'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
+										'event_espresso'
+									),
+									$query_param_key,
+									$query_param_value
+								),
+								array(
+									'status' => 400,
+								)
+							);
+						}
+						//if we aren't in debug mode, then just try our best to fulfill the user's request
+						$translated_value = null;
+					}
+				} else {
+					$translated_value = ModelDataTranslator::prepareFieldValueFromJson(
+						$field,
+						$query_param_value,
+						$requested_version,
+						$timezone
+					);
+				}
+				if (
+					(isset($query_param_for_models[$query_param_key]) && $is_gmt_datetime_field)
+					||
+					$translated_value === null
+				) {
+					//they have already provided a non-gmt field, ignore the gmt one. That's what WP core
+					//currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
+					//OR we couldn't create a translated value from their input
+					continue;
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so this param doesn't correspond to a field eh?
+				if ($writing) {
+					//always tell API clients about invalid parameters when they're creating data. Otherwise,
+					//they are probably going to create invalid data
+					throw new RestException(
+						'invalid_field',
+						sprintf(
+							esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
+							$query_param_key
+						)
+					);
+				} else {
+					//so it's not for a field, is it a logic query param key?
+					if (in_array(
+						$query_param_sans_stars,
+						$model->logic_query_param_keys()
+					)) {
+						$query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+							$query_param_value,
+							$model,
+							$requested_version
+						);
+					} elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+						//only tell API clients they got it wrong if we're in debug mode
+						//otherwise try our best ot fulfill their request by ignoring this invalid data
+						throw new RestException(
+							'invalid_parameter',
+							sprintf(
+								esc_html__(
+									'You provided an invalid parameter, with key "%1$s"',
+									'event_espresso'
+								),
+								$query_param_sans_stars
+							),
+							array(
+								'status' => 400,
+							)
+						);
+					}
+				}
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
+	 * gmt date field name
+	 *
+	 * @param string $field_name
+	 * @return boolean
+	 */
+	public static function isGmtDateFieldName($field_name)
+	{
+		return substr(
+			ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
+			-4,
+			4
+		) === '_gmt';
+	}
+
+
+
+	/**
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function removeGmtFromFieldName($field_name)
+	{
+		if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+			$field_name
+		);
+		$query_param_sans_gmt_and_sans_stars = substr(
+			$query_param_sans_stars,
+			0,
+			strrpos(
+				$field_name,
+				'_gmt'
+			)
+		);
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
+	}
+
+
+
+	/**
+	 * Takes a field name from the REST API and prepares it for the model querying
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function prepareFieldNameFromJson($field_name)
+	{
+		if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return ModelDataTranslator::removeGmtFromFieldName($field_name);
+		}
+		return $field_name;
+	}
+
+
+
+	/**
+	 * Takes array of field names from REST API and prepares for models
+	 *
+	 * @param array $field_names
+	 * @return array of field names (possibly include model prefixes)
+	 */
+	public static function prepareFieldNamesFromJson(array $field_names)
+	{
+		$new_array = array();
+		foreach ($field_names as $key => $field_name) {
+			$new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Takes array where array keys are field names (possibly with model path prefixes)
+	 * from the REST API and prepares them for model querying
+	 *
+	 * @param array $field_names_as_keys
+	 * @return array
+	 */
+	public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
+	{
+		$new_array = array();
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value;
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of model query params for use in the REST API
+	 *
+	 * @param array     $model_query_params
+	 * @param EEM_Base $model
+	 * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
+	 *                                     REST API
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
+	 * @throws EE_Error
+	 */
+	public static function prepareQueryParamsForRestApi(
+		array $model_query_params,
+		EEM_Base $model,
+		$requested_version = null
+	) {
+		if ($requested_version === null) {
+			$requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
+		}
+		$rest_query_params = $model_query_params;
+		if (isset($model_query_params[0])) {
+			$rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params['having'],
+				$model,
+				$requested_version
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
+			$rest_query_params,
+			$model_query_params,
+			$model,
+			$requested_version
+		);
+	}
+
+
+
+	/**
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
+	 *
+	 * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
+	 *                                                      passed into EEM_Base::get_all()
+	 * @param EEM_Base $model
+	 * @param string    $requested_version                  eg "4.8.36"
+	 * @return array ready for use in the rest api query params
+	 * @throws EE_Error
+	 * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
+	 *                                     (which would be really unusual)
+	 */
+	public static function prepareConditionsQueryParamsForRestApi(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
+				ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
+				$model
+			);
+			if ($field instanceof EE_Model_Field_Base) {
+				//did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
+							$field,
+							$value,
+							$requested_version
+						);
+					}
+				} else {
+					$translated_value = ModelDataTranslator::prepareFieldValueForJson(
+						$field,
+						$query_param_value,
+						$requested_version
+					);
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+					$query_param_value,
+					$model,
+					$requested_version
+				);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		} else {
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+			return $condition_query_param_sans_star;
+		}
+	}
+
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @param EEM_Base $model
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
+	{
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
+		//which will help us find the database table and column
+		$query_param_parts = explode('.', $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'_extract_column_name is empty when trying to extract column and table name from %s',
+						'event_espresso'
+					),
+					$query_param_name
+				)
+			);
+		}
+		$number_of_parts = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+		} else {// $number_of_parts >= 2
+			//the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
+		}
+		try {
+			return $model->field_settings_for($field_name, false);
+		} catch (EE_Error $e) {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * Returns true if $data can be easily represented in JSON.
+	 * Basically, objects and resources can't be represented in JSON easily.
+	 * @param mixed $data
+	 * @return bool
+	 */
+	protected static function isRepresentableInJson($data)
+	{
+		return is_scalar($data)
+			   || is_array($data)
+			   || is_null($data);
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -10,7 +10,7 @@ 
 use EE_Serialized_Text_Field;
 use EEM_Base;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -178,7 +178,7 @@ 
                     '0',
                     STR_PAD_LEFT
                 );
-            $new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
+            $new_value = rest_parse_date($original_value.$offset_sign.$offset_string);
         } else {
             $new_value = $original_value;
         }
@@ -226,10 +226,10 @@ 
      */
     private static function parseTimezoneOffset($timezone_offset)
     {
-        $first_char = substr((string)$timezone_offset, 0, 1);
+        $first_char = substr((string) $timezone_offset, 0, 1);
         if ($first_char === '+' || $first_char === '-') {
             $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
+            $offset_secs = substr((string) $timezone_offset, 1);
         } else {
             $offset_sign = '+';
             $offset_secs = $timezone_offset;
@@ -256,12 +256,12 @@ 
                 //did they submit a string of a unix timestamp?
                 if (is_numeric($original_value)) {
                     $datetime_obj = new \DateTime();
-                    $datetime_obj->setTimestamp((int)$original_value);
+                    $datetime_obj->setTimestamp((int) $original_value);
                 } else {
                     //first, check if its a MySQL timestamp in GMT
                     $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
                 }
-                if (! $datetime_obj instanceof \DateTime) {
+                if ( ! $datetime_obj instanceof \DateTime) {
                     //so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
                     $datetime_obj = $field_obj->prepare_for_set($original_value);
                 }
@@ -271,7 +271,7 @@ 
                 $new_value = $original_value->format('Y-m-d H:i:s');
             } elseif (is_int($original_value) || is_float($original_value)) {
                 $new_value = date('Y-m-d H:i:s', $original_value);
-            } elseif($original_value === null || $original_value === '') {
+            } elseif ($original_value === null || $original_value === '') {
                 $new_value = null;
             } else {
                 //so it's not a datetime object, unix timestamp (as string or int),
@@ -287,7 +287,7 @@ 
                         $original_value,
                         $field_obj->get_name(),
                         $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+                        $field_obj->get_time_format().' '.$field_obj->get_time_format()
                     )
                 );
             }
@@ -297,7 +297,7 @@ 
         }
         //are we about to send an object? just don't. We have no good way to represent it in JSON.
         // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+        if ( ! ModelDataTranslator::isRepresentableInJson($new_value)) {
             $new_value = array(
                 'error_code' => 'php_object_not_return',
                 'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
@@ -347,7 +347,7 @@ 
                 $model
             );
             //double-check is it a *_gmt field?
-            if (! $field instanceof EE_Model_Field_Base
+            if ( ! $field instanceof EE_Model_Field_Base
                 && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
             ) {
                 //yep, take off '_gmt', and find the field
@@ -366,8 +366,8 @@ 
                 $timezone = $model->get_timezone();
             }
             if ($field instanceof EE_Model_Field_Base) {
-                if (! $writing && is_array($query_param_value)) {
-                    if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
+                if ( ! $writing && is_array($query_param_value)) {
+                    if ( ! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
                         if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
                             throw new RestException(
                                 'numerically_indexed_array_of_values_only',
@@ -402,7 +402,7 @@ 
                             );
                         } elseif (array_key_exists($op, $model->valid_between_style_operators())
                             && isset($query_param_value[1], $query_param_value[2])
-                            && !isset($query_param_value[3])
+                            && ! isset($query_param_value[3])
                         ) {
                             $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
                                 $field,
@@ -426,10 +426,10 @@ 
                             ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
                             $translated_value[] = $query_param_value[1];
                         } elseif (array_key_exists($op, $model->valid_null_style_operators())
-                            && !isset($query_param_value[1])) {
+                            && ! isset($query_param_value[1])) {
                             //no arguments should have been provided, so don't look for any
                         } elseif (isset($query_param_value[1])
-                            && !isset($query_param_value[2])
+                            && ! isset($query_param_value[2])
                             && ! array_key_exists(
                                 $op,
                                 array_merge(
@@ -580,7 +580,7 @@ 
      */
     public static function removeGmtFromFieldName($field_name)
     {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+        if ( ! ModelDataTranslator::isGmtDateFieldName($field_name)) {
             return $field_name;
         }
         $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(

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

Doc Comments +1 added lines

@@ -569,6 +569,7 @@
      * @param EE_Registration $registration
      * @param EE_Question     $question
      * @param                 mixed EE_Answer|NULL      $answer
+     * @param EE_Answer $answer
      * @return EE_Form_Input_Base
      * @throws \EE_Error
      */

Spacing +49 added lines, -50 removed lines

@@ -47,7 +47,7 @@ 
     {
         $this->_slug     = 'attendee_information';
         $this->_name     = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'attendee_info_main.template.php';
         $this->checkout  = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -58,11 +58,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'
         );
@@ -70,18 +70,18 @@ 
             '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__(
                 'The attendee information was successfully copied.%sPlease 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__(
+        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'
         );
@@ -144,7 +144,7 @@ 
                     && $this->checkout->visit_allows_processing_of_this_registration($registration)
                 ) {
                     $subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
-                    if (! $this->checkout->admin_request) {
+                    if ( ! $this->checkout->admin_request) {
                         $template_args['registrations'][$registration->reg_url_link()]    = $registration;
                         $template_args['ticket_count'][$registration->ticket()->ID()]     = isset(
                             $template_args['ticket_count'][$registration->ticket()->ID()]
@@ -193,8 +193,7 @@ 
                 'html_id'         => $this->reg_form_name(),
                 'subsections'     => $subsections,
                 'layout_strategy' => $this->checkout->admin_request ?
-                    new EE_Div_Per_Section_Layout() :
-                    new EE_Template_Layout(
+                    new EE_Div_Per_Section_Layout() : new EE_Template_Layout(
                         array(
                             'layout_template_file' => $this->_template, // layout_template
                             'template_args'        => $template_args,
@@ -232,7 +231,7 @@ 
             if ($question_groups) {
                 // array of params to pass to parent constructor
                 $form_args = array(
-                    '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;'
@@ -288,7 +287,7 @@ 
         // generate hidden input
         return new EE_Hidden_Input(
             array(
-                '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,
             )
         );
@@ -308,11 +307,11 @@ 
     {
         // array of params to pass to parent constructor
         $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
+            'html_id'         => 'ee-reg-form-qstn-grp-'.$question_group->identifier(),
             '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() . '-lbl',
+            'html_label_id'   => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-lbl',
             'subsections'     => array(
                 'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
             ),
@@ -323,7 +322,7 @@ 
         // where params
         $query_params = array('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'] = array('!=', true);
         }
         $questions = $question_group->get_many_related(
@@ -467,7 +466,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+                SPCO_REG_STEPS_PATH.$this->_slug.DS.'_auto_copy_attendee_info.template.php',
                 apply_filters(
                     'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
                     array()
@@ -499,16 +498,16 @@ 
                 if ($registration->ticket()->ID() !== $prev_ticket) {
                     $item_name = $registration->ticket()->name();
                     $item_name .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
+                        ? ' - '.$registration->ticket()->description()
                         : '';
-                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']'] =
+                    $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();
                 }
 
-                $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(
                         array(
                             $registration->ID() => sprintf(
@@ -517,7 +516,7 @@ 
                             ),
                         ),
                         array(
-                            '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,
                         )
@@ -566,7 +565,7 @@ 
             $registration,
             $question->system_ID()
         );
-        $answer       = $answer_value === null
+        $answer = $answer_value === null
             ? EEM_Answer::instance()->get_one(
                 array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
             )
@@ -583,14 +582,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);
@@ -622,18 +621,18 @@ 
             10,
             4
         );
-        $input_constructor_args                  = array(
-            '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 = array(
+            '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,
@@ -676,7 +675,7 @@ 
         $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();
@@ -726,7 +725,7 @@ 
         $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();
@@ -778,7 +777,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.',
@@ -809,7 +808,7 @@ 
         if ($registrations_processed === false) {
             // but return immediately if the previous step exited early due to errors
             return false;
-        } elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+        } elseif ( ! $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(
@@ -889,7 +888,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.',
@@ -904,12 +903,12 @@ 
             /** @var string $reg_url_link */
             $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();
                     }
                     /**
@@ -944,7 +943,7 @@ 
                             ? true
                             : false;
                         // 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]
                         );
@@ -956,11 +955,11 @@ 
                         }
                         // 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)) {
+                            if ( ! in_array($form_section, $non_input_form_sections)) {
                                 foreach ($form_inputs as $form_input => $input_value) {
                                     // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
                                     // check for critical inputs
-                                    if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+                                    if ( ! $this->_verify_critical_attendee_details_are_set_and_validate_email(
                                         $form_input,
                                         $input_value
                                     )
@@ -980,7 +979,7 @@ 
                                         $input_value = $primary_registrant[$form_input];
                                     }
                                     // now attempt to save the input data
-                                    if (! $this->_save_registration_form_input(
+                                    if ( ! $this->_save_registration_form_input(
                                         $registration,
                                         $form_input,
                                         $input_value
@@ -1036,7 +1035,7 @@ 
                     // add relation to registration, set attendee ID, and cache attendee
                     $this->_associate_attendee_with_registration($registration, $attendee);
                     // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
+                    if ( ! $registration->attendee() instanceof EE_Attendee) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1121,7 +1120,7 @@ 
          * @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()
             : $form_input;
         $answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
                            && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
@@ -1142,10 +1141,10 @@ 
                 break;
 
             default:
-                $ATT_input = 'ATT_' . $form_input;
+                $ATT_input = 'ATT_'.$form_input;
                 //EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
                 $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
+                $form_input        = $attendee_property ? 'ATT_'.$form_input : $form_input;
         }
         // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
         // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
@@ -1190,7 +1189,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) {
@@ -1277,7 +1276,7 @@ 
             'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
             false
         )) {
-            $address_details           = array(
+            $address_details = array(
                 'ATT_address',
                 'ATT_address2',
                 'ATT_city',
@@ -1289,7 +1288,7 @@ 
             $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])
+            if ( ! isset($attendee_data[$critical_attendee_detail])
                 || empty($attendee_data[$critical_attendee_detail])
             ) {
                 $attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(

Indentation +1316 added lines, -1316 removed lines

@@ -16,1324 +16,1324 @@
 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 = array();
-
-    /**
-     * @type array $_required_questions
-     */
-    private $_required_questions = array();
-
-    /**
-     * @type array $_registration_answers
-     */
-    private $_registration_answers = array();
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug     = 'attendee_information';
-        $this->_name     = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
-        $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__(
-                'The attendee information was successfully copied.%sPlease 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 EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function generate_reg_form()
-    {
-        $this->_print_copy_info = false;
-        $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(),
-            array('set_tax_rate' => true)
-        );
-        /** @var $subsections EE_Form_Section_Proper[] */
-        $subsections   = array(
-            'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-        );
-        $template_args = array(
-            'revisit'       => $this->checkout->revisit,
-            'registrations' => array(),
-            'ticket_count'  => array(),
-        );
-        // 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);
-                    if (! $this->checkout->admin_request) {
-                        $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',
-                            array($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();
-                    }
-                }
-            }
-            // print_copy_info ?
-            if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
-                // TODO: add admin option for toggling copy attendee info,
-                // then use that value to change $this->_print_copy_info
-                $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
-                    );
-                }
-            }
-        }
-
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => $this->checkout->admin_request ?
-                    new EE_Div_Per_Section_Layout() :
-                    new EE_Template_Layout(
-                        array(
-                            '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 \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _registrations_reg_form(EE_Registration $registration)
-    {
-        static $attendee_nmbr = 1;
-        $form_args = array();
-        // verify that registration has valid event
-        if ($registration->event() instanceof EE_Event) {
-            $question_groups = $registration->event()->question_groups(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-                    array(
-                        array(
-                            'Event.EVT_ID'                     => $registration->event()->ID(),
-                            'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
-                        ),
-                        'order_by' => array('QSG_order' => 'ASC'),
-                    ),
-                    $registration,
-                    $this
-                )
-            );
-            if ($question_groups) {
-                // array of params to pass to parent constructor
-                $form_args = array(
-                    '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'     => array(),
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        array(
-                            'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
-                            'legend_text'  => sprintf(__('Attendee %d', '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
-                );
-                // if we have question groups for additional attendees, then display the copy options
-                $this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
-                        $registration
-                    );
-                }
-            }
-        }
-        $attendee_nmbr++;
-        return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * _additional_attendee_reg_info_input
-     *
-     * @access public
-     * @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(
-            array(
-                '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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
-    {
-        // array of params to pass to parent constructor
-        $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
-            '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() . '-lbl',
-            'subsections'     => array(
-                '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 = array('QST_deleted' => 0);
-        // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
-            $query_params['QST_admin_only'] = array('!=', 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',
-                array(
-                    $query_params,
-                    'order_by' => array(
-                        '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
-            )
-        );
+	/**
+	 * @type bool $_print_copy_info
+	 */
+	private $_print_copy_info = false;
+
+	/**
+	 * @type array $_attendee_data
+	 */
+	private $_attendee_data = array();
+
+	/**
+	 * @type array $_required_questions
+	 */
+	private $_required_questions = array();
+
+	/**
+	 * @type array $_registration_answers
+	 */
+	private $_registration_answers = array();
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug     = 'attendee_information';
+		$this->_name     = esc_html__('Attendee Information', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+		$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__(
+				'The attendee information was successfully copied.%sPlease 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 EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function generate_reg_form()
+	{
+		$this->_print_copy_info = false;
+		$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(),
+			array('set_tax_rate' => true)
+		);
+		/** @var $subsections EE_Form_Section_Proper[] */
+		$subsections   = array(
+			'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+		);
+		$template_args = array(
+			'revisit'       => $this->checkout->revisit,
+			'registrations' => array(),
+			'ticket_count'  => array(),
+		);
+		// 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);
+					if (! $this->checkout->admin_request) {
+						$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',
+							array($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();
+					}
+				}
+			}
+			// print_copy_info ?
+			if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
+				// TODO: add admin option for toggling copy attendee info,
+				// then use that value to change $this->_print_copy_info
+				$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
+					);
+				}
+			}
+		}
+
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => $this->checkout->admin_request ?
+					new EE_Div_Per_Section_Layout() :
+					new EE_Template_Layout(
+						array(
+							'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 \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _registrations_reg_form(EE_Registration $registration)
+	{
+		static $attendee_nmbr = 1;
+		$form_args = array();
+		// verify that registration has valid event
+		if ($registration->event() instanceof EE_Event) {
+			$question_groups = $registration->event()->question_groups(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+					array(
+						array(
+							'Event.EVT_ID'                     => $registration->event()->ID(),
+							'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
+						),
+						'order_by' => array('QSG_order' => 'ASC'),
+					),
+					$registration,
+					$this
+				)
+			);
+			if ($question_groups) {
+				// array of params to pass to parent constructor
+				$form_args = array(
+					'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'     => array(),
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						array(
+							'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
+							'legend_text'  => sprintf(__('Attendee %d', '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
+				);
+				// if we have question groups for additional attendees, then display the copy options
+				$this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
+						$registration
+					);
+				}
+			}
+		}
+		$attendee_nmbr++;
+		return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * _additional_attendee_reg_info_input
+	 *
+	 * @access public
+	 * @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(
+			array(
+				'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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
+	{
+		// array of params to pass to parent constructor
+		$form_args = array(
+			'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
+			'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() . '-lbl',
+			'subsections'     => array(
+				'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 = array('QST_deleted' => 0);
+		// don't load admin only questions on the frontend
+		if (! $this->checkout->admin_request) {
+			$query_params['QST_admin_only'] = array('!=', 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',
+				array(
+					$query_params,
+					'order_by' => array(
+						'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
-        );
-    }
-
-
-    /**
-     * @access public
-     * @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);
-    }
-
-
-    /**
-     * @access public
-     * @return    EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _copy_attendee_info_form()
-    {
-        // array of params to pass to parent constructor
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections'     => $this->_copy_attendee_info_inputs(),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file'     => SPCO_REG_STEPS_PATH
-                                                      . $this->_slug
-                                                      . DS
-                                                      . 'copy_attendee_info.template.php',
-                        'begin_template_file'      => null,
-                        'input_template_file'      => null,
-                        'subsection_template_file' => null,
-                        'end_template_file'        => null,
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _auto_copy_attendee_info
-     *
-     * @access public
-     * @return EE_Form_Section_HTML
-     */
-    private function _auto_copy_attendee_info()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-                    array()
-                ),
-                true,
-                true
-            )
-        );
-    }
-
-
-    /**
-     * _copy_attendee_info_inputs
-     *
-     * @access public
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _copy_attendee_info_inputs()
-    {
-        $copy_attendee_info_inputs = array();
-        $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(
-                        array(
-                            $registration->ID() => sprintf(
-                                esc_html__('Attendee #%s', 'event_espresso'),
-                                $registration->count()
-                            ),
-                        ),
-                        array(
-                            '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;
-    }
-
-
-    /**
-     * _additional_primary_registrant_inputs
-     *
-     * @access public
-     * @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(
-            array(
-                'html_id' => 'primary_registrant',
-                'default' => $registration->reg_url_link(),
-            )
-        );
-    }
-
-
-    /**
-     * @access public
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    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(
-                array(array('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(array(
-                '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                 mixed EE_Answer|NULL      $answer
-     * @return EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    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() ? true : false;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input'),
-            10,
-            4
-        );
-        $input_constructor_args                  = array(
-            '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',
-            array($this, 'use_cached_countries_for_form_input')
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function use_cached_countries_for_form_input(
-        $countries_list,
-        \EE_Question $question = null,
-        \EE_Registration $registration = null,
-        \EE_Answer $answer = null
-    ) {
-        $country_options = array('' => '');
-        // 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(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        $country_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $country_options;
-    }
-
-
-    /**
-     * 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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function use_cached_states_for_form_input(
-        $states_list,
-        \EE_Question $question = null,
-        \EE_Registration $registration = null,
-        \EE_Answer $answer = null
-    ) {
-        $state_options = array('' => array('' => ''));
-        $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();
-                }
-            }
-        }
-        $state_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $state_options;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\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();
-        // EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
-        // 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)) {
-            EE_Error::add_error(
-                esc_html__('Your form data could not be applied to any valid registrations.', 'event_espresso'),
-                __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;
-        } elseif (! $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__(
-                        'There was %1$d ticket in the Event Queue, but %2$ds 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__(
-                        'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } else {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of %1$d tickets in the Event Queue, but %2$ds 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 EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_registrations($registrations = array(), $valid_data = array())
-    {
-        // 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 = array(
-            'line_item_id' => null,
-        );
-        $copy_primary       = false;
-        // reg form sections that do not contain inputs
-        $non_input_form_sections = array(
-            '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;
-            }
-            /** @var string $reg_url_link */
-            $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] = array();
-                    // 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
-                            ? true
-                            : false;
-                        // 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)) {
-                                foreach ($form_inputs as $form_input => $input_value) {
-                                    // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
-                                    // 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__(
-                                                    'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
-                                                    'event_espresso'
-                                                ),
-                                                $form_input,
-                                                $input_value
-                                            ),
-                                            __FILE__,
-                                            __FUNCTION__,
-                                            __LINE__
-                                        );
-                                        return false;
-                                    }
-                                }
-                            }
-                        }  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
-                    }
-                    //EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
-                    // 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;
-                        }
-                    }
-                    // EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
-                    // add relation to registration, set attendee ID, and cache attendee
-                    $this->_associate_attendee_with_registration($registration, $attendee);
-                    // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'Registration %s 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);
-                    // 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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _save_registration_form_input(
-        EE_Registration $registration,
-        $form_input = '',
-        $input_value = ''
-    ) {
-        // \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
-        // \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
-        // \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
-        // 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;
-        }
-        /*
+		$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
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @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);
+	}
+
+
+	/**
+	 * @access public
+	 * @return    EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _copy_attendee_info_form()
+	{
+		// array of params to pass to parent constructor
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections'     => $this->_copy_attendee_info_inputs(),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file'     => SPCO_REG_STEPS_PATH
+													  . $this->_slug
+													  . DS
+													  . 'copy_attendee_info.template.php',
+						'begin_template_file'      => null,
+						'input_template_file'      => null,
+						'subsection_template_file' => null,
+						'end_template_file'        => null,
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _auto_copy_attendee_info
+	 *
+	 * @access public
+	 * @return EE_Form_Section_HTML
+	 */
+	private function _auto_copy_attendee_info()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+					array()
+				),
+				true,
+				true
+			)
+		);
+	}
+
+
+	/**
+	 * _copy_attendee_info_inputs
+	 *
+	 * @access public
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+		$copy_attendee_info_inputs = array();
+		$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(
+						array(
+							$registration->ID() => sprintf(
+								esc_html__('Attendee #%s', 'event_espresso'),
+								$registration->count()
+							),
+						),
+						array(
+							'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;
+	}
+
+
+	/**
+	 * _additional_primary_registrant_inputs
+	 *
+	 * @access public
+	 * @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(
+			array(
+				'html_id' => 'primary_registrant',
+				'default' => $registration->reg_url_link(),
+			)
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	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(
+				array(array('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(array(
+				'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                 mixed EE_Answer|NULL      $answer
+	 * @return EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	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() ? true : false;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input'),
+			10,
+			4
+		);
+		$input_constructor_args                  = array(
+			'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',
+			array($this, 'use_cached_countries_for_form_input')
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function use_cached_countries_for_form_input(
+		$countries_list,
+		\EE_Question $question = null,
+		\EE_Registration $registration = null,
+		\EE_Answer $answer = null
+	) {
+		$country_options = array('' => '');
+		// 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(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		$country_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $country_options;
+	}
+
+
+	/**
+	 * 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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function use_cached_states_for_form_input(
+		$states_list,
+		\EE_Question $question = null,
+		\EE_Registration $registration = null,
+		\EE_Answer $answer = null
+	) {
+		$state_options = array('' => array('' => ''));
+		$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();
+				}
+			}
+		}
+		$state_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $state_options;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\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();
+		// EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
+		// 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)) {
+			EE_Error::add_error(
+				esc_html__('Your form data could not be applied to any valid registrations.', 'event_espresso'),
+				__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;
+		} elseif (! $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__(
+						'There was %1$d ticket in the Event Queue, but %2$ds 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__(
+						'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} else {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of %1$d tickets in the Event Queue, but %2$ds 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 EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_registrations($registrations = array(), $valid_data = array())
+	{
+		// 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 = array(
+			'line_item_id' => null,
+		);
+		$copy_primary       = false;
+		// reg form sections that do not contain inputs
+		$non_input_form_sections = array(
+			'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;
+			}
+			/** @var string $reg_url_link */
+			$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] = array();
+					// 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
+							? true
+							: false;
+						// 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)) {
+								foreach ($form_inputs as $form_input => $input_value) {
+									// \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
+									// 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__(
+													'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
+													'event_espresso'
+												),
+												$form_input,
+												$input_value
+											),
+											__FILE__,
+											__FUNCTION__,
+											__LINE__
+										);
+										return false;
+									}
+								}
+							}
+						}  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
+					}
+					//EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
+					// 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;
+						}
+					}
+					// EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
+					// add relation to registration, set attendee ID, and cache attendee
+					$this->_associate_attendee_with_registration($registration, $attendee);
+					// \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
+					if (! $registration->attendee() instanceof EE_Attendee) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'Registration %s 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);
+					// 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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _save_registration_form_input(
+		EE_Registration $registration,
+		$form_input = '',
+		$input_value = ''
+	) {
+		// \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
+		// \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
+		// \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
+		// 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()
-            : $form_input;
-        $answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
-                           && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
-            ? true
-            : false;
-        //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;
-                //EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
-                $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
-        }
-        // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
-        // 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;
-        } elseif ($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 ? true : false;
-        } else {
-            foreach ($this->_registration_answers as $answer) {
-                if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
-                    $answer->set_value($input_value);
-                    $result = $answer->save();
-                    return $result !== false ? true : 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;
-                    break;
-                case 'lname':
-                    EE_Error::add_error(
-                        esc_html__('Last Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'email':
-                    EE_Error::add_error(
-                        esc_html__('Please enter a valid email address.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     *    _associate_attendee_with_registration
-     *
-     * @param EE_Registration $registration
-     * @param EE_Attendee     $attendee
-     * @return void
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    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
-     */
-    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
-     */
-    private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
-    {
-        // bare minimum critical details include first name, last name, email address
-        $critical_attendee_details = array('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           = array(
-                '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 \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function update_reg_step()
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect     = true;
-            $this->checkout->redirect_url = add_query_arg(
-                array(
-                    '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()
+			: $form_input;
+		$answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
+						   && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
+			? true
+			: false;
+		//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;
+				//EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
+				$attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
+				$form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
+		}
+		// EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
+		// 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;
+		} elseif ($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 ? true : false;
+		} else {
+			foreach ($this->_registration_answers as $answer) {
+				if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
+					$answer->set_value($input_value);
+					$result = $answer->save();
+					return $result !== false ? true : 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;
+					break;
+				case 'lname':
+					EE_Error::add_error(
+						esc_html__('Last Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'email':
+					EE_Error::add_error(
+						esc_html__('Please enter a valid email address.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 *    _associate_attendee_with_registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Attendee     $attendee
+	 * @return void
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	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
+	 */
+	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
+	 */
+	private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
+	{
+		// bare minimum critical details include first name, last name, email address
+		$critical_attendee_details = array('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           = array(
+				'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 \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function update_reg_step()
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect     = true;
+			$this->checkout->redirect_url = add_query_arg(
+				array(
+					'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;
+	}
 }

modules/ticket_selector/DisplayTicketSelector.php

Indentation +705 added lines, -705 removed lines

@@ -17,7 +17,7 @@ 
 use WP_Post;
 
 if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+	exit( 'No direct script access allowed' );
 }
 
 
@@ -34,713 +34,713 @@ 
 class DisplayTicketSelector
 {
 
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected $iframe = false;
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @var int $max_attendees
-     */
-    private $max_attendees = EE_INF;
-
-    /**
-     *@var string $date_format
-     */
-    private $date_format;
-
-    /**
-     *@var string $time_format
-     */
-    private $time_format;
-
-    /**
-     *@var boolean $display_full_ui
-     */
-    private $display_full_ui;
-
-
-
-    /**
-     * DisplayTicketSelector constructor.
-     */
-    public function __construct()
-    {
-        $this->date_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format')
-        );
-        $this->time_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format')
-        );
-    }
-
-
-
-    /**
-     * @param boolean $iframe
-     */
-    public function setIframe( $iframe = true )
-    {
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
-    }
-
-
-    /**
-     * finds and sets the \EE_Event object for use throughout class
-     *
-     * @param mixed $event
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function setEvent( $event = null )
-    {
-        if ( $event === null ) {
-            global $post;
-            $event = $post;
-        }
-        if ( $event instanceof EE_Event ) {
-            $this->event = $event;
-        } elseif ( $event instanceof WP_Post ) {
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
-                $this->event = $event->EE_Event;
-            } elseif ( $event->post_type === 'espresso_events' ) {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
-                $this->event = $event->EE_Event;
-            }
-        } else {
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
-            $dev_msg = $user_msg . __(
-                    'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                    'event_espresso'
-                );
-            EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function getMaxAttendees()
-    {
-        return $this->max_attendees;
-    }
-
-
-
-    /**
-     * @param int $max_attendees
-     */
-    public function setMaxAttendees($max_attendees)
-    {
-        $this->max_attendees = absint(
-            apply_filters(
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-                $max_attendees
-            )
-        );
-    }
-
-
-
-    /**
-     * Returns whether or not the full ticket selector should be shown or not.
-     * Currently, it displays on the frontend (including ajax requests) but not the backend
-     * @return bool
-     */
-    private function display_full_ui()
-    {
-        if ($this->display_full_ui === null) {
-            $this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
-        }
-        return $this->display_full_ui;
-    }
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param WP_Post|int $event
-     * @param bool         $view_details
-     * @return string
-     * @throws EE_Error
-     */
-    public function display( $event = null, $view_details = false )
-    {
-        // reset filter for displaying submit button
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
-        // poke and prod incoming event till it tells us what it is
-        if ( ! $this->setEvent( $event ) ) {
-            return false;
-        }
-        // begin gathering template arguments by getting event status
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
-        if (
-            $this->activeEventAndShowTicketSelector(
-                $event,
-                $template_args['event_status'],
-                $view_details
-            )
-        ) {
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        $this->setMaxAttendees($this->event->additional_limit());
-        if ($this->getMaxAttendees() < 1) {
-            return $this->ticketSalesClosedMessage();
-        }
-        // is the event expired ?
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        if ( $template_args[ 'event_is_expired' ] ) {
-            return $this->expiredEventMessage();
-        }
-        // get all tickets for this event ordered by the datetime
-        $tickets = $this->getTickets();
-        if (count($tickets) < 1) {
-            return $this->noTicketAvailableMessage();
-        }
-        if (EED_Events_Archive::is_iframe()){
-            $this->setIframe();
-        }
-        // redirecting to another site for registration ??
-        $external_url = (string) $this->event->external_url();
-        // if redirecting to another site for registration, then we don't load the TS
-        $ticket_selector = $external_url
-            ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets,$template_args);
-        // now set up the form (but not for the admin)
-        $ticket_selector = $this->display_full_ui()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
-        return $ticket_selector;
-    }
-
-
-
-    /**
-     * displayTicketSelector
-     * examines the event properties and determines whether a Ticket Selector should be displayed
-     *
-     * @param WP_Post|int $event
-     * @param string       $_event_active_status
-     * @param bool         $view_details
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
-    {
-        $event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
-        return $this->display_full_ui()
-               && (
-                   ! $this->event->display_ticket_selector()
-                   || $view_details
-                   || post_password_required($event_post)
-                   || (
-                       $_event_active_status !== EE_Datetime::active
-                       && $_event_active_status !== EE_Datetime::upcoming
-                       && $_event_active_status !== EE_Datetime::sold_out
-                       && ! (
-                           $_event_active_status === EE_Datetime::inactive
-                           && is_user_logged_in()
-                       )
-                   )
-               );
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event is expired
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function expiredEventMessage()
-    {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
-            'We\'re sorry, but all tickets sales have ended because the event is expired.',
-            'event_espresso'
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
-    }
-
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event has no more tickets available
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function noTicketAvailableMessage()
-    {
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $no_ticket_available_msg .= sprintf(
-                esc_html__(
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
-            );
-        }
-        return '
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected $iframe = false;
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @var int $max_attendees
+	 */
+	private $max_attendees = EE_INF;
+
+	/**
+	 *@var string $date_format
+	 */
+	private $date_format;
+
+	/**
+	 *@var string $time_format
+	 */
+	private $time_format;
+
+	/**
+	 *@var boolean $display_full_ui
+	 */
+	private $display_full_ui;
+
+
+
+	/**
+	 * DisplayTicketSelector constructor.
+	 */
+	public function __construct()
+	{
+		$this->date_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format')
+		);
+		$this->time_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format')
+		);
+	}
+
+
+
+	/**
+	 * @param boolean $iframe
+	 */
+	public function setIframe( $iframe = true )
+	{
+		$this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
+	}
+
+
+	/**
+	 * finds and sets the \EE_Event object for use throughout class
+	 *
+	 * @param mixed $event
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function setEvent( $event = null )
+	{
+		if ( $event === null ) {
+			global $post;
+			$event = $post;
+		}
+		if ( $event instanceof EE_Event ) {
+			$this->event = $event;
+		} elseif ( $event instanceof WP_Post ) {
+			if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
+				$this->event = $event->EE_Event;
+			} elseif ( $event->post_type === 'espresso_events' ) {
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
+				$this->event = $event->EE_Event;
+			}
+		} else {
+			$user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
+			$dev_msg = $user_msg . __(
+					'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+					'event_espresso'
+				);
+			EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function getMaxAttendees()
+	{
+		return $this->max_attendees;
+	}
+
+
+
+	/**
+	 * @param int $max_attendees
+	 */
+	public function setMaxAttendees($max_attendees)
+	{
+		$this->max_attendees = absint(
+			apply_filters(
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+				$max_attendees
+			)
+		);
+	}
+
+
+
+	/**
+	 * Returns whether or not the full ticket selector should be shown or not.
+	 * Currently, it displays on the frontend (including ajax requests) but not the backend
+	 * @return bool
+	 */
+	private function display_full_ui()
+	{
+		if ($this->display_full_ui === null) {
+			$this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
+		}
+		return $this->display_full_ui;
+	}
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param WP_Post|int $event
+	 * @param bool         $view_details
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display( $event = null, $view_details = false )
+	{
+		// reset filter for displaying submit button
+		remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
+		// poke and prod incoming event till it tells us what it is
+		if ( ! $this->setEvent( $event ) ) {
+			return false;
+		}
+		// begin gathering template arguments by getting event status
+		$template_args = array( 'event_status' => $this->event->get_active_status() );
+		if (
+			$this->activeEventAndShowTicketSelector(
+				$event,
+				$template_args['event_status'],
+				$view_details
+			)
+		) {
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		$this->setMaxAttendees($this->event->additional_limit());
+		if ($this->getMaxAttendees() < 1) {
+			return $this->ticketSalesClosedMessage();
+		}
+		// is the event expired ?
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		if ( $template_args[ 'event_is_expired' ] ) {
+			return $this->expiredEventMessage();
+		}
+		// get all tickets for this event ordered by the datetime
+		$tickets = $this->getTickets();
+		if (count($tickets) < 1) {
+			return $this->noTicketAvailableMessage();
+		}
+		if (EED_Events_Archive::is_iframe()){
+			$this->setIframe();
+		}
+		// redirecting to another site for registration ??
+		$external_url = (string) $this->event->external_url();
+		// if redirecting to another site for registration, then we don't load the TS
+		$ticket_selector = $external_url
+			? $this->externalEventRegistration()
+			: $this->loadTicketSelector($tickets,$template_args);
+		// now set up the form (but not for the admin)
+		$ticket_selector = $this->display_full_ui()
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
+		return $ticket_selector;
+	}
+
+
+
+	/**
+	 * displayTicketSelector
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
+	 *
+	 * @param WP_Post|int $event
+	 * @param string       $_event_active_status
+	 * @param bool         $view_details
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
+	{
+		$event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
+		return $this->display_full_ui()
+			   && (
+				   ! $this->event->display_ticket_selector()
+				   || $view_details
+				   || post_password_required($event_post)
+				   || (
+					   $_event_active_status !== EE_Datetime::active
+					   && $_event_active_status !== EE_Datetime::upcoming
+					   && $_event_active_status !== EE_Datetime::sold_out
+					   && ! (
+						   $_event_active_status === EE_Datetime::inactive
+						   && is_user_logged_in()
+					   )
+				   )
+			   );
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event is expired
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function expiredEventMessage()
+	{
+		return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+			'We\'re sorry, but all tickets sales have ended because the event is expired.',
+			'event_espresso'
+		) . '</span></div><!-- .ee-event-expired-notice -->';
+	}
+
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event has no more tickets available
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function noTicketAvailableMessage()
+	{
+		$no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$no_ticket_available_msg .= sprintf(
+				esc_html__(
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
+			);
+		}
+		return '
             <div class="ee-event-expired-notice">
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
             </div><!-- .ee-event-expired-notice -->';
-    }
-
-
-
-    /**
-     * ticketSalesClosed
-     * notice displayed if event ticket sales are turned off
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketSalesClosedMessage()
-    {
-        $sales_closed_msg = esc_html__(
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-            'event_espresso'
-        );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $sales_closed_msg .= sprintf(
-                esc_html__(
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
-                '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
-            );
-        }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-    }
-
-
-
-    /**
-     * getTickets
-     *
-     * @return \EE_Base_Class[]|\EE_Ticket[]
-     * @throws EE_Error
-     */
-    protected function getTickets()
-    {
-        $ticket_query_args = array(
-            array('Datetime.EVT_ID' => $this->event->ID()),
-            'order_by' => array(
-                'TKT_order'              => 'ASC',
-                'TKT_required'           => 'DESC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ),
-        );
-        if (
-            ! (
-                EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
-                && EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
-            )
-        ) {
-            //use the correct applicable time query depending on what version of core is being run.
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
-                ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
-        }
-        return EEM_Ticket::instance()->get_all($ticket_query_args);
-    }
-
-
-
-    /**
-     * loadTicketSelector
-     * begins to assemble template arguments
-     * and decides whether to load a "simple" ticket selector, or the standard
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function loadTicketSelector(array $tickets, array $template_args)
-    {
-        $template_args['event'] = $this->event;
-        $template_args['EVT_ID'] = $this->event->ID();
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        $template_args['max_atndz'] = $this->getMaxAttendees();
-        $template_args['date_format'] = $this->date_format;
-        $template_args['time_format'] = $this->time_format;
-        /**
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
-         *
-         * @since 4.9.13
-         * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
-         * @param int $EVT_ID The Event ID
-         */
-        $template_args['anchor_id'] = apply_filters(
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
-            $this->event->ID()
-        );
-        $template_args['tickets'] = $tickets;
-        $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
-        return $ticket_selector instanceof TicketSelectorSimple
-            ? $ticket_selector
-            : new TicketSelectorStandard(
-                $this->event,
-                $tickets,
-                $this->getMaxAttendees(),
-                $template_args,
-                $this->date_format,
-                $this->time_format
-            );
-    }
-
-
-
-    /**
-     * simpleTicketSelector
-     * there's one ticket, and max attendees is set to one,
-     * so if the event is free, then this is a "simple" ticket selector
-     * a.k.a. "Dude Where's my Ticket Selector?"
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array  $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function simpleTicketSelector($tickets, array $template_args)
-    {
-        // if there is only ONE ticket with a max qty of ONE
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
-            return '';
-        }
-        /** @var \EE_Ticket $ticket */
-        $ticket = reset($tickets);
-        // if the ticket is free... then not much need for the ticket selector
-        if (
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__hide_ticket_selector',
-                $ticket->is_free(),
-                $this->event->ID()
-            )
-        ) {
-            return new TicketSelectorSimple(
-                $this->event,
-                $ticket,
-                $this->getMaxAttendees(),
-                $template_args
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     * externalEventRegistration
-     *
-     * @return string
-     */
-    public function externalEventRegistration()
-    {
-        // if not we still need to trigger the display of the submit button
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        //display notice to admin that registration is external
-        return $this->display_full_ui()
-            ? esc_html__(
-                'Registration is at an external URL for this event.',
-                'event_espresso'
-            )
-            : '';
-    }
-
-
-
-    /**
-     * formOpen
-     *
-     * @param        int    $ID
-     * @param        string $external_url
-     * @return        string
-     */
-    public function formOpen( $ID = 0, $external_url = '' )
-    {
-        // if redirecting, we don't need any anything else
-        if ( $external_url ) {
-            $html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
-            // open link in new window ?
-            $html .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                EED_Events_Archive::is_iframe()
-            )
-                ? ' target="_blank"'
-                : '';
-            $html .= '>';
-            $query_args = EEH_URL::get_query_string( $external_url );
-            foreach ( (array)$query_args as $query_arg => $value ) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
-            return '';
-        }
-        $checkout_url = EEH_Event_View::event_link_url( $ID );
-        if ( ! $checkout_url ) {
-            EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-        $extra_params = $this->iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
-        return $html;
-    }
-
-
-
-    /**
-     * displaySubmitButton
-     *
-     * @param  string $external_url
-     * @return string
-     * @throws EE_Error
-     */
-    public function displaySubmitButton($external_url = '')
-    {
-        $html = '';
-        if ($this->display_full_ui()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= $this->displayRegisterNowButton();
-                $html .= empty($external_url)
-                    ? $this->ticketSelectorEndDiv()
-                    : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
-            } elseif ($this->getMaxAttendees() === 1) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ($this->event->is_sold_out()) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            __(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            $this->event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        $this->event
-                    );
-                    if (
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                            false,
-                            $this->event
-                        )
-                    ) {
-                        $html .= $this->displayRegisterNowButton();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .=  $this->ticketSelectorEndDiv();
-                } elseif (
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                    && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= $this->displayViewDetailsButton(true);
-                } else {
-                    $html .= $this->ticketSelectorEndDiv();
-                }
-            } elseif (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= $this->ticketSelectorEndDiv();
-                $html .= $this->displayViewDetailsButton();
-            } else {
-                if (
-                    apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        $this->event
-                    )
-                ) {
-                    $html .= $this->displayRegisterNowButton();
-                }
-                // no submit or view details button, and no additional content
-                $html .= $this->ticketSelectorEndDiv();
-            }
-            if ( ! $this->iframe && ! is_archive()) {
-                $html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
-            }
-        }
-	    return apply_filters(
-		    'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
-		    $html,
-		    $this->event
-	    );
-    }
-
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayRegisterNowButton()
-    {
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            __('Register Now', 'event_espresso'),
-            $this->event
-        );
-        $external_url = $this->event->external_url();
-        $html = EEH_HTML::div(
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
-        );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
-        $html .= ' class="ticket-selector-submit-btn ';
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
-        $html .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            $this->event
-        );
-        return $html;
-    }
-
-
-    /**
-     * displayViewDetailsButton
-     *
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayViewDetailsButton( $DWMTS = false )
-    {
-        if ( ! $this->event->get_permalink() ) {
-            EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $view_details_btn = '<form method="POST" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            $this->event->get_permalink(),
-            $this->event
-        );
-        $view_details_btn .= '"';
-        // open link in new window ?
-        $view_details_btn .= apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
-            EED_Events_Archive::is_iframe()
-        )
-            ? ' target="_blank"'
-            : '';
-        $view_details_btn .='>';
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            esc_html__('View Details', 'event_espresso'),
-            $this->event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . $this->event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
-        if ($DWMTS) {
-            $view_details_btn .= $this->formClose();
-            $view_details_btn .= $this->ticketSelectorEndDiv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= $this->clearTicketSelector();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= $this->formClose();
-        }
-        return $view_details_btn;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ticketSelectorEndDiv()
-    {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function clearTicketSelector()
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div><!-- clearTicketSelector -->';
-    }
-
-
-
-    /**
-     * @access        public
-     * @return        string
-     */
-    public function formClose()
-    {
-        return '</form>';
-    }
+	}
+
+
+
+	/**
+	 * ticketSalesClosed
+	 * notice displayed if event ticket sales are turned off
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketSalesClosedMessage()
+	{
+		$sales_closed_msg = esc_html__(
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+			'event_espresso'
+		);
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$sales_closed_msg .= sprintf(
+				esc_html__(
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'.get_edit_post_link($this->event->ID()).'">',
+				'</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
+			);
+		}
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+	}
+
+
+
+	/**
+	 * getTickets
+	 *
+	 * @return \EE_Base_Class[]|\EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	protected function getTickets()
+	{
+		$ticket_query_args = array(
+			array('Datetime.EVT_ID' => $this->event->ID()),
+			'order_by' => array(
+				'TKT_order'              => 'ASC',
+				'TKT_required'           => 'DESC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			),
+		);
+		if (
+			! (
+				EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
+				&& EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
+			)
+		) {
+			//use the correct applicable time query depending on what version of core is being run.
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query')
+				? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
+		}
+		return EEM_Ticket::instance()->get_all($ticket_query_args);
+	}
+
+
+
+	/**
+	 * loadTicketSelector
+	 * begins to assemble template arguments
+	 * and decides whether to load a "simple" ticket selector, or the standard
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function loadTicketSelector(array $tickets, array $template_args)
+	{
+		$template_args['event'] = $this->event;
+		$template_args['EVT_ID'] = $this->event->ID();
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		$template_args['max_atndz'] = $this->getMaxAttendees();
+		$template_args['date_format'] = $this->date_format;
+		$template_args['time_format'] = $this->time_format;
+		/**
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
+		 *
+		 * @since 4.9.13
+		 * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
+		 * @param int $EVT_ID The Event ID
+		 */
+		$template_args['anchor_id'] = apply_filters(
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
+			'#tkt-slctr-tbl-' . $this->event->ID(),
+			$this->event->ID()
+		);
+		$template_args['tickets'] = $tickets;
+		$template_args['ticket_count'] = count($tickets);
+		$ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
+		return $ticket_selector instanceof TicketSelectorSimple
+			? $ticket_selector
+			: new TicketSelectorStandard(
+				$this->event,
+				$tickets,
+				$this->getMaxAttendees(),
+				$template_args,
+				$this->date_format,
+				$this->time_format
+			);
+	}
+
+
+
+	/**
+	 * simpleTicketSelector
+	 * there's one ticket, and max attendees is set to one,
+	 * so if the event is free, then this is a "simple" ticket selector
+	 * a.k.a. "Dude Where's my Ticket Selector?"
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array  $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function simpleTicketSelector($tickets, array $template_args)
+	{
+		// if there is only ONE ticket with a max qty of ONE
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
+			return '';
+		}
+		/** @var \EE_Ticket $ticket */
+		$ticket = reset($tickets);
+		// if the ticket is free... then not much need for the ticket selector
+		if (
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__hide_ticket_selector',
+				$ticket->is_free(),
+				$this->event->ID()
+			)
+		) {
+			return new TicketSelectorSimple(
+				$this->event,
+				$ticket,
+				$this->getMaxAttendees(),
+				$template_args
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * externalEventRegistration
+	 *
+	 * @return string
+	 */
+	public function externalEventRegistration()
+	{
+		// if not we still need to trigger the display of the submit button
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		//display notice to admin that registration is external
+		return $this->display_full_ui()
+			? esc_html__(
+				'Registration is at an external URL for this event.',
+				'event_espresso'
+			)
+			: '';
+	}
+
+
+
+	/**
+	 * formOpen
+	 *
+	 * @param        int    $ID
+	 * @param        string $external_url
+	 * @return        string
+	 */
+	public function formOpen( $ID = 0, $external_url = '' )
+	{
+		// if redirecting, we don't need any anything else
+		if ( $external_url ) {
+			$html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
+			// open link in new window ?
+			$html .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				EED_Events_Archive::is_iframe()
+			)
+				? ' target="_blank"'
+				: '';
+			$html .= '>';
+			$query_args = EEH_URL::get_query_string( $external_url );
+			foreach ( (array)$query_args as $query_arg => $value ) {
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
+			return '';
+		}
+		$checkout_url = EEH_Event_View::event_link_url( $ID );
+		if ( ! $checkout_url ) {
+			EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+		$extra_params = $this->iframe ? ' target="_blank"' : '';
+		$html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		$html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
+		return $html;
+	}
+
+
+
+	/**
+	 * displaySubmitButton
+	 *
+	 * @param  string $external_url
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displaySubmitButton($external_url = '')
+	{
+		$html = '';
+		if ($this->display_full_ui()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= $this->displayRegisterNowButton();
+				$html .= empty($external_url)
+					? $this->ticketSelectorEndDiv()
+					: $this->clearTicketSelector();
+				$html .= '<br/>' . $this->formClose();
+			} elseif ($this->getMaxAttendees() === 1) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ($this->event->is_sold_out()) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							$this->event->name(),
+							'</p>',
+							'<br />'
+						),
+						$this->event
+					);
+					if (
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+							false,
+							$this->event
+						)
+					) {
+						$html .= $this->displayRegisterNowButton();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .=  $this->ticketSelectorEndDiv();
+				} elseif (
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+					&& ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= $this->displayViewDetailsButton(true);
+				} else {
+					$html .= $this->ticketSelectorEndDiv();
+				}
+			} elseif (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= $this->ticketSelectorEndDiv();
+				$html .= $this->displayViewDetailsButton();
+			} else {
+				if (
+					apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						$this->event
+					)
+				) {
+					$html .= $this->displayRegisterNowButton();
+				}
+				// no submit or view details button, and no additional content
+				$html .= $this->ticketSelectorEndDiv();
+			}
+			if ( ! $this->iframe && ! is_archive()) {
+				$html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
+			$html,
+			$this->event
+		);
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayRegisterNowButton()
+	{
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			__('Register Now', 'event_espresso'),
+			$this->event
+		);
+		$external_url = $this->event->external_url();
+		$html = EEH_HTML::div(
+			'', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
+		);
+		$html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+		$html .= ' class="ticket-selector-submit-btn ';
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html .= ' type="submit" value="' . $btn_text . '" />';
+		$html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+		$html .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			$this->event
+		);
+		return $html;
+	}
+
+
+	/**
+	 * displayViewDetailsButton
+	 *
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayViewDetailsButton( $DWMTS = false )
+	{
+		if ( ! $this->event->get_permalink() ) {
+			EE_Error::add_error(
+				esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$view_details_btn = '<form method="POST" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			$this->event->get_permalink(),
+			$this->event
+		);
+		$view_details_btn .= '"';
+		// open link in new window ?
+		$view_details_btn .= apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
+			EED_Events_Archive::is_iframe()
+		)
+			? ' target="_blank"'
+			: '';
+		$view_details_btn .='>';
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			esc_html__('View Details', 'event_espresso'),
+			$this->event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . $this->event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
+		if ($DWMTS) {
+			$view_details_btn .= $this->formClose();
+			$view_details_btn .= $this->ticketSelectorEndDiv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= $this->clearTicketSelector();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= $this->formClose();
+		}
+		return $view_details_btn;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ticketSelectorEndDiv()
+	{
+		return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function clearTicketSelector()
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div><!-- clearTicketSelector -->';
+	}
+
+
+
+	/**
+	 * @access        public
+	 * @return        string
+	 */
+	public function formClose()
+	{
+		return '</form>';
+	}
 
 
 

Spacing +53 added lines, -53 removed lines

@@ -16,8 +16,8 @@ 
 use EEM_Ticket;
 use WP_Post;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-    exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+    exit('No direct script access allowed');
 }
 
 
@@ -93,9 +93,9 @@ 
     /**
      * @param boolean $iframe
      */
-    public function setIframe( $iframe = true )
+    public function setIframe($iframe = true)
     {
-        $this->iframe = filter_var( $iframe, FILTER_VALIDATE_BOOLEAN );
+        $this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
     }
 
 
@@ -106,28 +106,28 @@ 
      * @return bool
      * @throws EE_Error
      */
-    protected function setEvent( $event = null )
+    protected function setEvent($event = null)
     {
-        if ( $event === null ) {
+        if ($event === null) {
             global $post;
             $event = $post;
         }
-        if ( $event instanceof EE_Event ) {
+        if ($event instanceof EE_Event) {
             $this->event = $event;
-        } elseif ( $event instanceof WP_Post ) {
-            if ( isset( $event->EE_Event ) && $event->EE_Event instanceof EE_Event ) {
+        } elseif ($event instanceof WP_Post) {
+            if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
                 $this->event = $event->EE_Event;
-            } elseif ( $event->post_type === 'espresso_events' ) {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object( $event );
+            } elseif ($event->post_type === 'espresso_events') {
+                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
                 $this->event = $event->EE_Event;
             }
         } else {
-            $user_msg = __( 'No Event object or an invalid Event object was supplied.', 'event_espresso' );
-            $dev_msg = $user_msg . __(
+            $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
+            $dev_msg = $user_msg.__(
                     'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
                     'event_espresso'
                 );
-            EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         return true;
@@ -182,16 +182,16 @@ 
      * @return string
      * @throws EE_Error
      */
-    public function display( $event = null, $view_details = false )
+    public function display($event = null, $view_details = false)
     {
         // reset filter for displaying submit button
-        remove_filter( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true' );
+        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
         // poke and prod incoming event till it tells us what it is
-        if ( ! $this->setEvent( $event ) ) {
+        if ( ! $this->setEvent($event)) {
             return false;
         }
         // begin gathering template arguments by getting event status
-        $template_args = array( 'event_status' => $this->event->get_active_status() );
+        $template_args = array('event_status' => $this->event->get_active_status());
         if (
             $this->activeEventAndShowTicketSelector(
                 $event,
@@ -208,7 +208,7 @@ 
         }
         // is the event expired ?
         $template_args['event_is_expired'] = $this->event->is_expired();
-        if ( $template_args[ 'event_is_expired' ] ) {
+        if ($template_args['event_is_expired']) {
             return $this->expiredEventMessage();
         }
         // get all tickets for this event ordered by the datetime
@@ -216,7 +216,7 @@ 
         if (count($tickets) < 1) {
             return $this->noTicketAvailableMessage();
         }
-        if (EED_Events_Archive::is_iframe()){
+        if (EED_Events_Archive::is_iframe()) {
             $this->setIframe();
         }
         // redirecting to another site for registration ??
@@ -224,10 +224,10 @@ 
         // if redirecting to another site for registration, then we don't load the TS
         $ticket_selector = $external_url
             ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets,$template_args);
+            : $this->loadTicketSelector($tickets, $template_args);
         // now set up the form (but not for the admin)
         $ticket_selector = $this->display_full_ui()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+            ? $this->formOpen($this->event->ID(), $external_url).$ticket_selector
             : $ticket_selector;
         // submit button and form close tag
         $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
@@ -277,10 +277,10 @@ 
      */
     protected function expiredEventMessage()
     {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+        return '<div class="ee-event-expired-notice"><span class="important-notice">'.esc_html__(
             'We\'re sorry, but all tickets sales have ended because the event is expired.',
             'event_espresso'
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
+        ).'</span></div><!-- .ee-event-expired-notice -->';
     }
 
 
@@ -294,7 +294,7 @@ 
      */
     protected function noTicketAvailableMessage()
     {
-        $no_ticket_available_msg = esc_html__( 'We\'re sorry, but all ticket sales have ended.', 'event_espresso' );
+        $no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
         if (current_user_can('edit_post', $this->event->ID())) {
             $no_ticket_available_msg .= sprintf(
                 esc_html__(
@@ -309,7 +309,7 @@ 
         }
         return '
             <div class="ee-event-expired-notice">
-                <span class="important-notice">' . $no_ticket_available_msg . '</span>
+                <span class="important-notice">' . $no_ticket_available_msg.'</span>
             </div><!-- .ee-event-expired-notice -->';
     }
 
@@ -340,7 +340,7 @@ 
                 '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
             );
         }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+        return '<p><span class="important-notice">'.$sales_closed_msg.'</span></p>';
     }
 
 
@@ -407,12 +407,12 @@ 
          */
         $template_args['anchor_id'] = apply_filters(
             'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
+            '#tkt-slctr-tbl-'.$this->event->ID(),
             $this->event->ID()
         );
         $template_args['tickets'] = $tickets;
         $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector( $tickets, $template_args);
+        $ticket_selector = $this->simpleTicketSelector($tickets, $template_args);
         return $ticket_selector instanceof TicketSelectorSimple
             ? $ticket_selector
             : new TicketSelectorStandard(
@@ -493,11 +493,11 @@ 
      * @param        string $external_url
      * @return        string
      */
-    public function formOpen( $ID = 0, $external_url = '' )
+    public function formOpen($ID = 0, $external_url = '')
     {
         // if redirecting, we don't need any anything else
-        if ( $external_url ) {
-            $html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
+        if ($external_url) {
+            $html = '<form method="GET" action="'.EEH_URL::refactor_url($external_url).'"';
             // open link in new window ?
             $html .= apply_filters(
                 'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
@@ -506,21 +506,21 @@ 
                 ? ' target="_blank"'
                 : '';
             $html .= '>';
-            $query_args = EEH_URL::get_query_string( $external_url );
-            foreach ( (array)$query_args as $query_arg => $value ) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+            $query_args = EEH_URL::get_query_string($external_url);
+            foreach ((array) $query_args as $query_arg => $value) {
+                $html .= '<input type="hidden" name="'.$query_arg.'" value="'.$value.'">';
             }
             return $html;
         }
         // if there is no submit button, then don't start building a form
         // because the "View Details" button will build its own form
-        if ( ! apply_filters( 'FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false ) ) {
+        if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
             return '';
         }
-        $checkout_url = EEH_Event_View::event_link_url( $ID );
-        if ( ! $checkout_url ) {
+        $checkout_url = EEH_Event_View::event_link_url($ID);
+        if ( ! $checkout_url) {
             EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
                 __FILE__,
                 __FUNCTION__,
                 __LINE__
@@ -529,9 +529,9 @@ 
         // set no cache headers and constants
         EE_System::do_not_cache();
         $extra_params = $this->iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
+        $html = '<form method="POST" action="'.$checkout_url.'"'.$extra_params.'>';
         $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters( 'FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event );
+        $html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
         return $html;
     }
 
@@ -554,7 +554,7 @@ 
                 $html .= empty($external_url)
                     ? $this->ticketSelectorEndDiv()
                     : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
+                $html .= '<br/>'.$this->formClose();
             } elseif ($this->getMaxAttendees() === 1) {
                 // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
                 if ($this->event->is_sold_out()) {
@@ -583,7 +583,7 @@ 
                         $html .= $this->displayRegisterNowButton();
                     }
                     // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .=  $this->ticketSelectorEndDiv();
+                    $html .= $this->ticketSelectorEndDiv();
                 } elseif (
                     apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
                     && ! is_single()
@@ -638,13 +638,13 @@ 
         );
         $external_url = $this->event->external_url();
         $html = EEH_HTML::div(
-            '', 'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap', 'ticket-selector-submit-btn-wrap'
+            '', 'ticket-selector-submit-'.$this->event->ID().'-btn-wrap', 'ticket-selector-submit-btn-wrap'
         );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+        $html .= '<input id="ticket-selector-submit-'.$this->event->ID().'-btn"';
         $html .= ' class="ticket-selector-submit-btn ';
         $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+        $html .= ' type="submit" value="'.$btn_text.'" />';
+        $html .= EEH_HTML::divx().'<!-- .ticket-selector-submit-btn-wrap -->';
         $html .= apply_filters(
             'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
             '',
@@ -664,11 +664,11 @@ 
      * @return string
      * @throws EE_Error
      */
-    public function displayViewDetailsButton( $DWMTS = false )
+    public function displayViewDetailsButton($DWMTS = false)
     {
-        if ( ! $this->event->get_permalink() ) {
+        if ( ! $this->event->get_permalink()) {
             EE_Error::add_error(
-                esc_html__( 'The URL for the Event Details page could not be retrieved.', 'event_espresso' ),
+                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
                 __FILE__, __FUNCTION__, __LINE__
             );
         }
@@ -686,7 +686,7 @@ 
         )
             ? ' target="_blank"'
             : '';
-        $view_details_btn .='>';
+        $view_details_btn .= '>';
         $btn_text = apply_filters(
             'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
             esc_html__('View Details', 'event_espresso'),
@@ -697,7 +697,7 @@ 
                              . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
                              . $btn_text
                              . '" />';
-        $view_details_btn .= apply_filters( 'FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event );
+        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
         if ($DWMTS) {
             $view_details_btn .= $this->formClose();
             $view_details_btn .= $this->ticketSelectorEndDiv();
@@ -717,7 +717,7 @@ 
      */
     public function ticketSelectorEndDiv()
     {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+        return $this->clearTicketSelector().'</div><!-- ticketSelectorEndDiv -->';
     }
 
 

modules/single_page_checkout/reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php

Doc Comments +12 added lines, -12 removed lines

@@ -145,7 +145,7 @@ 
 
 
     /**
-     * @return null
+     * @return EE_Line_Item_Display
      */
     public function line_item_display()
     {
@@ -154,7 +154,7 @@ 
 
 
     /**
-     * @param null $line_item_display
+     * @param EE_Line_Item_Display $line_item_display
      */
     public function set_line_item_display($line_item_display)
     {
@@ -882,7 +882,7 @@ 
      *    _apply_registration_payments_to_amount_owing
      *
      * @access protected
-     * @param array $registrations
+     * @param EE_Base_Class[] $registrations
      * @throws EE_Error
      */
     protected function _apply_registration_payments_to_amount_owing(array $registrations)
@@ -1188,7 +1188,7 @@ 
      * get_billing_form_html_for_payment_method
      *
      * @access public
-     * @return string
+     * @return boolean
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws ReflectionException
@@ -1255,7 +1255,7 @@ 
      *
      * @access private
      * @param EE_Payment_Method $payment_method
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
+     * @return EE_Billing_Info_Form
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -1364,7 +1364,7 @@ 
      * switch_payment_method
      *
      * @access public
-     * @return string
+     * @return boolean
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -1643,7 +1643,7 @@ 
     /**
      * process_reg_step
      *
-     * @return bool
+     * @return null|boolean
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws ReflectionException
@@ -1774,7 +1774,7 @@ 
      *    update_reg_step
      *    this is the final step after a user  revisits the site to retry a payment
      *
-     * @return bool
+     * @return null|boolean
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws ReflectionException
@@ -2221,7 +2221,7 @@ 
      *
      * @access    private
      * @type    EE_Payment_Method $payment_method
-     * @return mixed EE_Payment | boolean
+     * @return EE_Payment|null EE_Payment | boolean
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws ReflectionException
@@ -2546,7 +2546,7 @@ 
      *        or present the payment options again
      *
      * @access private
-     * @return EE_Payment|FALSE
+     * @return boolean
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws ReflectionException
@@ -2686,8 +2686,8 @@ 
      * _redirect_wayward_request
      *
      * @access private
-     * @param \EE_Registration|null $primary_registrant
-     * @return bool
+     * @param EE_Registration $primary_registrant
+     * @return false|null
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException

Spacing +59 added lines, -59 removed lines

@@ -132,7 +132,7 @@ 
     {
         $this->_slug     = 'payment_options';
         $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'payment_options_main.template.php';
         $this->checkout  = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -187,7 +187,7 @@ 
      */
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+        EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
             'Please select a method of payment in order to continue.',
             'event_espresso'
         );
@@ -195,7 +195,7 @@ 
             'A valid method of payment could not be determined. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+        EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
             'Forwarding to Secure Payment Provider.',
             'event_espresso'
         );
@@ -215,7 +215,7 @@ 
     {
         $transaction = $this->checkout->transaction;
         //if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
+        if ( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
             return;
         }
         foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
@@ -343,7 +343,7 @@ 
                     $registration->event(),
                     $this
                 );
-            } elseif (! $this->checkout->revisit
+            } elseif ( ! $this->checkout->revisit
                 && $registration->status_ID() !== EEM_Registration::status_id_not_approved
                 && $registration->ticket()->is_free()
             ) {
@@ -352,23 +352,23 @@ 
         }
         $subsections = array();
         // now decide which template to load
-        if (! empty($sold_out_events)) {
+        if ( ! empty($sold_out_events)) {
             $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
         }
-        if (! empty($insufficient_spaces_available)) {
+        if ( ! empty($insufficient_spaces_available)) {
             $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
                 $insufficient_spaces_available
             );
         }
-        if (! empty($registrations_requiring_pre_approval)) {
+        if ( ! empty($registrations_requiring_pre_approval)) {
             $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
                 $registrations_requiring_pre_approval
             );
         }
-        if (! empty($registrations_for_free_events)) {
+        if ( ! empty($registrations_for_free_events)) {
             $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
         }
-        if (! empty($registrations_requiring_payment)) {
+        if ( ! empty($registrations_requiring_payment)) {
             if ($this->checkout->amount_owing > 0) {
                 // autoload Line_Item_Display classes
                 EEH_Autoloader::register_line_item_filter_autoloaders();
@@ -389,7 +389,7 @@ 
                         array('registrations' => $registrations)
                     )
                 );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
+                $this->checkout->amount_owing = $filtered_line_item_tree->total();
                 $this->_apply_registration_payments_to_amount_owing($registrations);
             }
             $no_payment_required = false;
@@ -433,13 +433,13 @@ 
      */
     public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
     {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
             return $line_item_filter_collection;
         }
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
+        if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
             return $line_item_filter_collection;
         }
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
+        if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
             return $line_item_filter_collection;
         }
         $line_item_filter_collection->add(
@@ -530,15 +530,15 @@ 
             }
             $EVT_ID = $registration->event_ID();
             $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[$ticket->ID()])) {
+            if ( ! isset($tickets_remaining[$ticket->ID()])) {
                 $tickets_remaining[$ticket->ID()] = $ticket->remaining();
             }
             if ($tickets_remaining[$ticket->ID()] > 0) {
-                if (! isset($event_reg_count[$EVT_ID])) {
+                if ( ! isset($event_reg_count[$EVT_ID])) {
                     $event_reg_count[$EVT_ID] = 0;
                 }
                 $event_reg_count[$EVT_ID]++;
-                if (! isset($event_spaces_remaining[$EVT_ID])) {
+                if ( ! isset($event_spaces_remaining[$EVT_ID])) {
                     $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
                 }
             }
@@ -607,7 +607,7 @@ 
         foreach ($sold_out_events_array as $sold_out_event) {
             $sold_out_events .= EEH_HTML::li(
                 EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
+                    '  '.$sold_out_event->name(),
                     '',
                     'dashicons dashicons-marker ee-icon-size-16 pink-text'
                 )
@@ -663,7 +663,7 @@ 
         foreach ($insufficient_spaces_events_array as $event) {
             if ($event instanceof EE_Event) {
                 $insufficient_space_events .= EEH_HTML::li(
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
+                    EEH_HTML::span(' '.$event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
                 );
             }
         }
@@ -853,7 +853,7 @@ 
     {
         return new EE_Form_Section_Proper(
             array(
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+                'html_id'         => 'ee-'.$this->slug().'-extra-hidden-inputs',
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
                 'subsections'     => array(
                     'spco_no_payment_required' => new EE_Hidden_Input(
@@ -893,7 +893,7 @@ 
                 $payments += $registration->registration_payments();
             }
         }
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 if ($payment instanceof EE_Registration_Payment) {
                     $this->checkout->amount_owing -= $payment->amount();
@@ -979,7 +979,7 @@ 
             );
         }
         // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
+        $payment_method_header = count($this->checkout->available_payment_methods) > 1
             ? apply_filters(
                 'FHEE__registration_page_payment_options__method_of_payment_hdr',
                 esc_html__('Please Select Your Method of Payment', 'event_espresso')
@@ -1009,14 +1009,14 @@ 
                 $payment_method_button = EEH_HTML::img(
                     $payment_method->button_url(),
                     $payment_method->name(),
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+                    'spco-payment-method-'.$payment_method->slug().'-btn-img',
                     'spco-payment-method-btn-img'
                 );
                 // check if any payment methods are set as default
                 // if payment method is already selected OR nothing is selected and this payment method should be
                 // open_by_default
                 if (($this->checkout->selected_method_of_payment === $payment_method->slug())
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
+                    || ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
                 ) {
                     $this->checkout->selected_method_of_payment = $payment_method->slug();
                     $this->_save_selected_method_of_payment();
@@ -1024,7 +1024,7 @@ 
                 } else {
                     $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
                 }
-                $payment_methods_billing_info[$payment_method->slug() . '-info'] = $this->_payment_method_billing_info(
+                $payment_methods_billing_info[$payment_method->slug().'-info'] = $this->_payment_method_billing_info(
                     $payment_method
                 );
             }
@@ -1036,7 +1036,7 @@ 
         $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
             $available_payment_method_options
         );
-        $available_payment_methods                              += $payment_methods_billing_info;
+        $available_payment_methods += $payment_methods_billing_info;
         // build the available payment methods form
         return new EE_Form_Section_Proper(
             array(
@@ -1060,7 +1060,7 @@ 
      */
     protected function _get_available_payment_methods()
     {
-        if (! empty($this->checkout->available_payment_methods)) {
+        if ( ! empty($this->checkout->available_payment_methods)) {
             return $this->checkout->available_payment_methods;
         }
         $available_payment_methods = array();
@@ -1170,7 +1170,7 @@ 
         );
         return new EE_Form_Section_Proper(
             array(
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+                'html_id'         => 'spco-payment-method-info-'.$payment_method->slug(),
                 'html_class'      => 'spco-payment-method-info-dv',
                 // only display the selected or default PM
                 'html_style'      => $currently_selected ? '' : 'display:none;',
@@ -1200,7 +1200,7 @@ 
         // how have they chosen to pay?
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
         $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
             return false;
         }
         if (apply_filters(
@@ -1372,7 +1372,7 @@ 
      */
     public function switch_payment_method()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return false;
         }
         if (apply_filters(
@@ -1501,7 +1501,7 @@ 
             }
         }
         // verify payment method
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
             // get payment method for selected method of payment
             $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
         }
@@ -1526,7 +1526,7 @@ 
      */
     public function save_payer_details_via_ajax()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return;
         }
         // generate billing form for selected method of payment if it hasn't been done already
@@ -1536,7 +1536,7 @@ 
             );
         }
         // generate primary attendee from payer info if applicable
-        if (! $this->checkout->transaction_has_primary_registrant()) {
+        if ( ! $this->checkout->transaction_has_primary_registrant()) {
             $attendee = $this->_create_attendee_from_request_data();
             if ($attendee instanceof EE_Attendee) {
                 foreach ($this->checkout->transaction->registrations() as $registration) {
@@ -1567,7 +1567,7 @@ 
     {
         // get State ID
         $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
-        if (! empty($STA_ID)) {
+        if ( ! empty($STA_ID)) {
             // can we get state object from name ?
             EE_Registry::instance()->load_model('State');
             $state  = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
@@ -1575,7 +1575,7 @@ 
         }
         // get Country ISO
         $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
-        if (! empty($CNT_ISO)) {
+        if ( ! empty($CNT_ISO)) {
             // can we get country object from name ?
             EE_Registry::instance()->load_model('Country');
             $country = EEM_Country::instance()->get_col(
@@ -1608,7 +1608,7 @@ 
         }
         // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
         // AND email address
-        if (! empty($attendee_data['ATT_fname'])
+        if ( ! empty($attendee_data['ATT_fname'])
             && ! empty($attendee_data['ATT_lname'])
             && ! empty($attendee_data['ATT_email'])
         ) {
@@ -1824,7 +1824,7 @@ 
     private function _process_payment()
     {
         // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
+        if ( ! $this->_last_second_ticket_verifications()) {
             return false;
         }
         // ya gotta make a choice man
@@ -1835,7 +1835,7 @@ 
             return false;
         }
         // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
             return false;
         }
         // setup billing form
@@ -1844,12 +1844,12 @@ 
                 $this->checkout->payment_method
             );
             // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
+            if ( ! $this->_billing_form_is_valid()) {
                 return false;
             }
         }
         // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
+        if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
             return false;
         }
         // if session is close to expiring (under 10 minutes by default)
@@ -1905,7 +1905,7 @@ 
     protected function _last_second_ticket_verifications()
     {
         // don't bother re-validating if not a return visit
-        if (! $this->checkout->revisit) {
+        if ( ! $this->checkout->revisit) {
             return true;
         }
         $registrations = $this->checkout->transaction->registrations();
@@ -1956,7 +1956,7 @@ 
             $this->_get_payment_method_for_selected_method_of_payment()
         );
         $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
+        $html .= $this->checkout->redirect_form;
         EE_Registry::instance()->REQ->add_output($html);
         return true;
     }
@@ -1971,7 +1971,7 @@ 
      */
     private function _billing_form_is_valid()
     {
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
+        if ( ! $this->checkout->payment_method->type_obj()->has_billing_form()) {
             return true;
         }
         if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
@@ -2088,7 +2088,7 @@ 
     {
         // convert billing form data into an attendee
         $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
+        if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2105,7 +2105,7 @@ 
             return false;
         }
         $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $primary_registration instanceof EE_Registration) {
+        if ( ! $primary_registration instanceof EE_Registration) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2121,7 +2121,7 @@ 
             );
             return false;
         }
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
+        if ( ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
               instanceof
               EE_Attendee
         ) {
@@ -2177,7 +2177,7 @@ 
             $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
         }
         // verify $payment_method
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2195,7 +2195,7 @@ 
             return null;
         }
         // and verify it has a valid Payment_Method Type object
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+        if ( ! $payment_method->type_obj() instanceof EE_PMT_Base) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2233,7 +2233,7 @@ 
         $payment = null;
         $this->checkout->transaction->save();
         $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        if (! $payment_processor instanceof EE_Payment_Processor) {
+        if ( ! $payment_processor instanceof EE_Payment_Processor) {
             return false;
         }
         try {
@@ -2337,7 +2337,7 @@ 
             return true;
         }
         // verify payment object
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2377,7 +2377,7 @@ 
             return true;
             // On-Site payment?
         } else if ($this->checkout->payment_method->is_on_site()) {
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+            if ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
                 //$this->_setup_redirect_for_next_step();
                 $this->checkout->continue_reg = false;
             }
@@ -2499,7 +2499,7 @@ 
                     break;
                 // bad payment
                 case EEM_Payment::status_id_failed :
-                    if (! empty($msg)) {
+                    if ( ! empty($msg)) {
                         EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
                         return false;
                     }
@@ -2560,11 +2560,11 @@ 
         // how have they chosen to pay?
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
         // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
             $this->checkout->continue_reg = false;
             return false;
         }
-        if (! $this->checkout->payment_method->is_off_site()) {
+        if ( ! $this->checkout->payment_method->is_off_site()) {
             return false;
         }
         $this->_validate_offsite_return();
@@ -2580,7 +2580,7 @@ 
         // verify TXN
         if ($this->checkout->transaction instanceof EE_Transaction) {
             $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-            if (! $gateway instanceof EE_Offsite_Gateway) {
+            if ( ! $gateway instanceof EE_Offsite_Gateway) {
                 $this->checkout->continue_reg = false;
                 return false;
             }
@@ -2622,7 +2622,7 @@ 
      */
     private function _validate_offsite_return()
     {
-        $TXN_ID = (int)EE_Registry::instance()->REQ->get('spco_txn', 0);
+        $TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
         if ($TXN_ID !== $this->checkout->transaction->ID()) {
             // Houston... we might have a problem
             $invalid_TXN = false;
@@ -2695,13 +2695,13 @@ 
      */
     private function _redirect_wayward_request(EE_Registration $primary_registrant)
     {
-        if (! $primary_registrant instanceof EE_Registration) {
+        if ( ! $primary_registrant instanceof EE_Registration) {
             // try redirecting based on the current TXN
             $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
                 ? $this->checkout->transaction->primary_registration()
                 : null;
         }
-        if (! $primary_registrant instanceof EE_Registration) {
+        if ( ! $primary_registrant instanceof EE_Registration) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2771,7 +2771,7 @@ 
             $payment = $this->checkout->transaction->last_payment();
             //$payment_source = 'last_payment after Exception';
             // but if we STILL don't have a payment object
-            if (! $payment instanceof EE_Payment) {
+            if ( ! $payment instanceof EE_Payment) {
                 // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
                 $this->_handle_payment_processor_exception($e);
             }

Indentation +2872 added lines, -2872 removed lines

@@ -15,2876 +15,2876 @@
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
 {
 
-    /**
-     * @access protected
-     * @var EE_Line_Item_Display $Line_Item_Display
-     */
-    protected $line_item_display;
-
-    /**
-     * @access protected
-     * @var boolean $handle_IPN_in_this_request
-     */
-    protected $handle_IPN_in_this_request = false;
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        add_filter(
-            'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
-        );
-        add_action(
-            'wp_ajax_switch_spco_billing_form',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
-        );
-        add_action(
-            'wp_ajax_nopriv_switch_spco_billing_form',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
-        );
-        add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
-        add_action(
-            'wp_ajax_nopriv_save_payer_details',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
-        );
-        add_action(
-            'wp_ajax_get_transaction_details_for_gateways',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
-        );
-        add_action(
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
-        );
-        add_filter(
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
-            10,
-            1
-        );
-    }
-
-
-    /**
-     *    ajax switch_spco_billing_form
-     *
-     * @throws \EE_Error
-     */
-    public static function switch_spco_billing_form()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
-    }
-
-
-    /**
-     *    ajax save_payer_details
-     *
-     * @throws \EE_Error
-     */
-    public static function save_payer_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
-    }
-
-
-    /**
-     *    ajax get_transaction_details
-     *
-     * @throws \EE_Error
-     */
-    public static function get_transaction_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
-    }
-
-
-    /**
-     * bypass_recaptcha_for_load_payment_method
-     *
-     * @access public
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function bypass_recaptcha_for_load_payment_method()
-    {
-        return array(
-            'EESID'  => EE_Registry::instance()->SSN->id(),
-            'step'   => 'payment_options',
-            'action' => 'spco_billing_form',
-        );
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug     = 'payment_options';
-        $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
-        $this->checkout  = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__(
-                'Please select a method of payment and provide any necessary billing information before proceeding.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-    /**
-     * @return null
-     */
-    public function line_item_display()
-    {
-        return $this->line_item_display;
-    }
-
-
-    /**
-     * @param null $line_item_display
-     */
-    public function set_line_item_display($line_item_display)
-    {
-        $this->line_item_display = $line_item_display;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function handle_IPN_in_this_request()
-    {
-        return $this->handle_IPN_in_this_request;
-    }
-
-
-    /**
-     * @param boolean $handle_IPN_in_this_request
-     */
-    public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
-    {
-        $this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * translate_js_strings
-     *
-     * @return void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
-            'Please select a method of payment in order to continue.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
-            'A valid method of payment could not be determined. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
-            'Forwarding to Secure Payment Provider.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * enqueue_styles_and_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        $transaction = $this->checkout->transaction;
-        //if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
-            return;
-        }
-        foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
-            $type_obj = $payment_method->type_obj();
-            if ($type_obj instanceof EE_PMT_Base) {
-                $billing_form = $type_obj->generate_new_billing_form($transaction);
-                if ($billing_form instanceof EE_Form_Section_Proper) {
-                    $billing_form->enqueue_js();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * initialize_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function initialize_reg_step()
-    {
-        // TODO: if /when we implement donations, then this will need overriding
-        if (// don't need payment options for:
-            // 	registrations made via the admin
-            // 	completed transactions
-            // 	overpaid transactions
-            // 	$ 0.00 transactions (no payment required)
-            ! $this->checkout->payment_required()
-            // but do NOT remove if current action being called belongs to this reg step
-            && ! is_callable(array($this, $this->checkout->action))
-            && ! $this->completed()
-        ) {
-            // and if so, then we no longer need the Payment Options step
-            if ($this->is_current_step()) {
-                $this->checkout->generate_reg_form = false;
-            }
-            $this->checkout->remove_reg_step($this->_slug);
-            // DEBUG LOG
-            //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        // load EEM_Payment_Method
-        EE_Registry::instance()->load_model('Payment_Method');
-        // get all active payment methods
-        $this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function generate_reg_form()
-    {
-        // reset in case someone changes their mind
-        $this->_reset_selected_method_of_payment();
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'payments_closed';
-        $registrations_requiring_payment            = array();
-        $registrations_for_free_events              = array();
-        $registrations_requiring_pre_approval       = array();
-        $sold_out_events                            = array();
-        $insufficient_spaces_available              = array();
-        $no_payment_required                        = true;
-        // loop thru registrations to gather info
-        $registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-            $registrations,
-            $this->checkout->revisit
-        );
-        foreach ($registrations as $REG_ID => $registration) {
-            /** @var $registration EE_Registration */
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[$REG_ID])) {
-                $insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
-                continue;
-            }
-            // event requires admin approval
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
-                // add event to list of events with pre-approval reg status
-                $registrations_requiring_pre_approval[$REG_ID] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            if ($this->checkout->revisit
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-                && (
-                    $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out(true)
-                )
-            ) {
-                // add event to list of events that are sold out
-                $sold_out_events[$registration->event()->ID()] = $registration->event();
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            // are they allowed to pay now and is there monies owing?
-            if ($registration->owes_monies_and_can_pay()) {
-                $registrations_requiring_payment[$REG_ID] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
-                    $registration->event(),
-                    $this
-                );
-            } elseif (! $this->checkout->revisit
-                && $registration->status_ID() !== EEM_Registration::status_id_not_approved
-                && $registration->ticket()->is_free()
-            ) {
-                $registrations_for_free_events[$registration->event()->ID()] = $registration;
-            }
-        }
-        $subsections = array();
-        // now decide which template to load
-        if (! empty($sold_out_events)) {
-            $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
-        }
-        if (! empty($insufficient_spaces_available)) {
-            $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
-                $insufficient_spaces_available
-            );
-        }
-        if (! empty($registrations_requiring_pre_approval)) {
-            $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
-                $registrations_requiring_pre_approval
-            );
-        }
-        if (! empty($registrations_for_free_events)) {
-            $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
-        }
-        if (! empty($registrations_requiring_payment)) {
-            if ($this->checkout->amount_owing > 0) {
-                // autoload Line_Item_Display classes
-                EEH_Autoloader::register_line_item_filter_autoloaders();
-                $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
-                    apply_filters(
-                        'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-                        new EE_Line_Item_Filter_Collection()
-                    ),
-                    $this->checkout->cart->get_grand_total()
-                );
-                /** @var EE_Line_Item $filtered_line_item_tree */
-                $filtered_line_item_tree = $line_item_filter_processor->process();
-                EEH_Autoloader::register_line_item_display_autoloaders();
-                $this->set_line_item_display(new EE_Line_Item_Display('spco'));
-                $subsections['payment_options'] = $this->_display_payment_options(
-                    $this->line_item_display->display_line_item(
-                        $filtered_line_item_tree,
-                        array('registrations' => $registrations)
-                    )
-                );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
-                $this->_apply_registration_payments_to_amount_owing($registrations);
-            }
-            $no_payment_required = false;
-        } else {
-            $this->_hide_reg_step_submit_button_if_revisit();
-        }
-        $this->_save_selected_method_of_payment();
-
-        $subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
-        $subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
-
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => new EE_No_Layout(),
-            )
-        );
-    }
-
-
-    /**
-     * add line item filters required for this reg step
-     * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
-     *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
-     *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
-     *        payment options reg step, can apply these filters via the following: apply_filters(
-     *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
-     *        filter collection by passing that instead of instantiating a new collection
-     *
-     * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
-     * @return EE_Line_Item_Filter_Collection
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
-    {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
-            return $line_item_filter_collection;
-        }
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
-            return $line_item_filter_collection;
-        }
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
-            return $line_item_filter_collection;
-        }
-        $line_item_filter_collection->add(
-            new EE_Billable_Line_Item_Filter(
-                EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
-                    EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                    )
-                )
-            )
-        );
-        $line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
-        return $line_item_filter_collection;
-    }
-
-
-    /**
-     * remove_ejected_registrations
-     * if a registrant has lost their potential space at an event due to lack of payment,
-     * then this method removes them from the list of registrations being paid for during this request
-     *
-     * @param \EE_Registration[] $registrations
-     * @return EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function remove_ejected_registrations(array $registrations)
-    {
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-            $registrations,
-            EE_Registry::instance()->SSN->checkout()->revisit
-        );
-        foreach ($registrations as $REG_ID => $registration) {
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[$REG_ID])) {
-                unset($registrations[$REG_ID]);
-                continue;
-            }
-        }
-        return $registrations;
-    }
-
-
-    /**
-     * find_registrations_that_lost_their_space
-     * If a registrant chooses an offline payment method like Invoice,
-     * then no space is reserved for them at the event until they fully pay fo that site
-     * (unless the event's default reg status is set to APPROVED)
-     * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
-     * then this method will determine which registrations have lost the ability to complete the reg process.
-     *
-     * @param \EE_Registration[] $registrations
-     * @param bool               $revisit
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
-    {
-        // registrations per event
-        $event_reg_count = array();
-        // spaces left per event
-        $event_spaces_remaining = array();
-        // tickets left sorted by ID
-        $tickets_remaining = array();
-        // registrations that have lost their space
-        $ejected_registrations = array();
-        foreach ($registrations as $REG_ID => $registration) {
-            if ($registration->status_ID() === EEM_Registration::status_id_approved
-                || apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
-                    false,
-                    $registration,
-                    $revisit
-                )
-            ) {
-                continue;
-            }
-            $EVT_ID = $registration->event_ID();
-            $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[$ticket->ID()])) {
-                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
-            }
-            if ($tickets_remaining[$ticket->ID()] > 0) {
-                if (! isset($event_reg_count[$EVT_ID])) {
-                    $event_reg_count[$EVT_ID] = 0;
-                }
-                $event_reg_count[$EVT_ID]++;
-                if (! isset($event_spaces_remaining[$EVT_ID])) {
-                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
-                }
-            }
-            if ($revisit
-                && ($tickets_remaining[$ticket->ID()] === 0
-                    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
-                )
-            ) {
-                $ejected_registrations[$REG_ID] = $registration->event();
-                if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
-                    /** @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->manually_update_registration_status(
-                        $registration,
-                        EEM_Registration::status_id_wait_list
-                    );
-                }
-            }
-        }
-        return $ejected_registrations;
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _adjust_registration_status_if_event_old_sold()
-    {
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _hide_reg_step_submit_button_if_revisit()
-    {
-        if ($this->checkout->revisit) {
-            add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
-        }
-    }
-
-
-    /**
-     * sold_out_events
-     * displays notices regarding events that have sold out since hte registrant first signed up
-     *
-     * @param \EE_Event[] $sold_out_events_array
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _sold_out_events($sold_out_events_array = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'events_sold_out';
-        $sold_out_events                            = '';
-        foreach ($sold_out_events_array as $sold_out_event) {
-            $sold_out_events .= EEH_HTML::li(
-                EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
-                    '',
-                    'dashicons dashicons-marker ee-icon-size-16 pink-text'
-                )
-            );
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            array(
-                                'sold_out_events'     => $sold_out_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
-                                    sprintf(
-                                        esc_html__(
-                                            'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$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.%2$s',
-                                            'event_espresso'
-                                        ),
-                                        '<strong>',
-                                        '</strong>',
-                                        '<br />'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _insufficient_spaces_available
-     * displays notices regarding events that do not have enough remaining spaces
-     * to satisfy the current number of registrations looking to pay
-     *
-     * @param \EE_Event[] $insufficient_spaces_events_array
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'invoice';
-        $insufficient_space_events                  = '';
-        foreach ($insufficient_spaces_events_array as $event) {
-            if ($event instanceof EE_Event) {
-                $insufficient_space_events .= EEH_HTML::li(
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections'     => array(
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
-                ),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
-                            array(
-                                'sold_out_events'     => $insufficient_space_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
-                                    esc_html__(
-                                        'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * registrations_requiring_pre_approval
-     *
-     * @param array $registrations_requiring_pre_approval
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
-    {
-        $events_requiring_pre_approval = '';
-        foreach ($registrations_requiring_pre_approval as $registration) {
-            if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
-                $events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
-                    EEH_HTML::span(
-                        '',
-                        '',
-                        'dashicons dashicons-marker ee-icon-size-16 orange-text'
-                    )
-                    . EEH_HTML::span($registration->event()->name(), '', 'orange-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'events_requiring_pre_approval.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            array(
-                                'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
-                                'events_requiring_pre_approval_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
-                                    esc_html__(
-                                        'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has 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'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _no_payment_required
-     *
-     * @param \EE_Event[] $registrations_for_free_events
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _no_payment_required($registrations_for_free_events = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
-        // generate no_payment_required form
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'no_payment_required.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
-                            array(
-                                'revisit'                       => $this->checkout->revisit,
-                                'registrations'                 => array(),
-                                'ticket_count'                  => array(),
-                                'registrations_for_free_events' => $registrations_for_free_events,
-                                'no_payment_required_msg'       => EEH_HTML::p(
-                                    esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _display_payment_options
-     *
-     * @param string $transaction_details
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _display_payment_options($transaction_details = '')
-    {
-        // has method_of_payment been set by no-js user?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
-        // build payment options form
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
-            new EE_Form_Section_Proper(
-                array(
-                    'subsections'     => array(
-                        'before_payment_options' => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
-                            new EE_Form_Section_Proper(
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
-                            )
-                        ),
-                        'payment_options'        => $this->_setup_payment_options(),
-                        'after_payment_options'  => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
-                            new EE_Form_Section_Proper(
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
-                            )
-                        ),
-                    ),
-                    'layout_strategy' => new EE_Template_Layout(
-                        array(
-                            'layout_template_file' => $this->_template,
-                            'template_args'        => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
-                                array(
-                                    'reg_count'                 => $this->line_item_display->total_items(),
-                                    'transaction_details'       => $transaction_details,
-                                    'available_payment_methods' => array(),
-                                )
-                            ),
-                        )
-                    ),
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _extra_hidden_inputs
-     *
-     * @param bool $no_payment_required
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _extra_hidden_inputs($no_payment_required = true)
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    'spco_no_payment_required' => new EE_Hidden_Input(
-                        array(
-                            'normalization_strategy' => new EE_Boolean_Normalization(),
-                            'html_name'              => 'spco_no_payment_required',
-                            'html_id'                => 'spco-no-payment-required-payment_options',
-                            'default'                => $no_payment_required,
-                        )
-                    ),
-                    'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
-                        array(
-                            'normalization_strategy' => new EE_Int_Normalization(),
-                            'html_name'              => 'spco_transaction_id',
-                            'html_id'                => 'spco-transaction-id',
-                            'default'                => $this->checkout->transaction->ID(),
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     *    _apply_registration_payments_to_amount_owing
-     *
-     * @access protected
-     * @param array $registrations
-     * @throws EE_Error
-     */
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
-    {
-        $payments = array();
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
-                $payments += $registration->registration_payments();
-            }
-        }
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Registration_Payment) {
-                    $this->checkout->amount_owing -= $payment->amount();
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    _reset_selected_method_of_payment
-     *
-     * @access    private
-     * @param    bool $force_reset
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _reset_selected_method_of_payment($force_reset = false)
-    {
-        $reset_payment_method = $force_reset
-            ? true
-            : sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
-        if ($reset_payment_method) {
-            $this->checkout->selected_method_of_payment = null;
-            $this->checkout->payment_method             = null;
-            $this->checkout->billing_form               = null;
-            $this->_save_selected_method_of_payment();
-        }
-    }
-
-
-    /**
-     * _save_selected_method_of_payment
-     * stores the selected_method_of_payment in the session
-     * so that it's available for all subsequent requests including AJAX
-     *
-     * @access        private
-     * @param string $selected_method_of_payment
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _save_selected_method_of_payment($selected_method_of_payment = '')
-    {
-        $selected_method_of_payment = ! empty($selected_method_of_payment)
-            ? $selected_method_of_payment
-            : $this->checkout->selected_method_of_payment;
-        EE_Registry::instance()->SSN->set_session_data(
-            array('selected_method_of_payment' => $selected_method_of_payment)
-        );
-    }
-
-
-    /**
-     * _setup_payment_options
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function _setup_payment_options()
-    {
-        // load payment method classes
-        $this->checkout->available_payment_methods = $this->_get_available_payment_methods();
-        if (empty($this->checkout->available_payment_methods)) {
-            EE_Error::add_error(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
-                    sprintf(
-                        esc_html__(
-                            'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
-                            'event_espresso'
-                        ),
-                        '<br>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    )
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
-            ? apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Please Select Your Method of Payment', 'event_espresso')
-            )
-            : apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Method of Payment', 'event_espresso')
-            );
-        $available_payment_methods = array(
-            // display the "Payment Method" header
-            'payment_method_header' => new EE_Form_Section_HTML(
-                EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
-            ),
-        );
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
-        $available_payment_method_options = array();
-        $default_payment_method_option    = array();
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
-        $payment_methods_billing_info = array(
-            new EE_Form_Section_HTML(
-                EEH_HTML::div('<br />', '', '', 'clear:both;')
-            ),
-        );
-        // loop through payment methods
-        foreach ($this->checkout->available_payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $payment_method_button = EEH_HTML::img(
-                    $payment_method->button_url(),
-                    $payment_method->name(),
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
-                    'spco-payment-method-btn-img'
-                );
-                // check if any payment methods are set as default
-                // if payment method is already selected OR nothing is selected and this payment method should be
-                // open_by_default
-                if (($this->checkout->selected_method_of_payment === $payment_method->slug())
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
-                ) {
-                    $this->checkout->selected_method_of_payment = $payment_method->slug();
-                    $this->_save_selected_method_of_payment();
-                    $default_payment_method_option[$payment_method->slug()] = $payment_method_button;
-                } else {
-                    $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
-                }
-                $payment_methods_billing_info[$payment_method->slug() . '-info'] = $this->_payment_method_billing_info(
-                    $payment_method
-                );
-            }
-        }
-        // prepend available_payment_method_options with default_payment_method_option so that it appears first in list
-        // of PMs
-        $available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
-        // now generate the actual form  inputs
-        $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
-            $available_payment_method_options
-        );
-        $available_payment_methods                              += $payment_methods_billing_info;
-        // build the available payment methods form
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'spco-available-methods-of-payment-dv',
-                'subsections'     => $available_payment_methods,
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-            )
-        );
-    }
-
-
-    /**
-     * _get_available_payment_methods
-     *
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_available_payment_methods()
-    {
-        if (! empty($this->checkout->available_payment_methods)) {
-            return $this->checkout->available_payment_methods;
-        }
-        $available_payment_methods = array();
-        // load EEM_Payment_Method
-        EE_Registry::instance()->load_model('Payment_Method');
-        /** @type EEM_Payment_Method $EEM_Payment_Method */
-        $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-        // get all active payment methods
-        $payment_methods = $EEM_Payment_Method->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $available_payment_methods[$payment_method->slug()] = $payment_method;
-            }
-        }
-        return $available_payment_methods;
-    }
-
-
-    /**
-     *    _available_payment_method_inputs
-     *
-     * @access    private
-     * @param    array $available_payment_method_options
-     * @return    \EE_Form_Section_Proper
-     */
-    private function _available_payment_method_inputs($available_payment_method_options = array())
-    {
-        // generate inputs
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'ee-available-payment-method-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    '' => new EE_Radio_Button_Input(
-                        $available_payment_method_options,
-                        array(
-                            'html_name'          => 'selected_method_of_payment',
-                            'html_class'         => 'spco-payment-method',
-                            'default'            => $this->checkout->selected_method_of_payment,
-                            'label_size'         => 11,
-                            'enforce_label_size' => true,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     *    _payment_method_billing_info
-     *
-     * @access    private
-     * @param    EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
-    {
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
-            ? true
-            : false;
-        // generate the billing form for payment method
-        $billing_form                 = $currently_selected
-            ? $this->_get_billing_form_for_payment_method($payment_method)
-            : new EE_Form_Section_HTML();
-        $this->checkout->billing_form = $currently_selected
-            ? $billing_form
-            : $this->checkout->billing_form;
-        // it's all in the details
-        $info_html = EEH_HTML::h3(
-            esc_html__('Important information regarding your payment', 'event_espresso'),
-            '',
-            'spco-payment-method-hdr'
-        );
-        // add some info regarding the step, either from what's saved in the admin,
-        // or a default string depending on whether the PM has a billing form or not
-        if ($payment_method->description()) {
-            $payment_method_info = $payment_method->description();
-        } elseif ($billing_form instanceof EE_Billing_Info_Form) {
-            $payment_method_info = sprintf(
-                esc_html__(
-                    'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
-                    'event_espresso'
-                ),
-                $this->submit_button_text()
-            );
-        } else {
-            $payment_method_info = sprintf(
-                esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
-                $this->submit_button_text()
-            );
-        }
-        $info_html .= EEH_HTML::p(
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
-                $payment_method_info
-            ),
-            '',
-            'spco-payment-method-desc ee-attention'
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
-                'html_class'      => 'spco-payment-method-info-dv',
-                // only display the selected or default PM
-                'html_style'      => $currently_selected ? '' : 'display:none;',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    'info'         => new EE_Form_Section_HTML($info_html),
-                    'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * get_billing_form_html_for_payment_method
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_billing_form_html_for_payment_method()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            return false;
-        }
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-            false
-        )) {
-            EE_Error::add_success(
-                apply_filters(
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // now generate billing form for selected method of payment
-        $payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
-        // fill form with attendee info if applicable
-        if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
-            && $this->checkout->transaction_has_primary_registrant()
-        ) {
-            $payment_method_billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if ($payment_method_billing_form instanceof EE_Billing_Info_Form
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
-        ) {
-            $payment_method_billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $payment_method_billing_form
-                );
-        }
-        $billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
-            ? $payment_method_billing_form->get_html()
-            : '';
-        $this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
-        // localize validation rules for main form
-        $this->checkout->current_step->reg_form->localize_validation_rules();
-        $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-        return true;
-    }
-
-
-    /**
-     * _get_billing_form_for_payment_method
-     *
-     * @access private
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
-    {
-        $billing_form = $payment_method->type_obj()->billing_form(
-            $this->checkout->transaction,
-            array('amount_owing' => $this->checkout->amount_owing)
-        );
-        if ($billing_form instanceof EE_Billing_Info_Form) {
-            if (apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-                false
-            )
-                && EE_Registry::instance()->REQ->is_set('payment_method')
-            ) {
-                EE_Error::add_success(
-                    apply_filters(
-                        'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                        sprintf(
-                            esc_html__(
-                                'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                                'event_espresso'
-                            ),
-                            $payment_method->name()
-                        )
-                    )
-                );
-            }
-            return apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-                $billing_form,
-                $payment_method
-            );
-        }
-        // no actual billing form, so return empty HTML form section
-        return new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * _get_selected_method_of_payment
-     *
-     * @access private
-     * @param boolean $required whether to throw an error if the "selected_method_of_payment"
-     *                          is not found in the incoming request
-     * @param string  $request_param
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_selected_method_of_payment(
-        $required = false,
-        $request_param = 'selected_method_of_payment'
-    ) {
-        // is selected_method_of_payment set in the request ?
-        $selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
-        if ($selected_method_of_payment) {
-            // sanitize it
-            $selected_method_of_payment = is_array($selected_method_of_payment)
-                ? array_shift($selected_method_of_payment)
-                : $selected_method_of_payment;
-            $selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
-            // store it in the session so that it's available for all subsequent requests including AJAX
-            $this->_save_selected_method_of_payment($selected_method_of_payment);
-        } else {
-            // or is is set in the session ?
-            $selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
-                'selected_method_of_payment'
-            );
-        }
-        // do ya really really gotta have it?
-        if (empty($selected_method_of_payment) && $required) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $selected_method_of_payment;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /***********************************  SWITCH PAYMENT METHOD  ************************************/
-    /********************************************************************************************************/
-    /**
-     * switch_payment_method
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function switch_payment_method()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return false;
-        }
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-            false
-        )) {
-            EE_Error::add_success(
-                apply_filters(
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // generate billing form for selected method of payment if it hasn't been done already
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // fill form with attendee info if applicable
-        if (apply_filters(
-            'FHEE__populate_billing_form_fields_from_attendee',
-            (
-                $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $this->checkout->transaction_has_primary_registrant()
-            ),
-            $this->checkout->billing_form,
-            $this->checkout->transaction
-        )
-        ) {
-            $this->checkout->billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
-        ) {
-            $this->checkout->billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $this->checkout->billing_form
-                );
-        }
-        // get html and validation rules for form
-        if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->json_response->set_return_data(
-                array('payment_method_info' => $this->checkout->billing_form->get_html())
-            );
-            // localize validation rules for main form
-            $this->checkout->billing_form->localize_validation_rules(true);
-            $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-        } else {
-            $this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
-        }
-        //prevents advancement to next step
-        $this->checkout->continue_reg = false;
-        return true;
-    }
-
-
-    /**
-     * _verify_payment_method_is_set
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _verify_payment_method_is_set()
-    {
-        // generate billing form for selected method of payment if it hasn't been done already
-        if (empty($this->checkout->selected_method_of_payment)) {
-            // how have they chosen to pay?
-            $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        } else {
-            // choose your own adventure based on method_of_payment
-            switch ($this->checkout->selected_method_of_payment) {
-                case 'events_sold_out' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                case 'payments_closed' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                case 'no_payment_required' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                default:
-            }
-        }
-        // verify payment method
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            // get payment method for selected method of payment
-            $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
-        }
-        return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
-    }
-
-
-
-    /********************************************************************************************************/
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * save_payer_details_via_ajax
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function save_payer_details_via_ajax()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return;
-        }
-        // generate billing form for selected method of payment if it hasn't been done already
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // generate primary attendee from payer info if applicable
-        if (! $this->checkout->transaction_has_primary_registrant()) {
-            $attendee = $this->_create_attendee_from_request_data();
-            if ($attendee instanceof EE_Attendee) {
-                foreach ($this->checkout->transaction->registrations() as $registration) {
-                    if ($registration->is_primary_registrant()) {
-                        $this->checkout->primary_attendee_obj = $attendee;
-                        $registration->_add_relation_to($attendee, 'Attendee');
-                        $registration->set_attendee_id($attendee->ID());
-                        $registration->update_cache_after_object_save('Attendee', $attendee);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * create_attendee_from_request_data
-     * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _create_attendee_from_request_data()
-    {
-        // get State ID
-        $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
-        if (! empty($STA_ID)) {
-            // can we get state object from name ?
-            EE_Registry::instance()->load_model('State');
-            $state  = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
-        }
-        // get Country ISO
-        $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
-        if (! empty($CNT_ISO)) {
-            // can we get country object from name ?
-            EE_Registry::instance()->load_model('Country');
-            $country = EEM_Country::instance()->get_col(
-                array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
-                'CNT_ISO'
-            );
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
-        }
-        // grab attendee data
-        $attendee_data = array(
-            'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
-            'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
-            'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
-            'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
-            'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
-            'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
-            'STA_ID'       => $STA_ID,
-            'CNT_ISO'      => $CNT_ISO,
-            'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
-            'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
-        );
-        // validate the email address since it is the most important piece of info
-        if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
-            EE_Error::add_error(
-                esc_html__('An invalid email address was submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
-        // AND email address
-        if (! empty($attendee_data['ATT_fname'])
-            && ! empty($attendee_data['ATT_lname'])
-            && ! empty($attendee_data['ATT_email'])
-        ) {
-            $existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
-                array(
-                    'ATT_fname' => $attendee_data['ATT_fname'],
-                    'ATT_lname' => $attendee_data['ATT_lname'],
-                    'ATT_email' => $attendee_data['ATT_email'],
-                )
-            );
-            if ($existing_attendee instanceof EE_Attendee) {
-                return $existing_attendee;
-            }
-        }
-        // no existing attendee? kk let's create a new one
-        // kinda lame, but we need a first and last name to create an attendee, so use the email address if those
-        // don't exist
-        $attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
-            ? $attendee_data['ATT_fname']
-            : $attendee_data['ATT_email'];
-        $attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
-            ? $attendee_data['ATT_lname']
-            : $attendee_data['ATT_email'];
-        return EE_Attendee::new_instance($attendee_data);
-    }
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  *****************************************/
-    /********************************************************************************************************/
-    /**
-     * process_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function process_reg_step()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
-            ? 'no_payment_required'
-            : $this->_get_selected_method_of_payment(true);
-        // choose your own adventure based on method_of_payment
-        switch ($this->checkout->selected_method_of_payment) {
-
-            case 'events_sold_out' :
-                $this->checkout->redirect     = true;
-                $this->checkout->redirect_url = $this->checkout->cancel_page_url;
-                $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-                // mark this reg step as completed
-                $this->set_completed();
-                return false;
-                break;
-
-            case 'payments_closed' :
-                if (apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
-                    false
-                )) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required at this time.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-                break;
-
-            case 'no_payment_required' :
-                if (apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
-                    false
-                )) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-                break;
-
-            default:
-                $registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                    EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                );
-                $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-                    $registrations,
-                    EE_Registry::instance()->SSN->checkout()->revisit
-                );
-                // calculate difference between the two arrays
-                $registrations = array_diff($registrations, $ejected_registrations);
-                if (empty($registrations)) {
-                    $this->_redirect_because_event_sold_out();
-                    return false;
-                }
-                $payment_successful = $this->_process_payment();
-                if ($payment_successful) {
-                    $this->checkout->continue_reg = true;
-                    $this->_maybe_set_completed($this->checkout->payment_method);
-                } else {
-                    $this->checkout->continue_reg = false;
-                }
-                return $payment_successful;
-        }
-    }
-
-
-    /**
-     * _redirect_because_event_sold_out
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _redirect_because_event_sold_out()
-    {
-        $this->checkout->continue_reg = false;
-        // set redirect URL
-        $this->checkout->redirect_url = add_query_arg(
-            array('e_reg_url_link' => $this->checkout->reg_url_link),
-            $this->checkout->current_step->reg_step_url()
-        );
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-    }
-
-
-    /**
-     * _maybe_set_completed
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _maybe_set_completed(EE_Payment_Method $payment_method)
-    {
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite :
-                break;
-            case EE_PMT_Base::onsite :
-            case EE_PMT_Base::offline :
-                // mark this reg step as completed
-                $this->set_completed();
-                break;
-        }
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to retry a payment
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function update_reg_step()
-    {
-        $success = true;
-        // if payment required
-        if ($this->checkout->transaction->total() > 0) {
-            do_action(
-                'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
-                $this->checkout->transaction
-            );
-            // attempt payment via payment method
-            $success = $this->process_reg_step();
-        }
-        if ($success && ! $this->checkout->redirect) {
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
-                $this->checkout->transaction->ID()
-            );
-            // set return URL
-            $this->checkout->redirect_url = add_query_arg(
-                array('e_reg_url_link' => $this->checkout->reg_url_link),
-                $this->checkout->thank_you_page_url
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     *    _process_payment
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_payment()
-    {
-        // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
-            return false;
-        }
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $this->checkout->json_response->set_plz_select_method_of_payment(
-                esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
-            );
-            return false;
-        }
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            return false;
-        }
-        // setup billing form
-        if ($this->checkout->payment_method->is_on_site()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-            // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
-                return false;
-            }
-        }
-        // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
-            return false;
-        }
-        // if session is close to expiring (under 10 minutes by default)
-        if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
-            // add some time to session expiration so that payment can be completed
-            EE_Registry::instance()->SSN->extend_expiration();
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        //$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
-        // in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
-        // for events with a default reg status of Approved
-        // $transaction_processor->toggle_registration_statuses_for_default_approved_events(
-        //      $this->checkout->transaction, $this->checkout->reg_cache_where_params
-        // );
-        // attempt payment
-        $payment = $this->_attempt_payment($this->checkout->payment_method);
-        // process results
-        $payment = $this->_validate_payment($payment);
-        $payment = $this->_post_payment_processing($payment);
-        // verify payment
-        if ($payment instanceof EE_Payment) {
-            // store that for later
-            $this->checkout->payment = $payment;
-            // 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();
-            $payment_status = $payment->status();
-            if (
-                $payment_status === EEM_Payment::status_id_approved
-                || $payment_status === EEM_Payment::status_id_pending
-            ) {
-                return true;
-            } else {
-                return false;
-            }
-        } else if ($payment === true) {
-            // please note that offline payment methods will NOT make a payment,
-            // but instead just mark themselves as the PMD_ID on the transaction, and return true
-            $this->checkout->payment = $payment;
-            return true;
-        }
-        // where's my money?
-        return false;
-    }
-
-
-    /**
-     * _last_second_ticket_verifications
-     *
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _last_second_ticket_verifications()
-    {
-        // don't bother re-validating if not a return visit
-        if (! $this->checkout->revisit) {
-            return true;
-        }
-        $registrations = $this->checkout->transaction->registrations();
-        if (empty($registrations)) {
-            return false;
-        }
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $event = $registration->event_obj();
-                if ($event instanceof EE_Event && $event->is_sold_out(true)) {
-                    EE_Error::add_error(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
-                            sprintf(
-                                esc_html__(
-                                    'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
-                                    'event_espresso'
-                                ),
-                                $event->name()
-                            )
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * redirect_form
-     *
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function redirect_form()
-    {
-        $payment_method_billing_info = $this->_payment_method_billing_info(
-            $this->_get_payment_method_for_selected_method_of_payment()
-        );
-        $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
-        EE_Registry::instance()->REQ->add_output($html);
-        return true;
-    }
-
-
-    /**
-     * _billing_form_is_valid
-     *
-     * @access private
-     * @return bool
-     * @throws \EE_Error
-     */
-    private function _billing_form_is_valid()
-    {
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
-            return true;
-        }
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
-            if ($this->checkout->billing_form->was_submitted()) {
-                $this->checkout->billing_form->receive_form_submission();
-                if ($this->checkout->billing_form->is_valid()) {
-                    return true;
-                }
-                $validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
-                $error_strings     = array();
-                foreach ($validation_errors as $validation_error) {
-                    if ($validation_error instanceof EE_Validation_Error) {
-                        $form_section = $validation_error->get_form_section();
-                        if ($form_section instanceof EE_Form_Input_Base) {
-                            $label = $form_section->html_label_text();
-                        } elseif ($form_section instanceof EE_Form_Section_Base) {
-                            $label = $form_section->name();
-                        } else {
-                            $label = esc_html__('Validation Error', 'event_espresso');
-                        }
-                        $error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
-                    }
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        implode('<br/>', $error_strings)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'The billing form was not submitted or something prevented it\'s submission.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * _setup_primary_registrant_prior_to_payment
-     * ensures that the primary registrant has a valid attendee object created with the critical details populated
-     * (first & last name & email) and that both the transaction object and primary registration object have been saved
-     * plz note that any other registrations will NOT be saved at this point (because they may not have any details
-     * yet)
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _setup_primary_registrant_prior_to_payment()
-    {
-        // check if transaction has a primary registrant and that it has a related Attendee object
-        // if not, then we need to at least gather some primary registrant data before attempting payment
-        if (
-            $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-            && ! $this->checkout->transaction_has_primary_registrant()
-            && ! $this->_capture_primary_registration_data_from_billing_form()
-        ) {
-            return false;
-        }
-        // because saving an object clears it's cache, we need to do the chevy shuffle
-        // grab the primary_registration object
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        // at this point we'll consider a TXN to not have been failed
-        $this->checkout->transaction->toggle_failed_transaction_status();
-        // save the TXN ( which clears cached copy of primary_registration)
-        $this->checkout->transaction->save();
-        // grab TXN ID and save it to the primary_registration
-        $primary_registration->set_transaction_id($this->checkout->transaction->ID());
-        // save what we have so far
-        $primary_registration->save();
-        return true;
-    }
-
-
-    /**
-     * _capture_primary_registration_data_from_billing_form
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _capture_primary_registration_data_from_billing_form()
-    {
-        // convert billing form data into an attendee
-        $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $primary_registration instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
-              instanceof
-              EE_Attendee
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __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($primary_registration);
-        return true;
-    }
-
-
-    /**
-     * _get_payment_method_for_selected_method_of_payment
-     * retrieves a valid payment method
-     *
-     * @access public
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_payment_method_for_selected_method_of_payment()
-    {
-        if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
-            $this->_redirect_because_event_sold_out();
-            return null;
-        }
-        // get EE_Payment_Method object
-        if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
-            $payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
-        } else {
-            // load EEM_Payment_Method
-            EE_Registry::instance()->load_model('Payment_Method');
-            /** @type EEM_Payment_Method $EEM_Payment_Method */
-            $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-            $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
-        }
-        // verify $payment_method
-        if (! $payment_method instanceof EE_Payment_Method) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        // and verify it has a valid Payment_Method Type object
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     *    _attempt_payment
-     *
-     * @access    private
-     * @type    EE_Payment_Method $payment_method
-     * @return mixed EE_Payment | boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _attempt_payment(EE_Payment_Method $payment_method)
-    {
-        $payment = null;
-        $this->checkout->transaction->save();
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        if (! $payment_processor instanceof EE_Payment_Processor) {
-            return false;
-        }
-        try {
-            $payment_processor->set_revisit($this->checkout->revisit);
-            // generate payment object
-            $payment = $payment_processor->process_payment(
-                $payment_method,
-                $this->checkout->transaction,
-                $this->checkout->amount_owing,
-                $this->checkout->billing_form,
-                $this->_get_return_url($payment_method),
-                'CART',
-                $this->checkout->admin_request,
-                true,
-                $this->reg_step_url()
-            );
-        } catch (Exception $e) {
-            $this->_handle_payment_processor_exception($e);
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _handle_payment_processor_exception
-     *
-     * @access protected
-     * @param \Exception $e
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _handle_payment_processor_exception(Exception $e)
-    {
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
-                $e->getMessage(),
-                $e->getFile(),
-                $e->getLine()
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * _get_return_url
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_return_url(EE_Payment_Method $payment_method)
-    {
-        $return_url = '';
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite :
-                $return_url = add_query_arg(
-                    array(
-                        'action'                     => 'process_gateway_response',
-                        'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                        'spco_txn'                   => $this->checkout->transaction->ID(),
-                    ),
-                    $this->reg_step_url()
-                );
-                break;
-            case EE_PMT_Base::onsite :
-            case EE_PMT_Base::offline :
-                $return_url = $this->checkout->next_step->reg_step_url();
-                break;
-        }
-        return $return_url;
-    }
-
-
-    /**
-     * _validate_payment
-     *
-     * @access private
-     * @param EE_Payment $payment
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _validate_payment($payment = null)
-    {
-        if ($this->checkout->payment_method->is_off_line()) {
-            return true;
-        }
-        // verify payment object
-        if (! $payment instanceof EE_Payment) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _post_payment_processing
-     *
-     * @access private
-     * @param EE_Payment|bool $payment
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _post_payment_processing($payment = null)
-    {
-        // Off-Line payment?
-        if ($payment === true) {
-            //$this->_setup_redirect_for_next_step();
-            return true;
-            // On-Site payment?
-        } else if ($this->checkout->payment_method->is_on_site()) {
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
-                //$this->_setup_redirect_for_next_step();
-                $this->checkout->continue_reg = false;
-            }
-            // Off-Site payment?
-        } else if ($this->checkout->payment_method->is_off_site()) {
-            // if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
-            if ($payment instanceof EE_Payment && $payment->redirect_url()) {
-                do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
-                $this->checkout->redirect      = true;
-                $this->checkout->redirect_form = $payment->redirect_form();
-                $this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
-                // set JSON response
-                $this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
-                // set cron job for finalizing the TXN
-                // in case the user does not return from the off-site gateway
-                EE_Cron_Tasks::schedule_finalize_abandoned_transactions_check(
-                    EE_Registry::instance()->SSN->expiration() + 1,
-                    $this->checkout->transaction->ID()
-                );
-                // and lastly, let's bump the payment status to pending
-                $payment->set_status(EEM_Payment::status_id_pending);
-                $payment->save();
-            } else {
-                // not a payment
-                $this->checkout->continue_reg = false;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            // ummm ya... not Off-Line, not On-Site, not off-Site ????
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    _process_payment_status
-     *
-     * @access private
-     * @type    EE_Payment $payment
-     * @param string       $payment_occurs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
-    {
-        // off-line payment? carry on
-        if ($payment_occurs === EE_PMT_Base::offline) {
-            return true;
-        }
-        // verify payment validity
-        if ($payment instanceof EE_Payment) {
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
-            $msg = $payment->gateway_response();
-            // check results
-            switch ($payment->status()) {
-                // good payment
-                case EEM_Payment::status_id_approved :
-                    EE_Error::add_success(
-                        esc_html__('Your payment was processed successfully.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return true;
-                    break;
-                // slow payment
-                case EEM_Payment::status_id_pending :
-                    if (empty($msg)) {
-                        $msg = esc_html__(
-                            'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return true;
-                    break;
-                // don't wanna payment
-                case EEM_Payment::status_id_cancelled :
-                    if (empty($msg)) {
-                        $msg = _n(
-                            'Payment cancelled. Please try again.',
-                            'Payment cancelled. Please try again or select another method of payment.',
-                            count($this->checkout->available_payment_methods),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                    break;
-                // not enough payment
-                case EEM_Payment::status_id_declined :
-                    if (empty($msg)) {
-                        $msg = _n(
-                            'We\'re sorry but your payment was declined. Please try again.',
-                            'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
-                            count($this->checkout->available_payment_methods),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                    break;
-                // bad payment
-                case EEM_Payment::status_id_failed :
-                    if (! empty($msg)) {
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        return false;
-                    }
-                    // default to error below
-                    break;
-            }
-        }
-        // off-site payment gateway responses are too unreliable, so let's just assume that
-        // the payment processing is just running slower than the registrant's request
-        if ($payment_occurs === EE_PMT_Base::offsite) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /**********************************  PROCESS GATEWAY RESPONSE  **********************************/
-    /********************************************************************************************************/
-    /**
-     * process_gateway_response
-     * this is the return point for Off-Site Payment Methods
-     * It will attempt to "handle the IPN" if it appears that this has not already occurred,
-     * otherwise, it will load up the last payment made for the TXN.
-     * If the payment retrieved looks good, it will then either:
-     *    complete the current step and allow advancement to the next reg step
-     *        or present the payment options again
-     *
-     * @access private
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public function process_gateway_response()
-    {
-        $payment = null;
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        if (! $this->checkout->payment_method->is_off_site()) {
-            return false;
-        }
-        $this->_validate_offsite_return();
-        // DEBUG LOG
-        //$this->checkout->log(
-        //	__CLASS__, __FUNCTION__, __LINE__,
-        //	array(
-        //		'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-        //		'payment_method' => $this->checkout->payment_method,
-        //	),
-        //	true
-        //);
-        // verify TXN
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-            if (! $gateway instanceof EE_Offsite_Gateway) {
-                $this->checkout->continue_reg = false;
-                return false;
-            }
-            $payment = $this->_process_off_site_payment($gateway);
-            $payment = $this->_process_cancelled_payments($payment);
-            $payment = $this->_validate_payment($payment);
-            // if payment was not declined by the payment gateway or cancelled by the registrant
-            if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
-                //$this->_setup_redirect_for_next_step();
-                // store that for later
-                $this->checkout->payment = $payment;
-                // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
-                // because we will complete this step during the IPN processing then
-                if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
-                    $this->set_completed();
-                }
-                return true;
-            }
-        }
-        // DEBUG LOG
-        //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
-        //	array( 'payment' => $payment )
-        //);
-        $this->checkout->continue_reg = false;
-        return false;
-    }
-
-
-    /**
-     * _validate_return
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    private function _validate_offsite_return()
-    {
-        $TXN_ID = (int)EE_Registry::instance()->REQ->get('spco_txn', 0);
-        if ($TXN_ID !== $this->checkout->transaction->ID()) {
-            // Houston... we might have a problem
-            $invalid_TXN = false;
-            // first gather some info
-            $valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $primary_registrant = $valid_TXN instanceof EE_Transaction
-                ? $valid_TXN->primary_registration()
-                : null;
-            // let's start by retrieving the cart for this TXN
-            $cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
-            if ($cart instanceof EE_Cart) {
-                // verify that the current cart has tickets
-                $tickets = $cart->get_tickets();
-                if (empty($tickets)) {
-                    $invalid_TXN = true;
-                }
-            } else {
-                $invalid_TXN = true;
-            }
-            $valid_TXN_SID = $primary_registrant instanceof EE_Registration
-                ? $primary_registrant->session_ID()
-                : null;
-            // validate current Session ID and compare against valid TXN session ID
-            if (
-                $invalid_TXN // if this is already true, then skip other checks
-                || EE_Session::instance()->id() === null
-                || (
-                    // WARNING !!!
-                    // this could be PayPal sending back duplicate requests (ya they do that)
-                    // or it **could** mean someone is simply registering AGAIN after having just done so
-                    // so now we need to determine if this current TXN looks valid or not
-                    // and whether this reg step has even been started ?
-                    EE_Session::instance()->id() === $valid_TXN_SID
-                    // really? you're half way through this reg step, but you never started it ?
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
-                )
-            ) {
-                $invalid_TXN = true;
-            }
-            if ($invalid_TXN) {
-                // is the valid TXN completed ?
-                if ($valid_TXN instanceof EE_Transaction) {
-                    // has this step even been started ?
-                    $reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
-                    if ($reg_step_completed !== false && $reg_step_completed !== true) {
-                        // so it **looks** like this is a double request from PayPal
-                        // so let's try to pick up where we left off
-                        $this->checkout->transaction = $valid_TXN;
-                        $this->checkout->refresh_all_entities(true);
-                        return;
-                    }
-                }
-                // you appear to be lost?
-                $this->_redirect_wayward_request($primary_registrant);
-            }
-        }
-    }
-
-
-    /**
-     * _redirect_wayward_request
-     *
-     * @access private
-     * @param \EE_Registration|null $primary_registrant
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _redirect_wayward_request(EE_Registration $primary_registrant)
-    {
-        if (! $primary_registrant instanceof EE_Registration) {
-            // try redirecting based on the current TXN
-            $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
-                ? $this->checkout->transaction->primary_registration()
-                : null;
-        }
-        if (! $primary_registrant instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // make sure transaction is not locked
-        $this->checkout->transaction->unlock();
-        wp_safe_redirect(
-            add_query_arg(
-                array(
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
-                ),
-                $this->checkout->thank_you_page_url
-            )
-        );
-        exit();
-    }
-
-
-    /**
-     * _process_off_site_payment
-     *
-     * @access private
-     * @param \EE_Offsite_Gateway $gateway
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
-    {
-        try {
-            $request_data = \EE_Registry::instance()->REQ->params();
-            // if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
-            $this->set_handle_IPN_in_this_request(
-                $gateway->handle_IPN_in_this_request($request_data, false)
-            );
-            if ($this->handle_IPN_in_this_request()) {
-                // get payment details and process results
-                /** @type EE_Payment_Processor $payment_processor */
-                $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                $payment           = $payment_processor->process_ipn(
-                    $request_data,
-                    $this->checkout->transaction,
-                    $this->checkout->payment_method,
-                    true,
-                    false
-                );
-                //$payment_source = 'process_ipn';
-            } else {
-                $payment = $this->checkout->transaction->last_payment();
-                //$payment_source = 'last_payment';
-            }
-        } catch (Exception $e) {
-            // let's just eat the exception and try to move on using any previously set payment info
-            $payment = $this->checkout->transaction->last_payment();
-            //$payment_source = 'last_payment after Exception';
-            // but if we STILL don't have a payment object
-            if (! $payment instanceof EE_Payment) {
-                // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
-                $this->_handle_payment_processor_exception($e);
-            }
-        }
-        // DEBUG LOG
-        //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
-        //	array(
-        //		'process_ipn_payment' => $payment,
-        //		'payment_source'      => $payment_source,
-        //	)
-        //);
-        return $payment;
-    }
-
-
-    /**
-     * _process_cancelled_payments
-     * just makes sure that the payment status gets updated correctly
-     * so tha tan error isn't generated during payment validation
-     *
-     * @access private
-     * @param EE_Payment $payment
-     * @return EE_Payment | FALSE
-     * @throws \EE_Error
-     */
-    private function _process_cancelled_payments($payment = null)
-    {
-        if (
-            $payment instanceof EE_Payment
-            && isset($_REQUEST['ee_cancel_payment'])
-            && $payment->status() === EEM_Payment::status_id_failed
-        ) {
-            $payment->set_status(EEM_Payment::status_id_cancelled);
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    get_transaction_details_for_gateways
-     *
-     * @access    public
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_transaction_details_for_gateways()
-    {
-        $txn_details = array();
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $txn_details = array(
-                'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
-            );
-        }
-        // get EE_Payment_Method object
-        if (
-            empty($txn_details)
-            &&
-            ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
-        ) {
-            $txn_details = array(
-                'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                'error'                      => esc_html__(
-                    'A valid Payment Method could not be determined.',
-                    'event_espresso'
-                ),
-            );
-        }
-        if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
-            $return_url  = $this->_get_return_url($this->checkout->payment_method);
-            $txn_details = array(
-                'TXN_ID'         => $this->checkout->transaction->ID(),
-                'TXN_timestamp'  => $this->checkout->transaction->datetime(),
-                'TXN_total'      => $this->checkout->transaction->total(),
-                'TXN_paid'       => $this->checkout->transaction->paid(),
-                'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
-                'STS_ID'         => $this->checkout->transaction->status_ID(),
-                'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
-                'payment_amount' => $this->checkout->amount_owing,
-                'return_url'     => $return_url,
-                'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
-                    array(
-                        'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
-                        'ee_payment_method' => $this->checkout->payment_method->slug(),
-                    )
-                ),
-            );
-        }
-        echo wp_json_encode($txn_details);
-        exit();
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
-    }
+	/**
+	 * @access protected
+	 * @var EE_Line_Item_Display $Line_Item_Display
+	 */
+	protected $line_item_display;
+
+	/**
+	 * @access protected
+	 * @var boolean $handle_IPN_in_this_request
+	 */
+	protected $handle_IPN_in_this_request = false;
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		add_filter(
+			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
+		);
+		add_action(
+			'wp_ajax_switch_spco_billing_form',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
+		);
+		add_action(
+			'wp_ajax_nopriv_switch_spco_billing_form',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
+		);
+		add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
+		add_action(
+			'wp_ajax_nopriv_save_payer_details',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
+		);
+		add_action(
+			'wp_ajax_get_transaction_details_for_gateways',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
+		);
+		add_action(
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
+		);
+		add_filter(
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 *    ajax switch_spco_billing_form
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function switch_spco_billing_form()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
+	}
+
+
+	/**
+	 *    ajax save_payer_details
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function save_payer_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
+	}
+
+
+	/**
+	 *    ajax get_transaction_details
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function get_transaction_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
+	}
+
+
+	/**
+	 * bypass_recaptcha_for_load_payment_method
+	 *
+	 * @access public
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function bypass_recaptcha_for_load_payment_method()
+	{
+		return array(
+			'EESID'  => EE_Registry::instance()->SSN->id(),
+			'step'   => 'payment_options',
+			'action' => 'spco_billing_form',
+		);
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug     = 'payment_options';
+		$this->_name     = esc_html__('Payment Options', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+		$this->checkout  = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__(
+				'Please select a method of payment and provide any necessary billing information before proceeding.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+	/**
+	 * @return null
+	 */
+	public function line_item_display()
+	{
+		return $this->line_item_display;
+	}
+
+
+	/**
+	 * @param null $line_item_display
+	 */
+	public function set_line_item_display($line_item_display)
+	{
+		$this->line_item_display = $line_item_display;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function handle_IPN_in_this_request()
+	{
+		return $this->handle_IPN_in_this_request;
+	}
+
+
+	/**
+	 * @param boolean $handle_IPN_in_this_request
+	 */
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
+	{
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * translate_js_strings
+	 *
+	 * @return void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+			'Please select a method of payment in order to continue.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
+			'A valid method of payment could not be determined. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+			'Forwarding to Secure Payment Provider.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * enqueue_styles_and_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		$transaction = $this->checkout->transaction;
+		//if the transaction isn't set or nothing is owed on it, don't enqueue any JS
+		if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
+			return;
+		}
+		foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
+			$type_obj = $payment_method->type_obj();
+			if ($type_obj instanceof EE_PMT_Base) {
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
+				if ($billing_form instanceof EE_Form_Section_Proper) {
+					$billing_form->enqueue_js();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * initialize_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function initialize_reg_step()
+	{
+		// TODO: if /when we implement donations, then this will need overriding
+		if (// don't need payment options for:
+			// 	registrations made via the admin
+			// 	completed transactions
+			// 	overpaid transactions
+			// 	$ 0.00 transactions (no payment required)
+			! $this->checkout->payment_required()
+			// but do NOT remove if current action being called belongs to this reg step
+			&& ! is_callable(array($this, $this->checkout->action))
+			&& ! $this->completed()
+		) {
+			// and if so, then we no longer need the Payment Options step
+			if ($this->is_current_step()) {
+				$this->checkout->generate_reg_form = false;
+			}
+			$this->checkout->remove_reg_step($this->_slug);
+			// DEBUG LOG
+			//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		// load EEM_Payment_Method
+		EE_Registry::instance()->load_model('Payment_Method');
+		// get all active payment methods
+		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function generate_reg_form()
+	{
+		// reset in case someone changes their mind
+		$this->_reset_selected_method_of_payment();
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'payments_closed';
+		$registrations_requiring_payment            = array();
+		$registrations_for_free_events              = array();
+		$registrations_requiring_pre_approval       = array();
+		$sold_out_events                            = array();
+		$insufficient_spaces_available              = array();
+		$no_payment_required                        = true;
+		// loop thru registrations to gather info
+		$registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+			$registrations,
+			$this->checkout->revisit
+		);
+		foreach ($registrations as $REG_ID => $registration) {
+			/** @var $registration EE_Registration */
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[$REG_ID])) {
+				$insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
+				continue;
+			}
+			// event requires admin approval
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
+				// add event to list of events with pre-approval reg status
+				$registrations_requiring_pre_approval[$REG_ID] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			if ($this->checkout->revisit
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+				&& (
+					$registration->event()->is_sold_out()
+					|| $registration->event()->is_sold_out(true)
+				)
+			) {
+				// add event to list of events that are sold out
+				$sold_out_events[$registration->event()->ID()] = $registration->event();
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			// are they allowed to pay now and is there monies owing?
+			if ($registration->owes_monies_and_can_pay()) {
+				$registrations_requiring_payment[$REG_ID] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
+					$registration->event(),
+					$this
+				);
+			} elseif (! $this->checkout->revisit
+				&& $registration->status_ID() !== EEM_Registration::status_id_not_approved
+				&& $registration->ticket()->is_free()
+			) {
+				$registrations_for_free_events[$registration->event()->ID()] = $registration;
+			}
+		}
+		$subsections = array();
+		// now decide which template to load
+		if (! empty($sold_out_events)) {
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
+		}
+		if (! empty($insufficient_spaces_available)) {
+			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
+				$insufficient_spaces_available
+			);
+		}
+		if (! empty($registrations_requiring_pre_approval)) {
+			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
+				$registrations_requiring_pre_approval
+			);
+		}
+		if (! empty($registrations_for_free_events)) {
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
+		}
+		if (! empty($registrations_requiring_payment)) {
+			if ($this->checkout->amount_owing > 0) {
+				// autoload Line_Item_Display classes
+				EEH_Autoloader::register_line_item_filter_autoloaders();
+				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
+					apply_filters(
+						'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+						new EE_Line_Item_Filter_Collection()
+					),
+					$this->checkout->cart->get_grand_total()
+				);
+				/** @var EE_Line_Item $filtered_line_item_tree */
+				$filtered_line_item_tree = $line_item_filter_processor->process();
+				EEH_Autoloader::register_line_item_display_autoloaders();
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
+				$subsections['payment_options'] = $this->_display_payment_options(
+					$this->line_item_display->display_line_item(
+						$filtered_line_item_tree,
+						array('registrations' => $registrations)
+					)
+				);
+				$this->checkout->amount_owing   = $filtered_line_item_tree->total();
+				$this->_apply_registration_payments_to_amount_owing($registrations);
+			}
+			$no_payment_required = false;
+		} else {
+			$this->_hide_reg_step_submit_button_if_revisit();
+		}
+		$this->_save_selected_method_of_payment();
+
+		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
+		$subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
+
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => new EE_No_Layout(),
+			)
+		);
+	}
+
+
+	/**
+	 * add line item filters required for this reg step
+	 * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
+	 *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
+	 *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
+	 *        payment options reg step, can apply these filters via the following: apply_filters(
+	 *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
+	 *        filter collection by passing that instead of instantiating a new collection
+	 *
+	 * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
+	 * @return EE_Line_Item_Filter_Collection
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
+	{
+		if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+			return $line_item_filter_collection;
+		}
+		if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
+			return $line_item_filter_collection;
+		}
+		if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
+			return $line_item_filter_collection;
+		}
+		$line_item_filter_collection->add(
+			new EE_Billable_Line_Item_Filter(
+				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
+					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+					)
+				)
+			)
+		);
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
+		return $line_item_filter_collection;
+	}
+
+
+	/**
+	 * remove_ejected_registrations
+	 * if a registrant has lost their potential space at an event due to lack of payment,
+	 * then this method removes them from the list of registrations being paid for during this request
+	 *
+	 * @param \EE_Registration[] $registrations
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function remove_ejected_registrations(array $registrations)
+	{
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+			$registrations,
+			EE_Registry::instance()->SSN->checkout()->revisit
+		);
+		foreach ($registrations as $REG_ID => $registration) {
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[$REG_ID])) {
+				unset($registrations[$REG_ID]);
+				continue;
+			}
+		}
+		return $registrations;
+	}
+
+
+	/**
+	 * find_registrations_that_lost_their_space
+	 * If a registrant chooses an offline payment method like Invoice,
+	 * then no space is reserved for them at the event until they fully pay fo that site
+	 * (unless the event's default reg status is set to APPROVED)
+	 * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
+	 * then this method will determine which registrations have lost the ability to complete the reg process.
+	 *
+	 * @param \EE_Registration[] $registrations
+	 * @param bool               $revisit
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
+	{
+		// registrations per event
+		$event_reg_count = array();
+		// spaces left per event
+		$event_spaces_remaining = array();
+		// tickets left sorted by ID
+		$tickets_remaining = array();
+		// registrations that have lost their space
+		$ejected_registrations = array();
+		foreach ($registrations as $REG_ID => $registration) {
+			if ($registration->status_ID() === EEM_Registration::status_id_approved
+				|| apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
+					false,
+					$registration,
+					$revisit
+				)
+			) {
+				continue;
+			}
+			$EVT_ID = $registration->event_ID();
+			$ticket = $registration->ticket();
+			if (! isset($tickets_remaining[$ticket->ID()])) {
+				$tickets_remaining[$ticket->ID()] = $ticket->remaining();
+			}
+			if ($tickets_remaining[$ticket->ID()] > 0) {
+				if (! isset($event_reg_count[$EVT_ID])) {
+					$event_reg_count[$EVT_ID] = 0;
+				}
+				$event_reg_count[$EVT_ID]++;
+				if (! isset($event_spaces_remaining[$EVT_ID])) {
+					$event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
+				}
+			}
+			if ($revisit
+				&& ($tickets_remaining[$ticket->ID()] === 0
+					|| $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
+				)
+			) {
+				$ejected_registrations[$REG_ID] = $registration->event();
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
+					/** @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->manually_update_registration_status(
+						$registration,
+						EEM_Registration::status_id_wait_list
+					);
+				}
+			}
+		}
+		return $ejected_registrations;
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _adjust_registration_status_if_event_old_sold()
+	{
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _hide_reg_step_submit_button_if_revisit()
+	{
+		if ($this->checkout->revisit) {
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
+		}
+	}
+
+
+	/**
+	 * sold_out_events
+	 * displays notices regarding events that have sold out since hte registrant first signed up
+	 *
+	 * @param \EE_Event[] $sold_out_events_array
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _sold_out_events($sold_out_events_array = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'events_sold_out';
+		$sold_out_events                            = '';
+		foreach ($sold_out_events_array as $sold_out_event) {
+			$sold_out_events .= EEH_HTML::li(
+				EEH_HTML::span(
+					'  ' . $sold_out_event->name(),
+					'',
+					'dashicons dashicons-marker ee-icon-size-16 pink-text'
+				)
+			);
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							array(
+								'sold_out_events'     => $sold_out_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
+									sprintf(
+										esc_html__(
+											'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$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.%2$s',
+											'event_espresso'
+										),
+										'<strong>',
+										'</strong>',
+										'<br />'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _insufficient_spaces_available
+	 * displays notices regarding events that do not have enough remaining spaces
+	 * to satisfy the current number of registrations looking to pay
+	 *
+	 * @param \EE_Event[] $insufficient_spaces_events_array
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'invoice';
+		$insufficient_space_events                  = '';
+		foreach ($insufficient_spaces_events_array as $event) {
+			if ($event instanceof EE_Event) {
+				$insufficient_space_events .= EEH_HTML::li(
+					EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections'     => array(
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
+				),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
+							array(
+								'sold_out_events'     => $insufficient_space_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
+									esc_html__(
+										'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
+										'event_espresso'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * registrations_requiring_pre_approval
+	 *
+	 * @param array $registrations_requiring_pre_approval
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
+	{
+		$events_requiring_pre_approval = '';
+		foreach ($registrations_requiring_pre_approval as $registration) {
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
+				$events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
+					EEH_HTML::span(
+						'',
+						'',
+						'dashicons dashicons-marker ee-icon-size-16 orange-text'
+					)
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'events_requiring_pre_approval.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							array(
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
+								'events_requiring_pre_approval_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
+									esc_html__(
+										'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has 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'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _no_payment_required
+	 *
+	 * @param \EE_Event[] $registrations_for_free_events
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _no_payment_required($registrations_for_free_events = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
+		// generate no_payment_required form
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'no_payment_required.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
+							array(
+								'revisit'                       => $this->checkout->revisit,
+								'registrations'                 => array(),
+								'ticket_count'                  => array(),
+								'registrations_for_free_events' => $registrations_for_free_events,
+								'no_payment_required_msg'       => EEH_HTML::p(
+									esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _display_payment_options
+	 *
+	 * @param string $transaction_details
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _display_payment_options($transaction_details = '')
+	{
+		// has method_of_payment been set by no-js user?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
+		// build payment options form
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
+			new EE_Form_Section_Proper(
+				array(
+					'subsections'     => array(
+						'before_payment_options' => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
+							new EE_Form_Section_Proper(
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
+							)
+						),
+						'payment_options'        => $this->_setup_payment_options(),
+						'after_payment_options'  => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
+							new EE_Form_Section_Proper(
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
+							)
+						),
+					),
+					'layout_strategy' => new EE_Template_Layout(
+						array(
+							'layout_template_file' => $this->_template,
+							'template_args'        => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
+								array(
+									'reg_count'                 => $this->line_item_display->total_items(),
+									'transaction_details'       => $transaction_details,
+									'available_payment_methods' => array(),
+								)
+							),
+						)
+					),
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _extra_hidden_inputs
+	 *
+	 * @param bool $no_payment_required
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _extra_hidden_inputs($no_payment_required = true)
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'spco_no_payment_required' => new EE_Hidden_Input(
+						array(
+							'normalization_strategy' => new EE_Boolean_Normalization(),
+							'html_name'              => 'spco_no_payment_required',
+							'html_id'                => 'spco-no-payment-required-payment_options',
+							'default'                => $no_payment_required,
+						)
+					),
+					'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
+						array(
+							'normalization_strategy' => new EE_Int_Normalization(),
+							'html_name'              => 'spco_transaction_id',
+							'html_id'                => 'spco-transaction-id',
+							'default'                => $this->checkout->transaction->ID(),
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 *    _apply_registration_payments_to_amount_owing
+	 *
+	 * @access protected
+	 * @param array $registrations
+	 * @throws EE_Error
+	 */
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
+	{
+		$payments = array();
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
+				$payments += $registration->registration_payments();
+			}
+		}
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Registration_Payment) {
+					$this->checkout->amount_owing -= $payment->amount();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    _reset_selected_method_of_payment
+	 *
+	 * @access    private
+	 * @param    bool $force_reset
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _reset_selected_method_of_payment($force_reset = false)
+	{
+		$reset_payment_method = $force_reset
+			? true
+			: sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
+		if ($reset_payment_method) {
+			$this->checkout->selected_method_of_payment = null;
+			$this->checkout->payment_method             = null;
+			$this->checkout->billing_form               = null;
+			$this->_save_selected_method_of_payment();
+		}
+	}
+
+
+	/**
+	 * _save_selected_method_of_payment
+	 * stores the selected_method_of_payment in the session
+	 * so that it's available for all subsequent requests including AJAX
+	 *
+	 * @access        private
+	 * @param string $selected_method_of_payment
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _save_selected_method_of_payment($selected_method_of_payment = '')
+	{
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
+			? $selected_method_of_payment
+			: $this->checkout->selected_method_of_payment;
+		EE_Registry::instance()->SSN->set_session_data(
+			array('selected_method_of_payment' => $selected_method_of_payment)
+		);
+	}
+
+
+	/**
+	 * _setup_payment_options
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function _setup_payment_options()
+	{
+		// load payment method classes
+		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
+		if (empty($this->checkout->available_payment_methods)) {
+			EE_Error::add_error(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
+					sprintf(
+						esc_html__(
+							'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
+							'event_espresso'
+						),
+						'<br>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					)
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// switch up header depending on number of available payment methods
+		$payment_method_header     = count($this->checkout->available_payment_methods) > 1
+			? apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Please Select Your Method of Payment', 'event_espresso')
+			)
+			: apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Method of Payment', 'event_espresso')
+			);
+		$available_payment_methods = array(
+			// display the "Payment Method" header
+			'payment_method_header' => new EE_Form_Section_HTML(
+				EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
+			),
+		);
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
+		$available_payment_method_options = array();
+		$default_payment_method_option    = array();
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
+		$payment_methods_billing_info = array(
+			new EE_Form_Section_HTML(
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
+			),
+		);
+		// loop through payment methods
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$payment_method_button = EEH_HTML::img(
+					$payment_method->button_url(),
+					$payment_method->name(),
+					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+					'spco-payment-method-btn-img'
+				);
+				// check if any payment methods are set as default
+				// if payment method is already selected OR nothing is selected and this payment method should be
+				// open_by_default
+				if (($this->checkout->selected_method_of_payment === $payment_method->slug())
+					|| (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
+				) {
+					$this->checkout->selected_method_of_payment = $payment_method->slug();
+					$this->_save_selected_method_of_payment();
+					$default_payment_method_option[$payment_method->slug()] = $payment_method_button;
+				} else {
+					$available_payment_method_options[$payment_method->slug()] = $payment_method_button;
+				}
+				$payment_methods_billing_info[$payment_method->slug() . '-info'] = $this->_payment_method_billing_info(
+					$payment_method
+				);
+			}
+		}
+		// prepend available_payment_method_options with default_payment_method_option so that it appears first in list
+		// of PMs
+		$available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
+		// now generate the actual form  inputs
+		$available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
+			$available_payment_method_options
+		);
+		$available_payment_methods                              += $payment_methods_billing_info;
+		// build the available payment methods form
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'spco-available-methods-of-payment-dv',
+				'subsections'     => $available_payment_methods,
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+			)
+		);
+	}
+
+
+	/**
+	 * _get_available_payment_methods
+	 *
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_available_payment_methods()
+	{
+		if (! empty($this->checkout->available_payment_methods)) {
+			return $this->checkout->available_payment_methods;
+		}
+		$available_payment_methods = array();
+		// load EEM_Payment_Method
+		EE_Registry::instance()->load_model('Payment_Method');
+		/** @type EEM_Payment_Method $EEM_Payment_Method */
+		$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
+		// get all active payment methods
+		$payment_methods = $EEM_Payment_Method->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$available_payment_methods[$payment_method->slug()] = $payment_method;
+			}
+		}
+		return $available_payment_methods;
+	}
+
+
+	/**
+	 *    _available_payment_method_inputs
+	 *
+	 * @access    private
+	 * @param    array $available_payment_method_options
+	 * @return    \EE_Form_Section_Proper
+	 */
+	private function _available_payment_method_inputs($available_payment_method_options = array())
+	{
+		// generate inputs
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'ee-available-payment-method-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'' => new EE_Radio_Button_Input(
+						$available_payment_method_options,
+						array(
+							'html_name'          => 'selected_method_of_payment',
+							'html_class'         => 'spco-payment-method',
+							'default'            => $this->checkout->selected_method_of_payment,
+							'label_size'         => 11,
+							'enforce_label_size' => true,
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 *    _payment_method_billing_info
+	 *
+	 * @access    private
+	 * @param    EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
+	{
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
+			? true
+			: false;
+		// generate the billing form for payment method
+		$billing_form                 = $currently_selected
+			? $this->_get_billing_form_for_payment_method($payment_method)
+			: new EE_Form_Section_HTML();
+		$this->checkout->billing_form = $currently_selected
+			? $billing_form
+			: $this->checkout->billing_form;
+		// it's all in the details
+		$info_html = EEH_HTML::h3(
+			esc_html__('Important information regarding your payment', 'event_espresso'),
+			'',
+			'spco-payment-method-hdr'
+		);
+		// add some info regarding the step, either from what's saved in the admin,
+		// or a default string depending on whether the PM has a billing form or not
+		if ($payment_method->description()) {
+			$payment_method_info = $payment_method->description();
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
+			$payment_method_info = sprintf(
+				esc_html__(
+					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
+					'event_espresso'
+				),
+				$this->submit_button_text()
+			);
+		} else {
+			$payment_method_info = sprintf(
+				esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
+				$this->submit_button_text()
+			);
+		}
+		$info_html .= EEH_HTML::p(
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
+				$payment_method_info
+			),
+			'',
+			'spco-payment-method-desc ee-attention'
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+				'html_class'      => 'spco-payment-method-info-dv',
+				// only display the selected or default PM
+				'html_style'      => $currently_selected ? '' : 'display:none;',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'info'         => new EE_Form_Section_HTML($info_html),
+					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * get_billing_form_html_for_payment_method
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_billing_form_html_for_payment_method()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		$this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			return false;
+		}
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+			false
+		)) {
+			EE_Error::add_success(
+				apply_filters(
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// now generate billing form for selected method of payment
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
+		// fill form with attendee info if applicable
+		if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& $this->checkout->transaction_has_primary_registrant()
+		) {
+			$payment_method_billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if ($payment_method_billing_form instanceof EE_Billing_Info_Form
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+		) {
+			$payment_method_billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$payment_method_billing_form
+				);
+		}
+		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
+			? $payment_method_billing_form->get_html()
+			: '';
+		$this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
+		// localize validation rules for main form
+		$this->checkout->current_step->reg_form->localize_validation_rules();
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+		return true;
+	}
+
+
+	/**
+	 * _get_billing_form_for_payment_method
+	 *
+	 * @access private
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
+	{
+		$billing_form = $payment_method->type_obj()->billing_form(
+			$this->checkout->transaction,
+			array('amount_owing' => $this->checkout->amount_owing)
+		);
+		if ($billing_form instanceof EE_Billing_Info_Form) {
+			if (apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+				false
+			)
+				&& EE_Registry::instance()->REQ->is_set('payment_method')
+			) {
+				EE_Error::add_success(
+					apply_filters(
+						'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+						sprintf(
+							esc_html__(
+								'You have selected "%s" as your method of payment. Please note the important payment information below.',
+								'event_espresso'
+							),
+							$payment_method->name()
+						)
+					)
+				);
+			}
+			return apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+				$billing_form,
+				$payment_method
+			);
+		}
+		// no actual billing form, so return empty HTML form section
+		return new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * _get_selected_method_of_payment
+	 *
+	 * @access private
+	 * @param boolean $required whether to throw an error if the "selected_method_of_payment"
+	 *                          is not found in the incoming request
+	 * @param string  $request_param
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_selected_method_of_payment(
+		$required = false,
+		$request_param = 'selected_method_of_payment'
+	) {
+		// is selected_method_of_payment set in the request ?
+		$selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
+		if ($selected_method_of_payment) {
+			// sanitize it
+			$selected_method_of_payment = is_array($selected_method_of_payment)
+				? array_shift($selected_method_of_payment)
+				: $selected_method_of_payment;
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
+			// store it in the session so that it's available for all subsequent requests including AJAX
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
+		} else {
+			// or is is set in the session ?
+			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
+				'selected_method_of_payment'
+			);
+		}
+		// do ya really really gotta have it?
+		if (empty($selected_method_of_payment) && $required) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $selected_method_of_payment;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/***********************************  SWITCH PAYMENT METHOD  ************************************/
+	/********************************************************************************************************/
+	/**
+	 * switch_payment_method
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function switch_payment_method()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return false;
+		}
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+			false
+		)) {
+			EE_Error::add_success(
+				apply_filters(
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// generate billing form for selected method of payment if it hasn't been done already
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// fill form with attendee info if applicable
+		if (apply_filters(
+			'FHEE__populate_billing_form_fields_from_attendee',
+			(
+				$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $this->checkout->transaction_has_primary_registrant()
+			),
+			$this->checkout->billing_form,
+			$this->checkout->transaction
+		)
+		) {
+			$this->checkout->billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+		) {
+			$this->checkout->billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$this->checkout->billing_form
+				);
+		}
+		// get html and validation rules for form
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->json_response->set_return_data(
+				array('payment_method_info' => $this->checkout->billing_form->get_html())
+			);
+			// localize validation rules for main form
+			$this->checkout->billing_form->localize_validation_rules(true);
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+		} else {
+			$this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
+		}
+		//prevents advancement to next step
+		$this->checkout->continue_reg = false;
+		return true;
+	}
+
+
+	/**
+	 * _verify_payment_method_is_set
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _verify_payment_method_is_set()
+	{
+		// generate billing form for selected method of payment if it hasn't been done already
+		if (empty($this->checkout->selected_method_of_payment)) {
+			// how have they chosen to pay?
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		} else {
+			// choose your own adventure based on method_of_payment
+			switch ($this->checkout->selected_method_of_payment) {
+				case 'events_sold_out' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				case 'payments_closed' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				case 'no_payment_required' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				default:
+			}
+		}
+		// verify payment method
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			// get payment method for selected method of payment
+			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
+		}
+		return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
+	}
+
+
+
+	/********************************************************************************************************/
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * save_payer_details_via_ajax
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function save_payer_details_via_ajax()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return;
+		}
+		// generate billing form for selected method of payment if it hasn't been done already
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// generate primary attendee from payer info if applicable
+		if (! $this->checkout->transaction_has_primary_registrant()) {
+			$attendee = $this->_create_attendee_from_request_data();
+			if ($attendee instanceof EE_Attendee) {
+				foreach ($this->checkout->transaction->registrations() as $registration) {
+					if ($registration->is_primary_registrant()) {
+						$this->checkout->primary_attendee_obj = $attendee;
+						$registration->_add_relation_to($attendee, 'Attendee');
+						$registration->set_attendee_id($attendee->ID());
+						$registration->update_cache_after_object_save('Attendee', $attendee);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * create_attendee_from_request_data
+	 * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _create_attendee_from_request_data()
+	{
+		// get State ID
+		$STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
+		if (! empty($STA_ID)) {
+			// can we get state object from name ?
+			EE_Registry::instance()->load_model('State');
+			$state  = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
+		}
+		// get Country ISO
+		$CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
+		if (! empty($CNT_ISO)) {
+			// can we get country object from name ?
+			EE_Registry::instance()->load_model('Country');
+			$country = EEM_Country::instance()->get_col(
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
+				'CNT_ISO'
+			);
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
+		}
+		// grab attendee data
+		$attendee_data = array(
+			'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
+			'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
+			'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
+			'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
+			'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
+			'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
+			'STA_ID'       => $STA_ID,
+			'CNT_ISO'      => $CNT_ISO,
+			'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
+			'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
+		);
+		// validate the email address since it is the most important piece of info
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
+			EE_Error::add_error(
+				esc_html__('An invalid email address was submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// does this attendee already exist in the db ? we're searching using a combination of first name, last name,
+		// AND email address
+		if (! empty($attendee_data['ATT_fname'])
+			&& ! empty($attendee_data['ATT_lname'])
+			&& ! empty($attendee_data['ATT_email'])
+		) {
+			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
+				array(
+					'ATT_fname' => $attendee_data['ATT_fname'],
+					'ATT_lname' => $attendee_data['ATT_lname'],
+					'ATT_email' => $attendee_data['ATT_email'],
+				)
+			);
+			if ($existing_attendee instanceof EE_Attendee) {
+				return $existing_attendee;
+			}
+		}
+		// no existing attendee? kk let's create a new one
+		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those
+		// don't exist
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
+			? $attendee_data['ATT_fname']
+			: $attendee_data['ATT_email'];
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
+			? $attendee_data['ATT_lname']
+			: $attendee_data['ATT_email'];
+		return EE_Attendee::new_instance($attendee_data);
+	}
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  *****************************************/
+	/********************************************************************************************************/
+	/**
+	 * process_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function process_reg_step()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
+			? 'no_payment_required'
+			: $this->_get_selected_method_of_payment(true);
+		// choose your own adventure based on method_of_payment
+		switch ($this->checkout->selected_method_of_payment) {
+
+			case 'events_sold_out' :
+				$this->checkout->redirect     = true;
+				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+				// mark this reg step as completed
+				$this->set_completed();
+				return false;
+				break;
+
+			case 'payments_closed' :
+				if (apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
+					false
+				)) {
+					EE_Error::add_success(
+						esc_html__('no payment required at this time.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+				break;
+
+			case 'no_payment_required' :
+				if (apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
+					false
+				)) {
+					EE_Error::add_success(
+						esc_html__('no payment required.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+				break;
+
+			default:
+				$registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+					EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+				);
+				$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+					$registrations,
+					EE_Registry::instance()->SSN->checkout()->revisit
+				);
+				// calculate difference between the two arrays
+				$registrations = array_diff($registrations, $ejected_registrations);
+				if (empty($registrations)) {
+					$this->_redirect_because_event_sold_out();
+					return false;
+				}
+				$payment_successful = $this->_process_payment();
+				if ($payment_successful) {
+					$this->checkout->continue_reg = true;
+					$this->_maybe_set_completed($this->checkout->payment_method);
+				} else {
+					$this->checkout->continue_reg = false;
+				}
+				return $payment_successful;
+		}
+	}
+
+
+	/**
+	 * _redirect_because_event_sold_out
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _redirect_because_event_sold_out()
+	{
+		$this->checkout->continue_reg = false;
+		// set redirect URL
+		$this->checkout->redirect_url = add_query_arg(
+			array('e_reg_url_link' => $this->checkout->reg_url_link),
+			$this->checkout->current_step->reg_step_url()
+		);
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+	}
+
+
+	/**
+	 * _maybe_set_completed
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _maybe_set_completed(EE_Payment_Method $payment_method)
+	{
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite :
+				break;
+			case EE_PMT_Base::onsite :
+			case EE_PMT_Base::offline :
+				// mark this reg step as completed
+				$this->set_completed();
+				break;
+		}
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to retry a payment
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function update_reg_step()
+	{
+		$success = true;
+		// if payment required
+		if ($this->checkout->transaction->total() > 0) {
+			do_action(
+				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
+				$this->checkout->transaction
+			);
+			// attempt payment via payment method
+			$success = $this->process_reg_step();
+		}
+		if ($success && ! $this->checkout->redirect) {
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
+				$this->checkout->transaction->ID()
+			);
+			// set return URL
+			$this->checkout->redirect_url = add_query_arg(
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
+				$this->checkout->thank_you_page_url
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 *    _process_payment
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_payment()
+	{
+		// basically confirm that the event hasn't sold out since they hit the page
+		if (! $this->_last_second_ticket_verifications()) {
+			return false;
+		}
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$this->checkout->json_response->set_plz_select_method_of_payment(
+				esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
+			);
+			return false;
+		}
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			return false;
+		}
+		// setup billing form
+		if ($this->checkout->payment_method->is_on_site()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+			// bad billing form ?
+			if (! $this->_billing_form_is_valid()) {
+				return false;
+			}
+		}
+		// ensure primary registrant has been fully processed
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
+			return false;
+		}
+		// if session is close to expiring (under 10 minutes by default)
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
+			// add some time to session expiration so that payment can be completed
+			EE_Registry::instance()->SSN->extend_expiration();
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		//$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
+		// for events with a default reg status of Approved
+		// $transaction_processor->toggle_registration_statuses_for_default_approved_events(
+		//      $this->checkout->transaction, $this->checkout->reg_cache_where_params
+		// );
+		// attempt payment
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
+		// process results
+		$payment = $this->_validate_payment($payment);
+		$payment = $this->_post_payment_processing($payment);
+		// verify payment
+		if ($payment instanceof EE_Payment) {
+			// store that for later
+			$this->checkout->payment = $payment;
+			// 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();
+			$payment_status = $payment->status();
+			if (
+				$payment_status === EEM_Payment::status_id_approved
+				|| $payment_status === EEM_Payment::status_id_pending
+			) {
+				return true;
+			} else {
+				return false;
+			}
+		} else if ($payment === true) {
+			// please note that offline payment methods will NOT make a payment,
+			// but instead just mark themselves as the PMD_ID on the transaction, and return true
+			$this->checkout->payment = $payment;
+			return true;
+		}
+		// where's my money?
+		return false;
+	}
+
+
+	/**
+	 * _last_second_ticket_verifications
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _last_second_ticket_verifications()
+	{
+		// don't bother re-validating if not a return visit
+		if (! $this->checkout->revisit) {
+			return true;
+		}
+		$registrations = $this->checkout->transaction->registrations();
+		if (empty($registrations)) {
+			return false;
+		}
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$event = $registration->event_obj();
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
+					EE_Error::add_error(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
+							sprintf(
+								esc_html__(
+									'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
+									'event_espresso'
+								),
+								$event->name()
+							)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * redirect_form
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function redirect_form()
+	{
+		$payment_method_billing_info = $this->_payment_method_billing_info(
+			$this->_get_payment_method_for_selected_method_of_payment()
+		);
+		$html                        = $payment_method_billing_info->get_html();
+		$html                        .= $this->checkout->redirect_form;
+		EE_Registry::instance()->REQ->add_output($html);
+		return true;
+	}
+
+
+	/**
+	 * _billing_form_is_valid
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	private function _billing_form_is_valid()
+	{
+		if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
+			return true;
+		}
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
+			if ($this->checkout->billing_form->was_submitted()) {
+				$this->checkout->billing_form->receive_form_submission();
+				if ($this->checkout->billing_form->is_valid()) {
+					return true;
+				}
+				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
+				$error_strings     = array();
+				foreach ($validation_errors as $validation_error) {
+					if ($validation_error instanceof EE_Validation_Error) {
+						$form_section = $validation_error->get_form_section();
+						if ($form_section instanceof EE_Form_Input_Base) {
+							$label = $form_section->html_label_text();
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
+							$label = $form_section->name();
+						} else {
+							$label = esc_html__('Validation Error', 'event_espresso');
+						}
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
+					}
+				}
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
+							'event_espresso'
+						),
+						'<br/>',
+						implode('<br/>', $error_strings)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'The billing form was not submitted or something prevented it\'s submission.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * _setup_primary_registrant_prior_to_payment
+	 * ensures that the primary registrant has a valid attendee object created with the critical details populated
+	 * (first & last name & email) and that both the transaction object and primary registration object have been saved
+	 * plz note that any other registrations will NOT be saved at this point (because they may not have any details
+	 * yet)
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _setup_primary_registrant_prior_to_payment()
+	{
+		// check if transaction has a primary registrant and that it has a related Attendee object
+		// if not, then we need to at least gather some primary registrant data before attempting payment
+		if (
+			$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& ! $this->checkout->transaction_has_primary_registrant()
+			&& ! $this->_capture_primary_registration_data_from_billing_form()
+		) {
+			return false;
+		}
+		// because saving an object clears it's cache, we need to do the chevy shuffle
+		// grab the primary_registration object
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		// at this point we'll consider a TXN to not have been failed
+		$this->checkout->transaction->toggle_failed_transaction_status();
+		// save the TXN ( which clears cached copy of primary_registration)
+		$this->checkout->transaction->save();
+		// grab TXN ID and save it to the primary_registration
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
+		// save what we have so far
+		$primary_registration->save();
+		return true;
+	}
+
+
+	/**
+	 * _capture_primary_registration_data_from_billing_form
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _capture_primary_registration_data_from_billing_form()
+	{
+		// convert billing form data into an attendee
+		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
+		if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		if (! $primary_registration instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
+			  instanceof
+			  EE_Attendee
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__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($primary_registration);
+		return true;
+	}
+
+
+	/**
+	 * _get_payment_method_for_selected_method_of_payment
+	 * retrieves a valid payment method
+	 *
+	 * @access public
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_payment_method_for_selected_method_of_payment()
+	{
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
+			$this->_redirect_because_event_sold_out();
+			return null;
+		}
+		// get EE_Payment_Method object
+		if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
+			$payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
+		} else {
+			// load EEM_Payment_Method
+			EE_Registry::instance()->load_model('Payment_Method');
+			/** @type EEM_Payment_Method $EEM_Payment_Method */
+			$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
+			$payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
+		}
+		// verify $payment_method
+		if (! $payment_method instanceof EE_Payment_Method) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		// and verify it has a valid Payment_Method Type object
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 *    _attempt_payment
+	 *
+	 * @access    private
+	 * @type    EE_Payment_Method $payment_method
+	 * @return mixed EE_Payment | boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _attempt_payment(EE_Payment_Method $payment_method)
+	{
+		$payment = null;
+		$this->checkout->transaction->save();
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		if (! $payment_processor instanceof EE_Payment_Processor) {
+			return false;
+		}
+		try {
+			$payment_processor->set_revisit($this->checkout->revisit);
+			// generate payment object
+			$payment = $payment_processor->process_payment(
+				$payment_method,
+				$this->checkout->transaction,
+				$this->checkout->amount_owing,
+				$this->checkout->billing_form,
+				$this->_get_return_url($payment_method),
+				'CART',
+				$this->checkout->admin_request,
+				true,
+				$this->reg_step_url()
+			);
+		} catch (Exception $e) {
+			$this->_handle_payment_processor_exception($e);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _handle_payment_processor_exception
+	 *
+	 * @access protected
+	 * @param \Exception $e
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _handle_payment_processor_exception(Exception $e)
+	{
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
+				$e->getMessage(),
+				$e->getFile(),
+				$e->getLine()
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * _get_return_url
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_return_url(EE_Payment_Method $payment_method)
+	{
+		$return_url = '';
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite :
+				$return_url = add_query_arg(
+					array(
+						'action'                     => 'process_gateway_response',
+						'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+						'spco_txn'                   => $this->checkout->transaction->ID(),
+					),
+					$this->reg_step_url()
+				);
+				break;
+			case EE_PMT_Base::onsite :
+			case EE_PMT_Base::offline :
+				$return_url = $this->checkout->next_step->reg_step_url();
+				break;
+		}
+		return $return_url;
+	}
+
+
+	/**
+	 * _validate_payment
+	 *
+	 * @access private
+	 * @param EE_Payment $payment
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _validate_payment($payment = null)
+	{
+		if ($this->checkout->payment_method->is_off_line()) {
+			return true;
+		}
+		// verify payment object
+		if (! $payment instanceof EE_Payment) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _post_payment_processing
+	 *
+	 * @access private
+	 * @param EE_Payment|bool $payment
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _post_payment_processing($payment = null)
+	{
+		// Off-Line payment?
+		if ($payment === true) {
+			//$this->_setup_redirect_for_next_step();
+			return true;
+			// On-Site payment?
+		} else if ($this->checkout->payment_method->is_on_site()) {
+			if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+				//$this->_setup_redirect_for_next_step();
+				$this->checkout->continue_reg = false;
+			}
+			// Off-Site payment?
+		} else if ($this->checkout->payment_method->is_off_site()) {
+			// if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
+			if ($payment instanceof EE_Payment && $payment->redirect_url()) {
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
+				$this->checkout->redirect      = true;
+				$this->checkout->redirect_form = $payment->redirect_form();
+				$this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
+				// set JSON response
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
+				// set cron job for finalizing the TXN
+				// in case the user does not return from the off-site gateway
+				EE_Cron_Tasks::schedule_finalize_abandoned_transactions_check(
+					EE_Registry::instance()->SSN->expiration() + 1,
+					$this->checkout->transaction->ID()
+				);
+				// and lastly, let's bump the payment status to pending
+				$payment->set_status(EEM_Payment::status_id_pending);
+				$payment->save();
+			} else {
+				// not a payment
+				$this->checkout->continue_reg = false;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
+							'event_espresso'
+						),
+						'<br/>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			// ummm ya... not Off-Line, not On-Site, not off-Site ????
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    _process_payment_status
+	 *
+	 * @access private
+	 * @type    EE_Payment $payment
+	 * @param string       $payment_occurs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
+	{
+		// off-line payment? carry on
+		if ($payment_occurs === EE_PMT_Base::offline) {
+			return true;
+		}
+		// verify payment validity
+		if ($payment instanceof EE_Payment) {
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
+			$msg = $payment->gateway_response();
+			// check results
+			switch ($payment->status()) {
+				// good payment
+				case EEM_Payment::status_id_approved :
+					EE_Error::add_success(
+						esc_html__('Your payment was processed successfully.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return true;
+					break;
+				// slow payment
+				case EEM_Payment::status_id_pending :
+					if (empty($msg)) {
+						$msg = esc_html__(
+							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
+							'event_espresso'
+						);
+					}
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
+					return true;
+					break;
+				// don't wanna payment
+				case EEM_Payment::status_id_cancelled :
+					if (empty($msg)) {
+						$msg = _n(
+							'Payment cancelled. Please try again.',
+							'Payment cancelled. Please try again or select another method of payment.',
+							count($this->checkout->available_payment_methods),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+					break;
+				// not enough payment
+				case EEM_Payment::status_id_declined :
+					if (empty($msg)) {
+						$msg = _n(
+							'We\'re sorry but your payment was declined. Please try again.',
+							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
+							count($this->checkout->available_payment_methods),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+					break;
+				// bad payment
+				case EEM_Payment::status_id_failed :
+					if (! empty($msg)) {
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						return false;
+					}
+					// default to error below
+					break;
+			}
+		}
+		// off-site payment gateway responses are too unreliable, so let's just assume that
+		// the payment processing is just running slower than the registrant's request
+		if ($payment_occurs === EE_PMT_Base::offsite) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/**********************************  PROCESS GATEWAY RESPONSE  **********************************/
+	/********************************************************************************************************/
+	/**
+	 * process_gateway_response
+	 * this is the return point for Off-Site Payment Methods
+	 * It will attempt to "handle the IPN" if it appears that this has not already occurred,
+	 * otherwise, it will load up the last payment made for the TXN.
+	 * If the payment retrieved looks good, it will then either:
+	 *    complete the current step and allow advancement to the next reg step
+	 *        or present the payment options again
+	 *
+	 * @access private
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public function process_gateway_response()
+	{
+		$payment = null;
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		if (! $this->checkout->payment_method->is_off_site()) {
+			return false;
+		}
+		$this->_validate_offsite_return();
+		// DEBUG LOG
+		//$this->checkout->log(
+		//	__CLASS__, __FUNCTION__, __LINE__,
+		//	array(
+		//		'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+		//		'payment_method' => $this->checkout->payment_method,
+		//	),
+		//	true
+		//);
+		// verify TXN
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
+			if (! $gateway instanceof EE_Offsite_Gateway) {
+				$this->checkout->continue_reg = false;
+				return false;
+			}
+			$payment = $this->_process_off_site_payment($gateway);
+			$payment = $this->_process_cancelled_payments($payment);
+			$payment = $this->_validate_payment($payment);
+			// if payment was not declined by the payment gateway or cancelled by the registrant
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
+				//$this->_setup_redirect_for_next_step();
+				// store that for later
+				$this->checkout->payment = $payment;
+				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
+				// because we will complete this step during the IPN processing then
+				if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
+					$this->set_completed();
+				}
+				return true;
+			}
+		}
+		// DEBUG LOG
+		//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
+		//	array( 'payment' => $payment )
+		//);
+		$this->checkout->continue_reg = false;
+		return false;
+	}
+
+
+	/**
+	 * _validate_return
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	private function _validate_offsite_return()
+	{
+		$TXN_ID = (int)EE_Registry::instance()->REQ->get('spco_txn', 0);
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
+			// Houston... we might have a problem
+			$invalid_TXN = false;
+			// first gather some info
+			$valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$primary_registrant = $valid_TXN instanceof EE_Transaction
+				? $valid_TXN->primary_registration()
+				: null;
+			// let's start by retrieving the cart for this TXN
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
+			if ($cart instanceof EE_Cart) {
+				// verify that the current cart has tickets
+				$tickets = $cart->get_tickets();
+				if (empty($tickets)) {
+					$invalid_TXN = true;
+				}
+			} else {
+				$invalid_TXN = true;
+			}
+			$valid_TXN_SID = $primary_registrant instanceof EE_Registration
+				? $primary_registrant->session_ID()
+				: null;
+			// validate current Session ID and compare against valid TXN session ID
+			if (
+				$invalid_TXN // if this is already true, then skip other checks
+				|| EE_Session::instance()->id() === null
+				|| (
+					// WARNING !!!
+					// this could be PayPal sending back duplicate requests (ya they do that)
+					// or it **could** mean someone is simply registering AGAIN after having just done so
+					// so now we need to determine if this current TXN looks valid or not
+					// and whether this reg step has even been started ?
+					EE_Session::instance()->id() === $valid_TXN_SID
+					// really? you're half way through this reg step, but you never started it ?
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
+				)
+			) {
+				$invalid_TXN = true;
+			}
+			if ($invalid_TXN) {
+				// is the valid TXN completed ?
+				if ($valid_TXN instanceof EE_Transaction) {
+					// has this step even been started ?
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
+						// so it **looks** like this is a double request from PayPal
+						// so let's try to pick up where we left off
+						$this->checkout->transaction = $valid_TXN;
+						$this->checkout->refresh_all_entities(true);
+						return;
+					}
+				}
+				// you appear to be lost?
+				$this->_redirect_wayward_request($primary_registrant);
+			}
+		}
+	}
+
+
+	/**
+	 * _redirect_wayward_request
+	 *
+	 * @access private
+	 * @param \EE_Registration|null $primary_registrant
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _redirect_wayward_request(EE_Registration $primary_registrant)
+	{
+		if (! $primary_registrant instanceof EE_Registration) {
+			// try redirecting based on the current TXN
+			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
+				? $this->checkout->transaction->primary_registration()
+				: null;
+		}
+		if (! $primary_registrant instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// make sure transaction is not locked
+		$this->checkout->transaction->unlock();
+		wp_safe_redirect(
+			add_query_arg(
+				array(
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
+				),
+				$this->checkout->thank_you_page_url
+			)
+		);
+		exit();
+	}
+
+
+	/**
+	 * _process_off_site_payment
+	 *
+	 * @access private
+	 * @param \EE_Offsite_Gateway $gateway
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
+	{
+		try {
+			$request_data = \EE_Registry::instance()->REQ->params();
+			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
+			$this->set_handle_IPN_in_this_request(
+				$gateway->handle_IPN_in_this_request($request_data, false)
+			);
+			if ($this->handle_IPN_in_this_request()) {
+				// get payment details and process results
+				/** @type EE_Payment_Processor $payment_processor */
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+				$payment           = $payment_processor->process_ipn(
+					$request_data,
+					$this->checkout->transaction,
+					$this->checkout->payment_method,
+					true,
+					false
+				);
+				//$payment_source = 'process_ipn';
+			} else {
+				$payment = $this->checkout->transaction->last_payment();
+				//$payment_source = 'last_payment';
+			}
+		} catch (Exception $e) {
+			// let's just eat the exception and try to move on using any previously set payment info
+			$payment = $this->checkout->transaction->last_payment();
+			//$payment_source = 'last_payment after Exception';
+			// but if we STILL don't have a payment object
+			if (! $payment instanceof EE_Payment) {
+				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
+				$this->_handle_payment_processor_exception($e);
+			}
+		}
+		// DEBUG LOG
+		//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
+		//	array(
+		//		'process_ipn_payment' => $payment,
+		//		'payment_source'      => $payment_source,
+		//	)
+		//);
+		return $payment;
+	}
+
+
+	/**
+	 * _process_cancelled_payments
+	 * just makes sure that the payment status gets updated correctly
+	 * so tha tan error isn't generated during payment validation
+	 *
+	 * @access private
+	 * @param EE_Payment $payment
+	 * @return EE_Payment | FALSE
+	 * @throws \EE_Error
+	 */
+	private function _process_cancelled_payments($payment = null)
+	{
+		if (
+			$payment instanceof EE_Payment
+			&& isset($_REQUEST['ee_cancel_payment'])
+			&& $payment->status() === EEM_Payment::status_id_failed
+		) {
+			$payment->set_status(EEM_Payment::status_id_cancelled);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    get_transaction_details_for_gateways
+	 *
+	 * @access    public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_transaction_details_for_gateways()
+	{
+		$txn_details = array();
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$txn_details = array(
+				'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
+			);
+		}
+		// get EE_Payment_Method object
+		if (
+			empty($txn_details)
+			&&
+			! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
+		) {
+			$txn_details = array(
+				'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+				'error'                      => esc_html__(
+					'A valid Payment Method could not be determined.',
+					'event_espresso'
+				),
+			);
+		}
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
+			$return_url  = $this->_get_return_url($this->checkout->payment_method);
+			$txn_details = array(
+				'TXN_ID'         => $this->checkout->transaction->ID(),
+				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
+				'TXN_total'      => $this->checkout->transaction->total(),
+				'TXN_paid'       => $this->checkout->transaction->paid(),
+				'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
+				'STS_ID'         => $this->checkout->transaction->status_ID(),
+				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
+				'payment_amount' => $this->checkout->amount_owing,
+				'return_url'     => $return_url,
+				'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
+					array(
+						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
+						'ee_payment_method' => $this->checkout->payment_method->slug(),
+					)
+				),
+			);
+		}
+		echo wp_json_encode($txn_details);
+		exit();
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
+	}
 }

core/admin/EE_Admin_Page_Init.core.php

Indentation +8 added lines, -8 removed lines

@@ -153,18 +153,18 @@
 
 
 	/**
-     * This loads scripts and styles for the EE_Admin system
-     * that must be available on ALL WP admin pages (i.e. EE_menu items)
-     *
+	 * This loads scripts and styles for the EE_Admin system
+	 * that must be available on ALL WP admin pages (i.e. EE_menu items)
+	 *
 	 * @return void
 	 */
 	public function load_wp_global_scripts_styles() {
 		wp_register_style(
-		    'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
-            array('dashicons'),
-            EVENT_ESPRESSO_VERSION
-        );
+			'espresso_menu',
+			EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+			array('dashicons'),
+			EVENT_ESPRESSO_VERSION
+		);
 		wp_enqueue_style('espresso_menu');
 	}
 

Spacing +56 added lines, -56 removed lines

@@ -88,16 +88,16 @@ 
 		$this->_set_init_properties();
 
 		//global styles/scripts across all wp admin pages
-		add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5 );
+		add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5);
 
 		//load initial stuff.
 		$this->_set_file_and_folder_name();
 
 		$this->_set_menu_map();
 
-		if ( empty( $this->_menu_map ) || is_array( $this->_menu_map ) )
+		if (empty($this->_menu_map) || is_array($this->_menu_map))
 			 {
-			 	EE_Error::doing_it_wrong( get_class( $this ) . '::$_menu_map', sprintf( __('The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.', 'event_espresso' ), get_class( $this ) ), '4.4.0' );
+			 	EE_Error::doing_it_wrong(get_class($this).'::$_menu_map', sprintf(__('The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.', 'event_espresso'), get_class($this)), '4.4.0');
 			 	return;
 			 }
 
@@ -161,7 +161,7 @@ 
 	public function load_wp_global_scripts_styles() {
 		wp_register_style(
 		    'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+            EE_ADMIN_URL.'assets/admin-menu-styles.css',
             array('dashicons'),
             EVENT_ESPRESSO_VERSION
         );
@@ -193,8 +193,8 @@ 
 
 
 	protected function _set_capability() {
-		$capability = empty($this->capability) ?  $this->_menu_map->capability : $this->capability;
-		$this->capability = apply_filters( 'FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability );
+		$capability = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
+		$this->capability = apply_filters('FHEE_'.$this->_menu_map->menu_slug.'_capability', $capability);
 	}
 
 
@@ -212,7 +212,7 @@ 
 	public function initialize_admin_page() {
 		//let's check user access first
 		$this->_check_user_access();
-		if ( !is_object( $this->_loaded_page_object) ) return;
+		if ( ! is_object($this->_loaded_page_object)) return;
 		$this->_loaded_page_object->route_admin_request();
 		return;
 	}
@@ -224,25 +224,25 @@ 
 
 
 	public function set_page_dependencies($wp_page_slug) {
-		if ( !$this->_load_page ) return;
+		if ( ! $this->_load_page) return;
 
-		if ( !is_object($this->_loaded_page_object) ) {
+		if ( ! is_object($this->_loaded_page_object)) {
 			$msg[] = __('We can\'t load the page because we\'re missing a valid page object that tells us what to load', 'event_espresso');
-			$msg[] = $msg[0] . "\r\n" . sprintf(
+			$msg[] = $msg[0]."\r\n".sprintf(
 				__('The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory', 'event_espresso'),
 				 $this->_file_name,
 				 $this->_file_name,
-				 $this->_folder_path . $this->_file_name,
+				 $this->_folder_path.$this->_file_name,
 				 $this->_menu_map->menu_slug
 			);
-			throw new EE_Error( implode( '||', $msg) );
+			throw new EE_Error(implode('||', $msg));
 		}
 
 		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-		$page_hook = 'load-' . $wp_page_slug;
+		$page_hook = 'load-'.$wp_page_slug;
 		//hook into page load hook so all page specific stuff get's loaded.
-		if ( !empty($wp_page_slug) )
-			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies') );
+		if ( ! empty($wp_page_slug))
+			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
 	}
 
 
@@ -253,7 +253,7 @@ 
 	 */
 	public function do_initial_loads() {
 		//no loading or initializing if menu map is setup incorrectly.
-		if ( empty( $this->_menu_map ) || is_array( $this->_menu_map ) ) {
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
 			return;
 		}
 		$this->_initialize_admin_page();
@@ -270,19 +270,19 @@ 
 		$bt = debug_backtrace();
 		//for more reliable determination of folder name
 		//we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
-		$class = get_class( $this );
-		foreach ( $bt as $index => $values ) {
-			if ( isset( $values['class'] ) && $values['class'] == $class ) {
+		$class = get_class($this);
+		foreach ($bt as $index => $values) {
+			if (isset($values['class']) && $values['class'] == $class) {
 				$file_index = $index - 1;
-				$this->_folder_name = basename(dirname($bt[$file_index]['file']) );
-				if ( !empty( $this->_folder_name ) ) break;
+				$this->_folder_name = basename(dirname($bt[$file_index]['file']));
+				if ( ! empty($this->_folder_name)) break;
 			}
 		}
 
-		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . DS;
+		$this->_folder_path = EE_ADMIN_PAGES.$this->_folder_name.DS;
 
-		$this->_file_name = preg_replace( '/^ee/' , 'EE', $this->_folder_name );
-		$this->_file_name = ucwords( str_replace('_', ' ', $this->_file_name) );
+		$this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
+		$this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
 		$this->_file_name = str_replace(' ', '_', $this->_file_name);
 	}
 
@@ -294,19 +294,19 @@ 
 	 * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks files/classes
 	 * @return array
 	 */
-	public function register_hooks( $extend = FALSE ) {
+	public function register_hooks($extend = FALSE) {
 
 		//get a list of files in the directory that have the "Hook" in their name an
 
 		//if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
-		if ( $extend ) {
-			$hook_files_glob_path = apply_filters( 'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend', EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS . '*' . $this->_file_name . '_Hooks_Extend.class.php' );
-			$this->_hook_paths = $this->_register_hook_files( $hook_files_glob_path, $extend );
+		if ($extend) {
+			$hook_files_glob_path = apply_filters('FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend', EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.DS.'*'.$this->_file_name.'_Hooks_Extend.class.php');
+			$this->_hook_paths = $this->_register_hook_files($hook_files_glob_path, $extend);
 		}
 
 		//loop through decaf folders
-		$hook_files_glob_path = apply_filters( 'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path', $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php' );
-		$this->_hook_paths = array_merge( $this->_register_hook_files( $hook_files_glob_path ), $this->_hook_paths );  //making sure any extended hook paths are later in the array than the core hook paths!
+		$hook_files_glob_path = apply_filters('FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path', $this->_folder_path.'*'.$this->_file_name.'_Hooks.class.php');
+		$this->_hook_paths = array_merge($this->_register_hook_files($hook_files_glob_path), $this->_hook_paths); //making sure any extended hook paths are later in the array than the core hook paths!
 
 		return $this->_hook_paths;
 
@@ -314,27 +314,27 @@ 
 
 
 
-	protected function _register_hook_files( $hook_files_glob_path, $extend = FALSE ) {
+	protected function _register_hook_files($hook_files_glob_path, $extend = FALSE) {
 		$hook_paths = array();
-		if ( $hook_files = glob( $hook_files_glob_path ) ) {
-			if ( empty( $hook_files ) ) {
+		if ($hook_files = glob($hook_files_glob_path)) {
+			if (empty($hook_files)) {
 				return array();
 			}
-			foreach ( $hook_files as $file ) {
+			foreach ($hook_files as $file) {
 				//lets get the linked admin.
-				$hook_file = $extend ? str_replace( EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS, '', $file ) : str_replace($this->_folder_path, '', $file );
-				$replace = $extend ? '_' . $this->_file_name . '_Hooks_Extend.class.php' : '_' . $this->_file_name . '_Hooks.class.php';
-				$rel_admin = str_replace( $replace, '', $hook_file);
+				$hook_file = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.DS, '', $file) : str_replace($this->_folder_path, '', $file);
+				$replace = $extend ? '_'.$this->_file_name.'_Hooks_Extend.class.php' : '_'.$this->_file_name.'_Hooks.class.php';
+				$rel_admin = str_replace($replace, '', $hook_file);
 				$rel_admin = strtolower($rel_admin);
 				$hook_paths[] = $file;
 
 				//make sure we haven't already got a hook setup for this page path
-				if ( in_array( $rel_admin, $this->_files_hooked ) )
+				if (in_array($rel_admin, $this->_files_hooked))
 					continue;
 
 				$this->hook_file = $hook_file;
-				$rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
-				$filter = add_filter( $rel_admin_hook, array($this, 'load_admin_hook') );
+				$rel_admin_hook = 'FHEE_do_other_page_hooks_'.$rel_admin;
+				$filter = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
 				$this->_files_hooked[] = $rel_admin;
 			}
 		}
@@ -359,7 +359,7 @@ 
 	protected function _initialize_admin_page() {
 
 		//JUST CHECK WE'RE ON RIGHT PAGE.
-		if ( (!isset( $_REQUEST['page'] ) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing )
+		if (( ! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing)
 			return; //not on the right page so let's get out.
 		$this->_load_page = TRUE;
 
@@ -367,30 +367,30 @@ 
 //		spl_autoload_register(array( $this, 'set_autoloaders') );
 
 		//we don't need to do a page_request check here because it's only called via WP menu system.
-		$admin_page = $this->_file_name . '_Admin_Page';
-		$hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
+		$admin_page = $this->_file_name.'_Admin_Page';
+		$hook_suffix = $this->_menu_map->menu_slug.'_'.$admin_page;
 		$admin_page = apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}", $admin_page);
 
 		// define requested admin page class name then load the file and instantiate
-		$path_to_file = str_replace( array( '\\', '/' ), DS, $this->_folder_path . $admin_page . '.core.php' );
-		$path_to_file=apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",$path_to_file );//so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+		$path_to_file = str_replace(array('\\', '/'), DS, $this->_folder_path.$admin_page.'.core.php');
+		$path_to_file = apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}", $path_to_file); //so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
 
-		if ( is_readable( $path_to_file )) {
+		if (is_readable($path_to_file)) {
 			// This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
-			do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization' );
-			do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug );
-			require_once( $path_to_file );
-			$a = new ReflectionClass( $admin_page );
-			$this->_loaded_page_object = $a->newInstance( $this->_routing );
+			do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
+			do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_'.$this->_menu_map->menu_slug);
+			require_once($path_to_file);
+			$a = new ReflectionClass($admin_page);
+			$this->_loaded_page_object = $a->newInstance($this->_routing);
 		}
-		do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__after_initialization' );
-		do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug );
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_'.$this->_menu_map->menu_slug);
 	}
 
 
 
 	public function get_admin_page_name() {
-		return $this->_file_name . '_Admin_Page';
+		return $this->_file_name.'_Admin_Page';
 	}
 
 
@@ -422,8 +422,8 @@ 
 	 * @return bool|die true if pass (or admin) wp_die if fail
 	 */
 	private function _check_user_access() {
-		if ( ! EE_Registry::instance()->CAP->current_user_can( $this->_menu_map->capability, $this->_menu_map->menu_slug ) ) {
-			wp_die( __('You don\'t have access to this page.'), '', array( 'back_link' => true ) );
+		if ( ! EE_Registry::instance()->CAP->current_user_can($this->_menu_map->capability, $this->_menu_map->menu_slug)) {
+			wp_die(__('You don\'t have access to this page.'), '', array('back_link' => true));
 		}
 		return true;
 	}

core/libraries/form_sections/strategies/layout/EE_Div_Per_Section_Layout.strategy.php

Indentation +126 added lines, -126 removed lines

@@ -14,132 +14,132 @@
 class EE_Div_Per_Section_Layout extends EE_Form_Section_Layout_Base
 {
 
-    /**
-     * opening div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_begin()
-    {
-        return EEH_HTML::div(
-            '',
-            $this->_form_section->html_id(),
-            $this->_form_section->html_class(),
-            $this->_form_section->html_style()
-        );
-    }
-
-
-
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws \EE_Error
-     */
-    public function layout_input($input)
-    {
-        $html = '';
-        // set something unique for the id
-        $html_id = (string)$input->html_id() !== ''
-            ? (string)$input->html_id()
-            : spl_object_hash($input);
-        // and add a generic input type class
-        $html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-        } else if ($input instanceof EE_Submit_Input) {
-            $html .= EEH_HTML::div(
-                $input->get_html_for_input(),
-                $html_id . '-submit-dv',
-                "{$input->html_class()}-submit-dv {$html_class}"
-            );
-        } else if ($input instanceof EE_Select_Input) {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
-                "{$input->html_class()}-input-dv {$html_class}"
-            );
-        } else if ($input instanceof EE_Form_Input_With_Options_Base) {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
-                "{$input->html_class()}-input-dv {$html_class}"
-            );
-        } else {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
-                "{$input->html_class()}-input-dv {$html_class}"
-            );
-        }
-        return $html;
-    }
-
-
-
-    /**
-     *
-     * _display_label_for_option_type_question
-     * Gets the HTML for the 'label', which is just text for this (because labels
-     * should be for each input)
-     *
-     * @param EE_Form_Input_With_Options_Base $input
-     * @return string
-     */
-    protected function _display_label_for_option_type_question(EE_Form_Input_With_Options_Base $input)
-    {
-        if ($input->display_html_label_text() !== '') {
-            return EEH_HTML::div(
-                $input->required()
-                    ? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk')
-                    : $input->html_label_text(),
-                $input->html_label_id(),
-                $input->required()
-                    ? 'ee-required-label ' . $input->html_label_class()
-                    : $input->html_label_class(),
-                $input->html_label_style(),
-                $input->html_other_attributes()
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
-    }
-
-
-
-    /**
-     * closing div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_end()
-    {
-        return EEH_HTML::divx($this->_form_section->html_id(), $this->_form_section->html_class());
-    }
+	/**
+	 * opening div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_begin()
+	{
+		return EEH_HTML::div(
+			'',
+			$this->_form_section->html_id(),
+			$this->_form_section->html_class(),
+			$this->_form_section->html_style()
+		);
+	}
+
+
+
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function layout_input($input)
+	{
+		$html = '';
+		// set something unique for the id
+		$html_id = (string)$input->html_id() !== ''
+			? (string)$input->html_id()
+			: spl_object_hash($input);
+		// and add a generic input type class
+		$html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+		} else if ($input instanceof EE_Submit_Input) {
+			$html .= EEH_HTML::div(
+				$input->get_html_for_input(),
+				$html_id . '-submit-dv',
+				"{$input->html_class()}-submit-dv {$html_class}"
+			);
+		} else if ($input instanceof EE_Select_Input) {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl(1) . $input->get_html_for_label() .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$html_id . '-input-dv',
+				"{$input->html_class()}-input-dv {$html_class}"
+			);
+		} else if ($input instanceof EE_Form_Input_With_Options_Base) {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$html_id . '-input-dv',
+				"{$input->html_class()}-input-dv {$html_class}"
+			);
+		} else {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl(1) . $input->get_html_for_label() .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$html_id . '-input-dv',
+				"{$input->html_class()}-input-dv {$html_class}"
+			);
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 *
+	 * _display_label_for_option_type_question
+	 * Gets the HTML for the 'label', which is just text for this (because labels
+	 * should be for each input)
+	 *
+	 * @param EE_Form_Input_With_Options_Base $input
+	 * @return string
+	 */
+	protected function _display_label_for_option_type_question(EE_Form_Input_With_Options_Base $input)
+	{
+		if ($input->display_html_label_text() !== '') {
+			return EEH_HTML::div(
+				$input->required()
+					? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk')
+					: $input->html_label_text(),
+				$input->html_label_id(),
+				$input->required()
+					? 'ee-required-label ' . $input->html_label_class()
+					: $input->html_label_class(),
+				$input->html_label_style(),
+				$input->html_other_attributes()
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		//		d( $form_section );
+		return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+	}
+
+
+
+	/**
+	 * closing div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_end()
+	{
+		return EEH_HTML::divx($this->_form_section->html_id(), $this->_form_section->html_class());
+	}
 
 
 

Spacing +23 added lines, -23 removed lines

@@ -42,44 +42,44 @@ 
     {
         $html = '';
         // set something unique for the id
-        $html_id = (string)$input->html_id() !== ''
-            ? (string)$input->html_id()
+        $html_id = (string) $input->html_id() !== ''
+            ? (string) $input->html_id()
             : spl_object_hash($input);
         // and add a generic input type class
-        $html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv';
+        $html_class = sanitize_key(str_replace('_', '-', get_class($input))).'-dv';
         if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
         } else if ($input instanceof EE_Submit_Input) {
             $html .= EEH_HTML::div(
                 $input->get_html_for_input(),
-                $html_id . '-submit-dv',
+                $html_id.'-submit-dv',
                 "{$input->html_class()}-submit-dv {$html_class}"
             );
         } else if ($input instanceof EE_Select_Input) {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
+                EEH_HTML::nl(1).$input->get_html_for_label().
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $html_id.'-input-dv',
                 "{$input->html_class()}-input-dv {$html_class}"
             );
         } else if ($input instanceof EE_Form_Input_With_Options_Base) {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
+                EEH_HTML::nl().$this->_display_label_for_option_type_question($input).
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $html_id.'-input-dv',
                 "{$input->html_class()}-input-dv {$html_class}"
             );
         } else {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
+                EEH_HTML::nl(1).$input->get_html_for_label().
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $html_id.'-input-dv',
                 "{$input->html_class()}-input-dv {$html_class}"
             );
         }
@@ -102,11 +102,11 @@ 
         if ($input->display_html_label_text() !== '') {
             return EEH_HTML::div(
                 $input->required()
-                    ? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk')
+                    ? $input->html_label_text().EEH_HTML::span('*', '', 'ee-asterisk')
                     : $input->html_label_text(),
                 $input->html_label_id(),
                 $input->required()
-                    ? 'ee-required-label ' . $input->html_label_class()
+                    ? 'ee-required-label '.$input->html_label_class()
                     : $input->html_label_class(),
                 $input->html_label_style(),
                 $input->html_other_attributes()
@@ -126,7 +126,7 @@ 
     public function layout_subsection($form_section)
     {
         //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+        return EEH_HTML::nl(1).$form_section->get_html().EEH_HTML::nl(-1);
     }
 
 

core/db_classes/EE_Message_Template_Group.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -211,7 +211,7 @@
      * appropriately.
      *
      * @throws EE_Error
-     * @return EE_message_type|false if exception thrown.
+     * @return null|EE_message_type if exception thrown.
      */
     public function message_type_obj()
     {

Indentation +396 added lines, -396 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -13,400 +13,400 @@ 
 class EE_Message_Template_Group extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template_Group|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template_Group
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param bool $message_type
-     * @throws EE_Error
-     */
-    public function set_message_type($message_type = false)
-    {
-        if (! $message_type) {
-            throw new EE_Error(__('Missing required value for the message_type parameter', 'event_espresso'));
-        }
-        $this->set('MTP_message_type', $message_type);
-    }
-
-
-    /**
-     * @param bool $messenger
-     * @throws EE_Error
-     */
-    public function set_messenger($messenger = false)
-    {
-        if (! $messenger) {
-            throw new EE_Error(__('Missing required value for the messenger parameter', 'event_espresso'));
-        }
-        $this->set('MTP_messenger', $messenger);
-    }
-
-
-    /**
-     * @param bool $GRP_ID
-     * @throws EE_Error
-     */
-    public function set_group_template_id($GRP_ID = false)
-    {
-        if (! $GRP_ID) {
-            throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
-        }
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * get Group ID
-     *
-     * @access public
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * get User ID
-     *
-     * @access public
-     * @return int
-     */
-    public function user()
-    {
-        $user_id = $this->get('MTP_user_id');
-        return empty($user_id) ? get_current_user_id() : $user_id;
-    }
-
-
-    /**
-     * Wrapper for the user function() (preserve backward compat)
-     *
-     * @since  4.5.0
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->user();
-    }
-
-
-    /**
-     * This simply returns a count of all related events to this message template group
-     *
-     * @return int
-     */
-    public function count_events()
-    {
-        return $this->count_related('Event');
-    }
-
-
-    /**
-     * returns the name saved in the db for this template
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('MTP_name');
-    }
-
-
-    /**
-     * Returns the description saved in the db for this template group
-     *
-     * @return string
-     */
-    public function description()
-    {
-        return $this->get('MTP_description');
-    }
-
-
-    /**
-     * returns all related EE_Message_Template objects
-     *
-     * @param  array $query_params like EEM_Base::get_all()
-     * @return EE_Message_Template[]
-     */
-    public function message_templates($query_params = array())
-    {
-        return $this->get_many_related('Message_Template', $query_params);
-    }
-
-
-    /**
-     * get Message Messenger
-     *
-     * @access public
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get('MTP_messenger');
-    }
-
-
-    /**
-     * get Message Messenger OBJECT
-     * If an attempt to get the corresponding messenger object fails, then we set this message
-     * template group to inactive, and save to db.  Then return null so client code can handle
-     * appropriately.
-     *
-     * @return EE_messenger
-     */
-    public function messenger_obj()
-    {
-        $messenger = $this->messenger();
-        try {
-            $messenger = EEH_MSG_Template::messenger_obj($messenger);
-        } catch (EE_Error $e) {
-            //if an exception was thrown then let's deactivate this message template group because it means there is no class for this messenger in this group.
-            $this->set('MTP_is_active', false);
-            $this->save();
-            return null;
-        }
-        return $messenger;
-    }
-
-
-    /**
-     * get Message Type
-     *
-     * @access public
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get('MTP_message_type');
-    }
-
-
-    /**
-     * get Message type OBJECT
-     * If an attempt to get the corresponding message type object fails, then we set this message
-     * template group to inactive, and save to db.  Then return null so client code can handle
-     * appropriately.
-     *
-     * @throws EE_Error
-     * @return EE_message_type|false if exception thrown.
-     */
-    public function message_type_obj()
-    {
-        $message_type = $this->message_type();
-        try {
-            $message_type = EEH_MSG_Template::message_type_obj($message_type);
-        } catch (EE_Error $e) {
-            //if an exception was thrown then let's deactivate this message template group because it means there is no class for the message type in this group.
-            $this->set('MTP_is_active', false);
-            $this->save();
-            return null;
-        }
-        return $message_type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function contexts_config()
-    {
-        return $this->message_type_obj()->get_contexts();
-    }
-
-
-    /**
-     * This returns the context_label for contexts as set in the message type object
-     * Note this is an array with singular and plural keys
-     *
-     * @access public
-     * @return array labels for "context"
-     */
-    public function context_label()
-    {
-        $obj = $this->message_type_obj();
-        return $obj->get_context_label();
-    }
-
-
-    /**
-     * This returns an array of EE_Message_Template objects indexed by context and field.
-     *
-     * @return array()
-     */
-    public function context_templates()
-    {
-        $mtps_arr = array();
-        $mtps     = $this->get_many_related('Message_Template');
-        if (empty($mtps)) {
-            return array();
-        }
-        //note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
-        foreach ($mtps as $mtp) {
-            $mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
-        }
-        return $mtps_arr;
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is global
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_global()
-    {
-        return $this->get('MTP_is_global');
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_active()
-    {
-        return $this->get('MTP_is_active');
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
-     * this template.
-     *
-     * @since 4.3.0
-     * @uses  EEH_MSG_Template::get_shortcodes()
-     * @param string $context what context we're going to return shortcodes for
-     * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
-     *                        to be returned.
-     * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the
-     *                        unique shortcodes for all the given (or all) fields.
-     * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
-     *               shortcodes found.
-     */
-    public function get_shortcodes($context, $fields = array(), $merged = false)
-    {
-        $messenger    = $this->messenger();
-        $message_type = $this->message_type();
-        return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
-    }
-
-
-
-    /**
-     * this just returns and array of instantiated shortcode objects given an array of object refs
-     *
-     * @access private
-     * @param $sc_refs
-     * @throws EE_Error
-     * @return array    an array of EE_Shortcode objects
-     */
-    //private function _get_shortcode_objects( $sc_refs ) {
-    //	$sc_objs = array();
-    //	EED_Messages::set_autoloaders();
-    //	foreach ( $sc_refs as $shortcode_ref ) {
-    //		$ref = ucwords( str_replace( '_', ' ', $shortcode_ref ) );
-    //		$ref = str_replace( ' ', '_', $ref );
-    //		$classname = 'EE_' . $ref . '_Shortcodes';
-    //		if ( ! class_exists( $classname ) ) {
-    //			$msg[ ] = __( 'Shortcode library loading fail.', 'event_espresso' );
-    //			$msg[ ] = sprintf( __( 'The class name checked was "%s". Please check the spelling and case of this reference and make sure it matches the appropriate shortcode library file name (minus the extension) in the "/library/shortcodes/" directory', 'event_espresso' ), $classname );
-    //			throw new EE_Error( implode( '||', $msg ) );
-    //		}
-    //		$a = new ReflectionClass( $classname );
-    //		$sc_objs[ ] = $a->newInstance();
-    //	}
-    //	return $sc_objs;
-    //}
-
-
-    /**
-     * This just gets the template pack name assigned to this message template group.  If it's not set, then we just
-     * use the default template pack.
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    public function get_template_pack_name()
-    {
-        return $this->get_extra_meta('MTP_template_pack', true, 'default');
-    }
-
-
-    /**
-     * This returns the specific template pack object referenced by the template pack name attached to this message
-     * template group.  If no template pack is assigned then the default template pack is retrieved.
-     *
-     * @since 4.5.0
-     * @return EE_Messages_Template_Pack
-     */
-    public function get_template_pack()
-    {
-        $pack_name = $this->get_template_pack_name();
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_template_pack($pack_name);
-    }
-
-
-    /**
-     * This retrieves the template variation assigned to this message template group.  If it's not set, then we just
-     * use the default template variation.
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    public function get_template_pack_variation()
-    {
-        return $this->get_extra_meta('MTP_variation', true, 'default');
-    }
-
-
-    /**
-     * This just sets the template pack name attached to this message template group.
-     *
-     * @since 4.5.0
-     * @param string $template_pack_name What message template pack is assigned.
-     * @return int
-     */
-    public function set_template_pack_name($template_pack_name)
-    {
-        return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
-    }
-
-
-    /**
-     * This just sets the template pack variation attached to this message template group.
-     *
-     * @since 4.5.0
-     * @param string $variation What variation is being set on the message template group.
-     * @return int
-     */
-    public function set_template_pack_variation($variation)
-    {
-        return $this->update_extra_meta('MTP_variation', $variation);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template_Group|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template_Group
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param bool $message_type
+	 * @throws EE_Error
+	 */
+	public function set_message_type($message_type = false)
+	{
+		if (! $message_type) {
+			throw new EE_Error(__('Missing required value for the message_type parameter', 'event_espresso'));
+		}
+		$this->set('MTP_message_type', $message_type);
+	}
+
+
+	/**
+	 * @param bool $messenger
+	 * @throws EE_Error
+	 */
+	public function set_messenger($messenger = false)
+	{
+		if (! $messenger) {
+			throw new EE_Error(__('Missing required value for the messenger parameter', 'event_espresso'));
+		}
+		$this->set('MTP_messenger', $messenger);
+	}
+
+
+	/**
+	 * @param bool $GRP_ID
+	 * @throws EE_Error
+	 */
+	public function set_group_template_id($GRP_ID = false)
+	{
+		if (! $GRP_ID) {
+			throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
+		}
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * get Group ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * get User ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function user()
+	{
+		$user_id = $this->get('MTP_user_id');
+		return empty($user_id) ? get_current_user_id() : $user_id;
+	}
+
+
+	/**
+	 * Wrapper for the user function() (preserve backward compat)
+	 *
+	 * @since  4.5.0
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->user();
+	}
+
+
+	/**
+	 * This simply returns a count of all related events to this message template group
+	 *
+	 * @return int
+	 */
+	public function count_events()
+	{
+		return $this->count_related('Event');
+	}
+
+
+	/**
+	 * returns the name saved in the db for this template
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('MTP_name');
+	}
+
+
+	/**
+	 * Returns the description saved in the db for this template group
+	 *
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->get('MTP_description');
+	}
+
+
+	/**
+	 * returns all related EE_Message_Template objects
+	 *
+	 * @param  array $query_params like EEM_Base::get_all()
+	 * @return EE_Message_Template[]
+	 */
+	public function message_templates($query_params = array())
+	{
+		return $this->get_many_related('Message_Template', $query_params);
+	}
+
+
+	/**
+	 * get Message Messenger
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get('MTP_messenger');
+	}
+
+
+	/**
+	 * get Message Messenger OBJECT
+	 * If an attempt to get the corresponding messenger object fails, then we set this message
+	 * template group to inactive, and save to db.  Then return null so client code can handle
+	 * appropriately.
+	 *
+	 * @return EE_messenger
+	 */
+	public function messenger_obj()
+	{
+		$messenger = $this->messenger();
+		try {
+			$messenger = EEH_MSG_Template::messenger_obj($messenger);
+		} catch (EE_Error $e) {
+			//if an exception was thrown then let's deactivate this message template group because it means there is no class for this messenger in this group.
+			$this->set('MTP_is_active', false);
+			$this->save();
+			return null;
+		}
+		return $messenger;
+	}
+
+
+	/**
+	 * get Message Type
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get('MTP_message_type');
+	}
+
+
+	/**
+	 * get Message type OBJECT
+	 * If an attempt to get the corresponding message type object fails, then we set this message
+	 * template group to inactive, and save to db.  Then return null so client code can handle
+	 * appropriately.
+	 *
+	 * @throws EE_Error
+	 * @return EE_message_type|false if exception thrown.
+	 */
+	public function message_type_obj()
+	{
+		$message_type = $this->message_type();
+		try {
+			$message_type = EEH_MSG_Template::message_type_obj($message_type);
+		} catch (EE_Error $e) {
+			//if an exception was thrown then let's deactivate this message template group because it means there is no class for the message type in this group.
+			$this->set('MTP_is_active', false);
+			$this->save();
+			return null;
+		}
+		return $message_type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function contexts_config()
+	{
+		return $this->message_type_obj()->get_contexts();
+	}
+
+
+	/**
+	 * This returns the context_label for contexts as set in the message type object
+	 * Note this is an array with singular and plural keys
+	 *
+	 * @access public
+	 * @return array labels for "context"
+	 */
+	public function context_label()
+	{
+		$obj = $this->message_type_obj();
+		return $obj->get_context_label();
+	}
+
+
+	/**
+	 * This returns an array of EE_Message_Template objects indexed by context and field.
+	 *
+	 * @return array()
+	 */
+	public function context_templates()
+	{
+		$mtps_arr = array();
+		$mtps     = $this->get_many_related('Message_Template');
+		if (empty($mtps)) {
+			return array();
+		}
+		//note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
+		foreach ($mtps as $mtp) {
+			$mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
+		}
+		return $mtps_arr;
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is global
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_global()
+	{
+		return $this->get('MTP_is_global');
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_active()
+	{
+		return $this->get('MTP_is_active');
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
+	 * this template.
+	 *
+	 * @since 4.3.0
+	 * @uses  EEH_MSG_Template::get_shortcodes()
+	 * @param string $context what context we're going to return shortcodes for
+	 * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
+	 *                        to be returned.
+	 * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the
+	 *                        unique shortcodes for all the given (or all) fields.
+	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
+	 *               shortcodes found.
+	 */
+	public function get_shortcodes($context, $fields = array(), $merged = false)
+	{
+		$messenger    = $this->messenger();
+		$message_type = $this->message_type();
+		return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
+	}
+
+
+
+	/**
+	 * this just returns and array of instantiated shortcode objects given an array of object refs
+	 *
+	 * @access private
+	 * @param $sc_refs
+	 * @throws EE_Error
+	 * @return array    an array of EE_Shortcode objects
+	 */
+	//private function _get_shortcode_objects( $sc_refs ) {
+	//	$sc_objs = array();
+	//	EED_Messages::set_autoloaders();
+	//	foreach ( $sc_refs as $shortcode_ref ) {
+	//		$ref = ucwords( str_replace( '_', ' ', $shortcode_ref ) );
+	//		$ref = str_replace( ' ', '_', $ref );
+	//		$classname = 'EE_' . $ref . '_Shortcodes';
+	//		if ( ! class_exists( $classname ) ) {
+	//			$msg[ ] = __( 'Shortcode library loading fail.', 'event_espresso' );
+	//			$msg[ ] = sprintf( __( 'The class name checked was "%s". Please check the spelling and case of this reference and make sure it matches the appropriate shortcode library file name (minus the extension) in the "/library/shortcodes/" directory', 'event_espresso' ), $classname );
+	//			throw new EE_Error( implode( '||', $msg ) );
+	//		}
+	//		$a = new ReflectionClass( $classname );
+	//		$sc_objs[ ] = $a->newInstance();
+	//	}
+	//	return $sc_objs;
+	//}
+
+
+	/**
+	 * This just gets the template pack name assigned to this message template group.  If it's not set, then we just
+	 * use the default template pack.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	public function get_template_pack_name()
+	{
+		return $this->get_extra_meta('MTP_template_pack', true, 'default');
+	}
+
+
+	/**
+	 * This returns the specific template pack object referenced by the template pack name attached to this message
+	 * template group.  If no template pack is assigned then the default template pack is retrieved.
+	 *
+	 * @since 4.5.0
+	 * @return EE_Messages_Template_Pack
+	 */
+	public function get_template_pack()
+	{
+		$pack_name = $this->get_template_pack_name();
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($pack_name);
+	}
+
+
+	/**
+	 * This retrieves the template variation assigned to this message template group.  If it's not set, then we just
+	 * use the default template variation.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	public function get_template_pack_variation()
+	{
+		return $this->get_extra_meta('MTP_variation', true, 'default');
+	}
+
+
+	/**
+	 * This just sets the template pack name attached to this message template group.
+	 *
+	 * @since 4.5.0
+	 * @param string $template_pack_name What message template pack is assigned.
+	 * @return int
+	 */
+	public function set_template_pack_name($template_pack_name)
+	{
+		return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
+	}
+
+
+	/**
+	 * This just sets the template pack variation attached to this message template group.
+	 *
+	 * @since 4.5.0
+	 * @param string $variation What variation is being set on the message template group.
+	 * @return int
+	 */
+	public function set_template_pack_variation($variation)
+	{
+		return $this->update_extra_meta('MTP_variation', $variation);
+	}
 }
 //end EE_Message_Template_Group class

Spacing +4 added lines, -4 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -42,7 +42,7 @@ 
      */
     public function set_message_type($message_type = false)
     {
-        if (! $message_type) {
+        if ( ! $message_type) {
             throw new EE_Error(__('Missing required value for the message_type parameter', 'event_espresso'));
         }
         $this->set('MTP_message_type', $message_type);
@@ -55,7 +55,7 @@ 
      */
     public function set_messenger($messenger = false)
     {
-        if (! $messenger) {
+        if ( ! $messenger) {
             throw new EE_Error(__('Missing required value for the messenger parameter', 'event_espresso'));
         }
         $this->set('MTP_messenger', $messenger);
@@ -68,7 +68,7 @@ 
      */
     public function set_group_template_id($GRP_ID = false)
     {
-        if (! $GRP_ID) {
+        if ( ! $GRP_ID) {
             throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
         }
         $this->set('GRP_ID', $GRP_ID);