eventespresso / event-espresso-core

core/libraries/messages/EE_Message_Repository.lib.php

Indentation +251 added lines, -251 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,256 +16,256 @@ 
 {
 
 
-    /**
-     *    EE_Message_Repository constructor
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message';
-        parent::__construct();
-    }
-
-
-    /**
-     * Add the EE_Message to the repository.
-     * This also ensures that the MSG_token is saves as a part of the info for retrieval.
-     *
-     * @param EE_Message $message
-     * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
-     * @return bool
-     */
-    public function add($message, $info = null)
-    {
-        $attached = parent::add($message);
-        //ensure $info is an array if not already
-        $info = $info === null ? $info = array() : (array)$info;
-        $data = $this->_init_data($info, $attached, $message);
-        if ($attached) {
-            $this->set_info($message, $data);
-        }
-        return $attached;
-    }
-
-
-    /**
-     * Initializes the data from the incoming info.
-     *
-     * @param array      $info     incoming data.
-     * @param bool       $attached Indicates whether the object was attached successfully.
-     * @param EE_Message $message
-     * @return array
-     */
-    protected function _init_data($info, $attached, $message)
-    {
-        $data = array(
-            'test_send'               => false,
-            'preview'                 => false,
-            'data_handler_class_name' => '',
-            'data'                    => array(
-                'MSG_generation_data' => array(),
-            ),
-        );
-        if (isset($info['preview'])) {
-            $data['preview'] = $info['preview'];
-            unset($info['preview']);
-        }
-        if (isset($info['test_send'])) {
-            $data['test_send'] = $info['test_send'];
-            unset($info['test_send']);
-        }
-        if (isset($info['data_handler_class_name'])) {
-            $data['data_handler_class_name'] = $info['data_handler_class_name'];
-            unset($info['data_handler_class_name']);
-        }
-        if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
-            $generation_data = isset($info['MSG_generation_data']) ? $info['MSG_generation_data'] : array();
-            //if data isn't in $info...let's see if its available via the message object
-            $generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
-            //still empty then let's just use info
-            $generation_data                     = ! $generation_data ? $info : $generation_data;
-            $data['data']['MSG_generation_data'] = $generation_data;
-        }
-        return $data;
-    }
-
-
-    /**
-     * Save all EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only  When true, only the hooks related to saving are fired.
-     * @return array array(
-     *                  'updated' => 0, //count of how many messages updated
-     *                  'notupdated' => 0, //count of how many messages not updated.
-     *                  'errors' => array( $token ), //array of message object tokens that had errors in saving
-     *                  )
-     */
-    public function saveAll($do_hooks_only = false)
-    {
-        $save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
-
-        if (! $do_hooks_only) {
-            $this->rewind();
-            //exit early if there is nothing to save.
-            if ($this->count() < 1) {
-                return $save_tracking;
-            }
-
-            while ($this->valid()) {
-                $saved = $this->current()->save();
-                if ($saved === false) {
-                    $save_tracking['errors'][] = $this->current()->MSG_token();
-                } elseif ($saved) {
-                    $save_tracking['updated']++;
-                } else {
-                    $save_tracking['notupdated']++;
-                }
-                //maybe persist generation data if this is an incomplete EE_Message.
-                $this->_maybe_persist_attached_data();
-
-                $this->next();
-            }
-        }
-        do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
-        return $save_tracking;
-    }
-
-
-    /**
-     * Retrieves a EE_Message from the repository that matches the given token.
-     *
-     * @param string $token Token.
-     * @return EE_Message | null
-     */
-    public function getMessageByToken($token)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->MSG_token() === $token) {
-                $message = $this->current();
-                $this->rewind();
-                return $message;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
-     *
-     * @return array();
-     */
-    public function get_generation_data()
-    {
-        //first verify we're at a valid iterator point.
-        if ( ! $this->valid()) {
-            return array();
-        }
-        $info = $this->getInfo();
-        return isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
-    }
-
-
-    /**
-     * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
-     *
-     * @return string
-     */
-    public function get_data_handler()
-    {
-        if ( ! $this->valid()) {
-            return '';
-        }
-        $info = $this->getInfo();
-        return isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
-    }
-
-
-    /**
-     * Returns whether this EE_Message is for a preview or not.
-     *
-     * @return bool
-     */
-    public function is_preview()
-    {
-        if ( ! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return $info['preview'];
-    }
-
-
-    /**
-     * Returns whether the current message pointed to is for a test send.
-     *
-     * @return bool
-     */
-    public function is_test_send()
-    {
-        if ( ! $this->valid()) {
-            return false;
-        }
-        $info = $this->getInfo();
-        return $info['test_send'];
-    }
-
-
-    /**
-     *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
-     *  data is attached for later retrieval (batch generation).
-     */
-    protected function _maybe_persist_attached_data()
-    {
-        if ( ! $this->valid()) {
-            return;
-        }
-
-        $info                    = $this->getInfo();
-        $data_handler_class_name = isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
-        $data                    = isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
-        if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
-            $this->current()->set_generation_data($data);
-            $this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
-        }
-    }
-
-
-    /**
-     * This method returns a count of messages in the repository that have a given priority.
-     *
-     * @param int   $priority the priority that is being filtered for the count.
-     * @param array $status   the optional status(es) that will also be filtered by when priority matches.
-     * @return int  count of messages in the queue matching the conditions.
-     */
-    public function count_by_priority_and_status($priority, $status = array())
-    {
-        if ( ! empty($status)) {
-            $status = is_array($status) ? $status : array($status);
-        }
-
-        $count = 0;
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->priority() === $priority && (($status && in_array($this->current()->STS_ID(),
-                            $status)) || ! $status)
-            ) {
-                $count++;
-            }
-            $this->next();
-        }
-        return $count;
-    }
-
-
-    /**
-     * @return EE_Message
-     */
-    public function current()
-    {
-        return parent::current();
-    }
+	/**
+	 *    EE_Message_Repository constructor
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message';
+		parent::__construct();
+	}
+
+
+	/**
+	 * Add the EE_Message to the repository.
+	 * This also ensures that the MSG_token is saves as a part of the info for retrieval.
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $info Any included data is saved in the attached object info array indexed by 'data'
+	 * @return bool
+	 */
+	public function add($message, $info = null)
+	{
+		$attached = parent::add($message);
+		//ensure $info is an array if not already
+		$info = $info === null ? $info = array() : (array)$info;
+		$data = $this->_init_data($info, $attached, $message);
+		if ($attached) {
+			$this->set_info($message, $data);
+		}
+		return $attached;
+	}
+
+
+	/**
+	 * Initializes the data from the incoming info.
+	 *
+	 * @param array      $info     incoming data.
+	 * @param bool       $attached Indicates whether the object was attached successfully.
+	 * @param EE_Message $message
+	 * @return array
+	 */
+	protected function _init_data($info, $attached, $message)
+	{
+		$data = array(
+			'test_send'               => false,
+			'preview'                 => false,
+			'data_handler_class_name' => '',
+			'data'                    => array(
+				'MSG_generation_data' => array(),
+			),
+		);
+		if (isset($info['preview'])) {
+			$data['preview'] = $info['preview'];
+			unset($info['preview']);
+		}
+		if (isset($info['test_send'])) {
+			$data['test_send'] = $info['test_send'];
+			unset($info['test_send']);
+		}
+		if (isset($info['data_handler_class_name'])) {
+			$data['data_handler_class_name'] = $info['data_handler_class_name'];
+			unset($info['data_handler_class_name']);
+		}
+		if ($attached && $message->STS_ID() === EEM_Message::status_incomplete) {
+			$generation_data = isset($info['MSG_generation_data']) ? $info['MSG_generation_data'] : array();
+			//if data isn't in $info...let's see if its available via the message object
+			$generation_data = ! $generation_data ? $message->get_generation_data() : $generation_data;
+			//still empty then let's just use info
+			$generation_data                     = ! $generation_data ? $info : $generation_data;
+			$data['data']['MSG_generation_data'] = $generation_data;
+		}
+		return $data;
+	}
+
+
+	/**
+	 * Save all EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only  When true, only the hooks related to saving are fired.
+	 * @return array array(
+	 *                  'updated' => 0, //count of how many messages updated
+	 *                  'notupdated' => 0, //count of how many messages not updated.
+	 *                  'errors' => array( $token ), //array of message object tokens that had errors in saving
+	 *                  )
+	 */
+	public function saveAll($do_hooks_only = false)
+	{
+		$save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
+
+		if (! $do_hooks_only) {
+			$this->rewind();
+			//exit early if there is nothing to save.
+			if ($this->count() < 1) {
+				return $save_tracking;
+			}
+
+			while ($this->valid()) {
+				$saved = $this->current()->save();
+				if ($saved === false) {
+					$save_tracking['errors'][] = $this->current()->MSG_token();
+				} elseif ($saved) {
+					$save_tracking['updated']++;
+				} else {
+					$save_tracking['notupdated']++;
+				}
+				//maybe persist generation data if this is an incomplete EE_Message.
+				$this->_maybe_persist_attached_data();
+
+				$this->next();
+			}
+		}
+		do_action('AHEE__EE_Message_Repository__saveAll__after', $save_tracking, $this, $do_hooks_only);
+		return $save_tracking;
+	}
+
+
+	/**
+	 * Retrieves a EE_Message from the repository that matches the given token.
+	 *
+	 * @param string $token Token.
+	 * @return EE_Message | null
+	 */
+	public function getMessageByToken($token)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->MSG_token() === $token) {
+				$message = $this->current();
+				$this->rewind();
+				return $message;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * This retrieves any data required for generation that may be saved with the current EE_Message in storage.
+	 *
+	 * @return array();
+	 */
+	public function get_generation_data()
+	{
+		//first verify we're at a valid iterator point.
+		if ( ! $this->valid()) {
+			return array();
+		}
+		$info = $this->getInfo();
+		return isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
+	}
+
+
+	/**
+	 * Retrieves the data_handler_class_name or reference associated with the current EE_Message object in the iterator.
+	 *
+	 * @return string
+	 */
+	public function get_data_handler()
+	{
+		if ( ! $this->valid()) {
+			return '';
+		}
+		$info = $this->getInfo();
+		return isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
+	}
+
+
+	/**
+	 * Returns whether this EE_Message is for a preview or not.
+	 *
+	 * @return bool
+	 */
+	public function is_preview()
+	{
+		if ( ! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return $info['preview'];
+	}
+
+
+	/**
+	 * Returns whether the current message pointed to is for a test send.
+	 *
+	 * @return bool
+	 */
+	public function is_test_send()
+	{
+		if ( ! $this->valid()) {
+			return false;
+		}
+		$info = $this->getInfo();
+		return $info['test_send'];
+	}
+
+
+	/**
+	 *  This checks if the current EE_Message in the iterator is incomplete. If it is, then
+	 *  data is attached for later retrieval (batch generation).
+	 */
+	protected function _maybe_persist_attached_data()
+	{
+		if ( ! $this->valid()) {
+			return;
+		}
+
+		$info                    = $this->getInfo();
+		$data_handler_class_name = isset($info['data_handler_class_name']) ? $info['data_handler_class_name'] : '';
+		$data                    = isset($info['data']) && isset($info['data']['MSG_generation_data']) ? $info['data']['MSG_generation_data'] : array();
+		if ($data && $this->current()->STS_ID() === EEM_Message::status_incomplete) {
+			$this->current()->set_generation_data($data);
+			$this->current()->set_field_or_extra_meta('data_handler_class_name', $data_handler_class_name);
+		}
+	}
+
+
+	/**
+	 * This method returns a count of messages in the repository that have a given priority.
+	 *
+	 * @param int   $priority the priority that is being filtered for the count.
+	 * @param array $status   the optional status(es) that will also be filtered by when priority matches.
+	 * @return int  count of messages in the queue matching the conditions.
+	 */
+	public function count_by_priority_and_status($priority, $status = array())
+	{
+		if ( ! empty($status)) {
+			$status = is_array($status) ? $status : array($status);
+		}
+
+		$count = 0;
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->priority() === $priority && (($status && in_array($this->current()->STS_ID(),
+							$status)) || ! $status)
+			) {
+				$count++;
+			}
+			$this->next();
+		}
+		return $count;
+	}
+
+
+	/**
+	 * @return EE_Message
+	 */
+	public function current()
+	{
+		return parent::current();
+	}
 
 
 }
\ No newline at end of file

Spacing +3 added lines, -3 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -38,7 +38,7 @@ 
     {
         $attached = parent::add($message);
         //ensure $info is an array if not already
-        $info = $info === null ? $info = array() : (array)$info;
+        $info = $info === null ? $info = array() : (array) $info;
         $data = $this->_init_data($info, $attached, $message);
         if ($attached) {
             $this->set_info($message, $data);
@@ -103,7 +103,7 @@ 
     {
         $save_tracking = array('updated' => 0, 'notupdated' => 0, 'errors' => array());
 
-        if (! $do_hooks_only) {
+        if ( ! $do_hooks_only) {
             $this->rewind();
             //exit early if there is nothing to save.
             if ($this->count() < 1) {

core/db_models/EEM_Event.model.php

Spacing +9 added lines, -9 removed lines

@@ -1,7 +1,7 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
-require_once(EE_MODELS . 'EEM_CPT_Base.model.php');
+require_once(EE_MODELS.'EEM_CPT_Base.model.php');
 
 
 
@@ -59,7 +59,7 @@ 
     public static function instance($timezone = null)
     {
         // check if instance of EEM_Event already exists
-        if (! self::$_instance instanceof EEM_Event) {
+        if ( ! self::$_instance instanceof EEM_Event) {
             // instantiate Espresso_model
             self::$_instance = new self($timezone);
         }
@@ -249,7 +249,7 @@ 
      */
     public function get_all_event_question_groups($EVT_ID = 0)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -278,7 +278,7 @@ 
      */
     public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -310,7 +310,7 @@ 
      */
     public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
@@ -714,7 +714,7 @@ 
         $questions = array();
         // get all question groups for event
         $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
+        if ( ! empty($qgs)) {
             foreach ($qgs as $qg) {
                 $qsts = $qg->questions();
                 $questions[$qg->ID()] = $qg->model_field_array();
@@ -732,7 +732,7 @@ 
                     $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
                     $qst_name = $qstn_id = $qst->ID();
                     $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+                    $qst_name = ! empty($ans_id) ? '['.$qst_name.']['.$ans_id.']' : '['.$qst_name.']';
                     $input_name = '';
                     $input_id = sanitize_key($qst->display_text());
                     $input_class = '';
@@ -740,7 +740,7 @@ 
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
                                                                                            . $input_name
                                                                                            . $qst_name;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id.'-'.$qstn_id;
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;

Doc Comments +1 added lines, -1 removed lines

@@ -217,7 +217,7 @@
 
     /**
      * Used to override the default for the additional limit field.
-     * @param $additional_limit
+     * @param integer $additional_limit
      */
     public static function set_default_additional_limit($additional_limit)
     {

Indentation +788 added lines, -788 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 require_once(EE_MODELS . 'EEM_CPT_Base.model.php');
 
@@ -16,793 +16,793 @@ 
 class EEM_Event extends EEM_CPT_Base
 {
 
-    /**
-     * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
-     * event
-     */
-    const sold_out = 'sold_out';
-
-    /**
-     * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
-     * date)
-     */
-    const postponed = 'postponed';
-
-    /**
-     * constant used by status(), indicating that the event will no longer occur
-     */
-    const cancelled = 'cancelled';
-
-
-    /**
-     * @var string
-     */
-    protected static $_default_reg_status;
-
-
-    /**
-     * This is the default for the additional limit field.
-     * @var int
-     */
-    protected static $_default_additional_limit = 10;
-
-
-    /**
-     * private instance of the Event object
-     *
-     * @var EEM_Event
-     */
-    protected static $_instance;
-
-
-
-    /**
-     *  This function is a singleton method used to instantiate the EEM_Event object
-     *
-     * @param string $timezone
-     * @return EEM_Event
-     * @throws \EE_Error
-     */
-    public static function instance($timezone = null)
-    {
-        // check if instance of EEM_Event already exists
-        if (! self::$_instance instanceof EEM_Event) {
-            // instantiate Espresso_model
-            self::$_instance = new self($timezone);
-        }
-        //we might have a timezone set, let set_timezone decide what to do with it
-        self::$_instance->set_timezone($timezone);
-        // EEM_Event object
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        EE_Registry::instance()->load_model('Registration');
-        $this->singular_item = esc_html__('Event', 'event_espresso');
-        $this->plural_item = esc_html__('Events', 'event_espresso');
-        // to remove Cancelled events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
-        // to remove Postponed events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
-        // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
-        //	add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati = apply_filters(
-            'AFEE__EEM_Event__construct___custom_stati',
-            array(
-                EEM_Event::cancelled => array(
-                    'label'  => esc_html__('Cancelled', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
-                ),
-                EEM_Event::postponed => array(
-                    'label'  => esc_html__('Postponed', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
-                ),
-                EEM_Event::sold_out  => array(
-                    'label'  => esc_html__('Sold Out', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
-                ),
-            )
-        );
-        self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
-            : self::$_default_reg_status;
-        $this->_tables = array(
-            'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
-        );
-        $this->_fields = array(
-            'Event_CPT'  => array(
-                'EVT_ID'         => new EE_Primary_Key_Int_Field('ID',
-                    esc_html__('Post ID for Event', 'event_espresso')),
-                'EVT_name'       => new EE_Plain_Text_Field('post_title', esc_html__('Event Name', 'event_espresso'),
-                    false,
-                    ''),
-                'EVT_desc'       => new EE_Post_Content_Field('post_content',
-                    esc_html__('Event Description', 'event_espresso'),
-                    false, ''),
-                'EVT_slug'       => new EE_Slug_Field('post_name', esc_html__('Event Slug', 'event_espresso'), false,
-                    ''),
-                'EVT_created'    => new EE_Datetime_Field('post_date',
-                    esc_html__('Date/Time Event Created', 'event_espresso'),
-                    false, EE_Datetime_Field::now),
-                'EVT_short_desc' => new EE_Simple_HTML_Field('post_excerpt',
-                    esc_html__('Event Short Description', 'event_espresso'), false, ''),
-                'EVT_modified'   => new EE_Datetime_Field('post_modified',
-                    esc_html__('Date/Time Event Modified', 'event_espresso'), false, EE_Datetime_Field::now),
-                'EVT_wp_user'    => new EE_WP_User_Field('post_author',
-                    esc_html__('Event Creator ID', 'event_espresso'),
-                    false),
-                'parent'         => new EE_Integer_Field('post_parent', esc_html__('Event Parent ID', 'event_espresso'),
-                    false,
-                    0),
-                'EVT_order'      => new EE_Integer_Field('menu_order', esc_html__('Event Menu Order', 'event_espresso'),
-                    false,
-                    1),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
-                // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
-                'status'         => new EE_WP_Post_Status_Field('post_status',
-                    esc_html__('Event Status', 'event_espresso'),
-                    false, 'draft', $this->_custom_stati),
-            ),
-            'Event_Meta' => array(
-                'EVTM_ID'                         => new EE_DB_Only_Float_Field('EVTM_ID',
-                    esc_html__('Event Meta Row ID', 'event_espresso'), false),
-                'EVT_ID_fk'                       => new EE_DB_Only_Int_Field('EVT_ID',
-                    esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), false),
-                'EVT_display_desc'                => new EE_Boolean_Field('EVT_display_desc',
-                    esc_html__('Display Description Flag', 'event_espresso'), false, 1),
-                'EVT_display_ticket_selector'     => new EE_Boolean_Field('EVT_display_ticket_selector',
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso'), false, 1),
-                'EVT_visible_on'                  => new EE_Datetime_Field('EVT_visible_on',
-                    esc_html__('Event Visible Date', 'event_espresso'), true, EE_Datetime_Field::now),
-                'EVT_additional_limit'            => new EE_Integer_Field(
-                    'EVT_additional_limit',
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                    true,
-                    self::$_default_additional_limit
-                ),
-                'EVT_default_registration_status' => new EE_Enum_Text_Field(
-                    'EVT_default_registration_status',
-                    esc_html__('Default Registration Status on this Event', 'event_espresso'), false,
-                    EEM_Event::$_default_reg_status, EEM_Registration::reg_status_array()
-                ),
-                'EVT_member_only'                 => new EE_Boolean_Field('EVT_member_only',
-                    esc_html__('Member-Only Event Flag', 'event_espresso'), false, false),
-                'EVT_phone'                       => new EE_Plain_Text_Field('EVT_phone',
-                    esc_html__('Event Phone Number', 'event_espresso'), false),
-                'EVT_allow_overflow'              => new EE_Boolean_Field('EVT_allow_overflow',
-                    esc_html__('Allow Overflow on Event', 'event_espresso'), false, false),
-                'EVT_timezone_string'             => new EE_Plain_Text_Field('EVT_timezone_string',
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'), false),
-                'EVT_external_URL'                => new EE_Plain_Text_Field('EVT_external_URL',
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true),
-                'EVT_donations'                   => new EE_Boolean_Field('EVT_donations',
-                    esc_html__('Accept Donations?', 'event_espresso'), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            'WP_User'                => new EE_Belongs_To_Relation(),
-        );
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * @param string $default_reg_status
-     */
-    public static function set_default_reg_status($default_reg_status)
-    {
-        self::$_default_reg_status = $default_reg_status;
-        // if EEM_Event has already been instantiated,
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
-        if (self::$_instance instanceof EEM_Event) {
-            $default_reg_status = new EE_Enum_Text_Field(
-                'EVT_default_registration_status',
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                false,
-                $default_reg_status,
-                EEM_Registration::reg_status_array()
-            );
-            $default_reg_status->_construct_finalize(
-                'Event_Meta',
-                'EVT_default_registration_status',
-                'EEM_Event'
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
-        }
-    }
-
-
-    /**
-     * Used to override the default for the additional limit field.
-     * @param $additional_limit
-     */
-    public static function set_default_additional_limit($additional_limit)
-    {
-        self::$_default_additional_limit = (int) $additional_limit;
-        if (self::$_instance instanceof EEM_Event) {
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
-                'EVT_additional_limit',
-                __('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                true,
-                self::$_default_additional_limit
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
-                'Event_Meta',
-                'EVT_additional_limit',
-                'EEM_Event'
-            );
-        }
-    }
-
-
-    /**
-     * Return what is currently set as the default additional limit for the event.
-     * @return int
-     */
-    public static function get_default_additional_limit()
-    {
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function get_all_question_groups()
-    {
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            array(
-                array('QSG_deleted' => false),
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_all_event_question_groups($EVT_ID = 0)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            array(
-                array('EVT_ID' => $EVT_ID),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int     $EVT_ID
-     * @param boolean $for_primary_attendee
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            array(
-                array(
-                    'EVT_ID'      => $EVT_ID,
-                    'EQG_primary' => $for_primary_attendee,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int             $EVT_ID
-     * @param EE_Registration $registration
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        $where_params = array(
-            'Event_Question_Group.EVT_ID'      => $EVT_ID,
-            'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
-            'QSG_deleted'                      => false,
-        );
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            array(
-                $where_params,
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_target_db_column
-     *
-     * @param string $QSG_IDs csv list of $QSG IDs
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_questions_in_groups($QSG_IDs = '')
-    {
-        if (empty($QSG_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question')->get_all(
-            array(
-                array(
-                    'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
-                    'QST_deleted'           => false,
-                    'QST_admin_only'        => is_admin(),
-                ),
-                'order_by' => 'QST_order',
-            )
-        );
-    }
-
-
-
-    /**
-     * get_options_for_question
-     *
-     * @param string $QST_IDs csv list of $QST IDs
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_options_for_question($QST_IDs)
-    {
-        if (empty($QST_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Option')->get_all(
-            array(
-                array(
-                    'Question.QST_ID' => array('IN', $QST_IDs),
-                    'QSO_deleted'     => false,
-                ),
-                'order_by' => 'QSO_ID',
-            )
-        );
-    }
-
-
-
-
-
-
-
-    /**
-     * Gets all events that are published
-     * and have event start time earlier than now and an event end time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_active_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        //if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start******'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * get all events that are published and have an event start time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (Note that status and DTT_EVT_start will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * Gets all events that are published
-     * and have an event end time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_active_and_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // add where params for DTT_EVT_end
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This only returns events that are expired.
-     * They may still be published but all their datetimes have expired.
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_expired_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        $exclude_query = $query_params;
-        if (isset($exclude_query[0])) {
-            unset($exclude_query[0]);
-        }
-        $exclude_query[0] = array(
-            'Datetime.DTT_EVT_end' => array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ),
-        );
-        // first get all events that have datetimes where its not expired.
-        $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
-        $event_ids = array_keys($event_ids);
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $and_condition = array(
-            'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
-            'EVT_ID'               => array('NOT IN', $event_ids),
-        );
-        if (isset($where_params['OR'])) {
-            $and_condition['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        // merge remaining $where params with the and conditions.
-        $where_params['AND'] = array_merge($and_condition, $where_params);
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This basically just returns the events that do not have the publish status.
-     *
-     * @param  array   $query_params An array of query params to further filter on
-     *                               (note that status will be overwritten)
-     * @param  boolean $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_inactive_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // let's add in specific query_params for inactive events.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $where_params['AND']['status'] = array('!=', 'publish');
-        if (isset($where_params['OR'])) {
-            $where_params['AND']['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
-     * attached to the event. See parent for param descriptions
-     *
-     * @param        $id_or_obj
-     * @param        $other_model_id_or_obj
-     * @param string $relationName
-     * @param array  $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
-    {
-        if ($relationName === 'Price') {
-            //let's get the PRC object for the given ID to make sure that we aren't dealing with a default
-            $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
-            //if EVT_ID = 0, then this is a default
-            if ((int) $prc_chk->get('EVT_ID') === 0) {
-                //let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
-                $prc_chk->set('PRC_ID', 0);
-            }
-            //run parent
-            return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
-        }
-        //otherwise carry on as normal
-        return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
-    }
-
-
-
-    /******************** DEPRECATED METHODS ********************/
-
-
-
-    /**
-     * _get_question_target_db_column
-     *
-     * @deprecated as of 4.8.32.rc.001. Instead consider using
-     *             EE_Registration_Custom_Questions_Form located in
-     *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
-     * @access     public
-     * @param    EE_Registration $registration (so existing answers for registration are included)
-     * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
-     *                                         registration).
-     * @throws EE_Error
-     * @return    array
-     */
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
-    {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(__('An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
-                'event_espresso'));
-        }
-        $questions = array();
-        // get all question groups for event
-        $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
-            foreach ($qgs as $qg) {
-                $qsts = $qg->questions();
-                $questions[$qg->ID()] = $qg->model_field_array();
-                $questions[$qg->ID()]['QSG_questions'] = array();
-                foreach ($qsts as $qst) {
-                    if ($qst->is_system_question()) {
-                        continue;
-                    }
-                    $answer = EEM_Answer::instance()->get_one(array(
-                        array(
-                            'QST_ID' => $qst->ID(),
-                            'REG_ID' => $registration->ID(),
-                        ),
-                    ));
-                    $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
-                    $qst_name = $qstn_id = $qst->ID();
-                    $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
-                    $input_name = '';
-                    $input_id = sanitize_key($qst->display_text());
-                    $input_class = '';
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
-                                                                                           . $input_name
-                                                                                           . $qst_name;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
-                    //leave responses as-is, don't convert stuff into html entities please!
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
-                    if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
-                        $QSOs = $qst->options(true, $answer->value());
-                        if (is_array($QSOs)) {
-                            foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return $questions;
-    }
+	/**
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
+	 * event
+	 */
+	const sold_out = 'sold_out';
+
+	/**
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
+	 * date)
+	 */
+	const postponed = 'postponed';
+
+	/**
+	 * constant used by status(), indicating that the event will no longer occur
+	 */
+	const cancelled = 'cancelled';
+
+
+	/**
+	 * @var string
+	 */
+	protected static $_default_reg_status;
+
+
+	/**
+	 * This is the default for the additional limit field.
+	 * @var int
+	 */
+	protected static $_default_additional_limit = 10;
+
+
+	/**
+	 * private instance of the Event object
+	 *
+	 * @var EEM_Event
+	 */
+	protected static $_instance;
+
+
+
+	/**
+	 *  This function is a singleton method used to instantiate the EEM_Event object
+	 *
+	 * @param string $timezone
+	 * @return EEM_Event
+	 * @throws \EE_Error
+	 */
+	public static function instance($timezone = null)
+	{
+		// check if instance of EEM_Event already exists
+		if (! self::$_instance instanceof EEM_Event) {
+			// instantiate Espresso_model
+			self::$_instance = new self($timezone);
+		}
+		//we might have a timezone set, let set_timezone decide what to do with it
+		self::$_instance->set_timezone($timezone);
+		// EEM_Event object
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		EE_Registry::instance()->load_model('Registration');
+		$this->singular_item = esc_html__('Event', 'event_espresso');
+		$this->plural_item = esc_html__('Events', 'event_espresso');
+		// to remove Cancelled events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
+		// to remove Postponed events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
+		// to remove Sold Out events from the frontend, copy the following filter to your functions.php file
+		//	add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
+		$this->_custom_stati = apply_filters(
+			'AFEE__EEM_Event__construct___custom_stati',
+			array(
+				EEM_Event::cancelled => array(
+					'label'  => esc_html__('Cancelled', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
+				),
+				EEM_Event::postponed => array(
+					'label'  => esc_html__('Postponed', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
+				),
+				EEM_Event::sold_out  => array(
+					'label'  => esc_html__('Sold Out', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
+				),
+			)
+		);
+		self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
+			: self::$_default_reg_status;
+		$this->_tables = array(
+			'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
+		);
+		$this->_fields = array(
+			'Event_CPT'  => array(
+				'EVT_ID'         => new EE_Primary_Key_Int_Field('ID',
+					esc_html__('Post ID for Event', 'event_espresso')),
+				'EVT_name'       => new EE_Plain_Text_Field('post_title', esc_html__('Event Name', 'event_espresso'),
+					false,
+					''),
+				'EVT_desc'       => new EE_Post_Content_Field('post_content',
+					esc_html__('Event Description', 'event_espresso'),
+					false, ''),
+				'EVT_slug'       => new EE_Slug_Field('post_name', esc_html__('Event Slug', 'event_espresso'), false,
+					''),
+				'EVT_created'    => new EE_Datetime_Field('post_date',
+					esc_html__('Date/Time Event Created', 'event_espresso'),
+					false, EE_Datetime_Field::now),
+				'EVT_short_desc' => new EE_Simple_HTML_Field('post_excerpt',
+					esc_html__('Event Short Description', 'event_espresso'), false, ''),
+				'EVT_modified'   => new EE_Datetime_Field('post_modified',
+					esc_html__('Date/Time Event Modified', 'event_espresso'), false, EE_Datetime_Field::now),
+				'EVT_wp_user'    => new EE_WP_User_Field('post_author',
+					esc_html__('Event Creator ID', 'event_espresso'),
+					false),
+				'parent'         => new EE_Integer_Field('post_parent', esc_html__('Event Parent ID', 'event_espresso'),
+					false,
+					0),
+				'EVT_order'      => new EE_Integer_Field('menu_order', esc_html__('Event Menu Order', 'event_espresso'),
+					false,
+					1),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
+				// EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
+				'status'         => new EE_WP_Post_Status_Field('post_status',
+					esc_html__('Event Status', 'event_espresso'),
+					false, 'draft', $this->_custom_stati),
+			),
+			'Event_Meta' => array(
+				'EVTM_ID'                         => new EE_DB_Only_Float_Field('EVTM_ID',
+					esc_html__('Event Meta Row ID', 'event_espresso'), false),
+				'EVT_ID_fk'                       => new EE_DB_Only_Int_Field('EVT_ID',
+					esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), false),
+				'EVT_display_desc'                => new EE_Boolean_Field('EVT_display_desc',
+					esc_html__('Display Description Flag', 'event_espresso'), false, 1),
+				'EVT_display_ticket_selector'     => new EE_Boolean_Field('EVT_display_ticket_selector',
+					esc_html__('Display Ticket Selector Flag', 'event_espresso'), false, 1),
+				'EVT_visible_on'                  => new EE_Datetime_Field('EVT_visible_on',
+					esc_html__('Event Visible Date', 'event_espresso'), true, EE_Datetime_Field::now),
+				'EVT_additional_limit'            => new EE_Integer_Field(
+					'EVT_additional_limit',
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+					true,
+					self::$_default_additional_limit
+				),
+				'EVT_default_registration_status' => new EE_Enum_Text_Field(
+					'EVT_default_registration_status',
+					esc_html__('Default Registration Status on this Event', 'event_espresso'), false,
+					EEM_Event::$_default_reg_status, EEM_Registration::reg_status_array()
+				),
+				'EVT_member_only'                 => new EE_Boolean_Field('EVT_member_only',
+					esc_html__('Member-Only Event Flag', 'event_espresso'), false, false),
+				'EVT_phone'                       => new EE_Plain_Text_Field('EVT_phone',
+					esc_html__('Event Phone Number', 'event_espresso'), false),
+				'EVT_allow_overflow'              => new EE_Boolean_Field('EVT_allow_overflow',
+					esc_html__('Allow Overflow on Event', 'event_espresso'), false, false),
+				'EVT_timezone_string'             => new EE_Plain_Text_Field('EVT_timezone_string',
+					esc_html__('Timezone (name) for Event times', 'event_espresso'), false),
+				'EVT_external_URL'                => new EE_Plain_Text_Field('EVT_external_URL',
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true),
+				'EVT_donations'                   => new EE_Boolean_Field('EVT_donations',
+					esc_html__('Accept Donations?', 'event_espresso'), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'WP_User'                => new EE_Belongs_To_Relation(),
+		);
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * @param string $default_reg_status
+	 */
+	public static function set_default_reg_status($default_reg_status)
+	{
+		self::$_default_reg_status = $default_reg_status;
+		// if EEM_Event has already been instantiated,
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
+		if (self::$_instance instanceof EEM_Event) {
+			$default_reg_status = new EE_Enum_Text_Field(
+				'EVT_default_registration_status',
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
+				false,
+				$default_reg_status,
+				EEM_Registration::reg_status_array()
+			);
+			$default_reg_status->_construct_finalize(
+				'Event_Meta',
+				'EVT_default_registration_status',
+				'EEM_Event'
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
+		}
+	}
+
+
+	/**
+	 * Used to override the default for the additional limit field.
+	 * @param $additional_limit
+	 */
+	public static function set_default_additional_limit($additional_limit)
+	{
+		self::$_default_additional_limit = (int) $additional_limit;
+		if (self::$_instance instanceof EEM_Event) {
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
+				'EVT_additional_limit',
+				__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				true,
+				self::$_default_additional_limit
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
+				'Event_Meta',
+				'EVT_additional_limit',
+				'EEM_Event'
+			);
+		}
+	}
+
+
+	/**
+	 * Return what is currently set as the default additional limit for the event.
+	 * @return int
+	 */
+	public static function get_default_additional_limit()
+	{
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function get_all_question_groups()
+	{
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			array(
+				array('QSG_deleted' => false),
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_all_event_question_groups($EVT_ID = 0)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			array(
+				array('EVT_ID' => $EVT_ID),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $for_primary_attendee
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			array(
+				array(
+					'EVT_ID'      => $EVT_ID,
+					'EQG_primary' => $for_primary_attendee,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int             $EVT_ID
+	 * @param EE_Registration $registration
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		$where_params = array(
+			'Event_Question_Group.EVT_ID'      => $EVT_ID,
+			'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
+			'QSG_deleted'                      => false,
+		);
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			array(
+				$where_params,
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_target_db_column
+	 *
+	 * @param string $QSG_IDs csv list of $QSG IDs
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_questions_in_groups($QSG_IDs = '')
+	{
+		if (empty($QSG_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question')->get_all(
+			array(
+				array(
+					'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
+					'QST_deleted'           => false,
+					'QST_admin_only'        => is_admin(),
+				),
+				'order_by' => 'QST_order',
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_options_for_question
+	 *
+	 * @param string $QST_IDs csv list of $QST IDs
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_options_for_question($QST_IDs)
+	{
+		if (empty($QST_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Option')->get_all(
+			array(
+				array(
+					'Question.QST_ID' => array('IN', $QST_IDs),
+					'QSO_deleted'     => false,
+				),
+				'order_by' => 'QSO_ID',
+			)
+		);
+	}
+
+
+
+
+
+
+
+	/**
+	 * Gets all events that are published
+	 * and have event start time earlier than now and an event end time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_active_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		//if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start******'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * get all events that are published and have an event start time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (Note that status and DTT_EVT_start will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * Gets all events that are published
+	 * and have an event end time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_active_and_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// add where params for DTT_EVT_end
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This only returns events that are expired.
+	 * They may still be published but all their datetimes have expired.
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_expired_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		$exclude_query = $query_params;
+		if (isset($exclude_query[0])) {
+			unset($exclude_query[0]);
+		}
+		$exclude_query[0] = array(
+			'Datetime.DTT_EVT_end' => array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			),
+		);
+		// first get all events that have datetimes where its not expired.
+		$event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
+		$event_ids = array_keys($event_ids);
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$and_condition = array(
+			'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
+			'EVT_ID'               => array('NOT IN', $event_ids),
+		);
+		if (isset($where_params['OR'])) {
+			$and_condition['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		// merge remaining $where params with the and conditions.
+		$where_params['AND'] = array_merge($and_condition, $where_params);
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This basically just returns the events that do not have the publish status.
+	 *
+	 * @param  array   $query_params An array of query params to further filter on
+	 *                               (note that status will be overwritten)
+	 * @param  boolean $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_inactive_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// let's add in specific query_params for inactive events.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$where_params['AND']['status'] = array('!=', 'publish');
+		if (isset($where_params['OR'])) {
+			$where_params['AND']['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
+	 * attached to the event. See parent for param descriptions
+	 *
+	 * @param        $id_or_obj
+	 * @param        $other_model_id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
+	{
+		if ($relationName === 'Price') {
+			//let's get the PRC object for the given ID to make sure that we aren't dealing with a default
+			$prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
+			//if EVT_ID = 0, then this is a default
+			if ((int) $prc_chk->get('EVT_ID') === 0) {
+				//let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
+				$prc_chk->set('PRC_ID', 0);
+			}
+			//run parent
+			return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
+		}
+		//otherwise carry on as normal
+		return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
+	}
+
+
+
+	/******************** DEPRECATED METHODS ********************/
+
+
+
+	/**
+	 * _get_question_target_db_column
+	 *
+	 * @deprecated as of 4.8.32.rc.001. Instead consider using
+	 *             EE_Registration_Custom_Questions_Form located in
+	 *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
+	 * @access     public
+	 * @param    EE_Registration $registration (so existing answers for registration are included)
+	 * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
+	 *                                         registration).
+	 * @throws EE_Error
+	 * @return    array
+	 */
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
+	{
+		if (empty($EVT_ID)) {
+			throw new EE_Error(__('An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
+				'event_espresso'));
+		}
+		$questions = array();
+		// get all question groups for event
+		$qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
+		if (! empty($qgs)) {
+			foreach ($qgs as $qg) {
+				$qsts = $qg->questions();
+				$questions[$qg->ID()] = $qg->model_field_array();
+				$questions[$qg->ID()]['QSG_questions'] = array();
+				foreach ($qsts as $qst) {
+					if ($qst->is_system_question()) {
+						continue;
+					}
+					$answer = EEM_Answer::instance()->get_one(array(
+						array(
+							'QST_ID' => $qst->ID(),
+							'REG_ID' => $registration->ID(),
+						),
+					));
+					$answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
+					$qst_name = $qstn_id = $qst->ID();
+					$ans_id = $answer->ID();
+					$qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+					$input_name = '';
+					$input_id = sanitize_key($qst->display_text());
+					$input_class = '';
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
+																						   . $input_name
+																						   . $qst_name;
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
+					//leave responses as-is, don't convert stuff into html entities please!
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
+					if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
+						$QSOs = $qst->options(true, $answer->value());
+						if (is_array($QSOs)) {
+							foreach ($QSOs as $QSO_ID => $QSO) {
+								$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
+							}
+						}
+					}
+				}
+			}
+		}
+		return $questions;
+	}
 
 
 }

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1712 added lines, -1712 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\exceptions\InvalidEntityException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -17,1717 +17,1717 @@ 
 class EED_Single_Page_Checkout extends EED_Module
 {
 
-    /**
-     * $_initialized - has the SPCO controller already been initialized ?
-     *
-     * @access private
-     * @var bool $_initialized
-     */
-    private static $_initialized = false;
-
-
-    /**
-     * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
-     *
-     * @access private
-     * @var bool $_valid_checkout
-     */
-    private static $_checkout_verified = true;
-
-    /**
-     *    $_reg_steps_array - holds initial array of reg steps
-     *
-     * @access private
-     * @var array $_reg_steps_array
-     */
-    private static $_reg_steps_array = array();
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-
-
-    /**
-     * @return EED_Single_Page_Checkout
-     */
-    public static function instance()
-    {
-        add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * @return EE_CART
-     */
-    public function cart()
-    {
-        return $this->checkout->cart;
-    }
-
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        return $this->checkout->transaction;
-    }
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public static function set_hooks()
-    {
-        EED_Single_Page_Checkout::set_definitions();
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Single_Page_Checkout::set_definitions();
-        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
-            // hook into the top of pre_get_posts to set the reg step routing, which gives other modules or plugins a chance to modify the reg steps, but just before the routes get called
-            add_action('pre_get_posts', array('EED_Single_Page_Checkout', 'load_reg_steps'), 1);
-            return;
-        }
-        // going to start an output buffer in case anything gets accidentally output that might disrupt our JSON response
-        ob_start();
-        EED_Single_Page_Checkout::load_request_handler();
-        EED_Single_Page_Checkout::load_reg_steps();
-        // set ajax hooks
-        add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
-        add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
-        add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
-        add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
-        add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
-        add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
-    }
-
-
-
-    /**
-     *    process ajax request
-     *
-     * @param string $ajax_action
-     * @throws \EE_Error
-     */
-    public static function process_ajax_request($ajax_action)
-    {
-        EE_Registry::instance()->REQ->set('action', $ajax_action);
-        EED_Single_Page_Checkout::instance()->_initialize();
-    }
-
-
-
-    /**
-     *    ajax display registration step
-     *
-     * @throws \EE_Error
-     */
-    public static function display_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
-    }
-
-
-
-    /**
-     *    ajax process registration step
-     *
-     * @throws \EE_Error
-     */
-    public static function process_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
-    }
-
-
-
-    /**
-     *    ajax process registration step
-     *
-     * @throws \EE_Error
-     */
-    public static function update_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
-    }
-
-
-
-    /**
-     *   update_checkout
-     *
-     * @access public
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function update_checkout()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_checkout');
-    }
-
-
-
-    /**
-     *    load_request_handler
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function load_request_handler()
-    {
-        // load core Request_Handler class
-        if ( ! isset(EE_Registry::instance()->REQ)) {
-            EE_Registry::instance()->load_core('Request_Handler');
-        }
-    }
-
-
-
-    /**
-     *    set_definitions
-     *
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public static function set_definitions()
-    {
-        define('SPCO_BASE_PATH', rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS);
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS);
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS);
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS);
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS);
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS);
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
-            __('%1$sWe\'re sorry, but you\'re registration time has expired.%2$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-    }
-
-
-
-    /**
-     * load_reg_steps
-     * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return void
-     */
-    public static function load_reg_steps()
-    {
-        static $reg_steps_loaded = false;
-        if ($reg_steps_loaded) {
-            return;
-        }
-        // filter list of reg_steps
-        $reg_steps_to_load = (array)apply_filters(
-            'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
-            EED_Single_Page_Checkout::get_reg_steps()
-        );
-        // sort by key (order)
-        ksort($reg_steps_to_load);
-        // loop through folders
-        foreach ($reg_steps_to_load as $order => $reg_step) {
-            // we need a
-            if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-                // copy over to the reg_steps_array
-                EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step;
-                // register custom key route for each reg step
-                // ie: step=>"slug" - this is the entire reason we load the reg steps array now
-                EE_Config::register_route($reg_step['slug'], 'EED_Single_Page_Checkout', 'run', 'step');
-                // add AJAX or other hooks
-                if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
-                    // setup autoloaders if necessary
-                    if ( ! class_exists($reg_step['class_name'])) {
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder($reg_step['file_path'], true);
-                    }
-                    if (is_callable($reg_step['class_name'], 'set_hooks')) {
-                        call_user_func(array($reg_step['class_name'], 'set_hooks'));
-                    }
-                }
-            }
-        }
-        $reg_steps_loaded = true;
-    }
-
-
-
-    /**
-     *    get_reg_steps
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function get_reg_steps()
-    {
-        $reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
-        if (empty($reg_steps)) {
-            $reg_steps = array(
-                10  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
-                    'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
-                    'slug'       => 'attendee_information',
-                    'has_hooks'  => false,
-                ),
-                20  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'registration_confirmation',
-                    'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation',
-                    'slug'       => 'registration_confirmation',
-                    'has_hooks'  => false,
-                ),
-                30  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
-                    'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
-                    'slug'       => 'payment_options',
-                    'has_hooks'  => true,
-                ),
-                999 => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
-                    'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
-                    'slug'       => 'finalize_registration',
-                    'has_hooks'  => false,
-                ),
-            );
-        }
-        return $reg_steps;
-    }
-
-
-
-    /**
-     *    registration_checkout_for_admin
-     *
-     * @access    public
-     * @return    string
-     * @throws \EE_Error
-     */
-    public static function registration_checkout_for_admin()
-    {
-        EED_Single_Page_Checkout::load_reg_steps();
-        EE_Registry::instance()->REQ->set('step', 'attendee_information');
-        EE_Registry::instance()->REQ->set('action', 'display_spco_reg_step');
-        EE_Registry::instance()->REQ->set('process_form_submission', false);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
-        return EE_Registry::instance()->REQ->get_output();
-    }
-
-
-
-    /**
-     * process_registration_from_admin
-     *
-     * @access public
-     * @return \EE_Transaction
-     * @throws \EE_Error
-     */
-    public static function process_registration_from_admin()
-    {
-        EED_Single_Page_Checkout::load_reg_steps();
-        EE_Registry::instance()->REQ->set('step', 'attendee_information');
-        EE_Registry::instance()->REQ->set('action', 'process_reg_step');
-        EE_Registry::instance()->REQ->set('process_form_submission', true);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) {
-            $final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps);
-            if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
-                EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step);
-                if ($final_reg_step->process_reg_step()) {
-                    $final_reg_step->set_completed();
-                    EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array();
-                    return EED_Single_Page_Checkout::instance()->checkout->transaction;
-                }
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     *    run
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function run($WP_Query)
-    {
-        if (
-            $WP_Query instanceof WP_Query
-            && $WP_Query->is_main_query()
-            && apply_filters('FHEE__EED_Single_Page_Checkout__run', true)
-            && $this->_is_reg_checkout()
-        ) {
-            $this->_initialize();
-        }
-    }
-
-
-
-    /**
-     * determines whether current url matches reg page url
-     *
-     * @return bool
-     */
-    protected function _is_reg_checkout()
-    {
-        // get current permalink for reg page without any extra query args
-        $reg_page_url = \get_permalink(EE_Config::instance()->core->reg_page_id);
-        // get request URI for current request, but without the scheme or host
-        $current_request_uri = \EEH_URL::filter_input_server_url('REQUEST_URI');
-        $current_request_uri = html_entity_decode($current_request_uri);
-        // get array of query args from the current request URI
-        $query_args = \EEH_URL::get_query_string($current_request_uri);
-        // grab page id if it is set
-        $page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0;
-        // and remove the page id from the query args (we will re-add it later)
-        unset($query_args['page_id']);
-        // now strip all query args from current request URI
-        $current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri);
-        // and re-add the page id if it was set
-        if ($page_id) {
-            $current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri);
-        }
-        // remove slashes and ?
-        $current_request_uri = trim($current_request_uri, '?/');
-        // is current request URI part of the known full reg page URL ?
-        return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false;
-    }
-
-
-
-    /**
-     *    run
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     * @throws \EE_Error
-     */
-    public static function init($WP_Query)
-    {
-        EED_Single_Page_Checkout::instance()->run($WP_Query);
-    }
-
-
-
-    /**
-     *    _initialize - initial module setup
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    void
-     */
-    private function _initialize()
-    {
-        // ensure SPCO doesn't run twice
-        if (EED_Single_Page_Checkout::$_initialized) {
-            return;
-        }
-        try {
-            $this->_verify_session();
-            // setup the EE_Checkout object
-            $this->checkout = $this->_initialize_checkout();
-            // filter checkout
-            $this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
-            // get the $_GET
-            $this->_get_request_vars();
-            if ($this->_block_bots()) {
-                return;
-            }
-            // filter continue_reg
-            $this->checkout->continue_reg = apply_filters('FHEE__EED_Single_Page_Checkout__init___continue_reg', true, $this->checkout);
-            // load the reg steps array
-            if ( ! $this->_load_and_instantiate_reg_steps()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // set the current step
-            $this->checkout->set_current_step($this->checkout->step);
-            // and the next step
-            $this->checkout->set_next_step();
-            // verify that everything has been setup correctly
-            if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // lock the transaction
-            $this->checkout->transaction->lock();
-            // make sure all of our cached objects are added to their respective model entity mappers
-            $this->checkout->refresh_all_entities();
-            // set amount owing
-            $this->checkout->amount_owing = $this->checkout->transaction->remaining();
-            // initialize each reg step, which gives them the chance to potentially alter the process
-            $this->_initialize_reg_steps();
-            // DEBUG LOG
-            //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            // get reg form
-            if( ! $this->_check_form_submission()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // checkout the action!!!
-            $this->_process_form_action();
-            // add some style and make it dance
-            $this->add_styles_and_scripts();
-            // kk... SPCO has successfully run
-            EED_Single_Page_Checkout::$_initialized = true;
-            // set no cache headers and constants
-            EE_System::do_not_cache();
-            // add anchor
-            add_action('loop_start', array($this, 'set_checkout_anchor'), 1);
-            // remove transaction lock
-            add_action('shutdown', array($this, 'unlock_transaction'), 1);
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     *    _verify_session
-     * checks that the session is valid and not expired
-     *
-     * @access    private
-     * @throws EE_Error
-     */
-    private function _verify_session()
-    {
-        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
-            throw new EE_Error(__('The EE_Session class could not be loaded.', 'event_espresso'));
-        }
-        // is session still valid ?
-        if (EE_Registry::instance()->SSN->expired() && EE_Registry::instance()->REQ->get('e_reg_url_link', '') === '') {
-            $this->checkout = new EE_Checkout();
-            EE_Registry::instance()->SSN->reset_cart();
-            EE_Registry::instance()->SSN->reset_checkout();
-            EE_Registry::instance()->SSN->reset_transaction();
-            EE_Error::add_attention(EE_Registry::$i18n_js_strings['registration_expiration_notice'], __FILE__,
-                __FUNCTION__, __LINE__);
-            EE_Registry::instance()->SSN->reset_expired();
-        }
-    }
-
-
-
-    /**
-     *    _initialize_checkout
-     * loads and instantiates EE_Checkout
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return EE_Checkout
-     */
-    private function _initialize_checkout()
-    {
-        // look in session for existing checkout
-        /** @type EE_Checkout $checkout */
-        $checkout = EE_Registry::instance()->SSN->checkout();
-        // verify
-        if ( ! $checkout instanceof EE_Checkout) {
-            // instantiate EE_Checkout object for handling the properties of the current checkout process
-            $checkout = EE_Registry::instance()->load_file(SPCO_INC_PATH, 'EE_Checkout', 'class', array(), false);
-        } else {
-            if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
-                $this->unlock_transaction();
-                wp_safe_redirect($checkout->redirect_url);
-                exit();
-            }
-        }
-        $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
-        // verify again
-        if ( ! $checkout instanceof EE_Checkout) {
-            throw new EE_Error(__('The EE_Checkout class could not be loaded.', 'event_espresso'));
-        }
-        // reset anything that needs a clean slate for each request
-        $checkout->reset_for_current_request();
-        return $checkout;
-    }
-
-
-
-    /**
-     *    _get_request_vars
-     *
-     * @access    private
-     * @return    void
-     * @throws \EE_Error
-     */
-    private function _get_request_vars()
-    {
-        // load classes
-        EED_Single_Page_Checkout::load_request_handler();
-        //make sure this request is marked as belonging to EE
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        // which step is being requested ?
-        $this->checkout->step = EE_Registry::instance()->REQ->get('step', $this->_get_first_step());
-        // which step is being edited ?
-        $this->checkout->edit_step = EE_Registry::instance()->REQ->get('edit_step', '');
-        // and what we're doing on the current step
-        $this->checkout->action = EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step');
-        // timestamp
-        $this->checkout->uts = EE_Registry::instance()->REQ->get('uts', 0);
-        // returning to edit ?
-        $this->checkout->reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link', '');
-        // or some other kind of revisit ?
-        $this->checkout->revisit = filter_var(
-            EE_Registry::instance()->REQ->get('revisit', false),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // and whether or not to generate a reg form for this request
-        $this->checkout->generate_reg_form = filter_var(
-            EE_Registry::instance()->REQ->get('generate_reg_form', true),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // and whether or not to process a reg form submission for this request
-        $this->checkout->process_form_submission = filter_var(
-            EE_Registry::instance()->REQ->get(
-                'process_form_submission',
-                $this->checkout->action === 'process_reg_step'
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        $this->checkout->process_form_submission = filter_var(
-            $this->checkout->action !== 'display_spco_reg_step'
-                ? $this->checkout->process_form_submission
-                : false,
-            FILTER_VALIDATE_BOOLEAN
-        );
-        // $this->_display_request_vars();
-    }
-
-
-
-    /**
-     *  _display_request_vars
-     *
-     * @access    protected
-     * @return    void
-     */
-    protected function _display_request_vars()
-    {
-        if ( ! WP_DEBUG) {
-            return;
-        }
-        EEH_Debug_Tools::printr($_REQUEST, '$_REQUEST', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->generate_reg_form, '$this->checkout->generate_reg_form', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->process_form_submission, '$this->checkout->process_form_submission', __FILE__, __LINE__);
-    }
-
-
-
-    /**
-     * _block_bots
-     * checks that the incoming request has either of the following set:
-     *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
-     *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
-     * so if you're not coming from the Ticket Selector nor returning for a valid IP...
-     * then where you coming from man?
-     *
-     * @return boolean
-     */
-    private function _block_bots()
-    {
-        $invalid_checkout_access = \EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
-        if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) {
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    _get_first_step
-     *  gets slug for first step in $_reg_steps_array
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    string
-     */
-    private function _get_first_step()
-    {
-        $first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
-        return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information';
-    }
-
-
-
-    /**
-     *    _load_and_instantiate_reg_steps
-     *  instantiates each reg step based on the loaded reg_steps array
-     *
-     * @access    private
-     * @throws EE_Error
-     * @return    bool
-     */
-    private function _load_and_instantiate_reg_steps()
-    {
-        do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
-        // have reg_steps already been instantiated ?
-        if (
-            empty($this->checkout->reg_steps)
-            || apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
-        ) {
-            // if not, then loop through raw reg steps array
-            foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
-                if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
-                    return false;
-                }
-            }
-            EE_Registry::instance()->CFG->registration->skip_reg_confirmation = true;
-            EE_Registry::instance()->CFG->registration->reg_confirmation_last = true;
-            // skip the registration_confirmation page ?
-            if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) {
-                // just remove it from the reg steps array
-                $this->checkout->remove_reg_step('registration_confirmation', false);
-            } else if (
-                isset($this->checkout->reg_steps['registration_confirmation'])
-                && EE_Registry::instance()->CFG->registration->reg_confirmation_last
-            ) {
-                // set the order to something big like 100
-                $this->checkout->set_reg_step_order('registration_confirmation', 100);
-            }
-            // filter the array for good luck
-            $this->checkout->reg_steps = apply_filters(
-                'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps',
-                $this->checkout->reg_steps
-            );
-            // finally re-sort based on the reg step class order properties
-            $this->checkout->sort_reg_steps();
-        } else {
-            foreach ($this->checkout->reg_steps as $reg_step) {
-                // set all current step stati to FALSE
-                $reg_step->set_is_current_step(false);
-            }
-        }
-        if (empty($this->checkout->reg_steps)) {
-            EE_Error::add_error(__('No Reg Steps were loaded..', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // make reg step details available to JS
-        $this->checkout->set_reg_step_JSON_info();
-        return true;
-    }
-
-
-
-    /**
-     *     _load_and_instantiate_reg_step
-     *
-     * @access    private
-     * @param array $reg_step
-     * @param int   $order
-     * @return bool
-     */
-    private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0)
-    {
-        // we need a file_path, class_name, and slug to add a reg step
-        if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-            // if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
-            if (
-                $this->checkout->reg_url_link
-                && $this->checkout->step !== $reg_step['slug']
-                && $reg_step['slug'] !== 'finalize_registration'
-                // normally at this point we would NOT load the reg step, but this filter can change that
-                && apply_filters(
-                    'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
-                    true,
-                    $reg_step,
-                    $this->checkout
-                )
-            ) {
-                return true;
-            }
-            // instantiate step class using file path and class name
-            $reg_step_obj = EE_Registry::instance()->load_file(
-                $reg_step['file_path'],
-                $reg_step['class_name'],
-                'class',
-                $this->checkout,
-                false
-            );
-            // did we gets the goods ?
-            if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
-                // set reg step order based on config
-                $reg_step_obj->set_order($order);
-                // add instantiated reg step object to the master reg steps array
-                $this->checkout->add_reg_step($reg_step_obj);
-            } else {
-                EE_Error::add_error(
-                    __('The current step could not be set.', 'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                return false;
-            }
-        } else {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    sprintf(
-                        __('A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s', 'event_espresso'),
-                        isset($reg_step['file_path']) ? $reg_step['file_path'] : '',
-                        isset($reg_step['class_name']) ? $reg_step['class_name'] : '',
-                        isset($reg_step['slug']) ? $reg_step['slug'] : '',
-                        '<ul>',
-                        '<li>',
-                        '</li>',
-                        '</ul>'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _verify_transaction_and_get_registrations
-     *
-     * @access private
-     * @return bool
-     */
-    private function _verify_transaction_and_get_registrations()
-    {
-        // was there already a valid transaction in the checkout from the session ?
-        if ( ! $this->checkout->transaction instanceof EE_Transaction) {
-            // get transaction from db or session
-            $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
-                ? $this->_get_transaction_and_cart_for_previous_visit()
-                : $this->_get_cart_for_current_session_and_setup_new_transaction();
-            if ( ! $this->checkout->transaction instanceof EE_Transaction) {
-                EE_Error::add_error(
-                    __('Your Registration and Transaction information could not be retrieved from the db.',
-                        'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                $this->checkout->transaction = EE_Transaction::new_instance();
-                // add some style and make it dance
-                $this->add_styles_and_scripts();
-                EED_Single_Page_Checkout::$_initialized = true;
-                return false;
-            }
-            // and the registrations for the transaction
-            $this->_get_registrations($this->checkout->transaction);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _get_transaction_and_cart_for_previous_visit
-     *
-     * @access private
-     * @return mixed EE_Transaction|NULL
-     */
-    private function _get_transaction_and_cart_for_previous_visit()
-    {
-        /** @var $TXN_model EEM_Transaction */
-        $TXN_model = EE_Registry::instance()->load_model('Transaction');
-        // because the reg_url_link is present in the request, this is a return visit to SPCO, so we'll get the transaction data from the db
-        $transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // and get the cart that was used for that transaction
-            $this->checkout->cart = $this->_get_cart_for_transaction($transaction);
-            return $transaction;
-        } else {
-            EE_Error::add_error(__('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return null;
-        }
-    }
-
-
-
-    /**
-     * _get_cart_for_transaction
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    private function _get_cart_for_transaction($transaction)
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-
-    /**
-     * get_cart_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    public function get_cart_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-
-    /**
-     * _get_transaction_and_cart_for_current_session
-     *    generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @access private
-     * @return EE_Transaction
-     * @throws \EE_Error
-     */
-    private function _get_cart_for_current_session_and_setup_new_transaction()
-    {
-        //  if there's no transaction, then this is the FIRST visit to SPCO
-        // so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
-        $this->checkout->cart = $this->_get_cart_for_transaction(null);
-        // and then create a new transaction
-        $transaction = $this->_initialize_transaction();
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // and save TXN data to the cart
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
-        } else {
-            EE_Error::add_error(__('A Valid Transaction could not be initialized.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $transaction;
-    }
-
-
-
-    /**
-     *    generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @access private
-     * @return mixed EE_Transaction|NULL
-     */
-    private function _initialize_transaction()
-    {
-        try {
-            // ensure cart totals have been calculated
-            $this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
-            // grab the cart grand total
-            $cart_total = $this->checkout->cart->get_cart_grand_total();
-            // create new TXN
-            $transaction = EE_Transaction::new_instance(
-                array(
-                    'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
-                    'TXN_total'     => $cart_total > 0 ? $cart_total : 0,
-                    'TXN_paid'      => 0,
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                )
-            );
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // set cron job for following up on TXNs after their session has expired
-            EE_Cron_Tasks::schedule_expired_transaction_check(
-                EE_Registry::instance()->SSN->expiration() + 1,
-                $transaction->ID()
-            );
-            return $transaction;
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return null;
-    }
-
-
-
-    /**
-     * _get_registrations
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     * @throws \EE_Error
-     */
-    private function _get_registrations(EE_Transaction $transaction)
-    {
-        // first step: grab the registrants  { : o
-        $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, true);
-        // verify registrations have been set
-        if (empty($registrations)) {
-            // if no cached registrations, then check the db
-            $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, false);
-            // still nothing ? well as long as this isn't a revisit
-            if (empty($registrations) && ! $this->checkout->revisit) {
-                // generate new registrations from scratch
-                $registrations = $this->_initialize_registrations($transaction);
-            }
-        }
-        // sort by their original registration order
-        usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count'));
-        // then loop thru the array
-        foreach ($registrations as $registration) {
-            // verify each registration
-            if ($registration instanceof EE_Registration) {
-                // we display all attendee info for the primary registrant
-                if ($this->checkout->reg_url_link === $registration->reg_url_link()
-                    && $registration->is_primary_registrant()
-                ) {
-                    $this->checkout->primary_revisit = true;
-                    break;
-                } else if ($this->checkout->revisit
-                           && $this->checkout->reg_url_link !== $registration->reg_url_link()
-                ) {
-                    // but hide info if it doesn't belong to you
-                    $transaction->clear_cache('Registration', $registration->ID());
-                }
-                $this->checkout->set_reg_status_updated($registration->ID(), false);
-            }
-        }
-    }
-
-
-
-    /**
-     *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @return    array
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     * @throws \EE_Error
-     */
-    private function _initialize_registrations(EE_Transaction $transaction)
-    {
-        $att_nmbr = 0;
-        $registrations = array();
-        if ($transaction instanceof EE_Transaction) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
-            // now let's add the cart items to the $transaction
-            foreach ($this->checkout->cart->get_tickets() as $line_item) {
-                //do the following for each ticket of this type they selected
-                for ($x = 1; $x <= $line_item->quantity(); $x++) {
-                    $att_nmbr++;
-                    /** @var EventEspresso\core\services\commands\registration\CreateRegistrationCommand $CreateRegistrationCommand */
-                    $CreateRegistrationCommand = EE_Registry::instance()
-                                                            ->create(
-                                                                'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
-                                                                array(
-                                                                    $transaction,
-                                                                    $line_item,
-                                                                    $att_nmbr,
-                                                                    $this->checkout->total_ticket_count,
-                                                                )
-                                                            );
-                    // override capabilities for frontend registrations
-                    if ( ! is_admin()) {
-                        $CreateRegistrationCommand->setCapCheck(
-                            new PublicCapabilities('', 'create_new_registration')
-                        );
-                    }
-                    $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
-                    if ( ! $registration instanceof EE_Registration) {
-                        throw new InvalidEntityException($registration, 'EE_Registration');
-                    }
-                    $registrations[ $registration->ID() ] = $registration;
-                }
-            }
-            $registration_processor->fix_reg_final_price_rounding_issue($transaction);
-        }
-        return $registrations;
-    }
-
-
-
-    /**
-     * sorts registrations by REG_count
-     *
-     * @access public
-     * @param EE_Registration $reg_A
-     * @param EE_Registration $reg_B
-     * @return int
-     */
-    public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B)
-    {
-        // this shouldn't ever happen within the same TXN, but oh well
-        if ($reg_A->count() === $reg_B->count()) {
-            return 0;
-        }
-        return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
-    }
-
-
-
-    /**
-     *    _final_verifications
-     * just makes sure that everything is set up correctly before proceeding
-     *
-     * @access    private
-     * @return    bool
-     * @throws \EE_Error
-     */
-    private function _final_verifications()
-    {
-        // filter checkout
-        $this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___final_verifications__checkout', $this->checkout);
-        //verify that current step is still set correctly
-        if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
-            EE_Error::add_error(
-                __('We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // if returning to SPCO, then verify that primary registrant is set
-        if ( ! empty($this->checkout->reg_url_link)) {
-            $valid_registrant = $this->checkout->transaction->primary_registration();
-            if ( ! $valid_registrant instanceof EE_Registration) {
-                EE_Error::add_error(
-                    __('We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $valid_registrant = null;
-            foreach ($this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration) {
-                if (
-                    $registration instanceof EE_Registration
-                    && $registration->reg_url_link() === $this->checkout->reg_url_link
-                ) {
-                    $valid_registrant = $registration;
-                }
-            }
-            if ( ! $valid_registrant instanceof EE_Registration) {
-                // hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
-                if (EED_Single_Page_Checkout::$_checkout_verified) {
-                    // clear the session, mark the checkout as unverified, and try again
-                    EE_Registry::instance()->SSN->clear_session();
-                    EED_Single_Page_Checkout::$_initialized = false;
-                    EED_Single_Page_Checkout::$_checkout_verified = false;
-                    $this->_initialize();
-                    EE_Error::reset_notices();
-                    return false;
-                }
-                EE_Error::add_error(
-                    __('We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        // now that things have been kinda sufficiently verified,
-        // let's add the checkout to the session so that's available other systems
-        EE_Registry::instance()->SSN->set_checkout($this->checkout);
-        return true;
-    }
-
-
-
-    /**
-     *    _initialize_reg_steps
-     * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
-     * then loops thru all of the active reg steps and calls the initialize_reg_step() method
-     *
-     * @access    private
-     * @param bool $reinitializing
-     * @throws \EE_Error
-     */
-    private function _initialize_reg_steps($reinitializing = false)
-    {
-        $this->checkout->set_reg_step_initiated($this->checkout->current_step);
-        // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
-        foreach ($this->checkout->reg_steps as $reg_step) {
-            if ( ! $reg_step->initialize_reg_step()) {
-                // if not initialized then maybe this step is being removed...
-                if ( ! $reinitializing && $reg_step->is_current_step()) {
-                    // if it was the current step, then we need to start over here
-                    $this->_initialize_reg_steps(true);
-                    return;
-                }
-                continue;
-            }
-            // add css and JS for current step
-            $reg_step->enqueue_styles_and_scripts();
-            // i18n
-            $reg_step->translate_js_strings();
-            if ($reg_step->is_current_step()) {
-                // the text that appears on the reg step form submit button
-                $reg_step->set_submit_button_text();
-            }
-        }
-        // dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
-        do_action("AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}", $this->checkout->current_step);
-    }
-
-
-
-    /**
-     * _check_form_submission
-     *
-     * @access private
-     * @return boolean
-     */
-    private function _check_form_submission()
-    {
-        //does this request require the reg form to be generated ?
-        if ($this->checkout->generate_reg_form) {
-            // ever heard that song by Blue Rodeo ?
-            try {
-                $this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
-                // if not displaying a form, then check for form submission
-                if (
-                    $this->checkout->process_form_submission
-                    && $this->checkout->current_step->reg_form->was_submitted()
-                ) {
-                    // clear out any old data in case this step is being run again
-                    $this->checkout->current_step->set_valid_data(array());
-                    // capture submitted form data
-                    $this->checkout->current_step->reg_form->receive_form_submission(
-                        apply_filters('FHEE__Single_Page_Checkout___check_form_submission__request_params', EE_Registry::instance()->REQ->params(), $this->checkout)
-                    );
-                    // validate submitted form data
-                    if ( ! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
-                        // thou shall not pass !!!
-                        $this->checkout->continue_reg = false;
-                        // any form validation errors?
-                        if ($this->checkout->current_step->reg_form->submission_error_message() !== '') {
-                            $submission_error_messages = array();
-                            // bad, bad, bad registrant
-                            foreach ($this->checkout->current_step->reg_form->get_validation_errors_accumulated() as $validation_error) {
-                                if ($validation_error instanceof EE_Validation_Error) {
-                                    $submission_error_messages[] = sprintf(
-                                        __('%s : %s', 'event_espresso'),
-                                        $validation_error->get_form_section()->html_label_text(),
-                                        $validation_error->getMessage()
-                                    );
-                                }
-                            }
-                            EE_Error::add_error(implode('<br />', $submission_error_messages), __FILE__, __FUNCTION__, __LINE__);
-                        }
-                        // well not really... what will happen is we'll just get redirected back to redo the current step
-                        $this->go_to_next_step();
-                        return false;
-                    }
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _process_action
-     *
-     * @access private
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _process_form_action()
-    {
-        // what cha wanna do?
-        switch ($this->checkout->action) {
-            // AJAX next step reg form
-            case 'display_spco_reg_step' :
-                $this->checkout->redirect = false;
-                if (EE_Registry::instance()->REQ->ajax) {
-                    $this->checkout->json_response->set_reg_step_html($this->checkout->current_step->display_reg_form());
-                }
-                break;
-            default :
-                // meh... do one of those other steps first
-                if ( ! empty($this->checkout->action) && is_callable(array($this->checkout->current_step, $this->checkout->action))) {
-                    // dynamically creates hook point like: AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
-                    do_action("AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}", $this->checkout->current_step);
-                    // call action on current step
-                    if (call_user_func(array($this->checkout->current_step, $this->checkout->action))) {
-                        // good registrant, you get to proceed
-                        if (
-                            $this->checkout->current_step->success_message() !== ''
-                            && apply_filters(
-                                'FHEE__Single_Page_Checkout___process_form_action__display_success',
-                                false
-                            )
-                        ) {
-                            EE_Error::add_success(
-                                $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
-                            );
-                        }
-                        // pack it up, pack it in...
-                        $this->_setup_redirect();
-                    }
-                    // dynamically creates hook point like: AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
-                    do_action("AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}", $this->checkout->current_step);
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            __('The requested form action "%s" does not exist for the current "%s" registration step.', 'event_espresso'),
-                            $this->checkout->action,
-                            $this->checkout->current_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            // end default
-        }
-        // store our progress so far
-        $this->checkout->stash_transaction_and_checkout();
-        // advance to the next step! If you pass GO, collect $200
-        $this->go_to_next_step();
-    }
-
-
-
-    /**
-     *        add_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     */
-    public function add_styles_and_scripts()
-    {
-        // i18n
-        $this->translate_js_strings();
-        if ($this->checkout->admin_request) {
-            add_action('admin_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
-        } else {
-            add_action('wp_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
-        }
-    }
-
-
-
-    /**
-     *        translate_js_strings
-     *
-     * @access        public
-     * @return        void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['revisit'] = $this->checkout->revisit;
-        EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->checkout->reg_url_link;
-        EE_Registry::$i18n_js_strings['server_error'] = __('An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.', 'event_espresso');
-        EE_Registry::$i18n_js_strings['invalid_json_response'] = __('An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.', 'event_espresso');
-        EE_Registry::$i18n_js_strings['validation_error'] = __('There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.', 'event_espresso');
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = __('There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.', 'event_espresso');
-        EE_Registry::$i18n_js_strings['reg_step_error'] = __('This registration step could not be completed. Please refresh the page and try again.', 'event_espresso');
-        EE_Registry::$i18n_js_strings['invalid_coupon'] = __('We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.', 'event_espresso');
-        EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
-            __('Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.', 'event_espresso'),
-            '<br/>',
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language');
-        EE_Registry::$i18n_js_strings['EESID'] = EE_Registry::instance()->SSN->id();
-        EE_Registry::$i18n_js_strings['currency'] = EE_Registry::instance()->CFG->currency;
-        EE_Registry::$i18n_js_strings['datepicker_yearRange'] = '-150:+20';
-        EE_Registry::$i18n_js_strings['timer_years'] = __('years', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_months'] = __('months', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_weeks'] = __('weeks', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_days'] = __('days', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hours'] = __('hours', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minutes'] = __('minutes', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_seconds'] = __('seconds', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_year'] = __('year', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_month'] = __('month', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_week'] = __('week', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_day'] = __('day', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hour'] = __('hour', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minute'] = __('minute', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_second'] = __('second', 'event_espresso');
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
-            __(
-                '%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'
-            ),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-        EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters('FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit', true);
-        EE_Registry::$i18n_js_strings['session_extension'] = absint(
-            apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
-        );
-        EE_Registry::$i18n_js_strings['session_expiration'] = gmdate(
-            'M d, Y H:i:s', EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-        );
-    }
-
-
-
-    /**
-     *    enqueue_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     * @throws \EE_Error
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style('single_page_checkout', SPCO_CSS_URL . 'single_page_checkout.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('single_page_checkout');
-        // load JS
-        wp_register_script('jquery_plugin', EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js', array('jquery'), '1.0.1', true);
-        wp_register_script('jquery_countdown', EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js', array('jquery_plugin'), '2.0.2', true);
-        wp_register_script('single_page_checkout', SPCO_JS_URL . 'single_page_checkout.js', array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'), EVENT_ESPRESSO_VERSION, true);
-        if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->registration_form->enqueue_js();
-        }
-        if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->current_step->reg_form->enqueue_js();
-        }
-        wp_enqueue_script('single_page_checkout');
-        /**
-         * global action hook for enqueueing styles and scripts with
-         * spco calls.
-         */
-        do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
-        /**
-         * dynamic action hook for enqueueing styles and scripts with spco calls.
-         * The hook will end up being something like AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
-         */
-        do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(), $this);
-    }
-
-
-
-    /**
-     *    display the Registration Single Page Checkout Form
-     *
-     * @access    private
-     * @return    void
-     * @throws \EE_Error
-     */
-    private function _display_spco_reg_form()
-    {
-        // if registering via the admin, just display the reg form for the current step
-        if ($this->checkout->admin_request) {
-            EE_Registry::instance()->REQ->add_output($this->checkout->current_step->display_reg_form());
-        } else {
-            // add powered by EE msg
-            add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer'));
-            $empty_cart = count($this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)) < 1
-                ? true
-                : false;
-            EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
-            $cookies_not_set_msg = '';
-            if ($empty_cart && ! isset($_COOKIE['ee_cookie_test'])) {
-                $cookies_not_set_msg = apply_filters(
-                    'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
-                    sprintf(
-                        __(
-                            '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
-                            'event_espresso'
-                        ),
-                        '<div class="ee-attention">',
-                        '</div>',
-                        '<h6 class="important-notice">',
-                        '</h6>',
-                        '<p>',
-                        '</p>',
-                        '<br />',
-                        '<a href="http://www.whatarecookies.com/enable.asp" target="_blank">',
-                        '</a>'
-                    )
-                );
-            }
-            $this->checkout->registration_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'single-page-checkout',
-                    'html_id'         => 'ee-single-page-checkout-dv',
-                    'layout_strategy' =>
-                        new EE_Template_Layout(
-                            array(
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
-                                'template_args'        => array(
-                                    'empty_cart'              => $empty_cart,
-                                    'revisit'                 => $this->checkout->revisit,
-                                    'reg_steps'               => $this->checkout->reg_steps,
-                                    'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                        ? $this->checkout->next_step->slug()
-                                        : '',
-                                    'cancel_page_url'         => $this->checkout->cancel_page_url,
-                                    'empty_msg'               => apply_filters(
-                                        'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
-                                        sprintf(
-                                            __('You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
-                                                'event_espresso'),
-                                            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-                                            '">',
-                                            '</a>'
-                                        )
-                                    ),
-                                    'cookies_not_set_msg'     => $cookies_not_set_msg,
-                                    'registration_time_limit' => $this->checkout->get_registration_time_limit(),
-                                    'session_expiration'      =>
-                                        date('M d, Y H:i:s', EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)),
-                                ),
-                            )
-                        ),
-                )
-            );
-            // load template and add to output sent that gets filtered into the_content()
-            EE_Registry::instance()->REQ->add_output($this->checkout->registration_form->get_html());
-        }
-    }
-
-
-
-    /**
-     *    add_extra_finalize_registration_inputs
-     *
-     * @access    public
-     * @param $next_step
-     * @internal  param string $label
-     * @return void
-     */
-    public function add_extra_finalize_registration_inputs($next_step)
-    {
-        if ($next_step === 'finalize_registration') {
-            echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
-        }
-    }
-
-
-
-    /**
-     *    display_registration_footer
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function display_registration_footer()
-    {
-        if (
-        apply_filters(
-            'FHEE__EE_Front__Controller__show_reg_footer',
-            EE_Registry::instance()->CFG->admin->show_reg_footer
-        )
-        ) {
-            add_filter(
-                'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
-                    return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
-                }
-            );
-            echo apply_filters(
-                'FHEE__EE_Front_Controller__display_registration_footer',
-                \EEH_Template::powered_by_event_espresso(
-                    '',
-                    'espresso-registration-footer-dv',
-                    array('utm_content' => 'registration_checkout')
-                )
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     *    unlock_transaction
-     *
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function unlock_transaction()
-    {
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $this->checkout->transaction->unlock();
-        }
-    }
-
-
-
-    /**
-     *        _setup_redirect
-     *
-     * @access    private
-     * @return void
-     */
-    private function _setup_redirect()
-    {
-        if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            $this->checkout->redirect = true;
-            if (empty($this->checkout->redirect_url)) {
-                $this->checkout->redirect_url = $this->checkout->next_step->reg_step_url();
-            }
-            $this->checkout->redirect_url = apply_filters(
-                'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url',
-                $this->checkout->redirect_url,
-                $this->checkout
-            );
-        }
-    }
-
-
-
-    /**
-     *   handle ajax message responses and redirects
-     *
-     * @access public
-     * @return void
-     * @throws \EE_Error
-     */
-    public function go_to_next_step()
-    {
-        if (EE_Registry::instance()->REQ->ajax) {
-            // capture contents of output buffer we started earlier in the request, and insert into JSON response
-            $this->checkout->json_response->set_unexpected_errors(ob_get_clean());
-        }
-        $this->unlock_transaction();
-        // just return for these conditions
-        if (
-            $this->checkout->admin_request
-            || $this->checkout->action === 'redirect_form'
-            || $this->checkout->action === 'update_checkout'
-        ) {
-            return;
-        }
-        // AJAX response
-        $this->_handle_json_response();
-        // redirect to next step or the Thank You page
-        $this->_handle_html_redirects();
-        // hmmm... must be something wrong, so let's just display the form again !
-        $this->_display_spco_reg_form();
-    }
-
-
-
-    /**
-     *   _handle_json_response
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _handle_json_response()
-    {
-        // if this is an ajax request
-        if (EE_Registry::instance()->REQ->ajax) {
-            // DEBUG LOG
-            //$this->checkout->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	array(
-            //		'json_response_redirect_url' => $this->checkout->json_response->redirect_url(),
-            //		'redirect'                   => $this->checkout->redirect,
-            //		'continue_reg'               => $this->checkout->continue_reg,
-            //	)
-            //);
-            $this->checkout->json_response->set_registration_time_limit(
-                $this->checkout->get_registration_time_limit()
-            );
-            $this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
-            // just send the ajax (
-            $json_response = apply_filters(
-                'FHEE__EE_Single_Page_Checkout__JSON_response',
-                $this->checkout->json_response
-            );
-            echo $json_response;
-            exit();
-        }
-    }
-
-
-
-    /**
-     *   _handle_redirects
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _handle_html_redirects()
-    {
-        // going somewhere ?
-        if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) {
-            // store notices in a transient
-            EE_Error::get_notices(false, true, true);
-            // DEBUG LOG
-            //$this->checkout->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	array(
-            //		'headers_sent' => headers_sent(),
-            //		'redirect_url'     => $this->checkout->redirect_url,
-            //		'headers_list'    => headers_list(),
-            //	)
-            //);
-            wp_safe_redirect($this->checkout->redirect_url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     *   set_checkout_anchor
-     *
-     * @access public
-     * @return void
-     */
-    public function set_checkout_anchor()
-    {
-        echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
-    }
+	/**
+	 * $_initialized - has the SPCO controller already been initialized ?
+	 *
+	 * @access private
+	 * @var bool $_initialized
+	 */
+	private static $_initialized = false;
+
+
+	/**
+	 * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
+	 *
+	 * @access private
+	 * @var bool $_valid_checkout
+	 */
+	private static $_checkout_verified = true;
+
+	/**
+	 *    $_reg_steps_array - holds initial array of reg steps
+	 *
+	 * @access private
+	 * @var array $_reg_steps_array
+	 */
+	private static $_reg_steps_array = array();
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+
+
+	/**
+	 * @return EED_Single_Page_Checkout
+	 */
+	public static function instance()
+	{
+		add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * @return EE_CART
+	 */
+	public function cart()
+	{
+		return $this->checkout->cart;
+	}
+
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		return $this->checkout->transaction;
+	}
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public static function set_hooks()
+	{
+		EED_Single_Page_Checkout::set_definitions();
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Single_Page_Checkout::set_definitions();
+		if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
+			// hook into the top of pre_get_posts to set the reg step routing, which gives other modules or plugins a chance to modify the reg steps, but just before the routes get called
+			add_action('pre_get_posts', array('EED_Single_Page_Checkout', 'load_reg_steps'), 1);
+			return;
+		}
+		// going to start an output buffer in case anything gets accidentally output that might disrupt our JSON response
+		ob_start();
+		EED_Single_Page_Checkout::load_request_handler();
+		EED_Single_Page_Checkout::load_reg_steps();
+		// set ajax hooks
+		add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
+		add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step'));
+		add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
+		add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step'));
+		add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
+		add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step'));
+	}
+
+
+
+	/**
+	 *    process ajax request
+	 *
+	 * @param string $ajax_action
+	 * @throws \EE_Error
+	 */
+	public static function process_ajax_request($ajax_action)
+	{
+		EE_Registry::instance()->REQ->set('action', $ajax_action);
+		EED_Single_Page_Checkout::instance()->_initialize();
+	}
+
+
+
+	/**
+	 *    ajax display registration step
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function display_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
+	}
+
+
+
+	/**
+	 *    ajax process registration step
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function process_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
+	}
+
+
+
+	/**
+	 *    ajax process registration step
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function update_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
+	}
+
+
+
+	/**
+	 *   update_checkout
+	 *
+	 * @access public
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function update_checkout()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_checkout');
+	}
+
+
+
+	/**
+	 *    load_request_handler
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function load_request_handler()
+	{
+		// load core Request_Handler class
+		if ( ! isset(EE_Registry::instance()->REQ)) {
+			EE_Registry::instance()->load_core('Request_Handler');
+		}
+	}
+
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public static function set_definitions()
+	{
+		define('SPCO_BASE_PATH', rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS);
+		define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS);
+		define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS);
+		define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS);
+		define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS);
+		define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS);
+		define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
+			__('%1$sWe\'re sorry, but you\'re registration time has expired.%2$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+	}
+
+
+
+	/**
+	 * load_reg_steps
+	 * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function load_reg_steps()
+	{
+		static $reg_steps_loaded = false;
+		if ($reg_steps_loaded) {
+			return;
+		}
+		// filter list of reg_steps
+		$reg_steps_to_load = (array)apply_filters(
+			'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
+			EED_Single_Page_Checkout::get_reg_steps()
+		);
+		// sort by key (order)
+		ksort($reg_steps_to_load);
+		// loop through folders
+		foreach ($reg_steps_to_load as $order => $reg_step) {
+			// we need a
+			if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+				// copy over to the reg_steps_array
+				EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step;
+				// register custom key route for each reg step
+				// ie: step=>"slug" - this is the entire reason we load the reg steps array now
+				EE_Config::register_route($reg_step['slug'], 'EED_Single_Page_Checkout', 'run', 'step');
+				// add AJAX or other hooks
+				if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
+					// setup autoloaders if necessary
+					if ( ! class_exists($reg_step['class_name'])) {
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder($reg_step['file_path'], true);
+					}
+					if (is_callable($reg_step['class_name'], 'set_hooks')) {
+						call_user_func(array($reg_step['class_name'], 'set_hooks'));
+					}
+				}
+			}
+		}
+		$reg_steps_loaded = true;
+	}
+
+
+
+	/**
+	 *    get_reg_steps
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function get_reg_steps()
+	{
+		$reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
+		if (empty($reg_steps)) {
+			$reg_steps = array(
+				10  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+					'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
+					'slug'       => 'attendee_information',
+					'has_hooks'  => false,
+				),
+				20  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'registration_confirmation',
+					'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation',
+					'slug'       => 'registration_confirmation',
+					'has_hooks'  => false,
+				),
+				30  => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
+					'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
+					'slug'       => 'payment_options',
+					'has_hooks'  => true,
+				),
+				999 => array(
+					'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
+					'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
+					'slug'       => 'finalize_registration',
+					'has_hooks'  => false,
+				),
+			);
+		}
+		return $reg_steps;
+	}
+
+
+
+	/**
+	 *    registration_checkout_for_admin
+	 *
+	 * @access    public
+	 * @return    string
+	 * @throws \EE_Error
+	 */
+	public static function registration_checkout_for_admin()
+	{
+		EED_Single_Page_Checkout::load_reg_steps();
+		EE_Registry::instance()->REQ->set('step', 'attendee_information');
+		EE_Registry::instance()->REQ->set('action', 'display_spco_reg_step');
+		EE_Registry::instance()->REQ->set('process_form_submission', false);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
+		return EE_Registry::instance()->REQ->get_output();
+	}
+
+
+
+	/**
+	 * process_registration_from_admin
+	 *
+	 * @access public
+	 * @return \EE_Transaction
+	 * @throws \EE_Error
+	 */
+	public static function process_registration_from_admin()
+	{
+		EED_Single_Page_Checkout::load_reg_steps();
+		EE_Registry::instance()->REQ->set('step', 'attendee_information');
+		EE_Registry::instance()->REQ->set('action', 'process_reg_step');
+		EE_Registry::instance()->REQ->set('process_form_submission', true);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) {
+			$final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps);
+			if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
+				EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step);
+				if ($final_reg_step->process_reg_step()) {
+					$final_reg_step->set_completed();
+					EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array();
+					return EED_Single_Page_Checkout::instance()->checkout->transaction;
+				}
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 *    run
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function run($WP_Query)
+	{
+		if (
+			$WP_Query instanceof WP_Query
+			&& $WP_Query->is_main_query()
+			&& apply_filters('FHEE__EED_Single_Page_Checkout__run', true)
+			&& $this->_is_reg_checkout()
+		) {
+			$this->_initialize();
+		}
+	}
+
+
+
+	/**
+	 * determines whether current url matches reg page url
+	 *
+	 * @return bool
+	 */
+	protected function _is_reg_checkout()
+	{
+		// get current permalink for reg page without any extra query args
+		$reg_page_url = \get_permalink(EE_Config::instance()->core->reg_page_id);
+		// get request URI for current request, but without the scheme or host
+		$current_request_uri = \EEH_URL::filter_input_server_url('REQUEST_URI');
+		$current_request_uri = html_entity_decode($current_request_uri);
+		// get array of query args from the current request URI
+		$query_args = \EEH_URL::get_query_string($current_request_uri);
+		// grab page id if it is set
+		$page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0;
+		// and remove the page id from the query args (we will re-add it later)
+		unset($query_args['page_id']);
+		// now strip all query args from current request URI
+		$current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri);
+		// and re-add the page id if it was set
+		if ($page_id) {
+			$current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri);
+		}
+		// remove slashes and ?
+		$current_request_uri = trim($current_request_uri, '?/');
+		// is current request URI part of the known full reg page URL ?
+		return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false;
+	}
+
+
+
+	/**
+	 *    run
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public static function init($WP_Query)
+	{
+		EED_Single_Page_Checkout::instance()->run($WP_Query);
+	}
+
+
+
+	/**
+	 *    _initialize - initial module setup
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    void
+	 */
+	private function _initialize()
+	{
+		// ensure SPCO doesn't run twice
+		if (EED_Single_Page_Checkout::$_initialized) {
+			return;
+		}
+		try {
+			$this->_verify_session();
+			// setup the EE_Checkout object
+			$this->checkout = $this->_initialize_checkout();
+			// filter checkout
+			$this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
+			// get the $_GET
+			$this->_get_request_vars();
+			if ($this->_block_bots()) {
+				return;
+			}
+			// filter continue_reg
+			$this->checkout->continue_reg = apply_filters('FHEE__EED_Single_Page_Checkout__init___continue_reg', true, $this->checkout);
+			// load the reg steps array
+			if ( ! $this->_load_and_instantiate_reg_steps()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// set the current step
+			$this->checkout->set_current_step($this->checkout->step);
+			// and the next step
+			$this->checkout->set_next_step();
+			// verify that everything has been setup correctly
+			if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// lock the transaction
+			$this->checkout->transaction->lock();
+			// make sure all of our cached objects are added to their respective model entity mappers
+			$this->checkout->refresh_all_entities();
+			// set amount owing
+			$this->checkout->amount_owing = $this->checkout->transaction->remaining();
+			// initialize each reg step, which gives them the chance to potentially alter the process
+			$this->_initialize_reg_steps();
+			// DEBUG LOG
+			//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			// get reg form
+			if( ! $this->_check_form_submission()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// checkout the action!!!
+			$this->_process_form_action();
+			// add some style and make it dance
+			$this->add_styles_and_scripts();
+			// kk... SPCO has successfully run
+			EED_Single_Page_Checkout::$_initialized = true;
+			// set no cache headers and constants
+			EE_System::do_not_cache();
+			// add anchor
+			add_action('loop_start', array($this, 'set_checkout_anchor'), 1);
+			// remove transaction lock
+			add_action('shutdown', array($this, 'unlock_transaction'), 1);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 *    _verify_session
+	 * checks that the session is valid and not expired
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 */
+	private function _verify_session()
+	{
+		if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
+			throw new EE_Error(__('The EE_Session class could not be loaded.', 'event_espresso'));
+		}
+		// is session still valid ?
+		if (EE_Registry::instance()->SSN->expired() && EE_Registry::instance()->REQ->get('e_reg_url_link', '') === '') {
+			$this->checkout = new EE_Checkout();
+			EE_Registry::instance()->SSN->reset_cart();
+			EE_Registry::instance()->SSN->reset_checkout();
+			EE_Registry::instance()->SSN->reset_transaction();
+			EE_Error::add_attention(EE_Registry::$i18n_js_strings['registration_expiration_notice'], __FILE__,
+				__FUNCTION__, __LINE__);
+			EE_Registry::instance()->SSN->reset_expired();
+		}
+	}
+
+
+
+	/**
+	 *    _initialize_checkout
+	 * loads and instantiates EE_Checkout
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return EE_Checkout
+	 */
+	private function _initialize_checkout()
+	{
+		// look in session for existing checkout
+		/** @type EE_Checkout $checkout */
+		$checkout = EE_Registry::instance()->SSN->checkout();
+		// verify
+		if ( ! $checkout instanceof EE_Checkout) {
+			// instantiate EE_Checkout object for handling the properties of the current checkout process
+			$checkout = EE_Registry::instance()->load_file(SPCO_INC_PATH, 'EE_Checkout', 'class', array(), false);
+		} else {
+			if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
+				$this->unlock_transaction();
+				wp_safe_redirect($checkout->redirect_url);
+				exit();
+			}
+		}
+		$checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
+		// verify again
+		if ( ! $checkout instanceof EE_Checkout) {
+			throw new EE_Error(__('The EE_Checkout class could not be loaded.', 'event_espresso'));
+		}
+		// reset anything that needs a clean slate for each request
+		$checkout->reset_for_current_request();
+		return $checkout;
+	}
+
+
+
+	/**
+	 *    _get_request_vars
+	 *
+	 * @access    private
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	private function _get_request_vars()
+	{
+		// load classes
+		EED_Single_Page_Checkout::load_request_handler();
+		//make sure this request is marked as belonging to EE
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		// which step is being requested ?
+		$this->checkout->step = EE_Registry::instance()->REQ->get('step', $this->_get_first_step());
+		// which step is being edited ?
+		$this->checkout->edit_step = EE_Registry::instance()->REQ->get('edit_step', '');
+		// and what we're doing on the current step
+		$this->checkout->action = EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step');
+		// timestamp
+		$this->checkout->uts = EE_Registry::instance()->REQ->get('uts', 0);
+		// returning to edit ?
+		$this->checkout->reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link', '');
+		// or some other kind of revisit ?
+		$this->checkout->revisit = filter_var(
+			EE_Registry::instance()->REQ->get('revisit', false),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// and whether or not to generate a reg form for this request
+		$this->checkout->generate_reg_form = filter_var(
+			EE_Registry::instance()->REQ->get('generate_reg_form', true),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// and whether or not to process a reg form submission for this request
+		$this->checkout->process_form_submission = filter_var(
+			EE_Registry::instance()->REQ->get(
+				'process_form_submission',
+				$this->checkout->action === 'process_reg_step'
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		$this->checkout->process_form_submission = filter_var(
+			$this->checkout->action !== 'display_spco_reg_step'
+				? $this->checkout->process_form_submission
+				: false,
+			FILTER_VALIDATE_BOOLEAN
+		);
+		// $this->_display_request_vars();
+	}
+
+
+
+	/**
+	 *  _display_request_vars
+	 *
+	 * @access    protected
+	 * @return    void
+	 */
+	protected function _display_request_vars()
+	{
+		if ( ! WP_DEBUG) {
+			return;
+		}
+		EEH_Debug_Tools::printr($_REQUEST, '$_REQUEST', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->generate_reg_form, '$this->checkout->generate_reg_form', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->process_form_submission, '$this->checkout->process_form_submission', __FILE__, __LINE__);
+	}
+
+
+
+	/**
+	 * _block_bots
+	 * checks that the incoming request has either of the following set:
+	 *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
+	 *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
+	 * so if you're not coming from the Ticket Selector nor returning for a valid IP...
+	 * then where you coming from man?
+	 *
+	 * @return boolean
+	 */
+	private function _block_bots()
+	{
+		$invalid_checkout_access = \EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
+		if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) {
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    _get_first_step
+	 *  gets slug for first step in $_reg_steps_array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    string
+	 */
+	private function _get_first_step()
+	{
+		$first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
+		return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information';
+	}
+
+
+
+	/**
+	 *    _load_and_instantiate_reg_steps
+	 *  instantiates each reg step based on the loaded reg_steps array
+	 *
+	 * @access    private
+	 * @throws EE_Error
+	 * @return    bool
+	 */
+	private function _load_and_instantiate_reg_steps()
+	{
+		do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
+		// have reg_steps already been instantiated ?
+		if (
+			empty($this->checkout->reg_steps)
+			|| apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
+		) {
+			// if not, then loop through raw reg steps array
+			foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
+				if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
+					return false;
+				}
+			}
+			EE_Registry::instance()->CFG->registration->skip_reg_confirmation = true;
+			EE_Registry::instance()->CFG->registration->reg_confirmation_last = true;
+			// skip the registration_confirmation page ?
+			if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) {
+				// just remove it from the reg steps array
+				$this->checkout->remove_reg_step('registration_confirmation', false);
+			} else if (
+				isset($this->checkout->reg_steps['registration_confirmation'])
+				&& EE_Registry::instance()->CFG->registration->reg_confirmation_last
+			) {
+				// set the order to something big like 100
+				$this->checkout->set_reg_step_order('registration_confirmation', 100);
+			}
+			// filter the array for good luck
+			$this->checkout->reg_steps = apply_filters(
+				'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps',
+				$this->checkout->reg_steps
+			);
+			// finally re-sort based on the reg step class order properties
+			$this->checkout->sort_reg_steps();
+		} else {
+			foreach ($this->checkout->reg_steps as $reg_step) {
+				// set all current step stati to FALSE
+				$reg_step->set_is_current_step(false);
+			}
+		}
+		if (empty($this->checkout->reg_steps)) {
+			EE_Error::add_error(__('No Reg Steps were loaded..', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// make reg step details available to JS
+		$this->checkout->set_reg_step_JSON_info();
+		return true;
+	}
+
+
+
+	/**
+	 *     _load_and_instantiate_reg_step
+	 *
+	 * @access    private
+	 * @param array $reg_step
+	 * @param int   $order
+	 * @return bool
+	 */
+	private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0)
+	{
+		// we need a file_path, class_name, and slug to add a reg step
+		if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+			// if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
+			if (
+				$this->checkout->reg_url_link
+				&& $this->checkout->step !== $reg_step['slug']
+				&& $reg_step['slug'] !== 'finalize_registration'
+				// normally at this point we would NOT load the reg step, but this filter can change that
+				&& apply_filters(
+					'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
+					true,
+					$reg_step,
+					$this->checkout
+				)
+			) {
+				return true;
+			}
+			// instantiate step class using file path and class name
+			$reg_step_obj = EE_Registry::instance()->load_file(
+				$reg_step['file_path'],
+				$reg_step['class_name'],
+				'class',
+				$this->checkout,
+				false
+			);
+			// did we gets the goods ?
+			if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
+				// set reg step order based on config
+				$reg_step_obj->set_order($order);
+				// add instantiated reg step object to the master reg steps array
+				$this->checkout->add_reg_step($reg_step_obj);
+			} else {
+				EE_Error::add_error(
+					__('The current step could not be set.', 'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				return false;
+			}
+		} else {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					sprintf(
+						__('A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s', 'event_espresso'),
+						isset($reg_step['file_path']) ? $reg_step['file_path'] : '',
+						isset($reg_step['class_name']) ? $reg_step['class_name'] : '',
+						isset($reg_step['slug']) ? $reg_step['slug'] : '',
+						'<ul>',
+						'<li>',
+						'</li>',
+						'</ul>'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _verify_transaction_and_get_registrations
+	 *
+	 * @access private
+	 * @return bool
+	 */
+	private function _verify_transaction_and_get_registrations()
+	{
+		// was there already a valid transaction in the checkout from the session ?
+		if ( ! $this->checkout->transaction instanceof EE_Transaction) {
+			// get transaction from db or session
+			$this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
+				? $this->_get_transaction_and_cart_for_previous_visit()
+				: $this->_get_cart_for_current_session_and_setup_new_transaction();
+			if ( ! $this->checkout->transaction instanceof EE_Transaction) {
+				EE_Error::add_error(
+					__('Your Registration and Transaction information could not be retrieved from the db.',
+						'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				$this->checkout->transaction = EE_Transaction::new_instance();
+				// add some style and make it dance
+				$this->add_styles_and_scripts();
+				EED_Single_Page_Checkout::$_initialized = true;
+				return false;
+			}
+			// and the registrations for the transaction
+			$this->_get_registrations($this->checkout->transaction);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _get_transaction_and_cart_for_previous_visit
+	 *
+	 * @access private
+	 * @return mixed EE_Transaction|NULL
+	 */
+	private function _get_transaction_and_cart_for_previous_visit()
+	{
+		/** @var $TXN_model EEM_Transaction */
+		$TXN_model = EE_Registry::instance()->load_model('Transaction');
+		// because the reg_url_link is present in the request, this is a return visit to SPCO, so we'll get the transaction data from the db
+		$transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// and get the cart that was used for that transaction
+			$this->checkout->cart = $this->_get_cart_for_transaction($transaction);
+			return $transaction;
+		} else {
+			EE_Error::add_error(__('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * _get_cart_for_transaction
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	private function _get_cart_for_transaction($transaction)
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+
+	/**
+	 * get_cart_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	public function get_cart_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+
+	/**
+	 * _get_transaction_and_cart_for_current_session
+	 *    generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @access private
+	 * @return EE_Transaction
+	 * @throws \EE_Error
+	 */
+	private function _get_cart_for_current_session_and_setup_new_transaction()
+	{
+		//  if there's no transaction, then this is the FIRST visit to SPCO
+		// so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
+		$this->checkout->cart = $this->_get_cart_for_transaction(null);
+		// and then create a new transaction
+		$transaction = $this->_initialize_transaction();
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// and save TXN data to the cart
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
+		} else {
+			EE_Error::add_error(__('A Valid Transaction could not be initialized.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $transaction;
+	}
+
+
+
+	/**
+	 *    generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @access private
+	 * @return mixed EE_Transaction|NULL
+	 */
+	private function _initialize_transaction()
+	{
+		try {
+			// ensure cart totals have been calculated
+			$this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
+			// grab the cart grand total
+			$cart_total = $this->checkout->cart->get_cart_grand_total();
+			// create new TXN
+			$transaction = EE_Transaction::new_instance(
+				array(
+					'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
+					'TXN_total'     => $cart_total > 0 ? $cart_total : 0,
+					'TXN_paid'      => 0,
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+				)
+			);
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// set cron job for following up on TXNs after their session has expired
+			EE_Cron_Tasks::schedule_expired_transaction_check(
+				EE_Registry::instance()->SSN->expiration() + 1,
+				$transaction->ID()
+			);
+			return $transaction;
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * _get_registrations
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 * @throws \EE_Error
+	 */
+	private function _get_registrations(EE_Transaction $transaction)
+	{
+		// first step: grab the registrants  { : o
+		$registrations = $transaction->registrations($this->checkout->reg_cache_where_params, true);
+		// verify registrations have been set
+		if (empty($registrations)) {
+			// if no cached registrations, then check the db
+			$registrations = $transaction->registrations($this->checkout->reg_cache_where_params, false);
+			// still nothing ? well as long as this isn't a revisit
+			if (empty($registrations) && ! $this->checkout->revisit) {
+				// generate new registrations from scratch
+				$registrations = $this->_initialize_registrations($transaction);
+			}
+		}
+		// sort by their original registration order
+		usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count'));
+		// then loop thru the array
+		foreach ($registrations as $registration) {
+			// verify each registration
+			if ($registration instanceof EE_Registration) {
+				// we display all attendee info for the primary registrant
+				if ($this->checkout->reg_url_link === $registration->reg_url_link()
+					&& $registration->is_primary_registrant()
+				) {
+					$this->checkout->primary_revisit = true;
+					break;
+				} else if ($this->checkout->revisit
+						   && $this->checkout->reg_url_link !== $registration->reg_url_link()
+				) {
+					// but hide info if it doesn't belong to you
+					$transaction->clear_cache('Registration', $registration->ID());
+				}
+				$this->checkout->set_reg_status_updated($registration->ID(), false);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @return    array
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 * @throws \EE_Error
+	 */
+	private function _initialize_registrations(EE_Transaction $transaction)
+	{
+		$att_nmbr = 0;
+		$registrations = array();
+		if ($transaction instanceof EE_Transaction) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
+			// now let's add the cart items to the $transaction
+			foreach ($this->checkout->cart->get_tickets() as $line_item) {
+				//do the following for each ticket of this type they selected
+				for ($x = 1; $x <= $line_item->quantity(); $x++) {
+					$att_nmbr++;
+					/** @var EventEspresso\core\services\commands\registration\CreateRegistrationCommand $CreateRegistrationCommand */
+					$CreateRegistrationCommand = EE_Registry::instance()
+															->create(
+																'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
+																array(
+																	$transaction,
+																	$line_item,
+																	$att_nmbr,
+																	$this->checkout->total_ticket_count,
+																)
+															);
+					// override capabilities for frontend registrations
+					if ( ! is_admin()) {
+						$CreateRegistrationCommand->setCapCheck(
+							new PublicCapabilities('', 'create_new_registration')
+						);
+					}
+					$registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
+					if ( ! $registration instanceof EE_Registration) {
+						throw new InvalidEntityException($registration, 'EE_Registration');
+					}
+					$registrations[ $registration->ID() ] = $registration;
+				}
+			}
+			$registration_processor->fix_reg_final_price_rounding_issue($transaction);
+		}
+		return $registrations;
+	}
+
+
+
+	/**
+	 * sorts registrations by REG_count
+	 *
+	 * @access public
+	 * @param EE_Registration $reg_A
+	 * @param EE_Registration $reg_B
+	 * @return int
+	 */
+	public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B)
+	{
+		// this shouldn't ever happen within the same TXN, but oh well
+		if ($reg_A->count() === $reg_B->count()) {
+			return 0;
+		}
+		return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
+	}
+
+
+
+	/**
+	 *    _final_verifications
+	 * just makes sure that everything is set up correctly before proceeding
+	 *
+	 * @access    private
+	 * @return    bool
+	 * @throws \EE_Error
+	 */
+	private function _final_verifications()
+	{
+		// filter checkout
+		$this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___final_verifications__checkout', $this->checkout);
+		//verify that current step is still set correctly
+		if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
+			EE_Error::add_error(
+				__('We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// if returning to SPCO, then verify that primary registrant is set
+		if ( ! empty($this->checkout->reg_url_link)) {
+			$valid_registrant = $this->checkout->transaction->primary_registration();
+			if ( ! $valid_registrant instanceof EE_Registration) {
+				EE_Error::add_error(
+					__('We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$valid_registrant = null;
+			foreach ($this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration) {
+				if (
+					$registration instanceof EE_Registration
+					&& $registration->reg_url_link() === $this->checkout->reg_url_link
+				) {
+					$valid_registrant = $registration;
+				}
+			}
+			if ( ! $valid_registrant instanceof EE_Registration) {
+				// hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
+				if (EED_Single_Page_Checkout::$_checkout_verified) {
+					// clear the session, mark the checkout as unverified, and try again
+					EE_Registry::instance()->SSN->clear_session();
+					EED_Single_Page_Checkout::$_initialized = false;
+					EED_Single_Page_Checkout::$_checkout_verified = false;
+					$this->_initialize();
+					EE_Error::reset_notices();
+					return false;
+				}
+				EE_Error::add_error(
+					__('We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		// now that things have been kinda sufficiently verified,
+		// let's add the checkout to the session so that's available other systems
+		EE_Registry::instance()->SSN->set_checkout($this->checkout);
+		return true;
+	}
+
+
+
+	/**
+	 *    _initialize_reg_steps
+	 * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
+	 * then loops thru all of the active reg steps and calls the initialize_reg_step() method
+	 *
+	 * @access    private
+	 * @param bool $reinitializing
+	 * @throws \EE_Error
+	 */
+	private function _initialize_reg_steps($reinitializing = false)
+	{
+		$this->checkout->set_reg_step_initiated($this->checkout->current_step);
+		// loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
+		foreach ($this->checkout->reg_steps as $reg_step) {
+			if ( ! $reg_step->initialize_reg_step()) {
+				// if not initialized then maybe this step is being removed...
+				if ( ! $reinitializing && $reg_step->is_current_step()) {
+					// if it was the current step, then we need to start over here
+					$this->_initialize_reg_steps(true);
+					return;
+				}
+				continue;
+			}
+			// add css and JS for current step
+			$reg_step->enqueue_styles_and_scripts();
+			// i18n
+			$reg_step->translate_js_strings();
+			if ($reg_step->is_current_step()) {
+				// the text that appears on the reg step form submit button
+				$reg_step->set_submit_button_text();
+			}
+		}
+		// dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
+		do_action("AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}", $this->checkout->current_step);
+	}
+
+
+
+	/**
+	 * _check_form_submission
+	 *
+	 * @access private
+	 * @return boolean
+	 */
+	private function _check_form_submission()
+	{
+		//does this request require the reg form to be generated ?
+		if ($this->checkout->generate_reg_form) {
+			// ever heard that song by Blue Rodeo ?
+			try {
+				$this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
+				// if not displaying a form, then check for form submission
+				if (
+					$this->checkout->process_form_submission
+					&& $this->checkout->current_step->reg_form->was_submitted()
+				) {
+					// clear out any old data in case this step is being run again
+					$this->checkout->current_step->set_valid_data(array());
+					// capture submitted form data
+					$this->checkout->current_step->reg_form->receive_form_submission(
+						apply_filters('FHEE__Single_Page_Checkout___check_form_submission__request_params', EE_Registry::instance()->REQ->params(), $this->checkout)
+					);
+					// validate submitted form data
+					if ( ! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
+						// thou shall not pass !!!
+						$this->checkout->continue_reg = false;
+						// any form validation errors?
+						if ($this->checkout->current_step->reg_form->submission_error_message() !== '') {
+							$submission_error_messages = array();
+							// bad, bad, bad registrant
+							foreach ($this->checkout->current_step->reg_form->get_validation_errors_accumulated() as $validation_error) {
+								if ($validation_error instanceof EE_Validation_Error) {
+									$submission_error_messages[] = sprintf(
+										__('%s : %s', 'event_espresso'),
+										$validation_error->get_form_section()->html_label_text(),
+										$validation_error->getMessage()
+									);
+								}
+							}
+							EE_Error::add_error(implode('<br />', $submission_error_messages), __FILE__, __FUNCTION__, __LINE__);
+						}
+						// well not really... what will happen is we'll just get redirected back to redo the current step
+						$this->go_to_next_step();
+						return false;
+					}
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _process_action
+	 *
+	 * @access private
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _process_form_action()
+	{
+		// what cha wanna do?
+		switch ($this->checkout->action) {
+			// AJAX next step reg form
+			case 'display_spco_reg_step' :
+				$this->checkout->redirect = false;
+				if (EE_Registry::instance()->REQ->ajax) {
+					$this->checkout->json_response->set_reg_step_html($this->checkout->current_step->display_reg_form());
+				}
+				break;
+			default :
+				// meh... do one of those other steps first
+				if ( ! empty($this->checkout->action) && is_callable(array($this->checkout->current_step, $this->checkout->action))) {
+					// dynamically creates hook point like: AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
+					do_action("AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}", $this->checkout->current_step);
+					// call action on current step
+					if (call_user_func(array($this->checkout->current_step, $this->checkout->action))) {
+						// good registrant, you get to proceed
+						if (
+							$this->checkout->current_step->success_message() !== ''
+							&& apply_filters(
+								'FHEE__Single_Page_Checkout___process_form_action__display_success',
+								false
+							)
+						) {
+							EE_Error::add_success(
+								$this->checkout->current_step->success_message()
+								. '<br />' . $this->checkout->next_step->_instructions()
+							);
+						}
+						// pack it up, pack it in...
+						$this->_setup_redirect();
+					}
+					// dynamically creates hook point like: AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
+					do_action("AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}", $this->checkout->current_step);
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							__('The requested form action "%s" does not exist for the current "%s" registration step.', 'event_espresso'),
+							$this->checkout->action,
+							$this->checkout->current_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			// end default
+		}
+		// store our progress so far
+		$this->checkout->stash_transaction_and_checkout();
+		// advance to the next step! If you pass GO, collect $200
+		$this->go_to_next_step();
+	}
+
+
+
+	/**
+	 *        add_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function add_styles_and_scripts()
+	{
+		// i18n
+		$this->translate_js_strings();
+		if ($this->checkout->admin_request) {
+			add_action('admin_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
+		} else {
+			add_action('wp_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10);
+		}
+	}
+
+
+
+	/**
+	 *        translate_js_strings
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['revisit'] = $this->checkout->revisit;
+		EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->checkout->reg_url_link;
+		EE_Registry::$i18n_js_strings['server_error'] = __('An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.', 'event_espresso');
+		EE_Registry::$i18n_js_strings['invalid_json_response'] = __('An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.', 'event_espresso');
+		EE_Registry::$i18n_js_strings['validation_error'] = __('There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.', 'event_espresso');
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = __('There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.', 'event_espresso');
+		EE_Registry::$i18n_js_strings['reg_step_error'] = __('This registration step could not be completed. Please refresh the page and try again.', 'event_espresso');
+		EE_Registry::$i18n_js_strings['invalid_coupon'] = __('We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.', 'event_espresso');
+		EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
+			__('Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.', 'event_espresso'),
+			'<br/>',
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language');
+		EE_Registry::$i18n_js_strings['EESID'] = EE_Registry::instance()->SSN->id();
+		EE_Registry::$i18n_js_strings['currency'] = EE_Registry::instance()->CFG->currency;
+		EE_Registry::$i18n_js_strings['datepicker_yearRange'] = '-150:+20';
+		EE_Registry::$i18n_js_strings['timer_years'] = __('years', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_months'] = __('months', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_weeks'] = __('weeks', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_days'] = __('days', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hours'] = __('hours', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minutes'] = __('minutes', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_seconds'] = __('seconds', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_year'] = __('year', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_month'] = __('month', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_week'] = __('week', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_day'] = __('day', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hour'] = __('hour', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minute'] = __('minute', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_second'] = __('second', 'event_espresso');
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
+			__(
+				'%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'
+			),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+		EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters('FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit', true);
+		EE_Registry::$i18n_js_strings['session_extension'] = absint(
+			apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
+		);
+		EE_Registry::$i18n_js_strings['session_expiration'] = gmdate(
+			'M d, Y H:i:s', EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)
+		);
+	}
+
+
+
+	/**
+	 *    enqueue_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 * @throws \EE_Error
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style('single_page_checkout', SPCO_CSS_URL . 'single_page_checkout.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('single_page_checkout');
+		// load JS
+		wp_register_script('jquery_plugin', EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js', array('jquery'), '1.0.1', true);
+		wp_register_script('jquery_countdown', EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js', array('jquery_plugin'), '2.0.2', true);
+		wp_register_script('single_page_checkout', SPCO_JS_URL . 'single_page_checkout.js', array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'), EVENT_ESPRESSO_VERSION, true);
+		if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->registration_form->enqueue_js();
+		}
+		if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->current_step->reg_form->enqueue_js();
+		}
+		wp_enqueue_script('single_page_checkout');
+		/**
+		 * global action hook for enqueueing styles and scripts with
+		 * spco calls.
+		 */
+		do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
+		/**
+		 * dynamic action hook for enqueueing styles and scripts with spco calls.
+		 * The hook will end up being something like AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
+		 */
+		do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(), $this);
+	}
+
+
+
+	/**
+	 *    display the Registration Single Page Checkout Form
+	 *
+	 * @access    private
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	private function _display_spco_reg_form()
+	{
+		// if registering via the admin, just display the reg form for the current step
+		if ($this->checkout->admin_request) {
+			EE_Registry::instance()->REQ->add_output($this->checkout->current_step->display_reg_form());
+		} else {
+			// add powered by EE msg
+			add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer'));
+			$empty_cart = count($this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)) < 1
+				? true
+				: false;
+			EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
+			$cookies_not_set_msg = '';
+			if ($empty_cart && ! isset($_COOKIE['ee_cookie_test'])) {
+				$cookies_not_set_msg = apply_filters(
+					'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
+					sprintf(
+						__(
+							'%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
+							'event_espresso'
+						),
+						'<div class="ee-attention">',
+						'</div>',
+						'<h6 class="important-notice">',
+						'</h6>',
+						'<p>',
+						'</p>',
+						'<br />',
+						'<a href="http://www.whatarecookies.com/enable.asp" target="_blank">',
+						'</a>'
+					)
+				);
+			}
+			$this->checkout->registration_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'single-page-checkout',
+					'html_id'         => 'ee-single-page-checkout-dv',
+					'layout_strategy' =>
+						new EE_Template_Layout(
+							array(
+								'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+								'template_args'        => array(
+									'empty_cart'              => $empty_cart,
+									'revisit'                 => $this->checkout->revisit,
+									'reg_steps'               => $this->checkout->reg_steps,
+									'next_step'               => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+										? $this->checkout->next_step->slug()
+										: '',
+									'cancel_page_url'         => $this->checkout->cancel_page_url,
+									'empty_msg'               => apply_filters(
+										'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
+										sprintf(
+											__('You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
+												'event_espresso'),
+											'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+											'">',
+											'</a>'
+										)
+									),
+									'cookies_not_set_msg'     => $cookies_not_set_msg,
+									'registration_time_limit' => $this->checkout->get_registration_time_limit(),
+									'session_expiration'      =>
+										date('M d, Y H:i:s', EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS)),
+								),
+							)
+						),
+				)
+			);
+			// load template and add to output sent that gets filtered into the_content()
+			EE_Registry::instance()->REQ->add_output($this->checkout->registration_form->get_html());
+		}
+	}
+
+
+
+	/**
+	 *    add_extra_finalize_registration_inputs
+	 *
+	 * @access    public
+	 * @param $next_step
+	 * @internal  param string $label
+	 * @return void
+	 */
+	public function add_extra_finalize_registration_inputs($next_step)
+	{
+		if ($next_step === 'finalize_registration') {
+			echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
+		}
+	}
+
+
+
+	/**
+	 *    display_registration_footer
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function display_registration_footer()
+	{
+		if (
+		apply_filters(
+			'FHEE__EE_Front__Controller__show_reg_footer',
+			EE_Registry::instance()->CFG->admin->show_reg_footer
+		)
+		) {
+			add_filter(
+				'FHEE__EEH_Template__powered_by_event_espresso__url',
+				function ($url) {
+					return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
+				}
+			);
+			echo apply_filters(
+				'FHEE__EE_Front_Controller__display_registration_footer',
+				\EEH_Template::powered_by_event_espresso(
+					'',
+					'espresso-registration-footer-dv',
+					array('utm_content' => 'registration_checkout')
+				)
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 *    unlock_transaction
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function unlock_transaction()
+	{
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$this->checkout->transaction->unlock();
+		}
+	}
+
+
+
+	/**
+	 *        _setup_redirect
+	 *
+	 * @access    private
+	 * @return void
+	 */
+	private function _setup_redirect()
+	{
+		if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			$this->checkout->redirect = true;
+			if (empty($this->checkout->redirect_url)) {
+				$this->checkout->redirect_url = $this->checkout->next_step->reg_step_url();
+			}
+			$this->checkout->redirect_url = apply_filters(
+				'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url',
+				$this->checkout->redirect_url,
+				$this->checkout
+			);
+		}
+	}
+
+
+
+	/**
+	 *   handle ajax message responses and redirects
+	 *
+	 * @access public
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function go_to_next_step()
+	{
+		if (EE_Registry::instance()->REQ->ajax) {
+			// capture contents of output buffer we started earlier in the request, and insert into JSON response
+			$this->checkout->json_response->set_unexpected_errors(ob_get_clean());
+		}
+		$this->unlock_transaction();
+		// just return for these conditions
+		if (
+			$this->checkout->admin_request
+			|| $this->checkout->action === 'redirect_form'
+			|| $this->checkout->action === 'update_checkout'
+		) {
+			return;
+		}
+		// AJAX response
+		$this->_handle_json_response();
+		// redirect to next step or the Thank You page
+		$this->_handle_html_redirects();
+		// hmmm... must be something wrong, so let's just display the form again !
+		$this->_display_spco_reg_form();
+	}
+
+
+
+	/**
+	 *   _handle_json_response
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _handle_json_response()
+	{
+		// if this is an ajax request
+		if (EE_Registry::instance()->REQ->ajax) {
+			// DEBUG LOG
+			//$this->checkout->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	array(
+			//		'json_response_redirect_url' => $this->checkout->json_response->redirect_url(),
+			//		'redirect'                   => $this->checkout->redirect,
+			//		'continue_reg'               => $this->checkout->continue_reg,
+			//	)
+			//);
+			$this->checkout->json_response->set_registration_time_limit(
+				$this->checkout->get_registration_time_limit()
+			);
+			$this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
+			// just send the ajax (
+			$json_response = apply_filters(
+				'FHEE__EE_Single_Page_Checkout__JSON_response',
+				$this->checkout->json_response
+			);
+			echo $json_response;
+			exit();
+		}
+	}
+
+
+
+	/**
+	 *   _handle_redirects
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _handle_html_redirects()
+	{
+		// going somewhere ?
+		if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) {
+			// store notices in a transient
+			EE_Error::get_notices(false, true, true);
+			// DEBUG LOG
+			//$this->checkout->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	array(
+			//		'headers_sent' => headers_sent(),
+			//		'redirect_url'     => $this->checkout->redirect_url,
+			//		'headers_list'    => headers_list(),
+			//	)
+			//);
+			wp_safe_redirect($this->checkout->redirect_url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 *   set_checkout_anchor
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_checkout_anchor()
+	{
+		echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
+	}
 
 
 

modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php

Indentation +616 added lines, -616 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,659 +16,659 @@ 
 abstract class EE_SPCO_Reg_Step
 {
 
-    /**
-     *    $_completed - TRUE if this step has fully completed it's duties
-     *
-     * @access protected
-     * @type bool $_completed
-     */
-    protected $_completed = false;
-
-    /**
-     *    $_is_current_step - TRUE if this is the current step
-     *
-     * @access protected
-     * @type bool $_is_current_step
-     */
-    protected $_is_current_step = false;
-
-    /**
-     *    $_order - when the reg step should be run relative to other steps
-     *
-     * @access protected
-     * @type int $_template
-     */
-    protected $_order = 0;
-
-    /**
-     *    $_slug - URL param for this step
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_slug;
-
-    /**
-     *    $_name - Step Name - translatable string
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_name;
-
-    /**
-     *    $_submit_button_text - translatable string that appears on this step's submit button
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_submit_button_text;
-
-    /**
-     *    $_template - template name
-     *
-     * @access protected
-     * @type string $_template
-     */
-    protected $_template;
-
-    /**
-     *    $_reg_form_name - the form input name and id attribute
-     *
-     * @access protected
-     * @var string $_reg_form_name
-     */
-    protected $_reg_form_name;
-
-    /**
-     *    $_success_message - text to display upon successful form submission
-     *
-     * @access private
-     * @var string $_success_message
-     */
-    protected $_success_message;
-
-    /**
-     *    $_instructions - a brief description of how to complete the reg step. Usually displayed in conjunction with
-     *    the previous step's success message.
-     *
-     * @access private
-     * @var string $_instructions
-     */
-    protected $_instructions;
-
-    /**
-     *    $_valid_data - the normalized and validated data for this step
-     *
-     * @access public
-     * @var array $_valid_data
-     */
-    protected $_valid_data = array();
-
-    /**
-     *    $reg_form - the registration form for this step
-     *
-     * @access public
-     * @var EE_Form_Section_Proper $reg_form
-     */
-    public $reg_form;
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-
-
-    /**
-     * @return void
-     */
-    abstract public function translate_js_strings();
-
-
+	/**
+	 *    $_completed - TRUE if this step has fully completed it's duties
+	 *
+	 * @access protected
+	 * @type bool $_completed
+	 */
+	protected $_completed = false;
+
+	/**
+	 *    $_is_current_step - TRUE if this is the current step
+	 *
+	 * @access protected
+	 * @type bool $_is_current_step
+	 */
+	protected $_is_current_step = false;
+
+	/**
+	 *    $_order - when the reg step should be run relative to other steps
+	 *
+	 * @access protected
+	 * @type int $_template
+	 */
+	protected $_order = 0;
+
+	/**
+	 *    $_slug - URL param for this step
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_slug;
+
+	/**
+	 *    $_name - Step Name - translatable string
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_name;
+
+	/**
+	 *    $_submit_button_text - translatable string that appears on this step's submit button
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_submit_button_text;
+
+	/**
+	 *    $_template - template name
+	 *
+	 * @access protected
+	 * @type string $_template
+	 */
+	protected $_template;
+
+	/**
+	 *    $_reg_form_name - the form input name and id attribute
+	 *
+	 * @access protected
+	 * @var string $_reg_form_name
+	 */
+	protected $_reg_form_name;
+
+	/**
+	 *    $_success_message - text to display upon successful form submission
+	 *
+	 * @access private
+	 * @var string $_success_message
+	 */
+	protected $_success_message;
+
+	/**
+	 *    $_instructions - a brief description of how to complete the reg step. Usually displayed in conjunction with
+	 *    the previous step's success message.
+	 *
+	 * @access private
+	 * @var string $_instructions
+	 */
+	protected $_instructions;
+
+	/**
+	 *    $_valid_data - the normalized and validated data for this step
+	 *
+	 * @access public
+	 * @var array $_valid_data
+	 */
+	protected $_valid_data = array();
+
+	/**
+	 *    $reg_form - the registration form for this step
+	 *
+	 * @access public
+	 * @var EE_Form_Section_Proper $reg_form
+	 */
+	public $reg_form;
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function translate_js_strings();
+
+
 
-    /**
-     * @return void
-     */
-    abstract public function enqueue_styles_and_scripts();
-
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function initialize_reg_step();
-
-
-
-    /**
-     * @return string
-     */
-    abstract public function generate_reg_form();
-
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function process_reg_step();
-
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function update_reg_step();
-
-
-
-    /**
-     * @return boolean
-     */
-    public function completed()
-    {
-        return $this->_completed;
-    }
+	/**
+	 * @return void
+	 */
+	abstract public function enqueue_styles_and_scripts();
+
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function initialize_reg_step();
+
+
+
+	/**
+	 * @return string
+	 */
+	abstract public function generate_reg_form();
+
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function process_reg_step();
+
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function update_reg_step();
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function completed()
+	{
+		return $this->_completed;
+	}
 
 
 
-    /**
-     * set_completed - toggles $_completed to TRUE
-     */
-    public function set_completed()
-    {
-        // DEBUG LOG
-        //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-        $this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
-    }
+	/**
+	 * set_completed - toggles $_completed to TRUE
+	 */
+	public function set_completed()
+	{
+		// DEBUG LOG
+		//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+		$this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
+	}
 
 
 
-    /**
-     * set_completed - toggles $_completed to FALSE
-     */
-    public function set_not_completed()
-    {
-        $this->_completed = false;
-    }
+	/**
+	 * set_completed - toggles $_completed to FALSE
+	 */
+	public function set_not_completed()
+	{
+		$this->_completed = false;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_name;
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->_slug;
-    }
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->_slug;
+	}
 
 
 
-    /**
-     * submit_button_text
-     * the text that appears on the reg step form submit button
-     *
-     * @return string
-     */
-    public function submit_button_text()
-    {
-        return $this->_submit_button_text;
-    }
+	/**
+	 * submit_button_text
+	 * the text that appears on the reg step form submit button
+	 *
+	 * @return string
+	 */
+	public function submit_button_text()
+	{
+		return $this->_submit_button_text;
+	}
 
 
 
-    /**
-     * set_submit_button_text
-     * sets the text that appears on the reg step form submit button
-     *
-     * @param string $submit_button_text
-     */
-    public function set_submit_button_text($submit_button_text = '')
-    {
-        if (! empty($submit_button_text)) {
-            $this->_submit_button_text = $submit_button_text;
-        } else if ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($this->checkout->revisit) {
-                $this->_submit_button_text = sprintf(__('Update %s', 'event_espresso'),
-                    $this->checkout->current_step->name());
-            } else {
-                $this->_submit_button_text = sprintf(__('Proceed to %s', 'event_espresso'),
-                    $this->checkout->next_step->name());
-            }
-        }
-        // filters the submit button text
-        $this->_submit_button_text = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-            $this->_submit_button_text,
-            $this->checkout
-        );
-    }
+	/**
+	 * set_submit_button_text
+	 * sets the text that appears on the reg step form submit button
+	 *
+	 * @param string $submit_button_text
+	 */
+	public function set_submit_button_text($submit_button_text = '')
+	{
+		if (! empty($submit_button_text)) {
+			$this->_submit_button_text = $submit_button_text;
+		} else if ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($this->checkout->revisit) {
+				$this->_submit_button_text = sprintf(__('Update %s', 'event_espresso'),
+					$this->checkout->current_step->name());
+			} else {
+				$this->_submit_button_text = sprintf(__('Proceed to %s', 'event_espresso'),
+					$this->checkout->next_step->name());
+			}
+		}
+		// filters the submit button text
+		$this->_submit_button_text = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+			$this->_submit_button_text,
+			$this->checkout
+		);
+	}
 
 
 
-    /**
-     * @param boolean $is_current_step
-     */
-    public function set_is_current_step($is_current_step)
-    {
-        $this->_is_current_step = $is_current_step;
-    }
+	/**
+	 * @param boolean $is_current_step
+	 */
+	public function set_is_current_step($is_current_step)
+	{
+		$this->_is_current_step = $is_current_step;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function is_current_step()
-    {
-        return $this->_is_current_step;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function is_current_step()
+	{
+		return $this->_is_current_step;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function is_final_step()
-    {
-        return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function is_final_step()
+	{
+		return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
+	}
 
 
 
-    /**
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->_order = $order;
-    }
-
-
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->_order = $order;
+	}
+
+
 
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->_order;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function template()
-    {
-        return $this->_template;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function success_message()
-    {
-        return $this->_success_message;
-    }
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->_order;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function template()
+	{
+		return $this->_template;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function success_message()
+	{
+		return $this->_success_message;
+	}
 
 
 
-    /**
-     * _set_success_message
-     *
-     * @param string $success_message
-     */
-    protected function _set_success_message($success_message)
-    {
-        $this->_success_message = $success_message;
-    }
-
-
-
-    /**
-     * _reset_success_message
-     *
-     * @return void
-     */
-    protected function _reset_success_message()
-    {
-        $this->_success_message = '';
-    }
+	/**
+	 * _set_success_message
+	 *
+	 * @param string $success_message
+	 */
+	protected function _set_success_message($success_message)
+	{
+		$this->_success_message = $success_message;
+	}
+
+
+
+	/**
+	 * _reset_success_message
+	 *
+	 * @return void
+	 */
+	protected function _reset_success_message()
+	{
+		$this->_success_message = '';
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public function _instructions()
-    {
-        return $this->_instructions;
-    }
-
-
-
-    /**
-     * @param string $instructions
-     */
-    public function set_instructions($instructions)
-    {
-        $this->_instructions = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
-            $instructions,
-            $this
-        );
-    }
-
-
-
-    /**
-     * @param array $valid_data
-     */
-    public function set_valid_data($valid_data)
-    {
-        $this->_valid_data = $valid_data;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function valid_data()
-    {
-        if (empty($this->_valid_data)) {
-            $this->_valid_data = $this->reg_form->valid_data();
-        }
-        return $this->_valid_data;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function reg_form_name()
-    {
-        if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
-        }
-        return $this->_reg_form_name;
-    }
-
-
-
-    /**
-     * @param string $reg_form_name
-     */
-    protected function set_reg_form_name($reg_form_name)
-    {
-        $this->_reg_form_name = $reg_form_name;
-    }
-
-
-
-    /**
-     * reg_step_url
-     *
-     * @param string $action
-     * @return string
-     */
-    public function reg_step_url($action = '')
-    {
-        $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
-            $query_args['action'] = $action;
-        }
-        // final step has no display
-        if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
-            $query_args['action'] = 'process_reg_step';
-        }
-        if ($this->checkout->revisit) {
-            $query_args['revisit'] = true;
-        }
-        if ($this->checkout->reg_url_link) {
-            $query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
-        }
-        return add_query_arg($query_args, $this->checkout->reg_page_base_url);
-    }
-
-
-
-    /**
-     * creates the default hidden inputs section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function reg_step_hidden_inputs()
-    {
-        // hidden inputs for admin registrations
-        if ($this->checkout->admin_request) {
-            return new EE_Form_Section_Proper(
-                array(
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => array(
-                        'next_step' => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug() : '',
-                            )
-                        ),
-                    ),
-                )
-            );
-        } else {
-            $default_form_action = apply_filters(
-                'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
-                empty($this->checkout->reg_url_link)
-                    ? 'process_reg_step'
-                    : 'update_reg_step',
-                $this
-            );
-            // hidden inputs for frontend registrations
-            return new EE_Form_Section_Proper(
-                array(
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => array(
-                        'action'         => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'action',
-                                'html_id'   => 'spco-' . $this->slug() . '-action',
-                                'default'   => $default_form_action,
-                            )
-                        ),
-                        'next_step'      => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug() : '',
-                            )
-                        ),
-                        'e_reg_url_link' => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'e_reg_url_link',
-                                'html_id'   => 'spco-reg_url_link',
-                                'default'   => $this->checkout->reg_url_link,
-                            )
-                        ),
-                        'revisit'        => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'revisit',
-                                'html_id'   => 'spco-revisit',
-                                'default'   => $this->checkout->revisit,
-                            )
-                        ),
-                    ),
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * generate_reg_form_for_actions
-     *
-     * @param array $actions
-     * @return void
-     */
-    public function generate_reg_form_for_actions($actions = array())
-    {
-        $actions = array_merge(
-            array(
-                'generate_reg_form',
-                'display_spco_reg_step',
-                'process_reg_step',
-                'update_reg_step',
-            ), $actions
-        );
-        $this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function display_reg_form()
-    {
-        $html = '';
-        if ($this->reg_form instanceof EE_Form_Section_Proper) {
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
-            if (EE_Registry::instance()->REQ->ajax) {
-                $this->reg_form->localize_validation_rules();
-                $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-            }
-            $html .= $this->reg_form->get_html();
-            $html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_step_submit_button()
-    {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            return '';
-        }
-        ob_start();
-        do_action('AHEE__before_spco_whats_next_buttons', $this->slug(), $this->checkout->next_step->slug(),
-            $this->checkout);
-        $html = ob_get_clean();
-        // generate submit button
-        $sbmt_btn = new EE_Submit_Input(array(
-            'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-            'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-            'html_class'            => 'spco-next-step-btn',
-            'other_html_attributes' => ' rel="' . $this->slug() . '"',
-            'default'               => $this->submit_button_text(),
-        ));
-        $sbmt_btn->set_button_css_attributes(true, 'large');
-        $sbmt_btn_html = $sbmt_btn->get_html_for_input();
-        $html .= EEH_HTML::div(
-            apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
-            'spco-whats-next-buttons'
-        );
-        return $html;
-    }
-
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     */
-    public function div_class()
-    {
-        return $this->is_current_step() ? '' : ' hidden';
-    }
-
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_lnk_url()
-    {
-        return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
-    }
-
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_link_class()
-    {
-        return $this->is_current_step() ? ' hidden' : '';
-    }
-
-
-
-    /**
-     * update_checkout with changes that have been made to the cart
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function update_checkout()
-    {
-        // grab the cart grand total and reset TXN total
-        $this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
-        $this->checkout->stash_transaction_and_checkout();
-    }
-
-
-
-    /**
-     *    __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'));
-    }
+	/**
+	 * @return string
+	 */
+	public function _instructions()
+	{
+		return $this->_instructions;
+	}
+
+
+
+	/**
+	 * @param string $instructions
+	 */
+	public function set_instructions($instructions)
+	{
+		$this->_instructions = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
+			$instructions,
+			$this
+		);
+	}
+
+
+
+	/**
+	 * @param array $valid_data
+	 */
+	public function set_valid_data($valid_data)
+	{
+		$this->_valid_data = $valid_data;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function valid_data()
+	{
+		if (empty($this->_valid_data)) {
+			$this->_valid_data = $this->reg_form->valid_data();
+		}
+		return $this->_valid_data;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_form_name()
+	{
+		if (empty($this->_reg_form_name)) {
+			$this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+		}
+		return $this->_reg_form_name;
+	}
+
+
+
+	/**
+	 * @param string $reg_form_name
+	 */
+	protected function set_reg_form_name($reg_form_name)
+	{
+		$this->_reg_form_name = $reg_form_name;
+	}
+
+
+
+	/**
+	 * reg_step_url
+	 *
+	 * @param string $action
+	 * @return string
+	 */
+	public function reg_step_url($action = '')
+	{
+		$query_args = array('step' => $this->slug());
+		if (! empty($action)) {
+			$query_args['action'] = $action;
+		}
+		// final step has no display
+		if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
+			$query_args['action'] = 'process_reg_step';
+		}
+		if ($this->checkout->revisit) {
+			$query_args['revisit'] = true;
+		}
+		if ($this->checkout->reg_url_link) {
+			$query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
+		}
+		return add_query_arg($query_args, $this->checkout->reg_page_base_url);
+	}
+
+
+
+	/**
+	 * creates the default hidden inputs section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function reg_step_hidden_inputs()
+	{
+		// hidden inputs for admin registrations
+		if ($this->checkout->admin_request) {
+			return new EE_Form_Section_Proper(
+				array(
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => array(
+						'next_step' => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug() : '',
+							)
+						),
+					),
+				)
+			);
+		} else {
+			$default_form_action = apply_filters(
+				'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
+				empty($this->checkout->reg_url_link)
+					? 'process_reg_step'
+					: 'update_reg_step',
+				$this
+			);
+			// hidden inputs for frontend registrations
+			return new EE_Form_Section_Proper(
+				array(
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => array(
+						'action'         => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'action',
+								'html_id'   => 'spco-' . $this->slug() . '-action',
+								'default'   => $default_form_action,
+							)
+						),
+						'next_step'      => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug() : '',
+							)
+						),
+						'e_reg_url_link' => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'e_reg_url_link',
+								'html_id'   => 'spco-reg_url_link',
+								'default'   => $this->checkout->reg_url_link,
+							)
+						),
+						'revisit'        => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'revisit',
+								'html_id'   => 'spco-revisit',
+								'default'   => $this->checkout->revisit,
+							)
+						),
+					),
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * generate_reg_form_for_actions
+	 *
+	 * @param array $actions
+	 * @return void
+	 */
+	public function generate_reg_form_for_actions($actions = array())
+	{
+		$actions = array_merge(
+			array(
+				'generate_reg_form',
+				'display_spco_reg_step',
+				'process_reg_step',
+				'update_reg_step',
+			), $actions
+		);
+		$this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function display_reg_form()
+	{
+		$html = '';
+		if ($this->reg_form instanceof EE_Form_Section_Proper) {
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
+			if (EE_Registry::instance()->REQ->ajax) {
+				$this->reg_form->localize_validation_rules();
+				$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+			}
+			$html .= $this->reg_form->get_html();
+			$html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_step_submit_button()
+	{
+		if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			return '';
+		}
+		ob_start();
+		do_action('AHEE__before_spco_whats_next_buttons', $this->slug(), $this->checkout->next_step->slug(),
+			$this->checkout);
+		$html = ob_get_clean();
+		// generate submit button
+		$sbmt_btn = new EE_Submit_Input(array(
+			'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+			'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+			'html_class'            => 'spco-next-step-btn',
+			'other_html_attributes' => ' rel="' . $this->slug() . '"',
+			'default'               => $this->submit_button_text(),
+		));
+		$sbmt_btn->set_button_css_attributes(true, 'large');
+		$sbmt_btn_html = $sbmt_btn->get_html_for_input();
+		$html .= EEH_HTML::div(
+			apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
+			'spco-' . $this->slug() . '-whats-next-buttons-dv',
+			'spco-whats-next-buttons'
+		);
+		return $html;
+	}
+
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 */
+	public function div_class()
+	{
+		return $this->is_current_step() ? '' : ' hidden';
+	}
+
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_lnk_url()
+	{
+		return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
+	}
+
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_link_class()
+	{
+		return $this->is_current_step() ? ' hidden' : '';
+	}
+
+
+
+	/**
+	 * update_checkout with changes that have been made to the cart
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function update_checkout()
+	{
+		// grab the cart grand total and reset TXN total
+		$this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
+		$this->checkout->stash_transaction_and_checkout();
+	}
+
+
+
+	/**
+	 *    __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'));
+	}
 
 
 

Spacing +14 added lines, -14 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -238,7 +238,7 @@ 
      */
     public function set_submit_button_text($submit_button_text = '')
     {
-        if (! empty($submit_button_text)) {
+        if ( ! empty($submit_button_text)) {
             $this->_submit_button_text = $submit_button_text;
         } else if ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             if ($this->checkout->revisit) {
@@ -406,7 +406,7 @@ 
     public function reg_form_name()
     {
         if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+            $this->set_reg_form_name('ee-spco-'.$this->slug().'-reg-step-form');
         }
         return $this->_reg_form_name;
     }
@@ -432,7 +432,7 @@ 
     public function reg_step_url($action = '')
     {
         $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $query_args['action'] = $action;
         }
         // final step has no display
@@ -463,12 +463,12 @@ 
             return new EE_Form_Section_Proper(
                 array(
                     'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                    'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                     'subsections'     => array(
                         'next_step' => new EE_Fixed_Hidden_Input(
                             array(
                                 'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                                'html_id'   => 'spco-'.$this->slug().'-next-step',
                                 'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                     ? $this->checkout->next_step->slug() : '',
                             )
@@ -488,19 +488,19 @@ 
             return new EE_Form_Section_Proper(
                 array(
                     'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                    'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                     'subsections'     => array(
                         'action'         => new EE_Fixed_Hidden_Input(
                             array(
                                 'html_name' => 'action',
-                                'html_id'   => 'spco-' . $this->slug() . '-action',
+                                'html_id'   => 'spco-'.$this->slug().'-action',
                                 'default'   => $default_form_action,
                             )
                         ),
                         'next_step'      => new EE_Fixed_Hidden_Input(
                             array(
                                 'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                                'html_id'   => 'spco-'.$this->slug().'-next-step',
                                 'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                     ? $this->checkout->next_step->slug() : '',
                             )
@@ -578,7 +578,7 @@ 
      */
     public function reg_step_submit_button()
     {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             return '';
         }
         ob_start();
@@ -587,17 +587,17 @@ 
         $html = ob_get_clean();
         // generate submit button
         $sbmt_btn = new EE_Submit_Input(array(
-            'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-            'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+            'html_name'             => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
+            'html_id'               => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
             'html_class'            => 'spco-next-step-btn',
-            'other_html_attributes' => ' rel="' . $this->slug() . '"',
+            'other_html_attributes' => ' rel="'.$this->slug().'"',
             'default'               => $this->submit_button_text(),
         ));
         $sbmt_btn->set_button_css_attributes(true, 'large');
         $sbmt_btn_html = $sbmt_btn->get_html_for_input();
         $html .= EEH_HTML::div(
             apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
+            'spco-'.$this->slug().'-whats-next-buttons-dv',
             'spco-whats-next-buttons'
         );
         return $html;

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

Indentation +94 added lines, -94 removed lines

@@ -286,41 +286,41 @@ 
 			$this->checkout->revisit
 		);
 		foreach ( $registrations as $REG_ID => $registration ) {
-            /** @var $registration EE_Registration */
-            // has this registration lost it's space ?
+			/** @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 (
+			// 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 (
 				// returning registrant
 				$this->checkout->revisit
 				// anything other than Approved
 				&& $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;
+				&& (
+					$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() ) {
@@ -428,11 +428,11 @@ 
 			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
-                    )
+						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;
 	}
@@ -481,46 +481,46 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function find_registrations_that_lost_their_space( array $registrations, $revisit = false ) {
-        // registrations per event
+		// 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
+		// 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;
+			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();
-                }
-            }
+			$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 ]
-                )
+					$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 ) {
@@ -589,9 +589,9 @@ 
 				'layout_strategy'		=> new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'sold_out_events.template.php',
+												  . $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(
@@ -644,9 +644,9 @@ 
 				'layout_strategy' => new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'sold_out_events.template.php',
+												  . $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(
@@ -694,9 +694,9 @@ 
 				'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
+												  . $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(
@@ -734,9 +734,9 @@ 
 				'layout_strategy' 	=> new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'no_payment_required.template.php', // layout_template
+												  . $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(
@@ -964,7 +964,7 @@ 
 					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
 				}
 				$payment_methods_billing_info[ $payment_method->slug()
-				                               . '-info' ] = $this->_payment_method_billing_info(
+											   . '-info' ] = $this->_payment_method_billing_info(
 					$payment_method
 				);
 			}
@@ -1152,7 +1152,7 @@ 
 		// fill form with attendee info if applicable
 		if (
 			$payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
-		    && $this->checkout->transaction_has_primary_registrant()
+			&& $this->checkout->transaction_has_primary_registrant()
 		) {
 			$payment_method_billing_form->populate_from_attendee(
 				$this->checkout->transaction->primary_registration()->attendee()
@@ -1161,7 +1161,7 @@ 
 		// and debug content
 		if (
 			$payment_method_billing_form instanceof EE_Billing_Info_Form
-		    && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+			&& $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
@@ -1336,7 +1336,7 @@ 
 		}
 		// 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->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
@@ -1506,8 +1506,8 @@ 
 		}
 		// 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'] )
+			 && ! empty( $attendee_data['ATT_lname'] )
+			 && ! empty( $attendee_data['ATT_email'] )
 		) {
 			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
 				array(
@@ -1754,7 +1754,7 @@ 
 			$payment_status = $payment->status();
 			if (
 				$payment_status === EEM_Payment::status_id_approved
-			    || $payment_status === EEM_Payment::status_id_pending
+				|| $payment_status === EEM_Payment::status_id_pending
 			) {
 				return true;
 			} else {
@@ -1980,8 +1980,8 @@ 
 			return false;
 		}
 		if ( ! $primary_registration->_add_relation_to( $this->checkout->primary_attendee_obj, 'Attendee' )
-		       instanceof
-		       EE_Attendee
+			   instanceof
+			   EE_Attendee
 		) {
 			EE_Error::add_error(
 				sprintf(
@@ -2699,19 +2699,19 @@ 
 
 
 
-    /**
-     *    __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' ) );
-    }
+	/**
+	 *    __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' ) );
+	}
 
 
 

Spacing +362 added lines, -362 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -38,32 +38,32 @@ 
 	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' )
+			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' )
+			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' )
+			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_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' )
+			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' )
+			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' )
+			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' ),
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
 			10,
 			1
 		);
@@ -77,7 +77,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function switch_spco_billing_form() {
-		EED_Single_Page_Checkout::process_ajax_request( 'switch_payment_method' );
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
 	}
 
 
@@ -88,7 +88,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function save_payer_details() {
-		EED_Single_Page_Checkout::process_ajax_request( 'save_payer_details_via_ajax' );
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
 	}
 
 
@@ -99,7 +99,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function get_transaction_details() {
-		EED_Single_Page_Checkout::process_ajax_request( 'get_transaction_details_for_gateways' );
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
 	}
 
 
@@ -126,10 +126,10 @@ 
 	 * @access    public
 	 * @param    EE_Checkout $checkout
 	 */
-	public function __construct( EE_Checkout $checkout ) {
+	public function __construct(EE_Checkout $checkout) {
 		$this->_slug = 'payment_options';
-		$this->_name = __( 'Payment Options', 'event_espresso' );
-		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+		$this->_name = __('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(
@@ -154,7 +154,7 @@ 
 	/**
 	 * @param null $line_item_display
 	 */
-	public function set_line_item_display( $line_item_display ) {
+	public function set_line_item_display($line_item_display) {
 		$this->line_item_display = $line_item_display;
 	}
 
@@ -172,8 +172,8 @@ 
 	/**
 	 * @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 );
+	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);
 	}
 
 
@@ -208,14 +208,14 @@ 
 	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 ) ) {
+		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 ) {
+		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 ) {
+			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();
 				}
 			}
@@ -240,20 +240,20 @@ 
 			// 	$ 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 ) )
+			&& ! 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() ) {
+			if ($this->is_current_step()) {
 				$this->checkout->generate_reg_form = false;
 			}
-			$this->checkout->remove_reg_step( $this->_slug );
+			$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' );
+		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,
@@ -280,16 +280,16 @@ 
 		$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 );
+		$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 ) {
+		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();
+			if (isset($ejected_registrations[$REG_ID])) {
+				$insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
 				continue;
 			}
             // event requires admin approval
@@ -310,11 +310,11 @@ 
 				&& $registration->status_ID() !== EEM_Registration::status_id_approved
                 && (
                     $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out( true )
+                    || $registration->event()->is_sold_out(true)
                 )
             ) {
                 // add event to list of events that are sold out
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
+                $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(),
@@ -323,8 +323,8 @@ 
                 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;
+			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(),
@@ -335,29 +335,29 @@ 
 				&& $registration->status_ID() !== EEM_Registration::status_id_not_approved
 				&& $registration->ticket()->is_free()
 			) {
-				$registrations_for_free_events[ $registration->event()->ID() ] = $registration;
+				$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($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 ) ) {
-			$subsections['no_payment_required'] = $this->_no_payment_required( $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 ( $this->checkout->amount_owing > 0 ) {
+		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(
@@ -370,15 +370,15 @@ 
 				/** @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' ) );
+				$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 )
+						array('registrations' => $registrations)
 					)
 				);
 				$this->checkout->amount_owing = $filtered_line_item_tree->total();
-				$this->_apply_registration_payments_to_amount_owing( $registrations );
+				$this->_apply_registration_payments_to_amount_owing($registrations);
 			}
 			$no_payment_required = false;
 		} else {
@@ -387,7 +387,7 @@ 
 		$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 );
+		$subsections['extra_hidden_inputs'] = $this->_extra_hidden_inputs($no_payment_required);
 
 		return new EE_Form_Section_Proper(
 			array(
@@ -414,14 +414,14 @@ 
 	 * @return \EE_Line_Item_Filter_Collection
 	 * @throws \EE_Error
 	 */
-	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 ) {
+	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 ) {
+		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(
@@ -433,7 +433,7 @@ 
 				)
 			)
         );
-		$line_item_filter_collection->add( new EE_Non_Zero_Line_Item_Filter() );
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
 		return $line_item_filter_collection;
 	}
 
@@ -449,15 +449,15 @@ 
 	 * @return \EE_Registration[]
 	 * @throws \EE_Error
 	 */
-	public static function remove_ejected_registrations( array $registrations ) {
+	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 ) {
+		foreach ($registrations as $REG_ID => $registration) {
 			// has this registration lost it's space ?
-			if ( isset( $ejected_registrations[ $REG_ID ] ) ) {
-				unset( $registrations[ $REG_ID ] );
+			if (isset($ejected_registrations[$REG_ID])) {
+				unset($registrations[$REG_ID]);
 				continue;
 			}
 		}
@@ -480,7 +480,7 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-	public static function find_registrations_that_lost_their_space( array $registrations, $revisit = false ) {
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false) {
         // registrations per event
 		$event_reg_count = array();
 		// spaces left per event
@@ -489,7 +489,7 @@ 
         $tickets_remaining = array();
         // registrations that have lost their space
 		$ejected_registrations = array();
-		foreach ( $registrations as $REG_ID => $registration ) {
+		foreach ($registrations as $REG_ID => $registration) {
             if (
                 $registration->status_ID() === EEM_Registration::status_id_approved
                 || apply_filters(
@@ -519,13 +519,13 @@ 
 				$revisit
 				&& (
                     $tickets_remaining[$ticket->ID()] === 0
-				    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
+				    || $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 ) {
+				$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' );
+					$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,
@@ -560,8 +560,8 @@ 
 	 * @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' );
+		if ($this->checkout->revisit) {
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
 		}
 	}
 
@@ -575,13 +575,13 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _sold_out_events( $sold_out_events_array = array() ) {
+	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 ) {
+		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' )
+				EEH_HTML::span('  '.$sold_out_event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
 			);
 		}
 		return new EE_Form_Section_Proper(
@@ -599,7 +599,7 @@ 
 								'sold_out_events_msg' => apply_filters(
 									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
 									sprintf(
-										__( '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' ),
+										__('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 />'
@@ -624,14 +624,14 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _insufficient_spaces_available( $insufficient_spaces_events_array = array() ) {
+	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 ) {
+		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')
 				);
 			}
 		}
@@ -675,17 +675,17 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _registrations_requiring_pre_approval( $registrations_requiring_pre_approval = array() ) {
+	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(
+		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' )
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
 				);
 			}
 		}
@@ -700,7 +700,7 @@ 
 						'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'     => 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',
 									__(
@@ -725,7 +725,7 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _no_payment_required( $registrations_for_free_events = array() ) {
+	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
@@ -745,7 +745,7 @@ 
 								'ticket_count'                  => array(),
 								'registrations_for_free_events' => $registrations_for_free_events,
 								'no_payment_required_msg'       => EEH_HTML::p(
-									__( 'This is a free event, so no billing will occur.', 'event_espresso' )
+									__('This is a free event, so no billing will occur.', 'event_espresso')
 								)
 							)
 						),
@@ -764,7 +764,7 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _display_payment_options( $transaction_details = '' ) {
+	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
@@ -776,14 +776,14 @@ 
 						'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() )
+								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() )
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
 							)
 						),
 					),
@@ -814,10 +814,10 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _extra_hidden_inputs( $no_payment_required = true ) {
+	private function _extra_hidden_inputs($no_payment_required = true) {
 		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(
@@ -849,16 +849,16 @@ 
 	 * @access protected
 	 * @param array $registrations
 	 */
-	protected function _apply_registration_payments_to_amount_owing( array $registrations ) {
+	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() ) {
+		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 ) {
+		if ( ! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Registration_Payment) {
 					$this->checkout->amount_owing -= $payment->amount();
 				}
 			}
@@ -874,11 +874,11 @@ 
 	 * @param    bool $force_reset
 	 * @return    void
 	 */
-	private function _reset_selected_method_of_payment( $force_reset = false ) {
+	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 ) {
+			: 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;
@@ -897,12 +897,12 @@ 
 	 * @param string $selected_method_of_payment
 	 * @return  void
 	 */
-	private function _save_selected_method_of_payment( $selected_method_of_payment = '' ) {
-		$selected_method_of_payment = ! empty( $selected_method_of_payment )
+	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 )
+			array('selected_method_of_payment' => $selected_method_of_payment)
 		);
 	}
 
@@ -918,19 +918,19 @@ 
 		// load payment method classes
 		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
 		// 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',
-				__( 'Please Select Your Method of Payment', 'event_espresso' )
+				__('Please Select Your Method of Payment', 'event_espresso')
 			)
 			: apply_filters(
 				'FHEE__registration_page_payment_options__method_of_payment_hdr',
-				__( 'Method of Payment', 'event_espresso' )
+				__('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' )
+				EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
 			)
 		);
 		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
@@ -939,32 +939,32 @@ 
 		// 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;' )
+				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 ) {
+		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-'.$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->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;
+					$default_payment_method_option[$payment_method->slug()] = $payment_method_button;
 				} else {
-					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
+					$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
 				);
 			}
@@ -994,12 +994,12 @@ 
 	 * @return EE_Payment_Method[]
 	 */
 	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();
 		// load EEM_Payment_Method
-		EE_Registry::instance()->load_model( '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
@@ -1007,9 +1007,9 @@ 
 			$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;
+		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;
@@ -1024,14 +1024,14 @@ 
 	 * @param    array $available_payment_method_options
 	 * @return    \EE_Form_Section_Proper
 	 */
-	private function _available_payment_method_inputs( $available_payment_method_options = array() ) {
+	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 (
+					'' => new EE_Radio_Button_Input(
 						$available_payment_method_options,
 						array(
 							'html_name'          => 'selected_method_of_payment',
@@ -1056,28 +1056,28 @@ 
 	 * @return    \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _payment_method_billing_info( EE_Payment_Method $payment_method ) {
+	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 )
+			? $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(
-			__( 'Important information regarding your payment', 'event_espresso' ),
+			__('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() ) {
+		if ($payment_method->description()) {
 			$payment_method_info = $payment_method->description();
-		} elseif ( $billing_form instanceof EE_Billing_Info_Form ) {
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
 			$payment_method_info = sprintf(
 				__(
 					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
@@ -1087,7 +1087,7 @@ 
 			);
 		} else {
 			$payment_method_info = sprintf(
-				__( 'Please click the "%1$s" button below in order to proceed.', 'event_espresso' ),
+				__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
 				$this->submit_button_text()
 			);
 		}
@@ -1101,13 +1101,13 @@ 
 		);
 		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;',
 				'layout_strategy' => new EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
-					'info'         => new EE_Form_Section_HTML( $info_html ),
+					'info'         => new EE_Form_Section_HTML($info_html),
 					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML()
 				)
 			)
@@ -1125,15 +1125,15 @@ 
 	 */
 	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->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(
+		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',
@@ -1148,7 +1148,7 @@ 
 			);
 		}
 		// now generate billing form for selected method of payment
-		$payment_method_billing_form = $this->_get_billing_form_for_payment_method( $this->checkout->payment_method );
+		$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
@@ -1170,10 +1170,10 @@ 
 		$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 ) );
+		$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() );
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
 		return true;
 	}
 
@@ -1187,18 +1187,18 @@ 
 	 * @return \EE_Billing_Info_Form|\EE_Form_Section_HTML
 	 * @throws \EE_Error
 	 */
-	private function _get_billing_form_for_payment_method( EE_Payment_Method $payment_method ) {
+	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 )
+			array('amount_owing' => $this->checkout->amount_owing)
 		);
-		if ( $billing_form instanceof EE_Billing_Info_Form ) {
+		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_Registry::instance()->REQ->is_set('payment_method')
 			) {
 				EE_Error::add_success(
 					apply_filters(
@@ -1240,15 +1240,15 @@ 
 		$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 ) {
+		$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 = 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 );
+			$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 );
+			$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(
@@ -1256,7 +1256,7 @@ 
 			);
 		}
 		// do ya really really gotta have it?
-		if ( empty( $selected_method_of_payment ) && $required ) {
+		if (empty($selected_method_of_payment) && $required) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1265,7 +1265,7 @@ 
 					),
 					'<br/>',
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1292,13 +1292,13 @@ 
 	 * @throws \EE_Error
 	 */
 	public function switch_payment_method() {
-		if ( ! $this->_verify_payment_method_is_set() ) {
+		if ( ! $this->_verify_payment_method_is_set()) {
 			return false;
 		}
-		if ( apply_filters(
+		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',
@@ -1313,7 +1313,7 @@ 
 			);
 		}
 		// 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() ) {
+		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
 			);
@@ -1335,7 +1335,7 @@ 
 			);
 		}
 		// and debug content
-		if ( $this->checkout->billing_form instanceof EE_Billing_Info_Form
+		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(
@@ -1343,15 +1343,15 @@ 
 			);
 		}
 		// get html and validation rules for form
-		if ( $this->checkout->billing_form instanceof EE_Form_Section_Proper ) {
+		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() )
+				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() );
+			$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' => '' ) );
+			$this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
 		}
 		//prevents advancement to next step
 		$this->checkout->continue_reg = false;
@@ -1368,18 +1368,18 @@ 
 	 */
 	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 ) ) {
+		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 );
+			$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 ) {
+			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',
-							__( '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' )
+							__('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__
 					);
@@ -1389,7 +1389,7 @@ 
 					EE_Error::add_attention(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
-							__( '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' )
+							__('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__
 					);
@@ -1399,7 +1399,7 @@ 
 					EE_Error::add_attention(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
-							__( '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' )
+							__('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__
 					);
@@ -1409,7 +1409,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();
 		}
@@ -1428,25 +1428,25 @@ 
 	 * @throws \EE_Error
 	 */
 	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
-		if ( $this->checkout->payment_method->type_obj()->has_billing_form() ) {
+		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() ) {
+		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() ) {
+			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 );
+						$registration->_add_relation_to($attendee, 'Attendee');
+						$registration->set_attendee_id($attendee->ID());
+						$registration->update_cache_after_object_save('Attendee', $attendee);
 					}
 				}
 			}
@@ -1464,50 +1464,50 @@ 
 	 */
 	protected function _create_attendee_from_request_data() {
 		// get State ID
-		$STA_ID = ! empty( $_REQUEST['state'] ) ? sanitize_text_field( $_REQUEST['state'] ) : '';
-		if ( ! empty( $STA_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;
+			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 ) ) {
+		$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' );
+			EE_Registry::instance()->load_model('Country');
 			$country = EEM_Country::instance()->get_col(
-				array( array( 'CNT_name' => $CNT_ISO ), 'limit' => 1 ),
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
 				'CNT_ISO'
 			);
-			$CNT_ISO = is_array( $country ) && ! empty( $country ) ? reset( $country ) : $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'] ) : '',
+			'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'] ) : '',
+			'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'] ) {
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
 			EE_Error::add_error(
-				__( 'An invalid email address was submitted.', 'event_espresso' ),
+				__('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'] )
+		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(
@@ -1516,19 +1516,19 @@ 
 					'ATT_email' => $attendee_data['ATT_email']
 				)
 			);
-			if ( $existing_attendee instanceof EE_Attendee ) {
+			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'] = ! 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'] = ! empty($attendee_data['ATT_lname'])
 			? $attendee_data['ATT_lname']
 			: $attendee_data['ATT_email'];
-		return EE_Attendee::new_instance( $attendee_data );
+		return EE_Attendee::new_instance($attendee_data);
 	}
 
 
@@ -1546,26 +1546,26 @@ 
 		// 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 );
+			: $this->_get_selected_method_of_payment(true);
 		// choose your own adventure based on method_of_payment
-		switch ( $this->checkout->selected_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 );
+				$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(
+				if (apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
 					false
-				) ) {
+				)) {
 					EE_Error::add_success(
-						__( 'no payment required at this time.', 'event_espresso' ),
+						__('no payment required at this time.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1577,12 +1577,12 @@ 
 				break;
 
 			case 'no_payment_required' :
-				if ( apply_filters(
+				if (apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
 					false
-				) ) {
+				)) {
 					EE_Error::add_success(
-						__( 'no payment required.', 'event_espresso' ),
+						__('no payment required.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1602,15 +1602,15 @@ 
 					EE_Registry::instance()->SSN->checkout()->revisit
 				);
 				// calculate difference between the two arrays
-				$registrations = array_diff( $registrations, $ejected_registrations );
-				if ( empty( $registrations ) ) {
+				$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 ) {
+				if ($payment_successful) {
 					$this->checkout->continue_reg = true;
-					$this->_maybe_set_completed( $this->checkout->payment_method );
+					$this->_maybe_set_completed($this->checkout->payment_method);
 				} else {
 					$this->checkout->continue_reg = false;
 				}
@@ -1631,10 +1631,10 @@ 
 		$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 ),
+			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 );
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 	}
 
 
@@ -1647,8 +1647,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _maybe_set_completed( EE_Payment_Method $payment_method ) {
-		switch ( $payment_method->type_obj()->payment_occurs() ) {
+	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 :
@@ -1671,7 +1671,7 @@ 
 	public function update_reg_step() {
 		$success = true;
 		// if payment required
-		if ( $this->checkout->transaction->total() > 0 ) {
+		if ($this->checkout->transaction->total() > 0) {
 			do_action(
 				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
 				$this->checkout->transaction
@@ -1679,13 +1679,13 @@ 
 			// attempt payment via payment method
 			$success = $this->process_reg_step();
 		}
-		if ( $success && ! $this->checkout->redirect ) {
+		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 ),
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
 				$this->checkout->thank_you_page_url
 			);
 		}
@@ -1703,36 +1703,36 @@ 
 	 */
 	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
-		if ( empty( $this->checkout->selected_method_of_payment ) ) {
+		if (empty($this->checkout->selected_method_of_payment)) {
 			$this->checkout->json_response->set_plz_select_method_of_payment(
-				__( 'Please select a method of payment before proceeding.', 'event_espresso' )
+				__('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() ) {
+		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() ) {
+		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() ) {
+			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)
-		if ( ( time() - EE_Registry::instance()->SSN->expiration() ) < EE_Registry::instance()->SSN->extension() ) {
+		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();
 		}
@@ -1741,12 +1741,12 @@ 
 		// 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 );
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
 		// process results
-		$payment = $this->_validate_payment( $payment );
-		$payment = $this->_post_payment_processing( $payment );
+		$payment = $this->_validate_payment($payment);
+		$payment = $this->_post_payment_processing($payment);
 		// verify payment
-		if ( $payment instanceof EE_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
@@ -1760,7 +1760,7 @@ 
 			} else {
 				return false;
 			}
-		} else if ( $payment === true ) {
+		} 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;
@@ -1780,22 +1780,22 @@ 
 	 */
 	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();
-		if ( empty( $registrations ) ) {
+		if (empty($registrations)) {
 			return false;
 		}
-		foreach ( $registrations as $registration ) {
-			if ( $registration instanceof EE_Registration ) {
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
 				$event = $registration->event_obj();
-				if ( $event instanceof EE_Event && $event->is_sold_out( true ) ) {
+				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(
-								__( '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' ),
+								__('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()
 							)
 						),
@@ -1825,7 +1825,7 @@ 
 		);
 		$html = $payment_method_billing_info->get_html();
 		$html .= $this->checkout->redirect_form;
-		EE_Registry::instance()->REQ->add_output( $html );
+		EE_Registry::instance()->REQ->add_output($html);
 		return true;
 	}
 
@@ -1839,28 +1839,28 @@ 
 	 * @throws \EE_Error
 	 */
 	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 ) {
-			if ( $this->checkout->billing_form->was_submitted() ) {
+		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() ) {
+				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 ) {
+				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 ) {
+						if ($form_section instanceof EE_Form_Input_Base) {
 							$label = $form_section->html_label_text();
-						} elseif ( $form_section instanceof EE_Form_Section_Base ) {
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
 							$label = $form_section->name();
 						} else {
-							$label = __( 'Validation Error', 'event_espresso' );
+							$label = __('Validation Error', 'event_espresso');
 						}
-						$error_strings[] = sprintf( '%1$s: %2$s', $label, $validation_error->getMessage() );
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
 					}
 				}
 				EE_Error::add_error(
@@ -1870,7 +1870,7 @@ 
 							'event_espresso'
 						),
 						'<br/>',
-						implode( '<br/>', $error_strings )
+						implode('<br/>', $error_strings)
 					),
 					__FILE__,
 					__FUNCTION__,
@@ -1889,7 +1889,7 @@ 
 			}
 		} else {
 			EE_Error::add_error(
-				__( 'The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso' ),
+				__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -1928,7 +1928,7 @@ 
 		// 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() );
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
 		// save what we have so far
 		$primary_registration->save();
 		return true;
@@ -1946,7 +1946,7 @@ 
 	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 ) {
+		if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1954,7 +1954,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1963,7 +1963,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(
 					__(
@@ -1971,7 +1971,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1979,7 +1979,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
 		) {
@@ -1990,7 +1990,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1999,9 +1999,9 @@ 
 			return false;
 		}
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( '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 );
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
 		return true;
 	}
 
@@ -2016,22 +2016,22 @@ 
 	 * @throws \EE_Error
 	 */
 	private function _get_payment_method_for_selected_method_of_payment() {
-		if ( $this->checkout->selected_method_of_payment === 'events_sold_out' ) {
+		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 ];
+		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' );
+			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 );
+			$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(
@@ -2040,7 +2040,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2049,7 +2049,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(
@@ -2058,7 +2058,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2079,29 +2079,29 @@ 
 	 * @return    mixed    EE_Payment | boolean
 	 * @throws \EE_Error
 	 */
-	private function _attempt_payment( EE_Payment_Method $payment_method ) {
+	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 ) {
+		$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 );
+			$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 ),
+				$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 );
+		} catch (Exception $e) {
+			$this->_handle_payment_processor_exception($e);
 		}
 		return $payment;
 	}
@@ -2116,7 +2116,7 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _handle_payment_processor_exception( Exception $e ) {
+	protected function _handle_payment_processor_exception(Exception $e) {
 		EE_Error::add_error(
 			sprintf(
 				__(
@@ -2124,7 +2124,7 @@ 
 					'event_espresso'
 				),
 				'<br/>',
-				EE_Registry::instance()->CFG->organization->get_pretty( 'email' ),
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
 				$e->getMessage(),
 				$e->getFile(),
 				$e->getLine()
@@ -2145,9 +2145,9 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	protected function _get_return_url( EE_Payment_Method $payment_method ) {
+	protected function _get_return_url(EE_Payment_Method $payment_method) {
 		$return_url = '';
-		switch ( $payment_method->type_obj()->payment_occurs() ) {
+		switch ($payment_method->type_obj()->payment_occurs()) {
 			case EE_PMT_Base::offsite :
 				$return_url = add_query_arg(
 					array(
@@ -2176,12 +2176,12 @@ 
 	 * @return EE_Payment | FALSE
 	 * @throws \EE_Error
 	 */
-	private function _validate_payment( $payment = null ) {
-		if ( $this->checkout->payment_method->is_off_line() ) {
+	private function _validate_payment($payment = null) {
+		if ($this->checkout->payment_method->is_off_line()) {
 			return true;
 		}
 		// verify payment object
-		if ( ! $payment instanceof EE_Payment ) {
+		if ( ! $payment instanceof EE_Payment) {
 			// not a payment
 			EE_Error::add_error(
 				sprintf(
@@ -2190,7 +2190,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2211,27 +2211,27 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _post_payment_processing( $payment = null ) {
+	private function _post_payment_processing($payment = null) {
 		// Off-Line payment?
-		if ( $payment === true ) {
+		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 ) ) {
+		} 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() ) {
+		} 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()' );
+			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' );
+				$this->checkout->redirect_url = $this->reg_step_url('redirect_form');
 				// set JSON response
-				$this->checkout->json_response->set_redirect_form( $this->checkout->redirect_form );
+				$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(
@@ -2239,7 +2239,7 @@ 
 					$this->checkout->transaction->ID()
 				);
 				// and lastly, let's bump the payment status to pending
-				$payment->set_status( EEM_Payment::status_id_pending );
+				$payment->set_status(EEM_Payment::status_id_pending);
 				$payment->save();
 			} else {
 				// not a payment
@@ -2251,7 +2251,7 @@ 
 							'event_espresso'
 						),
 						'<br/>',
-						EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
 					),
 					__FILE__,
 					__FUNCTION__,
@@ -2289,21 +2289,21 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _process_payment_status( $payment, $payment_occurs = EE_PMT_Base::offline ) {
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline) {
 		// off-line payment? carry on
-		if ( $payment_occurs === EE_PMT_Base::offline ) {
+		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()' );
+		if ($payment instanceof EE_Payment) {
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
 			$msg = $payment->gateway_response();
 			// check results
-			switch ( $payment->status() ) {
+			switch ($payment->status()) {
 				// good payment
 				case EEM_Payment::status_id_approved :
 					EE_Error::add_success(
-						__( 'Your payment was processed successfully.', 'event_espresso' ),
+						__('Your payment was processed successfully.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -2312,45 +2312,45 @@ 
 					break;
 				// slow payment
 				case EEM_Payment::status_id_pending :
-					if ( empty( $msg ) ) {
+					if (empty($msg)) {
 						$msg = __(
 							'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__ );
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
 					return true;
 					break;
 				// don't wanna payment
 				case EEM_Payment::status_id_cancelled :
-					if ( empty( $msg ) ) {
+					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 ),
+							count($this->checkout->available_payment_methods),
 							'event_espresso'
 						);
 					}
-					EE_Error::add_attention( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
 					return false;
 					break;
 				// not enough payment
 				case EEM_Payment::status_id_declined :
-					if ( empty( $msg ) ) {
+					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 ),
+							count($this->checkout->available_payment_methods),
 							'event_espresso'
 						);
 					}
-					EE_Error::add_attention( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					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__ );
+					if ( ! empty($msg)) {
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 						return false;
 					}
 					// default to error below
@@ -2359,7 +2359,7 @@ 
 		}
 		// 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 ) {
+		if ($payment_occurs === EE_PMT_Base::offsite) {
 			return true;
 		}
 		EE_Error::add_error(
@@ -2369,7 +2369,7 @@ 
 					'event_espresso'
 				),
 				'<br/>',
-				EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
 			),
 			__FILE__,
 			__FUNCTION__,
@@ -2402,13 +2402,13 @@ 
 	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 );
+		$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();
@@ -2422,23 +2422,23 @@ 
 		//	true
 		//);
 		// verify TXN
-		if ( $this->checkout->transaction instanceof EE_Transaction ) {
+		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;
 			}
-			$payment = $this->_process_off_site_payment( $gateway );
-			$payment = $this->_process_cancelled_payments( $payment );
-			$payment = $this->_validate_payment( $payment );
+			$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 ) ) {
+			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() ) {
+				if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
 					$this->set_completed();
 				}
 				return true;
@@ -2462,21 +2462,21 @@ 
 	 * @throws \EE_Error
 	 */
 	private function _validate_offsite_return() {
-		$TXN_ID = (int)EE_Registry::instance()->REQ->get( 'spco_txn', 0 );
-		if ( $TXN_ID !== $this->checkout->transaction->ID() ) {
+		$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 );
+			$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 ) {
+			$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 ) ) {
+				if (empty($tickets)) {
 					$invalid_TXN = true;
 				}
 			} else {
@@ -2486,35 +2486,35 @@ 
 				? $primary_registrant->session_ID()
 				: null;
 			// validate current Session ID and compare against valid TXN session ID
-			if ( EE_Session::instance()->id() === null ) {
+			if (EE_Session::instance()->id() === null) {
 				$invalid_TXN = true;
-			} else if ( EE_Session::instance()->id() === $valid_TXN_SID ) {
+			} else if (EE_Session::instance()->id() === $valid_TXN_SID) {
 				// 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
 				// has this step even been started ?
-				if ( $this->checkout->transaction->reg_step_completed( $this->slug() === false )
+				if ($this->checkout->transaction->reg_step_completed($this->slug() === false)
 				) {
 					// really? you're half way through this reg step, but you never started it ?
 					$invalid_TXN = true;
 				}
 			}
-			if ( $invalid_TXN ) {
+			if ($invalid_TXN) {
 				// is the valid TXN completed ?
-				if ( $valid_TXN instanceof EE_Transaction ) {
+				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 ) {
+					$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 );
+						$this->checkout->refresh_all_entities(true);
 						return;
 					}
 				}
 				// you appear to be lost?
-				$this->_redirect_wayward_request( $primary_registrant );
+				$this->_redirect_wayward_request($primary_registrant);
 			}
 		}
 	}
@@ -2529,14 +2529,14 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _redirect_wayward_request( EE_Registration $primary_registrant ) {
-		if ( ! $primary_registrant instanceof EE_Registration ) {
+	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 ) {
+		if ( ! $primary_registrant instanceof EE_Registration) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -2544,7 +2544,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2575,17 +2575,17 @@ 
 	 * @return \EE_Payment
 	 * @throws \EE_Error
 	 */
-	private function _process_off_site_payment( EE_Offsite_Gateway $gateway ) {
+	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 )
+				$gateway->handle_IPN_in_this_request($request_data, false)
 			);
-			if ( $this->handle_IPN_in_this_request() ) {
+			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_processor = EE_Registry::instance()->load_core('Payment_Processor');
 				$payment = $payment_processor->process_ipn(
 					$request_data,
 					$this->checkout->transaction,
@@ -2598,14 +2598,14 @@ 
 				$payment = $this->checkout->transaction->last_payment();
 				//$payment_source = 'last_payment';
 			}
-		} catch ( Exception $e ) {
+		} 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 ) {
+			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 );
+				$this->_handle_payment_processor_exception($e);
 			}
 		}
 		// DEBUG LOG
@@ -2630,13 +2630,13 @@ 
 	 * @return EE_Payment | FALSE
 	 * @throws \EE_Error
 	 */
-	private function _process_cancelled_payments( $payment = null ) {
+	private function _process_cancelled_payments($payment = null) {
 		if (
 			$payment instanceof EE_Payment
-			&& isset( $_REQUEST['ee_cancel_payment'] )
+			&& isset($_REQUEST['ee_cancel_payment'])
 			&& $payment->status() === EEM_Payment::status_id_failed
 		) {
-			$payment->set_status( EEM_Payment::status_id_cancelled );
+			$payment->set_status(EEM_Payment::status_id_cancelled);
 		}
 		return $payment;
 	}
@@ -2653,14 +2653,14 @@ 
 	public function get_transaction_details_for_gateways() {
 		$txn_details = array();
 		// ya gotta make a choice man
-		if ( empty( $this->checkout->selected_method_of_payment ) ) {
+		if (empty($this->checkout->selected_method_of_payment)) {
 			$txn_details = array(
-				'error' => __( 'Please select a method of payment before proceeding.', 'event_espresso' )
+				'error' => __('Please select a method of payment before proceeding.', 'event_espresso')
 			);
 		}
 		// get EE_Payment_Method object
 		if (
-			empty( $txn_details )
+			empty($txn_details)
 			&&
 			! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
 		) {
@@ -2672,8 +2672,8 @@ 
 				)
 			);
 		}
-		if ( empty( $txn_details ) && $this->checkout->transaction instanceof EE_Transaction ) {
-			$return_url = $this->_get_return_url( $this->checkout->payment_method );
+		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(),
@@ -2684,7 +2684,7 @@ 
 				'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 ),
+				'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(),
@@ -2693,7 +2693,7 @@ 
 				)
 			);
 		}
-		echo wp_json_encode( $txn_details );
+		echo wp_json_encode($txn_details);
 		exit();
 	}
 
@@ -2710,7 +2710,7 @@ 
     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' ) );
+        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
     }
 
 

core/libraries/rest_api/changes/Changes_In_4_8_34.php

Doc Comments -1 removed lines

@@ -32,7 +32,6 @@
      * Removes the checkin and checkout endpoints from the index for requests
      * to api versions lowers than 4.8.33
      *
-     * @param array                                                  $routes_on_this_version
      * @param EventEspresso\core\libraries\rest_api\controllers\Base $controller
      * @return array like $routes_on_this_version
      */

Indentation +34 added lines, -34 removed lines

@@ -12,39 +12,39 @@
 class Changes_In_4_8_34 extends Changes_In_Base
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function set_hooks()
-    {
-        //set a hook to remove the checkout/checkout endpoints if the request 
-        //is for lower than 4.8.33
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'remove_response_headers'),
-            10,
-            3
-        );
-    }
-
-
-
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array                                                  $routes_on_this_version
-     * @param EventEspresso\core\libraries\rest_api\controllers\Base $controller
-     * @return array like $routes_on_this_version
-     */
-    public function remove_response_headers($response_headers, $controller, $requested_version)
-    {
-        if ($controller instanceof Base
-            && $this->applies_to_version($requested_version)
-        ) {
-            return array();
-        }
-        return $response_headers;
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function set_hooks()
+	{
+		//set a hook to remove the checkout/checkout endpoints if the request 
+		//is for lower than 4.8.33
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'remove_response_headers'),
+			10,
+			3
+		);
+	}
+
+
+
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array                                                  $routes_on_this_version
+	 * @param EventEspresso\core\libraries\rest_api\controllers\Base $controller
+	 * @return array like $routes_on_this_version
+	 */
+	public function remove_response_headers($response_headers, $controller, $requested_version)
+	{
+		if ($controller instanceof Base
+			&& $this->applies_to_version($requested_version)
+		) {
+			return array();
+		}
+		return $response_headers;
+	}
 }
 

core/libraries/rest_api/controllers/Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -314,7 +314,7 @@
      *
      * @param string $route
      * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
+     * @param string[]  $match_keys EXCLUDING matching the entire regex
      * @return array where  $match_keys are the keys (the first value of $match_keys
      *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
      *                           array( 'model', 'id' ), will, if the regex is successful, will return

Indentation +304 added lines, -304 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\libraries\rest_api\Rest_Exception;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,309 +20,309 @@ 
 class Base
 {
 
-    const header_prefix_for_ee = 'X-EE-';
-
-    const header_prefix_for_wp = 'X-WP-';
-
-    /**
-     * Contains debug info we'll send back in the response headers
-     *
-     * @var array
-     */
-    protected $_debug_info = array();
-
-    /**
-     * Indicates whether or not the API is in debug mode
-     *
-     * @var boolean
-     */
-    protected $_debug_mode = false;
-
-    /**
-     * Indicates the version that was requested
-     *
-     * @var string
-     */
-    protected $_requested_version;
-
-    /**
-     * flat array of headers to send in the response
-     *
-     * @var array
-     */
-    protected $_response_headers = array();
-
-
-
-    public function __construct()
-    {
-        $this->_debug_mode = defined('EE_REST_API_DEBUG_MODE') ? EE_REST_API_DEBUG_MODE : false;
-    }
-
-
-
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function set_requested_version($version)
-    {
-        $this->_requested_version = $version;
-    }
-
-
-
-    /**
-     * Sets some debug info that we'll send back in headers
-     *
-     * @param string       $key
-     * @param string|array $info
-     */
-    protected function _set_debug_info($key, $info)
-    {
-        $this->_debug_info[$key] = $info;
-    }
-
-
-
-    /**
-     * Sets headers for the response
-     *
-     * @param string       $header_key    , excluding the "X-EE-" part
-     * @param array|string $value         if an array, multiple headers will be added, one
-     *                                    for each key in the array
-     * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
-     *                                    the standard WP one
-     */
-    protected function _set_response_header($header_key, $value, $use_ee_prefix = true)
-    {
-        if (is_array($value)) {
-            foreach ($value as $value_key => $value_value) {
-                $this->_set_response_header($header_key . '[' . $value_key . ']', $value_value);
-            }
-        } else {
-            $prefix = $use_ee_prefix ? Base::header_prefix_for_ee : Base::header_prefix_for_wp;
-            $this->_response_headers[$prefix . $header_key] = $value;
-        }
-    }
-
-
-
-    /**
-     * Returns a flat array of headers to be added to the response
-     *
-     * @return array
-     */
-    protected function _get_response_headers()
-    {
-        return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            $this->_response_headers,
-            $this,
-            $this->_requested_version
-        );
-    }
-
-
-
-    /**
-     * Adds error notices from EE_Error onto the provided \WP_Error
-     *
-     * @param \WP_Error $wp_error_response
-     * @return \WP_Error
-     */
-    protected function _add_ee_errors_to_response(\WP_Error $wp_error_response)
-    {
-        $notices_during_checkin = \EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
-            foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
-                $wp_error_response->add(
-                    sanitize_key($error_code),
-                    strip_tags($error_message));
-            }
-        }
-        return $wp_error_response;
-    }
-
-
-
-    /**
-     * Sends a response, but also makes sure to attach headers that
-     * are handy for debugging.
-     * Specifically, we assume folks will want to know what exactly was the DB query that got run,
-     * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
-     * the response, others?
-     *
-     * @param array|\WP_Error|\Exception $response
-     * @return \WP_REST_Response
-     */
-    public function send_response($response)
-    {
-        if ($response instanceof Rest_Exception) {
-            $response = new \WP_Error($response->get_string_code(), $response->getMessage(), $response->get_data());
-        }
-        if ($response instanceof \Exception) {
-            $code = $response->getCode() ? $response->getCode() : 'error_occurred';
-            $response = new \WP_Error($code, $response->getMessage());
-        }
-        if ($response instanceof \WP_Error) {
-            $response = $this->_add_ee_errors_to_response($response);
-            $rest_response = $this->_create_rest_response_from_wp_error($response);
-        } else {
-            $rest_response = new \WP_REST_Response($response, 200);
-        }
-        $headers = array();
-        if ($this->_debug_mode && is_array($this->_debug_info)) {
-            foreach ($this->_debug_info as $debug_key => $debug_info) {
-                if (is_array($debug_info)) {
-                    $debug_info = wp_json_encode($debug_info);
-                }
-                $headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
-            }
-        }
-        $headers = array_merge(
-            $headers,
-            $this->_get_response_headers(),
-            $this->_get_headers_from_ee_notices()
-        );
-        $rest_response->set_headers($headers);
-        return $rest_response;
-    }
-
-
-
-    /**
-     * Converts the \WP_Error into `WP_REST_Response.
-     * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
-     * (which is protected)
-     *
-     * @param \WP_Error $wp_error
-     * @return \WP_REST_Response
-     */
-    protected function _create_rest_response_from_wp_error(\WP_Error $wp_error)
-    {
-        $error_data = $wp_error->get_error_data();
-        if (is_array($error_data) && isset($error_data['status'])) {
-            $status = $error_data['status'];
-        } else {
-            $status = 500;
-        }
-        $errors = array();
-        foreach ((array)$wp_error->errors as $code => $messages) {
-            foreach ((array)$messages as $message) {
-                $errors[] = array(
-                    'code'    => $code,
-                    'message' => $message,
-                    'data'    => $wp_error->get_error_data($code),
-                );
-            }
-        }
-        $data = isset($errors[0]) ? $errors[0] : array();
-        if (count($errors) > 1) {
-            // Remove the primary error.
-            array_shift($errors);
-            $data['additional_errors'] = $errors;
-        }
-        return new \WP_REST_Response($data, $status);
-    }
-
-
-
-    /**
-     * Array of headers derived from EE success, attention, and error messages
-     *
-     * @return array
-     */
-    protected function _get_headers_from_ee_notices()
-    {
-        $headers = array();
-        $notices = \EE_Error::get_raw_notices();
-        foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
-                continue;
-            }
-            foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers['X-EE4-Notices-'
-                         . \EEH_Inflector::humanize($notice_type)
-                         . '['
-                         . $notice_code
-                         . ']'] = strip_tags($sub_notice);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            $headers,
-            $this->_requested_version,
-            $notices
-        );
-    }
-
-
-
-    /**
-     * Finds which version of the API was requested given the route, and returns it.
-     * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
-     * "4.8.29"
-     *
-     * @param string $route
-     * @return string
-     */
-    public function get_requested_version($route = null)
-    {
-        $matches = $this->parse_route(
-            $route,
-            '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
-            array('version')
-        );
-        if (isset($matches['version'])) {
-            return $matches['version'];
-        } else {
-            return \EED_Core_Rest_Api::latest_rest_api_version();
-        }
-    }
-
-
-
-    /**
-     * Applies the regex to the route, then creates an array using the values of
-     * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
-     * For example, if you call
-     * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
-     * it will return array( 'version' => '4.8', 'model' => 'events' )
-     *
-     * @param string $route
-     * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
-     * @return array where  $match_keys are the keys (the first value of $match_keys
-     *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
-     *                           array( 'model', 'id' ), will, if the regex is successful, will return
-     *                           array( 'model' => 'foo', 'id' => 'bar' )
-     * @throws \EE_Error if it couldn't be parsed
-     */
-    public function parse_route($route, $regex, $match_keys)
-    {
-        $indexed_matches = array();
-        $success = preg_match($regex, $route, $matches);
-        if (
-        is_array($matches)
-        ) {
-            //skip the overall regex match. Who cares
-            for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[$i])) {
-                    $success = false;
-                } else {
-                    $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
-                }
-            }
-        }
-        if (! $success) {
-            throw new \EE_Error(
-                __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
-                'endpoint_parsing_error'
-            );
-        }
-        return $indexed_matches;
-    }
+	const header_prefix_for_ee = 'X-EE-';
+
+	const header_prefix_for_wp = 'X-WP-';
+
+	/**
+	 * Contains debug info we'll send back in the response headers
+	 *
+	 * @var array
+	 */
+	protected $_debug_info = array();
+
+	/**
+	 * Indicates whether or not the API is in debug mode
+	 *
+	 * @var boolean
+	 */
+	protected $_debug_mode = false;
+
+	/**
+	 * Indicates the version that was requested
+	 *
+	 * @var string
+	 */
+	protected $_requested_version;
+
+	/**
+	 * flat array of headers to send in the response
+	 *
+	 * @var array
+	 */
+	protected $_response_headers = array();
+
+
+
+	public function __construct()
+	{
+		$this->_debug_mode = defined('EE_REST_API_DEBUG_MODE') ? EE_REST_API_DEBUG_MODE : false;
+	}
+
+
+
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function set_requested_version($version)
+	{
+		$this->_requested_version = $version;
+	}
+
+
+
+	/**
+	 * Sets some debug info that we'll send back in headers
+	 *
+	 * @param string       $key
+	 * @param string|array $info
+	 */
+	protected function _set_debug_info($key, $info)
+	{
+		$this->_debug_info[$key] = $info;
+	}
+
+
+
+	/**
+	 * Sets headers for the response
+	 *
+	 * @param string       $header_key    , excluding the "X-EE-" part
+	 * @param array|string $value         if an array, multiple headers will be added, one
+	 *                                    for each key in the array
+	 * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
+	 *                                    the standard WP one
+	 */
+	protected function _set_response_header($header_key, $value, $use_ee_prefix = true)
+	{
+		if (is_array($value)) {
+			foreach ($value as $value_key => $value_value) {
+				$this->_set_response_header($header_key . '[' . $value_key . ']', $value_value);
+			}
+		} else {
+			$prefix = $use_ee_prefix ? Base::header_prefix_for_ee : Base::header_prefix_for_wp;
+			$this->_response_headers[$prefix . $header_key] = $value;
+		}
+	}
+
+
+
+	/**
+	 * Returns a flat array of headers to be added to the response
+	 *
+	 * @return array
+	 */
+	protected function _get_response_headers()
+	{
+		return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			$this->_response_headers,
+			$this,
+			$this->_requested_version
+		);
+	}
+
+
+
+	/**
+	 * Adds error notices from EE_Error onto the provided \WP_Error
+	 *
+	 * @param \WP_Error $wp_error_response
+	 * @return \WP_Error
+	 */
+	protected function _add_ee_errors_to_response(\WP_Error $wp_error_response)
+	{
+		$notices_during_checkin = \EE_Error::get_raw_notices();
+		if (! empty($notices_during_checkin['errors'])) {
+			foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
+				$wp_error_response->add(
+					sanitize_key($error_code),
+					strip_tags($error_message));
+			}
+		}
+		return $wp_error_response;
+	}
+
+
+
+	/**
+	 * Sends a response, but also makes sure to attach headers that
+	 * are handy for debugging.
+	 * Specifically, we assume folks will want to know what exactly was the DB query that got run,
+	 * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
+	 * the response, others?
+	 *
+	 * @param array|\WP_Error|\Exception $response
+	 * @return \WP_REST_Response
+	 */
+	public function send_response($response)
+	{
+		if ($response instanceof Rest_Exception) {
+			$response = new \WP_Error($response->get_string_code(), $response->getMessage(), $response->get_data());
+		}
+		if ($response instanceof \Exception) {
+			$code = $response->getCode() ? $response->getCode() : 'error_occurred';
+			$response = new \WP_Error($code, $response->getMessage());
+		}
+		if ($response instanceof \WP_Error) {
+			$response = $this->_add_ee_errors_to_response($response);
+			$rest_response = $this->_create_rest_response_from_wp_error($response);
+		} else {
+			$rest_response = new \WP_REST_Response($response, 200);
+		}
+		$headers = array();
+		if ($this->_debug_mode && is_array($this->_debug_info)) {
+			foreach ($this->_debug_info as $debug_key => $debug_info) {
+				if (is_array($debug_info)) {
+					$debug_info = wp_json_encode($debug_info);
+				}
+				$headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
+			}
+		}
+		$headers = array_merge(
+			$headers,
+			$this->_get_response_headers(),
+			$this->_get_headers_from_ee_notices()
+		);
+		$rest_response->set_headers($headers);
+		return $rest_response;
+	}
+
+
+
+	/**
+	 * Converts the \WP_Error into `WP_REST_Response.
+	 * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
+	 * (which is protected)
+	 *
+	 * @param \WP_Error $wp_error
+	 * @return \WP_REST_Response
+	 */
+	protected function _create_rest_response_from_wp_error(\WP_Error $wp_error)
+	{
+		$error_data = $wp_error->get_error_data();
+		if (is_array($error_data) && isset($error_data['status'])) {
+			$status = $error_data['status'];
+		} else {
+			$status = 500;
+		}
+		$errors = array();
+		foreach ((array)$wp_error->errors as $code => $messages) {
+			foreach ((array)$messages as $message) {
+				$errors[] = array(
+					'code'    => $code,
+					'message' => $message,
+					'data'    => $wp_error->get_error_data($code),
+				);
+			}
+		}
+		$data = isset($errors[0]) ? $errors[0] : array();
+		if (count($errors) > 1) {
+			// Remove the primary error.
+			array_shift($errors);
+			$data['additional_errors'] = $errors;
+		}
+		return new \WP_REST_Response($data, $status);
+	}
+
+
+
+	/**
+	 * Array of headers derived from EE success, attention, and error messages
+	 *
+	 * @return array
+	 */
+	protected function _get_headers_from_ee_notices()
+	{
+		$headers = array();
+		$notices = \EE_Error::get_raw_notices();
+		foreach ($notices as $notice_type => $sub_notices) {
+			if (! is_array($sub_notices)) {
+				continue;
+			}
+			foreach ($sub_notices as $notice_code => $sub_notice) {
+				$headers['X-EE4-Notices-'
+						 . \EEH_Inflector::humanize($notice_type)
+						 . '['
+						 . $notice_code
+						 . ']'] = strip_tags($sub_notice);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			$headers,
+			$this->_requested_version,
+			$notices
+		);
+	}
+
+
+
+	/**
+	 * Finds which version of the API was requested given the route, and returns it.
+	 * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
+	 * "4.8.29"
+	 *
+	 * @param string $route
+	 * @return string
+	 */
+	public function get_requested_version($route = null)
+	{
+		$matches = $this->parse_route(
+			$route,
+			'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+			array('version')
+		);
+		if (isset($matches['version'])) {
+			return $matches['version'];
+		} else {
+			return \EED_Core_Rest_Api::latest_rest_api_version();
+		}
+	}
+
+
+
+	/**
+	 * Applies the regex to the route, then creates an array using the values of
+	 * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
+	 * For example, if you call
+	 * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
+	 * it will return array( 'version' => '4.8', 'model' => 'events' )
+	 *
+	 * @param string $route
+	 * @param string $regex
+	 * @param array  $match_keys EXCLUDING matching the entire regex
+	 * @return array where  $match_keys are the keys (the first value of $match_keys
+	 *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
+	 *                           array( 'model', 'id' ), will, if the regex is successful, will return
+	 *                           array( 'model' => 'foo', 'id' => 'bar' )
+	 * @throws \EE_Error if it couldn't be parsed
+	 */
+	public function parse_route($route, $regex, $match_keys)
+	{
+		$indexed_matches = array();
+		$success = preg_match($regex, $route, $matches);
+		if (
+		is_array($matches)
+		) {
+			//skip the overall regex match. Who cares
+			for ($i = 1; $i <= count($match_keys); $i++) {
+				if (! isset($matches[$i])) {
+					$success = false;
+				} else {
+					$indexed_matches[$match_keys[$i - 1]] = $matches[$i];
+				}
+			}
+		}
+		if (! $success) {
+			throw new \EE_Error(
+				__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
+				'endpoint_parsing_error'
+			);
+		}
+		return $indexed_matches;
+	}
 }
 
 // End of file Base.php
\ No newline at end of file

Spacing +11 added lines, -11 removed lines

@@ -3,7 +3,7 @@ 
 
 use EventEspresso\core\libraries\rest_api\Rest_Exception;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -99,11 +99,11 @@ 
     {
         if (is_array($value)) {
             foreach ($value as $value_key => $value_value) {
-                $this->_set_response_header($header_key . '[' . $value_key . ']', $value_value);
+                $this->_set_response_header($header_key.'['.$value_key.']', $value_value);
             }
         } else {
             $prefix = $use_ee_prefix ? Base::header_prefix_for_ee : Base::header_prefix_for_wp;
-            $this->_response_headers[$prefix . $header_key] = $value;
+            $this->_response_headers[$prefix.$header_key] = $value;
         }
     }
 
@@ -134,7 +134,7 @@ 
     protected function _add_ee_errors_to_response(\WP_Error $wp_error_response)
     {
         $notices_during_checkin = \EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
+        if ( ! empty($notices_during_checkin['errors'])) {
             foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
                 $wp_error_response->add(
                     sanitize_key($error_code),
@@ -177,7 +177,7 @@ 
                 if (is_array($debug_info)) {
                     $debug_info = wp_json_encode($debug_info);
                 }
-                $headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
+                $headers['X-EE4-Debug-'.ucwords($debug_key)] = $debug_info;
             }
         }
         $headers = array_merge(
@@ -208,8 +208,8 @@ 
             $status = 500;
         }
         $errors = array();
-        foreach ((array)$wp_error->errors as $code => $messages) {
-            foreach ((array)$messages as $message) {
+        foreach ((array) $wp_error->errors as $code => $messages) {
+            foreach ((array) $messages as $message) {
                 $errors[] = array(
                     'code'    => $code,
                     'message' => $message,
@@ -238,7 +238,7 @@ 
         $headers = array();
         $notices = \EE_Error::get_raw_notices();
         foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
+            if ( ! is_array($sub_notices)) {
                 continue;
             }
             foreach ($sub_notices as $notice_code => $sub_notice) {
@@ -271,7 +271,7 @@ 
     {
         $matches = $this->parse_route(
             $route,
-            '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+            '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'~',
             array('version')
         );
         if (isset($matches['version'])) {
@@ -308,14 +308,14 @@ 
         ) {
             //skip the overall regex match. Who cares
             for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[$i])) {
+                if ( ! isset($matches[$i])) {
                     $success = false;
                 } else {
                     $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
                 }
             }
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new \EE_Error(
                 __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
                 'endpoint_parsing_error'

core/libraries/rest_api/Model_Version_Info.php

Indentation +457 added lines, -457 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,462 +24,462 @@ 
 class Model_Version_Info
 {
 
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const model_added = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $_model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $_resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $_requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $_cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $_cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $_cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $_cached_fields_on_models = array();
-
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->_requested_version = $requested_version;
-        $this->_model_changes = array(
-            '4.8.29' => array(
-                //first version where the REST API is in EE core, so no need
-                //to specify how its different from the previous
-            ),
-        );
-        //setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->_resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->_resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
-                            $this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function model_changes_between_requested_version_and_current()
-    {
-        if ($this->_cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->model_changes() as $version => $models_changed_in_version) {
-                if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
-                    $model_changes[$version] = $models_changed_in_version;
-                }
-            }
-            $this->_cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->_cached_model_changes_between_requested_version_and_current;
-    }
-
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resource_changes_between_requested_version_and_current()
-    {
-        if ($this->_cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resource_changes() as $version => $model_classnames) {
-                if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
-                    $resource_changes[$version] = $model_classnames;
-                }
-            }
-            $this->_cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->_cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requested_version()
-    {
-        return $this->_requested_version;
-    }
-
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function model_changes()
-    {
-        return $this->_model_changes;
-    }
-
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function models_for_requested_version()
-    {
-        if ($this->_cached_models_for_requested_version === null) {
-            $all_models_in_current_version = \EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->model_changes_between_requested_version_and_current() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === Model_Version_Info::model_added) {
-                        unset($all_models_in_current_version[$model_name]);
-                    }
-                }
-            }
-            $this->_cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->_cached_models_for_requested_version;
-    }
-
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function is_model_name_in_this_version($model_name)
-    {
-        $model_names = $this->models_for_requested_version();
-        if (isset($model_names[$model_name])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function load_model($model_name)
-    {
-        if ($this->is_model_name_in_this_version($model_name)) {
-            return \EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requested_version()
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param \EEM_Base $model
-     * @return array|\EE_Model_Field_Base[]
-     */
-    public function fields_on_model_in_this_version($model)
-    {
-        if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
-            //get all model changes between the requested version and current core version
-            $changes = $this->model_changes_between_requested_version_and_current();
-            //fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            //remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (
-                    isset($changes_in_version[$model->get_this_model_name()])
-                    && $changes_in_version[$model->get_this_model_name()] !== Model_Version_Info::model_added
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[$model->get_this_model_name()])
-                    );
-                }
-            }
-            $this->_cached_fields_on_models = $current_fields;
-        }
-        return $this->_cached_fields_on_models;
-    }
-
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function is_subclass_of_one($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fields_ignored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_is_ignored($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_ignored());
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fields_that_have_rendered_format()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_has_rendered_format($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_that_have_rendered_format());
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT queryable or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fields_that_have_pretty_format()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_has_pretty_format($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_that_have_pretty_format());
-    }
-
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resource_changes()
-    {
-        return $this->_resource_changes;
-    }
-
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extra_resource_properties_for_model($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resource_changes_between_requested_version_and_current() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relation_settings(\EEM_Base $model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->is_model_name_in_this_version($relation_name)) {
-                $relations[$relation_name] = $relation_obj;
-            }
-        }
-        //filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const model_added = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $_model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $_resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $_requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $_cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $_cached_fields_on_models = array();
+
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->_requested_version = $requested_version;
+		$this->_model_changes = array(
+			'4.8.29' => array(
+				//first version where the REST API is in EE core, so no need
+				//to specify how its different from the previous
+			),
+		);
+		//setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->_resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->_resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
+							$this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function model_changes_between_requested_version_and_current()
+	{
+		if ($this->_cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->model_changes() as $version => $models_changed_in_version) {
+				if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
+					$model_changes[$version] = $models_changed_in_version;
+				}
+			}
+			$this->_cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->_cached_model_changes_between_requested_version_and_current;
+	}
+
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resource_changes_between_requested_version_and_current()
+	{
+		if ($this->_cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resource_changes() as $version => $model_classnames) {
+				if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
+					$resource_changes[$version] = $model_classnames;
+				}
+			}
+			$this->_cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->_cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requested_version()
+	{
+		return $this->_requested_version;
+	}
+
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function model_changes()
+	{
+		return $this->_model_changes;
+	}
+
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function models_for_requested_version()
+	{
+		if ($this->_cached_models_for_requested_version === null) {
+			$all_models_in_current_version = \EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->model_changes_between_requested_version_and_current() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === Model_Version_Info::model_added) {
+						unset($all_models_in_current_version[$model_name]);
+					}
+				}
+			}
+			$this->_cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->_cached_models_for_requested_version;
+	}
+
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function is_model_name_in_this_version($model_name)
+	{
+		$model_names = $this->models_for_requested_version();
+		if (isset($model_names[$model_name])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function load_model($model_name)
+	{
+		if ($this->is_model_name_in_this_version($model_name)) {
+			return \EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requested_version()
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param \EEM_Base $model
+	 * @return array|\EE_Model_Field_Base[]
+	 */
+	public function fields_on_model_in_this_version($model)
+	{
+		if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
+			//get all model changes between the requested version and current core version
+			$changes = $this->model_changes_between_requested_version_and_current();
+			//fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			//remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (
+					isset($changes_in_version[$model->get_this_model_name()])
+					&& $changes_in_version[$model->get_this_model_name()] !== Model_Version_Info::model_added
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[$model->get_this_model_name()])
+					);
+				}
+			}
+			$this->_cached_fields_on_models = $current_fields;
+		}
+		return $this->_cached_fields_on_models;
+	}
+
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function is_subclass_of_one($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fields_ignored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_is_ignored($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_ignored());
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fields_that_have_rendered_format()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_has_rendered_format($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_that_have_rendered_format());
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT queryable or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fields_that_have_pretty_format()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_has_pretty_format($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_that_have_pretty_format());
+	}
+
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resource_changes()
+	{
+		return $this->_resource_changes;
+	}
+
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extra_resource_properties_for_model($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resource_changes_between_requested_version_and_current() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relation_settings(\EEM_Base $model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->is_model_name_in_this_version($relation_name)) {
+				$relations[$relation_name] = $relation_obj;
+			}
+		}
+		//filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 
 }
 

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace EventEspresso\core\libraries\rest_api;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -120,7 +120,7 @@ 
                 foreach ($extra_fields as $fieldname => $field_data) {
                     $this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
                     foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
+                        if ( ! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
                             $this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
@@ -292,7 +292,7 @@ 
      */
     public function fields_on_model_in_this_version($model)
     {
-        if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
+        if ( ! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
             //get all model changes between the requested version and current core version
             $changes = $this->model_changes_between_requested_version_and_current();
             //fetch all fields currently on this model

core/libraries/rest_api/Model_Data_Translator.php

Indentation +481 added lines, -481 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,485 +27,485 @@ 
 class Model_Data_Translator
 {
 
-    /**
-     * 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 \DomainException
-     */
-    public static function prepare_field_values_from_json(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (is_array($original_value_maybe_array)) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_from_json(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = Model_Data_Translator::prepare_field_value_from_json(
-                $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 prepare_field_values_for_json($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field_obj,
-                    $array_item,
-                    $request_version
-                );
-            }
-        } else {
-            $new_value_maybe_array = Model_Data_Translator::prepare_field_value_for_json(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * 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 \DomainException
-     */
-    public static function prepare_field_value_from_json(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC' // UTC
-    )
-    {
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
-        $new_value = null;
-        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) = Model_Data_Translator::parse_timezone_offset(
-                $field_obj->get_timezone_offset(
-                    new \DateTimeZone($timezone_string)
-                )
-            );
-            $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;
-    }
-
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parse_timezone_offset($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 prepare_field_value_for_json($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = Model_Data_Translator::ee_inf_in_rest;
-        } elseif ($field_obj instanceof \EE_Datetime_Field) {
-            if ($original_value instanceof \DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } else {
-                $new_value = $original_value;
-            }
-            $new_value = mysql_to_rfc3339($new_value);
-        } else {
-            $new_value = $original_value;
-        }
-        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
-     * @return array
-     * @throws \DomainException
-     * @throws \EE_Error
-     */
-    public static function prepare_conditions_query_params_for_models(
-        $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) {
-            $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key);
-            $field = Model_Data_Translator::deduce_field_from_query_param(
-                $query_param_sans_stars,
-                $model
-            );
-            //double-check is it a *_gmt field?
-            if (! $field instanceof \EE_Model_Field_Base
-                && Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
-            ) {
-                //yep, take off '_gmt', and find the field
-                $query_param_key = Model_Data_Translator::remove_gmt_from_field_name($query_param_sans_stars);
-                $field = Model_Data_Translator::deduce_field_from_query_param(
-                    $query_param_key,
-                    $model
-                );
-                $timezone = 'UTC';
-            } else {
-                //so it's not a GMT field. Set the timezone on the model to the default
-                $timezone = \EEH_DTT_Helper::get_valid_timezone_string();
-            }
-            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] = Model_Data_Translator::prepare_field_values_from_json($field, $value,
-                            $requested_version, $timezone);
-                    }
-                } else {
-                    $translated_value = Model_Data_Translator::prepare_field_value_from_json($field, $query_param_value,
-                        $requested_version, $timezone);
-                }
-                $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] = Model_Data_Translator::prepare_conditions_query_params_for_models($query_param_value,
-                    $model, $requested_version);
-            }
-        }
-        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 is_gmt_date_field_name($field_name)
-    {
-        return substr(
-                   Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($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 remove_gmt_from_field_name($field_name)
-    {
-        if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($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 prepare_field_name_from_json($field_name)
-    {
-        if (Model_Data_Translator::is_gmt_date_field_name($field_name)) {
-            return Model_Data_Translator::remove_gmt_from_field_name($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 prepare_field_names_from_json(array $field_names)
-    {
-        $new_array = array();
-        foreach ($field_names as $key => $field_name) {
-            $new_array[$key] = Model_Data_Translator::prepare_field_name_from_json($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 prepare_field_names_in_array_keys_from_json(array $field_names_as_keys)
-    {
-        $new_array = array();
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[Model_Data_Translator::prepare_field_name_from_json($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 prepare_query_params_for_rest_api(
-        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'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
-                $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
-     */
-    public static function prepare_conditions_query_params_for_rest_api(
-        $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 = Model_Data_Translator::deduce_field_from_query_param(
-                Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($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] = Model_Data_Translator::prepare_field_values_for_json($field, $value,
-                            $requested_version);
-                    }
-                } else {
-                    $translated_value = Model_Data_Translator::prepare_field_value_for_json($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] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api($query_param_value,
-                    $model, $requested_version);
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function remove_stars_and_anything_after_from_condition_query_param_key($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 deduce_field_from_query_param($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);
-        } catch (\EE_Error $e) {
-            return null;
-        }
-    }
+	/**
+	 * 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 \DomainException
+	 */
+	public static function prepare_field_values_from_json(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (is_array($original_value_maybe_array)) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_from_json(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = Model_Data_Translator::prepare_field_value_from_json(
+				$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 prepare_field_values_for_json($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_for_json(
+					$field_obj,
+					$array_item,
+					$request_version
+				);
+			}
+		} else {
+			$new_value_maybe_array = Model_Data_Translator::prepare_field_value_for_json(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * 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 \DomainException
+	 */
+	public static function prepare_field_value_from_json(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC' // UTC
+	)
+	{
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
+		$new_value = null;
+		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) = Model_Data_Translator::parse_timezone_offset(
+				$field_obj->get_timezone_offset(
+					new \DateTimeZone($timezone_string)
+				)
+			);
+			$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;
+	}
+
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parse_timezone_offset($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 prepare_field_value_for_json($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = Model_Data_Translator::ee_inf_in_rest;
+		} elseif ($field_obj instanceof \EE_Datetime_Field) {
+			if ($original_value instanceof \DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} else {
+				$new_value = $original_value;
+			}
+			$new_value = mysql_to_rfc3339($new_value);
+		} else {
+			$new_value = $original_value;
+		}
+		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
+	 * @return array
+	 * @throws \DomainException
+	 * @throws \EE_Error
+	 */
+	public static function prepare_conditions_query_params_for_models(
+		$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) {
+			$query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key);
+			$field = Model_Data_Translator::deduce_field_from_query_param(
+				$query_param_sans_stars,
+				$model
+			);
+			//double-check is it a *_gmt field?
+			if (! $field instanceof \EE_Model_Field_Base
+				&& Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
+			) {
+				//yep, take off '_gmt', and find the field
+				$query_param_key = Model_Data_Translator::remove_gmt_from_field_name($query_param_sans_stars);
+				$field = Model_Data_Translator::deduce_field_from_query_param(
+					$query_param_key,
+					$model
+				);
+				$timezone = 'UTC';
+			} else {
+				//so it's not a GMT field. Set the timezone on the model to the default
+				$timezone = \EEH_DTT_Helper::get_valid_timezone_string();
+			}
+			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] = Model_Data_Translator::prepare_field_values_from_json($field, $value,
+							$requested_version, $timezone);
+					}
+				} else {
+					$translated_value = Model_Data_Translator::prepare_field_value_from_json($field, $query_param_value,
+						$requested_version, $timezone);
+				}
+				$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] = Model_Data_Translator::prepare_conditions_query_params_for_models($query_param_value,
+					$model, $requested_version);
+			}
+		}
+		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 is_gmt_date_field_name($field_name)
+	{
+		return substr(
+				   Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($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 remove_gmt_from_field_name($field_name)
+	{
+		if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($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 prepare_field_name_from_json($field_name)
+	{
+		if (Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+			return Model_Data_Translator::remove_gmt_from_field_name($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 prepare_field_names_from_json(array $field_names)
+	{
+		$new_array = array();
+		foreach ($field_names as $key => $field_name) {
+			$new_array[$key] = Model_Data_Translator::prepare_field_name_from_json($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 prepare_field_names_in_array_keys_from_json(array $field_names_as_keys)
+	{
+		$new_array = array();
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[Model_Data_Translator::prepare_field_name_from_json($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 prepare_query_params_for_rest_api(
+		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'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
+				$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
+	 */
+	public static function prepare_conditions_query_params_for_rest_api(
+		$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 = Model_Data_Translator::deduce_field_from_query_param(
+				Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($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] = Model_Data_Translator::prepare_field_values_for_json($field, $value,
+							$requested_version);
+					}
+				} else {
+					$translated_value = Model_Data_Translator::prepare_field_value_for_json($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] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api($query_param_value,
+					$model, $requested_version);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function remove_stars_and_anything_after_from_condition_query_param_key($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 deduce_field_from_query_param($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);
+		} catch (\EE_Error $e) {
+			return null;
+		}
+	}
 
 }

Spacing +6 added lines, -6 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace EventEspresso\core\libraries\rest_api;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -149,7 +149,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;
         }
@@ -166,10 +166,10 @@ 
      */
     private static function parse_timezone_offset($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;
@@ -237,7 +237,7 @@ 
                 $model
             );
             //double-check is it a *_gmt field?
-            if (! $field instanceof \EE_Model_Field_Base
+            if ( ! $field instanceof \EE_Model_Field_Base
                 && Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
             ) {
                 //yep, take off '_gmt', and find the field
@@ -303,7 +303,7 @@ 
      */
     public static function remove_gmt_from_field_name($field_name)
     {
-        if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+        if ( ! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
             return $field_name;
         }
         $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);