eventespresso / event-espresso-core

core/libraries/rest_api/controllers/model/Read.php

Indentation +1101 added lines, -1101 removed lines

@@ -7,7 +7,7 @@ 
 use EventEspresso\core\libraries\rest_api\Model_Data_Translator;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -25,1106 +25,1106 @@ 
 
 
 
-    /**
-     * @var Calculated_Model_Fields
-     */
-    protected $_fields_calculator;
-
-
-
-    /**
-     * Read constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->_fields_calculator = new Calculated_Model_Fields();
-    }
-
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param \WP_REST_Request $request
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_all(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
-                array('version', 'model')
-            );
-            $controller->set_requested_version($matches['version']);
-            $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entities_from_model(
-                    $controller->get_model_version_info()->load_model($model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
-
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param \WP_REST_Request $request
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_one(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
-                array('version', 'model', 'id'));
-            $controller->set_requested_version($matches['version']);
-            $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entity_from_model(
-                    $controller->get_model_version_info()->load_model($model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
-
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param \WP_REST_Request $request
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_related(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
-                array('version', 'model', 'id', 'related_model')
-            );
-            $controller->set_requested_version($matches['version']);
-            $main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $main_model_name_singular
-                        )
-                    )
-                );
-            }
-            $main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
-            //assume the related model name is plural and try to find the model's name
-            $related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
-                //so the word didn't singularize well. Maybe that's just because it's a singular word?
-                $related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
-            }
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $related_model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entities_from_relation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
-
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param \EEM_Base        $model
-     * @param \WP_REST_Request $request
-     * @return array|\WP_Error
-     */
-    public function get_entities_from_model($model, $request)
-    {
-        $query_params = $this->create_model_query_params($model, $request->get_params());
-        if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
-            $model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            return new \WP_Error(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::get_missing_permissions_string($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->_set_headers_from_query_params($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] = $this->create_entity_from_wpdb_result(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-
-    /**
-     * @param array                   $primary_model_query_params query params for finding the item from which
-     *                                                            relations will be based
-     * @param \EE_Model_Relation_Base $relation
-     * @param \WP_REST_Request        $request
-     * @return \WP_Error|array
-     */
-    protected function _get_entities_from_relation($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validate_context($request->get_param('caps'));
-        $model = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = array();
-        }
-        //check if they can access the 1st model object
-        $primary_model_query_params = array(
-            0       => $primary_model_query_params[0],
-            'limit' => 1,
-        );
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($primary_model_query_params);
-        }
-        $restricted_query_params = $primary_model_query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->_set_debug_info('main model query params', $restricted_query_params);
-        $this->_set_debug_info('missing caps', Capabilities::get_missing_permissions_string($related_model, $context));
-        if (
-        ! (
-            Capabilities::current_user_has_partial_access_to($related_model, $context)
-            && $model->exists($restricted_query_params)
-        )
-        ) {
-            if ($relation instanceof \EE_Belongs_To_Relation) {
-                $related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
-            } else {
-                $related_model_name_maybe_plural = \EEH_Inflector::pluralize_and_lower($related_model->get_this_model_name());
-            }
-            return new \WP_Error(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
-                        'event_espresso'),
-                    $related_model_name_maybe_plural,
-                    $relation->get_this_model()->get_this_model_name(),
-                    implode(
-                        ',',
-                        array_keys(
-                            Capabilities::get_missing_permissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-        $query_params = $this->create_model_query_params($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][$relation->get_this_model()->get_this_model_name()
-                             . '.'
-                             . $where_condition_key] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->_set_headers_from_query_params($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_result = $this->create_entity_from_wpdb_result(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof \EE_HABTM_Relation) {
-                //put the unusual stuff (properties from the HABTM relation) first, and make sure
-                //if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->create_entity_from_wpdb_result(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result = array_merge($nice_result, $join_model_result);
-                //but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof \EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param string                  $id the ID of the thing we are fetching related stuff from
-     * @param \EE_Model_Relation_Base $relation
-     * @param \WP_REST_Request        $request
-     * @return array|\WP_Error
-     * @throws \EE_Error
-     */
-    public function get_entities_from_relation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        'event_espresso'),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $this->_get_entities_from_relation(
-            array(
-                array(
-                    $relation->get_this_model()->primary_key_name() => $id,
-                ),
-            ),
-            $relation,
-            $request
-        );
-    }
-
-
-
-    /**
-     * Sets the headers that are based on the model and query params,
-     * like the total records. This should only be called on the original request
-     * from the client, not on subsequent internal
-     *
-     * @param \EEM_Base $model
-     * @param array     $query_params
-     * @return void
-     */
-    protected function _set_headers_from_query_params($model, $query_params)
-    {
-        $this->_set_debug_info('model query params', $query_params);
-        $this->_set_debug_info('missing caps',
-            Capabilities::get_missing_permissions_string($model, $query_params['caps']));
-        //normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) == 1) {
-                $limit_parts = array(0, $limit_parts[0]);
-            }
-        }
-        //remove the group by and having parts of the query, as those will
-        //make the sql query return an array of values, instead of just a single value
-        unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
-        $count = $model->count($query_params, null, true);
-        $pages = $count / $limit_parts[1];
-        $this->_set_response_header('Total', $count, false);
-        $this->_set_response_header('PageSize', $limit_parts[1], false);
-        $this->_set_response_header('TotalPages', ceil($pages), false);
-    }
-
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param \EEM_Base        $model
-     * @param array            $db_row     like results from $wpdb->get_results()
-     * @param \WP_REST_Request $rest_request
-     * @param string           $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     */
-    public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
-    {
-        if (! $rest_request instanceof \WP_REST_Request) {
-            //ok so this was called in the old style, where the 3rd arg was
-            //$include, and the 4th arg was $context
-            //now setup the request just to avoid fatal errors, although we won't be able
-            //to truly make use of it because it's kinda devoid of info
-            $rest_request = new \WP_REST_Request();
-            $rest_request->set_param('include', $rest_request);
-            $rest_request->set_param('caps', $deprecated);
-        }
-        if ($rest_request->get_param('caps') == null) {
-            $rest_request->set_param('caps', \EEM_Base::caps_read);
-        }
-        $entity_array = $this->_create_bare_entity_from_wpdb_results($model, $db_row);
-        $entity_array = $this->_add_extra_fields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->_get_entity_links($model, $db_row, $entity_array);
-        $entity_array['_calculated_fields'] = $this->_get_entity_calculations($model, $db_row, $rest_request);
-        $entity_array = $this->_include_requested_models($model, $rest_request, $entity_array, $db_row);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        $result_without_inaccessible_fields = Capabilities::filter_out_inaccessible_entity_fields(
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $this->get_model_version_info(),
-            $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($db_row)
-            )
-        );
-        $this->_set_debug_info(
-            'inaccessible fields',
-            array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
-        );
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_return',
-            $result_without_inaccessible_fields,
-            $model,
-            $rest_request->get_param('caps')
-        );
-    }
-
-
-
-    /**
-     * Creates a REST entity array (JSON object we're going to return in the response, but
-     * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
-     * from $wpdb->get_row( $sql, ARRAY_A)
-     *
-     * @param \EEM_Base $model
-     * @param array     $db_row
-     * @return array entity mostly ready for converting to JSON and sending in the response
-     */
-    protected function _create_bare_entity_from_wpdb_results(\EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key($result,
-            $this->get_model_version_info()->fields_on_model_in_this_version($model));
-        foreach ($result as $field_name => $raw_field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            $field_value = $field_obj->prepare_for_set_from_db($raw_field_value);
-            if ($this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_ignored())) {
-                unset($result[$field_name]);
-            } elseif (
-            $this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_rendered_format())
-            ) {
-                $result[$field_name] = array(
-                    'raw'      => $field_obj->prepare_for_get($field_value),
-                    'rendered' => $field_obj->prepare_for_pretty_echoing($field_value),
-                );
-            } elseif (
-            $this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_pretty_format())
-            ) {
-                $result[$field_name] = array(
-                    'raw'    => $field_obj->prepare_for_get($field_value),
-                    'pretty' => $field_obj->prepare_for_pretty_echoing($field_value),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                if ($field_value instanceof \DateTime) {
-                    $timezone = $field_value->getTimezone();
-                    $field_value->setTimezone(new \DateTimeZone('UTC'));
-                    $result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
-                        $field_obj,
-                        $field_value,
-                        $this->get_model_version_info()->requested_version()
-                    );
-                    $field_value->setTimezone($timezone);
-                    $result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
-                        $field_obj,
-                        $field_value,
-                        $this->get_model_version_info()->requested_version()
-                    );
-                }
-            } else {
-                $result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field_obj,
-                    $field_obj->prepare_for_get($field_value),
-                    $this->get_model_version_info()->requested_version()
-                );
-            }
-        }
-        return $result;
-    }
-
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param \EEM_Base $model
-     * @param array     $db_row
-     * @param array     $entity_array
-     * @return array modified entity
-     */
-    protected function _add_extra_fields(\EEM_Base $model, $db_row, $entity_array)
-    {
-        if ($model instanceof \EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
-        }
-        return $entity_array;
-    }
-
-
-
-    /**
-     * Gets links we want to add to the response
-     *
-     * @global \WP_REST_Server $wp_rest_server
-     * @param \EEM_Base        $model
-     * @param array            $db_row
-     * @param array            $entity_array
-     * @return array the _links item in the entity
-     */
-    protected function _get_entity_links($model, $db_row, $entity_array)
-    {
-        //add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->get_versioned_link_to(
-                        \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[$model->primary_key_name()]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->get_versioned_link_to(
-                    \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        //add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
-                $links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
-                    array(
-                        'href'   => $this->get_versioned_link_to(
-                            \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[$model->primary_key_name()]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
-                    ),
-                );
-            }
-        }
-        return $links;
-    }
-
-
-
-    /**
-     * Adds the included models indicated in the request to the entity provided
-     *
-     * @param \EEM_Base        $model
-     * @param \WP_REST_Request $rest_request
-     * @param array            $entity_array
-     * @param array            $db_row
-     * @return array the modified entity
-     */
-    protected function _include_requested_models(
-        \EEM_Base $model,
-        \WP_REST_Request $rest_request,
-        $entity_array,
-        $db_row = array()
-    ) {
-        //if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
-        //if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                //always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explode_and_get_items_prefixed_with($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        $relation_settings = $this->get_model_version_info()->relation_settings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explode_and_get_items_prefixed_with(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explode_and_get_items_prefixed_with(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            //did they specify they wanted to include a related model, or
-            //specific fields from a related model?
-            //or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                //if so, we should include at least some part of the related model
-                $pretend_related_request = new \WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    array(
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                    )
-                );
-                $pretend_related_request->add_header('no_rest_headers', true);
-                $primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                );
-                $related_results = $this->_get_entities_from_relation(
-                    $primary_model_query_params,
-                    $relation_obj,
-                    $pretend_related_request
-                );
-                $entity_array[Read::get_related_entity_name($relation_name, $relation_obj)] = $related_results
-                                                                                              instanceof
-                                                                                              \WP_Error
-                    ? null
-                    : $related_results;
-            }
-        }
-        return $entity_array;
-    }
-
-
-
-    /**
-     * Returns a new array with all the names of models removed. Eg
-     * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
-     *
-     * @param array $arr
-     * @return array
-     */
-    private function _remove_model_names_from_array($arr)
-    {
-        return array_diff($arr, array_keys(\EE_Registry::instance()->non_abstract_db_models));
-    }
-
-
-
-    /**
-     * Gets the calculated fields for the response
-     *
-     * @param \EEM_Base        $model
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $rest_request
-     * @return \stdClass the _calculations item in the entity
-     */
-    protected function _get_entity_calculations($model, $wpdb_row, $rest_request)
-    {
-        $calculated_fields = $this->explode_and_get_items_prefixed_with(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        //note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new \stdClass();
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                $calculated_fields_to_return->$field_to_calculate = Model_Data_Translator::prepare_field_value_for_json(
-                    null,
-                    $this->_fields_calculator->retrieve_calculated_field_value(
-                        $model,
-                        $field_to_calculate,
-                        $wpdb_row,
-                        $rest_request,
-                        $this
-                    ),
-                    $this->get_model_version_info()->requested_version()
-                );
-            } catch (Rest_Exception $e) {
-                //if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->_set_response_header(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->get_string_code()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage(),
-                    true
-                );
-            }
-        }
-        return $calculated_fields_to_return;
-    }
-
-
-
-    /**
-     * Gets the full URL to the resource, taking the requested version into account
-     *
-     * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
-     * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
-     */
-    public function get_versioned_link_to($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            \EED_Core_Rest_Api::ee_api_namespace
-            . $this->get_model_version_info()->requested_version()
-            . '/'
-            . $link_part_after_version_and_slash
-        );
-    }
-
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                  $relation_name
-     * @param \EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function get_related_entity_name($relation_name, $relation_obj)
-    {
-        if ($relation_obj instanceof \EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        } else {
-            return \EEH_Inflector::pluralize_and_lower($relation_name);
-        }
-    }
-
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param \EEM_Base        $model
-     * @param \WP_REST_Request $request
-     * @return array|\WP_Error
-     */
-    public function get_entity_from_model($model, $request)
-    {
-        $query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        }
-        $restricted_query_params = $query_params;
-        $restricted_query_params['caps'] = $this->validate_context($request->get_param('caps'));
-        $this->_set_debug_info('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty ($model_rows)) {
-            return $this->create_entity_from_wpdb_result(
-                $model,
-                array_shift($model_rows),
-                $request);
-        } else {
-            //ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
-                //you got shafted- it existed but we didn't want to tell you!
-                return new \WP_Error(
-                    'rest_user_cannot_read',
-                    sprintf(
-                        __('Sorry, you cannot read this %1$s. Missing permissions are: %2$s', 'event_espresso'),
-                        strtolower($model->get_this_model_name()),
-                        Capabilities::get_missing_permissions_string(
-                            $model,
-                            $this->validate_context($request->get_param('caps')))
-                    ),
-                    array('status' => 403)
-                );
-            } else {
-                //it's not you. It just doesn't exist
-                return new \WP_Error(
-                    sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                    sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                    array('status' => 404)
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validate_context($context)
-    {
-        if (! $context) {
-            $context = \EEM_Base::caps_read;
-        }
-        $valid_contexts = \EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts)) {
-            return $context;
-        } else {
-            return \EEM_Base::caps_read;
-        }
-    }
-
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param $default_query_params
-     * @return string
-     */
-    public function validate_default_query_params($default_query_params)
-    {
-        $valid_default_where_conditions_for_api_calls = array(
-            \EEM_Base::default_where_conditions_all,
-            \EEM_Base::default_where_conditions_minimum_all,
-            \EEM_Base::default_where_conditions_minimum_others,
-        );
-        if (! $default_query_params) {
-            $default_query_params = \EEM_Base::default_where_conditions_all;
-        }
-        if (
-        in_array(
-            $default_query_params,
-            $valid_default_where_conditions_for_api_calls,
-            true
-        )
-        ) {
-            return $default_query_params;
-        } else {
-            return \EEM_Base::default_where_conditions_all;
-        }
-    }
-
-
-
-    /**
-     * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
-     * Note: right now the query parameter keys for fields (and related fields)
-     * can be left as-is, but it's quite possible this will change someday.
-     * Also, this method's contents might be candidate for moving to Model_Data_Translator
-     *
-     * @param \EEM_Base $model
-     * @param array     $query_parameters from $_GET parameter @see Read:handle_request_get_all
-     * @return array like what EEM_Base::get_all() expects or FALSE to indicate
-     *                                    that absolutely no results should be returned
-     * @throws \EE_Error
-     */
-    public function create_model_query_params($model, $query_parameters)
-    {
-        $model_query_params = array();
-        if (isset($query_parameters['where'])) {
-            $model_query_params[0] = Model_Data_Translator::prepare_conditions_query_params_for_models(
-                $query_parameters['where'],
-                $model,
-                $this->get_model_version_info()->requested_version()
-            );
-        }
-        if (isset($query_parameters['order_by'])) {
-            $order_by = $query_parameters['order_by'];
-        } elseif (isset($query_parameters['orderby'])) {
-            $order_by = $query_parameters['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = Model_Data_Translator::prepare_field_names_in_array_keys_from_json($order_by);
-            } else {
-                //it's a single item
-                $order_by = Model_Data_Translator::prepare_field_name_from_json($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_parameters['group_by'])) {
-            $group_by = $query_parameters['group_by'];
-        } elseif (isset($query_parameters['groupby'])) {
-            $group_by = $query_parameters['groupby'];
-        } else {
-            $group_by = array_keys($model->get_combined_primary_key_fields());
-        }
-        //make sure they're all real names
-        if (is_array($group_by)) {
-            $group_by = Model_Data_Translator::prepare_field_names_from_json($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_parameters['having'])) {
-            $model_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_models(
-                $query_parameters['having'],
-                $model,
-                $this->get_model_version_info()->requested_version()
-            );
-        }
-        if (isset($query_parameters['order'])) {
-            $model_query_params['order'] = $query_parameters['order'];
-        }
-        if (isset($query_parameters['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_parameters['limit'])) {
-            //limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string)$query_parameters['limit']);
-            } else {
-                $limit_array = $query_parameters['limit'];
-            }
-            $sanitized_limit = array();
-            foreach ($limit_array as $key => $limit_part) {
-                if ($this->_debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new \EE_Error(
-                        sprintf(
-                            __('An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                'event_espresso'),
-                            wp_json_encode($query_parameters['limit'])
-                        )
-                    );
-                }
-                $sanitized_limit[] = (int)$limit_part;
-            }
-            $model_query_params['limit'] = implode(',', $sanitized_limit);
-        } else {
-            $model_query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (isset($query_parameters['caps'])) {
-            $model_query_params['caps'] = $this->validate_context($query_parameters['caps']);
-        } else {
-            $model_query_params['caps'] = \EEM_Base::caps_read;
-        }
-        if (isset($query_parameters['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validate_default_query_params($query_parameters['default_where_conditions']);
-        }
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
-    }
-
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @deprecated
-     * @param \EEM_Base $model
-     * @param array     $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     */
-    public function prepare_rest_query_params_key_for_models($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[$key] = $this->prepare_rest_query_params_key_for_models($model, $value);
-            } else {
-                $model_ready_query_params[$key] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepare_rest_query_params_values_for_models($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[$key] = $this->prepare_rest_query_params_values_for_models($model, $value);
-            } else {
-                $model_ready_query_params[$key] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blaabla" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explode_and_get_items_prefixed_with($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } else if (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = array();
-        }
-        //if the string was empty, we want an empty array
-        $exploded_contents = array_filter($exploded_contents);
-        $contents_with_prefix = array();
-        foreach ($exploded_contents as $item) {
-            $item = trim($item);
-            //if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
-                //does this item have a period?
-                if (strpos($item, '.') === false) {
-                    //if not, then its what we're looking for
-                    $contents_with_prefix[] = $item;
-                }
-            } else if (strpos($item, $prefix . '.') === 0) {
-                //this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } else if ($item === $prefix) {
-                //this item is JUST the prefix
-                //so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-
-    /**
-     * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
-     * Deprecated because its return values were really quite confusing- sometimes it returned
-     * an empty array (when the include string was blank or '*') or sometimes it returned
-     * array('*') (when you provided a model and a model of that kind was found).
-     * Parses the $include_string so we fetch all the field names relating to THIS model
-     * (ie have NO period in them), or for the provided model (ie start with the model
-     * name and then a period).
-     * @param string $include_string @see Read:handle_request_get_all
-     * @param string $model_name
-     * @return array of fields for this model. If $model_name is provided, then
-     *                               the fields for that model, with the model's name removed from each.
-     *                               If $include_string was blank or '*' returns an empty array
-     */
-    public function extract_includes_for_this_model($include_string, $model_name = null)
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return array();
-        }
-        $includes = explode(',', $include_string);
-        $extracted_fields_to_include = array();
-        if ($model_name) {
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
-                    //found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
-                    $extracted_fields_to_include[] = $field_sans_model_name;
-                } elseif ($field_to_include == $model_name) {
-                    $extracted_fields_to_include[] = '*';
-                }
-            }
-        } else {
-            //look for ones with no period
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (
-                    strpos($field_to_include, '.') === false
-                    && ! $this->get_model_version_info()->is_model_name_in_this_version($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
+	/**
+	 * @var Calculated_Model_Fields
+	 */
+	protected $_fields_calculator;
+
+
+
+	/**
+	 * Read constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->_fields_calculator = new Calculated_Model_Fields();
+	}
+
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_all(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
+				array('version', 'model')
+			);
+			$controller->set_requested_version($matches['version']);
+			$model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entities_from_model(
+					$controller->get_model_version_info()->load_model($model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
+
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_one(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
+				array('version', 'model', 'id'));
+			$controller->set_requested_version($matches['version']);
+			$model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entity_from_model(
+					$controller->get_model_version_info()->load_model($model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_related(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
+				array('version', 'model', 'id', 'related_model')
+			);
+			$controller->set_requested_version($matches['version']);
+			$main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$main_model_name_singular
+						)
+					)
+				);
+			}
+			$main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
+			//assume the related model name is plural and try to find the model's name
+			$related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+				//so the word didn't singularize well. Maybe that's just because it's a singular word?
+				$related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
+			}
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$related_model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entities_from_relation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
+
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param \EEM_Base        $model
+	 * @param \WP_REST_Request $request
+	 * @return array|\WP_Error
+	 */
+	public function get_entities_from_model($model, $request)
+	{
+		$query_params = $this->create_model_query_params($model, $request->get_params());
+		if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
+			$model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			return new \WP_Error(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::get_missing_permissions_string($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->_set_headers_from_query_params($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] = $this->create_entity_from_wpdb_result(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+
+	/**
+	 * @param array                   $primary_model_query_params query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param \WP_REST_Request        $request
+	 * @return \WP_Error|array
+	 */
+	protected function _get_entities_from_relation($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validate_context($request->get_param('caps'));
+		$model = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = array();
+		}
+		//check if they can access the 1st model object
+		$primary_model_query_params = array(
+			0       => $primary_model_query_params[0],
+			'limit' => 1,
+		);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($primary_model_query_params);
+		}
+		$restricted_query_params = $primary_model_query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->_set_debug_info('main model query params', $restricted_query_params);
+		$this->_set_debug_info('missing caps', Capabilities::get_missing_permissions_string($related_model, $context));
+		if (
+		! (
+			Capabilities::current_user_has_partial_access_to($related_model, $context)
+			&& $model->exists($restricted_query_params)
+		)
+		) {
+			if ($relation instanceof \EE_Belongs_To_Relation) {
+				$related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
+			} else {
+				$related_model_name_maybe_plural = \EEH_Inflector::pluralize_and_lower($related_model->get_this_model_name());
+			}
+			return new \WP_Error(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
+						'event_espresso'),
+					$related_model_name_maybe_plural,
+					$relation->get_this_model()->get_this_model_name(),
+					implode(
+						',',
+						array_keys(
+							Capabilities::get_missing_permissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+		$query_params = $this->create_model_query_params($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][$relation->get_this_model()->get_this_model_name()
+							 . '.'
+							 . $where_condition_key] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps'] = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->_set_headers_from_query_params($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_result = $this->create_entity_from_wpdb_result(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof \EE_HABTM_Relation) {
+				//put the unusual stuff (properties from the HABTM relation) first, and make sure
+				//if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->create_entity_from_wpdb_result(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result = array_merge($nice_result, $join_model_result);
+				//but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof \EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param string                  $id the ID of the thing we are fetching related stuff from
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param \WP_REST_Request        $request
+	 * @return array|\WP_Error
+	 * @throws \EE_Error
+	 */
+	public function get_entities_from_relation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new \EE_Error(
+				sprintf(
+					__('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						'event_espresso'),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $this->_get_entities_from_relation(
+			array(
+				array(
+					$relation->get_this_model()->primary_key_name() => $id,
+				),
+			),
+			$relation,
+			$request
+		);
+	}
+
+
+
+	/**
+	 * Sets the headers that are based on the model and query params,
+	 * like the total records. This should only be called on the original request
+	 * from the client, not on subsequent internal
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $query_params
+	 * @return void
+	 */
+	protected function _set_headers_from_query_params($model, $query_params)
+	{
+		$this->_set_debug_info('model query params', $query_params);
+		$this->_set_debug_info('missing caps',
+			Capabilities::get_missing_permissions_string($model, $query_params['caps']));
+		//normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) == 1) {
+				$limit_parts = array(0, $limit_parts[0]);
+			}
+		}
+		//remove the group by and having parts of the query, as those will
+		//make the sql query return an array of values, instead of just a single value
+		unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
+		$count = $model->count($query_params, null, true);
+		$pages = $count / $limit_parts[1];
+		$this->_set_response_header('Total', $count, false);
+		$this->_set_response_header('PageSize', $limit_parts[1], false);
+		$this->_set_response_header('TotalPages', ceil($pages), false);
+	}
+
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param \EEM_Base        $model
+	 * @param array            $db_row     like results from $wpdb->get_results()
+	 * @param \WP_REST_Request $rest_request
+	 * @param string           $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 */
+	public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
+	{
+		if (! $rest_request instanceof \WP_REST_Request) {
+			//ok so this was called in the old style, where the 3rd arg was
+			//$include, and the 4th arg was $context
+			//now setup the request just to avoid fatal errors, although we won't be able
+			//to truly make use of it because it's kinda devoid of info
+			$rest_request = new \WP_REST_Request();
+			$rest_request->set_param('include', $rest_request);
+			$rest_request->set_param('caps', $deprecated);
+		}
+		if ($rest_request->get_param('caps') == null) {
+			$rest_request->set_param('caps', \EEM_Base::caps_read);
+		}
+		$entity_array = $this->_create_bare_entity_from_wpdb_results($model, $db_row);
+		$entity_array = $this->_add_extra_fields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->_get_entity_links($model, $db_row, $entity_array);
+		$entity_array['_calculated_fields'] = $this->_get_entity_calculations($model, $db_row, $rest_request);
+		$entity_array = $this->_include_requested_models($model, $rest_request, $entity_array, $db_row);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		$result_without_inaccessible_fields = Capabilities::filter_out_inaccessible_entity_fields(
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$this->get_model_version_info(),
+			$model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($db_row)
+			)
+		);
+		$this->_set_debug_info(
+			'inaccessible fields',
+			array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
+		);
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_return',
+			$result_without_inaccessible_fields,
+			$model,
+			$rest_request->get_param('caps')
+		);
+	}
+
+
+
+	/**
+	 * Creates a REST entity array (JSON object we're going to return in the response, but
+	 * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
+	 * from $wpdb->get_row( $sql, ARRAY_A)
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $db_row
+	 * @return array entity mostly ready for converting to JSON and sending in the response
+	 */
+	protected function _create_bare_entity_from_wpdb_results(\EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key($result,
+			$this->get_model_version_info()->fields_on_model_in_this_version($model));
+		foreach ($result as $field_name => $raw_field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			$field_value = $field_obj->prepare_for_set_from_db($raw_field_value);
+			if ($this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_ignored())) {
+				unset($result[$field_name]);
+			} elseif (
+			$this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_rendered_format())
+			) {
+				$result[$field_name] = array(
+					'raw'      => $field_obj->prepare_for_get($field_value),
+					'rendered' => $field_obj->prepare_for_pretty_echoing($field_value),
+				);
+			} elseif (
+			$this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_pretty_format())
+			) {
+				$result[$field_name] = array(
+					'raw'    => $field_obj->prepare_for_get($field_value),
+					'pretty' => $field_obj->prepare_for_pretty_echoing($field_value),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				if ($field_value instanceof \DateTime) {
+					$timezone = $field_value->getTimezone();
+					$field_value->setTimezone(new \DateTimeZone('UTC'));
+					$result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
+						$field_obj,
+						$field_value,
+						$this->get_model_version_info()->requested_version()
+					);
+					$field_value->setTimezone($timezone);
+					$result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
+						$field_obj,
+						$field_value,
+						$this->get_model_version_info()->requested_version()
+					);
+				}
+			} else {
+				$result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
+					$field_obj,
+					$field_obj->prepare_for_get($field_value),
+					$this->get_model_version_info()->requested_version()
+				);
+			}
+		}
+		return $result;
+	}
+
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $db_row
+	 * @param array     $entity_array
+	 * @return array modified entity
+	 */
+	protected function _add_extra_fields(\EEM_Base $model, $db_row, $entity_array)
+	{
+		if ($model instanceof \EEM_CPT_Base) {
+			$entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
+		}
+		return $entity_array;
+	}
+
+
+
+	/**
+	 * Gets links we want to add to the response
+	 *
+	 * @global \WP_REST_Server $wp_rest_server
+	 * @param \EEM_Base        $model
+	 * @param array            $db_row
+	 * @param array            $entity_array
+	 * @return array the _links item in the entity
+	 */
+	protected function _get_entity_links($model, $db_row, $entity_array)
+	{
+		//add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->get_versioned_link_to(
+						\EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[$model->primary_key_name()]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->get_versioned_link_to(
+					\EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		//add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
+				$links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
+					array(
+						'href'   => $this->get_versioned_link_to(
+							\EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[$model->primary_key_name()]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
+					),
+				);
+			}
+		}
+		return $links;
+	}
+
+
+
+	/**
+	 * Adds the included models indicated in the request to the entity provided
+	 *
+	 * @param \EEM_Base        $model
+	 * @param \WP_REST_Request $rest_request
+	 * @param array            $entity_array
+	 * @param array            $db_row
+	 * @return array the modified entity
+	 */
+	protected function _include_requested_models(
+		\EEM_Base $model,
+		\WP_REST_Request $rest_request,
+		$entity_array,
+		$db_row = array()
+	) {
+		//if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
+		//if they passed in * or didn't specify any includes, return everything
+		if (! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				//always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explode_and_get_items_prefixed_with($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		$relation_settings = $this->get_model_version_info()->relation_settings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explode_and_get_items_prefixed_with(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explode_and_get_items_prefixed_with(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			//did they specify they wanted to include a related model, or
+			//specific fields from a related model?
+			//or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				//if so, we should include at least some part of the related model
+				$pretend_related_request = new \WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					array(
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+					)
+				);
+				$pretend_related_request->add_header('no_rest_headers', true);
+				$primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				);
+				$related_results = $this->_get_entities_from_relation(
+					$primary_model_query_params,
+					$relation_obj,
+					$pretend_related_request
+				);
+				$entity_array[Read::get_related_entity_name($relation_name, $relation_obj)] = $related_results
+																							  instanceof
+																							  \WP_Error
+					? null
+					: $related_results;
+			}
+		}
+		return $entity_array;
+	}
+
+
+
+	/**
+	 * Returns a new array with all the names of models removed. Eg
+	 * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	private function _remove_model_names_from_array($arr)
+	{
+		return array_diff($arr, array_keys(\EE_Registry::instance()->non_abstract_db_models));
+	}
+
+
+
+	/**
+	 * Gets the calculated fields for the response
+	 *
+	 * @param \EEM_Base        $model
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $rest_request
+	 * @return \stdClass the _calculations item in the entity
+	 */
+	protected function _get_entity_calculations($model, $wpdb_row, $rest_request)
+	{
+		$calculated_fields = $this->explode_and_get_items_prefixed_with(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		//note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new \stdClass();
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				$calculated_fields_to_return->$field_to_calculate = Model_Data_Translator::prepare_field_value_for_json(
+					null,
+					$this->_fields_calculator->retrieve_calculated_field_value(
+						$model,
+						$field_to_calculate,
+						$wpdb_row,
+						$rest_request,
+						$this
+					),
+					$this->get_model_version_info()->requested_version()
+				);
+			} catch (Rest_Exception $e) {
+				//if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->_set_response_header(
+					'Notices-Field-Calculation-Errors['
+					. $e->get_string_code()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage(),
+					true
+				);
+			}
+		}
+		return $calculated_fields_to_return;
+	}
+
+
+
+	/**
+	 * Gets the full URL to the resource, taking the requested version into account
+	 *
+	 * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
+	 * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
+	 */
+	public function get_versioned_link_to($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			\EED_Core_Rest_Api::ee_api_namespace
+			. $this->get_model_version_info()->requested_version()
+			. '/'
+			. $link_part_after_version_and_slash
+		);
+	}
+
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                  $relation_name
+	 * @param \EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function get_related_entity_name($relation_name, $relation_obj)
+	{
+		if ($relation_obj instanceof \EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		} else {
+			return \EEH_Inflector::pluralize_and_lower($relation_name);
+		}
+	}
+
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param \EEM_Base        $model
+	 * @param \WP_REST_Request $request
+	 * @return array|\WP_Error
+	 */
+	public function get_entity_from_model($model, $request)
+	{
+		$query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		}
+		$restricted_query_params = $query_params;
+		$restricted_query_params['caps'] = $this->validate_context($request->get_param('caps'));
+		$this->_set_debug_info('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty ($model_rows)) {
+			return $this->create_entity_from_wpdb_result(
+				$model,
+				array_shift($model_rows),
+				$request);
+		} else {
+			//ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			$model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
+			if (! empty($model_rows_found_sans_restrictions)) {
+				//you got shafted- it existed but we didn't want to tell you!
+				return new \WP_Error(
+					'rest_user_cannot_read',
+					sprintf(
+						__('Sorry, you cannot read this %1$s. Missing permissions are: %2$s', 'event_espresso'),
+						strtolower($model->get_this_model_name()),
+						Capabilities::get_missing_permissions_string(
+							$model,
+							$this->validate_context($request->get_param('caps')))
+					),
+					array('status' => 403)
+				);
+			} else {
+				//it's not you. It just doesn't exist
+				return new \WP_Error(
+					sprintf('rest_%s_invalid_id', $lowercase_model_name),
+					sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+					array('status' => 404)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validate_context($context)
+	{
+		if (! $context) {
+			$context = \EEM_Base::caps_read;
+		}
+		$valid_contexts = \EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts)) {
+			return $context;
+		} else {
+			return \EEM_Base::caps_read;
+		}
+	}
+
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param $default_query_params
+	 * @return string
+	 */
+	public function validate_default_query_params($default_query_params)
+	{
+		$valid_default_where_conditions_for_api_calls = array(
+			\EEM_Base::default_where_conditions_all,
+			\EEM_Base::default_where_conditions_minimum_all,
+			\EEM_Base::default_where_conditions_minimum_others,
+		);
+		if (! $default_query_params) {
+			$default_query_params = \EEM_Base::default_where_conditions_all;
+		}
+		if (
+		in_array(
+			$default_query_params,
+			$valid_default_where_conditions_for_api_calls,
+			true
+		)
+		) {
+			return $default_query_params;
+		} else {
+			return \EEM_Base::default_where_conditions_all;
+		}
+	}
+
+
+
+	/**
+	 * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
+	 * Note: right now the query parameter keys for fields (and related fields)
+	 * can be left as-is, but it's quite possible this will change someday.
+	 * Also, this method's contents might be candidate for moving to Model_Data_Translator
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $query_parameters from $_GET parameter @see Read:handle_request_get_all
+	 * @return array like what EEM_Base::get_all() expects or FALSE to indicate
+	 *                                    that absolutely no results should be returned
+	 * @throws \EE_Error
+	 */
+	public function create_model_query_params($model, $query_parameters)
+	{
+		$model_query_params = array();
+		if (isset($query_parameters['where'])) {
+			$model_query_params[0] = Model_Data_Translator::prepare_conditions_query_params_for_models(
+				$query_parameters['where'],
+				$model,
+				$this->get_model_version_info()->requested_version()
+			);
+		}
+		if (isset($query_parameters['order_by'])) {
+			$order_by = $query_parameters['order_by'];
+		} elseif (isset($query_parameters['orderby'])) {
+			$order_by = $query_parameters['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = Model_Data_Translator::prepare_field_names_in_array_keys_from_json($order_by);
+			} else {
+				//it's a single item
+				$order_by = Model_Data_Translator::prepare_field_name_from_json($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_parameters['group_by'])) {
+			$group_by = $query_parameters['group_by'];
+		} elseif (isset($query_parameters['groupby'])) {
+			$group_by = $query_parameters['groupby'];
+		} else {
+			$group_by = array_keys($model->get_combined_primary_key_fields());
+		}
+		//make sure they're all real names
+		if (is_array($group_by)) {
+			$group_by = Model_Data_Translator::prepare_field_names_from_json($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_parameters['having'])) {
+			$model_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_models(
+				$query_parameters['having'],
+				$model,
+				$this->get_model_version_info()->requested_version()
+			);
+		}
+		if (isset($query_parameters['order'])) {
+			$model_query_params['order'] = $query_parameters['order'];
+		}
+		if (isset($query_parameters['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_parameters['limit'])) {
+			//limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_parameters['limit'])) {
+				$limit_array = explode(',', (string)$query_parameters['limit']);
+			} else {
+				$limit_array = $query_parameters['limit'];
+			}
+			$sanitized_limit = array();
+			foreach ($limit_array as $key => $limit_part) {
+				if ($this->_debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new \EE_Error(
+						sprintf(
+							__('An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								'event_espresso'),
+							wp_json_encode($query_parameters['limit'])
+						)
+					);
+				}
+				$sanitized_limit[] = (int)$limit_part;
+			}
+			$model_query_params['limit'] = implode(',', $sanitized_limit);
+		} else {
+			$model_query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (isset($query_parameters['caps'])) {
+			$model_query_params['caps'] = $this->validate_context($query_parameters['caps']);
+		} else {
+			$model_query_params['caps'] = \EEM_Base::caps_read;
+		}
+		if (isset($query_parameters['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validate_default_query_params($query_parameters['default_where_conditions']);
+		}
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
+	}
+
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @deprecated
+	 * @param \EEM_Base $model
+	 * @param array     $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 */
+	public function prepare_rest_query_params_key_for_models($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[$key] = $this->prepare_rest_query_params_key_for_models($model, $value);
+			} else {
+				$model_ready_query_params[$key] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepare_rest_query_params_values_for_models($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[$key] = $this->prepare_rest_query_params_values_for_models($model, $value);
+			} else {
+				$model_ready_query_params[$key] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blaabla" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explode_and_get_items_prefixed_with($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} else if (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = array();
+		}
+		//if the string was empty, we want an empty array
+		$exploded_contents = array_filter($exploded_contents);
+		$contents_with_prefix = array();
+		foreach ($exploded_contents as $item) {
+			$item = trim($item);
+			//if no prefix was provided, so we look for items with no "." in them
+			if (! $prefix) {
+				//does this item have a period?
+				if (strpos($item, '.') === false) {
+					//if not, then its what we're looking for
+					$contents_with_prefix[] = $item;
+				}
+			} else if (strpos($item, $prefix . '.') === 0) {
+				//this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} else if ($item === $prefix) {
+				//this item is JUST the prefix
+				//so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+
+	/**
+	 * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
+	 * Deprecated because its return values were really quite confusing- sometimes it returned
+	 * an empty array (when the include string was blank or '*') or sometimes it returned
+	 * array('*') (when you provided a model and a model of that kind was found).
+	 * Parses the $include_string so we fetch all the field names relating to THIS model
+	 * (ie have NO period in them), or for the provided model (ie start with the model
+	 * name and then a period).
+	 * @param string $include_string @see Read:handle_request_get_all
+	 * @param string $model_name
+	 * @return array of fields for this model. If $model_name is provided, then
+	 *                               the fields for that model, with the model's name removed from each.
+	 *                               If $include_string was blank or '*' returns an empty array
+	 */
+	public function extract_includes_for_this_model($include_string, $model_name = null)
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return array();
+		}
+		$includes = explode(',', $include_string);
+		$extracted_fields_to_include = array();
+		if ($model_name) {
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, $model_name . '.') === 0) {
+					//found the model name at the exact start
+					$field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+					$extracted_fields_to_include[] = $field_sans_model_name;
+				} elseif ($field_to_include == $model_name) {
+					$extracted_fields_to_include[] = '*';
+				}
+			}
+		} else {
+			//look for ones with no period
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (
+					strpos($field_to_include, '.') === false
+					&& ! $this->get_model_version_info()->is_model_name_in_this_version($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
 }
 
 

Spacing +33 added lines, -33 removed lines

@@ -6,7 +6,7 @@ 
 use EventEspresso\core\libraries\rest_api\Rest_Exception;
 use EventEspresso\core\libraries\rest_api\Model_Data_Translator;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -55,12 +55,12 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)~',
                 array('version', 'model')
             );
             $controller->set_requested_version($matches['version']);
             $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -97,11 +97,11 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)/(.*)~',
                 array('version', 'model', 'id'));
             $controller->set_requested_version($matches['version']);
             $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -139,12 +139,12 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)/(.*)/(.*)~',
                 array('version', 'model', 'id', 'related_model')
             );
             $controller->set_requested_version($matches['version']);
             $main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -159,11 +159,11 @@ 
             $main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
             //assume the related model name is plural and try to find the model's name
             $related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
                 //so the word didn't singularize well. Maybe that's just because it's a singular word?
                 $related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
             }
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -199,7 +199,7 @@ 
     public function get_entities_from_model($model, $request)
     {
         $query_params = $this->create_model_query_params($model, $request->get_params());
-        if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
+        if ( ! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
             $model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             return new \WP_Error(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -211,7 +211,7 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->_set_headers_from_query_params($model, $query_params);
         }
         /** @type array $results */
@@ -241,7 +241,7 @@ 
         $context = $this->validate_context($request->get_param('caps'));
         $model = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = array();
         }
         //check if they can access the 1st model object
@@ -292,7 +292,7 @@ 
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->_set_headers_from_query_params($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -344,7 +344,7 @@ 
      */
     public function get_entities_from_relation($id, $relation, $request)
     {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new \EE_Error(
                 sprintf(
                     __('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
@@ -381,7 +381,7 @@ 
         $this->_set_debug_info('missing caps',
             Capabilities::get_missing_permissions_string($model, $query_params['caps']));
         //normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = \EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -415,7 +415,7 @@ 
      */
     public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
     {
-        if (! $rest_request instanceof \WP_REST_Request) {
+        if ( ! $rest_request instanceof \WP_REST_Request) {
             //ok so this was called in the old style, where the 3rd arg was
             //$include, and the 4th arg was $context
             //now setup the request just to avoid fatal errors, although we won't be able
@@ -500,7 +500,7 @@ 
                 if ($field_value instanceof \DateTime) {
                     $timezone = $field_value->getTimezone();
                     $field_value->setTimezone(new \DateTimeZone('UTC'));
-                    $result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
+                    $result[$field_name.'_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
                         $field_obj,
                         $field_value,
                         $this->get_model_version_info()->requested_version()
@@ -578,7 +578,7 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
-                $links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
+                $links[\EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = array(
                     array(
                         'href'   => $this->get_versioned_link_to(
                             \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
@@ -613,13 +613,13 @@ 
         $db_row = array()
     ) {
         //if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
         //if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
+        if ( ! in_array('*', $includes_for_this_model)
             && ! empty($includes_for_this_model)
         ) {
             if ($model->has_primary_key_field()) {
@@ -794,7 +794,7 @@ 
         $restricted_query_params['caps'] = $this->validate_context($request->get_param('caps'));
         $this->_set_debug_info('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty ($model_rows)) {
+        if ( ! empty ($model_rows)) {
             return $this->create_entity_from_wpdb_result(
                 $model,
                 array_shift($model_rows),
@@ -803,7 +803,7 @@ 
             //ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
             $lowercase_model_name = strtolower($model->get_this_model_name());
             $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
+            if ( ! empty($model_rows_found_sans_restrictions)) {
                 //you got shafted- it existed but we didn't want to tell you!
                 return new \WP_Error(
                     'rest_user_cannot_read',
@@ -838,7 +838,7 @@ 
      */
     public function validate_context($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = \EEM_Base::caps_read;
         }
         $valid_contexts = \EEM_Base::valid_cap_contexts();
@@ -864,7 +864,7 @@ 
             \EEM_Base::default_where_conditions_minimum_all,
             \EEM_Base::default_where_conditions_minimum_others,
         );
-        if (! $default_query_params) {
+        if ( ! $default_query_params) {
             $default_query_params = \EEM_Base::default_where_conditions_all;
         }
         if (
@@ -949,14 +949,14 @@ 
         }
         if (isset($query_parameters['limit'])) {
             //limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string)$query_parameters['limit']);
+            if ( ! is_array($query_parameters['limit'])) {
+                $limit_array = explode(',', (string) $query_parameters['limit']);
             } else {
                 $limit_array = $query_parameters['limit'];
             }
             $sanitized_limit = array();
             foreach ($limit_array as $key => $limit_part) {
-                if ($this->_debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+                if ($this->_debug_mode && ( ! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
                     throw new \EE_Error(
                         sprintf(
                             __('An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
@@ -965,7 +965,7 @@ 
                         )
                     );
                 }
-                $sanitized_limit[] = (int)$limit_part;
+                $sanitized_limit[] = (int) $limit_part;
             }
             $model_query_params['limit'] = implode(',', $sanitized_limit);
         } else {
@@ -1053,17 +1053,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             //if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 //does this item have a period?
                 if (strpos($item, '.') === false) {
                     //if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } else if (strpos($item, $prefix . '.') === 0) {
+            } else if (strpos($item, $prefix.'.') === 0) {
                 //this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } else if ($item === $prefix) {
                 //this item is JUST the prefix
@@ -1103,9 +1103,9 @@ 
         if ($model_name) {
             foreach ($includes as $field_to_include) {
                 $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
+                if (strpos($field_to_include, $model_name.'.') === 0) {
                     //found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+                    $field_sans_model_name = str_replace($model_name.'.', '', $field_to_include);
                     $extracted_fields_to_include[] = $field_sans_model_name;
                 } elseif ($field_to_include == $model_name) {
                     $extracted_fields_to_include[] = '*';

core/EE_Payment_Processor.core.php

Indentation +734 added lines, -734 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 EE_Registry::instance()->load_class('Processor_Base');
 
@@ -16,737 +16,737 @@ 
 class EE_Payment_Processor extends EE_Processor_Base
 {
 
-    /**
-     * @var EE_Payment_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Payment_Processor instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_Payment_Processor) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Payment_Processor__construct');
-        add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
-    }
-
-
-
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction
-     * appropriately. Saves the payment that is generated
-     *
-     * @param EE_Payment_Method    $payment_method
-     * @param EE_Transaction       $transaction
-     * @param float                $amount       if only part of the transaction is to be paid for, how much.
-     *                                           Leave null if payment is for the full amount owing
-     * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
-     *                                           Receive_form_submission() should have
-     *                                           already been called on the billing form
-     *                                           (ie, its inputs should have their normalized values set).
-     * @param string               $return_url   string used mostly by offsite gateways to specify
-     *                                           where to go AFTER the offsite gateway
-     * @param string               $method       like 'CART', indicates who the client who called this was
-     * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
-     * @param boolean              $update_txn   whether or not to call
-     *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string               $cancel_url   URL to return to if off-site payments are cancelled
-     * @return \EE_Payment
-     * @throws \EE_Error
-     */
-    public function process_payment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_form = null,
-        $return_url = null,
-        $method = 'CART',
-        $by_admin = false,
-        $update_txn = true,
-        $cancel_url = ''
-    ) {
-        if ((float)$amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-        // verify payment method
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
-        // verify transaction
-        EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                min($amount, $transaction->remaining()),//make sure we don't overcharge
-                $billing_form,
-                $return_url,
-                add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        } else {
-            EE_Error::add_error(
-                sprintf(
-                    __('A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.', 'event_espresso'),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ), __FILE__, __FUNCTION__, __LINE__
-            );
-            return null;
-        }
-    }
-
-
-
-    /**
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment_Method  $payment_method
-     * @throws EE_Error
-     * @return string
-     */
-    public function get_ipn_url_for_payment_method($transaction, $payment_method)
-    {
-        /** @type \EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $primary_reg = $transaction->primary_registration();
-        if ( ! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Cannot get IPN URL for transaction with ID %d because it has no primary registration",
-                        "event_espresso"
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
-        $url = add_query_arg(
-            array(
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ),
-            EE_Registry::instance()->CFG->core->txn_page_url()
-        );
-        return $url;
-    }
-
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array              $_req_data            eg $_REQUEST
-     * @param EE_Transaction|int $transaction          optional (or a transactions id)
-     * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
-     * @param boolean            $update_txn           whether or not to call
-     *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
-     *                                                 or is processed manually ( false like Mijireh )
-     * @throws EE_Error
-     * @throws Exception
-     * @return EE_Payment
-     */
-    public function process_ipn(
-        $_req_data,
-        $transaction = null,
-        $payment_method = null,
-        $update_txn = true,
-        $separate_IPN_request = true
-    ) {
-        EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array)$_req_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        $obj_for_log = null;
-        if ($transaction instanceof EE_Transaction) {
-            $obj_for_log = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $obj_for_log = EEM_Payment::instance()->get_one(
-                    array(
-                        array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
-                        'order_by' => array('PAY_timestamp' => 'desc'),
-                    )
-                );
-            }
-        } else if ($payment_method instanceof EE_Payment) {
-            $obj_for_log = $payment_method;
-        }
-        $log = EEM_Change_Log::instance()->log(
-            EEM_Change_Log::type_gateway,
-            array('IPN data received' => $_req_data),
-            $obj_for_log
-        );
-        try {
-            /**
-             * @var EE_Payment $payment
-             */
-            $payment = null;
-            if ($transaction && $payment_method) {
-                /** @type EE_Transaction $transaction */
-                $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-                /** @type EE_Payment_Method $payment_method */
-                $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
-                if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-                    try {
-                        $payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
-                        $log->set_object($payment);
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    }
-                } else {
-                    // not a payment
-                    EE_Error::add_error(
-                        sprintf(
-                            __('A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.', 'event_espresso'),
-                            '<br/>',
-                            EE_Registry::instance()->CFG->organization->get_pretty('email')
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                }
-            } else {
-                //that's actually pretty ok. The IPN just wasn't able
-                //to identify which transaction or payment method this was for
-                // give all active payment methods a chance to claim it
-                $active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
-                foreach ($active_payment_methods as $active_payment_method) {
-                    try {
-                        $payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
-                        $payment_method = $active_payment_method;
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment
-                        );
-                        break;
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    } catch (EE_Error $e) {
-                        //that's fine- it apparently couldn't handle the IPN
-                    }
-                }
-            }
-            // 			EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
-            if ($payment instanceof EE_Payment) {
-                $payment->save();
-                //  update the TXN
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn, $separate_IPN_request);
-            } else {
-                //we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-                if ($payment_method) {
-                    EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment_method);
-                } elseif ($transaction) {
-                    EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $transaction);
-                }
-            }
-            return $payment;
-        } catch (EE_Error $e) {
-            do_action(
-                'AHEE__log', __FILE__, __FUNCTION__, sprintf(
-                    __('Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"', 'event_espresso'),
-                    print_r($transaction, true),
-                    print_r($_req_data, true),
-                    $e->getMessage()
-                )
-            );
-            throw $e;
-        }
-    }
-
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param  array $request_data
-     * @return array
-     */
-    protected function _remove_unusable_characters_from_array(array $request_data)
-    {
-        $return_data = array();
-        foreach ($request_data as $key => $value) {
-            $return_data[$this->_remove_unusable_characters($key)] = $this->_remove_unusable_characters($value);
-        }
-        return $return_data;
-    }
-
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    protected function _remove_unusable_characters($request_data)
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
-
-
-
-    /**
-     * Should be called just before displaying the payment attempt results to the user,
-     * when the payment attempt has finished. Some payment methods may have special
-     * logic to perform here. For example, if process_payment() happens on a special request
-     * and then the user is redirected to a page that displays the payment's status, this
-     * should be called while loading the page that displays the payment's status. If the user is
-     * sent to an offsite payment provider, this should be called upon returning from that offsite payment
-     * provider.
-     *
-     * @param EE_Transaction|int $transaction
-     * @param bool               $update_txn whether or not to call
-     *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @throws \EE_Error
-     * @return EE_Payment
-     * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
-     *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
-     */
-    public function finalize_payment_for($transaction, $update_txn = true)
-    {
-        /** @var $transaction EE_Transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $last_payment_method = $transaction->payment_method();
-        if ($last_payment_method instanceof EE_Payment_Method) {
-            $payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
-            $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            return $payment;
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param EE_Payment        $payment_to_refund
-     * @param array             $refund_info
-     * @return EE_Payment
-     * @throws \EE_Error
-     */
-    public function process_refund(
-        EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        $refund_info = array()
-    ) {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
-        }
-        return $payment_to_refund;
-    }
-
-
-
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether or not to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment         $payment
-     * @param boolean            $update_txn
-     *                        whether or not to call
-     *                        EE_Transaction_Processor::
-     *                        update_transaction_and_registrations_after_checkout_or_payment()
-     *                        (you can save 1 DB query if you know you're going
-     *                        to save it later instead)
-     * @param bool               $IPN
-     *                        if processing IPNs or other similar payment
-     *                        related activities that occur in alternate
-     *                        requests than the main one that is processing the
-     *                        TXN, then set this to true to check whether the
-     *                        TXN is locked before updating
-     * @throws \EE_Error
-     */
-    public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
-    {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment && $payment->ID()) {
-                if (
-                    $payment->payment_method() instanceof EE_Payment_Method
-                    && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-                ) {
-                    $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                    // update TXN registrations with payment info
-                    $this->process_registration_payments($transaction, $payment);
-                }
-                $do_action = $payment->just_approved()
-                    ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                    : $do_action;
-            } else {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-            }
-            if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                // set new value for total paid
-                $transaction_payments->calculate_total_payments_and_update_status($transaction);
-                // call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
-                if ($update_txn) {
-                    $this->_post_payment_processing($transaction, $payment, $IPN);
-                }
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            //global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
-
-
-
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws \EE_Error
-     */
-    public function process_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        $registrations = array()
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        //EEM_Registration::instance()->show_next_x_db_queries();
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                array(
-                    array(
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
-                        'REG_final_price'  => array('!=', 0),
-                        'REG_final_price*' => array('!=', 'REG_paid', true),
-                    ),
-                )
-            );
-        }
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->process_registration_refund($registration, $payment, $available_payment_amount);
-                } else {
-                    $available_payment_amount = $this->process_registration_payment($registration, $payment, $available_payment_amount);
-                }
-            }
-        }
-        if ($available_payment_amount > 0 && apply_filters('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', false)) {
-            EE_Error::add_attention(
-                sprintf(
-                    __('A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_payment_amount
-     * @return float
-     * @throws \EE_Error
-     */
-    public function process_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_payment_amount = 0.00
-    ) {
-        $owing = $registration->final_price() - $registration->paid();
-        if ($owing > 0) {
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount -= $payment_amount;
-            //calculate and set new REG_paid
-            $registration->set_paid($registration->paid() + $payment_amount);
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $payment_amount);
-        }
-        return $available_payment_amount;
-    }
-
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $payment_amount
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _apply_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $payment_amount = 0.00
-    ) {
-        // find any existing reg payment records for this registration and payment
-        $existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
-            array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
-        );
-        // if existing registration payment exists
-        if ($existing_reg_payment instanceof EE_Registration_Payment) {
-            // then update that record
-            $existing_reg_payment->set_amount($payment_amount);
-            $existing_reg_payment->save();
-        } else {
-            // or add new relation between registration and payment and set amount
-            $registration->_add_relation_to($payment, 'Payment', array('RPY_amount' => $payment_amount));
-            // make it stick
-            $registration->save();
-        }
-    }
-
-
-
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws \EE_Error
-     */
-    public function process_registration_refund(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_refund_amount = 0.00
-    ) {
-        //EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
-        if ($registration->paid() > 0) {
-            // ensure $available_refund_amount is NOT negative
-            $available_refund_amount = (float)abs($available_refund_amount);
-            // don't allow refund amount to exceed the available payment amount, OR the amount paid
-            $refund_amount = min($available_refund_amount, (float)$registration->paid());
-            // update $available_payment_amount
-            $available_refund_amount -= $refund_amount;
-            //calculate and set new REG_paid
-            $registration->set_paid($registration->paid() - $refund_amount);
-            // convert payment amount back to a negative value for storage in the db
-            $refund_amount = (float)abs($refund_amount) * -1;
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $refund_amount);
-        }
-        return $available_refund_amount;
-    }
-
-
-
-    /**
-     * Process payments and transaction after payment process completed.
-     * ultimately this will send the TXN and payment details off so that notifications can be sent out.
-     * if this request happens to be processing an IPN,
-     * then we will also set the Payment Options Reg Step to completed,
-     * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @throws \EE_Error
-     */
-    protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // is the Payment Options Reg Step completed ?
-        $payment_options_step_completed = $transaction->reg_step_completed('payment_options');
-        // if the Payment Options Reg Step is completed...
-        $revisit = $payment_options_step_completed === true ? true : false;
-        // then this is kinda sorta a revisit with regards to payments at least
-        $transaction_processor->set_revisit($revisit);
-        // if this is an IPN, let's consider the Payment Options Reg Step completed if not already
-        if (
-            $IPN
-            && $payment_options_step_completed !== true
-            && ($payment->is_approved() || $payment->is_pending())
-        ) {
-            $payment_options_step_completed = $transaction->set_reg_step_completed(
-                'payment_options'
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid(false);
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        //  if this is an IPN and the final step has not been initiated
-        if ($IPN && $payment_options_step_completed && $finalized === false) {
-            // and if it hasn't already been set as being started...
-            $finalized = $transaction->set_reg_step_initiated('finalize_registration');
-        }
-        $transaction->save();
-        // because the above will return false if the final step was not fully completed, we need to check again...
-        if ($IPN && $finalized !== false) {
-            // and if we are all good to go, then send out notifications
-            add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            //ok, now process the transaction according to the payment
-            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($transaction, $payment);
-        }
-        // DEBUG LOG
-        $payment_method = $payment->payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payment_method_type_obj = $payment_method->type_obj();
-            if ($payment_method_type_obj instanceof EE_PMT_Base) {
-                $gateway = $payment_method_type_obj->get_gateway();
-                if ($gateway instanceof EE_Gateway) {
-                    $gateway->log(
-                        array(
-                            'message'               => __('Post Payment Transaction Details', 'event_espresso'),
-                            'transaction'           => $transaction->model_field_array(),
-                            'finalized'             => $finalized,
-                            'IPN'                   => $IPN,
-                            'deliver_notifications' => has_filter(
-                                'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-                            ),
-                        ),
-                        $payment
-                    );
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect paypal standard, pro, express, and payflow.
-     */
-    public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
-    {
-        if (strstr($url, 'https://') && strstr($url, '.paypal.com')) {
-            //Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            //instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 1);
-        }
-    }
+	/**
+	 * @var EE_Payment_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Payment_Processor instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_Payment_Processor) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Payment_Processor__construct');
+		add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
+	}
+
+
+
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction
+	 * appropriately. Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method    $payment_method
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount       if only part of the transaction is to be paid for, how much.
+	 *                                           Leave null if payment is for the full amount owing
+	 * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
+	 *                                           Receive_form_submission() should have
+	 *                                           already been called on the billing form
+	 *                                           (ie, its inputs should have their normalized values set).
+	 * @param string               $return_url   string used mostly by offsite gateways to specify
+	 *                                           where to go AFTER the offsite gateway
+	 * @param string               $method       like 'CART', indicates who the client who called this was
+	 * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
+	 * @param boolean              $update_txn   whether or not to call
+	 *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string               $cancel_url   URL to return to if off-site payments are cancelled
+	 * @return \EE_Payment
+	 * @throws \EE_Error
+	 */
+	public function process_payment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_form = null,
+		$return_url = null,
+		$method = 'CART',
+		$by_admin = false,
+		$update_txn = true,
+		$cancel_url = ''
+	) {
+		if ((float)$amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+		// verify payment method
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
+		// verify transaction
+		EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				min($amount, $transaction->remaining()),//make sure we don't overcharge
+				$billing_form,
+				$return_url,
+				add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		} else {
+			EE_Error::add_error(
+				sprintf(
+					__('A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.', 'event_espresso'),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				), __FILE__, __FUNCTION__, __LINE__
+			);
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment_Method  $payment_method
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function get_ipn_url_for_payment_method($transaction, $payment_method)
+	{
+		/** @type \EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$primary_reg = $transaction->primary_registration();
+		if ( ! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Cannot get IPN URL for transaction with ID %d because it has no primary registration",
+						"event_espresso"
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
+		$url = add_query_arg(
+			array(
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			),
+			EE_Registry::instance()->CFG->core->txn_page_url()
+		);
+		return $url;
+	}
+
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array              $_req_data            eg $_REQUEST
+	 * @param EE_Transaction|int $transaction          optional (or a transactions id)
+	 * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
+	 * @param boolean            $update_txn           whether or not to call
+	 *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
+	 *                                                 or is processed manually ( false like Mijireh )
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @return EE_Payment
+	 */
+	public function process_ipn(
+		$_req_data,
+		$transaction = null,
+		$payment_method = null,
+		$update_txn = true,
+		$separate_IPN_request = true
+	) {
+		EE_Registry::instance()->load_model('Change_Log');
+		$_req_data = $this->_remove_unusable_characters_from_array((array)$_req_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		$obj_for_log = null;
+		if ($transaction instanceof EE_Transaction) {
+			$obj_for_log = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$obj_for_log = EEM_Payment::instance()->get_one(
+					array(
+						array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
+						'order_by' => array('PAY_timestamp' => 'desc'),
+					)
+				);
+			}
+		} else if ($payment_method instanceof EE_Payment) {
+			$obj_for_log = $payment_method;
+		}
+		$log = EEM_Change_Log::instance()->log(
+			EEM_Change_Log::type_gateway,
+			array('IPN data received' => $_req_data),
+			$obj_for_log
+		);
+		try {
+			/**
+			 * @var EE_Payment $payment
+			 */
+			$payment = null;
+			if ($transaction && $payment_method) {
+				/** @type EE_Transaction $transaction */
+				$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+				/** @type EE_Payment_Method $payment_method */
+				$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
+				if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+					try {
+						$payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
+						$log->set_object($payment);
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					}
+				} else {
+					// not a payment
+					EE_Error::add_error(
+						sprintf(
+							__('A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.', 'event_espresso'),
+							'<br/>',
+							EE_Registry::instance()->CFG->organization->get_pretty('email')
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+				}
+			} else {
+				//that's actually pretty ok. The IPN just wasn't able
+				//to identify which transaction or payment method this was for
+				// give all active payment methods a chance to claim it
+				$active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
+				foreach ($active_payment_methods as $active_payment_method) {
+					try {
+						$payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
+						$payment_method = $active_payment_method;
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment
+						);
+						break;
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					} catch (EE_Error $e) {
+						//that's fine- it apparently couldn't handle the IPN
+					}
+				}
+			}
+			// 			EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
+			if ($payment instanceof EE_Payment) {
+				$payment->save();
+				//  update the TXN
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn, $separate_IPN_request);
+			} else {
+				//we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+				if ($payment_method) {
+					EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment_method);
+				} elseif ($transaction) {
+					EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $transaction);
+				}
+			}
+			return $payment;
+		} catch (EE_Error $e) {
+			do_action(
+				'AHEE__log', __FILE__, __FUNCTION__, sprintf(
+					__('Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"', 'event_espresso'),
+					print_r($transaction, true),
+					print_r($_req_data, true),
+					$e->getMessage()
+				)
+			);
+			throw $e;
+		}
+	}
+
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param  array $request_data
+	 * @return array
+	 */
+	protected function _remove_unusable_characters_from_array(array $request_data)
+	{
+		$return_data = array();
+		foreach ($request_data as $key => $value) {
+			$return_data[$this->_remove_unusable_characters($key)] = $this->_remove_unusable_characters($value);
+		}
+		return $return_data;
+	}
+
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	protected function _remove_unusable_characters($request_data)
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
+
+
+
+	/**
+	 * Should be called just before displaying the payment attempt results to the user,
+	 * when the payment attempt has finished. Some payment methods may have special
+	 * logic to perform here. For example, if process_payment() happens on a special request
+	 * and then the user is redirected to a page that displays the payment's status, this
+	 * should be called while loading the page that displays the payment's status. If the user is
+	 * sent to an offsite payment provider, this should be called upon returning from that offsite payment
+	 * provider.
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param bool               $update_txn whether or not to call
+	 *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @throws \EE_Error
+	 * @return EE_Payment
+	 * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
+	 *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
+	 */
+	public function finalize_payment_for($transaction, $update_txn = true)
+	{
+		/** @var $transaction EE_Transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$last_payment_method = $transaction->payment_method();
+		if ($last_payment_method instanceof EE_Payment_Method) {
+			$payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
+			$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			return $payment;
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param EE_Payment        $payment_to_refund
+	 * @param array             $refund_info
+	 * @return EE_Payment
+	 * @throws \EE_Error
+	 */
+	public function process_refund(
+		EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		$refund_info = array()
+	) {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
+		}
+		return $payment_to_refund;
+	}
+
+
+
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether or not to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment         $payment
+	 * @param boolean            $update_txn
+	 *                        whether or not to call
+	 *                        EE_Transaction_Processor::
+	 *                        update_transaction_and_registrations_after_checkout_or_payment()
+	 *                        (you can save 1 DB query if you know you're going
+	 *                        to save it later instead)
+	 * @param bool               $IPN
+	 *                        if processing IPNs or other similar payment
+	 *                        related activities that occur in alternate
+	 *                        requests than the main one that is processing the
+	 *                        TXN, then set this to true to check whether the
+	 *                        TXN is locked before updating
+	 * @throws \EE_Error
+	 */
+	public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
+	{
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment && $payment->ID()) {
+				if (
+					$payment->payment_method() instanceof EE_Payment_Method
+					&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+				) {
+					$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+					// update TXN registrations with payment info
+					$this->process_registration_payments($transaction, $payment);
+				}
+				$do_action = $payment->just_approved()
+					? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+					: $do_action;
+			} else {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+			}
+			if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				// set new value for total paid
+				$transaction_payments->calculate_total_payments_and_update_status($transaction);
+				// call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
+				if ($update_txn) {
+					$this->_post_payment_processing($transaction, $payment, $IPN);
+				}
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			//global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
+
+
+
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws \EE_Error
+	 */
+	public function process_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		$registrations = array()
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		//EEM_Registration::instance()->show_next_x_db_queries();
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				array(
+					array(
+						// only these reg statuses can receive payments
+						'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
+						'REG_final_price'  => array('!=', 0),
+						'REG_final_price*' => array('!=', 'REG_paid', true),
+					),
+				)
+			);
+		}
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->process_registration_refund($registration, $payment, $available_payment_amount);
+				} else {
+					$available_payment_amount = $this->process_registration_payment($registration, $payment, $available_payment_amount);
+				}
+			}
+		}
+		if ($available_payment_amount > 0 && apply_filters('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', false)) {
+			EE_Error::add_attention(
+				sprintf(
+					__('A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_payment_amount
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function process_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_payment_amount = 0.00
+	) {
+		$owing = $registration->final_price() - $registration->paid();
+		if ($owing > 0) {
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount -= $payment_amount;
+			//calculate and set new REG_paid
+			$registration->set_paid($registration->paid() + $payment_amount);
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $payment_amount);
+		}
+		return $available_payment_amount;
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $payment_amount
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _apply_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$payment_amount = 0.00
+	) {
+		// find any existing reg payment records for this registration and payment
+		$existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
+			array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
+		);
+		// if existing registration payment exists
+		if ($existing_reg_payment instanceof EE_Registration_Payment) {
+			// then update that record
+			$existing_reg_payment->set_amount($payment_amount);
+			$existing_reg_payment->save();
+		} else {
+			// or add new relation between registration and payment and set amount
+			$registration->_add_relation_to($payment, 'Payment', array('RPY_amount' => $payment_amount));
+			// make it stick
+			$registration->save();
+		}
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function process_registration_refund(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_refund_amount = 0.00
+	) {
+		//EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
+		if ($registration->paid() > 0) {
+			// ensure $available_refund_amount is NOT negative
+			$available_refund_amount = (float)abs($available_refund_amount);
+			// don't allow refund amount to exceed the available payment amount, OR the amount paid
+			$refund_amount = min($available_refund_amount, (float)$registration->paid());
+			// update $available_payment_amount
+			$available_refund_amount -= $refund_amount;
+			//calculate and set new REG_paid
+			$registration->set_paid($registration->paid() - $refund_amount);
+			// convert payment amount back to a negative value for storage in the db
+			$refund_amount = (float)abs($refund_amount) * -1;
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $refund_amount);
+		}
+		return $available_refund_amount;
+	}
+
+
+
+	/**
+	 * Process payments and transaction after payment process completed.
+	 * ultimately this will send the TXN and payment details off so that notifications can be sent out.
+	 * if this request happens to be processing an IPN,
+	 * then we will also set the Payment Options Reg Step to completed,
+	 * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @throws \EE_Error
+	 */
+	protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// is the Payment Options Reg Step completed ?
+		$payment_options_step_completed = $transaction->reg_step_completed('payment_options');
+		// if the Payment Options Reg Step is completed...
+		$revisit = $payment_options_step_completed === true ? true : false;
+		// then this is kinda sorta a revisit with regards to payments at least
+		$transaction_processor->set_revisit($revisit);
+		// if this is an IPN, let's consider the Payment Options Reg Step completed if not already
+		if (
+			$IPN
+			&& $payment_options_step_completed !== true
+			&& ($payment->is_approved() || $payment->is_pending())
+		) {
+			$payment_options_step_completed = $transaction->set_reg_step_completed(
+				'payment_options'
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid(false);
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		//  if this is an IPN and the final step has not been initiated
+		if ($IPN && $payment_options_step_completed && $finalized === false) {
+			// and if it hasn't already been set as being started...
+			$finalized = $transaction->set_reg_step_initiated('finalize_registration');
+		}
+		$transaction->save();
+		// because the above will return false if the final step was not fully completed, we need to check again...
+		if ($IPN && $finalized !== false) {
+			// and if we are all good to go, then send out notifications
+			add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			//ok, now process the transaction according to the payment
+			$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($transaction, $payment);
+		}
+		// DEBUG LOG
+		$payment_method = $payment->payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payment_method_type_obj = $payment_method->type_obj();
+			if ($payment_method_type_obj instanceof EE_PMT_Base) {
+				$gateway = $payment_method_type_obj->get_gateway();
+				if ($gateway instanceof EE_Gateway) {
+					$gateway->log(
+						array(
+							'message'               => __('Post Payment Transaction Details', 'event_espresso'),
+							'transaction'           => $transaction->model_field_array(),
+							'finalized'             => $finalized,
+							'IPN'                   => $IPN,
+							'deliver_notifications' => has_filter(
+								'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+							),
+						),
+						$payment
+					);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect paypal standard, pro, express, and payflow.
+	 */
+	public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
+	{
+		if (strstr($url, 'https://') && strstr($url, '.paypal.com')) {
+			//Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			//instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 1);
+		}
+	}
 }

core/libraries/payment_methods/EEI_Payment_Method_Interfaces.php

Spacing +3 added lines, -3 removed lines

@@ -5,7 +5,7 @@ 
  *
  * allows gateways to be used by different systems other than Event Espresso
  */
-interface EEI_Payment extends EEI_Base{
+interface EEI_Payment extends EEI_Base {
 
 	/**
 	 * @return string indicating which the payment is approved, pending, cancelled or failed
@@ -153,7 +153,7 @@ 
 /**
  * Interface EEI_Payment_Method
  */
-interface EEI_Payment_Method{
+interface EEI_Payment_Method {
 
 }
 
@@ -172,7 +172,7 @@ 
 	 * @param string $model_name
 	 * @return EE_Log
 	 */
-	public function gateway_log($message,$id,$model_name);
+	public function gateway_log($message, $id, $model_name);
 }
 
 

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +98 added lines, -100 removed lines

@@ -44,77 +44,76 @@ 
 	 */
 	protected $_image_url;
 
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY'
-        );
-        parent::__construct();
-    }
-
-
-
-    /**
-	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY'
+		);
+		parent::__construct();
+	}
+
 
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
 	 *
 *@param array $settings_array
 	 */
 	public function set_settings( $settings_array ) {
 		parent::set_settings($settings_array);
 		// Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
 	}
 
 
 
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
 	public function set_redirection_info( $payment, $billing_info = array(), $return_url = NULL, $notify_url = NULL, $cancel_url = NULL ) {
 		if ( ! $payment instanceof EEI_Payment ) {
 			$payment->set_gateway_response( __( 'Error. No associated payment was found.', 'event_espresso' ) );
@@ -202,9 +201,9 @@ 
 				$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
 				// Item quantity.
 				$token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
-                // Digital item is sold.
-                $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
-                $item_num++;
+				// Digital item is sold.
+				$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
+				$item_num++;
 			}
 		} else {
 			// Just one Item.
@@ -272,7 +271,6 @@ 
 
 
 	/**
-
 	 *  @param array $update_info {
 	 *	  @type string $gateway_txn_id
 	 *	  @type string status an EEMI_Payment status
@@ -292,8 +290,8 @@ 
 				return $payment;
 			}
 			$primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
+			$payment_details = $payment->details();
+			// Check if we still have the token.
 			if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN']) ) {
 				$payment->set_status( $this->_pay_model->failed_status() );
 				return $payment;
@@ -402,36 +400,36 @@ 
 	 */
 	public function _ppExpress_check_response( $request_response ) {
 		if (empty($request_response['body']) || is_wp_error( $request_response ) ) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str( urldecode($request_response['body']), $response_args );
-        if ( ! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if (
-            $response_args['ACK'] === 'Success'
-            && (
-                isset($response_args['PAYERID'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-                || isset($response_args['TOKEN'])
-            )
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        } else {
-            $errors = $this->_get_errors($response_args);
-            return array('status' => false, 'args' => $errors);
-        }
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str( urldecode($request_response['body']), $response_args );
+		if ( ! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if (
+			$response_args['ACK'] === 'Success'
+			&& (
+				isset($response_args['PAYERID'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+				|| isset($response_args['TOKEN'])
+			)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		} else {
+			$errors = $this->_get_errors($response_args);
+			return array('status' => false, 'args' => $errors);
+		}
 	}
 
 
 	/**
-     *  Log a "Cleared" request.
-     *
-     * @param array $request
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array $request
 	 * @param EEI_Payment  $payment
 	 * @param string  		$info
 	 * @return void
@@ -454,17 +452,17 @@ 
 		$n = 0;
 		while ( isset($data_array["L_ERRORCODE{$n}"]) ) {
 			$l_error_code = isset($data_array["L_ERRORCODE{$n}"])
-                ? $data_array["L_ERRORCODE{$n}"]
-                : '';
+				? $data_array["L_ERRORCODE{$n}"]
+				: '';
 			$l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
-                ? $data_array["L_SEVERITYCODE{$n}"]
-                : '';
+				? $data_array["L_SEVERITYCODE{$n}"]
+				: '';
 			$l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
-                ? $data_array["L_SHORTMESSAGE{$n}"]
-                : '';
+				? $data_array["L_SHORTMESSAGE{$n}"]
+				: '';
 			$l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
-                ? $data_array["L_LONGMESSAGE{$n}"]
-                : '';
+				? $data_array["L_LONGMESSAGE{$n}"]
+				: '';
 
 			if ( $n === 0 ) {
 				$errors = array(

Spacing +97 added lines, -97 removed lines

@@ -1,4 +1,4 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' )) { exit('NO direct script access allowed'); }
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('NO direct script access allowed'); }
 
 /**
  * ----------------------------------------------
@@ -96,7 +96,7 @@ 
 	 *
 *@param array $settings_array
 	 */
-	public function set_settings( $settings_array ) {
+	public function set_settings($settings_array) {
 		parent::set_settings($settings_array);
 		// Redirect URL.
         $this->_base_gateway_url = $this->_debug_mode
@@ -115,19 +115,19 @@ 
      * @return \EE_Payment|\EEI_Payment
      * @throws \EE_Error
      */
-	public function set_redirection_info( $payment, $billing_info = array(), $return_url = NULL, $notify_url = NULL, $cancel_url = NULL ) {
-		if ( ! $payment instanceof EEI_Payment ) {
-			$payment->set_gateway_response( __( 'Error. No associated payment was found.', 'event_espresso' ) );
-			$payment->set_status( $this->_pay_model->failed_status() );
+	public function set_redirection_info($payment, $billing_info = array(), $return_url = NULL, $notify_url = NULL, $cancel_url = NULL) {
+		if ( ! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(__('Error. No associated payment was found.', 'event_espresso'));
+			$payment->set_status($this->_pay_model->failed_status());
 			return $payment;
 		}
 		$transaction = $payment->transaction();
-		if ( ! $transaction instanceof EEI_Transaction ) {
-			$payment->set_gateway_response( __( 'Could not process this payment because it has no associated transaction.', 'event_espresso' ) );
-			$payment->set_status( $this->_pay_model->failed_status() );
+		if ( ! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(__('Could not process this payment because it has no associated transaction.', 'event_espresso'));
+			$payment->set_status($this->_pay_model->failed_status());
 			return $payment;
 		}
-		$order_description = substr( $this->_format_order_description($payment), 0, 127 );
+		$order_description = substr($this->_format_order_description($payment), 0, 127);
 		$primary_registration = $transaction->primary_registration();
 		$primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() : false;
 		$locale = explode('-', get_bloginfo('language'));
@@ -141,37 +141,37 @@ 
 			'RETURNURL' => $return_url,
 			'CANCELURL' => $cancel_url,
 			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-			'SOLUTIONTYPE' => 'Sole',	// Buyer does not need to create a PayPal account to check out. This is referred to as PayPal Account Optional.
-			'BUTTONSOURCE' => 'EventEspresso_SP',//EE will blow up if you change this
+			'SOLUTIONTYPE' => 'Sole', // Buyer does not need to create a PayPal account to check out. This is referred to as PayPal Account Optional.
+			'BUTTONSOURCE' => 'EventEspresso_SP', //EE will blow up if you change this
 			'LOCALECODE' => $locale[1]	// Locale of the pages displayed by PayPal during Express Checkout.
 		);
 
 		// Show itemized list.
-		if ( $this->_money->compare_floats( $payment->amount(), $transaction->total(), '==' ) ) {
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
 			$item_num = 0;
 			$itemized_sum = 0;
 			$total_line_items = $transaction->total_line_item();
 			// Go through each item in the list.
-			foreach ( $total_line_items->get_items() as $line_item ) {
-				if ( $line_item instanceof EE_Line_Item ) {
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
 					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
-					if ( EEH_Money::compare_floats( $line_item->total(), '0.00', '==' ) ) {
+					if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
 						continue;
 					}
 
 					$unit_price = $line_item->unit_price();
 					$line_item_quantity = $line_item->quantity();
 					// This is a discount.
-					if ( $line_item->is_percent() ) {
+					if ($line_item->is_percent()) {
 						$unit_price = $line_item->total();
 						$line_item_quantity = 1;
 					}
 					// Item Name.
-					$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr($this->_format_line_item_name( $line_item, $payment), 0, 127);
+					$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr($this->_format_line_item_name($line_item, $payment), 0, 127);
 					// Item description.
-					$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr($this->_format_line_item_desc( $line_item, $payment), 0, 127);
+					$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr($this->_format_line_item_desc($line_item, $payment), 0, 127);
 					// Cost of individual item.
-					$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency( $unit_price );
+					$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency($unit_price);
 					// Item Number.
 					$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
 					// Item quantity.
@@ -188,16 +188,16 @@ 
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
 			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
 
-			$itemized_sum_diff_from_txn_total = round( $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(), 2 );
+			$itemized_sum_diff_from_txn_total = round($transaction->total() - $itemized_sum - $total_line_items->get_total_tax(), 2);
 			// If we were not able to recognize some item like promotion, surcharge or cancellation,
 			// add the difference as an extra line item.
-			if ( $this->_money->compare_floats( $itemized_sum_diff_from_txn_total, 0, '!=' ) ) {
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
 				// Item Name.
-				$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr( __( 'Other (promotion/surcharge/cancellation)', 'event_espresso' ), 0, 127 );
+				$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr(__('Other (promotion/surcharge/cancellation)', 'event_espresso'), 0, 127);
 				// Item description.
 				$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
 				// Cost of individual item.
-				$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency( $itemized_sum_diff_from_txn_total );
+				$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency($itemized_sum_diff_from_txn_total);
 				// Item Number.
 				$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
 				// Item quantity.
@@ -209,11 +209,11 @@ 
 		} else {
 			// Just one Item.
 			// Item Name.
-			$token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = substr( $this->_format_partial_payment_line_item_name($payment), 0, 127 );
+			$token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = substr($this->_format_partial_payment_line_item_name($payment), 0, 127);
 			// Item description.
-			$token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = substr( $this->_format_partial_payment_line_item_desc($payment), 0, 127 );
+			$token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = substr($this->_format_partial_payment_line_item_desc($payment), 0, 127);
 			// Cost of individual item.
-			$token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency( $payment->amount() );
+			$token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency($payment->amount());
 			// Item Number.
 			$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
 			// Item quantity.
@@ -221,14 +221,14 @@ 
 			// Digital item is sold.
 			$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
 			// Item's sales S/H and tax amount.
-			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency( $payment->amount() );
+			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency($payment->amount());
 			$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = '0';
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
 			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
 		}
 		// Automatically filling out shipping and contact information.
-		if ( $this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee ) {
-			$token_request_dtls['NOSHIPPING'] = '2';	//  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			$token_request_dtls['NOSHIPPING'] = '2'; //  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
@@ -237,34 +237,34 @@ 
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
 			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-		} elseif ( ! $this->_request_shipping_addr ) {
+		} elseif ( ! $this->_request_shipping_addr) {
 			// Do not request shipping details on the PP Checkout page.
 			$token_request_dtls['NOSHIPPING'] = '1';
 			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
 
 		}
 		// Used a business/personal logo on the PayPal page.
-		if ( ! empty($this->_image_url) ) {
+		if ( ! empty($this->_image_url)) {
 			$token_request_dtls['LOGOIMG'] = $this->_image_url;
 		}
 		// Request PayPal token.
-		$token_request_response = $this->_ppExpress_request( $token_request_dtls, 'Payment Token', $payment );
-		$token_rstatus = $this->_ppExpress_check_response( $token_request_response );
-		$response_args = ( isset($token_rstatus['args']) && is_array($token_rstatus['args']) ) ? $token_rstatus['args'] : array();
-		if ( $token_rstatus['status'] ) {
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args'])) ? $token_rstatus['args'] : array();
+		if ($token_rstatus['status']) {
 			// We got the Token so we may continue with the payment and redirect the client.
-			$payment->set_details( $response_args );
+			$payment->set_details($response_args);
 
 			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-			$payment->set_redirect_url( $gateway_url . '/checkoutnow?useraction=commit&cmd=_express-checkout&token=' . $response_args['TOKEN'] );
+			$payment->set_redirect_url($gateway_url.'/checkoutnow?useraction=commit&cmd=_express-checkout&token='.$response_args['TOKEN']);
 		} else {
-			if ( isset($response_args['L_ERRORCODE']) ) {
-				$payment->set_gateway_response( $response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE'] );
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
 			} else {
-				$payment->set_gateway_response( __( 'Error occurred while trying to setup the Express Checkout.', 'event_espresso' ) );
+				$payment->set_gateway_response(__('Error occurred while trying to setup the Express Checkout.', 'event_espresso'));
 			}
-			$payment->set_details( $response_args );
-			$payment->set_status( $this->_pay_model->failed_status() );
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
 		}
 
 		return $payment;
@@ -280,22 +280,22 @@ 
 	 *  @param EEI_Transaction $transaction
 	 *  @return EEI_Payment
 	 */
-	public function handle_payment_update( $update_info, $transaction ) {
+	public function handle_payment_update($update_info, $transaction) {
 		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
 
-		if ( $payment instanceof EEI_Payment ) {
-			$this->log( array( 'Return from Authorization' => $update_info ), $payment );
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
 			$transaction = $payment->transaction();
-			if ( ! $transaction instanceof EEI_Transaction ) {
-				$payment->set_gateway_response( __( 'Could not process this payment because it has no associated transaction.', 'event_espresso' ) );
-				$payment->set_status( $this->_pay_model->failed_status() );
+			if ( ! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(__('Could not process this payment because it has no associated transaction.', 'event_espresso'));
+				$payment->set_status($this->_pay_model->failed_status());
 				return $payment;
 			}
 			$primary_registrant = $transaction->primary_registration();
             $payment_details = $payment->details();
             // Check if we still have the token.
-			if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN']) ) {
-				$payment->set_status( $this->_pay_model->failed_status() );
+			if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
 				return $payment;
 			}
 
@@ -304,10 +304,10 @@ 
 				'TOKEN' => $payment_details['TOKEN']
 			);
 			// Request Customer Details.
-			$cdetails_request_response = $this->_ppExpress_request( $cdetails_request_dtls, 'Customer Details', $payment );
-			$cdetails_rstatus = $this->_ppExpress_check_response( $cdetails_request_response );
-			$cdata_response_args = ( isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']) ) ? $cdetails_rstatus['args'] : array();
-			if ( $cdetails_rstatus['status'] ) {
+			$cdetails_request_response = $this->_ppExpress_request($cdetails_request_dtls, 'Customer Details', $payment);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args'])) ? $cdetails_rstatus['args'] : array();
+			if ($cdetails_rstatus['status']) {
 				// We got the PayerID so now we can Complete the transaction.
 				$docheckout_request_dtls = array(
 					'METHOD' => 'DoExpressCheckoutPayment',
@@ -318,39 +318,39 @@ 
 					'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code()
 				);
 				// Payment Checkout/Capture.
-				$docheckout_request_response = $this->_ppExpress_request( $docheckout_request_dtls, 'Do Payment', $payment );
-				$docheckout_rstatus = $this->_ppExpress_check_response( $docheckout_request_response );
-				$docheckout_response_args = ( isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']) ) ? $docheckout_rstatus['args'] : array();
-				if ( $docheckout_rstatus['status'] ) {
+				$docheckout_request_response = $this->_ppExpress_request($docheckout_request_dtls, 'Do Payment', $payment);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args'])) ? $docheckout_rstatus['args'] : array();
+				if ($docheckout_rstatus['status']) {
 					// All is well, payment approved.
 					$primary_registration_code = $primary_registrant instanceof EE_Registration ? $primary_registrant->reg_code() : '';
-					$payment->set_extra_accntng( $primary_registration_code );
-					$payment->set_amount( isset($docheckout_response_args['PAYMENTINFO_0_AMT']) ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT'] : 0 );
-					$payment->set_txn_id_chq_nmbr( isset( $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] ) ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] : null );
-					$payment->set_details( $cdata_response_args );
-					$payment->set_gateway_response( isset( $docheckout_response_args['PAYMENTINFO_0_ACK'] ) ? $docheckout_response_args['PAYMENTINFO_0_ACK'] : '' );
-					$payment->set_status( $this->_pay_model->approved_status() );
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT']) ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT'] : 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']) ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] : null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK']) ? $docheckout_response_args['PAYMENTINFO_0_ACK'] : '');
+					$payment->set_status($this->_pay_model->approved_status());
 				} else {
-					if ( isset($docheckout_response_args['L_ERRORCODE']) ) {
-						$payment->set_gateway_response( $docheckout_response_args['L_ERRORCODE'] . '; ' . $docheckout_response_args['L_SHORTMESSAGE'] );
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response($docheckout_response_args['L_ERRORCODE'].'; '.$docheckout_response_args['L_SHORTMESSAGE']);
 					} else {
-						$payment->set_gateway_response( __( 'Error occurred while trying to Capture the funds.', 'event_espresso' ) );
+						$payment->set_gateway_response(__('Error occurred while trying to Capture the funds.', 'event_espresso'));
 					}
-					$payment->set_details( $docheckout_response_args );
-					$payment->set_status( $this->_pay_model->declined_status() );
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
 				}
 			} else {
-				if ( isset($cdata_response_args['L_ERRORCODE']) ) {
-					$payment->set_gateway_response( $cdata_response_args['L_ERRORCODE'] . '; ' . $cdata_response_args['L_SHORTMESSAGE'] );
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response($cdata_response_args['L_ERRORCODE'].'; '.$cdata_response_args['L_SHORTMESSAGE']);
 				} else {
-					$payment->set_gateway_response( __( 'Error occurred while trying to get payment Details from PayPal.', 'event_espresso' ) );
+					$payment->set_gateway_response(__('Error occurred while trying to get payment Details from PayPal.', 'event_espresso'));
 				}
-				$payment->set_details( $cdata_response_args );
-				$payment->set_status( $this->_pay_model->failed_status() );
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
 			}
 		} else {
-			$payment->set_gateway_response( __( 'Error occurred while trying to process the payment.', 'event_espresso' ) );
-			$payment->set_status( $this->_pay_model->failed_status() );
+			$payment->set_gateway_response(__('Error occurred while trying to process the payment.', 'event_espresso'));
+			$payment->set_status($this->_pay_model->failed_status());
 		}
 
 		return $payment;
@@ -365,16 +365,16 @@ 
 	 *  @param EEI_Payment  $payment
 	 *	@return mixed
 	 */
-	public function _ppExpress_request( $request_params, $request_text, $payment ) {
+	public function _ppExpress_request($request_params, $request_text, $payment) {
 		$request_dtls = array(
 			'VERSION' => '204.0',
-			'USER' => urlencode( $this->_api_username ),
-			'PWD' => urlencode( $this->_api_password ),
-			'SIGNATURE' => urlencode( $this->_api_signature )
+			'USER' => urlencode($this->_api_username),
+			'PWD' => urlencode($this->_api_password),
+			'SIGNATURE' => urlencode($this->_api_signature)
 		);
-		$dtls = array_merge( $request_dtls, $request_params );
+		$dtls = array_merge($request_dtls, $request_params);
 
-		$this->_log_clean_request( $dtls, $payment, $request_text . ' Request' );
+		$this->_log_clean_request($dtls, $payment, $request_text.' Request');
 		// Request Customer Details.
 		$request_response = wp_remote_post(
 			$this->_base_gateway_url,
@@ -384,11 +384,11 @@ 
 				'httpversion' => '1.1',
 				'cookies' => array(),
 				'headers' => array(),
-				'body' => http_build_query( $dtls )
+				'body' => http_build_query($dtls)
 			)
 		);
 		// Log the response.
-		$this->log( array( $request_text . ' Response' => $request_response), $payment );
+		$this->log(array($request_text.' Response' => $request_response), $payment);
 
 		return $request_response;
 	}
@@ -400,13 +400,13 @@ 
 	 *	@param mixed        $request_response
 	 *	@return array
 	 */
-	public function _ppExpress_check_response( $request_response ) {
-		if (empty($request_response['body']) || is_wp_error( $request_response ) ) {
+	public function _ppExpress_check_response($request_response) {
+		if (empty($request_response['body']) || is_wp_error($request_response)) {
             // If we got here then there was an error in this request.
             return array('status' => false, 'args' => $request_response);
         }
         $response_args = array();
-        parse_str( urldecode($request_response['body']), $response_args );
+        parse_str(urldecode($request_response['body']), $response_args);
         if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
@@ -436,10 +436,10 @@ 
 	 * @param string  		$info
 	 * @return void
 	 */
-	private function _log_clean_request($request, $payment, $info ) {
+	private function _log_clean_request($request, $payment, $info) {
 		$cleaned_request_data = $request;
 		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-		$this->log( array($info => $cleaned_request_data), $payment );
+		$this->log(array($info => $cleaned_request_data), $payment);
 	}
 
 
@@ -449,10 +449,10 @@ 
 	 *  @param array	$data_array
 	 *  @return array
 	 */
-	private function _get_errors( $data_array ) {
+	private function _get_errors($data_array) {
 		$errors = array();
 		$n = 0;
-		while ( isset($data_array["L_ERRORCODE{$n}"]) ) {
+		while (isset($data_array["L_ERRORCODE{$n}"])) {
 			$l_error_code = isset($data_array["L_ERRORCODE{$n}"])
                 ? $data_array["L_ERRORCODE{$n}"]
                 : '';
@@ -466,7 +466,7 @@ 
                 ? $data_array["L_LONGMESSAGE{$n}"]
                 : '';
 
-			if ( $n === 0 ) {
+			if ($n === 0) {
 				$errors = array(
 					'L_ERRORCODE' => $l_error_code,
 					'L_SHORTMESSAGE' => $l_short_message,
@@ -474,10 +474,10 @@ 
 					'L_SEVERITYCODE' => $l_severity_code
 				);
 			} else {
-				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+				$errors['L_ERRORCODE'] .= ', '.$l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', '.$l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
 			}
 
 			$n++;

core/services/database/TableManager.php

Indentation +207 added lines, -209 removed lines

@@ -17,216 +17,214 @@
 class TableManager extends \EE_Base
 {
 
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    private $table_analysis;
-
-
-
-    /**
-     * TableManager constructor.
-     *
-     * @param TableAnalysis $TableAnalysis
-     */
-    public function __construct(TableAnalysis $TableAnalysis)
-    {
-        $this->table_analysis = $TableAnalysis;
-    }
-
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function getTableAnalysis()
-    {
-        if ($this->table_analysis instanceof TableAnalysis) {
-            return $this->table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
-     * @param string $column_name
-     * @param string $column_info
-     * @return bool|false|int
-     */
-    public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
-    {
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $columns = $this->getTableColumns($table_name);
-        if ( ! in_array($column_name, $columns)) {
-            $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
-            return $wpdb->query($alter_query);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Gets the name of all columns on the  table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return array
-     */
-    public function getTableColumns($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $field_array = array();
-        if ( ! empty($table_name)) {
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
-            if ($columns !== false) {
-                foreach ($columns as $column) {
-                    $field_array[] = $column->Field;
-                }
-            }
-        }
-        return $field_array;
-    }
-
-
-
-    /**
-     * Drops the specified table from the database. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return int
-     */
-    public function dropTable($table_name)
-    {
-        global $wpdb;
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
-        }
-        return 0;
-    }
-
-
-
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public function dropTables($table_names)
-    {
-        $tables_to_delete = array();
-        foreach ($table_names as $table_name) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[] = $table_name;
-            }
-        }
-        if( ! empty( $tables_to_delete ) ) {
-            global $wpdb;
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
-        }
-        return $tables_to_delete;
-    }
-
-
-
-    /**
-     * Drops the specified index from the specified table. $table_name can
-     * optionally start with $wpdb->prefix or not
-
-     *
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	private $table_analysis;
+
+
+
+	/**
+	 * TableManager constructor.
+	 *
+	 * @param TableAnalysis $TableAnalysis
+	 */
+	public function __construct(TableAnalysis $TableAnalysis)
+	{
+		$this->table_analysis = $TableAnalysis;
+	}
+
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function getTableAnalysis()
+	{
+		if ($this->table_analysis instanceof TableAnalysis) {
+			return $this->table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
+	 * @param string $column_name
+	 * @param string $column_info
+	 * @return bool|false|int
+	 */
+	public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
+	{
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$columns = $this->getTableColumns($table_name);
+		if ( ! in_array($column_name, $columns)) {
+			$alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
+			return $wpdb->query($alter_query);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Gets the name of all columns on the  table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return array
+	 */
+	public function getTableColumns($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$field_array = array();
+		if ( ! empty($table_name)) {
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
+			if ($columns !== false) {
+				foreach ($columns as $column) {
+					$field_array[] = $column->Field;
+				}
+			}
+		}
+		return $field_array;
+	}
+
+
+
+	/**
+	 * Drops the specified table from the database. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return int
+	 */
+	public function dropTable($table_name)
+	{
+		global $wpdb;
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
+		}
+		return 0;
+	}
+
+
+
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public function dropTables($table_names)
+	{
+		$tables_to_delete = array();
+		foreach ($table_names as $table_name) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
+				$tables_to_delete[] = $table_name;
+			}
+		}
+		if( ! empty( $tables_to_delete ) ) {
+			global $wpdb;
+			$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+		}
+		return $tables_to_delete;
+	}
+
+
+
+	/**
+	 * Drops the specified index from the specified table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
 *@global \wpdb       $wpdb
-     * @param string $table_name
-     * @param string $index_name
-     * @return int
-     */
-    public function dropIndex($table_name, $index_name)
-    {
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
-        if (
-            $this->getTableAnalysis()->tableExists($table_name)
-            && $wpdb->get_var($index_exists_query)
-               === $table_name //using get_var with the $index_exists_query returns the table's name
-        ) {
-            return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
-        }
-        return 0;
-    }
-
-
-
-    /**
-     * Just creates the requested table. $table_name can
-     * optionally start with $wpdb->prefix or not
-
-     *
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return int
+	 */
+	public function dropIndex($table_name, $index_name)
+	{
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
+		if (
+			$this->getTableAnalysis()->tableExists($table_name)
+			&& $wpdb->get_var($index_exists_query)
+			   === $table_name //using get_var with the $index_exists_query returns the table's name
+		) {
+			return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
+		}
+		return 0;
+	}
+
+
+
+	/**
+	 * Just creates the requested table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
 *@param string       $table_name
-     * @param string $create_sql defining the table's columns and indexes
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function createTable($table_name, $create_sql, $engine = 'MyISAM')
-    {
-        // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
-        if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            /** @var \wpdb $wpdb */
-            global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
-
-            //get $wpdb to echo errors, but buffer them. This way at least WE know an error
-            //happened. And then we can choose to tell the end user
-            $old_show_errors_policy = $wpdb->show_errors(true);
-            $old_error_suppression_policy = $wpdb->suppress_errors(false);
-            ob_start();
-            dbDelta($SQL);
-            $output = ob_get_contents();
-            ob_end_clean();
-            $wpdb->show_errors($old_show_errors_policy);
-            $wpdb->suppress_errors($old_error_suppression_policy);
-            if ( ! empty($output)) {
-                throw new \EE_Error($output);
-            }
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
-                        'event_espresso'),
-                    '<br />',
-                    $create_sql
-                )
-            );
-        }
-    }
+	 * @param string $create_sql defining the table's columns and indexes
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function createTable($table_name, $create_sql, $engine = 'MyISAM')
+	{
+		// does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
+		if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			/** @var \wpdb $wpdb */
+			global $wpdb;
+			$SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+
+			//get $wpdb to echo errors, but buffer them. This way at least WE know an error
+			//happened. And then we can choose to tell the end user
+			$old_show_errors_policy = $wpdb->show_errors(true);
+			$old_error_suppression_policy = $wpdb->suppress_errors(false);
+			ob_start();
+			dbDelta($SQL);
+			$output = ob_get_contents();
+			ob_end_clean();
+			$wpdb->show_errors($old_show_errors_policy);
+			$wpdb->suppress_errors($old_error_suppression_policy);
+			if ( ! empty($output)) {
+				throw new \EE_Error($output);
+			}
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
+						'event_espresso'),
+					'<br />',
+					$create_sql
+				)
+			);
+		}
+	}
 
 }

Spacing +3 added lines, -3 removed lines

@@ -145,9 +145,9 @@ 
                 $tables_to_delete[] = $table_name;
             }
         }
-        if( ! empty( $tables_to_delete ) ) {
+        if ( ! empty($tables_to_delete)) {
             global $wpdb;
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+            $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete));
         }
         return $tables_to_delete;
     }
@@ -202,7 +202,7 @@ 
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             /** @var \wpdb $wpdb */
             global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} ".$wpdb->get_charset_collate();
 
             //get $wpdb to echo errors, but buffer them. This way at least WE know an error
             //happened. And then we can choose to tell the end user

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

Indentation +79 added lines, -79 removed lines

@@ -1,16 +1,16 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
  /**
- *
- * Class EE_SPCO_Reg_Step_Attendee_Information
- *
- * Description
- *
- * @package 			Event Espresso
- * @subpackage 	core
- * @author 				Brent Christensen
- * @since 				4.5.0
- *
- */
+  *
+  * Class EE_SPCO_Reg_Step_Attendee_Information
+  *
+  * Description
+  *
+  * @package 			Event Espresso
+  * @subpackage 	core
+  * @author 				Brent Christensen
+  * @since 				4.5.0
+  *
+  */
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step {
 
 	/**
@@ -135,33 +135,33 @@ 
 					$registration instanceof EE_Registration
 					&& $this->checkout->visit_allows_processing_of_this_registration( $registration )
 				) {
-                    $attendee_reg_form = $this->_registrations_reg_form($registration);
-                    if ($attendee_reg_form instanceof EE_Form_Section_Proper) {
-                        $subsections[$registration->reg_url_link()] = $attendee_reg_form;
-                        if ( ! $this->checkout->admin_request) {
-                            $template_args['registrations'][$registration->reg_url_link()] = $registration;
-                            $template_args['ticket_count'][$registration->ticket()->ID()] = isset(
-                                $template_args['ticket_count'][$registration->ticket()->ID()]
-                            )
-                                ? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
-                                : 1;
-                            $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                                $this->checkout->cart->get_grand_total(),
-                                'Ticket',
-                                array($registration->ticket()->ID())
-                            );
-                            $ticket_line_item = is_array($ticket_line_item)
-                                ? reset($ticket_line_item)
-                                : $ticket_line_item;
-                            $template_args['ticket_line_item'][$registration->ticket()
-                                                                            ->ID()] = $Line_Item_Display->display_line_item(
-                                $ticket_line_item
-                            );
-                        }
-                    }
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $registration->reg_url_link();
-                    }
+					$attendee_reg_form = $this->_registrations_reg_form($registration);
+					if ($attendee_reg_form instanceof EE_Form_Section_Proper) {
+						$subsections[$registration->reg_url_link()] = $attendee_reg_form;
+						if ( ! $this->checkout->admin_request) {
+							$template_args['registrations'][$registration->reg_url_link()] = $registration;
+							$template_args['ticket_count'][$registration->ticket()->ID()] = isset(
+								$template_args['ticket_count'][$registration->ticket()->ID()]
+							)
+								? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
+								: 1;
+							$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+								$this->checkout->cart->get_grand_total(),
+								'Ticket',
+								array($registration->ticket()->ID())
+							);
+							$ticket_line_item = is_array($ticket_line_item)
+								? reset($ticket_line_item)
+								: $ticket_line_item;
+							$template_args['ticket_line_item'][$registration->ticket()
+																			->ID()] = $Line_Item_Display->display_line_item(
+								$ticket_line_item
+							);
+						}
+					}
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $registration->reg_url_link();
+					}
 				}
 			}
 			// print_copy_info ?
@@ -173,7 +173,7 @@ 
 				// generate hidden input
 				if (
 					isset( $subsections[ $primary_registrant ] )
-				     && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+					 && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
 				) {
 					$subsections[ $primary_registrant ]->add_subsections( $copy_options, 'primary_registrant', false );
 				}
@@ -208,35 +208,35 @@ 
 	 */
 	private function _registrations_reg_form( EE_Registration $registration ) {
 		static $attendee_nmbr = 1;
-        $form_args = array();
+		$form_args = array();
 		// verify that registration has valid event
 		if ( $registration->event() instanceof EE_Event ) {
 			$question_groups = $registration->event()->question_groups(
-                array(
-                    array(
-                        'Event.EVT_ID'                     => $registration->event()->ID(),
-                        'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false
-                    ),
-                    'order_by' => array('QSG_order' => 'ASC')
-                )
-            );
+				array(
+					array(
+						'Event.EVT_ID'                     => $registration->event()->ID(),
+						'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false
+					),
+					'order_by' => array('QSG_order' => 'ASC')
+				)
+			);
 			if ( $question_groups ) {
-                // array of params to pass to parent constructor
-                $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => array(),
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        array(
-                            'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
-                            'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr)
-                        )
-                    )
-                );
-                foreach ( $question_groups as $question_group ) {
+				// array of params to pass to parent constructor
+				$form_args = array(
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => array(),
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						array(
+							'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
+							'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr)
+						)
+					)
+				);
+				foreach ( $question_groups as $question_group ) {
 					if ( $question_group instanceof EE_Question_Group ) {
 						$form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
 							$registration,
@@ -244,19 +244,19 @@ 
 						);
 					}
 				}
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
-                    $registration
-                );
-                // if we have question groups for additional attendees, then display the copy options
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
+					$registration
+				);
+				// if we have question groups for additional attendees, then display the copy options
 				$this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs($registration);
-                }
-            }
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs($registration);
+				}
+			}
 		}
-        $attendee_nmbr++;
+		$attendee_nmbr++;
 		return ! empty($form_args) ? new EE_Form_Section_Proper( $form_args ) : null;
 	}
 
@@ -889,7 +889,7 @@ 
 					if ( isset( $valid_data[ $reg_url_link ] ) ) {
 						// do we need to copy basic info from primary attendee ?
 						$copy_primary = isset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] )
-						                && absint( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] ) === 0
+										&& absint( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] ) === 0
 							? true
 							: false;
 						// filter form input data for this registration
@@ -1064,7 +1064,7 @@ 
 			? $form_input
 			: $form_input . '-' . $registration->reg_url_link();
 		$answer_is_obj = isset( $this->_registration_answers[ $answer_cache_id ] )
-		                 && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
+						 && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
 			? true
 			: false;
 		//rename form_inputs if they are EE_Attendee properties
@@ -1184,7 +1184,7 @@ 
 		// then attempt to copy them from the primary attendee
 		if (
 			$this->checkout->primary_attendee_obj instanceof EE_Attendee
-            && ! isset( $attendee_data['ATT_fname'], $attendee_data['ATT_email'] )
+			&& ! isset( $attendee_data['ATT_fname'], $attendee_data['ATT_email'] )
 		) {
 			return $this->checkout->primary_attendee_obj;
 		}
@@ -1302,7 +1302,7 @@ 
 		}
 		foreach ( $critical_attendee_details as $critical_attendee_detail ) {
 			if ( ! isset( $attendee_data[ $critical_attendee_detail ] )
-			     || empty( $attendee_data[ $critical_attendee_detail ] )
+				 || empty( $attendee_data[ $critical_attendee_detail ] )
 			) {
 				$attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
 					$critical_attendee_detail

Spacing +211 added lines, -212 removed lines

@@ -41,21 +41,21 @@ 
 	 * @access    public
 	 * @param    EE_Checkout $checkout
 	 */
-	public function __construct( EE_Checkout $checkout ) {
+	public function __construct(EE_Checkout $checkout) {
 		$this->_slug = 'attendee_information';
 		$this->_name = __('Attendee Information', 'event_espresso');
-		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+		$this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'attendee_info_main.template.php';
 		$this->checkout = $checkout;
 		$this->_reset_success_message();
 		$this->set_instructions(
-			__( 'Please answer the following registration questions before proceeding.', 'event_espresso' )
+			__('Please answer the following registration questions before proceeding.', 'event_espresso')
 		);
 	}
 
 
 
 	public function translate_js_strings() {
-		EE_Registry::$i18n_js_strings['required_field'] = __( ' is a required question.', 'event_espresso' );
+		EE_Registry::$i18n_js_strings['required_field'] = __(' is a required question.', 'event_espresso');
 		EE_Registry::$i18n_js_strings['required_multi_field'] = __(
 			' is a required question. Please enter a value for at least one of the options.',
 			'event_espresso'
@@ -115,7 +115,7 @@ 
 		// calculate taxes
 		$Line_Item_Display->display_line_item(
 			$this->checkout->cart->get_grand_total(),
-			array( 'set_tax_rate' => true )
+			array('set_tax_rate' => true)
 		);
 		/** @var $subsections EE_Form_Section_Proper[] */
 		$subsections = array(
@@ -127,13 +127,13 @@ 
 			'ticket_count' 	=> array()
 		);
 		// grab the saved registrations from the transaction
-		$registrations = $this->checkout->transaction->registrations( $this->checkout->reg_cache_where_params );
-		if ( $registrations ) {
-			foreach ( $registrations as $registration ) {
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
 				// can this registration be processed during this visit ?
 				if (
 					$registration instanceof EE_Registration
-					&& $this->checkout->visit_allows_processing_of_this_registration( $registration )
+					&& $this->checkout->visit_allows_processing_of_this_registration($registration)
 				) {
                     $attendee_reg_form = $this->_registrations_reg_form($registration);
                     if ($attendee_reg_form instanceof EE_Form_Section_Proper) {
@@ -165,17 +165,17 @@ 
 				}
 			}
 			// print_copy_info ?
-			if ( $primary_registrant && ! $this->checkout->admin_request && count( $registrations ) > 1 ) {
+			if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
 				// TODO: add admin option for toggling copy attendee info, then use that value to change $this->_print_copy_info
 				$copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
 					? $this->_copy_attendee_info_form()
 					: $this->_auto_copy_attendee_info();
 				// generate hidden input
 				if (
-					isset( $subsections[ $primary_registrant ] )
-				     && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+					isset($subsections[$primary_registrant])
+				     && $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
 				) {
-					$subsections[ $primary_registrant ]->add_subsections( $copy_options, 'primary_registrant', false );
+					$subsections[$primary_registrant]->add_subsections($copy_options, 'primary_registrant', false);
 				}
 			}
 
@@ -187,8 +187,7 @@ 
 				'html_id' 					=> $this->reg_form_name(),
 				'subsections' 			=> $subsections,
 				'layout_strategy'		=> $this->checkout->admin_request ?
-					new EE_Div_Per_Section_Layout() :
-					new EE_Template_Layout(
+					new EE_Div_Per_Section_Layout() : new EE_Template_Layout(
 						array(
 							'layout_template_file' 	=> $this->_template, // layout_template
 							'template_args' 				=> $template_args
@@ -206,11 +205,11 @@ 
 	 * @return EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _registrations_reg_form( EE_Registration $registration ) {
+	private function _registrations_reg_form(EE_Registration $registration) {
 		static $attendee_nmbr = 1;
         $form_args = array();
 		// verify that registration has valid event
-		if ( $registration->event() instanceof EE_Event ) {
+		if ($registration->event() instanceof EE_Event) {
 			$question_groups = $registration->event()->question_groups(
                 array(
                     array(
@@ -220,10 +219,10 @@ 
                     'order_by' => array('QSG_order' => 'ASC')
                 )
             );
-			if ( $question_groups ) {
+			if ($question_groups) {
                 // array of params to pass to parent constructor
                 $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+                    'html_id'         => 'ee-registration-'.$registration->reg_url_link(),
                     'html_class'      => 'ee-reg-form-attendee-dv',
                     'html_style'      => $this->checkout->admin_request
                         ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
@@ -236,9 +235,9 @@ 
                         )
                     )
                 );
-                foreach ( $question_groups as $question_group ) {
-					if ( $question_group instanceof EE_Question_Group ) {
-						$form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
+                foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$form_args['subsections'][$question_group->identifier()] = $this->_question_group_reg_form(
 							$registration,
 							$question_group
 						);
@@ -257,7 +256,7 @@ 
             }
 		}
         $attendee_nmbr++;
-		return ! empty($form_args) ? new EE_Form_Section_Proper( $form_args ) : null;
+		return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : null;
 	}
 
 
@@ -278,7 +277,7 @@ 
 		// generate hidden input
 		return new EE_Hidden_Input(
 			array(
-				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'html_id' => 'additional-attendee-reg-info-'.$registration->reg_url_link(),
 				'default' => $additional_attendee_reg_info
 			)
 		);
@@ -292,26 +291,26 @@ 
 	 * @return EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _question_group_reg_form( EE_Registration $registration, EE_Question_Group $question_group ){
+	private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group) {
 		// array of params to pass to parent constructor
 		$form_args = array(
-			'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
+			'html_id'         => 'ee-reg-form-qstn-grp-'.$question_group->identifier(),
 			'html_class'      => $this->checkout->admin_request
 				? 'form-table ee-reg-form-qstn-grp-dv'
 				: 'ee-reg-form-qstn-grp-dv',
-			'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-lbl',
+			'html_label_id'   => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-lbl',
 			'subsections'     => array(
-				'reg_form_qstn_grp_hdr' => $this->_question_group_header( $question_group )
+				'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group)
 			),
 			'layout_strategy' => $this->checkout->admin_request
 				? new EE_Admin_Two_Column_Layout()
 				: new EE_Div_Per_Section_Layout()
 		);
 		// where params
-		$query_params = array( 'QST_deleted' => 0 );
+		$query_params = array('QST_deleted' => 0);
 		// don't load admin only questions on the frontend
-		if ( ! $this->checkout->admin_request ) {
-			$query_params['QST_admin_only'] = array( '!=', true );
+		if ( ! $this->checkout->admin_request) {
+			$query_params['QST_admin_only'] = array('!=', true);
 		}
 		$questions = $question_group->get_many_related(
 			'Question',
@@ -333,10 +332,10 @@ 
 			)
 		);
 		// loop thru questions
-		foreach ( $questions as $question ) {
-			if( $question instanceof EE_Question ){
+		foreach ($questions as $question) {
+			if ($question instanceof EE_Question) {
 				$identifier = $question->is_system_question() ? $question->system_ID() : $question->ID();
-				$form_args['subsections'][ $identifier ] = $this->reg_form_question( $registration, $question );
+				$form_args['subsections'][$identifier] = $this->reg_form_question($registration, $question);
 			}
 		}
 		$form_args['subsections'] = apply_filters(
@@ -357,7 +356,7 @@ 
 			)
 		);
 //		d( $form_args );
-		$question_group_reg_form = new EE_Form_Section_Proper( $form_args );
+		$question_group_reg_form = new EE_Form_Section_Proper($form_args);
 		return apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
 			$question_group_reg_form,
@@ -374,11 +373,11 @@ 
 	 * @param EE_Question_Group $question_group
 	 * @return 	EE_Form_Section_HTML
 	 */
-	private function _question_group_header( EE_Question_Group $question_group ){
+	private function _question_group_header(EE_Question_Group $question_group) {
 		$html = '';
 		// group_name
-		if ( $question_group->show_group_name() && $question_group->name() !== '' ) {
-			if ( $this->checkout->admin_request ) {
+		if ($question_group->show_group_name() && $question_group->name() !== '') {
+			if ($this->checkout->admin_request) {
 				$html .= EEH_HTML::br();
 				$html .= EEH_HTML::h3(
 					$question_group->name(),
@@ -392,7 +391,7 @@ 
 			}
 		}
 		// group_desc
-		if ( $question_group->show_group_desc() && $question_group->desc() !== '' ) {
+		if ($question_group->show_group_desc() && $question_group->desc() !== '') {
 			$html .= EEH_HTML::p(
 				$question_group->desc(),
 				'',
@@ -402,7 +401,7 @@ 
 			);
 
 		}
-		return new EE_Form_Section_HTML( $html );
+		return new EE_Form_Section_HTML($html);
 	}
 
 
@@ -412,7 +411,7 @@ 
 	 * @return    EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _copy_attendee_info_form(){
+	private function _copy_attendee_info_form() {
 		// array of params to pass to parent constructor
 		return new EE_Form_Section_Proper(
 			array(
@@ -441,7 +440,7 @@ 
 	private function _auto_copy_attendee_info() {
 		return new EE_Form_Section_HTML(
 			EEH_Template::locate_template(
-				SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+				SPCO_REG_STEPS_PATH.$this->_slug.DS.'_auto_copy_attendee_info.template.php',
 				apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
 					array()
@@ -465,32 +464,32 @@ 
 		$copy_attendee_info_inputs = array();
 		$prev_ticket = NULL;
 		// grab the saved registrations from the transaction
-		$registrations = $this->checkout->transaction->registrations( $this->checkout->reg_cache_where_params );
-		foreach ( $registrations as $registration ) {
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		foreach ($registrations as $registration) {
 			// for all  attendees other than the primary attendee
-			if ( $registration instanceof EE_Registration && ! $registration->is_primary_registrant() ) {
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
 				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-				if ( $registration->ticket()->ID() !== $prev_ticket ) {
+				if ($registration->ticket()->ID() !== $prev_ticket) {
 					$item_name = $registration->ticket()->name();
 					$item_name .= $registration->ticket()->description() !== ''
-						? ' - ' . $registration->ticket()->description()
+						? ' - '.$registration->ticket()->description()
 						: '';
-					$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']' ] = new EE_Form_Section_HTML(
-						'<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+					$copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-'.$registration->ticket()->ID().']'] = new EE_Form_Section_HTML(
+						'<h6 class="spco-copy-attendee-event-hdr">'.$item_name.'</h6>'
 					);
 					$prev_ticket = $registration->ticket()->ID();
 				}
 
-				$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] = new
+				$copy_attendee_info_inputs['spco_copy_attendee_chk['.$registration->ID().']'] = new
 				EE_Checkbox_Multi_Input(
 					array(
 						$registration->ID() => sprintf(
-							__( 'Attendee #%s', 'event_espresso' ),
+							__('Attendee #%s', 'event_espresso'),
 							$registration->count()
 						)
 					),
 					array(
-						'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+						'html_id'                 => 'spco-copy-attendee-chk-'.$registration->reg_url_link(),
 						'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
 						'display_html_label_text' => false
 					)
@@ -510,7 +509,7 @@ 
 	 * @return    EE_Form_Input_Base
 	 * @throws \EE_Error
 	 */
-	private function _additional_primary_registrant_inputs( EE_Registration $registration ){
+	private function _additional_primary_registrant_inputs(EE_Registration $registration) {
 		// generate hidden input
 		return new EE_Hidden_Input(
 			array(
@@ -529,7 +528,7 @@ 
 	 * @return    EE_Form_Input_Base
 	 * @throws \EE_Error
 	 */
-	public function reg_form_question( EE_Registration $registration, EE_Question $question ){
+	public function reg_form_question(EE_Registration $registration, EE_Question $question) {
 
 		// if this question was for an attendee detail, then check for that answer
 		$answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
@@ -538,32 +537,32 @@ 
 		);
 		$answer = $answer_value === null
 			? EEM_Answer::instance()->get_one(
-				array( array( 'QST_ID' => $question->ID(), 'REG_ID' => $registration->ID() ) )
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
 			)
 			: null;
 		// if NOT returning to edit an existing registration
 		// OR if this question is for an attendee property
 		// OR we still don't have an EE_Answer object
-		if( $answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link() ) {
+		if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
 			// create an EE_Answer object for storing everything in
-			$answer = EE_Answer::new_instance ( array(
+			$answer = EE_Answer::new_instance(array(
 				'QST_ID'=> $question->ID(),
 				'REG_ID'=> $registration->ID()
 			));
 		}
 		// verify instance
-		if( $answer instanceof EE_Answer ){
-			if ( ! empty( $answer_value )) {
-				$answer->set( 'ANS_value', $answer_value );
+		if ($answer instanceof EE_Answer) {
+			if ( ! empty($answer_value)) {
+				$answer->set('ANS_value', $answer_value);
 			}
-			$answer->cache( 'Question', $question );
+			$answer->cache('Question', $question);
 			//remember system ID had a bug where sometimes it could be null
-			$answer_cache_id =$question->is_system_question()
-				? $question->system_ID() . '-' . $registration->reg_url_link()
-				: $question->ID() . '-' . $registration->reg_url_link();
-			$registration->cache( 'Answer', $answer, $answer_cache_id );
+			$answer_cache_id = $question->is_system_question()
+				? $question->system_ID().'-'.$registration->reg_url_link()
+				: $question->ID().'-'.$registration->reg_url_link();
+			$registration->cache('Answer', $answer, $answer_cache_id);
 		}
-		return $this->_generate_question_input( $registration, $question, $answer );
+		return $this->_generate_question_input($registration, $question, $answer);
 
 	}
 
@@ -576,46 +575,46 @@ 
 	 * @return EE_Form_Input_Base
 	 * @throws \EE_Error
 	 */
-	private function _generate_question_input( EE_Registration $registration, EE_Question $question, $answer ){
+	private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer) {
 		$identifier = $question->is_system_question() ? $question->system_ID() : $question->ID();
-		$this->_required_questions[ $identifier ] = $question->required() ? true : false;
+		$this->_required_questions[$identifier] = $question->required() ? true : false;
 		add_filter(
 			'FHEE__EE_Question__generate_form_input__country_options',
-			array( $this, 'use_cached_countries_for_form_input' ),
+			array($this, 'use_cached_countries_for_form_input'),
 			10,
 			4
 		);
 		add_filter(
 			'FHEE__EE_Question__generate_form_input__state_options',
-			array( $this, 'use_cached_states_for_form_input' ),
+			array($this, 'use_cached_states_for_form_input'),
 			10,
 			4
 		);
 		$input_constructor_args = array(
-			'html_name'     => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-			'html_id'       => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-			'html_class'    => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-			'html_label_id' => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_name'     => 'ee_reg_qstn['.$registration->ID().']['.$identifier.']',
+			'html_id'       => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
+			'html_class'    => 'ee-reg-qstn ee-reg-qstn-'.$identifier,
+			'html_label_id' => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
 			'html_label_class'	=> 'ee-reg-qstn',
 		);
-		$input_constructor_args['html_label_id'] 	.= '-lbl';
-		if ( $answer instanceof EE_Answer && $answer->ID() ) {
-			$input_constructor_args[ 'html_name' ] .= '[' . $answer->ID() . ']';
-			$input_constructor_args[ 'html_id' ] .= '-' . $answer->ID();
-			$input_constructor_args[ 'html_label_id' ] .= '-' . $answer->ID();
+		$input_constructor_args['html_label_id'] .= '-lbl';
+		if ($answer instanceof EE_Answer && $answer->ID()) {
+			$input_constructor_args['html_name'] .= '['.$answer->ID().']';
+			$input_constructor_args['html_id'] .= '-'.$answer->ID();
+			$input_constructor_args['html_label_id'] .= '-'.$answer->ID();
 		}
-		$form_input =  $question->generate_form_input(
+		$form_input = $question->generate_form_input(
 			$registration,
 			$answer,
 			$input_constructor_args
 		);
 		remove_filter(
 			'FHEE__EE_Question__generate_form_input__country_options',
-			array( $this, 'use_cached_countries_for_form_input' )
+			array($this, 'use_cached_countries_for_form_input')
 		);
 		remove_filter(
 			'FHEE__EE_Question__generate_form_input__state_options',
-			array( $this, 'use_cached_states_for_form_input' )
+			array($this, 'use_cached_states_for_form_input')
 		);
 		return $form_input;
 	}
@@ -637,22 +636,22 @@ 
 		\EE_Registration $registration = null,
 		\EE_Answer $answer = null
 	) {
-		$country_options = array( '' => '' );
+		$country_options = array('' => '');
 		// get possibly cached list of countries
 		$countries = $this->checkout->action === 'process_reg_step'
 			? EEM_Country::instance()->get_all_countries()
 			: EEM_Country::instance()->get_all_active_countries();
-		if ( ! empty( $countries )) {
-			foreach( $countries as $country ){
-				if ( $country instanceof EE_Country ) {
-					$country_options[ $country->ID() ] = $country->name();
+		if ( ! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[$country->ID()] = $country->name();
 				}
 			}
 		}
-		if( $question instanceof EE_Question
-			&& $registration instanceof EE_Registration ) {
+		if ($question instanceof EE_Question
+			&& $registration instanceof EE_Registration) {
 			$answer = EEM_Answer::instance()->get_one(
-				array( array( 'QST_ID' => $question->ID(), 'REG_ID' => $registration->ID() ) )
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
 			);
 		} else {
 			$answer = EE_Answer::new_instance();
@@ -685,14 +684,14 @@ 
 		\EE_Registration $registration = null,
 		\EE_Answer $answer = null
 	) {
-		$state_options = array( '' => array( '' => ''));
+		$state_options = array('' => array('' => ''));
 		$states = $this->checkout->action === 'process_reg_step'
 			? EEM_State::instance()->get_all_states()
 			: EEM_State::instance()->get_all_active_states();
-		if ( ! empty( $states )) {
-			foreach( $states as $state ){
-				if ( $state instanceof EE_State ) {
-					$state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+		if ( ! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[$state->country()->name()][$state->ID()] = $state->name();
 				}
 			}
 		}
@@ -720,24 +719,24 @@ 
 	 * @throws \EE_Error
 	 */
 	public function process_reg_step() {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 		// grab validated data from form
 		$valid_data = $this->checkout->current_step->valid_data();
 		// EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
 		// EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
 		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-		if ( empty( $valid_data ))  {
+		if (empty($valid_data)) {
 			EE_Error::add_error(
-				__( 'No valid question responses were received.', 'event_espresso' ),
+				__('No valid question responses were received.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
 			);
 			return false;
 		}
-		if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg ) {
+		if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
 			EE_Error::add_error(
-				__( 'A valid transaction could not be initiated for processing your registrations.', 'event_espresso' ),
+				__('A valid transaction could not be initiated for processing your registrations.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -745,11 +744,11 @@ 
 			return false;
 		}
 		// get cached registrations
-		$registrations = $this->checkout->transaction->registrations( $this->checkout->reg_cache_where_params );
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
 		// verify we got the goods
-		if ( empty( $registrations )) {
+		if (empty($registrations)) {
 			EE_Error::add_error(
-				__( 'Your form data could not be applied to any valid registrations.', 'event_espresso' ),
+				__('Your form data could not be applied to any valid registrations.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -757,15 +756,15 @@ 
 			return false;
 		}
 		// extract attendee info from form data and save to model objects
-		$registrations_processed = $this->_process_registrations( $registrations, $valid_data );
+		$registrations_processed = $this->_process_registrations($registrations, $valid_data);
 		// if first pass thru SPCO,
 		// then let's check processed registrations against the total number of tickets in the cart
-		if ( $registrations_processed === false ) {
+		if ($registrations_processed === false) {
 			// but return immediately if the previous step exited early due to errors
 			return false;
-		} else if ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count ) {
+		} else if ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
 			// generate a correctly translated string for all possible singular/plural combinations
-			if ( $this->checkout->total_ticket_count === 1 && $registrations_processed !== 1 ) {
+			if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
 				$error_msg = sprintf(
 					__(
 						'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
@@ -774,7 +773,7 @@ 
 					$this->checkout->total_ticket_count,
 					$registrations_processed
 				);
-			} else if ( $this->checkout->total_ticket_count !== 1 && $registrations_processed === 1 ) {
+			} else if ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
 				$error_msg = sprintf(
 					__(
 						'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
@@ -793,17 +792,17 @@ 
 					$registrations_processed
 				);
 			}
-			EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// mark this reg step as completed
 		$this->set_completed();
 		$this->_set_success_message(
-			__( 'The Attendee Information Step has been successfully completed.', 'event_espresso' )
+			__('The Attendee Information Step has been successfully completed.', 'event_espresso')
 		);
 		//do action in case a plugin wants to do something with the data submitted in step 1.
 		//passes EE_Single_Page_Checkout, and it's posted data
-		do_action( 'AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data );
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
 		return true;
 	}
 
@@ -817,9 +816,9 @@ 
 	 * @return boolean | int
 	 * @throws \EE_Error
 	 */
-	private function _process_registrations( $registrations = array(), $valid_data = array() ) {
+	private function _process_registrations($registrations = array(), $valid_data = array()) {
 		// load resources and set some defaults
-		EE_Registry::instance()->load_model( 'Attendee' );
+		EE_Registry::instance()->load_model('Attendee');
 		// holder for primary registrant attendee object
 		$this->checkout->primary_attendee_obj = NULL;
 		// array for tracking reg form data for the primary registrant
@@ -836,9 +835,9 @@ 
 		// attendee counter
 		$att_nmbr = 0;
 		// grab the saved registrations from the transaction
-		foreach ( $registrations  as $registration ) {
+		foreach ($registrations  as $registration) {
 			// verify EE_Registration object
-			if ( ! $registration instanceof EE_Registration ) {
+			if ( ! $registration instanceof EE_Registration) {
 				EE_Error::add_error(
 					__(
 						'An invalid Registration object was discovered when attempting to process your registration information.',
@@ -853,12 +852,12 @@ 
 			/** @var string $reg_url_link */
 			$reg_url_link = $registration->reg_url_link();
 			// reg_url_link exists ?
-			if ( ! empty( $reg_url_link ) ) {
+			if ( ! empty($reg_url_link)) {
 				// should this registration be processed during this visit ?
-				if ( $this->checkout->visit_allows_processing_of_this_registration( $registration ) ) {
+				if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
 					// if NOT revisiting, then let's save the registration now,
 					// so that we have a REG_ID to use when generating other objects
-					if ( ! $this->checkout->revisit ) {
+					if ( ! $this->checkout->revisit) {
 						$registration->save();
 					}
 					/**
@@ -868,7 +867,7 @@ 
 					 * @var bool   if true is returned by the plugin then the
 					 *      		registration processing is halted.
 					 */
-					if ( apply_filters(
+					if (apply_filters(
 						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
 						false,
 						$att_nmbr,
@@ -876,38 +875,38 @@ 
 						$registrations,
 						$valid_data,
 						$this
-					) ) {
+					)) {
 						return false;
 					}
 
 					// Houston, we have a registration!
 					$att_nmbr++;
-					$this->_attendee_data[ $reg_url_link ] = array();
+					$this->_attendee_data[$reg_url_link] = array();
 					// grab any existing related answer objects
 					$this->_registration_answers = $registration->answers();
 					// unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-					if ( isset( $valid_data[ $reg_url_link ] ) ) {
+					if (isset($valid_data[$reg_url_link])) {
 						// do we need to copy basic info from primary attendee ?
-						$copy_primary = isset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] )
-						                && absint( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] ) === 0
+						$copy_primary = isset($valid_data[$reg_url_link]['additional_attendee_reg_info'])
+						                && absint($valid_data[$reg_url_link]['additional_attendee_reg_info']) === 0
 							? true
 							: false;
 						// filter form input data for this registration
-						$valid_data[ $reg_url_link ] = (array)apply_filters(
+						$valid_data[$reg_url_link] = (array) apply_filters(
 							'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-							$valid_data[ $reg_url_link ]
+							$valid_data[$reg_url_link]
 						);
 						// EEH_Debug_Tools::printr( $valid_data[ $reg_url_link ], '$valid_data[ $reg_url_link ]', __FILE__, __LINE__ );
-						if ( isset( $valid_data['primary_attendee'] )) {
-							$primary_registrant['line_item_id'] =  ! empty( $valid_data['primary_attendee'] )
+						if (isset($valid_data['primary_attendee'])) {
+							$primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
 								? $valid_data['primary_attendee']
 								: false;
-							unset( $valid_data['primary_attendee'] );
+							unset($valid_data['primary_attendee']);
 						}
 						// now loop through our array of valid post data && process attendee reg forms
-						foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs ) {
-							if ( ! in_array( $form_section, $non_input_form_sections )) {
-								foreach ( $form_inputs as $form_input => $input_value ) {
+						foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
+							if ( ! in_array($form_section, $non_input_form_sections)) {
+								foreach ($form_inputs as $form_input => $input_value) {
 									// \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
 									// check for critical inputs
 									if (
@@ -921,16 +920,16 @@ 
 									// store a bit of data about the primary attendee
 									if (
 										$att_nmbr === 1
-										&& ! empty( $input_value )
+										&& ! empty($input_value)
 										&& $reg_url_link === $primary_registrant['line_item_id']
 									) {
-										$primary_registrant[ $form_input ] = $input_value;
+										$primary_registrant[$form_input] = $input_value;
 									} else if (
 										$copy_primary
 										&& $input_value === null
-										&& isset( $primary_registrant[ $form_input ] )
+										&& isset($primary_registrant[$form_input])
 									) {
-										$input_value = $primary_registrant[ $form_input ];
+										$input_value = $primary_registrant[$form_input];
 									}
 									// now attempt to save the input data
 									if (
@@ -972,55 +971,55 @@ 
 						// have we met before?
 						$attendee = $this->_find_existing_attendee(
 							$registration,
-							$this->_attendee_data[ $reg_url_link ]
+							$this->_attendee_data[$reg_url_link]
 						);
 						// did we find an already existing record for this attendee ?
-						if ( $attendee instanceof EE_Attendee ) {
+						if ($attendee instanceof EE_Attendee) {
 							$attendee = $this->_update_existing_attendee_data(
 								$attendee,
-								$this->_attendee_data[ $reg_url_link ]
+								$this->_attendee_data[$reg_url_link]
 							);
 						} else {
 							// ensure critical details are set for additional attendees
-							$this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
+							$this->_attendee_data[$reg_url_link] = $att_nmbr > 1
 								? $this->_copy_critical_attendee_details_from_primary_registrant(
-									$this->_attendee_data[ $reg_url_link ]
+									$this->_attendee_data[$reg_url_link]
 								)
-								: $this->_attendee_data[ $reg_url_link ];
+								: $this->_attendee_data[$reg_url_link];
 							$attendee = $this->_create_new_attendee(
 								$registration,
-								$this->_attendee_data[ $reg_url_link ]
+								$this->_attendee_data[$reg_url_link]
 							);
 						}
 						// who's #1 ?
-						if ( $att_nmbr === 1 ) {
+						if ($att_nmbr === 1) {
 							$this->checkout->primary_attendee_obj = $attendee;
 						}
 					}
 					// EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
 					// add relation to registration, set attendee ID, and cache attendee
-					$this->_associate_attendee_with_registration( $registration, $attendee );
+					$this->_associate_attendee_with_registration($registration, $attendee);
 					// \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-					if ( ! $registration->attendee() instanceof EE_Attendee ) {
-						EE_Error::add_error( sprintf( __( 'Registration %s has an invalid or missing Attendee object.', 'event_espresso' ), $reg_url_link ), __FILE__, __FUNCTION__, __LINE__ );
+					if ( ! $registration->attendee() instanceof EE_Attendee) {
+						EE_Error::add_error(sprintf(__('Registration %s has an invalid or missing Attendee object.', 'event_espresso'), $reg_url_link), __FILE__, __FUNCTION__, __LINE__);
 						return false;
 					}
 					/** @type EE_Registration_Processor $registration_processor */
-					$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 					// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
-					$registration_processor->toggle_incomplete_registration_status_to_default( $registration, false );
+					$registration_processor->toggle_incomplete_registration_status_to_default($registration, false);
 					// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
 					$this->checkout->transaction->toggle_failed_transaction_status();
 					// if we've gotten this far, then let's save what we have
 					$registration->save();
 					// add relation between TXN and registration
-					$this->_associate_registration_with_transaction( $registration );
+					$this->_associate_registration_with_transaction($registration);
 				} // end of if ( ! $this->checkout->revisit || $this->checkout->primary_revisit || ( $this->checkout->revisit && $this->checkout->reg_url_link == $reg_url_link )) {
 
-			}  else {
-				EE_Error::add_error( __( 'An invalid or missing line item ID was encountered while attempting to process the registration form.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+			} else {
+				EE_Error::add_error(__('An invalid or missing line item ID was encountered while attempting to process the registration form.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 				// remove malformed data
-				unset( $valid_data[ $reg_url_link ] );
+				unset($valid_data[$reg_url_link]);
 				return false;
 			}
 
@@ -1049,26 +1048,26 @@ 
 		// \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
 		// allow for plugins to hook in and do their own processing of the form input.
 		// For plugins to bypass normal processing here, they just need to return a boolean value.
-		if ( apply_filters(
+		if (apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
 			false,
 			$registration,
 			$form_input,
 			$input_value,
 			$this
-		) ) {
+		)) {
 			return true;
 		}
 		// $answer_cache_id is the key used to find the EE_Answer we want
 		$answer_cache_id = $this->checkout->reg_url_link
 			? $form_input
-			: $form_input . '-' . $registration->reg_url_link();
-		$answer_is_obj = isset( $this->_registration_answers[ $answer_cache_id ] )
-		                 && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
+			: $form_input.'-'.$registration->reg_url_link();
+		$answer_is_obj = isset($this->_registration_answers[$answer_cache_id])
+		                 && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
 			? true
 			: false;
 		//rename form_inputs if they are EE_Attendee properties
-		switch( (string)$form_input ) {
+		switch ((string) $form_input) {
 
 			case 'state' :
 			case 'STA_ID' :
@@ -1083,32 +1082,32 @@ 
 				break;
 
 			default :
-				$ATT_input = 'ATT_' . $form_input;
+				$ATT_input = 'ATT_'.$form_input;
 				//EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
-				$attendee_property = EEM_Attendee::instance()->has_field( $ATT_input ) ? true : false;
-				$form_input = $attendee_property ? 'ATT_' . $form_input : $form_input;
+				$attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
+				$form_input = $attendee_property ? 'ATT_'.$form_input : $form_input;
 		}
 		// EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
 		// EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
 		// EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
 		// if this form input has a corresponding attendee property
-		if ( $attendee_property ) {
-			$this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
-			if ( $answer_is_obj ) {
+		if ($attendee_property) {
+			$this->_attendee_data[$registration->reg_url_link()][$form_input] = $input_value;
+			if ($answer_is_obj) {
 				// and delete the corresponding answer since we won't be storing this data in that object
-				$registration->_remove_relation_to( $this->_registration_answers[ $answer_cache_id ], 'Answer' );
-				$this->_registration_answers[ $answer_cache_id ]->delete_permanently();
+				$registration->_remove_relation_to($this->_registration_answers[$answer_cache_id], 'Answer');
+				$this->_registration_answers[$answer_cache_id]->delete_permanently();
 			}
 			return true;
-		} elseif ( $answer_is_obj ) {
+		} elseif ($answer_is_obj) {
 			// save this data to the answer object
-			$this->_registration_answers[ $answer_cache_id ]->set_value( $input_value );
-			$result = $this->_registration_answers[ $answer_cache_id ]->save();
+			$this->_registration_answers[$answer_cache_id]->set_value($input_value);
+			$result = $this->_registration_answers[$answer_cache_id]->save();
 			return $result !== false ? true : false;
 		} else {
-			foreach ( $this->_registration_answers as $answer ) {
-				if ( $answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id ) {
-					$answer->set_value( $input_value );
+			foreach ($this->_registration_answers as $answer) {
+				if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
+					$answer->set_value($input_value);
 					$result = $answer->save();
 					return $result !== false ? true : false;
 				}
@@ -1130,15 +1129,15 @@ 
 		$form_input = '',
 		$input_value = ''
 	) {
-		if ( empty( $input_value ) ) {
+		if (empty($input_value)) {
 			// if the form input isn't marked as being required, then just return
-			if ( ! isset( $this->_required_questions[ $form_input ] ) || ! $this->_required_questions[ $form_input ] ) {
+			if ( ! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
 				return true;
 			}
-			switch ( $form_input ) {
+			switch ($form_input) {
 				case 'fname' :
 					EE_Error::add_error(
-						__( 'First Name is a required value.', 'event_espresso' ),
+						__('First Name is a required value.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1147,7 +1146,7 @@ 
 					break;
 				case 'lname' :
 					EE_Error::add_error(
-						__( 'Last Name is a required value.', 'event_espresso' ),
+						__('Last Name is a required value.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1156,7 +1155,7 @@ 
 					break;
 				case 'email' :
 					EE_Error::add_error(
-						__( 'Please enter a valid email address.', 'event_espresso' ),
+						__('Please enter a valid email address.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1178,30 +1177,30 @@ 
 	 * @return boolean|EE_Attendee
 	 * @throws \EE_Error
 	 */
-	private function _find_existing_attendee( EE_Registration $registration, $attendee_data = array() ) {
+	private function _find_existing_attendee(EE_Registration $registration, $attendee_data = array()) {
 		$existing_attendee = null;
 		// if none of the critical properties are set in the incoming attendee data...
 		// then attempt to copy them from the primary attendee
 		if (
 			$this->checkout->primary_attendee_obj instanceof EE_Attendee
-            && ! isset( $attendee_data['ATT_fname'], $attendee_data['ATT_email'] )
+            && ! isset($attendee_data['ATT_fname'], $attendee_data['ATT_email'])
 		) {
 			return $this->checkout->primary_attendee_obj;
 		}
 		// does this attendee already exist in the db ?
 		// we're searching using a combination of first name, last name, AND email address
-		$ATT_fname = isset( $attendee_data['ATT_fname'] ) && ! empty( $attendee_data['ATT_fname'] )
+		$ATT_fname = isset($attendee_data['ATT_fname']) && ! empty($attendee_data['ATT_fname'])
 			? $attendee_data['ATT_fname']
 			: '';
-		$ATT_lname = isset( $attendee_data['ATT_lname'] ) && ! empty( $attendee_data['ATT_lname'] )
+		$ATT_lname = isset($attendee_data['ATT_lname']) && ! empty($attendee_data['ATT_lname'])
 			? $attendee_data['ATT_lname']
 			: '';
-		$ATT_email = isset( $attendee_data['ATT_email'] ) && ! empty( $attendee_data['ATT_email'] )
+		$ATT_email = isset($attendee_data['ATT_email']) && ! empty($attendee_data['ATT_email'])
 			? $attendee_data['ATT_email']
 			: '';
 		// but only if those have values
-		if ( $ATT_fname && $ATT_lname && $ATT_email ) {
-			$existing_attendee = EEM_Attendee::instance()->find_existing_attendee( array(
+		if ($ATT_fname && $ATT_lname && $ATT_email) {
+			$existing_attendee = EEM_Attendee::instance()->find_existing_attendee(array(
 				'ATT_fname' => $ATT_fname,
 				'ATT_lname' => $ATT_lname,
 				'ATT_email' => $ATT_email
@@ -1225,13 +1224,13 @@ 
 	 * @return \EE_Attendee
 	 * @throws \EE_Error
 	 */
-	private function _update_existing_attendee_data( EE_Attendee $existing_attendee, $attendee_data = array() ) {
+	private function _update_existing_attendee_data(EE_Attendee $existing_attendee, $attendee_data = array()) {
 		// first remove fname, lname, and email from attendee data
-		$dont_set = array( 'ATT_fname', 'ATT_lname', 'ATT_email' );
+		$dont_set = array('ATT_fname', 'ATT_lname', 'ATT_email');
 		// now loop thru what's left and add to attendee CPT
-		foreach ( $attendee_data as $property_name => $property_value ) {
-			if ( ! in_array( $property_name, $dont_set ) && EEM_Attendee::instance()->has_field( $property_name )) {
-				$existing_attendee->set( $property_name, $property_value );
+		foreach ($attendee_data as $property_name => $property_value) {
+			if ( ! in_array($property_name, $dont_set) && EEM_Attendee::instance()->has_field($property_name)) {
+				$existing_attendee->set($property_name, $property_value);
 			}
 		}
 		// better save that now
@@ -1249,11 +1248,11 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _associate_attendee_with_registration( EE_Registration $registration, EE_Attendee $attendee ) {
+	private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee) {
 		// add relation to attendee
-		$registration->_add_relation_to( $attendee, 'Attendee' );
-		$registration->set_attendee_id( $attendee->ID() );
-		$registration->update_cache_after_object_save( 'Attendee', $attendee );
+		$registration->_add_relation_to($attendee, 'Attendee');
+		$registration->set_attendee_id($attendee->ID());
+		$registration->update_cache_after_object_save('Attendee', $attendee);
 	}
 
 
@@ -1265,10 +1264,10 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _associate_registration_with_transaction( EE_Registration $registration ) {
+	private function _associate_registration_with_transaction(EE_Registration $registration) {
 		// add relation to attendee
-		$this->checkout->transaction->_add_relation_to( $registration, 'Registration' );
-		$this->checkout->transaction->update_cache_after_object_save( 'Registration', $registration );
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
 	}
 
 
@@ -1281,14 +1280,14 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-	private function _copy_critical_attendee_details_from_primary_registrant( $attendee_data = array() ) {
+	private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array()) {
 		// bare minimum critical details include first name, last name, email address
-		$critical_attendee_details = array( 'ATT_fname', 'ATT_lname', 'ATT_email' );
+		$critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
 		// add address info to critical details?
-		if ( apply_filters(
+		if (apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
 			false
-		) ) {
+		)) {
 			$address_details = array(
 				'ATT_address',
 				'ATT_address2',
@@ -1298,13 +1297,13 @@ 
 				'ATT_zip',
 				'ATT_phone'
 			);
-			$critical_attendee_details = array_merge( $critical_attendee_details, $address_details );
+			$critical_attendee_details = array_merge($critical_attendee_details, $address_details);
 		}
-		foreach ( $critical_attendee_details as $critical_attendee_detail ) {
-			if ( ! isset( $attendee_data[ $critical_attendee_detail ] )
-			     || empty( $attendee_data[ $critical_attendee_detail ] )
+		foreach ($critical_attendee_details as $critical_attendee_detail) {
+			if ( ! isset($attendee_data[$critical_attendee_detail])
+			     || empty($attendee_data[$critical_attendee_detail])
 			) {
-				$attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
+				$attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(
 					$critical_attendee_detail
 				);
 			}
@@ -1322,11 +1321,11 @@ 
 	 * @return \EE_Attendee
 	 * @throws \EE_Error
 	 */
-	private function _create_new_attendee( EE_Registration $registration, $attendee_data = array() ) {
+	private function _create_new_attendee(EE_Registration $registration, $attendee_data = array()) {
 		// create new attendee object
-		$new_attendee = EE_Attendee::new_instance( $attendee_data );
+		$new_attendee = EE_Attendee::new_instance($attendee_data);
 		// set author to event creator
-		$new_attendee->set( 'ATT_author', $registration->event()->wp_user() );
+		$new_attendee->set('ATT_author', $registration->event()->wp_user());
 		$new_attendee->save();
 		return $new_attendee;
 	}
@@ -1343,7 +1342,7 @@ 
 	 */
 	public function update_reg_step() {
 		// save everything
-		if ( $this->process_reg_step() ) {
+		if ($this->process_reg_step()) {
 			$this->checkout->redirect = true;
 			$this->checkout->redirect_url = add_query_arg(
 				array(
@@ -1352,7 +1351,7 @@ 
 				),
 				$this->checkout->thank_you_page_url
 			);
-			$this->checkout->json_response->set_redirect_url( $this->checkout->redirect_url );
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 			return true;
 		}
 		return false;

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1704 added lines, -1704 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,1709 +17,1709 @@ 
 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_flip($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()
-    {
-        // 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'
-            ) {
-                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_flip($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()
+	{
+		// 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'
+			) {
+				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>';
+	}
 
 
 

Spacing +25 added lines, -25 removed lines

@@ -216,13 +216,13 @@ 
      */
     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);
+        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',
@@ -231,7 +231,7 @@ 
             '</h4>',
             '<br />',
             '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+            '<a href="'.get_post_type_archive_link('espresso_events').'" title="',
             '">',
             '</a>',
             '</p>'
@@ -255,7 +255,7 @@ 
             return;
         }
         // filter list of reg_steps
-        $reg_steps_to_load = (array)apply_filters(
+        $reg_steps_to_load = (array) apply_filters(
             'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
             EED_Single_Page_Checkout::get_reg_steps()
         );
@@ -299,25 +299,25 @@ 
         if (empty($reg_steps)) {
             $reg_steps = array(
                 10  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+                    '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',
+                    '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',
+                    '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',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'finalize_registration',
                     'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
                     'slug'       => 'finalize_registration',
                     'has_hooks'  => false,
@@ -499,7 +499,7 @@ 
             // DEBUG LOG
             //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
             // get reg form
-            if( ! $this->_check_form_submission()) {
+            if ( ! $this->_check_form_submission()) {
                 EED_Single_Page_Checkout::$_initialized = true;
                 return;
             }
@@ -1063,7 +1063,7 @@ 
                     if ( ! $registration instanceof EE_Registration) {
                         throw new InvalidEntityException($registration, 'EE_Registration');
                     }
-                    $registrations[ $registration->ID() ] = $registration;
+                    $registrations[$registration->ID()] = $registration;
                 }
             }
             $registration_processor->fix_reg_final_price_rounding_issue($transaction);
@@ -1293,7 +1293,7 @@ 
                         ) {
                             EE_Error::add_success(
                                 $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
+                                . '<br />'.$this->checkout->next_step->_instructions()
                             );
                         }
                         // pack it up, pack it in...
@@ -1390,7 +1390,7 @@ 
             '</h4>',
             '<br />',
             '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+            '<a href="'.get_post_type_archive_link('espresso_events').'" title="',
             '">',
             '</a>',
             '</p>'
@@ -1416,12 +1416,12 @@ 
     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_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);
+        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();
         }
@@ -1438,7 +1438,7 @@ 
          * 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);
+        do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__'.$this->checkout->current_step->slug(), $this);
     }
 
 
@@ -1490,7 +1490,7 @@ 
                     'layout_strategy' =>
                         new EE_Template_Layout(
                             array(
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+                                'layout_template_file' => SPCO_TEMPLATES_PATH.'registration_page_wrapper.template.php',
                                 'template_args'        => array(
                                     'empty_cart'              => $empty_cart,
                                     'revisit'                 => $this->checkout->revisit,
@@ -1504,7 +1504,7 @@ 
                                         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 href="'.get_post_type_archive_link('espresso_events').'" title="',
                                             '">',
                                             '</a>'
                                         )
@@ -1558,7 +1558,7 @@ 
         ) {
             add_filter(
                 'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
+                function($url) {
                     return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
                 }
             );

modules/ticket_selector/EED_Ticket_Selector.module.php

Doc Comments +2 added lines, -2 removed lines

@@ -187,7 +187,7 @@ 
 	 *    process_ticket_selections
 	 *
 	 * @access        public
-	 * @return        array  or FALSE
+	 * @return        boolean|null  or FALSE
 	 * @throws \EE_Error
 	 */
 	public function process_ticket_selections() {
@@ -201,7 +201,7 @@ 
      * cancel_ticket_selections
      *
      * @access        public
-	 * @return        array  or FALSE
+	 * @return        false|null  or FALSE
 	 * @throws \EE_Error
 	 */
 	public function cancel_ticket_selections() {

Indentation +165 added lines, -165 removed lines

@@ -22,15 +22,15 @@ 
  */
 class EED_Ticket_Selector extends  EED_Module {
 
-    /**
-     * @var EventEspresso\modules\ticket_selector\DisplayTicketSelector $ticket_selector
-     */
-    private static $ticket_selector;
+	/**
+	 * @var EventEspresso\modules\ticket_selector\DisplayTicketSelector $ticket_selector
+	 */
+	private static $ticket_selector;
 
-    /**
-     * @var EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton $iframe_embed_button
-     */
-    private static $iframe_embed_button;
+	/**
+	 * @var EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton $iframe_embed_button
+	 */
+	private static $iframe_embed_button;
 
 
 
@@ -61,8 +61,8 @@ 
 		// routing
 		EE_Config::register_route( 'iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector' );
 		EE_Config::register_route( 'process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections' );
-        EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
-        add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
+		EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
+		add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
 		add_action( 'AHEE_event_details_header_bottom', array( 'EED_Ticket_Selector', 'display_ticket_selector' ), 10, 1 );
 		add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'load_tckt_slctr_assets' ), 10 );
 	}
@@ -83,7 +83,7 @@ 
 			array( 'EED_Ticket_Selector', 'ticket_selector_iframe_embed_button' ),
 			10
 		);
-    }
+	}
 
 
 
@@ -99,23 +99,23 @@ 
 
 		//if config is not set, initialize
 		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config ) {
-            \EED_Ticket_Selector::instance()->set_config();
-            \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
+			\EED_Ticket_Selector::instance()->set_config();
+			\EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
 		}
 	}
 
 
 
 	/**
-     * @return \EventEspresso\modules\ticket_selector\DisplayTicketSelector
-     */
-    public static function ticketSelector()
-    {
-        if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
-            EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector();
-        }
-        return EED_Ticket_Selector::$ticket_selector;
-    }
+	 * @return \EventEspresso\modules\ticket_selector\DisplayTicketSelector
+	 */
+	public static function ticketSelector()
+	{
+		if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
+			EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector();
+		}
+		return EED_Ticket_Selector::$ticket_selector;
+	}
 
 
 	/**
@@ -168,15 +168,15 @@ 
 
 
 
-    /**
-     *    creates buttons for selecting number of attendees for an event
-     *
-     * @access    public
-     * @param    WP_Post|int $event
-     * @param    bool        $view_details
-     * @return    string
-     * @throws \EE_Error
-     */
+	/**
+	 *    creates buttons for selecting number of attendees for an event
+	 *
+	 * @access    public
+	 * @param    WP_Post|int $event
+	 * @param    bool        $view_details
+	 * @return    string
+	 * @throws \EE_Error
+	 */
 	public static function display_ticket_selector( $event = NULL, $view_details = FALSE ) {
 		return EED_Ticket_Selector::ticketSelector()->display( $event, $view_details );
 	}
@@ -198,9 +198,9 @@ 
 
 
 	/**
-     * cancel_ticket_selections
-     *
-     * @access        public
+	 * cancel_ticket_selections
+	 *
+	 * @access        public
 	 * @return        array  or FALSE
 	 * @throws \EE_Error
 	 */
@@ -212,11 +212,11 @@ 
 
 
 	/**
-	* 	load js
-	*
-	* 	@access 		public
-	* 	@return 		void
-	*/
+	 * 	load js
+	 *
+	 * 	@access 		public
+	 * 	@return 		void
+	 */
 	public static function load_tckt_slctr_assets() {
 		if ( apply_filters( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE ) ) {
 			// add some style
@@ -225,9 +225,9 @@ 
 			// make it dance
 			wp_register_script('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', array('espresso_core'), '', TRUE);
 			wp_enqueue_script('ticket_selector');
-            require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
-            \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
-        }
+			require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
+			\EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
+		}
 	}
 
 
@@ -236,129 +236,129 @@ 
 
 
 
-    /**
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_view_details_btn()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_ticket_selector_submit()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param string $permalink_string
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     */
-    public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        if (
-        	\EE_Registry::instance()->REQ->get('page') === 'espresso_events'
-        	&& \EE_Registry::instance()->REQ->get('action') === 'edit'
-        ) {
-            $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->addEventEditorIframeEmbedButton();
-        }
-        return '';
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param int    $ID
-     * @param string $external_url
-     * @return string
-     */
-    public static function ticket_selector_form_open($ID = 0, $external_url = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function ticket_selector_form_close()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formClose();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function no_tkt_slctr_end_dv()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.13
-     * @return string
-     */
-    public static function tkt_slctr_end_dv()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function clear_tkt_slctr()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-
-    /**
-     * @deprecated
-     */
-    public static function load_tckt_slctr_assets_admin()
-    {
-        // todo add doing_it_wrong() notice during next major version
-	    if (
-		    \EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
-		    && \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
-	    ) {
-		    $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->embedButtonAssets();
-        }
-    }
+	/**
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_view_details_btn()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_ticket_selector_submit()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 */
+	public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			\EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+			&& \EE_Registry::instance()->REQ->get('action') === 'edit'
+		) {
+			$iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->addEventEditorIframeEmbedButton();
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param int    $ID
+	 * @param string $external_url
+	 * @return string
+	 */
+	public static function ticket_selector_form_open($ID = 0, $external_url = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function ticket_selector_form_close()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formClose();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function no_tkt_slctr_end_dv()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.13
+	 * @return string
+	 */
+	public static function tkt_slctr_end_dv()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function clear_tkt_slctr()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 */
+	public static function load_tckt_slctr_assets_admin()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			\EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
+			&& \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
+		) {
+			$iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->embedButtonAssets();
+		}
+	}
 
 
 }

Spacing +26 added lines, -26 removed lines

@@ -3,8 +3,8 @@ 
 use EventEspresso\modules\ticket_selector\TicketSelectorIframe;
 use EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -38,15 +38,15 @@ 
 	 * @return EED_Ticket_Selector
 	 */
 	public static function instance() {
-		return parent::get_instance( __CLASS__ );
+		return parent::get_instance(__CLASS__);
 	}
 
 
 
-	protected function set_config(){
-		$this->set_config_section( 'template_settings' );
-		$this->set_config_class( 'EE_Ticket_Selector_Config' );
-		$this->set_config_name( 'EED_Ticket_Selector' );
+	protected function set_config() {
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Ticket_Selector_Config');
+		$this->set_config_name('EED_Ticket_Selector');
 	}
 
 
@@ -59,12 +59,12 @@ 
 	 */
 	public static function set_hooks() {
 		// routing
-		EE_Config::register_route( 'iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector' );
-		EE_Config::register_route( 'process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections' );
+		EE_Config::register_route('iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector');
+		EE_Config::register_route('process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections');
         EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
-        add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
-		add_action( 'AHEE_event_details_header_bottom', array( 'EED_Ticket_Selector', 'display_ticket_selector' ), 10, 1 );
-		add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'load_tckt_slctr_assets' ), 10 );
+        add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
+		add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
+		add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
 	}
 
 
@@ -80,7 +80,7 @@ 
 		// to load assets for "espresso_events" page on the "edit" route (action)
 		add_action(
 			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
-			array( 'EED_Ticket_Selector', 'ticket_selector_iframe_embed_button' ),
+			array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'),
 			10
 		);
     }
@@ -94,11 +94,11 @@ 
 	 *  @return 	void
 	 */
 	public static function set_definitions() {
-		define( 'TICKET_SELECTOR_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS );
-		define( 'TICKET_SELECTOR_TEMPLATES_PATH', str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS );
+		define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
+		define('TICKET_SELECTOR_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS);
 
 		//if config is not set, initialize
-		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config ) {
+		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config) {
             \EED_Ticket_Selector::instance()->set_config();
             \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
 		}
@@ -125,7 +125,7 @@ 
 	 * 	@param	WP $WP
 	 * 	@return void
 	 */
-	public function run( $WP ) {}
+	public function run($WP) {}
 
 
 
@@ -133,7 +133,7 @@ 
 	 * @return \EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton
 	 */
 	public static function getIframeEmbedButton() {
-		if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton ) {
+		if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
 			self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
 		}
 		return self::$iframe_embed_button;
@@ -177,8 +177,8 @@ 
      * @return    string
      * @throws \EE_Error
      */
-	public static function display_ticket_selector( $event = NULL, $view_details = FALSE ) {
-		return EED_Ticket_Selector::ticketSelector()->display( $event, $view_details );
+	public static function display_ticket_selector($event = NULL, $view_details = FALSE) {
+		return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
 	}
 
 
@@ -218,14 +218,14 @@ 
 	* 	@return 		void
 	*/
 	public static function load_tckt_slctr_assets() {
-		if ( apply_filters( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE ) ) {
+		if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE)) {
 			// add some style
-			wp_register_style('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css');
+			wp_register_style('ticket_selector', TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css');
 			wp_enqueue_style('ticket_selector');
 			// make it dance
-			wp_register_script('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', array('espresso_core'), '', TRUE);
+			wp_register_script('ticket_selector', TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js', array('espresso_core'), '', TRUE);
 			wp_enqueue_script('ticket_selector');
-            require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
+            require_once(EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
             \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
         }
 	}
@@ -352,8 +352,8 @@ 
     {
         // todo add doing_it_wrong() notice during next major version
 	    if (
-		    \EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
-		    && \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
+		    \EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+		    && \EE_Registry::instance()->REQ->get('action') === 'edit'
 	    ) {
 		    $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
             $iframe_embed_button->embedButtonAssets();

modules/ticket_selector/ProcessTicketSelector.php

Doc Comments +4 added lines, -4 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * cancelTicketSelections
      *
-     * @return        string
+     * @return        false|null
      */
     public function cancelTicketSelections()
     {
@@ -99,7 +99,7 @@ 
     /**
      * process_ticket_selections
      *
-     * @return array|bool
+     * @return boolean|null
      * @throws \EE_Error
      */
     public function processTicketSelections()
@@ -273,7 +273,7 @@ 
      * validate_post_data
      *
      * @param int $id
-     * @return array|FALSE
+     * @return string
      */
     private function validatePostData($id = 0)
     {
@@ -390,7 +390,7 @@ 
      *
      * @param \EE_Ticket $ticket
      * @param int        $qty
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws \EE_Error
      */
     private function addTicketToCart(\EE_Ticket $ticket = null, $qty = 1)

Indentation +569 added lines, -569 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\modules\ticket_selector;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -19,574 +19,574 @@ 
 class ProcessTicketSelector
 {
 
-    /**
-     * array of datetimes and the spaces available for them
-     *
-     * @access private
-     * @var array
-     */
-    private static $_available_spaces = array();
-
-
-
-    /**
-     * cancelTicketSelections
-     *
-     * @return        string
-     */
-    public function cancelTicketSelections()
-    {
-        // check nonce
-        if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
-            return false;
-        }
-        \EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        if (\EE_Registry::instance()->REQ->is_set('event_id')) {
-            wp_safe_redirect(
-                \EEH_Event_View::event_link_url(
-                    \EE_Registry::instance()->REQ->get('event_id')
-                )
-            );
-        } else {
-            wp_safe_redirect(
-                site_url('/' . \EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
-            );
-        }
-        exit();
-    }
-
-
-
-    /**
-     * processTicketSelectorNonce
-     *
-     * @param  string $nonce_name
-     * @param string  $id
-     * @return bool
-     */
-    private function processTicketSelectorNonce($nonce_name, $id = '')
-    {
-        $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
-        if (
-            ! is_admin()
-            && (
-                ! \EE_Registry::instance()->REQ->is_set($nonce_name_with_id)
-                || ! wp_verify_nonce(
-                    \EE_Registry::instance()->REQ->get($nonce_name_with_id),
-                    $nonce_name
-                )
-            )
-        ) {
-            \EE_Error::add_error(
-                sprintf(
-                    __(
-                        'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * process_ticket_selections
-     *
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function processTicketSelections()
-    {
-        do_action('EED_Ticket_Selector__process_ticket_selections__before');
-        // do we have an event id?
-        if ( ! \EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
-            // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
-            \EE_Error::add_error(
-                sprintf(
-                    __(
-                        'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        //if event id is valid
-        $id = absint(\EE_Registry::instance()->REQ->get('tkt-slctr-event-id'));
-        // check nonce
-        if ( ! $this->processTicketSelectorNonce('process_ticket_selections', $id)) {
-            return false;
-        }
-        //		d( \EE_Registry::instance()->REQ );
-        self::$_available_spaces = array(
-            'tickets'   => array(),
-            'datetimes' => array(),
-        );
-        //we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart.
-        // When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc.
-        \EE_Registry::instance()->load_core('Session');
-        // unless otherwise requested, clear the session
-        if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
-            \EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        //d( \EE_Registry::instance()->SSN );
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // validate/sanitize data
-        $valid = $this->validatePostData($id);
-        //EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ );
-        //check total tickets ordered vs max number of attendees that can register
-        if ($valid['total_tickets'] > $valid['max_atndz']) {
-            // ordering too many tickets !!!
-            $total_tickets_string = _n(
-                'You have attempted to purchase %s ticket.',
-                'You have attempted to purchase %s tickets.',
-                $valid['total_tickets'],
-                'event_espresso'
-            );
-            $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
-            // dev only message
-            $max_atndz_string = _n(
-                'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                $valid['max_atndz'],
-                'event_espresso'
-            );
-            $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
-            \EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            // all data appears to be valid
-            $tckts_slctd = false;
-            $tickets_added = 0;
-            $valid = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data', $valid);
-            if ($valid['total_tickets'] > 0) {
-                // load cart
-                \EE_Registry::instance()->load_core('Cart');
-                // cycle thru the number of data rows sent from the event listing
-                for ($x = 0; $x < $valid['rows']; $x++) {
-                    // does this row actually contain a ticket quantity?
-                    if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
-                        // YES we have a ticket quantity
-                        $tckts_slctd = true;
-                        //						d( $valid['ticket_obj'][$x] );
-                        if ($valid['ticket_obj'][$x] instanceof \EE_Ticket) {
-                            // then add ticket to cart
-                            $tickets_added += $this->addTicketToCart(
-                                $valid['ticket_obj'][$x],
-                                $valid['qty'][$x]
-                            );
-                            if (\EE_Error::has_error()) {
-                                break;
-                            }
-                        } else {
-                            // nothing added to cart retrieved
-                            \EE_Error::add_error(
-                                sprintf(
-                                    __(
-                                        'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
-                                        'event_espresso'
-                                    ),
-                                    '<br/>'
-                                ),
-                                __FILE__, __FUNCTION__, __LINE__
-                            );
-                        }
-                    }
-                }
-            }
-            do_action(
-                'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-                \EE_Registry::instance()->CART,
-                $this
-            );
-            //d( \EE_Registry::instance()->CART );
-            //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
-            if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) {
-                if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
-                    do_action(
-                        'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
-                        \EE_Registry::instance()->CART,
-                        $this
-                    );
-                    \EE_Registry::instance()->CART->recalculate_all_cart_totals();
-                    \EE_Registry::instance()->CART->save_cart(false);
-                    // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
-                    // just return TRUE for registrations being made from admin
-                    if (is_admin()) {
-                        return true;
-                    }
-                    \EE_Error::get_notices(false, true);
-                    wp_safe_redirect(
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
-                            \EE_Registry::instance()->CFG->core->reg_page_url()
-                        )
-                    );
-                    exit();
-                } else {
-                    if ( ! \EE_Error::has_error() && ! \EE_Error::has_error(true, 'attention')) {
-                        // nothing added to cart
-                        \EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'),
-                            __FILE__, __FUNCTION__, __LINE__);
-                    }
-                }
-            } else {
-                // no ticket quantities were selected
-                \EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.',
-                    'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
-        // at this point, just return if registration is being made from admin
-        if (is_admin()) {
-            return false;
-        }
-        if ($valid['return_url']) {
-            \EE_Error::get_notices(false, true);
-            wp_safe_redirect($valid['return_url']);
-            exit();
-        } elseif (isset($event_to_add['id'])) {
-            \EE_Error::get_notices(false, true);
-            wp_safe_redirect(get_permalink($event_to_add['id']));
-            exit();
-        } else {
-            echo \EE_Error::get_notices();
-        }
-        return false;
-    }
-
-
-
-    /**
-     * validate_post_data
-     *
-     * @param int $id
-     * @return array|FALSE
-     */
-    private function validatePostData($id = 0)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! $id) {
-            \EE_Error::add_error(
-                __('The event id provided was not valid.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // start with an empty array()
-        $valid_data = array();
-        // grab valid id
-        $valid_data['id'] = $id;
-        // array of other form names
-        $inputs_to_clean = array(
-            'event_id'   => 'tkt-slctr-event-id',
-            'max_atndz'  => 'tkt-slctr-max-atndz-',
-            'rows'       => 'tkt-slctr-rows-',
-            'qty'        => 'tkt-slctr-qty-',
-            'ticket_id'  => 'tkt-slctr-ticket-id-',
-            'return_url' => 'tkt-slctr-return-url-',
-        );
-        // let's track the total number of tickets ordered.'
-        $valid_data['total_tickets'] = 0;
-        // cycle through $inputs_to_clean array
-        foreach ($inputs_to_clean as $what => $input_to_clean) {
-            // check for POST data
-            if (\EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
-                // grab value
-                $input_value = \EE_Registry::instance()->REQ->get($input_to_clean . $id);
-                switch ($what) {
-                    // integers
-                    case 'event_id':
-                        $valid_data[$what] = absint($input_value);
-                        // get event via the event id we put in the form
-                        $valid_data['event'] = \EE_Registry::instance()
-                                                           ->load_model('Event')
-                                                           ->get_one_by_ID($valid_data['event_id']);
-                        break;
-                    case 'rows':
-                    case 'max_atndz':
-                        $valid_data[$what] = absint($input_value);
-                        break;
-                    // arrays of integers
-                    case 'qty':
-                        /** @var array $row_qty */
-                        $row_qty = $input_value;
-                        // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if ( ! is_array($row_qty)) {
-                            // get number of rows
-                            $rows = \EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
-                                ? absint(\EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
-                                : 1;
-                            // explode ints by the dash
-                            $row_qty = explode('-', $row_qty);
-                            $row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
-                            $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
-                            $row_qty = array($row => $qty);
-                            for ($x = 1; $x <= $rows; $x++) {
-                                if ( ! isset($row_qty[$x])) {
-                                    $row_qty[$x] = 0;
-                                }
-                            }
-                        }
-                        ksort($row_qty);
-                        // cycle thru values
-                        foreach ($row_qty as $qty) {
-                            $qty = absint($qty);
-                            // sanitize as integers
-                            $valid_data[$what][] = $qty;
-                            $valid_data['total_tickets'] += $qty;
-                        }
-                        break;
-                    // array of integers
-                    case 'ticket_id':
-                        $value_array = array();
-                        // cycle thru values
-                        foreach ((array)$input_value as $key => $value) {
-                            // allow only numbers, letters,  spaces, commas and dashes
-                            $value_array[$key] = wp_strip_all_tags($value);
-                            // get ticket via the ticket id we put in the form
-                            $ticket_obj = \EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($value);
-                            $valid_data['ticket_obj'][$key] = $ticket_obj;
-                        }
-                        $valid_data[$what] = $value_array;
-                        break;
-                    case 'return_url' :
-                        // grab and sanitize return-url
-                        $input_value = esc_url_raw($input_value);
-                        // was the request coming from an iframe ? if so, then:
-                        if (strpos($input_value, 'event_list=iframe')) {
-                            // get anchor fragment
-                            $input_value = explode('#', $input_value);
-                            $input_value = end($input_value);
-                            // use event list url instead, but append anchor
-                            $input_value = \EEH_Event_View::event_archive_url() . '#' . $input_value;
-                        }
-                        $valid_data[$what] = $input_value;
-                        break;
-                }    // end switch $what
-            }
-        }    // end foreach $inputs_to_clean
-        return $valid_data;
-    }
-
-
-
-    /**
-     * adds a ticket to the cart
-     *
-     * @param \EE_Ticket $ticket
-     * @param int        $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    private function addTicketToCart(\EE_Ticket $ticket = null, $qty = 1)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // get the number of spaces left for this datetime ticket
-        $available_spaces = $this->ticketDatetimeAvailability($ticket);
-        // compare available spaces against the number of tickets being purchased
-        if ($available_spaces >= $qty) {
-            // allow addons to prevent a ticket from being added to cart
-            if (
-            ! apply_filters(
-                'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
-                true,
-                $ticket,
-                $qty,
-                $available_spaces
-            )
-            ) {
-                return false;
-            }
-            $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
-            // add event to cart
-            if (\EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) {
-                $this->recalculateTicketDatetimeAvailability($ticket, $qty);
-                return true;
-            }
-            return false;
-        }
-        // tickets can not be purchased but let's find the exact number left
-        // for the last ticket selected PRIOR to subtracting tickets
-        $available_spaces = $this->ticketDatetimeAvailability($ticket, true);
-        // greedy greedy greedy eh?
-        if ($available_spaces > 0) {
-            if (
-            apply_filters(
-                'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
-                true,
-                $ticket,
-                $qty,
-                $available_spaces
-            )
-            ) {
-                $this->displayAvailabilityError($available_spaces);
-            }
-        } else {
-            \EE_Error::add_error(
-                __(
-                    'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param int $available_spaces
-     * @throws \EE_Error
-     */
-    private function displayAvailabilityError($available_spaces = 1)
-    {
-        // add error messaging - we're using the _n function that will generate
-        // the appropriate singular or plural message based on the number of $available_spaces
-        if (\EE_Registry::instance()->CART->all_ticket_quantity_count()) {
-            $msg = sprintf(
-                _n(
-                    'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                    'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                    $available_spaces,
-                    'event_espresso'
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        } else {
-            $msg = sprintf(
-                _n(
-                    'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                    'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                    $available_spaces,
-                    'event_espresso'
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        }
-        \EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-    }
-
-
-
-    /**
-     * ticketDatetimeAvailability
-     * creates an array of tickets plus all of the datetimes available to each ticket
-     * and tracks the spaces remaining for each of those datetimes
-     *
-     * @param \EE_Ticket $ticket - selected ticket
-     * @param bool       $get_original_ticket_spaces
-     * @return int
-     * @throws \EE_Error
-     */
-    private function ticketDatetimeAvailability(\EE_Ticket $ticket, $get_original_ticket_spaces = false)
-    {
-        // if the $_available_spaces array has not been set up yet...
-        if ( ! isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
-            $this->setInitialTicketDatetimeAvailability($ticket);
-        }
-        $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
-                // if we want the original datetime availability BEFORE we started subtracting tickets ?
-                if ($get_original_ticket_spaces) {
-                    // then grab the available spaces from the "tickets" array
-                    // and compare with the above to get the lowest number
-                    $available_spaces = min(
-                        $available_spaces,
-                        self::$_available_spaces['tickets'][$ticket->ID()][$DTD_ID]
-                    );
-                } else {
-                    // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][$DTD_ID]);
-                }
-            }
-        }
-        return $available_spaces;
-    }
-
-
-
-    /**
-     * @param \EE_Ticket $ticket
-     * @return void
-     * @throws \EE_Error
-     */
-    private function setInitialTicketDatetimeAvailability(\EE_Ticket $ticket)
-    {
-        // first, get all of the datetimes that are available to this ticket
-        $datetimes = $ticket->get_many_related(
-            'Datetime',
-            array(
-                array(
-                    'DTT_EVT_end' => array(
-                        '>=',
-                        \EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-                    ),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-        if ( ! empty($datetimes)) {
-            // now loop thru all of the datetimes
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof \EE_Datetime) {
-                    // the number of spaces available for the datetime without considering individual ticket quantities
-                    $spaces_remaining = $datetime->spaces_remaining();
-                    // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
-                    // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    self::$_available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min(
-                        $ticket->qty() - $ticket->sold(),
-                        $spaces_remaining
-                    );
-                    // if the remaining spaces for this datetime is already set,
-                    // then compare that against the datetime spaces remaining, and take the lowest number,
-                    // else just take the datetime spaces remaining, and assign to the datetimes array
-                    self::$_available_spaces['datetimes'][$datetime->ID()] = isset(
-                        self::$_available_spaces['datetimes'][$datetime->ID()]
-                    )
-                        ? min(self::$_available_spaces['datetimes'][$datetime->ID()], $spaces_remaining)
-                        : $spaces_remaining;
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * @param    \EE_Ticket $ticket
-     * @param    int        $qty
-     * @return    void
-     */
-    private function recalculateTicketDatetimeAvailability(\EE_Ticket $ticket, $qty = 0)
-    {
-        if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
-                // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                self::$_available_spaces['datetimes'][$DTD_ID] -= $qty;
-            }
-        }
-    }
+	/**
+	 * array of datetimes and the spaces available for them
+	 *
+	 * @access private
+	 * @var array
+	 */
+	private static $_available_spaces = array();
+
+
+
+	/**
+	 * cancelTicketSelections
+	 *
+	 * @return        string
+	 */
+	public function cancelTicketSelections()
+	{
+		// check nonce
+		if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+			return false;
+		}
+		\EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		if (\EE_Registry::instance()->REQ->is_set('event_id')) {
+			wp_safe_redirect(
+				\EEH_Event_View::event_link_url(
+					\EE_Registry::instance()->REQ->get('event_id')
+				)
+			);
+		} else {
+			wp_safe_redirect(
+				site_url('/' . \EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
+			);
+		}
+		exit();
+	}
+
+
+
+	/**
+	 * processTicketSelectorNonce
+	 *
+	 * @param  string $nonce_name
+	 * @param string  $id
+	 * @return bool
+	 */
+	private function processTicketSelectorNonce($nonce_name, $id = '')
+	{
+		$nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
+		if (
+			! is_admin()
+			&& (
+				! \EE_Registry::instance()->REQ->is_set($nonce_name_with_id)
+				|| ! wp_verify_nonce(
+					\EE_Registry::instance()->REQ->get($nonce_name_with_id),
+					$nonce_name
+				)
+			)
+		) {
+			\EE_Error::add_error(
+				sprintf(
+					__(
+						'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * process_ticket_selections
+	 *
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function processTicketSelections()
+	{
+		do_action('EED_Ticket_Selector__process_ticket_selections__before');
+		// do we have an event id?
+		if ( ! \EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
+			// $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
+			\EE_Error::add_error(
+				sprintf(
+					__(
+						'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		//if event id is valid
+		$id = absint(\EE_Registry::instance()->REQ->get('tkt-slctr-event-id'));
+		// check nonce
+		if ( ! $this->processTicketSelectorNonce('process_ticket_selections', $id)) {
+			return false;
+		}
+		//		d( \EE_Registry::instance()->REQ );
+		self::$_available_spaces = array(
+			'tickets'   => array(),
+			'datetimes' => array(),
+		);
+		//we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart.
+		// When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc.
+		\EE_Registry::instance()->load_core('Session');
+		// unless otherwise requested, clear the session
+		if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
+			\EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		//d( \EE_Registry::instance()->SSN );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// validate/sanitize data
+		$valid = $this->validatePostData($id);
+		//EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ );
+		//check total tickets ordered vs max number of attendees that can register
+		if ($valid['total_tickets'] > $valid['max_atndz']) {
+			// ordering too many tickets !!!
+			$total_tickets_string = _n(
+				'You have attempted to purchase %s ticket.',
+				'You have attempted to purchase %s tickets.',
+				$valid['total_tickets'],
+				'event_espresso'
+			);
+			$limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
+			// dev only message
+			$max_atndz_string = _n(
+				'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				$valid['max_atndz'],
+				'event_espresso'
+			);
+			$limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
+			\EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			// all data appears to be valid
+			$tckts_slctd = false;
+			$tickets_added = 0;
+			$valid = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data', $valid);
+			if ($valid['total_tickets'] > 0) {
+				// load cart
+				\EE_Registry::instance()->load_core('Cart');
+				// cycle thru the number of data rows sent from the event listing
+				for ($x = 0; $x < $valid['rows']; $x++) {
+					// does this row actually contain a ticket quantity?
+					if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
+						// YES we have a ticket quantity
+						$tckts_slctd = true;
+						//						d( $valid['ticket_obj'][$x] );
+						if ($valid['ticket_obj'][$x] instanceof \EE_Ticket) {
+							// then add ticket to cart
+							$tickets_added += $this->addTicketToCart(
+								$valid['ticket_obj'][$x],
+								$valid['qty'][$x]
+							);
+							if (\EE_Error::has_error()) {
+								break;
+							}
+						} else {
+							// nothing added to cart retrieved
+							\EE_Error::add_error(
+								sprintf(
+									__(
+										'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
+										'event_espresso'
+									),
+									'<br/>'
+								),
+								__FILE__, __FUNCTION__, __LINE__
+							);
+						}
+					}
+				}
+			}
+			do_action(
+				'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+				\EE_Registry::instance()->CART,
+				$this
+			);
+			//d( \EE_Registry::instance()->CART );
+			//die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
+			if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) {
+				if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
+					do_action(
+						'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
+						\EE_Registry::instance()->CART,
+						$this
+					);
+					\EE_Registry::instance()->CART->recalculate_all_cart_totals();
+					\EE_Registry::instance()->CART->save_cart(false);
+					// exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
+					// just return TRUE for registrations being made from admin
+					if (is_admin()) {
+						return true;
+					}
+					\EE_Error::get_notices(false, true);
+					wp_safe_redirect(
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
+							\EE_Registry::instance()->CFG->core->reg_page_url()
+						)
+					);
+					exit();
+				} else {
+					if ( ! \EE_Error::has_error() && ! \EE_Error::has_error(true, 'attention')) {
+						// nothing added to cart
+						\EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'),
+							__FILE__, __FUNCTION__, __LINE__);
+					}
+				}
+			} else {
+				// no ticket quantities were selected
+				\EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.',
+					'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		//die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
+		// at this point, just return if registration is being made from admin
+		if (is_admin()) {
+			return false;
+		}
+		if ($valid['return_url']) {
+			\EE_Error::get_notices(false, true);
+			wp_safe_redirect($valid['return_url']);
+			exit();
+		} elseif (isset($event_to_add['id'])) {
+			\EE_Error::get_notices(false, true);
+			wp_safe_redirect(get_permalink($event_to_add['id']));
+			exit();
+		} else {
+			echo \EE_Error::get_notices();
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * validate_post_data
+	 *
+	 * @param int $id
+	 * @return array|FALSE
+	 */
+	private function validatePostData($id = 0)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! $id) {
+			\EE_Error::add_error(
+				__('The event id provided was not valid.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// start with an empty array()
+		$valid_data = array();
+		// grab valid id
+		$valid_data['id'] = $id;
+		// array of other form names
+		$inputs_to_clean = array(
+			'event_id'   => 'tkt-slctr-event-id',
+			'max_atndz'  => 'tkt-slctr-max-atndz-',
+			'rows'       => 'tkt-slctr-rows-',
+			'qty'        => 'tkt-slctr-qty-',
+			'ticket_id'  => 'tkt-slctr-ticket-id-',
+			'return_url' => 'tkt-slctr-return-url-',
+		);
+		// let's track the total number of tickets ordered.'
+		$valid_data['total_tickets'] = 0;
+		// cycle through $inputs_to_clean array
+		foreach ($inputs_to_clean as $what => $input_to_clean) {
+			// check for POST data
+			if (\EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
+				// grab value
+				$input_value = \EE_Registry::instance()->REQ->get($input_to_clean . $id);
+				switch ($what) {
+					// integers
+					case 'event_id':
+						$valid_data[$what] = absint($input_value);
+						// get event via the event id we put in the form
+						$valid_data['event'] = \EE_Registry::instance()
+														   ->load_model('Event')
+														   ->get_one_by_ID($valid_data['event_id']);
+						break;
+					case 'rows':
+					case 'max_atndz':
+						$valid_data[$what] = absint($input_value);
+						break;
+					// arrays of integers
+					case 'qty':
+						/** @var array $row_qty */
+						$row_qty = $input_value;
+						// if qty is coming from a radio button input, then we need to assemble an array of rows
+						if ( ! is_array($row_qty)) {
+							// get number of rows
+							$rows = \EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
+								? absint(\EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
+								: 1;
+							// explode ints by the dash
+							$row_qty = explode('-', $row_qty);
+							$row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
+							$qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
+							$row_qty = array($row => $qty);
+							for ($x = 1; $x <= $rows; $x++) {
+								if ( ! isset($row_qty[$x])) {
+									$row_qty[$x] = 0;
+								}
+							}
+						}
+						ksort($row_qty);
+						// cycle thru values
+						foreach ($row_qty as $qty) {
+							$qty = absint($qty);
+							// sanitize as integers
+							$valid_data[$what][] = $qty;
+							$valid_data['total_tickets'] += $qty;
+						}
+						break;
+					// array of integers
+					case 'ticket_id':
+						$value_array = array();
+						// cycle thru values
+						foreach ((array)$input_value as $key => $value) {
+							// allow only numbers, letters,  spaces, commas and dashes
+							$value_array[$key] = wp_strip_all_tags($value);
+							// get ticket via the ticket id we put in the form
+							$ticket_obj = \EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($value);
+							$valid_data['ticket_obj'][$key] = $ticket_obj;
+						}
+						$valid_data[$what] = $value_array;
+						break;
+					case 'return_url' :
+						// grab and sanitize return-url
+						$input_value = esc_url_raw($input_value);
+						// was the request coming from an iframe ? if so, then:
+						if (strpos($input_value, 'event_list=iframe')) {
+							// get anchor fragment
+							$input_value = explode('#', $input_value);
+							$input_value = end($input_value);
+							// use event list url instead, but append anchor
+							$input_value = \EEH_Event_View::event_archive_url() . '#' . $input_value;
+						}
+						$valid_data[$what] = $input_value;
+						break;
+				}    // end switch $what
+			}
+		}    // end foreach $inputs_to_clean
+		return $valid_data;
+	}
+
+
+
+	/**
+	 * adds a ticket to the cart
+	 *
+	 * @param \EE_Ticket $ticket
+	 * @param int        $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	private function addTicketToCart(\EE_Ticket $ticket = null, $qty = 1)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// get the number of spaces left for this datetime ticket
+		$available_spaces = $this->ticketDatetimeAvailability($ticket);
+		// compare available spaces against the number of tickets being purchased
+		if ($available_spaces >= $qty) {
+			// allow addons to prevent a ticket from being added to cart
+			if (
+			! apply_filters(
+				'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
+				true,
+				$ticket,
+				$qty,
+				$available_spaces
+			)
+			) {
+				return false;
+			}
+			$qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
+			// add event to cart
+			if (\EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) {
+				$this->recalculateTicketDatetimeAvailability($ticket, $qty);
+				return true;
+			}
+			return false;
+		}
+		// tickets can not be purchased but let's find the exact number left
+		// for the last ticket selected PRIOR to subtracting tickets
+		$available_spaces = $this->ticketDatetimeAvailability($ticket, true);
+		// greedy greedy greedy eh?
+		if ($available_spaces > 0) {
+			if (
+			apply_filters(
+				'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
+				true,
+				$ticket,
+				$qty,
+				$available_spaces
+			)
+			) {
+				$this->displayAvailabilityError($available_spaces);
+			}
+		} else {
+			\EE_Error::add_error(
+				__(
+					'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param int $available_spaces
+	 * @throws \EE_Error
+	 */
+	private function displayAvailabilityError($available_spaces = 1)
+	{
+		// add error messaging - we're using the _n function that will generate
+		// the appropriate singular or plural message based on the number of $available_spaces
+		if (\EE_Registry::instance()->CART->all_ticket_quantity_count()) {
+			$msg = sprintf(
+				_n(
+					'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+					'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+					$available_spaces,
+					'event_espresso'
+				),
+				$available_spaces,
+				'<br />'
+			);
+		} else {
+			$msg = sprintf(
+				_n(
+					'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+					'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+					$available_spaces,
+					'event_espresso'
+				),
+				$available_spaces,
+				'<br />'
+			);
+		}
+		\EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+	}
+
+
+
+	/**
+	 * ticketDatetimeAvailability
+	 * creates an array of tickets plus all of the datetimes available to each ticket
+	 * and tracks the spaces remaining for each of those datetimes
+	 *
+	 * @param \EE_Ticket $ticket - selected ticket
+	 * @param bool       $get_original_ticket_spaces
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	private function ticketDatetimeAvailability(\EE_Ticket $ticket, $get_original_ticket_spaces = false)
+	{
+		// if the $_available_spaces array has not been set up yet...
+		if ( ! isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
+			$this->setInitialTicketDatetimeAvailability($ticket);
+		}
+		$available_spaces = $ticket->qty() - $ticket->sold();
+		if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
+				// if we want the original datetime availability BEFORE we started subtracting tickets ?
+				if ($get_original_ticket_spaces) {
+					// then grab the available spaces from the "tickets" array
+					// and compare with the above to get the lowest number
+					$available_spaces = min(
+						$available_spaces,
+						self::$_available_spaces['tickets'][$ticket->ID()][$DTD_ID]
+					);
+				} else {
+					// we want the updated ticket availability as stored in the "datetimes" array
+					$available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][$DTD_ID]);
+				}
+			}
+		}
+		return $available_spaces;
+	}
+
+
+
+	/**
+	 * @param \EE_Ticket $ticket
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function setInitialTicketDatetimeAvailability(\EE_Ticket $ticket)
+	{
+		// first, get all of the datetimes that are available to this ticket
+		$datetimes = $ticket->get_many_related(
+			'Datetime',
+			array(
+				array(
+					'DTT_EVT_end' => array(
+						'>=',
+						\EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+					),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+		if ( ! empty($datetimes)) {
+			// now loop thru all of the datetimes
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof \EE_Datetime) {
+					// the number of spaces available for the datetime without considering individual ticket quantities
+					$spaces_remaining = $datetime->spaces_remaining();
+					// save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
+					// or the datetime spaces remaining) to this ticket using the datetime ID as the key
+					self::$_available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min(
+						$ticket->qty() - $ticket->sold(),
+						$spaces_remaining
+					);
+					// if the remaining spaces for this datetime is already set,
+					// then compare that against the datetime spaces remaining, and take the lowest number,
+					// else just take the datetime spaces remaining, and assign to the datetimes array
+					self::$_available_spaces['datetimes'][$datetime->ID()] = isset(
+						self::$_available_spaces['datetimes'][$datetime->ID()]
+					)
+						? min(self::$_available_spaces['datetimes'][$datetime->ID()], $spaces_remaining)
+						: $spaces_remaining;
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * @param    \EE_Ticket $ticket
+	 * @param    int        $qty
+	 * @return    void
+	 */
+	private function recalculateTicketDatetimeAvailability(\EE_Ticket $ticket, $qty = 0)
+	{
+		if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
+				// subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
+				self::$_available_spaces['datetimes'][$DTD_ID] -= $qty;
+			}
+		}
+	}
 
 
 }

Spacing +8 added lines, -8 removed lines

@@ -49,7 +49,7 @@ 
             );
         } else {
             wp_safe_redirect(
-                site_url('/' . \EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
+                site_url('/'.\EE_Registry::instance()->CFG->core->event_cpt_slug.'/')
             );
         }
         exit();
@@ -165,7 +165,7 @@ 
                 'event_espresso'
             );
             $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
-            \EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+            \EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__);
         } else {
             // all data appears to be valid
             $tckts_slctd = false;
@@ -305,9 +305,9 @@ 
         // cycle through $inputs_to_clean array
         foreach ($inputs_to_clean as $what => $input_to_clean) {
             // check for POST data
-            if (\EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
+            if (\EE_Registry::instance()->REQ->is_set($input_to_clean.$id)) {
                 // grab value
-                $input_value = \EE_Registry::instance()->REQ->get($input_to_clean . $id);
+                $input_value = \EE_Registry::instance()->REQ->get($input_to_clean.$id);
                 switch ($what) {
                     // integers
                     case 'event_id':
@@ -328,8 +328,8 @@ 
                         // if qty is coming from a radio button input, then we need to assemble an array of rows
                         if ( ! is_array($row_qty)) {
                             // get number of rows
-                            $rows = \EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
-                                ? absint(\EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
+                            $rows = \EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-'.$id)
+                                ? absint(\EE_Registry::instance()->REQ->get('tkt-slctr-rows-'.$id))
                                 : 1;
                             // explode ints by the dash
                             $row_qty = explode('-', $row_qty);
@@ -355,7 +355,7 @@ 
                     case 'ticket_id':
                         $value_array = array();
                         // cycle thru values
-                        foreach ((array)$input_value as $key => $value) {
+                        foreach ((array) $input_value as $key => $value) {
                             // allow only numbers, letters,  spaces, commas and dashes
                             $value_array[$key] = wp_strip_all_tags($value);
                             // get ticket via the ticket id we put in the form
@@ -373,7 +373,7 @@ 
                             $input_value = explode('#', $input_value);
                             $input_value = end($input_value);
                             // use event list url instead, but append anchor
-                            $input_value = \EEH_Event_View::event_archive_url() . '#' . $input_value;
+                            $input_value = \EEH_Event_View::event_archive_url().'#'.$input_value;
                         }
                         $valid_data[$what] = $input_value;
                         break;