eventespresso / event-espresso-core

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

Indentation +110 added lines, -110 removed lines

@@ -11,7 +11,7 @@ 
 use EventEspresso\core\libraries\rest_api\ModelDataTranslator;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -28,124 +28,124 @@ 
 {
 
 
-    /**
-     * @param \WP_REST_Request $request
-     * @param string           $version
-     * @return array|\WP_REST_Response
-     */
-    public static function handleRequestModelsMeta(\WP_REST_Request $request, $version)
-    {
-        $controller = new Meta();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse($controller->getModelsMetadataEntity());
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * @param \WP_REST_Request $request
+	 * @param string           $version
+	 * @return array|\WP_REST_Response
+	 */
+	public static function handleRequestModelsMeta(\WP_REST_Request $request, $version)
+	{
+		$controller = new Meta();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse($controller->getModelsMetadataEntity());
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
 
-    /*
+	/*
      * Gets the model metadata resource entity
      * @return array for JSON response, describing all the models available in teh requested version
      */
-    protected function getModelsMetadataEntity()
-    {
-        $response = array();
-        foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) {
-            $model = $this->getModelVersionInfo()->loadModel($model_name);
-            $fields_json = array();
-            foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) {
-                if ($this->getModelVersionInfo()->fieldIsIgnored($field_obj)) {
-                    continue;
-                }
-                if ($field_obj instanceof EE_Boolean_Field) {
-                    $datatype = 'Boolean';
-                } elseif ($field_obj->get_wpdb_data_type() == '%d') {
-                    $datatype = 'Number';
-                } elseif ($field_name instanceof EE_Serialized_Text_Field) {
-                    $datatype = 'Object';
-                } else {
-                    $datatype = 'String';
-                }
-                $default_value = ModelDataTranslator::prepareFieldValueForJson(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-                $field_json = array(
-                    'name'                => $field_name,
-                    'nicename'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
-                    'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
-                    'has_pretty_format'   => $this->getModelVersionInfo()->fieldHasPrettyFormat($field_obj),
-                    'type'                => str_replace('EE_', '', get_class($field_obj)),
-                    'datatype'            => $datatype,
-                    'nullable'            => $field_obj->is_nullable(),
-                    'default'             => $default_value,
-                    'table_alias'         => $field_obj->get_table_alias(),
-                    'table_column'        => $field_obj->get_table_column(),
-                );
-                $fields_json[$field_json['name']] = $field_json;
-            }
-            $fields_json = array_merge(
-                $fields_json,
-                $this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
-            );
-            $response[$model_name]['fields'] = apply_filters(
-                'FHEE__Meta__handle_request_models_meta__fields',
-                $fields_json,
-                $model
-            );
-            $relations_json = array();
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-                $relation_json = array(
-                    'name'   => $relation_name,
-                    'type'   => str_replace('EE_', '', get_class($relation_obj)),
-                    'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
-                );
-                $relations_json[$relation_name] = $relation_json;
-            }
-            $response[$model_name]['relations'] = apply_filters(
-                'FHEE__Meta__handle_request_models_meta__relations',
-                $relations_json,
-                $model
-            );
-        }
-        return $response;
-    }
+	protected function getModelsMetadataEntity()
+	{
+		$response = array();
+		foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) {
+			$model = $this->getModelVersionInfo()->loadModel($model_name);
+			$fields_json = array();
+			foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) {
+				if ($this->getModelVersionInfo()->fieldIsIgnored($field_obj)) {
+					continue;
+				}
+				if ($field_obj instanceof EE_Boolean_Field) {
+					$datatype = 'Boolean';
+				} elseif ($field_obj->get_wpdb_data_type() == '%d') {
+					$datatype = 'Number';
+				} elseif ($field_name instanceof EE_Serialized_Text_Field) {
+					$datatype = 'Object';
+				} else {
+					$datatype = 'String';
+				}
+				$default_value = ModelDataTranslator::prepareFieldValueForJson(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+				$field_json = array(
+					'name'                => $field_name,
+					'nicename'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
+					'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
+					'has_pretty_format'   => $this->getModelVersionInfo()->fieldHasPrettyFormat($field_obj),
+					'type'                => str_replace('EE_', '', get_class($field_obj)),
+					'datatype'            => $datatype,
+					'nullable'            => $field_obj->is_nullable(),
+					'default'             => $default_value,
+					'table_alias'         => $field_obj->get_table_alias(),
+					'table_column'        => $field_obj->get_table_column(),
+				);
+				$fields_json[$field_json['name']] = $field_json;
+			}
+			$fields_json = array_merge(
+				$fields_json,
+				$this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
+			);
+			$response[$model_name]['fields'] = apply_filters(
+				'FHEE__Meta__handle_request_models_meta__fields',
+				$fields_json,
+				$model
+			);
+			$relations_json = array();
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+				$relation_json = array(
+					'name'   => $relation_name,
+					'type'   => str_replace('EE_', '', get_class($relation_obj)),
+					'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
+				);
+				$relations_json[$relation_name] = $relation_json;
+			}
+			$response[$model_name]['relations'] = apply_filters(
+				'FHEE__Meta__handle_request_models_meta__relations',
+				$relations_json,
+				$model
+			);
+		}
+		return $response;
+	}
 
 
 
-    /**
-     * Adds EE metadata to the index
-     *
-     * @param \WP_REST_Response $rest_response_obj
-     * @return \WP_REST_Response
-     */
-    public static function filterEeMetadataIntoIndex(\WP_REST_Response $rest_response_obj)
-    {
-        $response_data = $rest_response_obj->get_data();
-        $addons = array();
-        foreach (EE_Registry::instance()->addons as $addon) {
-            $addon_json = array(
-                'name'    => $addon->name(),
-                'version' => $addon->version(),
-            );
-            $addons[$addon_json['name']] = $addon_json;
-        }
-        $response_data['ee'] = array(
-            'version'              => EEM_System_Status::instance()->get_ee_version(),
-            // @codingStandardsIgnoreStart
-            'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
-            // @codingStandardsIgnoreEnd
-            'addons'               => $addons,
-            'maintenance_mode'     => EE_Maintenance_Mode::instance()->real_level(),
-            'served_core_versions' => array_keys(EED_Core_Rest_Api::versions_served()),
-        );
-        $rest_response_obj->set_data($response_data);
-        return $rest_response_obj;
-    }
+	/**
+	 * Adds EE metadata to the index
+	 *
+	 * @param \WP_REST_Response $rest_response_obj
+	 * @return \WP_REST_Response
+	 */
+	public static function filterEeMetadataIntoIndex(\WP_REST_Response $rest_response_obj)
+	{
+		$response_data = $rest_response_obj->get_data();
+		$addons = array();
+		foreach (EE_Registry::instance()->addons as $addon) {
+			$addon_json = array(
+				'name'    => $addon->name(),
+				'version' => $addon->version(),
+			);
+			$addons[$addon_json['name']] = $addon_json;
+		}
+		$response_data['ee'] = array(
+			'version'              => EEM_System_Status::instance()->get_ee_version(),
+			// @codingStandardsIgnoreStart
+			'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
+			// @codingStandardsIgnoreEnd
+			'addons'               => $addons,
+			'maintenance_mode'     => EE_Maintenance_Mode::instance()->real_level(),
+			'served_core_versions' => array_keys(EED_Core_Rest_Api::versions_served()),
+		);
+		$rest_response_obj->set_data($response_data);
+		return $rest_response_obj;
+	}
 }
 
 

core/db_classes/EE_Attendee.class.php

Indentation +665 added lines, -665 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -23,670 +23,670 @@ 
 class EE_Attendee extends EE_CPT_Base implements EEI_Contact, EEI_Address, EEI_Admin_Links, EEI_Attendee
 {
 
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats
-     */
-    protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
-    {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
-            $lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
-        }
-        if (! isset($fieldValues['ATT_slug'])) {
-            //			$fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
-            $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
-        }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
-            $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
-        }
-        parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Attendee First Name
-     *
-     * @access        public
-     * @param string $fname
-     */
-    public function set_fname($fname = '')
-    {
-        $this->set('ATT_fname', $fname);
-    }
-
-
-    /**
-     *        Set Attendee Last Name
-     *
-     * @access        public
-     * @param string $lname
-     */
-    public function set_lname($lname = '')
-    {
-        $this->set('ATT_lname', $lname);
-    }
-
-
-    /**
-     *        Set Attendee Address
-     *
-     * @access        public
-     * @param string $address
-     */
-    public function set_address($address = '')
-    {
-        $this->set('ATT_address', $address);
-    }
-
-
-    /**
-     *        Set Attendee Address2
-     *
-     * @access        public
-     * @param        string $address2
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('ATT_address2', $address2);
-    }
-
-
-    /**
-     *        Set Attendee City
-     *
-     * @access        public
-     * @param        string $city
-     */
-    public function set_city($city = '')
-    {
-        $this->set('ATT_city', $city);
-    }
-
-
-    /**
-     *        Set Attendee State ID
-     *
-     * @access        public
-     * @param        int $STA_ID
-     */
-    public function set_state($STA_ID = 0)
-    {
-        $this->set('STA_ID', $STA_ID);
-    }
-
-
-    /**
-     *        Set Attendee Country ISO Code
-     *
-     * @access        public
-     * @param        string $CNT_ISO
-     */
-    public function set_country($CNT_ISO = '')
-    {
-        $this->set('CNT_ISO', $CNT_ISO);
-    }
-
-
-    /**
-     *        Set Attendee Zip/Postal Code
-     *
-     * @access        public
-     * @param        string $zip
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('ATT_zip', $zip);
-    }
-
-
-    /**
-     *        Set Attendee Email Address
-     *
-     * @access        public
-     * @param        string $email
-     */
-    public function set_email($email = '')
-    {
-        $this->set('ATT_email', $email);
-    }
-
-
-    /**
-     *        Set Attendee Phone
-     *
-     * @access        public
-     * @param        string $phone
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('ATT_phone', $phone);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $ATT_deleted
-     */
-    public function set_deleted($ATT_deleted = false)
-    {
-        $this->set('ATT_deleted', $ATT_deleted);
-    }
-
-
-    /**
-     * Returns the value for the post_author id saved with the cpt
-     *
-     * @since 4.5.0
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('ATT_author');
-    }
-
-
-    /**
-     *        get Attendee First Name
-     *
-     * @access        public
-     * @return string
-     */
-    public function fname()
-    {
-        return $this->get('ATT_fname');
-    }
-
-
-    /**
-     * echoes out the attendee's first name
-     *
-     * @return void
-     */
-    public function e_full_name()
-    {
-        echo $this->full_name();
-    }
-
-
-    /**
-     * Returns the first and last name concatenated together with a space.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     */
-    public function full_name($apply_html_entities = false)
-    {
-        $full_name = array(
-            $this->fname(),
-            $this->lname()
-        );
-        $full_name = array_filter($full_name);
-        $full_name = implode(' ', $full_name);
-        return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
-    }
-
-
-    /**
-     * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
-     * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
-     * attendee.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     */
-    public function ATT_full_name($apply_html_entities = false)
-    {
-        return $apply_html_entities
-            ? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
-            : $this->get('ATT_full_name');
-    }
-
-
-    /**
-     *        get Attendee Last Name
-     *
-     * @access        public
-     * @return string
-     */
-    public function lname()
-    {
-        return $this->get('ATT_lname');
-    }
-
-
-    /**
-     * Gets the attendee's full address as an array so client code can decide hwo to display it
-     *
-     * @return array numerically indexed, with each part of the address that is known.
-     * Eg, if the user only responded to state and country,
-     * it would be array(0=>'Alabama',1=>'USA')
-     * @return array
-     */
-    public function full_address_as_array()
-    {
-        $full_address_array     = array();
-        $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
-        foreach ($initial_address_fields as $address_field_name) {
-            $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
-                $full_address_array[] = $address_fields_value;
-            }
-        }
-        //now handle state and country
-        $state_obj = $this->state_obj();
-        if (! empty($state_obj)) {
-            $full_address_array[] = $state_obj->name();
-        }
-        $country_obj = $this->country_obj();
-        if (! empty($country_obj)) {
-            $full_address_array[] = $country_obj->name();
-        }
-        //lastly get the xip
-        $zip_value = $this->zip();
-        if (! empty($zip_value)) {
-            $full_address_array[] = $zip_value;
-        }
-        return $full_address_array;
-    }
-
-
-    /**
-     *        get Attendee Address
-     *
-     * @return string
-     */
-    public function address()
-    {
-        return $this->get('ATT_address');
-    }
-
-
-    /**
-     *        get Attendee Address2
-     *
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->get('ATT_address2');
-    }
-
-
-    /**
-     *        get Attendee City
-     *
-     * @return string
-     */
-    public function city()
-    {
-        return $this->get('ATT_city');
-    }
-
-
-    /**
-     *        get Attendee State ID
-     *
-     * @return string
-     */
-    public function state_ID()
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * Gets the state set to this attendee
-     *
-     * @return EE_State
-     */
-    public function state_obj()
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * Returns the state's name, otherwise 'Unknown'
-     *
-     * @return string
-     */
-    public function state_name()
-    {
-        if ($this->state_obj()) {
-            return $this->state_obj()->name();
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     *    get Attendee Country ISO Code
-     *
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * Gets country set for this attendee
-     *
-     * @return EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * Returns the country's name if known, otherwise 'Unknown'
-     *
-     * @return string
-     */
-    public function country_name()
-    {
-        if ($this->country_obj()) {
-            return $this->country_obj()->name();
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     *        get Attendee Zip/Postal Code
-     *
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->get('ATT_zip');
-    }
-
-
-    /**
-     *        get Attendee Email Address
-     *
-     * @return string
-     */
-    public function email()
-    {
-        return $this->get('ATT_email');
-    }
-
-
-    /**
-     *        get Attendee Phone #
-     *
-     * @return string
-     */
-    public function phone()
-    {
-        return $this->get('ATT_phone');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @return        bool
-     */
-    public function deleted()
-    {
-        return $this->get('ATT_deleted');
-    }
-
-
-    /**
-     * Gets registrations of this attendee
-     *
-     * @param array $query_params
-     * @return EE_Registration[]
-     */
-    public function get_registrations($query_params = array())
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets the most recent registration of this attendee
-     *
-     * @return EE_Registration
-     */
-    public function get_most_recent_registration()
-    {
-        return $this->get_first_related('Registration',
-            array('order_by' => array('REG_date' => 'DESC'))); //null, 'REG_date', 'DESC', '=', 'OBJECT_K');
-    }
-
-
-    /**
-     * Gets the most recent registration for this attend at this event
-     *
-     * @param int $event_id
-     * @return EE_Registration
-     */
-    public function get_most_recent_registration_for_event($event_id)
-    {
-        return $this->get_first_related('Registration',
-            array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC')));//, '=', 'OBJECT_K' );
-    }
-
-
-    /**
-     * returns any events attached to this attendee ($_Event property);
-     *
-     * @return array
-     */
-    public function events()
-    {
-        return $this->get_many_related('Event');
-    }
-
-
-    /**
-     * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
-     * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
-     * used to save the billing info
-     *
-     * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
-     * @return EE_Form_Section_Proper|null
-     */
-    public function billing_info_for_payment_method($payment_method)
-    {
-        $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
-            return null;
-        }
-        $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
-            return null;
-        }
-        $billing_form = $pm_type->billing_form();
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            $billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
-        }
-        return $billing_form;
-    }
-
-
-    /**
-     * Gets the postmeta key that holds this attendee's billing info for the
-     * specified payment method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     */
-    public function get_billing_info_postmeta_name($payment_method)
-    {
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
-     * retrieve it
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Payment_Method             $payment_method
-     * @return boolean
-     */
-    public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
-    {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
-            EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
-            return false;
-        }
-        $billing_form->clean_sensitive_data();
-        return update_post_meta($this->ID(), $this->get_billing_info_postmeta_name($payment_method),
-            $billing_form->input_values(true));
-    }
-
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'edit_attendee',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'contact_list',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats
+	 */
+	protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
+	{
+		if (! isset($fieldValues['ATT_full_name'])) {
+			$fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+			$lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
+			$fieldValues['ATT_full_name'] = $fname . $lname;
+		}
+		if (! isset($fieldValues['ATT_slug'])) {
+			//			$fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
+			$fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
+		}
+		if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+			$fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
+		}
+		parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Attendee First Name
+	 *
+	 * @access        public
+	 * @param string $fname
+	 */
+	public function set_fname($fname = '')
+	{
+		$this->set('ATT_fname', $fname);
+	}
+
+
+	/**
+	 *        Set Attendee Last Name
+	 *
+	 * @access        public
+	 * @param string $lname
+	 */
+	public function set_lname($lname = '')
+	{
+		$this->set('ATT_lname', $lname);
+	}
+
+
+	/**
+	 *        Set Attendee Address
+	 *
+	 * @access        public
+	 * @param string $address
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('ATT_address', $address);
+	}
+
+
+	/**
+	 *        Set Attendee Address2
+	 *
+	 * @access        public
+	 * @param        string $address2
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('ATT_address2', $address2);
+	}
+
+
+	/**
+	 *        Set Attendee City
+	 *
+	 * @access        public
+	 * @param        string $city
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('ATT_city', $city);
+	}
+
+
+	/**
+	 *        Set Attendee State ID
+	 *
+	 * @access        public
+	 * @param        int $STA_ID
+	 */
+	public function set_state($STA_ID = 0)
+	{
+		$this->set('STA_ID', $STA_ID);
+	}
+
+
+	/**
+	 *        Set Attendee Country ISO Code
+	 *
+	 * @access        public
+	 * @param        string $CNT_ISO
+	 */
+	public function set_country($CNT_ISO = '')
+	{
+		$this->set('CNT_ISO', $CNT_ISO);
+	}
+
+
+	/**
+	 *        Set Attendee Zip/Postal Code
+	 *
+	 * @access        public
+	 * @param        string $zip
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('ATT_zip', $zip);
+	}
+
+
+	/**
+	 *        Set Attendee Email Address
+	 *
+	 * @access        public
+	 * @param        string $email
+	 */
+	public function set_email($email = '')
+	{
+		$this->set('ATT_email', $email);
+	}
+
+
+	/**
+	 *        Set Attendee Phone
+	 *
+	 * @access        public
+	 * @param        string $phone
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('ATT_phone', $phone);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $ATT_deleted
+	 */
+	public function set_deleted($ATT_deleted = false)
+	{
+		$this->set('ATT_deleted', $ATT_deleted);
+	}
+
+
+	/**
+	 * Returns the value for the post_author id saved with the cpt
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('ATT_author');
+	}
+
+
+	/**
+	 *        get Attendee First Name
+	 *
+	 * @access        public
+	 * @return string
+	 */
+	public function fname()
+	{
+		return $this->get('ATT_fname');
+	}
+
+
+	/**
+	 * echoes out the attendee's first name
+	 *
+	 * @return void
+	 */
+	public function e_full_name()
+	{
+		echo $this->full_name();
+	}
+
+
+	/**
+	 * Returns the first and last name concatenated together with a space.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 */
+	public function full_name($apply_html_entities = false)
+	{
+		$full_name = array(
+			$this->fname(),
+			$this->lname()
+		);
+		$full_name = array_filter($full_name);
+		$full_name = implode(' ', $full_name);
+		return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
+	}
+
+
+	/**
+	 * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
+	 * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
+	 * attendee.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 */
+	public function ATT_full_name($apply_html_entities = false)
+	{
+		return $apply_html_entities
+			? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
+			: $this->get('ATT_full_name');
+	}
+
+
+	/**
+	 *        get Attendee Last Name
+	 *
+	 * @access        public
+	 * @return string
+	 */
+	public function lname()
+	{
+		return $this->get('ATT_lname');
+	}
+
+
+	/**
+	 * Gets the attendee's full address as an array so client code can decide hwo to display it
+	 *
+	 * @return array numerically indexed, with each part of the address that is known.
+	 * Eg, if the user only responded to state and country,
+	 * it would be array(0=>'Alabama',1=>'USA')
+	 * @return array
+	 */
+	public function full_address_as_array()
+	{
+		$full_address_array     = array();
+		$initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
+		foreach ($initial_address_fields as $address_field_name) {
+			$address_fields_value = $this->get($address_field_name);
+			if (! empty($address_fields_value)) {
+				$full_address_array[] = $address_fields_value;
+			}
+		}
+		//now handle state and country
+		$state_obj = $this->state_obj();
+		if (! empty($state_obj)) {
+			$full_address_array[] = $state_obj->name();
+		}
+		$country_obj = $this->country_obj();
+		if (! empty($country_obj)) {
+			$full_address_array[] = $country_obj->name();
+		}
+		//lastly get the xip
+		$zip_value = $this->zip();
+		if (! empty($zip_value)) {
+			$full_address_array[] = $zip_value;
+		}
+		return $full_address_array;
+	}
+
+
+	/**
+	 *        get Attendee Address
+	 *
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->get('ATT_address');
+	}
+
+
+	/**
+	 *        get Attendee Address2
+	 *
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->get('ATT_address2');
+	}
+
+
+	/**
+	 *        get Attendee City
+	 *
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->get('ATT_city');
+	}
+
+
+	/**
+	 *        get Attendee State ID
+	 *
+	 * @return string
+	 */
+	public function state_ID()
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * Gets the state set to this attendee
+	 *
+	 * @return EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * Returns the state's name, otherwise 'Unknown'
+	 *
+	 * @return string
+	 */
+	public function state_name()
+	{
+		if ($this->state_obj()) {
+			return $this->state_obj()->name();
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 *    get Attendee Country ISO Code
+	 *
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * Gets country set for this attendee
+	 *
+	 * @return EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * Returns the country's name if known, otherwise 'Unknown'
+	 *
+	 * @return string
+	 */
+	public function country_name()
+	{
+		if ($this->country_obj()) {
+			return $this->country_obj()->name();
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 *        get Attendee Zip/Postal Code
+	 *
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->get('ATT_zip');
+	}
+
+
+	/**
+	 *        get Attendee Email Address
+	 *
+	 * @return string
+	 */
+	public function email()
+	{
+		return $this->get('ATT_email');
+	}
+
+
+	/**
+	 *        get Attendee Phone #
+	 *
+	 * @return string
+	 */
+	public function phone()
+	{
+		return $this->get('ATT_phone');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @return        bool
+	 */
+	public function deleted()
+	{
+		return $this->get('ATT_deleted');
+	}
+
+
+	/**
+	 * Gets registrations of this attendee
+	 *
+	 * @param array $query_params
+	 * @return EE_Registration[]
+	 */
+	public function get_registrations($query_params = array())
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets the most recent registration of this attendee
+	 *
+	 * @return EE_Registration
+	 */
+	public function get_most_recent_registration()
+	{
+		return $this->get_first_related('Registration',
+			array('order_by' => array('REG_date' => 'DESC'))); //null, 'REG_date', 'DESC', '=', 'OBJECT_K');
+	}
+
+
+	/**
+	 * Gets the most recent registration for this attend at this event
+	 *
+	 * @param int $event_id
+	 * @return EE_Registration
+	 */
+	public function get_most_recent_registration_for_event($event_id)
+	{
+		return $this->get_first_related('Registration',
+			array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC')));//, '=', 'OBJECT_K' );
+	}
+
+
+	/**
+	 * returns any events attached to this attendee ($_Event property);
+	 *
+	 * @return array
+	 */
+	public function events()
+	{
+		return $this->get_many_related('Event');
+	}
+
+
+	/**
+	 * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
+	 * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
+	 * used to save the billing info
+	 *
+	 * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
+	 * @return EE_Form_Section_Proper|null
+	 */
+	public function billing_info_for_payment_method($payment_method)
+	{
+		$pm_type = $payment_method->type_obj();
+		if (! $pm_type instanceof EE_PMT_Base) {
+			return null;
+		}
+		$billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
+		if (! $billing_info) {
+			return null;
+		}
+		$billing_form = $pm_type->billing_form();
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			$billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
+		}
+		return $billing_form;
+	}
+
+
+	/**
+	 * Gets the postmeta key that holds this attendee's billing info for the
+	 * specified payment method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 */
+	public function get_billing_info_postmeta_name($payment_method)
+	{
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			return 'billing_info_' . $payment_method->type_obj()->system_name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
+	 * retrieve it
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Payment_Method             $payment_method
+	 * @return boolean
+	 */
+	public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
+	{
+		if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+			EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
+			return false;
+		}
+		$billing_form->clean_sensitive_data();
+		return update_post_meta($this->ID(), $this->get_billing_info_postmeta_name($payment_method),
+			$billing_form->input_values(true));
+	}
+
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'edit_attendee',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'contact_list',
+			),
+			admin_url('admin.php')
+		);
+	}
 
 
 }

Spacing +15 added lines, -15 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 /**
@@ -33,16 +33,16 @@ 
      */
     protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
     {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+        if ( ! isset($fieldValues['ATT_full_name'])) {
+            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'].' ' : '';
             $lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
+            $fieldValues['ATT_full_name'] = $fname.$lname;
         }
-        if (! isset($fieldValues['ATT_slug'])) {
+        if ( ! isset($fieldValues['ATT_slug'])) {
             //			$fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
             $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
         }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+        if ( ! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
             $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
         }
         parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
@@ -303,22 +303,22 @@ 
         $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
         foreach ($initial_address_fields as $address_field_name) {
             $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
+            if ( ! empty($address_fields_value)) {
                 $full_address_array[] = $address_fields_value;
             }
         }
         //now handle state and country
         $state_obj = $this->state_obj();
-        if (! empty($state_obj)) {
+        if ( ! empty($state_obj)) {
             $full_address_array[] = $state_obj->name();
         }
         $country_obj = $this->country_obj();
-        if (! empty($country_obj)) {
+        if ( ! empty($country_obj)) {
             $full_address_array[] = $country_obj->name();
         }
         //lastly get the xip
         $zip_value = $this->zip();
-        if (! empty($zip_value)) {
+        if ( ! empty($zip_value)) {
             $full_address_array[] = $zip_value;
         }
         return $full_address_array;
@@ -552,7 +552,7 @@ 
     public function get_most_recent_registration_for_event($event_id)
     {
         return $this->get_first_related('Registration',
-            array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC')));//, '=', 'OBJECT_K' );
+            array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))); //, '=', 'OBJECT_K' );
     }
 
 
@@ -578,11 +578,11 @@ 
     public function billing_info_for_payment_method($payment_method)
     {
         $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
+        if ( ! $pm_type instanceof EE_PMT_Base) {
             return null;
         }
         $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
+        if ( ! $billing_info) {
             return null;
         }
         $billing_form = $pm_type->billing_form();
@@ -603,7 +603,7 @@ 
     public function get_billing_info_postmeta_name($payment_method)
     {
         if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
+            return 'billing_info_'.$payment_method->type_obj()->system_name();
         } else {
             return null;
         }
@@ -620,7 +620,7 @@ 
      */
     public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
     {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+        if ( ! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
             EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
             return false;
         }

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

Indentation +126 added lines, -126 removed lines

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

Spacing +23 added lines, -23 removed lines

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

core/db_classes/EE_Transaction.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -438,7 +438,7 @@ 
      * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
      * function for getting attendees and how many registrations they each have for an event)
      *
-     * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
+     * @return EE_Base_Class[] EE_Attendee[] by default, int if $output is set to 'COUNT'
      * @throws EE_Error
      */
     public function attendees()
@@ -489,7 +489,7 @@ 
     /**
      * Gets all payments which have not been approved
      *
-     * @return EE_Base_Class[]|EEI_Payment[]
+     * @return EE_Base_Class[]
      * @throws EE_Error if a model is misconfigured somehow
      */
     public function pending_payments()

Indentation +1471 added lines, -1471 removed lines

@@ -17,1477 +17,1477 @@
 class EE_Transaction extends EE_Base_Class implements EEI_Transaction
 {
 
-    /**
-     * The length of time in seconds that a lock is applied before being considered expired.
-     * It is not long because a transaction should only be locked for the duration of the request that locked it
-     */
-    const LOCK_EXPIRATION = 2;
-
-    /**
-     * txn status upon initial construction.
-     *
-     * @var string
-     */
-    protected $_old_txn_status;
-
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone
-     *                                        (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Transaction
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        $txn        = $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
-            $txn->set_old_txn_status($txn->status_ID());
-        }
-        return $txn;
-    }
-
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Transaction
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        $txn = new self($props_n_values, true, $timezone);
-        $txn->set_old_txn_status($txn->status_ID());
-        return $txn;
-    }
-
-
-
-    /**
-     * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
-     * If a lock has already been set, then we will attempt to remove it in case it has expired.
-     * If that also fails, then an exception is thrown.
-     *
-     * @throws EE_Error
-     */
-    public function lock()
-    {
-        // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
-            // then attempt to remove the lock in case it is expired
-            if ($this->_remove_expired_lock()) {
-                // if removal was successful, then try setting lock again
-                $this->lock();
-            } else {
-                // but if the lock can not be removed, then throw an exception
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
-                            'event_espresso'
-                        ),
-                        $this->ID()
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * removes transaction lock applied in EE_Transaction::lock()
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function unlock()
-    {
-        return $this->delete_extra_meta('lock');
-    }
-
-
-
-    /**
-     * Decides whether or not now is the right time to update the transaction.
-     * This is useful because we don't always know if it is safe to update the transaction
-     * and its related data. why?
-     * because it's possible that the transaction is being used in another
-     * request and could overwrite anything we save.
-     * So we want to only update the txn once we know that won't happen.
-     * We also check that the lock isn't expired, and remove it if it is
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_locked()
-    {
-        // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
-            return false;
-        }
-        // if not, then let's try and remove the lock in case it's expired...
-        // _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
-        // and a positive number if the lock was removed (ie: number of locks deleted),
-        // so we need to return the opposite
-        return ! $this->_remove_expired_lock() ? true : false;
-    }
-
-
-
-    /**
-     * Gets the meta field indicating that this TXN is locked
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    protected function _get_lock()
-    {
-        return (int)$this->get_extra_meta('lock', true, 0);
-    }
-
-
-
-    /**
-     * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    protected function _remove_expired_lock()
-    {
-        $locked = $this->_get_lock();
-        if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
-            return $this->unlock();
-        }
-        return 0;
-    }
-
-
-
-    /**
-     * Set transaction total
-     *
-     * @param float $total total value of transaction
-     * @throws EE_Error
-     */
-    public function set_total($total = 0.00)
-    {
-        $this->set('TXN_total', (float)$total);
-    }
-
-
-
-    /**
-     * Set Total Amount Paid to Date
-     *
-     * @param float $total_paid total amount paid to date (sum of all payments)
-     * @throws EE_Error
-     */
-    public function set_paid($total_paid = 0.00)
-    {
-        $this->set('TXN_paid', (float)$total_paid);
-    }
-
-
-
-    /**
-     * Set transaction status
-     *
-     * @param string $status        whether the transaction is open, declined, accepted,
-     *                              or any number of custom values that can be set
-     * @throws EE_Error
-     */
-    public function set_status($status = '')
-    {
-        $this->set('STS_ID', $status);
-    }
-
-
-
-    /**
-     * Set hash salt
-     *
-     * @param string $hash_salt required for some payment gateways
-     * @throws EE_Error
-     */
-    public function set_hash_salt($hash_salt = '')
-    {
-        $this->set('TXN_hash_salt', $hash_salt);
-    }
-
-
-
-    /**
-     * Sets TXN_reg_steps array
-     *
-     * @param array $txn_reg_steps
-     * @throws EE_Error
-     */
-    public function set_reg_steps(array $txn_reg_steps)
-    {
-        $this->set('TXN_reg_steps', $txn_reg_steps);
-    }
-
-
-
-    /**
-     * Gets TXN_reg_steps
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function reg_steps()
-    {
-        $TXN_reg_steps = $this->get('TXN_reg_steps');
-        return is_array($TXN_reg_steps) ? (array)$TXN_reg_steps : array();
-    }
-
-
-
-    /**
-     * @return string of transaction's total cost, with currency symbol and decimal
-     * @throws EE_Error
-     */
-    public function pretty_total()
-    {
-        return $this->get_pretty('TXN_total');
-    }
-
-
-
-    /**
-     * Gets the amount paid in a pretty string (formatted and with currency symbol)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('TXN_paid');
-    }
-
-
-
-    /**
-     * calculate the amount remaining for this transaction and return;
-     *
-     * @return float amount remaining
-     * @throws EE_Error
-     */
-    public function remaining()
-    {
-        return $this->total() - $this->paid();
-    }
-
-
-
-    /**
-     * get Transaction Total
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function total()
-    {
-        return (float)$this->get('TXN_total');
-    }
-
-
-
-    /**
-     * get Total Amount Paid to Date
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function paid()
-    {
-        return (float)$this->get('TXN_paid');
-    }
-
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function get_cart_session()
-    {
-        $session_data = (array)$this->get('TXN_session_data');
-        return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
-            ? $session_data['cart']
-            : null;
-    }
-
-
-
-    /**
-     * get Transaction session data
-     *
-     * @throws EE_Error
-     */
-    public function session_data()
-    {
-        $session_data = $this->get('TXN_session_data');
-        if (empty($session_data)) {
-            $session_data = array(
-                'id'            => null,
-                'user_id'       => null,
-                'ip_address'    => null,
-                'user_agent'    => null,
-                'init_access'   => null,
-                'last_access'   => null,
-                'pages_visited' => array(),
-            );
-        }
-        return $session_data;
-    }
-
-
-
-    /**
-     * Set session data within the TXN object
-     *
-     * @param EE_Session|array $session_data
-     * @throws EE_Error
-     */
-    public function set_txn_session_data($session_data)
-    {
-        if ($session_data instanceof EE_Session) {
-            $this->set('TXN_session_data', $session_data->get_session_data(null, true));
-        } else {
-            $this->set('TXN_session_data', $session_data);
-        }
-    }
-
-
-
-    /**
-     * get Transaction hash salt
-     *
-     * @throws EE_Error
-     */
-    public function hash_salt_()
-    {
-        return $this->get('TXN_hash_salt');
-    }
-
-
-
-    /**
-     * Returns the transaction datetime as either:
-     *            - unix timestamp format ($format = false, $gmt = true)
-     *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
-     *              has no affect with this option)), this also may include a timezone abbreviation if the
-     *              set timezone in this class differs from what the timezone is on the blog.
-     *            - formatted date string including the UTC (timezone) offset (default).
-     *
-     * @param boolean $format - whether to return a unix timestamp (default) or formatted date string
-     * @param boolean $gmt    - whether to return a unix timestamp with UTC offset applied (default)
-     *                          or no UTC offset applied
-     * @return string | int
-     * @throws EE_Error
-     */
-    public function datetime($format = false, $gmt = false)
-    {
-        if ($format) {
-            return $this->get_pretty('TXN_timestamp');
-        }
-        if ($gmt) {
-            return $this->get_raw('TXN_timestamp');
-        }
-        return $this->get('TXN_timestamp');
-    }
-
-
-
-    /**
-     * Gets registrations on this transaction
-     *
-     * @param array   $query_params array of query parameters
-     * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     */
-    public function registrations($query_params = array(), $get_cached = false)
-    {
-        $query_params = (empty($query_params) || ! is_array($query_params))
-            ? array(
-                'order_by' => array(
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC',
-                ),
-            )
-            : $query_params;
-        $query_params = $get_cached ? array() : $query_params;
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-
-    /**
-     * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
-     * function for getting attendees and how many registrations they each have for an event)
-     *
-     * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
-     * @throws EE_Error
-     */
-    public function attendees()
-    {
-        return $this->get_many_related('Attendee', array(array('Registration.Transaction.TXN_ID' => $this->ID())));
-    }
-
-
-
-    /**
-     * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     */
-    public function payments($query_params = array())
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-
-    /**
-     * gets only approved payments for this transaction
-     *
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function approved_payments()
-    {
-        EE_Registry::instance()->load_model('Payment');
-        return $this->get_many_related(
-            'Payment',
-            array(
-                array('STS_ID' => EEM_Payment::status_id_approved),
-                'order_by' => array('PAY_timestamp' => 'DESC'),
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets all payments which have not been approved
-     *
-     * @return EE_Base_Class[]|EEI_Payment[]
-     * @throws EE_Error if a model is misconfigured somehow
-     */
-    public function pending_payments()
-    {
-        return $this->get_many_related(
-            'Payment',
-            array(
-                array(
-                    'STS_ID' => EEM_Payment::status_id_pending,
-                ),
-                'order_by' => array(
-                    'PAY_timestamp' => 'DESC',
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->status_ID() => __('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Transaction::complete_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
-                break;
-            case EEM_Transaction::incomplete_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::abandoned_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Transaction::failed_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Transaction::overpaid_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
-                break;
-        }
-        return $icon . $status[$this->status_ID()];
-    }
-
-
-
-    /**
-     * get Transaction Status
-     *
-     * @throws EE_Error
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-
-    /**
-     * Returns TRUE or FALSE for whether or not this transaction cost any money
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_free()
-    {
-        return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
-    }
-
-
-
-    /**
-     * Returns whether this transaction is complete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_completed()
-    {
-        return $this->status_ID() === EEM_Transaction::complete_status_code;
-    }
-
-
-
-    /**
-     * Returns whether this transaction is incomplete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() === EEM_Transaction::incomplete_status_code;
-    }
-
-
-
-    /**
-     * Returns whether this transaction is overpaid
-     * Useful in templates and other logic for deciding if monies need to be refunded
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_overpaid()
-    {
-        return $this->status_ID() === EEM_Transaction::overpaid_status_code;
-    }
-
-
-
-    /**
-     * Returns whether this transaction was abandoned
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * but that contact information exists for at least one registrant
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_abandoned()
-    {
-        return $this->status_ID() === EEM_Transaction::abandoned_status_code;
-    }
-
-
-
-    /**
-     * Returns whether this transaction failed
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * and that NO contact information exists for any registrants
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function failed()
-    {
-        return $this->status_ID() === EEM_Transaction::failed_status_code;
-    }
-
-
-
-    /**
-     * This returns the url for the invoice of this transaction
-     *
-     * @param string $type 'html' or 'pdf' (default is pdf)
-     * @return string
-     * @throws EE_Error
-     */
-    public function invoice_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->invoice_url($type);
-    }
-
-
-
-    /**
-     * Gets the primary registration only
-     *
-     * @return EE_Base_Class|EE_Registration
-     * @throws EE_Error
-     */
-    public function primary_registration()
-    {
-        $registrations = (array)$this->get_many_related(
-            'Registration',
-            array(array('REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT))
-        );
-        foreach ($registrations as $registration) {
-            // valid registration that is NOT cancelled or declined ?
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
-            ) {
-                return $registration;
-            }
-        }
-        // nothing valid found, so just return first thing from array of results
-        return reset($registrations);
-    }
-
-
-
-    /**
-     * Gets the URL for viewing the receipt
-     *
-     * @param string $type 'pdf' or 'html' (default is 'html')
-     * @return string
-     * @throws EE_Error
-     */
-    public function receipt_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->receipt_url($type);
-    }
-
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_overview_url()
-    {
-        $primary_registration = $this->primary_registration();
-        return $primary_registration instanceof EE_Registration ? $primary_registration->payment_overview_url() : false;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function gateway_response_on_transaction()
-    {
-        $payment = $this->get_first_related('Payment');
-        return $payment instanceof EE_Payment ? $payment->gateway_response() : '';
-    }
-
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Base_Class|EE_Status
-     * @throws EE_Error
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Base_Class[]|EE_Extra_Meta
-     * @throws EE_Error
-     */
-    public function extra_meta($query_params = array())
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     */
-    public function add_registration(EE_Registration $registration)
-    {
-        return $this->_add_relation_to($registration, 'Registration');
-    }
-
-
-
-    /**
-     * Removes the given registration from being related (even before saving this transaction).
-     * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
-     *
-     * @param int $registration_or_id
-     * @return EE_Base_Class that was removed from being related
-     * @throws EE_Error
-     */
-    public function remove_registration_with_id($registration_or_id)
-    {
-        return $this->_remove_relation_to($registration_or_id, 'Registration');
-    }
-
-
-
-    /**
-     * Gets all the line items which are for ACTUAL items
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function items_purchased()
-    {
-        return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_line_item)));
-    }
-
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     */
-    public function add_line_item(EE_Line_Item $line_item)
-    {
-        return $this->_add_relation_to($line_item, 'Line_Item');
-    }
-
-
-
-    /**
-     * Gets ALL the line items related to this transaction (unstructured)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function line_items($query_params = array())
-    {
-        return $this->get_many_related('Line_Item', $query_params);
-    }
-
-
-
-    /**
-     * Gets all the line items which are taxes on the total
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function tax_items()
-    {
-        return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_tax)));
-    }
-
-
-
-    /**
-     * Gets the total line item (which is a parent of all other related line items,
-     * meaning it takes them all into account on its total)
-     *
-     * @param bool $create_if_not_found
-     * @return \EE_Line_Item
-     * @throws EE_Error
-     */
-    public function total_line_item($create_if_not_found = true)
-    {
-        $item = $this->get_first_related('Line_Item', array(array('LIN_type' => EEM_Line_Item::type_total)));
-        if (! $item && $create_if_not_found) {
-            $item = EEH_Line_Item::create_total_line_item($this);
-        }
-        return $item;
-    }
-
-
-
-    /**
-     * Returns the total amount of tax on this transaction
-     * (assumes there's only one tax subtotal line item)
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function tax_total()
-    {
-        $tax_line_item = $this->tax_total_line_item();
-        if ($tax_line_item) {
-            return (float)$tax_line_item->total();
-        }
-        return (float)0;
-    }
-
-
-
-    /**
-     * Gets the tax subtotal line item (assumes there's only one)
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     */
-    public function tax_total_line_item()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
-    }
-
-
-
-    /**
-     * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function billing_info()
-    {
-        $payment_method = $this->payment_method();
-        if (! $payment_method) {
-            EE_Error::add_error(
-                __(
-                    'Could not find billing info for transaction because no gateway has been used for it yet',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                __(
-                    'Cannot get billing info for gateway %s on transaction because no primary registration exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                __(
-                    'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $attendee->billing_info_for_payment_method($payment_method);
-    }
-
-
-
-    /**
-     * Gets PMD_ID
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function payment_method_ID()
-    {
-        return $this->get('PMD_ID');
-    }
-
-
-
-    /**
-     * Sets PMD_ID
-     *
-     * @param int $PMD_ID
-     * @throws EE_Error
-     */
-    public function set_payment_method_ID($PMD_ID)
-    {
-        $this->set('PMD_ID', $PMD_ID);
-    }
-
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function payment_method()
-    {
-        $pm = $this->get_first_related('Payment_Method');
-        if ($pm instanceof EE_Payment_Method) {
-            return $pm;
-        }
-        $last_payment = $this->last_payment();
-        if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
-            return $last_payment->payment_method();
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the last payment made
-     *
-     * @return EE_Base_Class|EE_Payment
-     * @throws EE_Error
-     */
-    public function last_payment()
-    {
-        return $this->get_first_related('Payment', array('order_by' => array('PAY_ID' => 'desc')));
-    }
-
-
-
-    /**
-     * Gets all the line items which are unrelated to tickets on this transaction
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function non_ticket_line_items()
-    {
-        return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
-    }
-
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @param  boolean $update whether to save the TXN
-     * @return bool whether the TXN was saved
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function update_status_based_on_total_paid($update = true)
-    {
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
-            $new_txn_status = EEM_Transaction::overpaid_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
-            $new_txn_status = EEM_Transaction::complete_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
-            $new_txn_status = EEM_Transaction::incomplete_status_code;
-        } else {
-            throw new RuntimeException(
-                __('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
-            );
-        }
-        if ($new_txn_status !== $this->status_ID()) {
-            $this->set_status($new_txn_status);
-            if ($update) {
-                return $this->save() ? true : false;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Updates the transaction's status and total_paid based on all the payments
-     * that apply to it
-     *
-     * @deprecated
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_based_on_payments()
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
-            ),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        return $this->_old_txn_status;
-    }
-
-
-
-    /**
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-
-    /**
-     * reg_status_updated
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function txn_status_updated()
-    {
-        return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
-    }
-
-
-
-    /**
-     * _reg_steps_completed
-     * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
-     * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
-     * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
-     *
-     * @param string $reg_step_slug
-     * @param bool   $check_all
-     * @return bool|int
-     * @throws EE_Error
-     */
-    private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
-    {
-        $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
-            return false;
-        }
-        // loop thru reg steps array)
-        foreach ($reg_steps as $slug => $reg_step_completed) {
-            // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
-                // and this is the one
-                if ($slug === $reg_step_slug) {
-                    return $reg_step_completed;
-                }
-                // skip to next reg step in loop
-                continue;
-            }
-            // $check_all must be true, else we would never have gotten to this point
-            if ($slug === $reg_step_slug) {
-                // if we reach this point, then we are testing either:
-                // all_reg_steps_completed_except() or
-                // all_reg_steps_completed_except_final_step(),
-                // and since this is the reg step EXCEPTION being tested
-                // we want to return true (yes true) if this reg step is NOT completed
-                // ie: "is everything completed except the final step?"
-                // "that is correct... the final step is not completed, but all others are."
-                return $reg_step_completed !== true;
-            }
-            if ($reg_step_completed !== true) {
-                // if any reg step is NOT completed, then ALL steps are not completed
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function all_reg_steps_completed()
-    {
-        return $this->_reg_steps_completed();
-    }
-
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @param string $exception
-     * @return bool
-     * @throws EE_Error
-     */
-    public function all_reg_steps_completed_except($exception = '')
-    {
-        return $this->_reg_steps_completed($exception);
-    }
-
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function all_reg_steps_completed_except_final_step()
-    {
-        return $this->_reg_steps_completed('finalize_registration');
-    }
-
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @param string $reg_step_slug
-     * @return bool|int
-     * @throws EE_Error
-     */
-    public function reg_step_completed($reg_step_slug)
-    {
-        return $this->_reg_steps_completed($reg_step_slug, false);
-    }
-
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @return bool|int
-     * @throws EE_Error
-     */
-    public function final_reg_step_completed()
-    {
-        return $this->_reg_steps_completed('finalize_registration', false);
-    }
-
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function set_reg_step_initiated($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, time());
-    }
-
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function set_reg_step_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, true);
-    }
-
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function set_reg_step_not_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, false);
-    }
-
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
-     *
-     * @param  string      $reg_step_slug
-     * @param  boolean|int $status
-     * @return boolean
-     * @throws EE_Error
-     */
-    private function _set_reg_step_completed_status($reg_step_slug, $status)
-    {
-        // validate status
-        $status = is_bool($status) || is_int($status) ? $status : false;
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        // if reg step does NOT exist
-        if (! isset($txn_reg_steps[$reg_step_slug])) {
-            return false;
-        }
-        // if  we're trying to complete a step that is already completed
-        if ($txn_reg_steps[$reg_step_slug] === true) {
-            return true;
-        }
-        // if  we're trying to complete a step that hasn't even started
-        if ($status === true && $txn_reg_steps[$reg_step_slug] === false) {
-            return false;
-        }
-        // if current status value matches the incoming value (no change)
-        // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int)$txn_reg_steps[$reg_step_slug] === (int)$status) {
-            // this will happen in cases where multiple AJAX requests occur during the same step
-            return true;
-        }
-        // if we're trying to set a start time, but it has already been set...
-        if (is_numeric($status) && is_numeric($txn_reg_steps[$reg_step_slug])) {
-            // skip the update below, but don't return FALSE so that errors won't be displayed
-            return true;
-        }
-        // update completed status
-        $txn_reg_steps[$reg_step_slug] = $status;
-        $this->set_reg_steps($txn_reg_steps);
-        $this->save();
-        return true;
-    }
-
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @param string $reg_step_slug
-     * @return void
-     * @throws EE_Error
-     */
-    public function remove_reg_step($reg_step_slug)
-    {
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        unset($txn_reg_steps[$reg_step_slug]);
-        $this->set_reg_steps($txn_reg_steps);
-    }
-
-
-
-    /**
-     * toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @param bool $save
-     * @return bool
-     * @throws EE_Error
-     */
-    public function toggle_failed_transaction_status($save = true)
-    {
-        // if TXN status is still set as "failed"...
-        if ($this->status_ID() === EEM_Transaction::failed_status_code) {
-            $this->set_status(EEM_Transaction::abandoned_status_code);
-            if ($save) {
-                $this->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function toggle_abandoned_transaction_status()
-    {
-        // if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
-        $txn_status = $this->status_ID();
-        if (
-            $txn_status === EEM_Transaction::failed_status_code
-            || $txn_status === EEM_Transaction::abandoned_status_code
-        ) {
-            // if a contact record for the primary registrant has been created
-            if (
-                $this->primary_registration() instanceof EE_Registration
-                && $this->primary_registration()->attendee() instanceof EE_Attendee
-            ) {
-                $this->set_status(EEM_Transaction::incomplete_status_code);
-            } else {
-                // no contact record? yer abandoned!
-                $this->set_status(EEM_Transaction::abandoned_status_code);
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * checks if an Abandoned TXN has any related payments, and if so,
-     * updates the TXN status based on the amount paid
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     */
-    public function verify_abandoned_transaction_status()
-    {
-        if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
-            return;
-        }
-        $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Payment) {
-                    // kk this TXN should NOT be abandoned
-                    $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-                        EE_Error::add_attention(
-                            sprintf(
-                                esc_html__(
-                                    'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
-                                    'event_espresso'
-                                ),
-                                $this->ID(),
-                                $this->pretty_status()
-                            )
-                        );
-                    }
-                    // get final reg step status
-                    $finalized = $this->final_reg_step_completed();
-                    // if the 'finalize_registration' step has been initiated (has a timestamp)
-                    // but has not yet been fully completed (TRUE)
-                    if (is_int($finalized) && $finalized !== false && $finalized !== true) {
-                        $this->set_reg_step_completed('finalize_registration');
-                        $this->save();
-                    }
-                }
-            }
-        }
-    }
+	/**
+	 * The length of time in seconds that a lock is applied before being considered expired.
+	 * It is not long because a transaction should only be locked for the duration of the request that locked it
+	 */
+	const LOCK_EXPIRATION = 2;
+
+	/**
+	 * txn status upon initial construction.
+	 *
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone
+	 *                                        (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		$txn        = $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+		if (! $has_object) {
+			$txn->set_old_txn_status($txn->status_ID());
+		}
+		return $txn;
+	}
+
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		$txn = new self($props_n_values, true, $timezone);
+		$txn->set_old_txn_status($txn->status_ID());
+		return $txn;
+	}
+
+
+
+	/**
+	 * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
+	 * If a lock has already been set, then we will attempt to remove it in case it has expired.
+	 * If that also fails, then an exception is thrown.
+	 *
+	 * @throws EE_Error
+	 */
+	public function lock()
+	{
+		// attempt to set lock, but if that fails...
+		if (! $this->add_extra_meta('lock', time(), true)) {
+			// then attempt to remove the lock in case it is expired
+			if ($this->_remove_expired_lock()) {
+				// if removal was successful, then try setting lock again
+				$this->lock();
+			} else {
+				// but if the lock can not be removed, then throw an exception
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
+							'event_espresso'
+						),
+						$this->ID()
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * removes transaction lock applied in EE_Transaction::lock()
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function unlock()
+	{
+		return $this->delete_extra_meta('lock');
+	}
+
+
+
+	/**
+	 * Decides whether or not now is the right time to update the transaction.
+	 * This is useful because we don't always know if it is safe to update the transaction
+	 * and its related data. why?
+	 * because it's possible that the transaction is being used in another
+	 * request and could overwrite anything we save.
+	 * So we want to only update the txn once we know that won't happen.
+	 * We also check that the lock isn't expired, and remove it if it is
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_locked()
+	{
+		// if TXN is not locked, then return false immediately
+		if (! $this->_get_lock()) {
+			return false;
+		}
+		// if not, then let's try and remove the lock in case it's expired...
+		// _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
+		// and a positive number if the lock was removed (ie: number of locks deleted),
+		// so we need to return the opposite
+		return ! $this->_remove_expired_lock() ? true : false;
+	}
+
+
+
+	/**
+	 * Gets the meta field indicating that this TXN is locked
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function _get_lock()
+	{
+		return (int)$this->get_extra_meta('lock', true, 0);
+	}
+
+
+
+	/**
+	 * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function _remove_expired_lock()
+	{
+		$locked = $this->_get_lock();
+		if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
+			return $this->unlock();
+		}
+		return 0;
+	}
+
+
+
+	/**
+	 * Set transaction total
+	 *
+	 * @param float $total total value of transaction
+	 * @throws EE_Error
+	 */
+	public function set_total($total = 0.00)
+	{
+		$this->set('TXN_total', (float)$total);
+	}
+
+
+
+	/**
+	 * Set Total Amount Paid to Date
+	 *
+	 * @param float $total_paid total amount paid to date (sum of all payments)
+	 * @throws EE_Error
+	 */
+	public function set_paid($total_paid = 0.00)
+	{
+		$this->set('TXN_paid', (float)$total_paid);
+	}
+
+
+
+	/**
+	 * Set transaction status
+	 *
+	 * @param string $status        whether the transaction is open, declined, accepted,
+	 *                              or any number of custom values that can be set
+	 * @throws EE_Error
+	 */
+	public function set_status($status = '')
+	{
+		$this->set('STS_ID', $status);
+	}
+
+
+
+	/**
+	 * Set hash salt
+	 *
+	 * @param string $hash_salt required for some payment gateways
+	 * @throws EE_Error
+	 */
+	public function set_hash_salt($hash_salt = '')
+	{
+		$this->set('TXN_hash_salt', $hash_salt);
+	}
+
+
+
+	/**
+	 * Sets TXN_reg_steps array
+	 *
+	 * @param array $txn_reg_steps
+	 * @throws EE_Error
+	 */
+	public function set_reg_steps(array $txn_reg_steps)
+	{
+		$this->set('TXN_reg_steps', $txn_reg_steps);
+	}
+
+
+
+	/**
+	 * Gets TXN_reg_steps
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function reg_steps()
+	{
+		$TXN_reg_steps = $this->get('TXN_reg_steps');
+		return is_array($TXN_reg_steps) ? (array)$TXN_reg_steps : array();
+	}
+
+
+
+	/**
+	 * @return string of transaction's total cost, with currency symbol and decimal
+	 * @throws EE_Error
+	 */
+	public function pretty_total()
+	{
+		return $this->get_pretty('TXN_total');
+	}
+
+
+
+	/**
+	 * Gets the amount paid in a pretty string (formatted and with currency symbol)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('TXN_paid');
+	}
+
+
+
+	/**
+	 * calculate the amount remaining for this transaction and return;
+	 *
+	 * @return float amount remaining
+	 * @throws EE_Error
+	 */
+	public function remaining()
+	{
+		return $this->total() - $this->paid();
+	}
+
+
+
+	/**
+	 * get Transaction Total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function total()
+	{
+		return (float)$this->get('TXN_total');
+	}
+
+
+
+	/**
+	 * get Total Amount Paid to Date
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function paid()
+	{
+		return (float)$this->get('TXN_paid');
+	}
+
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function get_cart_session()
+	{
+		$session_data = (array)$this->get('TXN_session_data');
+		return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
+			? $session_data['cart']
+			: null;
+	}
+
+
+
+	/**
+	 * get Transaction session data
+	 *
+	 * @throws EE_Error
+	 */
+	public function session_data()
+	{
+		$session_data = $this->get('TXN_session_data');
+		if (empty($session_data)) {
+			$session_data = array(
+				'id'            => null,
+				'user_id'       => null,
+				'ip_address'    => null,
+				'user_agent'    => null,
+				'init_access'   => null,
+				'last_access'   => null,
+				'pages_visited' => array(),
+			);
+		}
+		return $session_data;
+	}
+
+
+
+	/**
+	 * Set session data within the TXN object
+	 *
+	 * @param EE_Session|array $session_data
+	 * @throws EE_Error
+	 */
+	public function set_txn_session_data($session_data)
+	{
+		if ($session_data instanceof EE_Session) {
+			$this->set('TXN_session_data', $session_data->get_session_data(null, true));
+		} else {
+			$this->set('TXN_session_data', $session_data);
+		}
+	}
+
+
+
+	/**
+	 * get Transaction hash salt
+	 *
+	 * @throws EE_Error
+	 */
+	public function hash_salt_()
+	{
+		return $this->get('TXN_hash_salt');
+	}
+
+
+
+	/**
+	 * Returns the transaction datetime as either:
+	 *            - unix timestamp format ($format = false, $gmt = true)
+	 *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
+	 *              has no affect with this option)), this also may include a timezone abbreviation if the
+	 *              set timezone in this class differs from what the timezone is on the blog.
+	 *            - formatted date string including the UTC (timezone) offset (default).
+	 *
+	 * @param boolean $format - whether to return a unix timestamp (default) or formatted date string
+	 * @param boolean $gmt    - whether to return a unix timestamp with UTC offset applied (default)
+	 *                          or no UTC offset applied
+	 * @return string | int
+	 * @throws EE_Error
+	 */
+	public function datetime($format = false, $gmt = false)
+	{
+		if ($format) {
+			return $this->get_pretty('TXN_timestamp');
+		}
+		if ($gmt) {
+			return $this->get_raw('TXN_timestamp');
+		}
+		return $this->get('TXN_timestamp');
+	}
+
+
+
+	/**
+	 * Gets registrations on this transaction
+	 *
+	 * @param array   $query_params array of query parameters
+	 * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function registrations($query_params = array(), $get_cached = false)
+	{
+		$query_params = (empty($query_params) || ! is_array($query_params))
+			? array(
+				'order_by' => array(
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC',
+				),
+			)
+			: $query_params;
+		$query_params = $get_cached ? array() : $query_params;
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+
+	/**
+	 * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
+	 * function for getting attendees and how many registrations they each have for an event)
+	 *
+	 * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
+	 * @throws EE_Error
+	 */
+	public function attendees()
+	{
+		return $this->get_many_related('Attendee', array(array('Registration.Transaction.TXN_ID' => $this->ID())));
+	}
+
+
+
+	/**
+	 * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 */
+	public function payments($query_params = array())
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+
+	/**
+	 * gets only approved payments for this transaction
+	 *
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function approved_payments()
+	{
+		EE_Registry::instance()->load_model('Payment');
+		return $this->get_many_related(
+			'Payment',
+			array(
+				array('STS_ID' => EEM_Payment::status_id_approved),
+				'order_by' => array('PAY_timestamp' => 'DESC'),
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets all payments which have not been approved
+	 *
+	 * @return EE_Base_Class[]|EEI_Payment[]
+	 * @throws EE_Error if a model is misconfigured somehow
+	 */
+	public function pending_payments()
+	{
+		return $this->get_many_related(
+			'Payment',
+			array(
+				array(
+					'STS_ID' => EEM_Payment::status_id_pending,
+				),
+				'order_by' => array(
+					'PAY_timestamp' => 'DESC',
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->status_ID() => __('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Transaction::complete_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
+				break;
+			case EEM_Transaction::incomplete_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::abandoned_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Transaction::failed_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Transaction::overpaid_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
+				break;
+		}
+		return $icon . $status[$this->status_ID()];
+	}
+
+
+
+	/**
+	 * get Transaction Status
+	 *
+	 * @throws EE_Error
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+
+	/**
+	 * Returns TRUE or FALSE for whether or not this transaction cost any money
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_free()
+	{
+		return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
+	}
+
+
+
+	/**
+	 * Returns whether this transaction is complete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_completed()
+	{
+		return $this->status_ID() === EEM_Transaction::complete_status_code;
+	}
+
+
+
+	/**
+	 * Returns whether this transaction is incomplete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() === EEM_Transaction::incomplete_status_code;
+	}
+
+
+
+	/**
+	 * Returns whether this transaction is overpaid
+	 * Useful in templates and other logic for deciding if monies need to be refunded
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_overpaid()
+	{
+		return $this->status_ID() === EEM_Transaction::overpaid_status_code;
+	}
+
+
+
+	/**
+	 * Returns whether this transaction was abandoned
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * but that contact information exists for at least one registrant
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_abandoned()
+	{
+		return $this->status_ID() === EEM_Transaction::abandoned_status_code;
+	}
+
+
+
+	/**
+	 * Returns whether this transaction failed
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * and that NO contact information exists for any registrants
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function failed()
+	{
+		return $this->status_ID() === EEM_Transaction::failed_status_code;
+	}
+
+
+
+	/**
+	 * This returns the url for the invoice of this transaction
+	 *
+	 * @param string $type 'html' or 'pdf' (default is pdf)
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function invoice_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->invoice_url($type);
+	}
+
+
+
+	/**
+	 * Gets the primary registration only
+	 *
+	 * @return EE_Base_Class|EE_Registration
+	 * @throws EE_Error
+	 */
+	public function primary_registration()
+	{
+		$registrations = (array)$this->get_many_related(
+			'Registration',
+			array(array('REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT))
+		);
+		foreach ($registrations as $registration) {
+			// valid registration that is NOT cancelled or declined ?
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
+			) {
+				return $registration;
+			}
+		}
+		// nothing valid found, so just return first thing from array of results
+		return reset($registrations);
+	}
+
+
+
+	/**
+	 * Gets the URL for viewing the receipt
+	 *
+	 * @param string $type 'pdf' or 'html' (default is 'html')
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function receipt_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->receipt_url($type);
+	}
+
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_overview_url()
+	{
+		$primary_registration = $this->primary_registration();
+		return $primary_registration instanceof EE_Registration ? $primary_registration->payment_overview_url() : false;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function gateway_response_on_transaction()
+	{
+		$payment = $this->get_first_related('Payment');
+		return $payment instanceof EE_Payment ? $payment->gateway_response() : '';
+	}
+
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Base_Class|EE_Status
+	 * @throws EE_Error
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class[]|EE_Extra_Meta
+	 * @throws EE_Error
+	 */
+	public function extra_meta($query_params = array())
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 */
+	public function add_registration(EE_Registration $registration)
+	{
+		return $this->_add_relation_to($registration, 'Registration');
+	}
+
+
+
+	/**
+	 * Removes the given registration from being related (even before saving this transaction).
+	 * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
+	 *
+	 * @param int $registration_or_id
+	 * @return EE_Base_Class that was removed from being related
+	 * @throws EE_Error
+	 */
+	public function remove_registration_with_id($registration_or_id)
+	{
+		return $this->_remove_relation_to($registration_or_id, 'Registration');
+	}
+
+
+
+	/**
+	 * Gets all the line items which are for ACTUAL items
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function items_purchased()
+	{
+		return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_line_item)));
+	}
+
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 */
+	public function add_line_item(EE_Line_Item $line_item)
+	{
+		return $this->_add_relation_to($line_item, 'Line_Item');
+	}
+
+
+
+	/**
+	 * Gets ALL the line items related to this transaction (unstructured)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function line_items($query_params = array())
+	{
+		return $this->get_many_related('Line_Item', $query_params);
+	}
+
+
+
+	/**
+	 * Gets all the line items which are taxes on the total
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function tax_items()
+	{
+		return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_tax)));
+	}
+
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other related line items,
+	 * meaning it takes them all into account on its total)
+	 *
+	 * @param bool $create_if_not_found
+	 * @return \EE_Line_Item
+	 * @throws EE_Error
+	 */
+	public function total_line_item($create_if_not_found = true)
+	{
+		$item = $this->get_first_related('Line_Item', array(array('LIN_type' => EEM_Line_Item::type_total)));
+		if (! $item && $create_if_not_found) {
+			$item = EEH_Line_Item::create_total_line_item($this);
+		}
+		return $item;
+	}
+
+
+
+	/**
+	 * Returns the total amount of tax on this transaction
+	 * (assumes there's only one tax subtotal line item)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function tax_total()
+	{
+		$tax_line_item = $this->tax_total_line_item();
+		if ($tax_line_item) {
+			return (float)$tax_line_item->total();
+		}
+		return (float)0;
+	}
+
+
+
+	/**
+	 * Gets the tax subtotal line item (assumes there's only one)
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 */
+	public function tax_total_line_item()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
+	}
+
+
+
+	/**
+	 * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function billing_info()
+	{
+		$payment_method = $this->payment_method();
+		if (! $payment_method) {
+			EE_Error::add_error(
+				__(
+					'Could not find billing info for transaction because no gateway has been used for it yet',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$primary_reg = $this->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				__(
+					'Cannot get billing info for gateway %s on transaction because no primary registration exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				__(
+					'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $attendee->billing_info_for_payment_method($payment_method);
+	}
+
+
+
+	/**
+	 * Gets PMD_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function payment_method_ID()
+	{
+		return $this->get('PMD_ID');
+	}
+
+
+
+	/**
+	 * Sets PMD_ID
+	 *
+	 * @param int $PMD_ID
+	 * @throws EE_Error
+	 */
+	public function set_payment_method_ID($PMD_ID)
+	{
+		$this->set('PMD_ID', $PMD_ID);
+	}
+
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function payment_method()
+	{
+		$pm = $this->get_first_related('Payment_Method');
+		if ($pm instanceof EE_Payment_Method) {
+			return $pm;
+		}
+		$last_payment = $this->last_payment();
+		if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
+			return $last_payment->payment_method();
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the last payment made
+	 *
+	 * @return EE_Base_Class|EE_Payment
+	 * @throws EE_Error
+	 */
+	public function last_payment()
+	{
+		return $this->get_first_related('Payment', array('order_by' => array('PAY_ID' => 'desc')));
+	}
+
+
+
+	/**
+	 * Gets all the line items which are unrelated to tickets on this transaction
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function non_ticket_line_items()
+	{
+		return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
+	}
+
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @param  boolean $update whether to save the TXN
+	 * @return bool whether the TXN was saved
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function update_status_based_on_total_paid($update = true)
+	{
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
+			$new_txn_status = EEM_Transaction::overpaid_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
+			$new_txn_status = EEM_Transaction::complete_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
+			$new_txn_status = EEM_Transaction::incomplete_status_code;
+		} else {
+			throw new RuntimeException(
+				__('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
+			);
+		}
+		if ($new_txn_status !== $this->status_ID()) {
+			$this->set_status($new_txn_status);
+			if ($update) {
+				return $this->save() ? true : false;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Updates the transaction's status and total_paid based on all the payments
+	 * that apply to it
+	 *
+	 * @deprecated
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_based_on_payments()
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
+			),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		return $this->_old_txn_status;
+	}
+
+
+
+	/**
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function txn_status_updated()
+	{
+		return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
+	}
+
+
+
+	/**
+	 * _reg_steps_completed
+	 * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
+	 * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
+	 * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
+	 *
+	 * @param string $reg_step_slug
+	 * @param bool   $check_all
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
+	{
+		$reg_steps = $this->reg_steps();
+		if (! is_array($reg_steps) || empty($reg_steps)) {
+			return false;
+		}
+		// loop thru reg steps array)
+		foreach ($reg_steps as $slug => $reg_step_completed) {
+			// if NOT checking ALL steps (only checking one step)
+			if (! $check_all) {
+				// and this is the one
+				if ($slug === $reg_step_slug) {
+					return $reg_step_completed;
+				}
+				// skip to next reg step in loop
+				continue;
+			}
+			// $check_all must be true, else we would never have gotten to this point
+			if ($slug === $reg_step_slug) {
+				// if we reach this point, then we are testing either:
+				// all_reg_steps_completed_except() or
+				// all_reg_steps_completed_except_final_step(),
+				// and since this is the reg step EXCEPTION being tested
+				// we want to return true (yes true) if this reg step is NOT completed
+				// ie: "is everything completed except the final step?"
+				// "that is correct... the final step is not completed, but all others are."
+				return $reg_step_completed !== true;
+			}
+			if ($reg_step_completed !== true) {
+				// if any reg step is NOT completed, then ALL steps are not completed
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function all_reg_steps_completed()
+	{
+		return $this->_reg_steps_completed();
+	}
+
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @param string $exception
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function all_reg_steps_completed_except($exception = '')
+	{
+		return $this->_reg_steps_completed($exception);
+	}
+
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function all_reg_steps_completed_except_final_step()
+	{
+		return $this->_reg_steps_completed('finalize_registration');
+	}
+
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @param string $reg_step_slug
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	public function reg_step_completed($reg_step_slug)
+	{
+		return $this->_reg_steps_completed($reg_step_slug, false);
+	}
+
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	public function final_reg_step_completed()
+	{
+		return $this->_reg_steps_completed('finalize_registration', false);
+	}
+
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function set_reg_step_initiated($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, time());
+	}
+
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function set_reg_step_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, true);
+	}
+
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function set_reg_step_not_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, false);
+	}
+
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
+	 *
+	 * @param  string      $reg_step_slug
+	 * @param  boolean|int $status
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	private function _set_reg_step_completed_status($reg_step_slug, $status)
+	{
+		// validate status
+		$status = is_bool($status) || is_int($status) ? $status : false;
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		// if reg step does NOT exist
+		if (! isset($txn_reg_steps[$reg_step_slug])) {
+			return false;
+		}
+		// if  we're trying to complete a step that is already completed
+		if ($txn_reg_steps[$reg_step_slug] === true) {
+			return true;
+		}
+		// if  we're trying to complete a step that hasn't even started
+		if ($status === true && $txn_reg_steps[$reg_step_slug] === false) {
+			return false;
+		}
+		// if current status value matches the incoming value (no change)
+		// type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
+		if ((int)$txn_reg_steps[$reg_step_slug] === (int)$status) {
+			// this will happen in cases where multiple AJAX requests occur during the same step
+			return true;
+		}
+		// if we're trying to set a start time, but it has already been set...
+		if (is_numeric($status) && is_numeric($txn_reg_steps[$reg_step_slug])) {
+			// skip the update below, but don't return FALSE so that errors won't be displayed
+			return true;
+		}
+		// update completed status
+		$txn_reg_steps[$reg_step_slug] = $status;
+		$this->set_reg_steps($txn_reg_steps);
+		$this->save();
+		return true;
+	}
+
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @param string $reg_step_slug
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function remove_reg_step($reg_step_slug)
+	{
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		unset($txn_reg_steps[$reg_step_slug]);
+		$this->set_reg_steps($txn_reg_steps);
+	}
+
+
+
+	/**
+	 * toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @param bool $save
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function toggle_failed_transaction_status($save = true)
+	{
+		// if TXN status is still set as "failed"...
+		if ($this->status_ID() === EEM_Transaction::failed_status_code) {
+			$this->set_status(EEM_Transaction::abandoned_status_code);
+			if ($save) {
+				$this->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function toggle_abandoned_transaction_status()
+	{
+		// if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
+		$txn_status = $this->status_ID();
+		if (
+			$txn_status === EEM_Transaction::failed_status_code
+			|| $txn_status === EEM_Transaction::abandoned_status_code
+		) {
+			// if a contact record for the primary registrant has been created
+			if (
+				$this->primary_registration() instanceof EE_Registration
+				&& $this->primary_registration()->attendee() instanceof EE_Attendee
+			) {
+				$this->set_status(EEM_Transaction::incomplete_status_code);
+			} else {
+				// no contact record? yer abandoned!
+				$this->set_status(EEM_Transaction::abandoned_status_code);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * checks if an Abandoned TXN has any related payments, and if so,
+	 * updates the TXN status based on the amount paid
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 */
+	public function verify_abandoned_transaction_status()
+	{
+		if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
+			return;
+		}
+		$payments = $this->get_many_related('Payment');
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Payment) {
+					// kk this TXN should NOT be abandoned
+					$this->update_status_based_on_total_paid();
+					if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+						EE_Error::add_attention(
+							sprintf(
+								esc_html__(
+									'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
+									'event_espresso'
+								),
+								$this->ID(),
+								$this->pretty_status()
+							)
+						);
+					}
+					// get final reg step status
+					$finalized = $this->final_reg_step_completed();
+					// if the 'finalize_registration' step has been initiated (has a timestamp)
+					// but has not yet been fully completed (TRUE)
+					if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+						$this->set_reg_step_completed('finalize_registration');
+						$this->save();
+					}
+				}
+			}
+		}
+	}
 
 }/* End of file EE_Transaction.class.php */
 /* Location: includes/classes/EE_Transaction.class.php */

Spacing +28 added lines, -28 removed lines

@@ -47,7 +47,7 @@ 
         $txn        = $has_object
             ? $has_object
             : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
+        if ( ! $has_object) {
             $txn->set_old_txn_status($txn->status_ID());
         }
         return $txn;
@@ -81,7 +81,7 @@ 
     public function lock()
     {
         // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
+        if ( ! $this->add_extra_meta('lock', time(), true)) {
             // then attempt to remove the lock in case it is expired
             if ($this->_remove_expired_lock()) {
                 // if removal was successful, then try setting lock again
@@ -131,7 +131,7 @@ 
     public function is_locked()
     {
         // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
+        if ( ! $this->_get_lock()) {
             return false;
         }
         // if not, then let's try and remove the lock in case it's expired...
@@ -151,7 +151,7 @@ 
      */
     protected function _get_lock()
     {
-        return (int)$this->get_extra_meta('lock', true, 0);
+        return (int) $this->get_extra_meta('lock', true, 0);
     }
 
 
@@ -181,7 +181,7 @@ 
      */
     public function set_total($total = 0.00)
     {
-        $this->set('TXN_total', (float)$total);
+        $this->set('TXN_total', (float) $total);
     }
 
 
@@ -194,7 +194,7 @@ 
      */
     public function set_paid($total_paid = 0.00)
     {
-        $this->set('TXN_paid', (float)$total_paid);
+        $this->set('TXN_paid', (float) $total_paid);
     }
 
 
@@ -248,7 +248,7 @@ 
     public function reg_steps()
     {
         $TXN_reg_steps = $this->get('TXN_reg_steps');
-        return is_array($TXN_reg_steps) ? (array)$TXN_reg_steps : array();
+        return is_array($TXN_reg_steps) ? (array) $TXN_reg_steps : array();
     }
 
 
@@ -298,7 +298,7 @@ 
      */
     public function total()
     {
-        return (float)$this->get('TXN_total');
+        return (float) $this->get('TXN_total');
     }
 
 
@@ -311,7 +311,7 @@ 
      */
     public function paid()
     {
-        return (float)$this->get('TXN_paid');
+        return (float) $this->get('TXN_paid');
     }
 
 
@@ -321,7 +321,7 @@ 
      */
     public function get_cart_session()
     {
-        $session_data = (array)$this->get('TXN_session_data');
+        $session_data = (array) $this->get('TXN_session_data');
         return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
             ? $session_data['cart']
             : null;
@@ -542,7 +542,7 @@ 
             false,
             'sentence'
         );
-        $icon   = '';
+        $icon = '';
         switch ($this->status_ID()) {
             case EEM_Transaction::complete_status_code:
                 $icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
@@ -561,7 +561,7 @@ 
                 $icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
                 break;
         }
-        return $icon . $status[$this->status_ID()];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -673,7 +673,7 @@ 
     public function invoice_url($type = 'html')
     {
         $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
+        if ( ! $REG instanceof EE_Registration) {
             return '';
         }
         return $REG->invoice_url($type);
@@ -689,7 +689,7 @@ 
      */
     public function primary_registration()
     {
-        $registrations = (array)$this->get_many_related(
+        $registrations = (array) $this->get_many_related(
             'Registration',
             array(array('REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT))
         );
@@ -718,7 +718,7 @@ 
     public function receipt_url($type = 'html')
     {
         $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
+        if ( ! $REG instanceof EE_Registration) {
             return '';
         }
         return $REG->receipt_url($type);
@@ -874,7 +874,7 @@ 
     public function total_line_item($create_if_not_found = true)
     {
         $item = $this->get_first_related('Line_Item', array(array('LIN_type' => EEM_Line_Item::type_total)));
-        if (! $item && $create_if_not_found) {
+        if ( ! $item && $create_if_not_found) {
             $item = EEH_Line_Item::create_total_line_item($this);
         }
         return $item;
@@ -893,9 +893,9 @@ 
     {
         $tax_line_item = $this->tax_total_line_item();
         if ($tax_line_item) {
-            return (float)$tax_line_item->total();
+            return (float) $tax_line_item->total();
         }
-        return (float)0;
+        return (float) 0;
     }
 
 
@@ -922,7 +922,7 @@ 
     public function billing_info()
     {
         $payment_method = $this->payment_method();
-        if (! $payment_method) {
+        if ( ! $payment_method) {
             EE_Error::add_error(
                 __(
                     'Could not find billing info for transaction because no gateway has been used for it yet',
@@ -935,7 +935,7 @@ 
             return null;
         }
         $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(
                 __(
                     'Cannot get billing info for gateway %s on transaction because no primary registration exists',
@@ -948,7 +948,7 @@ 
             return null;
         }
         $attendee = $primary_reg->attendee();
-        if (! $attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(
                 __(
                     'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
@@ -1091,7 +1091,7 @@ 
     public function update_based_on_payments()
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
@@ -1155,13 +1155,13 @@ 
     private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
     {
         $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
+        if ( ! is_array($reg_steps) || empty($reg_steps)) {
             return false;
         }
         // loop thru reg steps array)
         foreach ($reg_steps as $slug => $reg_step_completed) {
             // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
+            if ( ! $check_all) {
                 // and this is the one
                 if ($slug === $reg_step_slug) {
                     return $reg_step_completed;
@@ -1337,7 +1337,7 @@ 
         // get reg steps array
         $txn_reg_steps = $this->reg_steps();
         // if reg step does NOT exist
-        if (! isset($txn_reg_steps[$reg_step_slug])) {
+        if ( ! isset($txn_reg_steps[$reg_step_slug])) {
             return false;
         }
         // if  we're trying to complete a step that is already completed
@@ -1350,7 +1350,7 @@ 
         }
         // if current status value matches the incoming value (no change)
         // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int)$txn_reg_steps[$reg_step_slug] === (int)$status) {
+        if ((int) $txn_reg_steps[$reg_step_slug] === (int) $status) {
             // this will happen in cases where multiple AJAX requests occur during the same step
             return true;
         }
@@ -1459,12 +1459,12 @@ 
             return;
         }
         $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 if ($payment instanceof EE_Payment) {
                     // kk this TXN should NOT be abandoned
                     $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+                    if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
                         EE_Error::add_attention(
                             sprintf(
                                 esc_html__(

core/EE_Cron_Tasks.core.php

Indentation +581 added lines, -581 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -14,586 +14,586 @@ 
 class EE_Cron_Tasks extends EE_Base
 {
 
-    /**
-     * WordPress doesn't allow duplicate crons within 10 minutes of the original,
-     * so we'll set our retry time for just over 10 minutes to avoid that
-     */
-    const reschedule_timeout = 605;
-
-
-    /**
-     * @var EE_Cron_Tasks
-     */
-    private static $_instance;
-
-
-    /**
-     * @return EE_Cron_Tasks
-     * @throws \ReflectionException
-     * @throws \EE_Error
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public static function instance()
-    {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @access private
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     * @throws \EE_Error
-     * @throws \ReflectionException
-     */
-    private function __construct()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // verify that WP Cron is enabled
-        if (
-            defined('DISABLE_WP_CRON')
-            && DISABLE_WP_CRON
-            && is_admin()
-            && ! get_option('ee_disabled_wp_cron_check')
-        ) {
-            /**
-             * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
-             * config is loaded.
-             * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
-             * wanting to not have this functionality can just register its own action at a priority after this one to
-             * reverse any changes.
-             */
-            add_action(
-                'AHEE__EE_System__load_core_configuration__complete',
-                function ()
-                {
-                    EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
-                    EE_Registry::instance()->NET_CFG->update_config(true, false);
-                    add_option('ee_disabled_wp_cron_check', 1, '', false);
-                }
-            );
-        }
-        // UPDATE TRANSACTION WITH PAYMENT
-        add_action(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-            array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
-            10,
-            2
-        );
-        // ABANDONED / EXPIRED TRANSACTION CHECK
-        add_action(
-            'AHEE__EE_Cron_Tasks__expired_transaction_check',
-            array('EE_Cron_Tasks', 'expired_transaction_check'),
-            10,
-            1
-        );
-        // CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
-        add_action(
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-            array('EE_Cron_Tasks', 'clean_out_junk_transactions')
-        );
-        // logging
-        add_action(
-            'AHEE__EE_System__load_core_configuration__complete',
-            array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
-        );
-        EE_Registry::instance()->load_lib('Messages_Scheduler');
-        //clean out old gateway logs
-        add_action(
-            'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
-            array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
-        );
-    }
-
-
-    /**
-     * @access protected
-     * @return void
-     */
-    public static function log_scheduled_ee_crons()
-    {
-        $ee_crons = array(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-        );
-        $crons    = (array)get_option('cron');
-        if (! is_array($crons)) {
-            return;
-        }
-        foreach ($crons as $timestamp => $cron) {
-            foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[$ee_cron]) && is_array($cron[$ee_cron])) {
-                    do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[$ee_cron] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
-                            do_action(
-                                'AHEE_log',
-                                __CLASS__,
-                                __FUNCTION__,
-                                print_r($ee_cron_details['args'], true),
-                                "{$ee_cron} args"
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * reschedule_cron_for_transactions_if_maintenance_mode
-     * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
-     *
-     * @param string $cron_task
-     * @param array  $TXN_IDs
-     * @return bool
-     * @throws \DomainException
-     */
-    public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
-    {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
-            throw new \DomainException(
-                sprintf(
-                    __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
-                    $cron_task
-                )
-            );
-        }
-        // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
-                // ensure $additional_vars is an array
-                $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
-                // reset cron job for the TXN
-                call_user_func_array(
-                    array('EE_Cron_Tasks', $cron_task),
-                    array_merge(
-                        array(
-                            time() + (10 * MINUTE_IN_SECONDS),
-                            $TXN_ID,
-                        ),
-                        $additional_vars
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-
-    /****************  UPDATE TRANSACTION WITH PAYMENT ****************/
-    /**
-     * array of TXN IDs and the payment
-     *
-     * @var array
-     */
-    protected static $_update_transactions_with_payment = array();
-
-
-    /**
-     * schedule_update_transaction_with_payment
-     * sets a wp_schedule_single_event() for updating any TXNs that may
-     * require updating due to recently received payments
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function schedule_update_transaction_with_payment(
-        $timestamp,
-        $TXN_ID,
-        $PAY_ID
-    ) {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // validate $TXN_ID and $timestamp
-        $TXN_ID    = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-                array($TXN_ID, $PAY_ID)
-            );
-        }
-    }
-
-
-    /**
-     * setup_update_for_transaction_with_payment
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
-     * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
-     * The passed TXN_ID and associated payment gets added to an array, and then
-     * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
-     * 'shutdown' which will actually handle the processing of any
-     * transactions requiring updating, because doing so now would be too early
-     * and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[$TXN_ID] = $PAY_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'update_transaction_with_payment'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * update_transaction_with_payment
-     * loops through the self::$_abandoned_transactions array
-     * and attempts to finalize any TXNs that have not been completed
-     * but have had their sessions expired, most likely due to a user not
-     * returning from an off-site payment gateway
-     *
-     * @throws \EE_Error
-     * @throws \DomainException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     * @throws \ReflectionException
-     */
-    public static function update_transaction_with_payment()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
-            // are there any TXNs that need cleaning up ?
-            empty(self::$_update_transactions_with_payment)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_update_transaction_with_payment',
-                self::$_update_transactions_with_payment
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Payment_Processor $payment_processor */
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        // set revisit flag for payment processor
-        $payment_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
-            // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-                // reset cron job for updating the TXN
-                EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                    time() + EE_Cron_Tasks::reschedule_timeout,
-                    $TXN_ID,
-                    $PAY_ID
-                );
-                continue;
-            }
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $payment     = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            // verify transaction
-            if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
-                // now try to update the TXN with any payments
-                $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
-            }
-            unset(self::$_update_transactions_with_payment[$TXN_ID]);
-        }
-    }
-
-
-
-    /************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
-    /*****************  EXPIRED TRANSACTION CHECK *****************/
-    /**
-     * array of TXN IDs
-     *
-     * @var array
-     */
-    protected static $_expired_transactions = array();
-
-
-
-    /**
-     * schedule_expired_transaction_check
-     * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_expired_transaction_check(
-        $timestamp,
-        $TXN_ID
-    ) {
-        // validate $TXN_ID and $timestamp
-        $TXN_ID    = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__expired_transaction_check',
-                array($TXN_ID)
-            );
-        }
-    }
-
-
-
-    /**
-     * expired_transaction_check
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
-     * which is utilized by wp_schedule_single_event()
-     * in \EED_Single_Page_Checkout::_initialize_transaction().
-     * The passed TXN_ID gets added to an array, and then the
-     * process_expired_transactions() function is hooked into
-     * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
-     * processing of any failed transactions, because doing so now would be
-     * too early and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     */
-    public static function expired_transaction_check($TXN_ID = 0)
-    {
-        if (absint($TXN_ID)) {
-            self::$_expired_transactions[$TXN_ID] = $TXN_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'process_expired_transactions'),
-                5
-            );
-        }
-    }
-
-
-
-    /**
-     * process_expired_transactions
-     * loops through the self::$_expired_transactions array and processes any failed TXNs
-     *
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     * @throws \ReflectionException
-     * @throws \DomainException
-     */
-    public static function process_expired_transactions()
-    {
-        if (
-            // are there any TXNs that need cleaning up ?
-            empty(self::$_expired_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_expired_transactions
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag for txn processor
-        $transaction_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_expired_transactions as $TXN_ID) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            // verify transaction and whether it is failed or not
-            if ($transaction instanceof EE_Transaction) {
-                switch ($transaction->status_ID()) {
-                    // Completed TXNs
-                    case EEM_Transaction::complete_status_code :
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Overpaid TXNs
-                    case EEM_Transaction::overpaid_status_code :
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Incomplete TXNs
-                    case EEM_Transaction::incomplete_status_code :
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-                            $transaction
-                        );
-                        // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
-                        break;
-                    // Abandoned TXNs
-                    case EEM_Transaction::abandoned_status_code :
-                        // run hook before updating transaction, primarily so
-                        // EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-                            $transaction
-                        );
-                        // don't finalize the TXN if it has already been completed
-                        if ($transaction->all_reg_steps_completed() !== true) {
-                            /** @type EE_Payment_Processor $payment_processor */
-                            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                            // let's simulate an IPN here which will trigger any notifications that need to go out
-                            $payment_processor->update_txn_based_on_payment(
-                                $transaction,
-                                $transaction->last_payment(),
-                                true,
-                                true
-                            );
-                        }
-                        break;
-                    // Failed TXNs
-                    case EEM_Transaction::failed_status_code :
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-                            $transaction
-                        );
-                        // todo : perform garbage collection here and remove clean_out_junk_transactions()
-                        //$registrations = $transaction->registrations();
-                        //if ( ! empty( $registrations ) ) {
-                        //	foreach ( $registrations as $registration ) {
-                        //		if ( $registration instanceof EE_Registration ) {
-                        //$delete_registration = true;
-                        //if ( $registration->attendee() instanceof EE_Attendee ) {
-                        //	$delete_registration = false;
-                        //}
-                        //if ( $delete_registration ) {
-                        //	$registration->delete_permanently();
-                        //	$registration->delete_related_permanently();
-                        //}
-                        //		}
-                        //	}
-                        //}
-                        break;
-                }
-            }
-            unset(self::$_expired_transactions[$TXN_ID]);
-        }
-    }
-
-
-
-    /*************  END OF EXPIRED TRANSACTION CHECK  *************/
-    /************* START CLEAN UP BOT TRANSACTIONS **********************/
-
-
-
-    /**
-     * when a transaction is initially made, schedule this check.
-     * if it has NO REG data by the time it has expired, forget about it
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function clean_out_junk_transactions()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            EEM_Transaction::instance('')->delete_junk_transactions();
-            EEM_Registration::instance('')->delete_registrations_with_no_transaction();
-            EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
-        }
-    }
-
-
-
-    /**
-     * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
-     *
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     */
-    public static function clean_out_old_gateway_logs()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $time_diff_for_comparison = apply_filters(
-                'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-1 week'
-            );
-            EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
-        }
-    }
-
-
-    /*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
-    /**
-     * @var array
-     */
-    protected static $_abandoned_transactions = array();
-
-
-    /**
-     * @deprecated
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
-    {
-        EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @param int $TXN_ID
-     */
-    public static function check_for_abandoned_transactions($TXN_ID = 0)
-    {
-        EE_Cron_Tasks::expired_transaction_check($TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @throws \EE_Error
-     * @throws \DomainException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     * @throws \ReflectionException
-     */
-    public static function finalize_abandoned_transactions()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
-            // are there any TXNs that need cleaning up ?
-            empty(self::$_abandoned_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_abandoned_transactions
-            )
-        ) {
-            return;
-        }
-        // combine our arrays of transaction IDs
-        self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
-        // and deal with abandoned transactions here now...
-        EE_Cron_Tasks::process_expired_transactions();
-    }
-
-
-
-    /*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
+	/**
+	 * WordPress doesn't allow duplicate crons within 10 minutes of the original,
+	 * so we'll set our retry time for just over 10 minutes to avoid that
+	 */
+	const reschedule_timeout = 605;
+
+
+	/**
+	 * @var EE_Cron_Tasks
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @return EE_Cron_Tasks
+	 * @throws \ReflectionException
+	 * @throws \EE_Error
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public static function instance()
+	{
+		if (! self::$_instance instanceof EE_Cron_Tasks) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @access private
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 * @throws \EE_Error
+	 * @throws \ReflectionException
+	 */
+	private function __construct()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// verify that WP Cron is enabled
+		if (
+			defined('DISABLE_WP_CRON')
+			&& DISABLE_WP_CRON
+			&& is_admin()
+			&& ! get_option('ee_disabled_wp_cron_check')
+		) {
+			/**
+			 * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
+			 * config is loaded.
+			 * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
+			 * wanting to not have this functionality can just register its own action at a priority after this one to
+			 * reverse any changes.
+			 */
+			add_action(
+				'AHEE__EE_System__load_core_configuration__complete',
+				function ()
+				{
+					EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
+					EE_Registry::instance()->NET_CFG->update_config(true, false);
+					add_option('ee_disabled_wp_cron_check', 1, '', false);
+				}
+			);
+		}
+		// UPDATE TRANSACTION WITH PAYMENT
+		add_action(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+			array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
+			10,
+			2
+		);
+		// ABANDONED / EXPIRED TRANSACTION CHECK
+		add_action(
+			'AHEE__EE_Cron_Tasks__expired_transaction_check',
+			array('EE_Cron_Tasks', 'expired_transaction_check'),
+			10,
+			1
+		);
+		// CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
+		add_action(
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+			array('EE_Cron_Tasks', 'clean_out_junk_transactions')
+		);
+		// logging
+		add_action(
+			'AHEE__EE_System__load_core_configuration__complete',
+			array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
+		);
+		EE_Registry::instance()->load_lib('Messages_Scheduler');
+		//clean out old gateway logs
+		add_action(
+			'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
+			array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
+		);
+	}
+
+
+	/**
+	 * @access protected
+	 * @return void
+	 */
+	public static function log_scheduled_ee_crons()
+	{
+		$ee_crons = array(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+		);
+		$crons    = (array)get_option('cron');
+		if (! is_array($crons)) {
+			return;
+		}
+		foreach ($crons as $timestamp => $cron) {
+			foreach ($ee_crons as $ee_cron) {
+				if (isset($cron[$ee_cron]) && is_array($cron[$ee_cron])) {
+					do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
+					foreach ($cron[$ee_cron] as $ee_cron_details) {
+						if (! empty($ee_cron_details['args'])) {
+							do_action(
+								'AHEE_log',
+								__CLASS__,
+								__FUNCTION__,
+								print_r($ee_cron_details['args'], true),
+								"{$ee_cron} args"
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * reschedule_cron_for_transactions_if_maintenance_mode
+	 * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
+	 *
+	 * @param string $cron_task
+	 * @param array  $TXN_IDs
+	 * @return bool
+	 * @throws \DomainException
+	 */
+	public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
+	{
+		if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+			throw new \DomainException(
+				sprintf(
+					__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
+					$cron_task
+				)
+			);
+		}
+		// reschedule the cron if we can't hit the db right now
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
+				// ensure $additional_vars is an array
+				$additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
+				// reset cron job for the TXN
+				call_user_func_array(
+					array('EE_Cron_Tasks', $cron_task),
+					array_merge(
+						array(
+							time() + (10 * MINUTE_IN_SECONDS),
+							$TXN_ID,
+						),
+						$additional_vars
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+
+	/****************  UPDATE TRANSACTION WITH PAYMENT ****************/
+	/**
+	 * array of TXN IDs and the payment
+	 *
+	 * @var array
+	 */
+	protected static $_update_transactions_with_payment = array();
+
+
+	/**
+	 * schedule_update_transaction_with_payment
+	 * sets a wp_schedule_single_event() for updating any TXNs that may
+	 * require updating due to recently received payments
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function schedule_update_transaction_with_payment(
+		$timestamp,
+		$TXN_ID,
+		$PAY_ID
+	) {
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// validate $TXN_ID and $timestamp
+		$TXN_ID    = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+				array($TXN_ID, $PAY_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * setup_update_for_transaction_with_payment
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
+	 * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
+	 * The passed TXN_ID and associated payment gets added to an array, and then
+	 * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
+	 * 'shutdown' which will actually handle the processing of any
+	 * transactions requiring updating, because doing so now would be too early
+	 * and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if (absint($TXN_ID)) {
+			self::$_update_transactions_with_payment[$TXN_ID] = $PAY_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'update_transaction_with_payment'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * update_transaction_with_payment
+	 * loops through the self::$_abandoned_transactions array
+	 * and attempts to finalize any TXNs that have not been completed
+	 * but have had their sessions expired, most likely due to a user not
+	 * returning from an off-site payment gateway
+	 *
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 * @throws \ReflectionException
+	 */
+	public static function update_transaction_with_payment()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
+			// are there any TXNs that need cleaning up ?
+			empty(self::$_update_transactions_with_payment)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_update_transaction_with_payment',
+				self::$_update_transactions_with_payment
+			)
+		) {
+			return;
+		}
+		/** @type EE_Payment_Processor $payment_processor */
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		// set revisit flag for payment processor
+		$payment_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
+			// reschedule the cron if we can't hit the db right now
+			if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+				// reset cron job for updating the TXN
+				EE_Cron_Tasks::schedule_update_transaction_with_payment(
+					time() + EE_Cron_Tasks::reschedule_timeout,
+					$TXN_ID,
+					$PAY_ID
+				);
+				continue;
+			}
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$payment     = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			// verify transaction
+			if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
+				// now try to update the TXN with any payments
+				$payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
+			}
+			unset(self::$_update_transactions_with_payment[$TXN_ID]);
+		}
+	}
+
+
+
+	/************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
+	/*****************  EXPIRED TRANSACTION CHECK *****************/
+	/**
+	 * array of TXN IDs
+	 *
+	 * @var array
+	 */
+	protected static $_expired_transactions = array();
+
+
+
+	/**
+	 * schedule_expired_transaction_check
+	 * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_expired_transaction_check(
+		$timestamp,
+		$TXN_ID
+	) {
+		// validate $TXN_ID and $timestamp
+		$TXN_ID    = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__expired_transaction_check',
+				array($TXN_ID)
+			);
+		}
+	}
+
+
+
+	/**
+	 * expired_transaction_check
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
+	 * which is utilized by wp_schedule_single_event()
+	 * in \EED_Single_Page_Checkout::_initialize_transaction().
+	 * The passed TXN_ID gets added to an array, and then the
+	 * process_expired_transactions() function is hooked into
+	 * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
+	 * processing of any failed transactions, because doing so now would be
+	 * too early and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 */
+	public static function expired_transaction_check($TXN_ID = 0)
+	{
+		if (absint($TXN_ID)) {
+			self::$_expired_transactions[$TXN_ID] = $TXN_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'process_expired_transactions'),
+				5
+			);
+		}
+	}
+
+
+
+	/**
+	 * process_expired_transactions
+	 * loops through the self::$_expired_transactions array and processes any failed TXNs
+	 *
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 * @throws \ReflectionException
+	 * @throws \DomainException
+	 */
+	public static function process_expired_transactions()
+	{
+		if (
+			// are there any TXNs that need cleaning up ?
+			empty(self::$_expired_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_expired_transactions
+			)
+		) {
+			return;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag for txn processor
+		$transaction_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_expired_transactions as $TXN_ID) {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			// verify transaction and whether it is failed or not
+			if ($transaction instanceof EE_Transaction) {
+				switch ($transaction->status_ID()) {
+					// Completed TXNs
+					case EEM_Transaction::complete_status_code :
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
+							$transaction
+						);
+						break;
+					// Overpaid TXNs
+					case EEM_Transaction::overpaid_status_code :
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
+							$transaction
+						);
+						break;
+					// Incomplete TXNs
+					case EEM_Transaction::incomplete_status_code :
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+							$transaction
+						);
+						// todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
+						break;
+					// Abandoned TXNs
+					case EEM_Transaction::abandoned_status_code :
+						// run hook before updating transaction, primarily so
+						// EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+							$transaction
+						);
+						// don't finalize the TXN if it has already been completed
+						if ($transaction->all_reg_steps_completed() !== true) {
+							/** @type EE_Payment_Processor $payment_processor */
+							$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+							// let's simulate an IPN here which will trigger any notifications that need to go out
+							$payment_processor->update_txn_based_on_payment(
+								$transaction,
+								$transaction->last_payment(),
+								true,
+								true
+							);
+						}
+						break;
+					// Failed TXNs
+					case EEM_Transaction::failed_status_code :
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+							$transaction
+						);
+						// todo : perform garbage collection here and remove clean_out_junk_transactions()
+						//$registrations = $transaction->registrations();
+						//if ( ! empty( $registrations ) ) {
+						//	foreach ( $registrations as $registration ) {
+						//		if ( $registration instanceof EE_Registration ) {
+						//$delete_registration = true;
+						//if ( $registration->attendee() instanceof EE_Attendee ) {
+						//	$delete_registration = false;
+						//}
+						//if ( $delete_registration ) {
+						//	$registration->delete_permanently();
+						//	$registration->delete_related_permanently();
+						//}
+						//		}
+						//	}
+						//}
+						break;
+				}
+			}
+			unset(self::$_expired_transactions[$TXN_ID]);
+		}
+	}
+
+
+
+	/*************  END OF EXPIRED TRANSACTION CHECK  *************/
+	/************* START CLEAN UP BOT TRANSACTIONS **********************/
+
+
+
+	/**
+	 * when a transaction is initially made, schedule this check.
+	 * if it has NO REG data by the time it has expired, forget about it
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function clean_out_junk_transactions()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			EEM_Transaction::instance('')->delete_junk_transactions();
+			EEM_Registration::instance('')->delete_registrations_with_no_transaction();
+			EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
+		}
+	}
+
+
+
+	/**
+	 * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
+	 *
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 */
+	public static function clean_out_old_gateway_logs()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$time_diff_for_comparison = apply_filters(
+				'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
+				'-1 week'
+			);
+			EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
+		}
+	}
+
+
+	/*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
+	/**
+	 * @var array
+	 */
+	protected static $_abandoned_transactions = array();
+
+
+	/**
+	 * @deprecated
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
+	{
+		EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param int $TXN_ID
+	 */
+	public static function check_for_abandoned_transactions($TXN_ID = 0)
+	{
+		EE_Cron_Tasks::expired_transaction_check($TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 * @throws \ReflectionException
+	 */
+	public static function finalize_abandoned_transactions()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
+			// are there any TXNs that need cleaning up ?
+			empty(self::$_abandoned_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_abandoned_transactions
+			)
+		) {
+			return;
+		}
+		// combine our arrays of transaction IDs
+		self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
+		// and deal with abandoned transactions here now...
+		EE_Cron_Tasks::process_expired_transactions();
+	}
+
+
+
+	/*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
 }
 // End of file EE_Cron_Tasks.core.php
 // Location: /EE_Cron_Tasks.core.php

Spacing +9 added lines, -9 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -37,7 +37,7 @@ 
      */
     public static function instance()
     {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
+        if ( ! self::$_instance instanceof EE_Cron_Tasks) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -71,7 +71,7 @@ 
              */
             add_action(
                 'AHEE__EE_System__load_core_configuration__complete',
-                function ()
+                function()
                 {
                     EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
                     EE_Registry::instance()->NET_CFG->update_config(true, false);
@@ -123,8 +123,8 @@ 
             'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
             'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
         );
-        $crons    = (array)get_option('cron');
-        if (! is_array($crons)) {
+        $crons = (array) get_option('cron');
+        if ( ! is_array($crons)) {
             return;
         }
         foreach ($crons as $timestamp => $cron) {
@@ -132,7 +132,7 @@ 
                 if (isset($cron[$ee_cron]) && is_array($cron[$ee_cron])) {
                     do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
                     foreach ($cron[$ee_cron] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
+                        if ( ! empty($ee_cron_details['args'])) {
                             do_action(
                                 'AHEE_log',
                                 __CLASS__,
@@ -160,7 +160,7 @@ 
      */
     public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
     {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+        if ( ! method_exists('EE_Cron_Tasks', $cron_task)) {
             throw new \DomainException(
                 sprintf(
                     __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
@@ -169,7 +169,7 @@ 
             );
         }
         // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
                 // ensure $additional_vars is an array
                 $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
@@ -294,7 +294,7 @@ 
         EE_Registry::instance()->load_model('Transaction');
         foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
             // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+            if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
                 // reset cron job for updating the TXN
                 EE_Cron_Tasks::schedule_update_transaction_with_payment(
                     time() + EE_Cron_Tasks::reschedule_timeout,

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

Indentation +2866 added lines, -2866 removed lines

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

core/business/EE_Registration_Processor.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -734,7 +734,7 @@
      * @since 4.9.1
      * @param int                   $att_nmbr
      * @param EE_Line_Item | string $item
-     * @return string
+     * @return RegUrlLink
      * @throws InvalidArgumentException
      */
     public function generate_reg_url_link($att_nmbr, $item)

Spacing +15 added lines, -15 removed lines

@@ -74,7 +74,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
+        if ( ! self::$_instance instanceof EE_Registration_Processor) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -109,7 +109,7 @@ 
     public function set_old_reg_status($REG_ID, $old_reg_status)
     {
         // only set the first time
-        if (! isset($this->_old_reg_status[$REG_ID])) {
+        if ( ! isset($this->_old_reg_status[$REG_ID])) {
             $this->_old_reg_status[$REG_ID] = $old_reg_status;
         }
     }
@@ -264,7 +264,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -320,7 +320,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -365,7 +365,7 @@ 
         // set initial REG_Status
         $this->set_old_reg_status($registration->ID(), $registration->status_ID());
         // was a payment just made ?
-        $payment    = isset($additional_details['payment_updates'], $additional_details['last_payment'])
+        $payment = isset($additional_details['payment_updates'], $additional_details['last_payment'])
                       && $additional_details['payment_updates']
                       && $additional_details['last_payment'] instanceof EE_Payment
             ? $additional_details['last_payment']
@@ -406,7 +406,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -437,7 +437,7 @@ 
     public function trigger_registration_update_notifications($registration, array $additional_details = array())
     {
         try {
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 throw new EE_Error(
                     esc_html__('An invalid registration was received.', 'event_espresso')
                 );
@@ -451,7 +451,7 @@ 
             // 	false,
             // 	'EE_Transaction: ' . $registration->transaction()->ID()
             // );
-            if (! $registration->is_primary_registrant()) {
+            if ( ! $registration->is_primary_registrant()) {
                 return;
             }
             do_action(
@@ -570,7 +570,7 @@ 
         $diff = $transaction->total() - $reg_final_price_sum;
         //ok then, just grab one of the registrations
         if ($diff !== 0) {
-            $a_reg   = EEM_Registration::instance()->get_one(
+            $a_reg = EEM_Registration::instance()->get_one(
                 array(
                     array(
                         'TXN_ID' => $transaction->ID(),
@@ -605,7 +605,7 @@ 
         $closed_reg_statuses = ! empty($closed_reg_statuses)
             ? $closed_reg_statuses
             : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         // release a reserved ticket by decrementing ticket and datetime reserved values
@@ -641,7 +641,7 @@ 
             return false;
         }
         $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -691,7 +691,7 @@ 
         $total_ticket_count = 1
     ) {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
@@ -701,7 +701,7 @@ 
         );
         // grab the related ticket object for this line_item
         $ticket = $line_item->ticket();
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
@@ -740,7 +740,7 @@ 
     public function generate_reg_url_link($att_nmbr, $item)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EventEspresso\core\domain\entities\RegUrlLink'
@@ -767,7 +767,7 @@ 
     public function generate_reg_code(EE_Registration $registration)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EventEspresso\core\domain\entities\RegCode'

Indentation +759 added lines, -759 removed lines

@@ -26,765 +26,765 @@
 class EE_Registration_Processor extends EE_Processor_Base
 {
 
-    /**
-     * @var EE_Registration_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * initial reg status at the beginning of this request.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $_old_reg_status = array();
-
-    /**
-     * reg status at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $_new_reg_status = array();
-
-    /**
-     * amounts paid at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected static $_amount_paid = array();
-
-    /**
-     * Cache of the reg final price for registrations corresponding to a ticket line item
-     *
-     * @deprecated
-     * @var array @see EEH_Line_Item::calculate_reg_final_prices_per_line_item()'s return value
-     */
-    protected $_reg_final_price_per_tkt_line_item;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Registration_Processor instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * EE_Registration_Processor constructor
-     */
-    private function __construct()
-    {
-    }
-
-
-
-    /**
-     * @param int $REG_ID
-     * @return string
-     */
-    public function old_reg_status($REG_ID)
-    {
-        return isset($this->_old_reg_status[$REG_ID]) ? $this->_old_reg_status[$REG_ID] : null;
-    }
-
-
-
-    /**
-     * @param int    $REG_ID
-     * @param string $old_reg_status
-     */
-    public function set_old_reg_status($REG_ID, $old_reg_status)
-    {
-        // only set the first time
-        if (! isset($this->_old_reg_status[$REG_ID])) {
-            $this->_old_reg_status[$REG_ID] = $old_reg_status;
-        }
-    }
-
-
-
-    /**
-     * @param int $REG_ID
-     * @return string
-     */
-    public function new_reg_status($REG_ID)
-    {
-        return isset($this->_new_reg_status[$REG_ID]) ? $this->_new_reg_status[$REG_ID] : null;
-    }
-
-
-
-    /**
-     * @param int    $REG_ID
-     * @param string $new_reg_status
-     */
-    public function set_new_reg_status($REG_ID, $new_reg_status)
-    {
-        $this->_new_reg_status[$REG_ID] = $new_reg_status;
-    }
-
-
-
-    /**
-     * reg_status_updated
-     *
-     * @param int $REG_ID
-     * @return bool
-     */
-    public function reg_status_updated($REG_ID)
-    {
-        return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID);
-    }
-
-
-
-    /**
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_registration_status_and_trigger_notifications(EE_Registration $registration)
-    {
-        $this->toggle_incomplete_registration_status_to_default($registration, false);
-        $this->toggle_registration_status_for_default_approved_events($registration, false);
-        $this->toggle_registration_status_if_no_monies_owing($registration, false);
-        $registration->save();
-        // trigger notifications
-        $this->trigger_registration_update_notifications($registration);
-    }
-
-
-
-    /**
-     *    manually_update_registration_status
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param string          $new_reg_status
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function manually_update_registration_status(
-        EE_Registration $registration,
-        $new_reg_status = '',
-        $save = true
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // set incoming REG_Status
-        $this->set_new_reg_status($registration->ID(), $new_reg_status);
-        // toggle reg status but only if it has changed and the user can do so
-        if (
-            $this->reg_status_updated($registration->ID())
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registration',
-                'toggle_registration_status',
-                $registration->ID()
-            )
-        ) {
-            // change status to new value
-            $updated = $registration->set_status($this->new_reg_status($registration->ID()));
-            if ($updated && $save) {
-                $registration->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    toggle_incomplete_registration_status_to_default
-     *        changes any incomplete registrations to either the event or global default registration status
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @param Context|null    $context
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_incomplete_registration_status_to_default(
-        EE_Registration $registration,
-        $save = true,
-        Context $context = null
-    ) {
-        $existing_reg_status = $registration->status_ID();
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $existing_reg_status);
-        // is the registration currently incomplete ?
-        if ($registration->status_ID() === EEM_Registration::status_id_incomplete) {
-            // grab default reg status for the event, if set
-            $event_default_registration_status = $registration->event()->default_registration_status();
-            // if no default reg status is set for the event, then use the global value
-            $STS_ID = ! empty($event_default_registration_status)
-                ? $event_default_registration_status
-                : EE_Registry::instance()->CFG->registration->default_STS_ID;
-            // if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
-            $STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment
-                : $STS_ID;
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), $STS_ID);
-            $registration->set_status($STS_ID, false, $context);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            //$this->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	$registration->transaction(),
-            //	array(
-            //		'IPN'                   => EE_Processor_Base::$IPN,
-            //		'deliver_notifications' => has_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications' ),
-            //	)
-            //);
-        }
-    }
-
-
-
-    /**
-     *    toggle_registration_status_for_default_approved_events
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = true)
-    {
-        $reg_status = $registration->status_ID();
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $reg_status);
-        // if not already, toggle reg status to approved IF the event default reg status is approved
-        // ( as long as the registration wasn't cancelled or declined at some point )
-        if (
-            $reg_status !== EEM_Registration::status_id_cancelled
-            && $reg_status
-               !== EEM_Registration::status_id_declined
-            && $reg_status !== EEM_Registration::status_id_approved
-            && $registration->event()->default_registration_status() === EEM_Registration::status_id_approved
-        ) {
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
-            // toggle status to approved
-            $registration->set_status(EEM_Registration::status_id_approved);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            //$this->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	$registration->transaction(),
-            //	array(
-            //		'IPN'                   => EE_Processor_Base::$IPN,
-            //		'deliver_notifications' => has_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications' ),
-            //	)
-            //);
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    toggle_registration_statuses_if_no_monies_owing
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @param array           $additional_details
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function toggle_registration_status_if_no_monies_owing(
-        EE_Registration $registration,
-        $save = true,
-        array $additional_details = array()
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // was a payment just made ?
-        $payment    = isset($additional_details['payment_updates'], $additional_details['last_payment'])
-                      && $additional_details['payment_updates']
-                      && $additional_details['last_payment'] instanceof EE_Payment
-            ? $additional_details['last_payment']
-            : null;
-        $total_paid = array_sum(self::$_amount_paid);
-        // toggle reg status to approved IF
-        if (
-            // REG status is pending payment
-            $registration->status_ID() === EEM_Registration::status_id_pending_payment
-            // AND no monies are owing
-            && (
-                (
-                    $registration->transaction()->is_completed()
-                    || $registration->transaction()->is_overpaid()
-                    || $registration->transaction()->is_free()
-                    || apply_filters(
-                        'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing',
-                        false,
-                        $registration
-                    )
-                )
-                || (
-                    $payment instanceof EE_Payment && $payment->is_approved()
-                    && // this specific registration has not yet been paid for
-                    ! isset(self::$_amount_paid[$registration->ID()])
-                    && // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
-                    $payment->amount() - $total_paid >= $registration->final_price()
-                )
-            )
-        ) {
-            // mark as paid
-            self::$_amount_paid[$registration->ID()] = $registration->final_price();
-            // track new REG_Status
-            $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
-            // toggle status to approved
-            $registration->set_status(EEM_Registration::status_id_approved);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            //$this->log(
-            //	__CLASS__, __FUNCTION__, __LINE__,
-            //	$registration->transaction(),
-            //	array(
-            //		'IPN'                   => EE_Processor_Base::$IPN,
-            //		'deliver_notifications' => has_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications' ),
-            //	)
-            //);
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    registration_status_changed
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param array           $additional_details
-     * @return void
-     */
-    public function trigger_registration_update_notifications($registration, array $additional_details = array())
-    {
-        try {
-            if (! $registration instanceof EE_Registration) {
-                throw new EE_Error(
-                    esc_html__('An invalid registration was received.', 'event_espresso')
-                );
-            }
-            // EE_Registry::instance()->load_helper( 'Debug_Tools' );
-            // EEH_Debug_Tools::log(
-            // 	__CLASS__,
-            // 	__FUNCTION__,
-            // 	__LINE__,
-            // 	array( $registration->transaction(), $additional_details ),
-            // 	false,
-            // 	'EE_Transaction: ' . $registration->transaction()->ID()
-            // );
-            if (! $registration->is_primary_registrant()) {
-                return;
-            }
-            do_action(
-                'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-                $registration,
-                $additional_details
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
-        }
-    }
-
-
-
-    /**
-     * sets reg status based either on passed param or on transaction status and event pre-approval setting
-     *
-     * @param EE_Registration $registration
-     * @param array           $additional_details
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_registration_after_checkout_or_payment(
-        EE_Registration $registration,
-        array $additional_details = array()
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // if the registration status gets updated, then save the registration
-        if (
-            $this->toggle_registration_status_for_default_approved_events($registration, false)
-            || $this->toggle_registration_status_if_no_monies_owing(
-                $registration,
-                false,
-                $additional_details
-            )
-        ) {
-            $registration->save();
-        }
-        // set new  REG_Status
-        $this->set_new_reg_status($registration->ID(), $registration->status_ID());
-        return $this->reg_status_updated($registration->ID())
-               && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved;
-    }
-
-
-
-    /**
-     * Updates the registration' final prices based on the current line item tree (taking into account
-     * discounts, taxes, and other line items unrelated to tickets.)
-     *
-     * @param EE_Transaction $transaction
-     * @param boolean        $save_regs whether to immediately save registrations in this function or not
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public function update_registration_final_prices($transaction, $save_regs = true)
-    {
-        $reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-            $transaction->total_line_item()
-        );
-        foreach ($transaction->registrations() as $registration) {
-            /** @var EE_Line_Item $line_item */
-            $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
-            if (isset($reg_final_price_per_ticket_line_item[$line_item->ID()])) {
-                $registration->set_final_price($reg_final_price_per_ticket_line_item[$line_item->ID()]);
-                if ($save_regs) {
-                    $registration->save();
-                }
-            }
-        }
-        //and make sure there's no rounding problem
-        $this->fix_reg_final_price_rounding_issue($transaction);
-    }
-
-
-
-    /**
-     * Makes sure there is no rounding errors for the REG_final_prices.
-     * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them,
-     * they will each be for $0.99333333, which gets rounded to $1 again.
-     * So the transaction total will be $2.99, but each registration will be for $1,
-     * so if each registrant paid individually they will have overpaid by $0.01.
-     * So in order to overcome this, we check for any difference, and if there is a difference
-     * we just grab one registrant at random and make them responsible for it.
-     * This should be used after setting REG_final_prices (it's done automatically as part of
-     * EE_Registration_Processor::update_registration_final_prices())
-     *
-     * @param EE_Transaction $transaction
-     * @return bool success verifying that there is NO difference after this method is done
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function fix_reg_final_price_rounding_issue($transaction)
-    {
-        $reg_final_price_sum = EEM_Registration::instance()->sum(
-            array(
-                array(
-                    'TXN_ID' => $transaction->ID(),
-                ),
-            ),
-            'REG_final_price'
-        );
-        $diff = $transaction->total() - $reg_final_price_sum;
-        //ok then, just grab one of the registrations
-        if ($diff !== 0) {
-            $a_reg   = EEM_Registration::instance()->get_one(
-                array(
-                    array(
-                        'TXN_ID' => $transaction->ID(),
-                    ),
-                )
-            );
-            return $a_reg instanceof EE_Registration
-                ? (bool) $a_reg->save(array('REG_final_price' => $a_reg->final_price() + $diff))
-                : false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * update_registration_after_being_canceled_or_declined
-     *
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_reg
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function update_registration_after_being_canceled_or_declined(
-        EE_Registration $registration,
-        array $closed_reg_statuses = array(),
-        $update_reg = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        // release a reserved ticket by decrementing ticket and datetime reserved values
-        $registration->release_reserved_ticket(true);
-        $registration->set_final_price(0);
-        if ($update_reg) {
-            $registration->save();
-        }
-        return true;
-    }
-
-
-
-    /**
-     * update_canceled_or_declined_registration_after_being_reinstated
-     *
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_reg
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function update_canceled_or_declined_registration_after_being_reinstated(
-        EE_Registration $registration,
-        array $closed_reg_statuses = array(),
-        $update_reg = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket for Registration %1$d was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $registration->ticket_ID()
-                )
-            );
-        }
-        $registration->set_final_price($ticket->price());
-        if ($update_reg) {
-            $registration->save();
-        }
-        return true;
-    }
-
-
-
-    /**
-     * generate_ONE_registration_from_line_item
-     * Although a ticket line item may have a quantity greater than 1,
-     * this method will ONLY CREATE ONE REGISTRATION !!!
-     * Regardless of the ticket line item quantity.
-     * This means that any code calling this method is responsible for ensuring
-     * that the final registration count matches the ticket line item quantity.
-     * This was done to make it easier to match the number of registrations
-     * to the number of tickets in the cart, when the cart has been edited
-     * after SPCO has already been initialized. So if an additional ticket was added to the cart, you can simply pass
-     * the line item to this method to add a second ticket, and in this case, you would not want to add 2 tickets.
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param EE_Line_Item    $line_item
-     * @param \EE_Transaction $transaction
-     * @param int             $att_nmbr
-     * @param int             $total_ticket_count
-     * @return EE_Registration | null
-     * @throws \OutOfRangeException
-     * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
-     * @throws \EE_Error
-     */
-    public function generate_ONE_registration_from_line_item(
-        EE_Line_Item $line_item,
-        EE_Transaction $transaction,
-        $att_nmbr = 1,
-        $total_ticket_count = 1
-    ) {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        // grab the related ticket object for this line_item
-        $ticket = $line_item->ticket();
-        if (! $ticket instanceof EE_Ticket) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
-                    $line_item->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $registration_service = new CreateRegistrationService();
-        // then generate a new registration from that
-        return $registration_service->create(
-            $ticket->get_related_event(),
-            $transaction,
-            $ticket,
-            $line_item,
-            $att_nmbr,
-            $total_ticket_count
-        );
-    }
-
-
-
-    /**
-     * generates reg_url_link
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param int                   $att_nmbr
-     * @param EE_Line_Item | string $item
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    public function generate_reg_url_link($att_nmbr, $item)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EventEspresso\core\domain\entities\RegUrlLink'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        return new RegUrlLink($att_nmbr, $item);
-    }
-
-
-
-    /**
-     * generates reg code
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     */
-    public function generate_reg_code(EE_Registration $registration)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EventEspresso\core\domain\entities\RegCode'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        return apply_filters(
-            'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code',
-            new RegCode(
-                RegUrlLink::fromRegistration($registration),
-                $registration->transaction(),
-                $registration->ticket()
-            ),
-            $registration
-        );
-    }
+	/**
+	 * @var EE_Registration_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * initial reg status at the beginning of this request.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $_old_reg_status = array();
+
+	/**
+	 * reg status at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $_new_reg_status = array();
+
+	/**
+	 * amounts paid at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected static $_amount_paid = array();
+
+	/**
+	 * Cache of the reg final price for registrations corresponding to a ticket line item
+	 *
+	 * @deprecated
+	 * @var array @see EEH_Line_Item::calculate_reg_final_prices_per_line_item()'s return value
+	 */
+	protected $_reg_final_price_per_tkt_line_item;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Registration_Processor instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registration_Processor) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * EE_Registration_Processor constructor
+	 */
+	private function __construct()
+	{
+	}
+
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return string
+	 */
+	public function old_reg_status($REG_ID)
+	{
+		return isset($this->_old_reg_status[$REG_ID]) ? $this->_old_reg_status[$REG_ID] : null;
+	}
+
+
+
+	/**
+	 * @param int    $REG_ID
+	 * @param string $old_reg_status
+	 */
+	public function set_old_reg_status($REG_ID, $old_reg_status)
+	{
+		// only set the first time
+		if (! isset($this->_old_reg_status[$REG_ID])) {
+			$this->_old_reg_status[$REG_ID] = $old_reg_status;
+		}
+	}
+
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return string
+	 */
+	public function new_reg_status($REG_ID)
+	{
+		return isset($this->_new_reg_status[$REG_ID]) ? $this->_new_reg_status[$REG_ID] : null;
+	}
+
+
+
+	/**
+	 * @param int    $REG_ID
+	 * @param string $new_reg_status
+	 */
+	public function set_new_reg_status($REG_ID, $new_reg_status)
+	{
+		$this->_new_reg_status[$REG_ID] = $new_reg_status;
+	}
+
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @param int $REG_ID
+	 * @return bool
+	 */
+	public function reg_status_updated($REG_ID)
+	{
+		return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID);
+	}
+
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_status_and_trigger_notifications(EE_Registration $registration)
+	{
+		$this->toggle_incomplete_registration_status_to_default($registration, false);
+		$this->toggle_registration_status_for_default_approved_events($registration, false);
+		$this->toggle_registration_status_if_no_monies_owing($registration, false);
+		$registration->save();
+		// trigger notifications
+		$this->trigger_registration_update_notifications($registration);
+	}
+
+
+
+	/**
+	 *    manually_update_registration_status
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param string          $new_reg_status
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function manually_update_registration_status(
+		EE_Registration $registration,
+		$new_reg_status = '',
+		$save = true
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// set incoming REG_Status
+		$this->set_new_reg_status($registration->ID(), $new_reg_status);
+		// toggle reg status but only if it has changed and the user can do so
+		if (
+			$this->reg_status_updated($registration->ID())
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registration',
+				'toggle_registration_status',
+				$registration->ID()
+			)
+		) {
+			// change status to new value
+			$updated = $registration->set_status($this->new_reg_status($registration->ID()));
+			if ($updated && $save) {
+				$registration->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    toggle_incomplete_registration_status_to_default
+	 *        changes any incomplete registrations to either the event or global default registration status
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @param Context|null    $context
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_incomplete_registration_status_to_default(
+		EE_Registration $registration,
+		$save = true,
+		Context $context = null
+	) {
+		$existing_reg_status = $registration->status_ID();
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $existing_reg_status);
+		// is the registration currently incomplete ?
+		if ($registration->status_ID() === EEM_Registration::status_id_incomplete) {
+			// grab default reg status for the event, if set
+			$event_default_registration_status = $registration->event()->default_registration_status();
+			// if no default reg status is set for the event, then use the global value
+			$STS_ID = ! empty($event_default_registration_status)
+				? $event_default_registration_status
+				: EE_Registry::instance()->CFG->registration->default_STS_ID;
+			// if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
+			$STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment
+				: $STS_ID;
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), $STS_ID);
+			$registration->set_status($STS_ID, false, $context);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			//$this->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	$registration->transaction(),
+			//	array(
+			//		'IPN'                   => EE_Processor_Base::$IPN,
+			//		'deliver_notifications' => has_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications' ),
+			//	)
+			//);
+		}
+	}
+
+
+
+	/**
+	 *    toggle_registration_status_for_default_approved_events
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = true)
+	{
+		$reg_status = $registration->status_ID();
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $reg_status);
+		// if not already, toggle reg status to approved IF the event default reg status is approved
+		// ( as long as the registration wasn't cancelled or declined at some point )
+		if (
+			$reg_status !== EEM_Registration::status_id_cancelled
+			&& $reg_status
+			   !== EEM_Registration::status_id_declined
+			&& $reg_status !== EEM_Registration::status_id_approved
+			&& $registration->event()->default_registration_status() === EEM_Registration::status_id_approved
+		) {
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
+			// toggle status to approved
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			//$this->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	$registration->transaction(),
+			//	array(
+			//		'IPN'                   => EE_Processor_Base::$IPN,
+			//		'deliver_notifications' => has_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications' ),
+			//	)
+			//);
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @param array           $additional_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function toggle_registration_status_if_no_monies_owing(
+		EE_Registration $registration,
+		$save = true,
+		array $additional_details = array()
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// was a payment just made ?
+		$payment    = isset($additional_details['payment_updates'], $additional_details['last_payment'])
+					  && $additional_details['payment_updates']
+					  && $additional_details['last_payment'] instanceof EE_Payment
+			? $additional_details['last_payment']
+			: null;
+		$total_paid = array_sum(self::$_amount_paid);
+		// toggle reg status to approved IF
+		if (
+			// REG status is pending payment
+			$registration->status_ID() === EEM_Registration::status_id_pending_payment
+			// AND no monies are owing
+			&& (
+				(
+					$registration->transaction()->is_completed()
+					|| $registration->transaction()->is_overpaid()
+					|| $registration->transaction()->is_free()
+					|| apply_filters(
+						'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing',
+						false,
+						$registration
+					)
+				)
+				|| (
+					$payment instanceof EE_Payment && $payment->is_approved()
+					&& // this specific registration has not yet been paid for
+					! isset(self::$_amount_paid[$registration->ID()])
+					&& // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
+					$payment->amount() - $total_paid >= $registration->final_price()
+				)
+			)
+		) {
+			// mark as paid
+			self::$_amount_paid[$registration->ID()] = $registration->final_price();
+			// track new REG_Status
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
+			// toggle status to approved
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			//$this->log(
+			//	__CLASS__, __FUNCTION__, __LINE__,
+			//	$registration->transaction(),
+			//	array(
+			//		'IPN'                   => EE_Processor_Base::$IPN,
+			//		'deliver_notifications' => has_filter( 'FHEE__EED_Messages___maybe_registration__deliver_notifications' ),
+			//	)
+			//);
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    registration_status_changed
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param array           $additional_details
+	 * @return void
+	 */
+	public function trigger_registration_update_notifications($registration, array $additional_details = array())
+	{
+		try {
+			if (! $registration instanceof EE_Registration) {
+				throw new EE_Error(
+					esc_html__('An invalid registration was received.', 'event_espresso')
+				);
+			}
+			// EE_Registry::instance()->load_helper( 'Debug_Tools' );
+			// EEH_Debug_Tools::log(
+			// 	__CLASS__,
+			// 	__FUNCTION__,
+			// 	__LINE__,
+			// 	array( $registration->transaction(), $additional_details ),
+			// 	false,
+			// 	'EE_Transaction: ' . $registration->transaction()->ID()
+			// );
+			if (! $registration->is_primary_registrant()) {
+				return;
+			}
+			do_action(
+				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+				$registration,
+				$additional_details
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
+		}
+	}
+
+
+
+	/**
+	 * sets reg status based either on passed param or on transaction status and event pre-approval setting
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $additional_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_after_checkout_or_payment(
+		EE_Registration $registration,
+		array $additional_details = array()
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// if the registration status gets updated, then save the registration
+		if (
+			$this->toggle_registration_status_for_default_approved_events($registration, false)
+			|| $this->toggle_registration_status_if_no_monies_owing(
+				$registration,
+				false,
+				$additional_details
+			)
+		) {
+			$registration->save();
+		}
+		// set new  REG_Status
+		$this->set_new_reg_status($registration->ID(), $registration->status_ID());
+		return $this->reg_status_updated($registration->ID())
+			   && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved;
+	}
+
+
+
+	/**
+	 * Updates the registration' final prices based on the current line item tree (taking into account
+	 * discounts, taxes, and other line items unrelated to tickets.)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param boolean        $save_regs whether to immediately save registrations in this function or not
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_final_prices($transaction, $save_regs = true)
+	{
+		$reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+			$transaction->total_line_item()
+		);
+		foreach ($transaction->registrations() as $registration) {
+			/** @var EE_Line_Item $line_item */
+			$line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
+			if (isset($reg_final_price_per_ticket_line_item[$line_item->ID()])) {
+				$registration->set_final_price($reg_final_price_per_ticket_line_item[$line_item->ID()]);
+				if ($save_regs) {
+					$registration->save();
+				}
+			}
+		}
+		//and make sure there's no rounding problem
+		$this->fix_reg_final_price_rounding_issue($transaction);
+	}
+
+
+
+	/**
+	 * Makes sure there is no rounding errors for the REG_final_prices.
+	 * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them,
+	 * they will each be for $0.99333333, which gets rounded to $1 again.
+	 * So the transaction total will be $2.99, but each registration will be for $1,
+	 * so if each registrant paid individually they will have overpaid by $0.01.
+	 * So in order to overcome this, we check for any difference, and if there is a difference
+	 * we just grab one registrant at random and make them responsible for it.
+	 * This should be used after setting REG_final_prices (it's done automatically as part of
+	 * EE_Registration_Processor::update_registration_final_prices())
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return bool success verifying that there is NO difference after this method is done
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function fix_reg_final_price_rounding_issue($transaction)
+	{
+		$reg_final_price_sum = EEM_Registration::instance()->sum(
+			array(
+				array(
+					'TXN_ID' => $transaction->ID(),
+				),
+			),
+			'REG_final_price'
+		);
+		$diff = $transaction->total() - $reg_final_price_sum;
+		//ok then, just grab one of the registrations
+		if ($diff !== 0) {
+			$a_reg   = EEM_Registration::instance()->get_one(
+				array(
+					array(
+						'TXN_ID' => $transaction->ID(),
+					),
+				)
+			);
+			return $a_reg instanceof EE_Registration
+				? (bool) $a_reg->save(array('REG_final_price' => $a_reg->final_price() + $diff))
+				: false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * update_registration_after_being_canceled_or_declined
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_reg
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function update_registration_after_being_canceled_or_declined(
+		EE_Registration $registration,
+		array $closed_reg_statuses = array(),
+		$update_reg = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		// release a reserved ticket by decrementing ticket and datetime reserved values
+		$registration->release_reserved_ticket(true);
+		$registration->set_final_price(0);
+		if ($update_reg) {
+			$registration->save();
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * update_canceled_or_declined_registration_after_being_reinstated
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_reg
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function update_canceled_or_declined_registration_after_being_reinstated(
+		EE_Registration $registration,
+		array $closed_reg_statuses = array(),
+		$update_reg = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		$ticket = $registration->ticket();
+		if (! $ticket instanceof EE_Ticket) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The Ticket for Registration %1$d was not found or is invalid.',
+						'event_espresso'
+					),
+					$registration->ticket_ID()
+				)
+			);
+		}
+		$registration->set_final_price($ticket->price());
+		if ($update_reg) {
+			$registration->save();
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * generate_ONE_registration_from_line_item
+	 * Although a ticket line item may have a quantity greater than 1,
+	 * this method will ONLY CREATE ONE REGISTRATION !!!
+	 * Regardless of the ticket line item quantity.
+	 * This means that any code calling this method is responsible for ensuring
+	 * that the final registration count matches the ticket line item quantity.
+	 * This was done to make it easier to match the number of registrations
+	 * to the number of tickets in the cart, when the cart has been edited
+	 * after SPCO has already been initialized. So if an additional ticket was added to the cart, you can simply pass
+	 * the line item to this method to add a second ticket, and in this case, you would not want to add 2 tickets.
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param EE_Line_Item    $line_item
+	 * @param \EE_Transaction $transaction
+	 * @param int             $att_nmbr
+	 * @param int             $total_ticket_count
+	 * @return EE_Registration | null
+	 * @throws \OutOfRangeException
+	 * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
+	public function generate_ONE_registration_from_line_item(
+		EE_Line_Item $line_item,
+		EE_Transaction $transaction,
+		$att_nmbr = 1,
+		$total_ticket_count = 1
+	) {
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		// grab the related ticket object for this line_item
+		$ticket = $line_item->ticket();
+		if (! $ticket instanceof EE_Ticket) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
+					$line_item->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$registration_service = new CreateRegistrationService();
+		// then generate a new registration from that
+		return $registration_service->create(
+			$ticket->get_related_event(),
+			$transaction,
+			$ticket,
+			$line_item,
+			$att_nmbr,
+			$total_ticket_count
+		);
+	}
+
+
+
+	/**
+	 * generates reg_url_link
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param int                   $att_nmbr
+	 * @param EE_Line_Item | string $item
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	public function generate_reg_url_link($att_nmbr, $item)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EventEspresso\core\domain\entities\RegUrlLink'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		return new RegUrlLink($att_nmbr, $item);
+	}
+
+
+
+	/**
+	 * generates reg code
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 */
+	public function generate_reg_code(EE_Registration $registration)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EventEspresso\core\domain\entities\RegCode'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		return apply_filters(
+			'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code',
+			new RegCode(
+				RegUrlLink::fromRegistration($registration),
+				$registration->transaction(),
+				$registration->ticket()
+			),
+			$registration
+		);
+	}
 
 
 

core/EE_Payment_Processor.core.php

Indentation +857 added lines, -857 removed lines

@@ -21,861 +21,861 @@
 class EE_Payment_Processor extends EE_Processor_Base implements ResettableInterface
 {
 
-    /**
-     * @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;
-    }
-
-
-
-    /**
-     * @return EE_Payment_Processor
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        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
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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;
-        }
-        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
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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
-     * @throws \RuntimeException
-     * @throws \ReflectionException
-     * @throws \InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    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'),
-                    )
-                );
-            }
-        } elseif ($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()
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @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;
-        }
-        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
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_refund(
-        EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        array $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
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        array $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
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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;
-        // 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.
-     *
-     * @param $handle
-     * @param $r
-     * @param $url
-     */
-    public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
-    {
-        if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
-            //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;
+	}
+
+
+
+	/**
+	 * @return EE_Payment_Processor
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		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
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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;
+		}
+		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
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
+	 * @throws \RuntimeException
+	 * @throws \ReflectionException
+	 * @throws \InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	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'),
+					)
+				);
+			}
+		} elseif ($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()
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @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;
+		}
+		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
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_refund(
+		EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		array $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
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		array $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
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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;
+		// 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.
+	 *
+	 * @param $handle
+	 * @param $r
+	 * @param $url
+	 */
+	public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
+	{
+		if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
+			//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);
+		}
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -37,7 +37,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Payment_Processor) {
+        if ( ! self::$_instance instanceof EE_Payment_Processor) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -108,7 +108,7 @@ 
         $update_txn = true,
         $cancel_url = ''
     ) {
-        if ((float)$amount < 0) {
+        if ((float) $amount < 0) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -132,7 +132,7 @@ 
         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
+                min($amount, $transaction->remaining()), //make sure we don't overcharge
                 $billing_form,
                 $return_url,
                 add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
@@ -178,7 +178,7 @@ 
         /** @type \EE_Transaction $transaction */
         $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
         $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
+        if ( ! $primary_reg instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -193,7 +193,7 @@ 
             $payment_method,
             true
         );
-        $url            = add_query_arg(
+        $url = add_query_arg(
             array(
                 'e_reg_url_link'    => $primary_reg->reg_url_link(),
                 'ee_payment_method' => $payment_method->slug(),
@@ -235,7 +235,7 @@ 
         $separate_IPN_request = true
     ) {
         EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array)$_req_data);
+        $_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) {
@@ -274,7 +274,7 @@ 
                         EEM_Change_Log::instance()->log(
                             EEM_Change_Log::type_gateway,
                             array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
+                                'message'     => 'IPN Exception: '.$e->getMessage(),
                                 'current_url' => EEH_URL::current_url(),
                                 'payment'     => $e->getPaymentProperties(),
                                 'IPN_data'    => $e->getIpnData(),
@@ -318,7 +318,7 @@ 
                         EEM_Change_Log::instance()->log(
                             EEM_Change_Log::type_gateway,
                             array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
+                                'message'     => 'IPN Exception: '.$e->getMessage(),
                                 'current_url' => EEH_URL::current_url(),
                                 'payment'     => $e->getPaymentProperties(),
                                 'IPN_data'    => $e->getIpnData(),
@@ -759,15 +759,15 @@ 
         //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);
+            $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());
+            $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;
+            $refund_amount = (float) abs($refund_amount) * -1;
             // now save it
             $this->_apply_registration_payment($registration, $payment, $refund_amount);
         }

core/libraries/form_sections/form_handlers/FormHandler.php

Indentation +636 added lines, -636 removed lines

@@ -15,7 +15,7 @@ 
 use EventEspresso\core\exceptions\InvalidFormSubmissionException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -34,641 +34,641 @@ 
 abstract class FormHandler implements FormHandlerInterface
 {
 
-    /**
-     * will add opening and closing HTML form tags as well as a submit button
-     */
-    const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
-
-    /**
-     * will add opening and closing HTML form tags but NOT a submit button
-     */
-    const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags but will add a submit button
-     */
-    const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags NOR a submit button
-     */
-    const DO_NOT_SETUP_FORM = 'do_not_setup_form';
-
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     * defaults to true ( ie: form has displayable content )
-     *
-     * @var boolean $displayable
-     */
-    private $displayable = true;
-
-    /**
-     * @var string $form_name
-     */
-    private $form_name;
-
-    /**
-     * @var string $admin_name
-     */
-    private $admin_name;
-
-    /**
-     * @var string $slug
-     */
-    private $slug;
-
-    /**
-     * @var string $submit_btn_text
-     */
-    private $submit_btn_text;
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * form params in key value pairs
-     * can be added to form action URL or as hidden inputs
-     *
-     * @var array $form_args
-     */
-    private $form_args = array();
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * whether or not the form was determined to be invalid
-     *
-     * @var boolean $form_has_errors
-     */
-    private $form_has_errors;
-
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @var EE_Form_Section_Proper $form
-     */
-    private $form;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-
-
-    /**
-     * Form constructor.
-     *
-     * @param string      $form_name
-     * @param string      $admin_name
-     * @param string      $slug
-     * @param string      $form_action
-     * @param string      $form_config
-     * @param EE_Registry $registry
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        EE_Registry $registry
-    ) {
-        $this->setFormName($form_name);
-        $this->setAdminName($admin_name);
-        $this->setSlug($slug);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
-        $this->registry = $registry;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public static function getFormConfigConstants()
-    {
-        return array(
-            FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-            FormHandler::ADD_FORM_TAGS_ONLY,
-            FormHandler::ADD_FORM_SUBMIT_ONLY,
-            FormHandler::DO_NOT_SETUP_FORM,
-        );
-    }
-
-
-
-    /**
-     * @param bool $for_display
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    public function form($for_display = false)
-    {
-        if (! $this->formIsValid()) {
-            return null;
-        }
-        if ($for_display) {
-            $form_config = $this->formConfig();
-            if (
-                $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-                || $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
-            ) {
-                $this->appendSubmitButton();
-                $this->clearFormButtonFloats();
-            }
-        }
-        return $this->form;
-    }
-
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function formIsValid()
-    {
-        if ($this->form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        $form = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-            $this->generate(),
-            $this
-        );
-        if ($this->verifyForm($form)) {
-            $this->setForm($form);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @param EE_Form_Section_Proper|null $form
-     * @return bool
-     * @throws LogicException
-     */
-    public function verifyForm(EE_Form_Section_Proper $form = null)
-    {
-        $form = $form !== null ? $form : $this->form;
-        if ($form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
-                $this->form_name,
-                var_export($form, true)
-            )
-        );
-    }
-
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function setForm(EE_Form_Section_Proper $form)
-    {
-        $this->form = $form;
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function displayable()
-    {
-        return $this->displayable;
-    }
-
-
-
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false)
-    {
-        $this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName()
-    {
-        return $this->form_name;
-    }
-
-
-
-    /**
-     * @param string $form_name
-     * @throws InvalidDataTypeException
-     */
-    public function setFormName($form_name)
-    {
-        if (! is_string($form_name)) {
-            throw new InvalidDataTypeException('$form_name', $form_name, 'string');
-        }
-        $this->form_name = $form_name;
-    }
-
-
-
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName()
-    {
-        return $this->admin_name;
-    }
-
-
-
-    /**
-     * @param string $admin_name
-     * @throws InvalidDataTypeException
-     */
-    public function setAdminName($admin_name)
-    {
-        if (! is_string($admin_name)) {
-            throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
-        }
-        $this->admin_name = $admin_name;
-    }
-
-
-
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
-
-
-
-    /**
-     * @param string $slug
-     * @throws InvalidDataTypeException
-     */
-    public function setSlug($slug)
-    {
-        if (! is_string($slug)) {
-            throw new InvalidDataTypeException('$slug', $slug, 'string');
-        }
-        $this->slug = $slug;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function submitBtnText()
-    {
-        return $this->submit_btn_text;
-    }
-
-
-
-    /**
-     * @param string $submit_btn_text
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setSubmitBtnText($submit_btn_text)
-    {
-        if (! is_string($submit_btn_text)) {
-            throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
-        }
-        if (empty($submit_btn_text)) {
-            throw new InvalidArgumentException(
-                esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
-            );
-        }
-        $this->submit_btn_text = $submit_btn_text;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function formAction()
-    {
-        return ! empty($this->form_args)
-            ? add_query_arg($this->form_args, $this->form_action)
-            : $this->form_action;
-    }
-
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-
-    /**
-     * @param array $form_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addFormActionArgs($form_args = array())
-    {
-        if (is_object($form_args)) {
-            throw new InvalidDataTypeException(
-                '$form_args',
-                $form_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($form_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->form_args = array_merge($this->form_args, $form_args);
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-
-    /**
-     * @param string $form_config
-     * @throws DomainException
-     */
-    public function setFormConfig($form_config)
-    {
-        if (
-        ! in_array(
-            $form_config,
-            array(
-                FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-                FormHandler::ADD_FORM_TAGS_ONLY,
-                FormHandler::ADD_FORM_SUBMIT_ONLY,
-                FormHandler::DO_NOT_SETUP_FORM,
-            ),
-            true
-        )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
-                        'event_espresso'),
-                    $form_config
-                )
-            );
-        }
-        $this->form_config = $form_config;
-    }
-
-
-
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize()
-    {
-        $this->form_has_errors = EE_Error::has_error(true);
-        return true;
-    }
-
-
-
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->form()->enqueue_js();
-    }
-
-
-
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate();
-
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '')
-    {
-        $text = ! empty($text) ? $text : $this->submitBtnText();
-        return new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
-                'html_class'            => 'ee-form-submit',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $text,
-            )
-        );
-    }
-
-
-
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @param string $text
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function appendSubmitButton($text = '')
-    {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
-            return;
-        }
-        $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
-            null,
-            false
-        );
-    }
-
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateCancelButton($text = '')
-    {
-        $cancel_button = new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
-                'html_class'            => 'ee-cancel-form',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
-            )
-        );
-        $cancel_button->set_button_css_attributes(false);
-        return $cancel_button;
-    }
-
-
-
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function clearFormButtonFloats()
-    {
-        $this->form->add_subsections(
-            array(
-                'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
-                ),
-            ),
-            null,
-            false
-        );
-    }
-
-
-
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function display()
-    {
-        $form_html = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
-            ''
-        );
-        $form_config = $this->formConfig();
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_open($this->formAction());
-        }
-        $form_html .= $this->form(true)->get_html($this->form_has_errors);
-        if (
-            $form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_close();
-        }
-        $form_html .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
-            ''
-        );
-        return $form_html;
-    }
-
-
-
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return array
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    public function process($submitted_form_data = array())
-    {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
-            throw new InvalidFormSubmissionException($this->form_name);
-        }
-        $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
-            throw new InvalidFormSubmissionException(
-                $this->form_name,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
-                        'event_espresso'
-                    ),
-                    $this->form_name,
-                    '<br />',
-                    $this->form()->submission_error_message()
-                )
-            );
-        }
-        return $this->form()->valid_data();
-    }
+	/**
+	 * will add opening and closing HTML form tags as well as a submit button
+	 */
+	const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
+
+	/**
+	 * will add opening and closing HTML form tags but NOT a submit button
+	 */
+	const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags but will add a submit button
+	 */
+	const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags NOR a submit button
+	 */
+	const DO_NOT_SETUP_FORM = 'do_not_setup_form';
+
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 * defaults to true ( ie: form has displayable content )
+	 *
+	 * @var boolean $displayable
+	 */
+	private $displayable = true;
+
+	/**
+	 * @var string $form_name
+	 */
+	private $form_name;
+
+	/**
+	 * @var string $admin_name
+	 */
+	private $admin_name;
+
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
+
+	/**
+	 * @var string $submit_btn_text
+	 */
+	private $submit_btn_text;
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * form params in key value pairs
+	 * can be added to form action URL or as hidden inputs
+	 *
+	 * @var array $form_args
+	 */
+	private $form_args = array();
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * whether or not the form was determined to be invalid
+	 *
+	 * @var boolean $form_has_errors
+	 */
+	private $form_has_errors;
+
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @var EE_Form_Section_Proper $form
+	 */
+	private $form;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+
+
+	/**
+	 * Form constructor.
+	 *
+	 * @param string      $form_name
+	 * @param string      $admin_name
+	 * @param string      $slug
+	 * @param string      $form_action
+	 * @param string      $form_config
+	 * @param EE_Registry $registry
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		EE_Registry $registry
+	) {
+		$this->setFormName($form_name);
+		$this->setAdminName($admin_name);
+		$this->setSlug($slug);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
+		$this->registry = $registry;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFormConfigConstants()
+	{
+		return array(
+			FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+			FormHandler::ADD_FORM_TAGS_ONLY,
+			FormHandler::ADD_FORM_SUBMIT_ONLY,
+			FormHandler::DO_NOT_SETUP_FORM,
+		);
+	}
+
+
+
+	/**
+	 * @param bool $for_display
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	public function form($for_display = false)
+	{
+		if (! $this->formIsValid()) {
+			return null;
+		}
+		if ($for_display) {
+			$form_config = $this->formConfig();
+			if (
+				$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+				|| $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
+			) {
+				$this->appendSubmitButton();
+				$this->clearFormButtonFloats();
+			}
+		}
+		return $this->form;
+	}
+
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function formIsValid()
+	{
+		if ($this->form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		$form = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+			$this->generate(),
+			$this
+		);
+		if ($this->verifyForm($form)) {
+			$this->setForm($form);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @param EE_Form_Section_Proper|null $form
+	 * @return bool
+	 * @throws LogicException
+	 */
+	public function verifyForm(EE_Form_Section_Proper $form = null)
+	{
+		$form = $form !== null ? $form : $this->form;
+		if ($form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
+				$this->form_name,
+				var_export($form, true)
+			)
+		);
+	}
+
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function setForm(EE_Form_Section_Proper $form)
+	{
+		$this->form = $form;
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function displayable()
+	{
+		return $this->displayable;
+	}
+
+
+
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false)
+	{
+		$this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName()
+	{
+		return $this->form_name;
+	}
+
+
+
+	/**
+	 * @param string $form_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormName($form_name)
+	{
+		if (! is_string($form_name)) {
+			throw new InvalidDataTypeException('$form_name', $form_name, 'string');
+		}
+		$this->form_name = $form_name;
+	}
+
+
+
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName()
+	{
+		return $this->admin_name;
+	}
+
+
+
+	/**
+	 * @param string $admin_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setAdminName($admin_name)
+	{
+		if (! is_string($admin_name)) {
+			throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
+		}
+		$this->admin_name = $admin_name;
+	}
+
+
+
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
+
+
+
+	/**
+	 * @param string $slug
+	 * @throws InvalidDataTypeException
+	 */
+	public function setSlug($slug)
+	{
+		if (! is_string($slug)) {
+			throw new InvalidDataTypeException('$slug', $slug, 'string');
+		}
+		$this->slug = $slug;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function submitBtnText()
+	{
+		return $this->submit_btn_text;
+	}
+
+
+
+	/**
+	 * @param string $submit_btn_text
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setSubmitBtnText($submit_btn_text)
+	{
+		if (! is_string($submit_btn_text)) {
+			throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
+		}
+		if (empty($submit_btn_text)) {
+			throw new InvalidArgumentException(
+				esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
+			);
+		}
+		$this->submit_btn_text = $submit_btn_text;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function formAction()
+	{
+		return ! empty($this->form_args)
+			? add_query_arg($this->form_args, $this->form_action)
+			: $this->form_action;
+	}
+
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+
+	/**
+	 * @param array $form_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addFormActionArgs($form_args = array())
+	{
+		if (is_object($form_args)) {
+			throw new InvalidDataTypeException(
+				'$form_args',
+				$form_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($form_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->form_args = array_merge($this->form_args, $form_args);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+
+	/**
+	 * @param string $form_config
+	 * @throws DomainException
+	 */
+	public function setFormConfig($form_config)
+	{
+		if (
+		! in_array(
+			$form_config,
+			array(
+				FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+				FormHandler::ADD_FORM_TAGS_ONLY,
+				FormHandler::ADD_FORM_SUBMIT_ONLY,
+				FormHandler::DO_NOT_SETUP_FORM,
+			),
+			true
+		)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
+						'event_espresso'),
+					$form_config
+				)
+			);
+		}
+		$this->form_config = $form_config;
+	}
+
+
+
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize()
+	{
+		$this->form_has_errors = EE_Error::has_error(true);
+		return true;
+	}
+
+
+
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->form()->enqueue_js();
+	}
+
+
+
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate();
+
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '')
+	{
+		$text = ! empty($text) ? $text : $this->submitBtnText();
+		return new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(),
+				'html_id'               => 'ee-form-submit-' . $this->slug(),
+				'html_class'            => 'ee-form-submit',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $text,
+			)
+		);
+	}
+
+
+
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @param string $text
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function appendSubmitButton($text = '')
+	{
+		if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+			return;
+		}
+		$this->form->add_subsections(
+			array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+			null,
+			false
+		);
+	}
+
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '')
+	{
+		$cancel_button = new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
+				'html_id'               => 'ee-cancel-form-' . $this->slug(),
+				'html_class'            => 'ee-cancel-form',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
+			)
+		);
+		$cancel_button->set_button_css_attributes(false);
+		return $cancel_button;
+	}
+
+
+
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function clearFormButtonFloats()
+	{
+		$this->form->add_subsections(
+			array(
+				'clear-submit-btn-float' => new EE_Form_Section_HTML(
+					EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+				),
+			),
+			null,
+			false
+		);
+	}
+
+
+
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function display()
+	{
+		$form_html = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
+			''
+		);
+		$form_config = $this->formConfig();
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_open($this->formAction());
+		}
+		$form_html .= $this->form(true)->get_html($this->form_has_errors);
+		if (
+			$form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_close();
+		}
+		$form_html .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
+			''
+		);
+		return $form_html;
+	}
+
+
+
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	public function process($submitted_form_data = array())
+	{
+		if (! $this->form()->was_submitted($submitted_form_data)) {
+			throw new InvalidFormSubmissionException($this->form_name);
+		}
+		$this->form(true)->receive_form_submission($submitted_form_data);
+		if (! $this->form()->is_valid()) {
+			throw new InvalidFormSubmissionException(
+				$this->form_name,
+				sprintf(
+					esc_html__(
+						'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
+						'event_espresso'
+					),
+					$this->form_name,
+					'<br />',
+					$this->form()->submission_error_message()
+				)
+			);
+		}
+		return $this->form()->valid_data();
+	}
 
 
 

Spacing +18 added lines, -18 removed lines

@@ -14,7 +14,7 @@ 
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\exceptions\InvalidFormSubmissionException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -179,7 +179,7 @@ 
      */
     public function form($for_display = false)
     {
-        if (! $this->formIsValid()) {
+        if ( ! $this->formIsValid()) {
             return null;
         }
         if ($for_display) {
@@ -289,7 +289,7 @@ 
      */
     public function setFormName($form_name)
     {
-        if (! is_string($form_name)) {
+        if ( ! is_string($form_name)) {
             throw new InvalidDataTypeException('$form_name', $form_name, 'string');
         }
         $this->form_name = $form_name;
@@ -315,7 +315,7 @@ 
      */
     public function setAdminName($admin_name)
     {
-        if (! is_string($admin_name)) {
+        if ( ! is_string($admin_name)) {
             throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
         }
         $this->admin_name = $admin_name;
@@ -341,7 +341,7 @@ 
      */
     public function setSlug($slug)
     {
-        if (! is_string($slug)) {
+        if ( ! is_string($slug)) {
             throw new InvalidDataTypeException('$slug', $slug, 'string');
         }
         $this->slug = $slug;
@@ -366,7 +366,7 @@ 
      */
     public function setSubmitBtnText($submit_btn_text)
     {
-        if (! is_string($submit_btn_text)) {
+        if ( ! is_string($submit_btn_text)) {
             throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
         }
         if (empty($submit_btn_text)) {
@@ -397,7 +397,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -521,11 +521,11 @@ 
         $text = ! empty($text) ? $text : $this->submitBtnText();
         return new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(),
+                'html_id'               => 'ee-form-submit-'.$this->slug(),
                 'html_class'            => 'ee-form-submit',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $text,
             )
         );
@@ -543,11 +543,11 @@ 
      */
     public function appendSubmitButton($text = '')
     {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+        if ($this->form->subsection_exists($this->slug().'-submit-btn')) {
             return;
         }
         $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+            array($this->slug().'-submit-btn' => $this->generateSubmitButton($text)),
             null,
             false
         );
@@ -565,11 +565,11 @@ 
     {
         $cancel_button = new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(), // YES! Same name as submit !!!
+                'html_id'               => 'ee-cancel-form-'.$this->slug(),
                 'html_class'            => 'ee-cancel-form',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
             )
         );
@@ -590,7 +590,7 @@ 
         $this->form->add_subsections(
             array(
                 'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+                    EEH_HTML::div('', '', 'clear-float').EEH_HTML::divx()
                 ),
             ),
             null,
@@ -649,11 +649,11 @@ 
      */
     public function process($submitted_form_data = array())
     {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
+        if ( ! $this->form()->was_submitted($submitted_form_data)) {
             throw new InvalidFormSubmissionException($this->form_name);
         }
         $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
+        if ( ! $this->form()->is_valid()) {
             throw new InvalidFormSubmissionException(
                 $this->form_name,
                 sprintf(