eventespresso / event-espresso-core

core/db_models/fields/EE_Primary_Key_Field_Base.php

Indentation +19 added lines, -19 removed lines

@@ -2,24 +2,24 @@
 
 abstract class EE_Primary_Key_Field_Base extends EE_Field_With_Model_Name
 {
-    /**
-     * Overrides parent so it doesn't need to provide so many non-applicable fields
-     *
-     * @param string $table_column
-     * @param string $nicename
-     */
-    public function __construct($table_column, $nicename, $default)
-    {
-        parent::__construct($table_column, $nicename, false, $default, null);
-    }
+	/**
+	 * Overrides parent so it doesn't need to provide so many non-applicable fields
+	 *
+	 * @param string $table_column
+	 * @param string $nicename
+	 */
+	public function __construct($table_column, $nicename, $default)
+	{
+		parent::__construct($table_column, $nicename, false, $default, null);
+	}
 
-    /**
-     * @param $table_alias
-     * @param $name
-     */
-    function _construct_finalize($table_alias, $name, $model_name)
-    {
-        $this->_model_name_pointed_to = $model_name;
-        parent::_construct_finalize($table_alias, $name, $model_name);
-    }
+	/**
+	 * @param $table_alias
+	 * @param $name
+	 */
+	function _construct_finalize($table_alias, $name, $model_name)
+	{
+		$this->_model_name_pointed_to = $model_name;
+		parent::_construct_finalize($table_alias, $name, $model_name);
+	}
 }

core/db_models/fields/EE_Field_With_Model_Name.php

Indentation +74 added lines, -74 removed lines

@@ -8,83 +8,83 @@
  */
 abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base
 {
-    /**
-     * Usually the name of a single model. However, as in the case for custom post types,
-     * it can actually be an array of models
-     *
-     * @var string or array
-     */
-    protected $_model_name_pointed_to;
+	/**
+	 * Usually the name of a single model. However, as in the case for custom post types,
+	 * it can actually be an array of models
+	 *
+	 * @var string or array
+	 */
+	protected $_model_name_pointed_to;
 
-    /**
-     * @param string  $table_column  name fo column for field
-     * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
-     * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
-     *                               dbe a string
-     * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
-     *                               "EEM_"
-     */
-    function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        $this->_model_name_pointed_to = $model_name;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * @param string  $table_column  name fo column for field
+	 * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
+	 * @param boolean $nullable
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+	 *                               dbe a string
+	 * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
+	 *                               "EEM_"
+	 */
+	function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		$this->_model_name_pointed_to = $model_name;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
-    /**
-     * Returns the name of the model(s) pointed to
-     *
-     * @deprecated since version 4.6.7
-     * @return mixed string or array of strings
-     */
-    function get_model_name_pointed_to()
-    {
-        EE_Error::doing_it_wrong('get_model_name_pointed_to',
-            __('This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
-                'event_espresso'), '4.6.7');
-        return $this->_model_name_pointed_to;
-    }
+	/**
+	 * Returns the name of the model(s) pointed to
+	 *
+	 * @deprecated since version 4.6.7
+	 * @return mixed string or array of strings
+	 */
+	function get_model_name_pointed_to()
+	{
+		EE_Error::doing_it_wrong('get_model_name_pointed_to',
+			__('This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
+				'event_espresso'), '4.6.7');
+		return $this->_model_name_pointed_to;
+	}
 
-    /**
-     * Gets the model names pointed to by this field, always as an array
-     * (even if there's only one)
-     *
-     * @return array of model names pointed to by this field
-     */
-    function get_model_names_pointed_to()
-    {
-        if (is_array($this->_model_name_pointed_to)) {
-            return $this->_model_name_pointed_to;
-        } else {
-            return array($this->_model_name_pointed_to);
-        }
-    }
+	/**
+	 * Gets the model names pointed to by this field, always as an array
+	 * (even if there's only one)
+	 *
+	 * @return array of model names pointed to by this field
+	 */
+	function get_model_names_pointed_to()
+	{
+		if (is_array($this->_model_name_pointed_to)) {
+			return $this->_model_name_pointed_to;
+		} else {
+			return array($this->_model_name_pointed_to);
+		}
+	}
 
-    /**
-     * Returns the model's classname (eg EE_Event instead of just Event)
-     *
-     * @return array
-     */
-    function get_model_class_names_pointed_to()
-    {
-        $model_names = array();
-        if (is_array($this->_model_name_pointed_to)) {
-            foreach ($this->_model_name_pointed_to as $model_name) {
-                $model_names[] = "EE_" . $model_name;
-            }
-        } else {
-            $model_names = array("EE_" . $this->_model_name_pointed_to);
-        }
-        return $model_names;
-    }
+	/**
+	 * Returns the model's classname (eg EE_Event instead of just Event)
+	 *
+	 * @return array
+	 */
+	function get_model_class_names_pointed_to()
+	{
+		$model_names = array();
+		if (is_array($this->_model_name_pointed_to)) {
+			foreach ($this->_model_name_pointed_to as $model_name) {
+				$model_names[] = "EE_" . $model_name;
+			}
+		} else {
+			$model_names = array("EE_" . $this->_model_name_pointed_to);
+		}
+		return $model_names;
+	}
 
-    function is_model_obj_of_type_pointed_to($model_obj_or_ID)
-    {
-        foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
-            if ($model_obj_or_ID instanceof $model_obj_classname) {
-                return true;
-            }
-        }
-        return false;
-    }
+	function is_model_obj_of_type_pointed_to($model_obj_or_ID)
+	{
+		foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
+			if ($model_obj_or_ID instanceof $model_obj_classname) {
+				return true;
+			}
+		}
+		return false;
+	}
 }

core/db_models/relations/EE_HABTM_Relation.php

Indentation +199 added lines, -199 removed lines

@@ -12,203 +12,203 @@
  */
 class EE_HABTM_Relation extends EE_Model_Relation_Base
 {
-    /**
-     * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
-     * which joins EE_Event and EE_Question_Group
-     *
-     * @var EEM_Base
-     */
-    protected $_joining_model_name;
-
-    protected $_model_relation_chain_to_join_model;
-
-
-    /**
-     * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
-     * (and an ee joining-model.) This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param bool    $joining_model_name
-     * @param boolean $block_deletes                 for this type of relation, we block by default for now. if there
-     *                                               are related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '')
-    {
-        $this->_joining_model_name = $joining_model_name;
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
-
-    /**
-     * Gets the joining model's object
-     *
-     * @return EEM_Base
-     */
-    public function get_join_model()
-    {
-        return $this->_get_model($this->_joining_model_name);
-    }
-
-
-    /**
-     * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
-     * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws \EE_Error
-     */
-    public function get_join_to_intermediate_model_statement($model_relation_chain)
-    {
-        //create sql like
-        //LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
-        //LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
-        //remember the model relation chain to the JOIN model, because we'll
-        //need it for get_join_statement()
-        $this->_model_relation_chain_to_join_model = $model_relation_chain;
-        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();//get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
-
-        $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
-        $join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
-        //phew! ok, we have all the info we need, now we can create the SQL join string
-        $SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(),
-                $this_table_alias,
-                $this_table_pk_field->get_table_column()) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
-
-        return $SQL;
-    }
-
-
-    /**
-     * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
-     * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
-     * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
-     * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
-     * the intermediate join table, and then to the other model's pk's table
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        if ($this->_model_relation_chain_to_join_model === null) {
-            throw new EE_Error(sprintf(__('When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
-                'event_espresso')));
-        }
-        $join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model,
-                $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
-        $other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
-        $join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
-                $this->get_other_model()->get_this_model_name()) . $other_table_pk_field->get_table_alias();
-        $other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
-
-        $SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(),
-                $join_table_alias,
-                $join_table_fk_field_to_other_table->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
-        return $SQL;
-    }
-
-
-    /**
-     * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
-     * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
-     * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
-     * columns' values
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
-     *                                                            checking existing values and for setting new rows if
-     *                                                            no exact matches.
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        //check if such a relationship already exists
-        $join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-
-        $cols_n_values = array(
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
-        );
-
-        //if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
-            //make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            //make sure we strip THIS models name from the query param
-            $parsed_query = array();
-            foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                = str_replace($this->get_join_model()->get_this_model_name() . ".", "",
-                    $query_param);
-                $parsed_query[$query_param] = $val;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
-
-        $query_params = array($cols_n_values);
-
-
-        $existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
-        //if there is already an entry in the join table, indicating a relationship, we're done
-        //again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
-        //the other tables, use the joining model directly!
-        if (! $existing_entry_in_join_table) {
-            $this->get_join_model()->insert($cols_n_values);
-        }
-        return $other_model_obj;
-    }
-
-
-    /**
-     * Deletes any rows in the join table that have foreign keys matching the other model objects specified
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
-     *                                       values and for removing existing rows if exact matches exist.
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        //check if such a relationship already exists
-        $join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-
-        $cols_n_values = array(
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
-        );
-
-        //if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
-            //make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            //make sure we strip THIS models name from the query param
-            $parsed_query = array();
-            foreach ($where_query as $query_param => $val) {
-                $query_param                = str_replace($this->get_join_model()->get_this_model_name() . ".", "",
-                    $query_param);
-                $parsed_query[$query_param] = $val;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
-
-        $this->get_join_model()->delete(array($cols_n_values));
-        return $other_model_obj;
-    }
+	/**
+	 * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
+	 * which joins EE_Event and EE_Question_Group
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_joining_model_name;
+
+	protected $_model_relation_chain_to_join_model;
+
+
+	/**
+	 * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
+	 * (and an ee joining-model.) This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param bool    $joining_model_name
+	 * @param boolean $block_deletes                 for this type of relation, we block by default for now. if there
+	 *                                               are related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '')
+	{
+		$this->_joining_model_name = $joining_model_name;
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
+
+	/**
+	 * Gets the joining model's object
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_join_model()
+	{
+		return $this->_get_model($this->_joining_model_name);
+	}
+
+
+	/**
+	 * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
+	 * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws \EE_Error
+	 */
+	public function get_join_to_intermediate_model_statement($model_relation_chain)
+	{
+		//create sql like
+		//LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
+		//LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
+		//remember the model relation chain to the JOIN model, because we'll
+		//need it for get_join_statement()
+		$this->_model_relation_chain_to_join_model = $model_relation_chain;
+		$this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();//get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
+				$this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
+
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
+				$this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
+		//phew! ok, we have all the info we need, now we can create the SQL join string
+		$SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(),
+				$this_table_alias,
+				$this_table_pk_field->get_table_column()) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+
+		return $SQL;
+	}
+
+
+	/**
+	 * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
+	 * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
+	 * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
+	 * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
+	 * the intermediate join table, and then to the other model's pk's table
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		if ($this->_model_relation_chain_to_join_model === null) {
+			throw new EE_Error(sprintf(__('When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
+				'event_espresso')));
+		}
+		$join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model,
+				$this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
+		$join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
+				$this->get_other_model()->get_this_model_name()) . $other_table_pk_field->get_table_alias();
+		$other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
+
+		$SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(),
+				$join_table_alias,
+				$join_table_fk_field_to_other_table->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+		return $SQL;
+	}
+
+
+	/**
+	 * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
+	 * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
+	 * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
+	 * columns' values
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
+	 *                                                            checking existing values and for setting new rows if
+	 *                                                            no exact matches.
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		//check if such a relationship already exists
+		$join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+
+		$cols_n_values = array(
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
+		);
+
+		//if $where_query exists lets add them to the query_params.
+		if (! empty($extra_join_model_fields_n_values)) {
+			//make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			//make sure we strip THIS models name from the query param
+			$parsed_query = array();
+			foreach ($extra_join_model_fields_n_values as $query_param => $val) {
+				$query_param                = str_replace($this->get_join_model()->get_this_model_name() . ".", "",
+					$query_param);
+				$parsed_query[$query_param] = $val;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
+
+		$query_params = array($cols_n_values);
+
+
+		$existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
+		//if there is already an entry in the join table, indicating a relationship, we're done
+		//again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
+		//the other tables, use the joining model directly!
+		if (! $existing_entry_in_join_table) {
+			$this->get_join_model()->insert($cols_n_values);
+		}
+		return $other_model_obj;
+	}
+
+
+	/**
+	 * Deletes any rows in the join table that have foreign keys matching the other model objects specified
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
+	 *                                       values and for removing existing rows if exact matches exist.
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		//check if such a relationship already exists
+		$join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+
+		$cols_n_values = array(
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
+		);
+
+		//if $where_query exists lets add them to the query_params.
+		if (! empty($where_query)) {
+			//make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			//make sure we strip THIS models name from the query param
+			$parsed_query = array();
+			foreach ($where_query as $query_param => $val) {
+				$query_param                = str_replace($this->get_join_model()->get_this_model_name() . ".", "",
+					$query_param);
+				$parsed_query[$query_param] = $val;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
+
+		$this->get_join_model()->delete(array($cols_n_values));
+		return $other_model_obj;
+	}
 }

core/EE_Payment_Processor.core.php

Indentation +734 added lines, -734 removed lines

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

core/libraries/payment_methods/EEI_Payment_Method_Interfaces.php

Spacing +3 added lines, -3 removed lines

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

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +98 added lines, -100 removed lines

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

Spacing +97 added lines, -97 removed lines

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

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

Indentation +79 added lines, -79 removed lines

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

Spacing +211 added lines, -212 removed lines

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

modules/ticket_selector/EED_Ticket_Selector.module.php

Indentation +1207 added lines, -1207 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,1218 +14,1218 @@ 
 class EED_Ticket_Selector extends EED_Module
 {
 
-    const debug = false;    //	true false
-
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var \EE_Event
-     */
-    protected static $_event;
-
-    /**
-     * array of datetimes and the spaces available for them
-     *
-     * @access private
-     * @var array
-     */
-    private static $_available_spaces = array();
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @access private
-     * @var int
-     */
-    private static $_max_atndz = EE_INF;
-
-
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool
-     */
-    protected static $_in_iframe = false;
-
-
-
-    /**
-     * @return EED_Ticket_Selector
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Ticket_Selector_Config');
-        $this->set_config_name('EED_Ticket_Selector');
-    }
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // routing
-        EE_Config::register_route('iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector');
-        EE_Config::register_route('process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections');
-        EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
-        add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
-        add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
-        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
-        //add button for iframe code to event editor.
-        add_filter('get_sample_permalink_html', array('EED_Ticket_Selector', 'iframe_code_button'), 10, 2);
-        add_action('admin_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets_admin'), 10);
-    }
-
-
-
-    /**
-     *    set_definitions
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_definitions()
-    {
-        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
-        define('TICKET_SELECTOR_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS);
-        //if config is not set, initialize
-        //If config is not set, set it.
-        if (EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector === null) {
-            EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = new EE_Ticket_Selector_Config();
-        }
-        EE_Registry::$i18n_js_strings['ts_embed_iframe_title'] = __('Copy and Paste the following:', 'event_espresso');
-    }
-
-
-
-    /**
-     *    gets the ball rolling
-     *
-     * @access public
-     * @param    WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-
-    /**
-     * ticket_selector_iframe
-     *
-     * @access    public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function ticket_selector_iframe()
-    {
-        self::$_in_iframe = true;
-        /** @type EEM_Event $EEM_Event */
-        $EEM_Event = EE_Registry::instance()->load_model('Event');
-        $event = $EEM_Event->get_one_by_ID(
-            EE_Registry::instance()->REQ->get('event', 0)
-        );
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        $template_args['ticket_selector'] = EED_Ticket_Selector::display_ticket_selector($event);
-        $template_args['css'] = apply_filters(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
-            array(
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector_embed.css?ver=' . EVENT_ESPRESSO_VERSION,
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css?ver=' . EVENT_ESPRESSO_VERSION,
-                includes_url('css/dashicons.min.css?ver=' . $GLOBALS['wp_version']),
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
-            )
-        );
-        EE_Registry::$i18n_js_strings['ticket_selector_iframe'] = true;
-        EE_Registry::$i18n_js_strings['EEDTicketSelectorMsg'] = esc_html__('Please choose at least one ticket before continuing.',
-            'event_espresso');
-        $template_args['eei18n'] = apply_filters(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__eei18n_js_strings',
-            EE_Registry::localize_i18n_js_strings()
-        );
-        $template_args['js'] = apply_filters(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            array(
-                includes_url('js/jquery/jquery.js?ver=' . $GLOBALS['wp_version']),
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector_iframe_embed.js?ver=' . EVENT_ESPRESSO_VERSION,
-            )
-        );
-        $template_args['notices'] = EEH_Template::display_template(
-            EE_TEMPLATES . 'espresso-ajax-notices.template.php',
-            array(),
-            true
-        );
-        EEH_Template::display_template(
-            TICKET_SELECTOR_TEMPLATES_PATH . 'ticket_selector_chart_iframe.template.php',
-            $template_args
-        );
-        exit;
-    }
-
-
-
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     *
-     * @param string $permalink_string The current html string for the permalink section.
-     * @param int    $id               The post id for the event.
-     * @return string The new html string for the permalink area.
-     */
-    public static function iframe_code_button($permalink_string, $id )
-    {
-        //make sure this is ONLY when editing and the event id has been set.
-        if ( ! empty($id)) {
-            $post = get_post($id);
-            //if NOT event then let's get out.
-            if ($post->post_type !== 'espresso_events') {
-                return $permalink_string;
-            }
-            $permalink_string .= '<a id="js-ticket-selector-embed-trigger" class="button button-small" href="#"  tabindex="-1">'
-                                 . __('Embed', 'event_espresso')
-                                 . '</a> ';
-            $ticket_selector_url = add_query_arg(array('ticket_selector' => 'iframe', 'event' => $id), site_url());
-            $iframe_string = esc_html(
-                '<iframe src="' . $ticket_selector_url . '" width="100%" height="100%"></iframe>'
-            );
-            $permalink_string .= '
+	const debug = false;    //	true false
+
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var \EE_Event
+	 */
+	protected static $_event;
+
+	/**
+	 * array of datetimes and the spaces available for them
+	 *
+	 * @access private
+	 * @var array
+	 */
+	private static $_available_spaces = array();
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @access private
+	 * @var int
+	 */
+	private static $_max_atndz = EE_INF;
+
+
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool
+	 */
+	protected static $_in_iframe = false;
+
+
+
+	/**
+	 * @return EED_Ticket_Selector
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Ticket_Selector_Config');
+		$this->set_config_name('EED_Ticket_Selector');
+	}
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// routing
+		EE_Config::register_route('iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector');
+		EE_Config::register_route('process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections');
+		EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
+		add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
+		add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
+		add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
+		//add button for iframe code to event editor.
+		add_filter('get_sample_permalink_html', array('EED_Ticket_Selector', 'iframe_code_button'), 10, 2);
+		add_action('admin_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets_admin'), 10);
+	}
+
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_definitions()
+	{
+		define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+		define('TICKET_SELECTOR_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS);
+		//if config is not set, initialize
+		//If config is not set, set it.
+		if (EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector === null) {
+			EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = new EE_Ticket_Selector_Config();
+		}
+		EE_Registry::$i18n_js_strings['ts_embed_iframe_title'] = __('Copy and Paste the following:', 'event_espresso');
+	}
+
+
+
+	/**
+	 *    gets the ball rolling
+	 *
+	 * @access public
+	 * @param    WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+
+	/**
+	 * ticket_selector_iframe
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function ticket_selector_iframe()
+	{
+		self::$_in_iframe = true;
+		/** @type EEM_Event $EEM_Event */
+		$EEM_Event = EE_Registry::instance()->load_model('Event');
+		$event = $EEM_Event->get_one_by_ID(
+			EE_Registry::instance()->REQ->get('event', 0)
+		);
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		$template_args['ticket_selector'] = EED_Ticket_Selector::display_ticket_selector($event);
+		$template_args['css'] = apply_filters(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
+			array(
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector_embed.css?ver=' . EVENT_ESPRESSO_VERSION,
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css?ver=' . EVENT_ESPRESSO_VERSION,
+				includes_url('css/dashicons.min.css?ver=' . $GLOBALS['wp_version']),
+				EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+			)
+		);
+		EE_Registry::$i18n_js_strings['ticket_selector_iframe'] = true;
+		EE_Registry::$i18n_js_strings['EEDTicketSelectorMsg'] = esc_html__('Please choose at least one ticket before continuing.',
+			'event_espresso');
+		$template_args['eei18n'] = apply_filters(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__eei18n_js_strings',
+			EE_Registry::localize_i18n_js_strings()
+		);
+		$template_args['js'] = apply_filters(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			array(
+				includes_url('js/jquery/jquery.js?ver=' . $GLOBALS['wp_version']),
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector_iframe_embed.js?ver=' . EVENT_ESPRESSO_VERSION,
+			)
+		);
+		$template_args['notices'] = EEH_Template::display_template(
+			EE_TEMPLATES . 'espresso-ajax-notices.template.php',
+			array(),
+			true
+		);
+		EEH_Template::display_template(
+			TICKET_SELECTOR_TEMPLATES_PATH . 'ticket_selector_chart_iframe.template.php',
+			$template_args
+		);
+		exit;
+	}
+
+
+
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 *
+	 * @param string $permalink_string The current html string for the permalink section.
+	 * @param int    $id               The post id for the event.
+	 * @return string The new html string for the permalink area.
+	 */
+	public static function iframe_code_button($permalink_string, $id )
+	{
+		//make sure this is ONLY when editing and the event id has been set.
+		if ( ! empty($id)) {
+			$post = get_post($id);
+			//if NOT event then let's get out.
+			if ($post->post_type !== 'espresso_events') {
+				return $permalink_string;
+			}
+			$permalink_string .= '<a id="js-ticket-selector-embed-trigger" class="button button-small" href="#"  tabindex="-1">'
+								 . __('Embed', 'event_espresso')
+								 . '</a> ';
+			$ticket_selector_url = add_query_arg(array('ticket_selector' => 'iframe', 'event' => $id), site_url());
+			$iframe_string = esc_html(
+				'<iframe src="' . $ticket_selector_url . '" width="100%" height="100%"></iframe>'
+			);
+			$permalink_string .= '
 <div id="js-ts-iframe" style="display:none">
 	<div style="width:100%; height: 500px;">
 		' . $iframe_string . '
 	</div>
 </div>';
-        }
-        return $permalink_string;
-    }
-
-
-
-    /**
-     *    finds and sets the EE_Event object for use throughout class
-     *
-     * @access    public
-     * @param    mixed $event
-     * @return    bool
-     */
-    protected static function set_event($event = null)
-    {
-        if ($event === null) {
-            global $post;
-            $event = $post;
-        }
-        if ($event instanceof EE_Event) {
-            self::$_event = $event;
-        } else if ($event instanceof WP_Post ) {
-            if ( isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
-                self::$_event = $event->EE_Event;
-            } else if ( $event->post_type === 'espresso_events') {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
-                self::$_event = $event->EE_Event;
-            }
-        } else {
-            $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
-            $dev_msg = $user_msg
-                       . __('In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                    'event_espresso');
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @access public
-     * @param EE_Event $event
-     * @param bool     $view_details
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_ticket_selector($event = null, $view_details = false)
-    {
-        // reset filter for displaying submit button
-        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        // poke and prod incoming event till it tells us what it is
-        if ( ! EED_Ticket_Selector::set_event($event)) {
-            return false;
-        }
-        $event_post = self::$_event instanceof EE_Event ? self::$_event->ID() : $event;
-        // grab event status
-        $_event_active_status = self::$_event->get_active_status();
-        if (
-            ! is_admin()
-            && (
-                ! self::$_event->display_ticket_selector()
-                || $view_details
-                || post_password_required($event_post)
-                || (
-                    $_event_active_status !== EE_Datetime::active
-                    && $_event_active_status !== EE_Datetime::upcoming
-                    && $_event_active_status !== EE_Datetime::sold_out
-                    && ! (
-                        $_event_active_status === EE_Datetime::inactive
-                        && is_user_logged_in()
-                    )
-                )
-            )
-        ) {
-            return ! is_single() ? EED_Ticket_Selector::display_view_details_btn() : '';
-        }
-        $template_args = array();
-        $template_args['event_status'] = $_event_active_status;
-        $template_args['date_format'] = apply_filters('FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format'));
-        $template_args['time_format'] = apply_filters('FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format'));
-        $template_args['EVT_ID'] = self::$_event->ID();
-        $template_args['event'] = self::$_event;
-        // is the event expired ?
-        $template_args['event_is_expired'] = self::$_event->is_expired();
-        if ($template_args['event_is_expired']) {
-            return '<div class="ee-event-expired-notice"><span class="important-notice">'
-                   . __('We\'re sorry, but all tickets sales have ended because the event is expired.',
-                'event_espresso')
-                   . '</span></div>';
-        }
-        $ticket_query_args = array(
-            array('Datetime.EVT_ID' => self::$_event->ID()),
-            'order_by' => array(
-                'TKT_order'              => 'ASC',
-                'TKT_required'           => 'DESC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ),
-        );
-        if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets) {
-            //use the correct applicable time query depending on what version of core is being run.
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query') ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
-        }
-        // get all tickets for this event ordered by the datetime
-        $template_args['tickets'] = EEM_Ticket::instance()->get_all($ticket_query_args);
-        if (count($template_args['tickets']) < 1) {
-            return '<div class="ee-event-expired-notice"><span class="important-notice">'
-                   . __('We\'re sorry, but all ticket sales have ended.', 'event_espresso')
-                   . '</span></div>';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        \EED_Ticket_Selector::$_max_atndz = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-            self::$_event->additional_limit()
-        );
-        $template_args['max_atndz'] = \EED_Ticket_Selector::$_max_atndz;
-        if ($template_args['max_atndz'] < 1) {
-            $sales_closed_msg = __('We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-                'event_espresso');
-            if (current_user_can('edit_post', self::$_event->ID())) {
-                $sales_closed_msg .= sprintf(
-                    __('%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                        'event_espresso'),
-                    '<div class="ee-attention" style="text-align: left;"><b>',
-                    '</b><br />',
-                    $link = '<span class="edit-link"><a class="post-edit-link" href="'
-                            . get_edit_post_link(self::$_event->ID())
-                            . '">',
-                    '</a></span></div>'
-                );
-            }
-            return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-        }
-        $templates['ticket_selector'] = TICKET_SELECTOR_TEMPLATES_PATH . 'ticket_selector_chart.template.php';
-        $templates['ticket_selector'] = apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector__template_path',
-            $templates['ticket_selector'], self::$_event);
-        // redirecting to another site for registration ??
-        $external_url = self::$_event->external_url() !== null || self::$_event->external_url() !== ''
-            ? self::$_event->external_url() : false;
-        // if not redirecting to another site for registration
-        if ( ! $external_url) {
-            // then display the ticket selector
-            $ticket_selector = EEH_Template::locate_template($templates['ticket_selector'], $template_args);
-        } else {
-            // if not we still need to trigger the display of the submit button
-            add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-            //display notice to admin that registration is external
-            $ticket_selector = ! is_admin() ? ''
-                : __('Registration is at an external URL for this event.', 'event_espresso');
-        }
-        // now set up the form (but not for the admin)
-        $ticket_selector = ! is_admin()
-            ? EED_Ticket_Selector::ticket_selector_form_open(
-                self::$_event->ID(),
-                $external_url
-            ) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= ! is_admin() ? EED_Ticket_Selector::display_ticket_selector_submit($external_url) : '';
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-        return $ticket_selector;
-    }
-
-
-
-    /**
-     *    ticket_selector_form_open
-     *
-     * @access        public
-     * @param        int    $ID
-     * @param        string $external_url
-     * @return        string
-     */
-    public static function ticket_selector_form_open($ID = 0, $external_url = '')
-    {
-        // if redirecting, we don't need any anything else
-        if ($external_url) {
-            $html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
-            // open link in new window ?
-            $html .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                false
-            )
-                ? ' target="_blank"'
-                : '';
-            $html .= '>';
-            $query_args = (array)EEH_URL::get_query_string($external_url);
-            foreach ($query_args as $query_arg => $value) {
-                $html .= '
+		}
+		return $permalink_string;
+	}
+
+
+
+	/**
+	 *    finds and sets the EE_Event object for use throughout class
+	 *
+	 * @access    public
+	 * @param    mixed $event
+	 * @return    bool
+	 */
+	protected static function set_event($event = null)
+	{
+		if ($event === null) {
+			global $post;
+			$event = $post;
+		}
+		if ($event instanceof EE_Event) {
+			self::$_event = $event;
+		} else if ($event instanceof WP_Post ) {
+			if ( isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
+				self::$_event = $event->EE_Event;
+			} else if ( $event->post_type === 'espresso_events') {
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
+				self::$_event = $event->EE_Event;
+			}
+		} else {
+			$user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
+			$dev_msg = $user_msg
+					   . __('In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+					'event_espresso');
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @access public
+	 * @param EE_Event $event
+	 * @param bool     $view_details
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_ticket_selector($event = null, $view_details = false)
+	{
+		// reset filter for displaying submit button
+		remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		// poke and prod incoming event till it tells us what it is
+		if ( ! EED_Ticket_Selector::set_event($event)) {
+			return false;
+		}
+		$event_post = self::$_event instanceof EE_Event ? self::$_event->ID() : $event;
+		// grab event status
+		$_event_active_status = self::$_event->get_active_status();
+		if (
+			! is_admin()
+			&& (
+				! self::$_event->display_ticket_selector()
+				|| $view_details
+				|| post_password_required($event_post)
+				|| (
+					$_event_active_status !== EE_Datetime::active
+					&& $_event_active_status !== EE_Datetime::upcoming
+					&& $_event_active_status !== EE_Datetime::sold_out
+					&& ! (
+						$_event_active_status === EE_Datetime::inactive
+						&& is_user_logged_in()
+					)
+				)
+			)
+		) {
+			return ! is_single() ? EED_Ticket_Selector::display_view_details_btn() : '';
+		}
+		$template_args = array();
+		$template_args['event_status'] = $_event_active_status;
+		$template_args['date_format'] = apply_filters('FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format'));
+		$template_args['time_format'] = apply_filters('FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format'));
+		$template_args['EVT_ID'] = self::$_event->ID();
+		$template_args['event'] = self::$_event;
+		// is the event expired ?
+		$template_args['event_is_expired'] = self::$_event->is_expired();
+		if ($template_args['event_is_expired']) {
+			return '<div class="ee-event-expired-notice"><span class="important-notice">'
+				   . __('We\'re sorry, but all tickets sales have ended because the event is expired.',
+				'event_espresso')
+				   . '</span></div>';
+		}
+		$ticket_query_args = array(
+			array('Datetime.EVT_ID' => self::$_event->ID()),
+			'order_by' => array(
+				'TKT_order'              => 'ASC',
+				'TKT_required'           => 'DESC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			),
+		);
+		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets) {
+			//use the correct applicable time query depending on what version of core is being run.
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query') ? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
+		}
+		// get all tickets for this event ordered by the datetime
+		$template_args['tickets'] = EEM_Ticket::instance()->get_all($ticket_query_args);
+		if (count($template_args['tickets']) < 1) {
+			return '<div class="ee-event-expired-notice"><span class="important-notice">'
+				   . __('We\'re sorry, but all ticket sales have ended.', 'event_espresso')
+				   . '</span></div>';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		\EED_Ticket_Selector::$_max_atndz = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+			self::$_event->additional_limit()
+		);
+		$template_args['max_atndz'] = \EED_Ticket_Selector::$_max_atndz;
+		if ($template_args['max_atndz'] < 1) {
+			$sales_closed_msg = __('We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+				'event_espresso');
+			if (current_user_can('edit_post', self::$_event->ID())) {
+				$sales_closed_msg .= sprintf(
+					__('%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+						'event_espresso'),
+					'<div class="ee-attention" style="text-align: left;"><b>',
+					'</b><br />',
+					$link = '<span class="edit-link"><a class="post-edit-link" href="'
+							. get_edit_post_link(self::$_event->ID())
+							. '">',
+					'</a></span></div>'
+				);
+			}
+			return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+		}
+		$templates['ticket_selector'] = TICKET_SELECTOR_TEMPLATES_PATH . 'ticket_selector_chart.template.php';
+		$templates['ticket_selector'] = apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector__template_path',
+			$templates['ticket_selector'], self::$_event);
+		// redirecting to another site for registration ??
+		$external_url = self::$_event->external_url() !== null || self::$_event->external_url() !== ''
+			? self::$_event->external_url() : false;
+		// if not redirecting to another site for registration
+		if ( ! $external_url) {
+			// then display the ticket selector
+			$ticket_selector = EEH_Template::locate_template($templates['ticket_selector'], $template_args);
+		} else {
+			// if not we still need to trigger the display of the submit button
+			add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+			//display notice to admin that registration is external
+			$ticket_selector = ! is_admin() ? ''
+				: __('Registration is at an external URL for this event.', 'event_espresso');
+		}
+		// now set up the form (but not for the admin)
+		$ticket_selector = ! is_admin()
+			? EED_Ticket_Selector::ticket_selector_form_open(
+				self::$_event->ID(),
+				$external_url
+			) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= ! is_admin() ? EED_Ticket_Selector::display_ticket_selector_submit($external_url) : '';
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+		return $ticket_selector;
+	}
+
+
+
+	/**
+	 *    ticket_selector_form_open
+	 *
+	 * @access        public
+	 * @param        int    $ID
+	 * @param        string $external_url
+	 * @return        string
+	 */
+	public static function ticket_selector_form_open($ID = 0, $external_url = '')
+	{
+		// if redirecting, we don't need any anything else
+		if ($external_url) {
+			$html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
+			// open link in new window ?
+			$html .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				false
+			)
+				? ' target="_blank"'
+				: '';
+			$html .= '>';
+			$query_args = (array)EEH_URL::get_query_string($external_url);
+			foreach ($query_args as $query_arg => $value) {
+				$html .= '
 				<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-            return '';
-        }
-        $checkout_url = EEH_Event_View::event_link_url($ID);
-        if ( ! $checkout_url) {
-            EE_Error::add_error(__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__);
-        }
-        $extra_params = self::$_in_iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
-        $html .= wp_nonce_field('process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false);
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, self::$_event);
-        return $html;
-    }
-
-
-
-    /**
-     * display_ticket_selector_submit
-     *
-     * @param        string $external_url
-     * @return        string
-     * @throws \EE_Error
-     */
-    public static function display_ticket_selector_submit($external_url = '')
-    {
-        $html = '';
-        if ( ! is_admin()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= \EED_Ticket_Selector::display_register_now_button();
-                $html .= empty($external_url) ?
-                    \EED_Ticket_Selector::no_tkt_slctr_end_dv()
-                    : \EED_Ticket_Selector::clear_tkt_slctr();
-                $html .= '<br/>' . \EED_Ticket_Selector::ticket_selector_form_close();
-            } else if ( EED_Ticket_Selector::$_max_atndz === 1 ) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ( EED_Ticket_Selector::$_event->is_sold_out() ) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            __(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            EED_Ticket_Selector::$_event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        EED_Ticket_Selector::$_event
-                    );
-                    if (
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                            false,
-                            EED_Ticket_Selector::$_event
-                        )
-                    ) {
-                        $html .= \EED_Ticket_Selector::display_register_now_button();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .= \EED_Ticket_Selector::no_tkt_slctr_end_dv();
-                } else if (
-                    apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                    && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= EED_Ticket_Selector::display_view_details_btn(true);
-                }
-            } else if (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= \EED_Ticket_Selector::no_tkt_slctr_end_dv();
-                $html .= EED_Ticket_Selector::display_view_details_btn();
-            } else {
-                if (
-                    apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        EED_Ticket_Selector::$_event
-                    )
-                ) {
-                    $html .= \EED_Ticket_Selector::display_register_now_button();
-                }
-                // no submit or view details button, and no additional content
-                $html .= \EED_Ticket_Selector::no_tkt_slctr_end_dv();
-            }
-            if ( ! is_archive()) {
-                $html .= \EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
-            }
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public static function clear_tkt_slctr()
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div>';
-    }
-
-
-
-    /**
-     * @deprecated 4.9.13
-     * @return string
-     */
-    public static function tkt_slctr_end_dv()
-    {
-        return \EED_Ticket_Selector::clear_tkt_slctr();
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public static function no_tkt_slctr_end_dv()
-    {
-        // DWMTS event, no TS, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div></div>';
-    }
-
-
-
-    /**
-     *    ticket_selector_form_close
-     *
-     * @access        public
-     * @access        public
-     * @return        string
-     */
-    public static function ticket_selector_form_close()
-    {
-        return '</form>';
-    }
-
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_register_now_button()
-    {
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            __('Register Now', 'event_espresso'),
-            EED_Ticket_Selector::$_event
-        );
-        $external_url = EED_Ticket_Selector::$_event->external_url();
-        $html = '<input id="ticket-selector-submit-' . EED_Ticket_Selector::$_event->ID() . '-btn"';
-        $html .= ' class="ticket-selector-submit-btn ';
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            EED_Ticket_Selector::$_event
-        );
-        return $html;
-    }
-
-
-    /**
-     * display_view_details_btn
-     *
-     * @access public
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_view_details_btn($DWMTS = false)
-    {
-        if ( ! self::$_event->get_permalink()) {
-            EE_Error::add_error(
-                __('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $view_details_btn = '<form method="POST" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            self::$_event->get_permalink(),
-            self::$_event
-        );
-        $view_details_btn .= '">';
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            __('View Details', 'event_espresso'),
-            self::$_event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . self::$_event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', self::$_event);
-        if ($DWMTS) {
-            $view_details_btn .= \EED_Ticket_Selector::ticket_selector_form_close();
-            $view_details_btn .= \EED_Ticket_Selector::no_tkt_slctr_end_dv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= \EED_Ticket_Selector::clear_tkt_slctr();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= \EED_Ticket_Selector::ticket_selector_form_close();
-        }
-        return $view_details_btn;
-    }
-
-
-
-    /**
-     *    cancel_ticket_selections
-     *
-     * @access        public
-     * @access        public
-     * @return        string
-     */
-    public static function cancel_ticket_selections()
-    {
-        // check nonce
-        if ( ! EED_Ticket_Selector::process_ticket_selector_nonce('cancel_ticket_selections')) {
-            return false;
-        }
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        if (EE_Registry::instance()->REQ->is_set('event_id')) {
-            wp_safe_redirect(
-                EEH_Event_View::event_link_url(
-                    EE_Registry::instance()->REQ->get('event_id')
-                )
-            );
-        } else {
-            wp_safe_redirect(
-                site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
-            );
-        }
-        die();
-    }
-
-
-
-    /**
-     *    process_ticket_selector_nonce
-     *
-     * @access public
-     * @param  string $nonce_name
-     * @param string  $id
-     * @return bool
-     */
-    public static function process_ticket_selector_nonce($nonce_name, $id = '')
-    {
-        $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
-        if (
-            ! is_admin()
-            && (
-                ! EE_Registry::instance()->REQ->is_set($nonce_name_with_id)
-                || ! wp_verify_nonce(
-                    EE_Registry::instance()->REQ->get($nonce_name_with_id),
-                    $nonce_name
-                )
-            )
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     *    process_ticket_selections
-     *
-     * @access public
-     * @return array|boolean
-     * @throws \EE_Error
-     */
-    public function process_ticket_selections()
-    {
-        do_action('EED_Ticket_Selector__process_ticket_selections__before');
-        // do we have an event id?
-        if ( ! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
-            // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        //if event id is valid
-        $id = absint(EE_Registry::instance()->REQ->get('tkt-slctr-event-id'));
-        // check nonce
-        if ( ! EED_Ticket_Selector::process_ticket_selector_nonce('process_ticket_selections', $id)) {
-            return false;
-        }
-        //		d( EE_Registry::instance()->REQ );
-        self::$_available_spaces = array(
-            'tickets'   => array(),
-            'datetimes' => array(),
-        );
-        //we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart.
-        // When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc.
-        EE_Registry::instance()->load_core('Session');
-        // unless otherwise requested, clear the session
-        if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        //d( EE_Registry::instance()->SSN );
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // validate/sanitize data
-        $valid = self::_validate_post_data($id);
-        //EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ );
-        //check total tickets ordered vs max number of attendees that can register
-        if ($valid['total_tickets'] > $valid['max_atndz']) {
-            // ordering too many tickets !!!
-            $total_tickets_string = _n('You have attempted to purchase %s ticket.',
-                'You have attempted to purchase %s tickets.', $valid['total_tickets'], 'event_espresso');
-            $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
-            // dev only message
-            $max_atndz_string = _n('The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                $valid['max_atndz'], 'event_espresso');
-            $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
-            EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            // all data appears to be valid
-            $tckts_slctd = false;
-            $tickets_added = 0;
-            $valid = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data', $valid);
-            if ($valid['total_tickets'] > 0) {
-                // load cart
-                EE_Registry::instance()->load_core('Cart');
-                // cycle thru the number of data rows sent from the event listing
-                for ($x = 0; $x < $valid['rows']; $x++) {
-                    // does this row actually contain a ticket quantity?
-                    if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
-                        // YES we have a ticket quantity
-                        $tckts_slctd = true;
-                        //						d( $valid['ticket_obj'][$x] );
-                        if ($valid['ticket_obj'][$x] instanceof EE_Ticket) {
-                            // then add ticket to cart
-                            $tickets_added += self::_add_ticket_to_cart($valid['ticket_obj'][$x], $valid['qty'][$x]);
-                            if (EE_Error::has_error()) {
-                                break;
-                            }
-                        } else {
-                            // nothing added to cart retrieved
-                            EE_Error::add_error(
-                                sprintf(__('A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
-                                    'event_espresso'), '<br/>'),
-                                __FILE__, __FUNCTION__, __LINE__
-                            );
-                        }
-                    }
-                }
-            }
-            do_action(
-                'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-                EE_Registry::instance()->CART,
-                $this
-            );
-            //d( EE_Registry::instance()->CART );
-            //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
-            if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) {
-                if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
-                    do_action(
-                        'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
-                        EE_Registry::instance()->CART,
-                        $this
-                    );
-                    EE_Registry::instance()->CART->recalculate_all_cart_totals();
-                    EE_Registry::instance()->CART->save_cart(false);
-                    // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< OR HERE TO KILL REDIRECT AFTER CART UPDATE
-                    // just return TRUE for registrations being made from admin
-                    if (is_admin()) {
-                        return true;
-                    }
-                    EE_Error::get_notices(false, true);
-                    wp_safe_redirect(
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
-                            EE_Registry::instance()->CFG->core->reg_page_url()
-                        )
-                    );
-                    exit();
-                } else {
-                    if ( ! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
-                        // nothing added to cart
-                        EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'), __FILE__,
-                            __FUNCTION__, __LINE__);
-                    }
-                }
-            } else {
-                // no ticket quantities were selected
-                EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.',
-                    'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
-        // at this point, just return if registration is being made from admin
-        if (is_admin()) {
-            return false;
-        }
-        if ($valid['return_url']) {
-            EE_Error::get_notices(false, true);
-            wp_safe_redirect($valid['return_url']);
-            exit();
-        } elseif (isset($event_to_add['id'])) {
-            EE_Error::get_notices(false, true);
-            wp_safe_redirect(get_permalink($event_to_add['id']));
-            exit();
-        } else {
-            echo EE_Error::get_notices();
-        }
-        return false;
-    }
-
-
-
-    /**
-     *    validate_post_data
-     *
-     * @access        private
-     * @param int $id
-     * @return array|FALSE
-     */
-    private static function _validate_post_data($id = 0)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! $id) {
-            EE_Error::add_error(
-                __('The event id provided was not valid.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // start with an empty array()
-        $valid_data = array();
-        // grab valid id
-        $valid_data['id'] = $id;
-        // grab and sanitize return-url
-        $valid_data['return_url'] = esc_url_raw(EE_Registry::instance()->REQ->get('tkt-slctr-return-url-' . $id));
-        // array of other form names
-        $inputs_to_clean = array(
-            'event_id'   => 'tkt-slctr-event-id',
-            'max_atndz'  => 'tkt-slctr-max-atndz-',
-            'rows'       => 'tkt-slctr-rows-',
-            'qty'        => 'tkt-slctr-qty-',
-            'ticket_id'  => 'tkt-slctr-ticket-id-',
-            'return_url' => 'tkt-slctr-return-url-',
-        );
-        // let's track the total number of tickets ordered.'
-        $valid_data['total_tickets'] = 0;
-        // cycle through $inputs_to_clean array
-        foreach ($inputs_to_clean as $what => $input_to_clean) {
-            // check for POST data
-            if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
-                // grab value
-                $input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
-                switch ($what) {
-                    // integers
-                    case 'event_id':
-                        $valid_data[$what] = absint($input_value);
-                        // get event via the event id we put in the form
-                        $valid_data['event'] = EE_Registry::instance()
-                                                          ->load_model('Event')
-                                                          ->get_one_by_ID($valid_data['event_id']);
-                        break;
-                    case 'rows':
-                    case 'max_atndz':
-                        $valid_data[$what] = absint($input_value);
-                        break;
-                    // arrays of integers
-                    case 'qty':
-                        /** @var array $row_qty */
-                        $row_qty = $input_value;
-                        // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if ( ! is_array($row_qty)) {
-                            // get number of rows
-                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
-                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
-                                : 1;
-                            // explode ints by the dash
-                            $row_qty = explode('-', $row_qty);
-                            $row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
-                            $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
-                            $row_qty = array($row => $qty);
-                            //								 d( $row_qty );
-                            for ($x = 1; $x <= $rows; $x++) {
-                                if ( ! isset($row_qty[$x])) {
-                                    $row_qty[$x] = 0;
-                                }
-                            }
-                        }
-                        ksort($row_qty);
-                        //							 d( $row_qty );
-                        // cycle thru values
-                        foreach ($row_qty as $qty) {
-                            $qty = absint($qty);
-                            // sanitize as integers
-                            $valid_data[$what][] = $qty;
-                            $valid_data['total_tickets'] += $qty;
-                        }
-                        break;
-                    // array of integers
-                    case 'ticket_id':
-                        $value_array = array();
-                        // cycle thru values
-                        foreach ((array)$input_value as $key => $value) {
-                            // allow only numbers, letters,  spaces, commas and dashes
-                            $value_array[$key] = wp_strip_all_tags($value);
-                            // get ticket via the ticket id we put in the form
-                            $ticket_obj = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($value);
-                            $valid_data['ticket_obj'][$key] = $ticket_obj;
-                        }
-                        $valid_data[$what] = $value_array;
-                        break;
-                    case 'return_url' :
-                        // grab and sanitize return-url
-                        $valid_data[$what] = esc_url_raw($input_value);
-                        break;
-                }    // end switch $what
-            }
-        }    // end foreach $inputs_to_clean
-        //		d( $valid_data );
-        //		die();
-        return $valid_data;
-    }
-
-
-
-    /**
-     *    adds a ticket to the cart
-     *
-     * @access   private
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    private static function _add_ticket_to_cart(EE_Ticket $ticket = null, $qty = 1)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // get the number of spaces left for this datetime ticket
-        $available_spaces = self::_ticket_datetime_availability($ticket);
-        // compare available spaces against the number of tickets being purchased
-        if ($available_spaces >= $qty) {
-            // allow addons to prevent a ticket from being added to cart
-            if ( ! apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart', true, $ticket,
-                $qty, $available_spaces)
-            ) {
-                return false;
-            }
-            $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
-            // add event to cart
-            if (EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) {
-                self::_recalculate_ticket_datetime_availability($ticket, $qty);
-                return true;
-            } else {
-                return false;
-            }
-        } else {
-            // tickets can not be purchased but let's find the exact number left for the last ticket selected PRIOR to subtracting tickets
-            $available_spaces = self::_ticket_datetime_availability($ticket, true);
-            // greedy greedy greedy eh?
-            if ($available_spaces > 0) {
-                if (
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
-                    true,
-                    $ticket,
-                    $qty,
-                    $available_spaces
-                )
-                ) {
-                    EED_Ticket_Selector::_display_availability_error($available_spaces);
-                }
-            } else {
-                EE_Error::add_error(
-                    __('We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
-                        'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-            return false;
-        }
-    }
-
-
-
-    /**
-     *  _display_availability_error
-     *
-     * @access    private
-     * @param int $available_spaces
-     * @throws \EE_Error
-     */
-    private static function _display_availability_error($available_spaces = 1)
-    {
-        // add error messaging - we're using the _n function that will generate
-        // the appropriate singular or plural message based on the number of $available_spaces
-        if (EE_Registry::instance()->CART->all_ticket_quantity_count()) {
-            $msg = sprintf(
-                _n(
-                    'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                    'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                    $available_spaces,
-                    'event_espresso'
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        } else {
-            $msg = sprintf(
-                _n(
-                    'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                    'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                    $available_spaces,
-                    'event_espresso'
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        }
-        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-    }
-
-
-
-    /**
-     * _ticket_datetime_availability
-     * creates an array of tickets plus all of the datetimes available to each ticket
-     * and tracks the spaces remaining for each of those datetimes
-     *
-     * @access private
-     * @param EE_Ticket $ticket - selected ticket
-     * @param bool      $get_original_ticket_spaces
-     * @return int
-     * @throws \EE_Error
-     */
-    private static function _ticket_datetime_availability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
-    {
-        // if the $_available_spaces array has not been set up yet...
-        if ( ! isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
-            self::_set_initial_ticket_datetime_availability($ticket);
-        }
-        $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ((array)self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
-                // if we want the original datetime availability BEFORE we started subtracting tickets ?
-                if ($get_original_ticket_spaces) {
-                    // then grab the available spaces from the "tickets" array and compare with the above to get the lowest number
-                    $available_spaces = min($available_spaces,
-                        self::$_available_spaces['tickets'][$ticket->ID()][$DTD_ID]);
-                } else {
-                    // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][$DTD_ID]);
-                }
-            }
-        }
-        return $available_spaces;
-    }
-
-
-
-    /**
-     * _set_initial_ticket_datetime_availability
-     *
-     * @access private
-     * @param EE_Ticket $ticket
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _set_initial_ticket_datetime_availability(EE_Ticket $ticket)
-    {
-        // first, get all of the datetimes that are available to this ticket
-        $datetimes = $ticket->get_many_related(
-            'Datetime',
-            array(
-                array(
-                    'DTT_EVT_end' => array(
-                        '>=',
-                        EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-                    ),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-        if ( ! empty($datetimes)) {
-            // now loop thru all of the datetimes
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    // the number of spaces available for the datetime without considering individual ticket quantities
-                    $spaces_remaining = $datetime->spaces_remaining();
-                    // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    self::$_available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min(
-                        $ticket->qty() - $ticket->sold(),
-                        $spaces_remaining
-                    );
-                    // if the remaining spaces for this datetime is already set, then compare that against the datetime spaces remaining, and take the lowest number,
-                    // else just take the datetime spaces remaining, and assign to the datetimes array
-                    self::$_available_spaces['datetimes'][$datetime->ID()] = isset(self::$_available_spaces['datetimes'][$datetime->ID()])
-                        ? min(self::$_available_spaces['datetimes'][$datetime->ID()], $spaces_remaining)
-                        : $spaces_remaining;
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    _recalculate_ticket_datetime_availability
-     *
-     * @access    private
-     * @param    EE_Ticket $ticket
-     * @param    int       $qty
-     * @return    void
-     */
-    private static function _recalculate_ticket_datetime_availability(EE_Ticket $ticket, $qty = 0)
-    {
-        if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ((array)self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
-                // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                self::$_available_spaces['datetimes'][$DTD_ID] -= $qty;
-            }
-        }
-    }
-
-
-
-    /**
-     *    load js
-     *
-     * @access        public
-     * @return        void
-     */
-    public static function load_tckt_slctr_assets()
-    {
-        // add some style
-        if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
-            wp_register_style('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css');
-            wp_enqueue_style('ticket_selector');
-            // make it dance
-            // wp_register_script('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', array('espresso_core'), '', TRUE);
-            // wp_enqueue_script('ticket_selector');
-        }
-    }
-
-
-
-    public static function load_tckt_slctr_assets_admin()
-    {
-        //iframe button js on admin event editor page
-        if (EE_Registry::instance()->REQ->get('page') === 'espresso_events'
-            && EE_Registry::instance()->REQ->get('action') === 'edit'
-        ) {
-            wp_register_script('ticket_selector_embed', TICKET_SELECTOR_ASSETS_URL . 'ticket-selector-embed.js',
-                array('ee-dialog'), EVENT_ESPRESSO_VERSION, true);
-            wp_enqueue_script('ticket_selector_embed');
-        }
-    }
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+			return '';
+		}
+		$checkout_url = EEH_Event_View::event_link_url($ID);
+		if ( ! $checkout_url) {
+			EE_Error::add_error(__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__);
+		}
+		$extra_params = self::$_in_iframe ? ' target="_blank"' : '';
+		$html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
+		$html .= wp_nonce_field('process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false);
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		$html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, self::$_event);
+		return $html;
+	}
+
+
+
+	/**
+	 * display_ticket_selector_submit
+	 *
+	 * @param        string $external_url
+	 * @return        string
+	 * @throws \EE_Error
+	 */
+	public static function display_ticket_selector_submit($external_url = '')
+	{
+		$html = '';
+		if ( ! is_admin()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= \EED_Ticket_Selector::display_register_now_button();
+				$html .= empty($external_url) ?
+					\EED_Ticket_Selector::no_tkt_slctr_end_dv()
+					: \EED_Ticket_Selector::clear_tkt_slctr();
+				$html .= '<br/>' . \EED_Ticket_Selector::ticket_selector_form_close();
+			} else if ( EED_Ticket_Selector::$_max_atndz === 1 ) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ( EED_Ticket_Selector::$_event->is_sold_out() ) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							EED_Ticket_Selector::$_event->name(),
+							'</p>',
+							'<br />'
+						),
+						EED_Ticket_Selector::$_event
+					);
+					if (
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+							false,
+							EED_Ticket_Selector::$_event
+						)
+					) {
+						$html .= \EED_Ticket_Selector::display_register_now_button();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .= \EED_Ticket_Selector::no_tkt_slctr_end_dv();
+				} else if (
+					apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+					&& ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= EED_Ticket_Selector::display_view_details_btn(true);
+				}
+			} else if (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= \EED_Ticket_Selector::no_tkt_slctr_end_dv();
+				$html .= EED_Ticket_Selector::display_view_details_btn();
+			} else {
+				if (
+					apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						EED_Ticket_Selector::$_event
+					)
+				) {
+					$html .= \EED_Ticket_Selector::display_register_now_button();
+				}
+				// no submit or view details button, and no additional content
+				$html .= \EED_Ticket_Selector::no_tkt_slctr_end_dv();
+			}
+			if ( ! is_archive()) {
+				$html .= \EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
+			}
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public static function clear_tkt_slctr()
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div>';
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.13
+	 * @return string
+	 */
+	public static function tkt_slctr_end_dv()
+	{
+		return \EED_Ticket_Selector::clear_tkt_slctr();
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public static function no_tkt_slctr_end_dv()
+	{
+		// DWMTS event, no TS, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div></div>';
+	}
+
+
+
+	/**
+	 *    ticket_selector_form_close
+	 *
+	 * @access        public
+	 * @access        public
+	 * @return        string
+	 */
+	public static function ticket_selector_form_close()
+	{
+		return '</form>';
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_register_now_button()
+	{
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			__('Register Now', 'event_espresso'),
+			EED_Ticket_Selector::$_event
+		);
+		$external_url = EED_Ticket_Selector::$_event->external_url();
+		$html = '<input id="ticket-selector-submit-' . EED_Ticket_Selector::$_event->ID() . '-btn"';
+		$html .= ' class="ticket-selector-submit-btn ';
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html .= ' type="submit" value="' . $btn_text . '" />';
+		$html .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			EED_Ticket_Selector::$_event
+		);
+		return $html;
+	}
+
+
+	/**
+	 * display_view_details_btn
+	 *
+	 * @access public
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_view_details_btn($DWMTS = false)
+	{
+		if ( ! self::$_event->get_permalink()) {
+			EE_Error::add_error(
+				__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$view_details_btn = '<form method="POST" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			self::$_event->get_permalink(),
+			self::$_event
+		);
+		$view_details_btn .= '">';
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			__('View Details', 'event_espresso'),
+			self::$_event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . self::$_event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', self::$_event);
+		if ($DWMTS) {
+			$view_details_btn .= \EED_Ticket_Selector::ticket_selector_form_close();
+			$view_details_btn .= \EED_Ticket_Selector::no_tkt_slctr_end_dv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= \EED_Ticket_Selector::clear_tkt_slctr();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= \EED_Ticket_Selector::ticket_selector_form_close();
+		}
+		return $view_details_btn;
+	}
+
+
+
+	/**
+	 *    cancel_ticket_selections
+	 *
+	 * @access        public
+	 * @access        public
+	 * @return        string
+	 */
+	public static function cancel_ticket_selections()
+	{
+		// check nonce
+		if ( ! EED_Ticket_Selector::process_ticket_selector_nonce('cancel_ticket_selections')) {
+			return false;
+		}
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		if (EE_Registry::instance()->REQ->is_set('event_id')) {
+			wp_safe_redirect(
+				EEH_Event_View::event_link_url(
+					EE_Registry::instance()->REQ->get('event_id')
+				)
+			);
+		} else {
+			wp_safe_redirect(
+				site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
+			);
+		}
+		die();
+	}
+
+
+
+	/**
+	 *    process_ticket_selector_nonce
+	 *
+	 * @access public
+	 * @param  string $nonce_name
+	 * @param string  $id
+	 * @return bool
+	 */
+	public static function process_ticket_selector_nonce($nonce_name, $id = '')
+	{
+		$nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
+		if (
+			! is_admin()
+			&& (
+				! EE_Registry::instance()->REQ->is_set($nonce_name_with_id)
+				|| ! wp_verify_nonce(
+					EE_Registry::instance()->REQ->get($nonce_name_with_id),
+					$nonce_name
+				)
+			)
+		) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 *    process_ticket_selections
+	 *
+	 * @access public
+	 * @return array|boolean
+	 * @throws \EE_Error
+	 */
+	public function process_ticket_selections()
+	{
+		do_action('EED_Ticket_Selector__process_ticket_selections__before');
+		// do we have an event id?
+		if ( ! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
+			// $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		//if event id is valid
+		$id = absint(EE_Registry::instance()->REQ->get('tkt-slctr-event-id'));
+		// check nonce
+		if ( ! EED_Ticket_Selector::process_ticket_selector_nonce('process_ticket_selections', $id)) {
+			return false;
+		}
+		//		d( EE_Registry::instance()->REQ );
+		self::$_available_spaces = array(
+			'tickets'   => array(),
+			'datetimes' => array(),
+		);
+		//we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart.
+		// When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc.
+		EE_Registry::instance()->load_core('Session');
+		// unless otherwise requested, clear the session
+		if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		//d( EE_Registry::instance()->SSN );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// validate/sanitize data
+		$valid = self::_validate_post_data($id);
+		//EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ );
+		//check total tickets ordered vs max number of attendees that can register
+		if ($valid['total_tickets'] > $valid['max_atndz']) {
+			// ordering too many tickets !!!
+			$total_tickets_string = _n('You have attempted to purchase %s ticket.',
+				'You have attempted to purchase %s tickets.', $valid['total_tickets'], 'event_espresso');
+			$limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
+			// dev only message
+			$max_atndz_string = _n('The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				$valid['max_atndz'], 'event_espresso');
+			$limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
+			EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			// all data appears to be valid
+			$tckts_slctd = false;
+			$tickets_added = 0;
+			$valid = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data', $valid);
+			if ($valid['total_tickets'] > 0) {
+				// load cart
+				EE_Registry::instance()->load_core('Cart');
+				// cycle thru the number of data rows sent from the event listing
+				for ($x = 0; $x < $valid['rows']; $x++) {
+					// does this row actually contain a ticket quantity?
+					if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
+						// YES we have a ticket quantity
+						$tckts_slctd = true;
+						//						d( $valid['ticket_obj'][$x] );
+						if ($valid['ticket_obj'][$x] instanceof EE_Ticket) {
+							// then add ticket to cart
+							$tickets_added += self::_add_ticket_to_cart($valid['ticket_obj'][$x], $valid['qty'][$x]);
+							if (EE_Error::has_error()) {
+								break;
+							}
+						} else {
+							// nothing added to cart retrieved
+							EE_Error::add_error(
+								sprintf(__('A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
+									'event_espresso'), '<br/>'),
+								__FILE__, __FUNCTION__, __LINE__
+							);
+						}
+					}
+				}
+			}
+			do_action(
+				'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+				EE_Registry::instance()->CART,
+				$this
+			);
+			//d( EE_Registry::instance()->CART );
+			//die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
+			if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) {
+				if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
+					do_action(
+						'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
+						EE_Registry::instance()->CART,
+						$this
+					);
+					EE_Registry::instance()->CART->recalculate_all_cart_totals();
+					EE_Registry::instance()->CART->save_cart(false);
+					// exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< OR HERE TO KILL REDIRECT AFTER CART UPDATE
+					// just return TRUE for registrations being made from admin
+					if (is_admin()) {
+						return true;
+					}
+					EE_Error::get_notices(false, true);
+					wp_safe_redirect(
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
+							EE_Registry::instance()->CFG->core->reg_page_url()
+						)
+					);
+					exit();
+				} else {
+					if ( ! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+						// nothing added to cart
+						EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'), __FILE__,
+							__FUNCTION__, __LINE__);
+					}
+				}
+			} else {
+				// no ticket quantities were selected
+				EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.',
+					'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		//die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
+		// at this point, just return if registration is being made from admin
+		if (is_admin()) {
+			return false;
+		}
+		if ($valid['return_url']) {
+			EE_Error::get_notices(false, true);
+			wp_safe_redirect($valid['return_url']);
+			exit();
+		} elseif (isset($event_to_add['id'])) {
+			EE_Error::get_notices(false, true);
+			wp_safe_redirect(get_permalink($event_to_add['id']));
+			exit();
+		} else {
+			echo EE_Error::get_notices();
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *    validate_post_data
+	 *
+	 * @access        private
+	 * @param int $id
+	 * @return array|FALSE
+	 */
+	private static function _validate_post_data($id = 0)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! $id) {
+			EE_Error::add_error(
+				__('The event id provided was not valid.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// start with an empty array()
+		$valid_data = array();
+		// grab valid id
+		$valid_data['id'] = $id;
+		// grab and sanitize return-url
+		$valid_data['return_url'] = esc_url_raw(EE_Registry::instance()->REQ->get('tkt-slctr-return-url-' . $id));
+		// array of other form names
+		$inputs_to_clean = array(
+			'event_id'   => 'tkt-slctr-event-id',
+			'max_atndz'  => 'tkt-slctr-max-atndz-',
+			'rows'       => 'tkt-slctr-rows-',
+			'qty'        => 'tkt-slctr-qty-',
+			'ticket_id'  => 'tkt-slctr-ticket-id-',
+			'return_url' => 'tkt-slctr-return-url-',
+		);
+		// let's track the total number of tickets ordered.'
+		$valid_data['total_tickets'] = 0;
+		// cycle through $inputs_to_clean array
+		foreach ($inputs_to_clean as $what => $input_to_clean) {
+			// check for POST data
+			if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
+				// grab value
+				$input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
+				switch ($what) {
+					// integers
+					case 'event_id':
+						$valid_data[$what] = absint($input_value);
+						// get event via the event id we put in the form
+						$valid_data['event'] = EE_Registry::instance()
+														  ->load_model('Event')
+														  ->get_one_by_ID($valid_data['event_id']);
+						break;
+					case 'rows':
+					case 'max_atndz':
+						$valid_data[$what] = absint($input_value);
+						break;
+					// arrays of integers
+					case 'qty':
+						/** @var array $row_qty */
+						$row_qty = $input_value;
+						// if qty is coming from a radio button input, then we need to assemble an array of rows
+						if ( ! is_array($row_qty)) {
+							// get number of rows
+							$rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
+								? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
+								: 1;
+							// explode ints by the dash
+							$row_qty = explode('-', $row_qty);
+							$row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
+							$qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
+							$row_qty = array($row => $qty);
+							//								 d( $row_qty );
+							for ($x = 1; $x <= $rows; $x++) {
+								if ( ! isset($row_qty[$x])) {
+									$row_qty[$x] = 0;
+								}
+							}
+						}
+						ksort($row_qty);
+						//							 d( $row_qty );
+						// cycle thru values
+						foreach ($row_qty as $qty) {
+							$qty = absint($qty);
+							// sanitize as integers
+							$valid_data[$what][] = $qty;
+							$valid_data['total_tickets'] += $qty;
+						}
+						break;
+					// array of integers
+					case 'ticket_id':
+						$value_array = array();
+						// cycle thru values
+						foreach ((array)$input_value as $key => $value) {
+							// allow only numbers, letters,  spaces, commas and dashes
+							$value_array[$key] = wp_strip_all_tags($value);
+							// get ticket via the ticket id we put in the form
+							$ticket_obj = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($value);
+							$valid_data['ticket_obj'][$key] = $ticket_obj;
+						}
+						$valid_data[$what] = $value_array;
+						break;
+					case 'return_url' :
+						// grab and sanitize return-url
+						$valid_data[$what] = esc_url_raw($input_value);
+						break;
+				}    // end switch $what
+			}
+		}    // end foreach $inputs_to_clean
+		//		d( $valid_data );
+		//		die();
+		return $valid_data;
+	}
+
+
+
+	/**
+	 *    adds a ticket to the cart
+	 *
+	 * @access   private
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	private static function _add_ticket_to_cart(EE_Ticket $ticket = null, $qty = 1)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// get the number of spaces left for this datetime ticket
+		$available_spaces = self::_ticket_datetime_availability($ticket);
+		// compare available spaces against the number of tickets being purchased
+		if ($available_spaces >= $qty) {
+			// allow addons to prevent a ticket from being added to cart
+			if ( ! apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart', true, $ticket,
+				$qty, $available_spaces)
+			) {
+				return false;
+			}
+			$qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
+			// add event to cart
+			if (EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) {
+				self::_recalculate_ticket_datetime_availability($ticket, $qty);
+				return true;
+			} else {
+				return false;
+			}
+		} else {
+			// tickets can not be purchased but let's find the exact number left for the last ticket selected PRIOR to subtracting tickets
+			$available_spaces = self::_ticket_datetime_availability($ticket, true);
+			// greedy greedy greedy eh?
+			if ($available_spaces > 0) {
+				if (
+				apply_filters(
+					'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
+					true,
+					$ticket,
+					$qty,
+					$available_spaces
+				)
+				) {
+					EED_Ticket_Selector::_display_availability_error($available_spaces);
+				}
+			} else {
+				EE_Error::add_error(
+					__('We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
+						'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+			return false;
+		}
+	}
+
+
+
+	/**
+	 *  _display_availability_error
+	 *
+	 * @access    private
+	 * @param int $available_spaces
+	 * @throws \EE_Error
+	 */
+	private static function _display_availability_error($available_spaces = 1)
+	{
+		// add error messaging - we're using the _n function that will generate
+		// the appropriate singular or plural message based on the number of $available_spaces
+		if (EE_Registry::instance()->CART->all_ticket_quantity_count()) {
+			$msg = sprintf(
+				_n(
+					'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+					'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+					$available_spaces,
+					'event_espresso'
+				),
+				$available_spaces,
+				'<br />'
+			);
+		} else {
+			$msg = sprintf(
+				_n(
+					'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+					'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+					$available_spaces,
+					'event_espresso'
+				),
+				$available_spaces,
+				'<br />'
+			);
+		}
+		EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+	}
+
+
+
+	/**
+	 * _ticket_datetime_availability
+	 * creates an array of tickets plus all of the datetimes available to each ticket
+	 * and tracks the spaces remaining for each of those datetimes
+	 *
+	 * @access private
+	 * @param EE_Ticket $ticket - selected ticket
+	 * @param bool      $get_original_ticket_spaces
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	private static function _ticket_datetime_availability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
+	{
+		// if the $_available_spaces array has not been set up yet...
+		if ( ! isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
+			self::_set_initial_ticket_datetime_availability($ticket);
+		}
+		$available_spaces = $ticket->qty() - $ticket->sold();
+		if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach ((array)self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
+				// if we want the original datetime availability BEFORE we started subtracting tickets ?
+				if ($get_original_ticket_spaces) {
+					// then grab the available spaces from the "tickets" array and compare with the above to get the lowest number
+					$available_spaces = min($available_spaces,
+						self::$_available_spaces['tickets'][$ticket->ID()][$DTD_ID]);
+				} else {
+					// we want the updated ticket availability as stored in the "datetimes" array
+					$available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][$DTD_ID]);
+				}
+			}
+		}
+		return $available_spaces;
+	}
+
+
+
+	/**
+	 * _set_initial_ticket_datetime_availability
+	 *
+	 * @access private
+	 * @param EE_Ticket $ticket
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _set_initial_ticket_datetime_availability(EE_Ticket $ticket)
+	{
+		// first, get all of the datetimes that are available to this ticket
+		$datetimes = $ticket->get_many_related(
+			'Datetime',
+			array(
+				array(
+					'DTT_EVT_end' => array(
+						'>=',
+						EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+					),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+		if ( ! empty($datetimes)) {
+			// now loop thru all of the datetimes
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					// the number of spaces available for the datetime without considering individual ticket quantities
+					$spaces_remaining = $datetime->spaces_remaining();
+					// save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold or the datetime spaces remaining) to this ticket using the datetime ID as the key
+					self::$_available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min(
+						$ticket->qty() - $ticket->sold(),
+						$spaces_remaining
+					);
+					// if the remaining spaces for this datetime is already set, then compare that against the datetime spaces remaining, and take the lowest number,
+					// else just take the datetime spaces remaining, and assign to the datetimes array
+					self::$_available_spaces['datetimes'][$datetime->ID()] = isset(self::$_available_spaces['datetimes'][$datetime->ID()])
+						? min(self::$_available_spaces['datetimes'][$datetime->ID()], $spaces_remaining)
+						: $spaces_remaining;
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _recalculate_ticket_datetime_availability
+	 *
+	 * @access    private
+	 * @param    EE_Ticket $ticket
+	 * @param    int       $qty
+	 * @return    void
+	 */
+	private static function _recalculate_ticket_datetime_availability(EE_Ticket $ticket, $qty = 0)
+	{
+		if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach ((array)self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
+				// subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
+				self::$_available_spaces['datetimes'][$DTD_ID] -= $qty;
+			}
+		}
+	}
+
+
+
+	/**
+	 *    load js
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public static function load_tckt_slctr_assets()
+	{
+		// add some style
+		if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
+			wp_register_style('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css');
+			wp_enqueue_style('ticket_selector');
+			// make it dance
+			// wp_register_script('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', array('espresso_core'), '', TRUE);
+			// wp_enqueue_script('ticket_selector');
+		}
+	}
+
+
+
+	public static function load_tckt_slctr_assets_admin()
+	{
+		//iframe button js on admin event editor page
+		if (EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+			&& EE_Registry::instance()->REQ->get('action') === 'edit'
+		) {
+			wp_register_script('ticket_selector_embed', TICKET_SELECTOR_ASSETS_URL . 'ticket-selector-embed.js',
+				array('ee-dialog'), EVENT_ESPRESSO_VERSION, true);
+			wp_enqueue_script('ticket_selector_embed');
+		}
+	}
 
 
 

Spacing +44 added lines, -44 removed lines

@@ -14,7 +14,7 @@ 
 class EED_Ticket_Selector extends EED_Module
 {
 
-    const debug = false;    //	true false
+    const debug = false; //	true false
 
     /**
      * event that ticket selector is being generated for
@@ -113,8 +113,8 @@ 
      */
     public static function set_definitions()
     {
-        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
-        define('TICKET_SELECTOR_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS);
+        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
+        define('TICKET_SELECTOR_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS);
         //if config is not set, initialize
         //If config is not set, set it.
         if (EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector === null) {
@@ -158,10 +158,10 @@ 
         $template_args['css'] = apply_filters(
             'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
             array(
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector_embed.css?ver=' . EVENT_ESPRESSO_VERSION,
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css?ver=' . EVENT_ESPRESSO_VERSION,
-                includes_url('css/dashicons.min.css?ver=' . $GLOBALS['wp_version']),
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector_embed.css?ver='.EVENT_ESPRESSO_VERSION,
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css?ver='.EVENT_ESPRESSO_VERSION,
+                includes_url('css/dashicons.min.css?ver='.$GLOBALS['wp_version']),
+                EE_GLOBAL_ASSETS_URL.'css/espresso_default.css?ver='.EVENT_ESPRESSO_VERSION,
             )
         );
         EE_Registry::$i18n_js_strings['ticket_selector_iframe'] = true;
@@ -174,18 +174,18 @@ 
         $template_args['js'] = apply_filters(
             'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
             array(
-                includes_url('js/jquery/jquery.js?ver=' . $GLOBALS['wp_version']),
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js?ver=' . EVENT_ESPRESSO_VERSION,
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector_iframe_embed.js?ver=' . EVENT_ESPRESSO_VERSION,
+                includes_url('js/jquery/jquery.js?ver='.$GLOBALS['wp_version']),
+                EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js?ver='.EVENT_ESPRESSO_VERSION,
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector_iframe_embed.js?ver='.EVENT_ESPRESSO_VERSION,
             )
         );
         $template_args['notices'] = EEH_Template::display_template(
-            EE_TEMPLATES . 'espresso-ajax-notices.template.php',
+            EE_TEMPLATES.'espresso-ajax-notices.template.php',
             array(),
             true
         );
         EEH_Template::display_template(
-            TICKET_SELECTOR_TEMPLATES_PATH . 'ticket_selector_chart_iframe.template.php',
+            TICKET_SELECTOR_TEMPLATES_PATH.'ticket_selector_chart_iframe.template.php',
             $template_args
         );
         exit;
@@ -200,7 +200,7 @@ 
      * @param int    $id               The post id for the event.
      * @return string The new html string for the permalink area.
      */
-    public static function iframe_code_button($permalink_string, $id )
+    public static function iframe_code_button($permalink_string, $id)
     {
         //make sure this is ONLY when editing and the event id has been set.
         if ( ! empty($id)) {
@@ -214,12 +214,12 @@ 
                                  . '</a> ';
             $ticket_selector_url = add_query_arg(array('ticket_selector' => 'iframe', 'event' => $id), site_url());
             $iframe_string = esc_html(
-                '<iframe src="' . $ticket_selector_url . '" width="100%" height="100%"></iframe>'
+                '<iframe src="'.$ticket_selector_url.'" width="100%" height="100%"></iframe>'
             );
             $permalink_string .= '
 <div id="js-ts-iframe" style="display:none">
 	<div style="width:100%; height: 500px;">
-		' . $iframe_string . '
+		' . $iframe_string.'
 	</div>
 </div>';
         }
@@ -243,10 +243,10 @@ 
         }
         if ($event instanceof EE_Event) {
             self::$_event = $event;
-        } else if ($event instanceof WP_Post ) {
-            if ( isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
+        } else if ($event instanceof WP_Post) {
+            if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
                 self::$_event = $event->EE_Event;
-            } else if ( $event->post_type === 'espresso_events') {
+            } else if ($event->post_type === 'espresso_events') {
                 $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
                 self::$_event = $event->EE_Event;
             }
@@ -255,7 +255,7 @@ 
             $dev_msg = $user_msg
                        . __('In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
                     'event_espresso');
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         return true;
@@ -362,9 +362,9 @@ 
                     '</a></span></div>'
                 );
             }
-            return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+            return '<p><span class="important-notice">'.$sales_closed_msg.'</span></p>';
         }
-        $templates['ticket_selector'] = TICKET_SELECTOR_TEMPLATES_PATH . 'ticket_selector_chart.template.php';
+        $templates['ticket_selector'] = TICKET_SELECTOR_TEMPLATES_PATH.'ticket_selector_chart.template.php';
         $templates['ticket_selector'] = apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector__template_path',
             $templates['ticket_selector'], self::$_event);
         // redirecting to another site for registration ??
@@ -386,7 +386,7 @@ 
             ? EED_Ticket_Selector::ticket_selector_form_open(
                 self::$_event->ID(),
                 $external_url
-            ) . $ticket_selector
+            ).$ticket_selector
             : $ticket_selector;
         // submit button and form close tag
         $ticket_selector .= ! is_admin() ? EED_Ticket_Selector::display_ticket_selector_submit($external_url) : '';
@@ -409,7 +409,7 @@ 
     {
         // if redirecting, we don't need any anything else
         if ($external_url) {
-            $html = '<form method="GET" action="' . EEH_URL::refactor_url($external_url) . '"';
+            $html = '<form method="GET" action="'.EEH_URL::refactor_url($external_url).'"';
             // open link in new window ?
             $html .= apply_filters(
                 'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
@@ -418,10 +418,10 @@ 
                 ? ' target="_blank"'
                 : '';
             $html .= '>';
-            $query_args = (array)EEH_URL::get_query_string($external_url);
+            $query_args = (array) EEH_URL::get_query_string($external_url);
             foreach ($query_args as $query_arg => $value) {
                 $html .= '
-				<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+				<input type="hidden" name="' . $query_arg.'" value="'.$value.'">';
             }
             return $html;
         }
@@ -436,8 +436,8 @@ 
                 __FILE__, __FUNCTION__, __LINE__);
         }
         $extra_params = self::$_in_iframe ? ' target="_blank"' : '';
-        $html = '<form method="POST" action="' . $checkout_url . '"' . $extra_params . '>';
-        $html .= wp_nonce_field('process_ticket_selections', 'process_ticket_selections_nonce_' . $ID, true, false);
+        $html = '<form method="POST" action="'.$checkout_url.'"'.$extra_params.'>';
+        $html .= wp_nonce_field('process_ticket_selections', 'process_ticket_selections_nonce_'.$ID, true, false);
         $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
         $html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, self::$_event);
         return $html;
@@ -462,10 +462,10 @@ 
                 $html .= empty($external_url) ?
                     \EED_Ticket_Selector::no_tkt_slctr_end_dv()
                     : \EED_Ticket_Selector::clear_tkt_slctr();
-                $html .= '<br/>' . \EED_Ticket_Selector::ticket_selector_form_close();
-            } else if ( EED_Ticket_Selector::$_max_atndz === 1 ) {
+                $html .= '<br/>'.\EED_Ticket_Selector::ticket_selector_form_close();
+            } else if (EED_Ticket_Selector::$_max_atndz === 1) {
                 // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ( EED_Ticket_Selector::$_event->is_sold_out() ) {
+                if (EED_Ticket_Selector::$_event->is_sold_out()) {
                     // then instead of a View Details or Submit button, just display a "Sold Out" message
                     $html .= apply_filters(
                         'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
@@ -586,10 +586,10 @@ 
             EED_Ticket_Selector::$_event
         );
         $external_url = EED_Ticket_Selector::$_event->external_url();
-        $html = '<input id="ticket-selector-submit-' . EED_Ticket_Selector::$_event->ID() . '-btn"';
+        $html = '<input id="ticket-selector-submit-'.EED_Ticket_Selector::$_event->ID().'-btn"';
         $html .= ' class="ticket-selector-submit-btn ';
         $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
+        $html .= ' type="submit" value="'.$btn_text.'" />';
         $html .= apply_filters(
             'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
             '',
@@ -672,7 +672,7 @@ 
             );
         } else {
             wp_safe_redirect(
-                site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
+                site_url('/'.EE_Registry::instance()->CFG->core->event_cpt_slug.'/')
             );
         }
         die();
@@ -783,7 +783,7 @@ 
                 'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
                 $valid['max_atndz'], 'event_espresso');
             $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
-            EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__);
         } else {
             // all data appears to be valid
             $tckts_slctd = false;
@@ -903,7 +903,7 @@ 
         // grab valid id
         $valid_data['id'] = $id;
         // grab and sanitize return-url
-        $valid_data['return_url'] = esc_url_raw(EE_Registry::instance()->REQ->get('tkt-slctr-return-url-' . $id));
+        $valid_data['return_url'] = esc_url_raw(EE_Registry::instance()->REQ->get('tkt-slctr-return-url-'.$id));
         // array of other form names
         $inputs_to_clean = array(
             'event_id'   => 'tkt-slctr-event-id',
@@ -918,9 +918,9 @@ 
         // cycle through $inputs_to_clean array
         foreach ($inputs_to_clean as $what => $input_to_clean) {
             // check for POST data
-            if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
+            if (EE_Registry::instance()->REQ->is_set($input_to_clean.$id)) {
                 // grab value
-                $input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
+                $input_value = EE_Registry::instance()->REQ->get($input_to_clean.$id);
                 switch ($what) {
                     // integers
                     case 'event_id':
@@ -941,8 +941,8 @@ 
                         // if qty is coming from a radio button input, then we need to assemble an array of rows
                         if ( ! is_array($row_qty)) {
                             // get number of rows
-                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
-                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
+                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-'.$id)
+                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-'.$id))
                                 : 1;
                             // explode ints by the dash
                             $row_qty = explode('-', $row_qty);
@@ -970,7 +970,7 @@ 
                     case 'ticket_id':
                         $value_array = array();
                         // cycle thru values
-                        foreach ((array)$input_value as $key => $value) {
+                        foreach ((array) $input_value as $key => $value) {
                             // allow only numbers, letters,  spaces, commas and dashes
                             $value_array[$key] = wp_strip_all_tags($value);
                             // get ticket via the ticket id we put in the form
@@ -1111,7 +1111,7 @@ 
         $available_spaces = $ticket->qty() - $ticket->sold();
         if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ((array)self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
+            foreach ((array) self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // if we want the original datetime availability BEFORE we started subtracting tickets ?
                 if ($get_original_ticket_spaces) {
                     // then grab the available spaces from the "tickets" array and compare with the above to get the lowest number
@@ -1186,7 +1186,7 @@ 
     {
         if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ((array)self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
+            foreach ((array) self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
                 self::$_available_spaces['datetimes'][$DTD_ID] -= $qty;
             }
@@ -1205,7 +1205,7 @@ 
     {
         // add some style
         if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
-            wp_register_style('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css');
+            wp_register_style('ticket_selector', TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css');
             wp_enqueue_style('ticket_selector');
             // make it dance
             // wp_register_script('ticket_selector', TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', array('espresso_core'), '', TRUE);
@@ -1221,7 +1221,7 @@ 
         if (EE_Registry::instance()->REQ->get('page') === 'espresso_events'
             && EE_Registry::instance()->REQ->get('action') === 'edit'
         ) {
-            wp_register_script('ticket_selector_embed', TICKET_SELECTOR_ASSETS_URL . 'ticket-selector-embed.js',
+            wp_register_script('ticket_selector_embed', TICKET_SELECTOR_ASSETS_URL.'ticket-selector-embed.js',
                 array('ee-dialog'), EVENT_ESPRESSO_VERSION, true);
             wp_enqueue_script('ticket_selector_embed');
         }

core/entities/models/JsonModelSchema.php

Doc Comments -2 removed lines

@@ -39,7 +39,6 @@ 
 
     /**
      * Return the schema for a given model from a given model.
-     * @param \EEM_Base $model
      * @return array
      */
     public function getModelSchema()
@@ -103,7 +102,6 @@ 
 
     /**
      * Outputs the schema header for a model.
-     * @param \EEM_Base $model
      * @return array
      */
     public function getInitialSchemaStructure()

Spacing +3 added lines, -3 removed lines

@@ -33,7 +33,7 @@ 
      *
      * @param \EEM_Base $model
      */
-    public function __construct(EEM_Base $model){
+    public function __construct(EEM_Base $model) {
         $this->model = $model;
     }
 
@@ -60,7 +60,7 @@ 
     public function getModelSchemaForFields(array $model_fields, array $schema)
     {
         foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
+            if ( ! $model_field instanceof EE_Model_Field_Base) {
                 continue;
             }
             $schema['properties'][$field] = $model_field->getSchema();
@@ -91,7 +91,7 @@ 
     public function getModelSchemaForRelations(array $relations_on_model, array $schema)
     {
         foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
+            if ( ! $relation instanceof EE_Model_Relation_Base) {
                 continue;
             }
             $model_name_for_schema = EEH_Inflector::pluralize_and_lower($model_name);

Indentation +111 added lines, -111 removed lines

@@ -24,115 +24,115 @@
 class JsonModelSchema
 {
 
-    /**
-     * @var \EEM_Base
-     */
-    protected $model;
-
-    /**
-     * JsonModelSchema constructor.
-     *
-     * @param \EEM_Base $model
-     */
-    public function __construct(EEM_Base $model){
-        $this->model = $model;
-    }
-
-    /**
-     * Return the schema for a given model from a given model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getModelSchema()
-    {
-        return $this->getModelSchemaForRelations(
-            $this->model->relation_settings(),
-            $this->getModelSchemaForFields(
-                $this->model->field_settings(),
-                $this->getInitialSchemaStructure()
-            )
-        );
-    }
-
-
-    /**
-     * Get the schema for a given set of model fields.
-     * @param \EE_Model_Field_Base[]     $model_fields
-     * @return array
-     */
-    public function getModelSchemaForFields(array $model_fields, array $schema)
-    {
-        foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
-                continue;
-            }
-            $schema['properties'][$field] = $model_field->getSchema();
-
-            //if this is a primary key field add the primary key item
-            if ($model_field instanceof EE_Primary_Key_Field_Base) {
-                $schema['properties'][$field]['primary_key'] = true;
-            }
-
-            //if this is a foreign key field add the foreign key item
-            if ($model_field instanceof EE_Foreign_Key_Field_Base) {
-                $schema['properties'][$field]['foreign_key'] = array(
-                    'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
-                    'type' => 'array',
-                    'enum' => $model_field->get_model_class_names_pointed_to()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Get the schema for a given set of model relations
-     * @param EE_Model_Relation_Base[] $relations_on_model
-     * @return array
-     */
-    public function getModelSchemaForRelations(array $relations_on_model, array $schema)
-    {
-        foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
-                continue;
-            }
-            $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
-                ? strtolower($model_name)
-                : EEH_Inflector::pluralize_and_lower($model_name);
-            $schema['properties'][$model_name_for_schema] = $relation->getSchema();
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Outputs the schema header for a model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getInitialSchemaStructure()
-    {
-        return array(
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
-            'title' => $this->model->get_this_model_name(),
-            'type' => 'object',
-            'properties' => array()
-        );
-    }
-
-
-    /**
-     * Allows one to just use the object as a string to get the json.
-     * eg.
-     *
-     * $json_schema = new JsonModelSchema(EEM_Event::instance());
-     * echo $json_schema; //outputs the schema as a json formatted string.
-     *
-     * @return bool|false|mixed|string
-     */
-    public function __toString()
-    {
-        return wp_json_encode($this->getModelSchema());
-    }
+	/**
+	 * @var \EEM_Base
+	 */
+	protected $model;
+
+	/**
+	 * JsonModelSchema constructor.
+	 *
+	 * @param \EEM_Base $model
+	 */
+	public function __construct(EEM_Base $model){
+		$this->model = $model;
+	}
+
+	/**
+	 * Return the schema for a given model from a given model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getModelSchema()
+	{
+		return $this->getModelSchemaForRelations(
+			$this->model->relation_settings(),
+			$this->getModelSchemaForFields(
+				$this->model->field_settings(),
+				$this->getInitialSchemaStructure()
+			)
+		);
+	}
+
+
+	/**
+	 * Get the schema for a given set of model fields.
+	 * @param \EE_Model_Field_Base[]     $model_fields
+	 * @return array
+	 */
+	public function getModelSchemaForFields(array $model_fields, array $schema)
+	{
+		foreach ($model_fields as $field => $model_field) {
+			if (! $model_field instanceof EE_Model_Field_Base) {
+				continue;
+			}
+			$schema['properties'][$field] = $model_field->getSchema();
+
+			//if this is a primary key field add the primary key item
+			if ($model_field instanceof EE_Primary_Key_Field_Base) {
+				$schema['properties'][$field]['primary_key'] = true;
+			}
+
+			//if this is a foreign key field add the foreign key item
+			if ($model_field instanceof EE_Foreign_Key_Field_Base) {
+				$schema['properties'][$field]['foreign_key'] = array(
+					'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
+					'type' => 'array',
+					'enum' => $model_field->get_model_class_names_pointed_to()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Get the schema for a given set of model relations
+	 * @param EE_Model_Relation_Base[] $relations_on_model
+	 * @return array
+	 */
+	public function getModelSchemaForRelations(array $relations_on_model, array $schema)
+	{
+		foreach ($relations_on_model as $model_name => $relation) {
+			if (! $relation instanceof EE_Model_Relation_Base) {
+				continue;
+			}
+			$model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
+				? strtolower($model_name)
+				: EEH_Inflector::pluralize_and_lower($model_name);
+			$schema['properties'][$model_name_for_schema] = $relation->getSchema();
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Outputs the schema header for a model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getInitialSchemaStructure()
+	{
+		return array(
+			'$schema' => 'http://json-schema.org/draft-04/schema#',
+			'title' => $this->model->get_this_model_name(),
+			'type' => 'object',
+			'properties' => array()
+		);
+	}
+
+
+	/**
+	 * Allows one to just use the object as a string to get the json.
+	 * eg.
+	 *
+	 * $json_schema = new JsonModelSchema(EEM_Event::instance());
+	 * echo $json_schema; //outputs the schema as a json formatted string.
+	 *
+	 * @return bool|false|mixed|string
+	 */
+	public function __toString()
+	{
+		return wp_json_encode($this->getModelSchema());
+	}
 }