eventespresso / event-espresso-core

core/data_migration_scripts/EE_DMS_Core_4_9_0.dms.php

Indentation +291 added lines, -291 removed lines

@@ -12,9 +12,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_9_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
-    $matches = array();
-    preg_match('~4_9_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[$matches[1]] = $filepath;
+	$matches = array();
+	preg_match('~4_9_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[$matches[1]] = $filepath;
 }
 //give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_9_0__autoloaded_stages', $class_to_filepath);
@@ -33,68 +33,68 @@ 
 class EE_DMS_Core_4_9_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * return EE_DMS_Core_4_9_0
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = esc_html__("Data Update to Event Espresso 4.9.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_9_0_Email_System_Question(),
-            new EE_DMS_4_9_0_Answers_With_No_Registration(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
+	/**
+	 * return EE_DMS_Core_4_9_0
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = esc_html__("Data Update to Event Espresso 4.9.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_9_0_Email_System_Question(),
+			new EE_DMS_4_9_0_Answers_With_No_Registration(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
 
 
 
-    /**
-     * Whether to migrate or not.
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.9.0', '<=') && version_compare($version_string, '4.8.0', '>=')) {
-            //			echo "$version_string can be migrated from";
-            return true;
-        } elseif ( ! $version_string) {
-            //			echo "no version string provided: $version_string";
-            //no version string provided... this must be pre 4.3
-            return false;//changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
-            //			echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+	/**
+	 * Whether to migrate or not.
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.9.0', '<=') && version_compare($version_string, '4.8.0', '>=')) {
+			//			echo "$version_string can be migrated from";
+			return true;
+		} elseif ( ! $version_string) {
+			//			echo "no version string provided: $version_string";
+			//no version string provided... this must be pre 4.3
+			return false;//changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
+			//			echo "$version_string doesnt apply";
+			return false;
+		}
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $now_in_mysql = current_time('mysql', true);
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$now_in_mysql = current_time('mysql', true);
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					ANS_value text NOT NULL,
 					PRIMARY KEY  (ANS_ID),
 					KEY REG_ID (REG_ID),
 					KEY QST_ID (QST_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'ATT_email');
-        $sql = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'ATT_email');
+		$sql = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				ATT_fname varchar(45) NOT NULL,
 				ATT_lname varchar(45) NOT NULL,
@@ -111,9 +111,9 @@ 
 				KEY ATT_email (ATT_email(191)),
 				KEY ATT_lname (ATT_lname),
 				KEY ATT_fname (ATT_fname)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				REG_ID int(10) unsigned NOT NULL,
 				DTT_ID int(10) unsigned NOT NULL,
 				CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -121,9 +121,9 @@ 
 				PRIMARY KEY  (CHK_ID),
 				KEY REG_ID (REG_ID),
 				KEY DTT_ID (DTT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO varchar(2) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO varchar(2) NOT NULL,
 				CNT_ISO3 varchar(3) NOT NULL,
 				RGN_ID tinyint(3) unsigned DEFAULT NULL,
 				CNT_name varchar(45) NOT NULL,
@@ -139,29 +139,29 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code varchar(6) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "CUR_code varchar(6) NOT NULL,
 				CUR_single varchar(45) DEFAULT 'dollar',
 				CUR_plural varchar(45) DEFAULT 'dollars',
 				CUR_sign varchar(45) DEFAULT '$',
 				CUR_dec_plc varchar(1) NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        //note: although this table is no longer in use,
-        //it hasn't been removed because then queries to the model will have errors.
-        //but you should expect this table and its corresponding model to be removed in
-        //the next few months
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		//note: although this table is no longer in use,
+		//it hasn't been removed because then queries to the model will have errors.
+		//but you should expect this table and its corresponding model to be removed in
+		//the next few months
+		$table_name = 'esp_currency_payment_method';
+		$sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID),
 				KEY PMD_ID (PMD_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				DTT_name varchar(255) NOT NULL DEFAULT '',
 				DTT_description text NOT NULL,
@@ -178,25 +178,25 @@ 
 				KEY DTT_EVT_start (DTT_EVT_start),
 				KEY EVT_ID (EVT_ID),
 				KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				DTT_ID int(10) unsigned NOT NULL,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (DTK_ID),
 				KEY DTT_ID (DTT_ID),
 				KEY TKT_ID (TKT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EMT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
 				EVT_display_ticket_selector tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -211,34 +211,34 @@ 
 				EVT_donations tinyint(1) NULL,
 				PRIMARY KEY  (EVTM_ID),
 				KEY EVT_ID (EVT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				QSG_ID int(10) unsigned NOT NULL,
 				EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EQG_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY QSG_ID (QSG_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID),
 				KEY EXM_type (EXM_type,OBJ_ID,EXM_key)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_join';
-        $sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_join';
+		$sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(6) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(6) NOT NULL,
@@ -246,9 +246,9 @@ 
 				PRIMARY KEY  (EXJ_ID),
 				KEY first_model (EXJ_first_model_name,EXJ_first_model_id),
 				KEY second_model (EXJ_second_model_name,EXJ_second_model_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(11) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -269,11 +269,11 @@ 
 				KEY txn_type_timestamp (TXN_ID,LIN_type,LIN_timestamp),
 				KEY txn_obj_id_obj_type (TXN_ID,OBJ_ID,OBJ_type),
 				KEY obj_id_obj_type (OBJ_ID,OBJ_type)";
-        $this->_get_table_manager()->dropIndex('esp_line_item', 'TXN_ID');
-        $this->_get_table_manager()->dropIndex('esp_line_item', 'LIN_code');
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_get_table_manager()->dropIndex('esp_line_item', 'TXN_ID');
+		$this->_get_table_manager()->dropIndex('esp_line_item', 'LIN_code');
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -284,12 +284,12 @@ 
 				KEY LOG_time (LOG_time),
 				KEY OBJ (OBJ_type,OBJ_ID),
 				KEY LOG_type (LOG_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message';
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_to');
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_from');
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_subject');
-        $sql = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message';
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_to');
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_from');
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_subject');
+		$sql = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NULL,
 				MSG_token varchar(255) NULL,
 				TXN_ID int(10) unsigned NULL,
@@ -321,18 +321,18 @@ 
 				KEY STS_ID (STS_ID),
 				KEY MSG_created (MSG_created),
 				KEY MSG_modified (MSG_modified)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NOT NULL,
 				MTP_context varchar(50) NOT NULL,
 				MTP_template_field varchar(30) NOT NULL,
 				MTP_content text NOT NULL,
 				PRIMARY KEY  (MTP_ID),
 				KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				MTP_user_id int(10) NOT NULL DEFAULT '1',
 				MTP_name varchar(245) NOT NULL DEFAULT '',
 				MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -344,9 +344,9 @@ 
 				MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 				PRIMARY KEY  (GRP_ID),
 				KEY MTP_user_id (MTP_user_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_ID int(10) unsigned DEFAULT NULL,
 				STS_ID varchar(3) DEFAULT NULL,
 				PAY_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -363,9 +363,9 @@ 
 				PRIMARY KEY  (PAY_ID),
 				KEY PAY_timestamp (PAY_timestamp),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -381,24 +381,24 @@ 
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug),
 				KEY PMD_type (PMD_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRC_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (TKP_ID),
 				KEY TKT_ID (TKT_ID),
 				KEY PRC_ID (PRC_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_name varchar(45) NOT NULL,
 				TTM_description text,
 				TTM_file varchar(45),
 				PRIMARY KEY  (TTM_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QST_display_text text NOT NULL,
 				QST_admin_label varchar(255) NOT NULL,
 				QST_system varchar(25) DEFAULT NULL,
@@ -412,18 +412,18 @@ 
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID),
 				KEY QST_order (QST_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_ID int(10) unsigned NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
 				QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QGQ_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSG_ID_order (QSG_ID,QGQ_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSO_value varchar(255) NOT NULL,
 				QSO_desc text NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
@@ -433,9 +433,9 @@ 
 				PRIMARY KEY  (QSO_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSO_order (QSO_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				TXN_ID int(10) unsigned NOT NULL,
@@ -459,18 +459,18 @@ 
 				KEY TKT_ID (TKT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY STS_ID (STS_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_registration_payment';
-        $sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_registration_payment';
+		$sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  REG_ID int(10) unsigned NOT NULL,
 					  PAY_ID int(10) unsigned NULL,
 					  RPY_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID),
 					  KEY REG_ID (REG_ID),
 					  KEY PAY_ID (PAY_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 				CNT_ISO varchar(2) NOT NULL,
 				STA_abbrev varchar(24) NOT NULL,
 				STA_name varchar(100) NOT NULL,
@@ -478,9 +478,9 @@ 
 				PRIMARY KEY  (STA_ID),
 				KEY STA_abbrev (STA_abbrev),
 				KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID varchar(3) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID varchar(3) NOT NULL,
 				STS_code varchar(45) NOT NULL,
 				STS_type varchar(45) NOT NULL,
 				STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
@@ -488,9 +488,9 @@ 
 				STS_open tinyint(1) NOT NULL DEFAULT 1,
 				UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 				KEY STS_type (STS_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
 				TXN_total decimal(12,3) DEFAULT '0.00',
 				TXN_paid decimal(12,3) NOT NULL DEFAULT '0.00',
@@ -502,9 +502,9 @@ 
 				PRIMARY KEY  (TXN_ID),
 				KEY TXN_timestamp (TXN_timestamp),
 				KEY STS_ID (STS_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -523,10 +523,10 @@ 
 			KEY VNU_ID (VNU_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        //modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		//modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_ID tinyint(3) unsigned NOT NULL,
 				PRC_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 				PRC_name varchar(245) NOT NULL,
@@ -539,9 +539,9 @@ 
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID),
 				KEY PRT_ID (PRT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_name varchar(45) NOT NULL,
 				PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -550,9 +550,9 @@ 
 				PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				PRIMARY KEY  (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_ID int(10) unsigned NOT NULL,
 				TKT_name varchar(245) NOT NULL DEFAULT '',
 				TKT_description text NOT NULL,
@@ -575,9 +575,9 @@ 
 				TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				PRIMARY KEY  (TKT_ID),
 				KEY TKT_start_date (TKT_start_date)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_name varchar(255) NOT NULL,
 				QSG_identifier varchar(100) NOT NULL,
 				QSG_desc text NULL,
@@ -590,145 +590,145 @@ 
 				PRIMARY KEY  (QSG_ID),
 				UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 				KEY QSG_order (QSG_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        /** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
-        $script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        //(because many need to convert old string states to foreign keys into the states table)
-        $script_4_1_defaults->insert_default_states();
-        $script_4_1_defaults->insert_default_countries();
-        /** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
-        $script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
-        $script_4_5_defaults->insert_default_price_types();
-        $script_4_5_defaults->insert_default_prices();
-        $script_4_5_defaults->insert_default_tickets();
-        /** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
-        $script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
-        $script_4_6_defaults->add_default_admin_only_payments();
-        $script_4_6_defaults->insert_default_currencies();
-        /** @var EE_DMS_Core_4_8_0 $script_4_8_defaults */
-        $script_4_8_defaults = EE_Registry::instance()->load_dms('Core_4_8_0');
-        $script_4_8_defaults->verify_new_countries();
-        $script_4_8_defaults->verify_new_currencies();
-        $this->verify_db_collations();
-        $this->verify_db_collations_again();
-        return true;
-    }
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
+		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		//(because many need to convert old string states to foreign keys into the states table)
+		$script_4_1_defaults->insert_default_states();
+		$script_4_1_defaults->insert_default_countries();
+		/** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
+		$script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
+		$script_4_5_defaults->insert_default_price_types();
+		$script_4_5_defaults->insert_default_prices();
+		$script_4_5_defaults->insert_default_tickets();
+		/** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
+		$script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
+		$script_4_6_defaults->add_default_admin_only_payments();
+		$script_4_6_defaults->insert_default_currencies();
+		/** @var EE_DMS_Core_4_8_0 $script_4_8_defaults */
+		$script_4_8_defaults = EE_Registry::instance()->load_dms('Core_4_8_0');
+		$script_4_8_defaults->verify_new_countries();
+		$script_4_8_defaults->verify_new_currencies();
+		$this->verify_db_collations();
+		$this->verify_db_collations_again();
+		return true;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 
 
 
-    /**
-     * Verify all EE4 models' tables use utf8mb4 collation
-     *
-     * @return void
-     */
-    public function verify_db_collations()
-    {
-        global $wpdb;
-        //double-check we haven't already done it or that that the DB doesn't support utf8mb4
-        if ('utf8mb4' !== $wpdb->charset
-            || get_option('ee_verified_db_collations', false)) {
-            return;
-        }
-        // grab tables from each model
-        $tables_to_check = array();
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_Base) {
-                    foreach ($model_obj->get_tables() as $table) {
-                        if (
-                            strpos($table->get_table_name(), 'esp_')
-                            && (is_main_site()//for main tables, verify global tables
-                                || ! $table->is_global()//if not the main site, then only verify non-global tables (avoid doubling up)
-                            )
-                            && function_exists('maybe_convert_table_to_utf8mb4')
-                        ) {
-                            $tables_to_check[] = $table->get_table_name();
-                        }
-                    }
-                }
-            }
-        }
-        //and let's just be sure these addons' tables get migrated too. They already get handled if their addons are active
-        //when this code is run, but not otherwise. Once we record what tables EE added, we'll be able to use that instead
-        //of hard-coding this
-        $addon_tables = array(
-            //mailchimp
-            'esp_event_mailchimp_list_group',
-            'esp_event_question_mailchimp_field',
-            //multisite
-            'esp_blog_meta',
-            //people
-            'esp_people_to_post',
-            //promotions
-            'esp_promotion',
-            'esp_promotion_object',
-        );
-        foreach ($addon_tables as $table_name) {
-                $tables_to_check[] = $table_name;
-        }
-        $this->_verify_db_collations_for_tables(array_unique($tables_to_check));
-        //ok and now let's remember this was done (without needing to check the db schemas all over again)
-        add_option('ee_verified_db_collations', true, null, 'no');
-        //seeing how this ran with the fix from 10435, no need to check again
-        add_option('ee_verified_db_collations_again',true,null,'no');
-    }
+	/**
+	 * Verify all EE4 models' tables use utf8mb4 collation
+	 *
+	 * @return void
+	 */
+	public function verify_db_collations()
+	{
+		global $wpdb;
+		//double-check we haven't already done it or that that the DB doesn't support utf8mb4
+		if ('utf8mb4' !== $wpdb->charset
+			|| get_option('ee_verified_db_collations', false)) {
+			return;
+		}
+		// grab tables from each model
+		$tables_to_check = array();
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (
+							strpos($table->get_table_name(), 'esp_')
+							&& (is_main_site()//for main tables, verify global tables
+								|| ! $table->is_global()//if not the main site, then only verify non-global tables (avoid doubling up)
+							)
+							&& function_exists('maybe_convert_table_to_utf8mb4')
+						) {
+							$tables_to_check[] = $table->get_table_name();
+						}
+					}
+				}
+			}
+		}
+		//and let's just be sure these addons' tables get migrated too. They already get handled if their addons are active
+		//when this code is run, but not otherwise. Once we record what tables EE added, we'll be able to use that instead
+		//of hard-coding this
+		$addon_tables = array(
+			//mailchimp
+			'esp_event_mailchimp_list_group',
+			'esp_event_question_mailchimp_field',
+			//multisite
+			'esp_blog_meta',
+			//people
+			'esp_people_to_post',
+			//promotions
+			'esp_promotion',
+			'esp_promotion_object',
+		);
+		foreach ($addon_tables as $table_name) {
+				$tables_to_check[] = $table_name;
+		}
+		$this->_verify_db_collations_for_tables(array_unique($tables_to_check));
+		//ok and now let's remember this was done (without needing to check the db schemas all over again)
+		add_option('ee_verified_db_collations', true, null, 'no');
+		//seeing how this ran with the fix from 10435, no need to check again
+		add_option('ee_verified_db_collations_again',true,null,'no');
+	}
 
 
 
-    /**
-     * Verifies DB collations because a bug was discovered on https://events.codebasehq.com/projects/event-espresso/tickets/10435
-     * which meant some DB collations might not have been updated
-     * @return void
-     */
-    public function verify_db_collations_again(){
-        global $wpdb;
-        //double-check we haven't already done this or that the DB doesn't support it
-        //compare to how WordPress' upgrade_430() function does this check
-        if ('utf8mb4' !== $wpdb->charset
-            || get_option('ee_verified_db_collations_again', false)) {
-            return;
-        }
-        $tables_to_check = array(
-            'esp_attendee_meta',
-            'esp_message'
-        );
-        $this->_verify_db_collations_for_tables(array_unique($tables_to_check));
-        add_option('ee_verified_db_collations_again',true,null,'no');
-    }
+	/**
+	 * Verifies DB collations because a bug was discovered on https://events.codebasehq.com/projects/event-espresso/tickets/10435
+	 * which meant some DB collations might not have been updated
+	 * @return void
+	 */
+	public function verify_db_collations_again(){
+		global $wpdb;
+		//double-check we haven't already done this or that the DB doesn't support it
+		//compare to how WordPress' upgrade_430() function does this check
+		if ('utf8mb4' !== $wpdb->charset
+			|| get_option('ee_verified_db_collations_again', false)) {
+			return;
+		}
+		$tables_to_check = array(
+			'esp_attendee_meta',
+			'esp_message'
+		);
+		$this->_verify_db_collations_for_tables(array_unique($tables_to_check));
+		add_option('ee_verified_db_collations_again',true,null,'no');
+	}
 
 
 
-    /**
-     * Runs maybe_convert_table_to_utf8mb4 on the specified tables
-     * @param $tables_to_check
-     * @return boolean true if logic ran, false if it didn't
-     */
-    protected function _verify_db_collations_for_tables($tables_to_check)
-    {
-        foreach ($tables_to_check as $table_name) {
-            $table_name = $this->_table_analysis->ensureTableNameHasPrefix($table_name);
-            if ( ! apply_filters('FHEE__EE_DMS_Core_4_9_0__verify_db_collations__check_overridden', false, $table_name )
-                && $this->_get_table_analysis()->tableExists($table_name)
-            ) {
-                maybe_convert_table_to_utf8mb4($table_name);
-            }
-        }
-    }
+	/**
+	 * Runs maybe_convert_table_to_utf8mb4 on the specified tables
+	 * @param $tables_to_check
+	 * @return boolean true if logic ran, false if it didn't
+	 */
+	protected function _verify_db_collations_for_tables($tables_to_check)
+	{
+		foreach ($tables_to_check as $table_name) {
+			$table_name = $this->_table_analysis->ensureTableNameHasPrefix($table_name);
+			if ( ! apply_filters('FHEE__EE_DMS_Core_4_9_0__verify_db_collations__check_overridden', false, $table_name )
+				&& $this->_get_table_analysis()->tableExists($table_name)
+			) {
+				maybe_convert_table_to_utf8mb4($table_name);
+			}
+		}
+	}
 }
\ No newline at end of file

public/Espresso_Arabica_2014/content-espresso_events-venues.php

Spacing +32 added lines, -32 removed lines

@@ -1,66 +1,66 @@
 <?php
 //echo '<br/><h6 style="color:#2EA2CC;">'. __FILE__ . ' &nbsp; <span style="font-weight:normal;color:#E76700"> Line #: ' . __LINE__ . '</span></h6>';
 if (
-	( is_single() && espresso_display_venue_in_event_details() )
-	|| ( is_archive() && espresso_display_venue_in_event_list() )
+	(is_single() && espresso_display_venue_in_event_details())
+	|| (is_archive() && espresso_display_venue_in_event_list())
 ) :
 	global $post;
-	do_action( 'AHEE_event_details_before_venue_details', $post );
-	$venue_name = espresso_venue_name( 0, 'details', FALSE );
-	if ( empty( $venue_name ) && espresso_is_venue_private() ) {
-		do_action( 'AHEE_event_details_after_venue_details', $post );
+	do_action('AHEE_event_details_before_venue_details', $post);
+	$venue_name = espresso_venue_name(0, 'details', FALSE);
+	if (empty($venue_name) && espresso_is_venue_private()) {
+		do_action('AHEE_event_details_after_venue_details', $post);
 		return '';
 	}
 ?>
 
 <div class="espresso-venue-dv<?php echo espresso_is_venue_private() ? ' espresso-private-venue-dv' : ''; ?>">
-	<h4><strong><?php _e( 'Venue:', 'event_espresso' ); ?></strong>&nbsp;&nbsp; <strong> <?php echo $venue_name; ?></strong></h4>
+	<h4><strong><?php _e('Venue:', 'event_espresso'); ?></strong>&nbsp;&nbsp; <strong> <?php echo $venue_name; ?></strong></h4>
 	<p><span class="smaller-text tags-links"><?php echo espresso_venue_categories(); ?></span></p>
-<?php  if ( $venue_phone = espresso_venue_phone( $post->ID, FALSE )) : ?>
+<?php  if ($venue_phone = espresso_venue_phone($post->ID, FALSE)) : ?>
 	<p>
-		<span class="small-text"><strong><?php _e( 'Venue Phone:', 'event_espresso' ); ?></strong></span> <?php echo $venue_phone; ?>
+		<span class="small-text"><strong><?php _e('Venue Phone:', 'event_espresso'); ?></strong></span> <?php echo $venue_phone; ?>
 	</p>
-<?php endif;  ?>
-<?php if ( $venue_website = espresso_venue_website( $post->ID, FALSE )) : ?>
+<?php endif; ?>
+<?php if ($venue_website = espresso_venue_website($post->ID, FALSE)) : ?>
 	<p>
-		<span class="small-text"><strong><?php _e( 'Venue Website:', 'event_espresso' ); ?></strong></span> <?php echo $venue_website; ?>
+		<span class="small-text"><strong><?php _e('Venue Website:', 'event_espresso'); ?></strong></span> <?php echo $venue_website; ?>
 	</p>
 <?php endif; ?>
-<?php  if ( espresso_venue_has_address( $post->ID )) : ?>
-	<strong><span class="dashicons dashicons-location-alt"></span><?php _e( 'Address:', 'event_espresso' ); ?></strong>
-	<?php espresso_venue_address( 'inline' ); ?>
-	<?php espresso_venue_gmap( $post->ID ); ?>
+<?php  if (espresso_venue_has_address($post->ID)) : ?>
+	<strong><span class="dashicons dashicons-location-alt"></span><?php _e('Address:', 'event_espresso'); ?></strong>
+	<?php espresso_venue_address('inline'); ?>
+	<?php espresso_venue_gmap($post->ID); ?>
 	<div class="clear"><br/></div>
-<?php endif;  ?>
+<?php endif; ?>
 
-	<?php $VNU_ID = espresso_venue_id( $post->ID ); ?>
-	<?php if ( is_single() ) : ?>
-		<?php $venue_description = espresso_venue_description( $VNU_ID, FALSE ); ?>
-		<?php if ( $venue_description ) : ?>
+	<?php $VNU_ID = espresso_venue_id($post->ID); ?>
+	<?php if (is_single()) : ?>
+		<?php $venue_description = espresso_venue_description($VNU_ID, FALSE); ?>
+		<?php if ($venue_description) : ?>
 	<p>
-		<strong><?php _e( 'Description:', 'event_espresso' ); ?></strong><br/>
-		<?php echo do_shortcode( $venue_description ); ?>
+		<strong><?php _e('Description:', 'event_espresso'); ?></strong><br/>
+		<?php echo do_shortcode($venue_description); ?>
 	</p>
-		<?php endif;  ?>
+		<?php endif; ?>
 	<?php else : ?>
-		<?php $venue_excerpt = espresso_venue_excerpt( $VNU_ID, FALSE ); ?>
-		<?php if ( $venue_excerpt ) : ?>
+		<?php $venue_excerpt = espresso_venue_excerpt($VNU_ID, FALSE); ?>
+		<?php if ($venue_excerpt) : ?>
 	<p>
-		<strong><?php _e( 'Description:', 'event_espresso' ); ?></strong><br/>
+		<strong><?php _e('Description:', 'event_espresso'); ?></strong><br/>
 		<?php echo $venue_excerpt; ?>
 	</p>
-			<?php endif;  ?>
-		<?php endif;  ?>
+			<?php endif; ?>
+		<?php endif; ?>
 </div>
 <!-- .espresso-venue-dv -->
 <?php
-do_action( 'AHEE_event_details_after_venue_details', $post );
+do_action('AHEE_event_details_after_venue_details', $post);
 else :
-	if ( espresso_venue_is_password_protected() ) :
+	if (espresso_venue_is_password_protected()) :
 ?>
 	<div class="espresso-venue-dv  espresso-password-protected-venue-dv" >
 		<h3 class="event-venues-h3 ee-event-h3">
-			<?php _e( 'Location', 'event_espresso' );?>
+			<?php _e('Location', 'event_espresso'); ?>
 		</h3>
 		<?php echo espresso_password_protected_venue_form(); ?>
 	</div>

acceptance_tests/Helpers/EventsAdmin.php

Indentation +129 added lines, -129 removed lines

@@ -14,133 +14,133 @@
 trait EventsAdmin
 {
 
-    /**
-     * @param string $additional_params
-     */
-    public function amOnDefaultEventsListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params));
-    }
-
-
-    /**
-     * Triggers the publishing of the Event.
-     */
-    public function publishEvent()
-    {
-        $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
-        $this->actor()->wait(3);
-        $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR);
-        $this->actor()->waitForText('Event published.', 30);
-    }
-
-
-    /**
-     * Triggers saving the Event.
-     */
-    public function saveEvent()
-    {
-        $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
-        $this->actor()->wait(2);
-        $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR);
-    }
-
-
-    /**
-     * Navigates the actor to the event list table page and will attempt to edit the event for the given title.
-     * First this will search using the given title and then attempt to edit from the results of the search.
-     *
-     * Assumes actor is already logged in.
-     * @param $event_title
-     */
-    public function amEditingTheEventWithTitle($event_title)
-    {
-        $this->amOnDefaultEventsListTablePage();
-        $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title);
-        $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
-        $this->actor()->waitForText($event_title, 15);
-        $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View"
-     * link for the event in the event list table.
-     * Assumes the actor is already logged in and on the Event list table page.
-     *
-     * @param string $event_title
-     */
-    public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title)
-    {
-        $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
-        $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * Used to retrieve the event id for the event via the list table and for the given event.
-     * @param string $event_title
-     */
-    public function observeEventIdInListTableForEvent($event_title)
-    {
-        return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * This performs the click action on the gear icon that triggers the advanced settings view state.
-     * Assumes the actor is already logged in and editing an event.
-     *
-     * @param int $row_number  What ticket row to toggle open/close.
-     */
-    public function toggleAdvancedSettingsViewForTicketRow($row_number = 1)
-    {
-        $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number));
-    }
-
-
-    /**
-     * Toggles the TKT_is_taxable checkbox for the ticket in the given row.
-     * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that
-     * ticket is "open".
-     *
-     * @param int $row_number  What ticket row to toggle the checkbox for.
-     */
-    public function toggleTicketIsTaxableForTicketRow($row_number = 1)
-    {
-        $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number));
-    }
-
-
-    /**
-     * Use to change the default registration status for the event.
-     * Assumes the view is already on the event editor.
-     * @param $registration_status
-     */
-    public function changeDefaultRegistrationStatusTo($registration_status)
-    {
-        $this->actor()->selectOption(
-            EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR,
-            $registration_status
-        );
-    }
-
-
-    /**
-     * Use this from the context of the event editor to select the given custom template for a given message type and
-     * messenger.
-     *
-     * @param string $message_type_label  The visible label for the message type (eg Registration Approved)
-     * @param string $messenger_slug      The slug for the messenger (eg 'email')
-     * @param string $custom_template_label The visible label in the select input for the custom template you want
-     *                                      selected.
-     */
-    public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label)
-    {
-        $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug));
-        $this->actor()->selectOption(
-            EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label),
-            $custom_template_label
-        );
-    }
+	/**
+	 * @param string $additional_params
+	 */
+	public function amOnDefaultEventsListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * Triggers the publishing of the Event.
+	 */
+	public function publishEvent()
+	{
+		$this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
+		$this->actor()->wait(3);
+		$this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR);
+		$this->actor()->waitForText('Event published.', 30);
+	}
+
+
+	/**
+	 * Triggers saving the Event.
+	 */
+	public function saveEvent()
+	{
+		$this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
+		$this->actor()->wait(2);
+		$this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR);
+	}
+
+
+	/**
+	 * Navigates the actor to the event list table page and will attempt to edit the event for the given title.
+	 * First this will search using the given title and then attempt to edit from the results of the search.
+	 *
+	 * Assumes actor is already logged in.
+	 * @param $event_title
+	 */
+	public function amEditingTheEventWithTitle($event_title)
+	{
+		$this->amOnDefaultEventsListTablePage();
+		$this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title);
+		$this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
+		$this->actor()->waitForText($event_title, 15);
+		$this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View"
+	 * link for the event in the event list table.
+	 * Assumes the actor is already logged in and on the Event list table page.
+	 *
+	 * @param string $event_title
+	 */
+	public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title)
+	{
+		$this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
+		$this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * Used to retrieve the event id for the event via the list table and for the given event.
+	 * @param string $event_title
+	 */
+	public function observeEventIdInListTableForEvent($event_title)
+	{
+		return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * This performs the click action on the gear icon that triggers the advanced settings view state.
+	 * Assumes the actor is already logged in and editing an event.
+	 *
+	 * @param int $row_number  What ticket row to toggle open/close.
+	 */
+	public function toggleAdvancedSettingsViewForTicketRow($row_number = 1)
+	{
+		$this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number));
+	}
+
+
+	/**
+	 * Toggles the TKT_is_taxable checkbox for the ticket in the given row.
+	 * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that
+	 * ticket is "open".
+	 *
+	 * @param int $row_number  What ticket row to toggle the checkbox for.
+	 */
+	public function toggleTicketIsTaxableForTicketRow($row_number = 1)
+	{
+		$this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number));
+	}
+
+
+	/**
+	 * Use to change the default registration status for the event.
+	 * Assumes the view is already on the event editor.
+	 * @param $registration_status
+	 */
+	public function changeDefaultRegistrationStatusTo($registration_status)
+	{
+		$this->actor()->selectOption(
+			EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR,
+			$registration_status
+		);
+	}
+
+
+	/**
+	 * Use this from the context of the event editor to select the given custom template for a given message type and
+	 * messenger.
+	 *
+	 * @param string $message_type_label  The visible label for the message type (eg Registration Approved)
+	 * @param string $messenger_slug      The slug for the messenger (eg 'email')
+	 * @param string $custom_template_label The visible label in the select input for the custom template you want
+	 *                                      selected.
+	 */
+	public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label)
+	{
+		$this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug));
+		$this->actor()->selectOption(
+			EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label),
+			$custom_template_label
+		);
+	}
 }
\ No newline at end of file

acceptance_tests/Helpers/MessagesAdmin.php

Indentation +289 added lines, -289 removed lines

@@ -10,293 +10,293 @@
  */
 trait MessagesAdmin
 {
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnMessagesActivityListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
-    }
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnCustomMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
-    }
-
-
-    /**
-     * Directs to message settings page
-     */
-    public function amOnMessageSettingsPage()
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
-    }
-
-
-    public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
-    {
-        $this->actor()->dragAndDrop(
-            MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
-            MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
-        );
-    }
-
-
-    /**
-     * Assumes you are already on the list table page that has the ui for editing the template.
-     * @param string $message_type_slug
-     * @param string $context [optional] if you want to click directly to the given context in the editor
-     */
-    public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
-    {
-        $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
-    }
-
-
-    /**
-     * Use this action to verify that the count for the given text in the specified field is as expected.  For example
-     * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
-     *
-     * @param int    $expected_occurence_count
-     * @param string $text_to_check_for
-     * @param string $field
-     * @param string $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     */
-    public function verifyMatchingCountofTextInMessageActivityListTableFor(
-        $expected_occurence_count,
-        $text_to_check_for,
-        $field,
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin'
-    ) {
-        $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
-            $field,
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $text_to_check_for,
-            0
-        ));
-        $actual_count = count($elements);
-        $this->actor()->assertEquals(
-            $expected_occurence_count,
-            $actual_count,
-            sprintf(
-                'Expected %s of the %s text for the %s field but there were actually %s counted.',
-                $expected_occurence_count,
-                $text_to_check_for,
-                $field,
-                $actual_count
-            )
-        );
-    }
-
-
-    /**
-     * This will create a custom message template for the given messenger and message type from the context of the
-     * default (global) message template list table.
-     * Also takes care of verifying the template was created.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     */
-    public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
-    {
-        $this->amOnDefaultMessageTemplateListTablePage();
-        $this->actor()->click(
-            MessagesPage::createCustomButtonForMessageTypeAndMessenger(
-                $message_type_label,
-                $messenger_label
-            )
-        );
-        $this->actor()->seeInField('#title', 'New Custom Template');
-    }
-
-
-    /**
-     * This switches the context of the current messages template to the given reference.
-     * @param string $context_reference  This should be the visible label for the option.
-     */
-    public function switchContextTo($context_reference)
-    {
-        $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
-        $this->actor()->waitForText($context_reference, 10, 'h1');
-    }
-
-
-    /**
-     * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
-     * toggling.
-     *
-     * @param string $context_string           What context is being switched (used for the expected state text)
-     * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
-     *                                         (false)
-     */
-    public function toggleContextState($context_string, $expected_state_is_active = true)
-    {
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
-        if ($expected_state_is_active) {
-            $this->actor()->waitForText("The template for $context_string is currently active.");
-        } else {
-            $this->actor()->waitForText("The template for $context_string is currently inactive");
-        }
-    }
-
-
-    /**
-     * Triggers saving the message template.
-     * @param bool $and_close   Use to indicate to click the Save and Close button.
-     */
-    public function saveMessageTemplate($and_close = false)
-    {
-        $this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
-        if ($and_close) {
-            $this->actor()->click('Save and Close');
-        } else {
-            $this->actor()->click('Save');
-        }
-        $this->actor()->waitForText('successfully updated');
-    }
-
-
-    /**
-     * This takes care of clicking the View Message icon for the given parameters.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function viewMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        ));
-    }
-
-
-    /**
-     * Takes care of deleting a message matching the given parameters via the message activity list table.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function deleteMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        );
-        $cell_selector = MessagesPage::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $this->actor()->scrollTo($cell_selector, 0, -30);
-        $this->actor()->moveMouseOver(
-            $cell_selector,
-            5,
-            5
-        );
-        $this->actor()->waitForElementVisible(
-            $delete_action_selector
-        );
-        $this->actor()->click(
-            $delete_action_selector
-        );
-        $this->actor()->waitForText('successfully deleted', 20);
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is in that window.
-     * @param string $text_to_view
-     */
-    public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
-    {
-        $this->actor()->wait(2);
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
-        $this->actor()->switchToIframe();
-    }
-
-
-    /**
-     * This returns the value for the link at the given selector in the message modal.
-     * @param string $selector (any selector string accepted by WebDriver)
-     */
-    public function observeLinkAtSelectorInMessageModal($selector)
-    {
-        $this->actor()->wait(2);
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $link = $this->actor()->observeLinkUrlAt($selector);
-        $this->actor()->switchToIframe();
-        return $link;
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is NOT that window.
-     * @param string $text_to_view
-     */
-    public function dontSeeTextInViewMessageModal($text_to_view)
-    {
-        $this->seeTextInViewMessageModal($text_to_view, true);
-    }
-
-
-    public function dismissMessageModal()
-    {
-        $this->actor()->executeJs('window.dialogHelper.closeModal()');
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnMessagesActivityListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
+	}
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnCustomMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * Directs to message settings page
+	 */
+	public function amOnMessageSettingsPage()
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
+	}
+
+
+	public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
+	{
+		$this->actor()->dragAndDrop(
+			MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
+			MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
+		);
+	}
+
+
+	/**
+	 * Assumes you are already on the list table page that has the ui for editing the template.
+	 * @param string $message_type_slug
+	 * @param string $context [optional] if you want to click directly to the given context in the editor
+	 */
+	public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
+	{
+		$this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
+	}
+
+
+	/**
+	 * Use this action to verify that the count for the given text in the specified field is as expected.  For example
+	 * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
+	 *
+	 * @param int    $expected_occurence_count
+	 * @param string $text_to_check_for
+	 * @param string $field
+	 * @param string $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 */
+	public function verifyMatchingCountofTextInMessageActivityListTableFor(
+		$expected_occurence_count,
+		$text_to_check_for,
+		$field,
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin'
+	) {
+		$elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
+			$field,
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$text_to_check_for,
+			0
+		));
+		$actual_count = count($elements);
+		$this->actor()->assertEquals(
+			$expected_occurence_count,
+			$actual_count,
+			sprintf(
+				'Expected %s of the %s text for the %s field but there were actually %s counted.',
+				$expected_occurence_count,
+				$text_to_check_for,
+				$field,
+				$actual_count
+			)
+		);
+	}
+
+
+	/**
+	 * This will create a custom message template for the given messenger and message type from the context of the
+	 * default (global) message template list table.
+	 * Also takes care of verifying the template was created.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 */
+	public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
+	{
+		$this->amOnDefaultMessageTemplateListTablePage();
+		$this->actor()->click(
+			MessagesPage::createCustomButtonForMessageTypeAndMessenger(
+				$message_type_label,
+				$messenger_label
+			)
+		);
+		$this->actor()->seeInField('#title', 'New Custom Template');
+	}
+
+
+	/**
+	 * This switches the context of the current messages template to the given reference.
+	 * @param string $context_reference  This should be the visible label for the option.
+	 */
+	public function switchContextTo($context_reference)
+	{
+		$this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
+		$this->actor()->waitForText($context_reference, 10, 'h1');
+	}
+
+
+	/**
+	 * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
+	 * toggling.
+	 *
+	 * @param string $context_string           What context is being switched (used for the expected state text)
+	 * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
+	 *                                         (false)
+	 */
+	public function toggleContextState($context_string, $expected_state_is_active = true)
+	{
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
+		if ($expected_state_is_active) {
+			$this->actor()->waitForText("The template for $context_string is currently active.");
+		} else {
+			$this->actor()->waitForText("The template for $context_string is currently inactive");
+		}
+	}
+
+
+	/**
+	 * Triggers saving the message template.
+	 * @param bool $and_close   Use to indicate to click the Save and Close button.
+	 */
+	public function saveMessageTemplate($and_close = false)
+	{
+		$this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
+		if ($and_close) {
+			$this->actor()->click('Save and Close');
+		} else {
+			$this->actor()->click('Save');
+		}
+		$this->actor()->waitForText('successfully updated');
+	}
+
+
+	/**
+	 * This takes care of clicking the View Message icon for the given parameters.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function viewMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		));
+	}
+
+
+	/**
+	 * Takes care of deleting a message matching the given parameters via the message activity list table.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function deleteMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		);
+		$cell_selector = MessagesPage::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$this->actor()->scrollTo($cell_selector, 0, -30);
+		$this->actor()->moveMouseOver(
+			$cell_selector,
+			5,
+			5
+		);
+		$this->actor()->waitForElementVisible(
+			$delete_action_selector
+		);
+		$this->actor()->click(
+			$delete_action_selector
+		);
+		$this->actor()->waitForText('successfully deleted', 20);
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is in that window.
+	 * @param string $text_to_view
+	 */
+	public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
+	{
+		$this->actor()->wait(2);
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
+		$this->actor()->switchToIframe();
+	}
+
+
+	/**
+	 * This returns the value for the link at the given selector in the message modal.
+	 * @param string $selector (any selector string accepted by WebDriver)
+	 */
+	public function observeLinkAtSelectorInMessageModal($selector)
+	{
+		$this->actor()->wait(2);
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$link = $this->actor()->observeLinkUrlAt($selector);
+		$this->actor()->switchToIframe();
+		return $link;
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is NOT that window.
+	 * @param string $text_to_view
+	 */
+	public function dontSeeTextInViewMessageModal($text_to_view)
+	{
+		$this->seeTextInViewMessageModal($text_to_view, true);
+	}
+
+
+	public function dismissMessageModal()
+	{
+		$this->actor()->executeJs('window.dialogHelper.closeModal()');
+	}
 }

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +1083 added lines, -1083 removed lines

@@ -25,1144 +25,1144 @@
 {
 
 
-    /**
-     * possibly truncated version of the EE core version string
-     *
-     * @var string
-     */
-    protected static $_core_version = '';
+	/**
+	 * possibly truncated version of the EE core version string
+	 *
+	 * @var string
+	 */
+	protected static $_core_version = '';
 
-    /**
-     * Holds values for registered addons
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered addons
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
-    /**
-     * @var  array $_incompatible_addons keys are addon SLUGS
-     * (first argument passed to EE_Register_Addon::register()), keys are
-     * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
-     * Generally this should be used sparingly, as we don't want to muddle up
-     * EE core with knowledge of ALL the addons out there.
-     * If you want NO versions of an addon to run with a certain version of core,
-     * it's usually best to define the addon's "min_core_version" as part of its call
-     * to EE_Register_Addon::register(), rather than using this array with a super high value for its
-     * minimum plugin version.
-     * @access    protected
-     */
-    protected static $_incompatible_addons = array(
-        'Multi_Event_Registration' => '2.0.11.rc.002',
-        'Promotions'               => '1.0.0.rc.084',
-    );
+	/**
+	 * @var  array $_incompatible_addons keys are addon SLUGS
+	 * (first argument passed to EE_Register_Addon::register()), keys are
+	 * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
+	 * Generally this should be used sparingly, as we don't want to muddle up
+	 * EE core with knowledge of ALL the addons out there.
+	 * If you want NO versions of an addon to run with a certain version of core,
+	 * it's usually best to define the addon's "min_core_version" as part of its call
+	 * to EE_Register_Addon::register(), rather than using this array with a super high value for its
+	 * minimum plugin version.
+	 * @access    protected
+	 */
+	protected static $_incompatible_addons = array(
+		'Multi_Event_Registration' => '2.0.11.rc.002',
+		'Promotions'               => '1.0.0.rc.084',
+	);
 
 
-    /**
-     * We should always be comparing core to a version like '4.3.0.rc.000',
-     * not just '4.3.0'.
-     * So if the addon developer doesn't provide that full version string,
-     * fill in the blanks for them
-     *
-     * @param string $min_core_version
-     * @return string always like '4.3.0.rc.000'
-     */
-    protected static function _effective_version($min_core_version)
-    {
-        // versions: 4 . 3 . 1 . p . 123
-        // offsets:    0 . 1 . 2 . 3 . 4
-        $version_parts = explode('.', $min_core_version);
-        //check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
-            $version_parts[2] = '0';
-        }
-        //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
-        //soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
-            $version_parts[3] = 'dev';
-        }
-        if (! isset($version_parts[4])) {
-            $version_parts[4] = '000';
-        }
-        return implode('.', $version_parts);
-    }
+	/**
+	 * We should always be comparing core to a version like '4.3.0.rc.000',
+	 * not just '4.3.0'.
+	 * So if the addon developer doesn't provide that full version string,
+	 * fill in the blanks for them
+	 *
+	 * @param string $min_core_version
+	 * @return string always like '4.3.0.rc.000'
+	 */
+	protected static function _effective_version($min_core_version)
+	{
+		// versions: 4 . 3 . 1 . p . 123
+		// offsets:    0 . 1 . 2 . 3 . 4
+		$version_parts = explode('.', $min_core_version);
+		//check they specified the micro version (after 2nd period)
+		if (! isset($version_parts[2])) {
+			$version_parts[2] = '0';
+		}
+		//if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
+		//soon we can assume that's 'rc', but this current version is 'alpha'
+		if (! isset($version_parts[3])) {
+			$version_parts[3] = 'dev';
+		}
+		if (! isset($version_parts[4])) {
+			$version_parts[4] = '000';
+		}
+		return implode('.', $version_parts);
+	}
 
 
-    /**
-     * Returns whether or not the min core version requirement of the addon is met
-     *
-     * @param string $min_core_version    the minimum core version required by the addon
-     * @param string $actual_core_version the actual core version, optional
-     * @return boolean
-     */
-    public static function _meets_min_core_version_requirement(
-        $min_core_version,
-        $actual_core_version = EVENT_ESPRESSO_VERSION
-    ) {
-        return version_compare(
-            self::_effective_version($actual_core_version),
-            self::_effective_version($min_core_version),
-            '>='
-        );
-    }
+	/**
+	 * Returns whether or not the min core version requirement of the addon is met
+	 *
+	 * @param string $min_core_version    the minimum core version required by the addon
+	 * @param string $actual_core_version the actual core version, optional
+	 * @return boolean
+	 */
+	public static function _meets_min_core_version_requirement(
+		$min_core_version,
+		$actual_core_version = EVENT_ESPRESSO_VERSION
+	) {
+		return version_compare(
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
+			'>='
+		);
+	}
 
 
-    /**
-     * Method for registering new EE_Addons.
-     * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
-     * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
-     * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
-     * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
-     * 'activate_plugin', it registers the addon still, but its components are not registered
-     * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
-     * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
-     * (so that we can detect that the addon has activated on the subsequent request)
-     *
-     * @since    4.3.0
-     * @param string                  $addon_name                       the EE_Addon's name. Required.
-     * @param  array                  $setup_args                       {
-     *                                                                  An array of arguments provided for registering the
-     *                                                                  message type.
-     * @type  string                  $class_name                       the addon's main file name.
-     *                                                                  If left blank, generated from the addon name,
-     *                                                                  changes something like "calendar" to "EE_Calendar"
-     * @type string                   $min_core_version                 the minimum version of EE Core that the
-     *                                                                  addon will work with. eg "4.8.1.rc.084"
-     * @type string                   $version                          the "software" version for the addon. eg
-     *                                                                  "1.0.0.p" for a first stable release, or
-     *                                                                  "1.0.0.rc.043" for a version in progress
-     * @type string                   $main_file_path                   the full server path to the main file
-     *                                                                  loaded directly by WP
-     * @type string                   $domain_fqcn                      Fully Qualified Class Name
-     *                                                                  for the addon's Domain class
-     *                                                                  (see EventEspresso\core\domain\Domain)
-     * @type string                   $admin_path                       full server path to the folder where the
-     *                                                                  addon\'s admin files reside
-     * @type string                   $admin_callback                   a method to be called when the EE Admin is
-     *                                                                  first invoked, can be used for hooking into
-     *                                                                  any admin page
-     * @type string                   $config_section                   the section name for this addon's
-     *                                                                  configuration settings section
-     *                                                                  (defaults to "addons")
-     * @type string                   $config_class                     the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $config_name                      the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $autoloader_paths                 an array of class names and the full server
-     *                                                                  paths to those files. Required.
-     * @type string                   $autoloader_folders               an array of  "full server paths" for any
-     *                                                                  folders containing classes that might be
-     *                                                                  invoked by the addon
-     * @type string                   $dms_paths                        an array of full server paths to folders that
-     *                                                                  contain data migration scripts. Required.
-     * @type string                   $module_paths                     an array of full server paths to any
-     *                                                                  EED_Modules used by the addon
-     * @type string                   $shortcode_paths                  an array of full server paths to folders
-     *                                                                  that contain EES_Shortcodes
-     * @type string                   $widget_paths                     an array of full server paths to folders
-     *                                                                  that contain WP_Widgets
-     * @type string                   $pue_options
-     * @type array                    $capabilities                     an array indexed by role name
-     *                                                                  (i.e administrator,author ) and the values
-     *                                                                  are an array of caps to add to the role.
-     *                                                                  'administrator' => array(
-     *                                                                  'read_addon',
-     *                                                                  'edit_addon',
-     *                                                                  etc.
-     *                                                                  ).
-     * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
-     *                                                                  for any addons that need to register any
-     *                                                                  special meta mapped capabilities.  Should
-     *                                                                  be indexed where the key is the
-     *                                                                  EE_Meta_Capability_Map class name and the
-     *                                                                  values are the arguments sent to the class.
-     * @type array                    $model_paths                      array of folders containing DB models
-     * @see      EE_Register_Model
-     * @type array                    $class_paths                      array of folders containing DB classes
-     * @see      EE_Register_Model
-     * @type array                    $model_extension_paths            array of folders containing DB model
-     *                                                                  extensions
-     * @see      EE_Register_Model_Extension
-     * @type array                    $class_extension_paths            array of folders containing DB class
-     *                                                                  extensions
-     * @see      EE_Register_Model_Extension
-     * @type array message_types {
-     *                                                                  An array of message types with the key as
-     *                                                                  the message type name and the values as
-     *                                                                  below:
-     * @type string                   $mtfilename                       The filename of the message type being
-     *                                                                  registered. This will be the main
-     *                                                                  EE_{Message Type Name}_message_type class.
-     *                                                                  (eg. EE_Declined_Registration_message_type.class.php)
-     *                                                                  Required.
-     * @type array                    $autoloadpaths                    An array of paths to add to the messages
-     *                                                                  autoloader for the new message type.
-     *                                                                  Required.
-     * @type array                    $messengers_to_activate_with      An array of messengers that this message
-     *                                                                  type should activate with. Each value in
-     *                                                                  the
-     *                                                                  array
-     *                                                                  should match the name property of a
-     *                                                                  EE_messenger. Optional.
-     * @type array                    $messengers_to_validate_with      An array of messengers that this message
-     *                                                                  type should validate with. Each value in
-     *                                                                  the
-     *                                                                  array
-     *                                                                  should match the name property of an
-     *                                                                  EE_messenger.
-     *                                                                  Optional.
-     *                                                                  }
-     * @type array                    $custom_post_types
-     * @type array                    $custom_taxonomies
-     * @type array                    $payment_method_paths             each element is the folder containing the
-     *                                                                  EE_PMT_Base child class
-     *                                                                  (eg,
-     *                                                                  '/wp-content/plugins/my_plugin/Payomatic/'
-     *                                                                  which contains the files
-     *                                                                  EE_PMT_Payomatic.pm.php)
-     * @type array                    $default_terms
-     * @type array                    $namespace                        {
-     *                                                                  An array with two items for registering the
-     *                                                                  addon's namespace. (If, for some reason, you
-     *                                                                  require additional namespaces,
-     *                                                                  use EventEspresso\core\Psr4Autoloader::addNamespace()
-     *                                                                  directly)
-     * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
-     * @type string                   $FQNS                             the namespace prefix
-     * @type string                   $DIR                              a base directory for class files in the
-     *                                                                  namespace.
-     *                                                                  }
-     *                                                                  }
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function register($addon_name = '', $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
-        $class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
-        //setup $_settings array from incoming values.
-        $addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // setup PUE
-        EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
-        // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
-            return;
-        }
-        // register namespaces
-        EE_Register_Addon::_setup_namespaces($addon_settings);
-        // check if this is an activation request
-        if (EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
-            // dont bother setting up the rest of the addon atm
-            return;
-        }
-        // we need cars
-        EE_Register_Addon::_setup_autoloaders($addon_name);
-        // register new models and extensions
-        EE_Register_Addon::_register_models_and_extensions($addon_name);
-        // setup DMS
-        EE_Register_Addon::_register_data_migration_scripts($addon_name);
-        // if config_class is present let's register config.
-        EE_Register_Addon::_register_config($addon_name);
-        // register admin pages
-        EE_Register_Addon::_register_admin_pages($addon_name);
-        // add to list of modules to be registered
-        EE_Register_Addon::_register_modules($addon_name);
-        // add to list of shortcodes to be registered
-        EE_Register_Addon::_register_shortcodes($addon_name);
-        // add to list of widgets to be registered
-        EE_Register_Addon::_register_widgets($addon_name);
-        // register capability related stuff.
-        EE_Register_Addon::_register_capabilities($addon_name);
-        // any message type to register?
-        EE_Register_Addon::_register_message_types($addon_name);
-        // any custom post type/ custom capabilities or default terms to register
-        EE_Register_Addon::_register_custom_post_types($addon_name);
-        // and any payment methods
-        EE_Register_Addon::_register_payment_methods($addon_name);
-        // load and instantiate main addon class
-        $addon = EE_Register_Addon::_load_and_init_addon_class($addon_name);
-        //delay calling after_registration hook on each addon until after all add-ons have been registered.
-        add_action('AHEE__EE_System__load_espresso_addons__complete', array($addon, 'after_registration'), 999);
-    }
+	/**
+	 * Method for registering new EE_Addons.
+	 * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
+	 * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
+	 * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
+	 * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
+	 * 'activate_plugin', it registers the addon still, but its components are not registered
+	 * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
+	 * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
+	 * (so that we can detect that the addon has activated on the subsequent request)
+	 *
+	 * @since    4.3.0
+	 * @param string                  $addon_name                       the EE_Addon's name. Required.
+	 * @param  array                  $setup_args                       {
+	 *                                                                  An array of arguments provided for registering the
+	 *                                                                  message type.
+	 * @type  string                  $class_name                       the addon's main file name.
+	 *                                                                  If left blank, generated from the addon name,
+	 *                                                                  changes something like "calendar" to "EE_Calendar"
+	 * @type string                   $min_core_version                 the minimum version of EE Core that the
+	 *                                                                  addon will work with. eg "4.8.1.rc.084"
+	 * @type string                   $version                          the "software" version for the addon. eg
+	 *                                                                  "1.0.0.p" for a first stable release, or
+	 *                                                                  "1.0.0.rc.043" for a version in progress
+	 * @type string                   $main_file_path                   the full server path to the main file
+	 *                                                                  loaded directly by WP
+	 * @type string                   $domain_fqcn                      Fully Qualified Class Name
+	 *                                                                  for the addon's Domain class
+	 *                                                                  (see EventEspresso\core\domain\Domain)
+	 * @type string                   $admin_path                       full server path to the folder where the
+	 *                                                                  addon\'s admin files reside
+	 * @type string                   $admin_callback                   a method to be called when the EE Admin is
+	 *                                                                  first invoked, can be used for hooking into
+	 *                                                                  any admin page
+	 * @type string                   $config_section                   the section name for this addon's
+	 *                                                                  configuration settings section
+	 *                                                                  (defaults to "addons")
+	 * @type string                   $config_class                     the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $config_name                      the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $autoloader_paths                 an array of class names and the full server
+	 *                                                                  paths to those files. Required.
+	 * @type string                   $autoloader_folders               an array of  "full server paths" for any
+	 *                                                                  folders containing classes that might be
+	 *                                                                  invoked by the addon
+	 * @type string                   $dms_paths                        an array of full server paths to folders that
+	 *                                                                  contain data migration scripts. Required.
+	 * @type string                   $module_paths                     an array of full server paths to any
+	 *                                                                  EED_Modules used by the addon
+	 * @type string                   $shortcode_paths                  an array of full server paths to folders
+	 *                                                                  that contain EES_Shortcodes
+	 * @type string                   $widget_paths                     an array of full server paths to folders
+	 *                                                                  that contain WP_Widgets
+	 * @type string                   $pue_options
+	 * @type array                    $capabilities                     an array indexed by role name
+	 *                                                                  (i.e administrator,author ) and the values
+	 *                                                                  are an array of caps to add to the role.
+	 *                                                                  'administrator' => array(
+	 *                                                                  'read_addon',
+	 *                                                                  'edit_addon',
+	 *                                                                  etc.
+	 *                                                                  ).
+	 * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
+	 *                                                                  for any addons that need to register any
+	 *                                                                  special meta mapped capabilities.  Should
+	 *                                                                  be indexed where the key is the
+	 *                                                                  EE_Meta_Capability_Map class name and the
+	 *                                                                  values are the arguments sent to the class.
+	 * @type array                    $model_paths                      array of folders containing DB models
+	 * @see      EE_Register_Model
+	 * @type array                    $class_paths                      array of folders containing DB classes
+	 * @see      EE_Register_Model
+	 * @type array                    $model_extension_paths            array of folders containing DB model
+	 *                                                                  extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array                    $class_extension_paths            array of folders containing DB class
+	 *                                                                  extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array message_types {
+	 *                                                                  An array of message types with the key as
+	 *                                                                  the message type name and the values as
+	 *                                                                  below:
+	 * @type string                   $mtfilename                       The filename of the message type being
+	 *                                                                  registered. This will be the main
+	 *                                                                  EE_{Message Type Name}_message_type class.
+	 *                                                                  (eg. EE_Declined_Registration_message_type.class.php)
+	 *                                                                  Required.
+	 * @type array                    $autoloadpaths                    An array of paths to add to the messages
+	 *                                                                  autoloader for the new message type.
+	 *                                                                  Required.
+	 * @type array                    $messengers_to_activate_with      An array of messengers that this message
+	 *                                                                  type should activate with. Each value in
+	 *                                                                  the
+	 *                                                                  array
+	 *                                                                  should match the name property of a
+	 *                                                                  EE_messenger. Optional.
+	 * @type array                    $messengers_to_validate_with      An array of messengers that this message
+	 *                                                                  type should validate with. Each value in
+	 *                                                                  the
+	 *                                                                  array
+	 *                                                                  should match the name property of an
+	 *                                                                  EE_messenger.
+	 *                                                                  Optional.
+	 *                                                                  }
+	 * @type array                    $custom_post_types
+	 * @type array                    $custom_taxonomies
+	 * @type array                    $payment_method_paths             each element is the folder containing the
+	 *                                                                  EE_PMT_Base child class
+	 *                                                                  (eg,
+	 *                                                                  '/wp-content/plugins/my_plugin/Payomatic/'
+	 *                                                                  which contains the files
+	 *                                                                  EE_PMT_Payomatic.pm.php)
+	 * @type array                    $default_terms
+	 * @type array                    $namespace                        {
+	 *                                                                  An array with two items for registering the
+	 *                                                                  addon's namespace. (If, for some reason, you
+	 *                                                                  require additional namespaces,
+	 *                                                                  use EventEspresso\core\Psr4Autoloader::addNamespace()
+	 *                                                                  directly)
+	 * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
+	 * @type string                   $FQNS                             the namespace prefix
+	 * @type string                   $DIR                              a base directory for class files in the
+	 *                                                                  namespace.
+	 *                                                                  }
+	 *                                                                  }
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function register($addon_name = '', $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
+		$class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
+		//setup $_settings array from incoming values.
+		$addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// setup PUE
+		EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
+		// does this addon work with this version of core or WordPress ?
+		if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+			return;
+		}
+		// register namespaces
+		EE_Register_Addon::_setup_namespaces($addon_settings);
+		// check if this is an activation request
+		if (EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+			// dont bother setting up the rest of the addon atm
+			return;
+		}
+		// we need cars
+		EE_Register_Addon::_setup_autoloaders($addon_name);
+		// register new models and extensions
+		EE_Register_Addon::_register_models_and_extensions($addon_name);
+		// setup DMS
+		EE_Register_Addon::_register_data_migration_scripts($addon_name);
+		// if config_class is present let's register config.
+		EE_Register_Addon::_register_config($addon_name);
+		// register admin pages
+		EE_Register_Addon::_register_admin_pages($addon_name);
+		// add to list of modules to be registered
+		EE_Register_Addon::_register_modules($addon_name);
+		// add to list of shortcodes to be registered
+		EE_Register_Addon::_register_shortcodes($addon_name);
+		// add to list of widgets to be registered
+		EE_Register_Addon::_register_widgets($addon_name);
+		// register capability related stuff.
+		EE_Register_Addon::_register_capabilities($addon_name);
+		// any message type to register?
+		EE_Register_Addon::_register_message_types($addon_name);
+		// any custom post type/ custom capabilities or default terms to register
+		EE_Register_Addon::_register_custom_post_types($addon_name);
+		// and any payment methods
+		EE_Register_Addon::_register_payment_methods($addon_name);
+		// load and instantiate main addon class
+		$addon = EE_Register_Addon::_load_and_init_addon_class($addon_name);
+		//delay calling after_registration hook on each addon until after all add-ons have been registered.
+		add_action('AHEE__EE_System__load_espresso_addons__complete', array($addon, 'after_registration'), 999);
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _verify_parameters($addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args)) {
-            throw new EE_Error(
-                __(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _verify_parameters($addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args)) {
+			throw new EE_Error(
+				__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name($addon_name, array $setup_args)
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
-            //capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
-        return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
-            ? $class_name
-            : 'EE_' . $class_name;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name($addon_name, array $setup_args)
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
+			//capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		// check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
+		return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
+			? $class_name
+			: 'EE_' . $class_name;
+	}
 
 
-    /**
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return array
-     */
-    private static function _get_addon_settings($class_name, array $setup_args)
-    {
-        //setup $_settings array from incoming values.
-        $addon_settings = array(
-            // generated from the addon name, changes something like "calendar" to "EE_Calendar"
-            'class_name'            => $class_name,
-            // the addon slug for use in URLs, etc
-            'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string) $setup_args['plugin_slug']
-                : '',
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string) $setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string) $setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string) $setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string) $setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string) $setup_args['main_file_path']
-                : '',
-            // Fully Qualified Class Name for the addon's Domain class
-            'domain_fqcn'           => isset($setup_args['domain_fqcn'])
-                ? (string) $setup_args['domain_fqcn']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string) $setup_args['admin_path'] : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string) $setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string) $setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string) $setup_args['config_class'] : '',
-            //the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string) $setup_args['config_name'] : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array) $setup_args['autoloader_paths']
-                : array(),
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array) $setup_args['autoloader_folders']
-                : array(),
-            // array of full server paths to any EE_DMS data migration scripts used by the addon
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array) $setup_args['dms_paths']
-                : array(),
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array) $setup_args['module_paths']
-                : array(),
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : array(),
-            'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : array(),
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array) $setup_args['widget_paths']
-                : array(),
-            // array of PUE options used by the addon
-            'pue_options'           => isset($setup_args['pue_options'])
-                ? (array) $setup_args['pue_options']
-                : array(),
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array) $setup_args['message_types']
-                : array(),
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array) $setup_args['capabilities']
-                : array(),
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array) $setup_args['capability_maps']
-                : array(),
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array) $setup_args['model_paths']
-                : array(),
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array) $setup_args['class_paths']
-                : array(),
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array) $setup_args['model_extension_paths']
-                : array(),
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array) $setup_args['class_extension_paths']
-                : array(),
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array) $setup_args['custom_post_types']
-                : array(),
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array) $setup_args['custom_taxonomies']
-                : array(),
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : array(),
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array) $setup_args['default_terms']
-                : array(),
-            // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-            // that can be used for adding upgrading/marketing info
-            'plugins_page_row'      => isset($setup_args['plugins_page_row'])
-                ? $setup_args['plugins_page_row']
-                : '',
-            'namespace'             => isset(
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array) $setup_args['namespace']
-                : array(),
-        );
-        // if plugin_action_slug is NOT set, but an admin page path IS set,
-        // then let's just use the plugin_slug since that will be used for linking to the admin page
-        $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
-                                                && ! empty($addon_settings['admin_path'])
-            ? $addon_settings['plugin_slug']
-            : $addon_settings['plugin_action_slug'];
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
-    }
+	/**
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return array
+	 */
+	private static function _get_addon_settings($class_name, array $setup_args)
+	{
+		//setup $_settings array from incoming values.
+		$addon_settings = array(
+			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
+			'class_name'            => $class_name,
+			// the addon slug for use in URLs, etc
+			'plugin_slug'           => isset($setup_args['plugin_slug'])
+				? (string) $setup_args['plugin_slug']
+				: '',
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string) $setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string) $setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string) $setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string) $setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string) $setup_args['main_file_path']
+				: '',
+			// Fully Qualified Class Name for the addon's Domain class
+			'domain_fqcn'           => isset($setup_args['domain_fqcn'])
+				? (string) $setup_args['domain_fqcn']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string) $setup_args['admin_path'] : '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string) $setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string) $setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string) $setup_args['config_class'] : '',
+			//the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string) $setup_args['config_name'] : '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array) $setup_args['autoloader_paths']
+				: array(),
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array) $setup_args['autoloader_folders']
+				: array(),
+			// array of full server paths to any EE_DMS data migration scripts used by the addon
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array) $setup_args['dms_paths']
+				: array(),
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array) $setup_args['module_paths']
+				: array(),
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: array(),
+			'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: array(),
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array) $setup_args['widget_paths']
+				: array(),
+			// array of PUE options used by the addon
+			'pue_options'           => isset($setup_args['pue_options'])
+				? (array) $setup_args['pue_options']
+				: array(),
+			'message_types'         => isset($setup_args['message_types'])
+				? (array) $setup_args['message_types']
+				: array(),
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array) $setup_args['capabilities']
+				: array(),
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array) $setup_args['capability_maps']
+				: array(),
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array) $setup_args['model_paths']
+				: array(),
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array) $setup_args['class_paths']
+				: array(),
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array) $setup_args['model_extension_paths']
+				: array(),
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array) $setup_args['class_extension_paths']
+				: array(),
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array) $setup_args['custom_post_types']
+				: array(),
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array) $setup_args['custom_taxonomies']
+				: array(),
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: array(),
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array) $setup_args['default_terms']
+				: array(),
+			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+			// that can be used for adding upgrading/marketing info
+			'plugins_page_row'      => isset($setup_args['plugins_page_row'])
+				? $setup_args['plugins_page_row']
+				: '',
+			'namespace'             => isset(
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array) $setup_args['namespace']
+				: array(),
+		);
+		// if plugin_action_slug is NOT set, but an admin page path IS set,
+		// then let's just use the plugin_slug since that will be used for linking to the admin page
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
+												&& ! empty($addon_settings['admin_path'])
+			? $addon_settings['plugin_slug']
+			: $addon_settings['plugin_action_slug'];
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return boolean
-     */
-    private static function _addon_is_compatible($addon_name, array $addon_settings)
-    {
-        global $wp_version;
-        $incompatibility_message = '';
-        //check whether this addon version is compatible with EE core
-        if (
-            isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (
-        ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if (! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return boolean
+	 */
+	private static function _addon_is_compatible($addon_name, array $addon_settings)
+	{
+		global $wp_version;
+		$incompatibility_message = '';
+		//check whether this addon version is compatible with EE core
+		if (
+			isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (
+		! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if (! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
+	}
 
 
-    /**
-     * if plugin update engine is being used for auto-updates,
-     * then let's set that up now before going any further so that ALL addons can be updated
-     * (not needed if PUE is not being used)
-     *
-     * @param string $addon_name
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return void
-     */
-    private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
-    {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[ $addon_name ]['pue_options'] = array(
-                'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string) $setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string) $setup_args['pue_options']['plugin_basename']
-                    : plugin_basename($setup_args['main_file_path']),
-                'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string) $setup_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string) $setup_args['pue_options']['use_wp_update']
-                    : false,
-            );
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                array('EE_Register_Addon', 'load_pue_update')
-            );
-        }
-    }
+	/**
+	 * if plugin update engine is being used for auto-updates,
+	 * then let's set that up now before going any further so that ALL addons can be updated
+	 * (not needed if PUE is not being used)
+	 *
+	 * @param string $addon_name
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return void
+	 */
+	private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
+	{
+		if (! empty($setup_args['pue_options'])) {
+			self::$_settings[ $addon_name ]['pue_options'] = array(
+				'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
+					? (string) $setup_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
+					? (string) $setup_args['pue_options']['plugin_basename']
+					: plugin_basename($setup_args['main_file_path']),
+				'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
+					? (string) $setup_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
+					? (string) $setup_args['pue_options']['use_wp_update']
+					: false,
+			);
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				array('EE_Register_Addon', 'load_pue_update')
+			);
+		}
+	}
 
 
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (
-        isset(
-            $addon_settings['namespace']['FQNS'],
-            $addon_settings['namespace']['DIR']
-        )
-        ) {
-            EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            );
-        }
-    }
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (
+		isset(
+			$addon_settings['namespace']['FQNS'],
+			$addon_settings['namespace']['DIR']
+		)
+		) {
+			EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _addon_activation($addon_name, array $addon_settings)
-    {
-        // this is an activation request
-        if (did_action('activate_plugin')) {
-            //to find if THIS is the addon that was activated, just check if we have already registered it or not
-            //(as the newly-activated addon wasn't around the first time addons were registered).
-            //Note: the presence of pue_options in the addon registration options will initialize the $_settings
-            //property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
-                )
-            ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
-                $addon                          = self::_load_and_init_addon_class($addon_name);
-                $addon->set_activation_indicator_option();
-                // dont bother setting up the rest of the addon.
-                // we know it was just activated and the request will end soon
-            }
-            return true;
-        }
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-        }
-        // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
-        } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
-        }
-        return false;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _addon_activation($addon_name, array $addon_settings)
+	{
+		// this is an activation request
+		if (did_action('activate_plugin')) {
+			//to find if THIS is the addon that was activated, just check if we have already registered it or not
+			//(as the newly-activated addon wasn't around the first time addons were registered).
+			//Note: the presence of pue_options in the addon registration options will initialize the $_settings
+			//property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
+			if (! isset(self::$_settings[ $addon_name ])
+				|| (isset(self::$_settings[ $addon_name ])
+					&& ! isset(self::$_settings[ $addon_name ]['class_name'])
+				)
+			) {
+				self::$_settings[ $addon_name ] = $addon_settings;
+				$addon                          = self::_load_and_init_addon_class($addon_name);
+				$addon->set_activation_indicator_option();
+				// dont bother setting up the rest of the addon.
+				// we know it was just activated and the request will end soon
+			}
+			return true;
+		}
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+		}
+		// make sure addon settings are set correctly without overwriting anything existing
+		if (isset(self::$_settings[ $addon_name ])) {
+			self::$_settings[ $addon_name ] += $addon_settings;
+		} else {
+			self::$_settings[ $addon_name ] = $addon_settings;
+		}
+		return false;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _setup_autoloaders($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
-            // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
-        }
-        // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
-            }
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _setup_autoloaders($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+			// setup autoloader for single file
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+		}
+		// setup autoloaders for folders
+		if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
+			foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
+			}
+		}
+	}
 
 
-    /**
-     * register new models and extensions
-     *
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_models_and_extensions($addon_name)
-    {
-        // register new models
-        if (
-            ! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
-        ) {
-            EE_Register_Model::register(
-                $addon_name,
-                array(
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
-                )
-            );
-        }
-        // register model extensions
-        if (
-            ! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
-        ) {
-            EE_Register_Model_Extensions::register(
-                $addon_name,
-                array(
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
-                )
-            );
-        }
-    }
+	/**
+	 * register new models and extensions
+	 *
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_models_and_extensions($addon_name)
+	{
+		// register new models
+		if (
+			! empty(self::$_settings[ $addon_name ]['model_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['class_paths'])
+		) {
+			EE_Register_Model::register(
+				$addon_name,
+				array(
+					'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
+					'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+				)
+			);
+		}
+		// register model extensions
+		if (
+			! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+		) {
+			EE_Register_Model_Extensions::register(
+				$addon_name,
+				array(
+					'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
+					'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_data_migration_scripts($addon_name)
-    {
-        // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_data_migration_scripts($addon_name)
+	{
+		// setup DMS
+		if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_config($addon_name)
-    {
-        // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
-            EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
-                array(
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_config($addon_name)
+	{
+		// if config_class is present let's register config.
+		if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+			EE_Register_Config::register(
+				self::$_settings[ $addon_name ]['config_class'],
+				array(
+					'config_section' => self::$_settings[ $addon_name ]['config_section'],
+					'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_admin_pages($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_admin_pages($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_modules($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_modules($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_shortcodes($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-        ) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                array(
-                    'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
-                        ? self::$_settings[ $addon_name ]['shortcode_paths']
-                        : array(),
-                    'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                        ? self::$_settings[ $addon_name ]['shortcode_fqcns']
-                        : array(),
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_shortcodes($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+		) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				array(
+					'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
+						? self::$_settings[ $addon_name ]['shortcode_paths']
+						: array(),
+					'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+						? self::$_settings[ $addon_name ]['shortcode_fqcns']
+						: array(),
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_widgets($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_widgets($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_capabilities($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                array(
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_capabilities($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				array(
+					'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
+					'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_message_types($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                array('EE_Register_Addon', 'register_message_types')
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_message_types($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				array('EE_Register_Addon', 'register_message_types')
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_custom_post_types($addon_name)
-    {
-        if (
-            ! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                array(
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_custom_post_types($addon_name)
+	{
+		if (
+			! empty(self::$_settings[ $addon_name ]['custom_post_types'])
+			|| ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				array(
+					'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
+					'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
+					'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private static function _register_payment_methods($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private static function _register_payment_methods($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * Loads and instantiates the EE_Addon class and adds it onto the registry
-     *
-     * @param string $addon_name
-     * @return EE_Addon
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    private static function _load_and_init_addon_class($addon_name)
-    {
-        $loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
-        $addon = $loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
-            array('EE_Registry::create(addon)' => true)
-        );
-        // setter inject dep map if required
-        if($addon instanceof RequiresDependencyMapInterface && $addon->dependencyMap() === null){
-            $addon->setDependencyMap($loader->getShared('EE_Dependency_Map'));
-        }
-        // setter inject domain if required
-        if(
-            $addon instanceof RequiresDomainInterface
-            && self::$_settings[ $addon_name ]['domain_fqcn'] !== ''
-            && $addon->domain() === null
-        ){
-            $addon->setDomain(
-                $loader->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
-                    array(
-                        self::$_settings[ $addon_name ]['main_file_path'],
-                        self::$_settings[ $addon_name ]['version']
-                    )
-                )
-            );
-        }
+	/**
+	 * Loads and instantiates the EE_Addon class and adds it onto the registry
+	 *
+	 * @param string $addon_name
+	 * @return EE_Addon
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	private static function _load_and_init_addon_class($addon_name)
+	{
+		$loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
+		$addon = $loader->getShared(
+			self::$_settings[ $addon_name ]['class_name'],
+			array('EE_Registry::create(addon)' => true)
+		);
+		// setter inject dep map if required
+		if($addon instanceof RequiresDependencyMapInterface && $addon->dependencyMap() === null){
+			$addon->setDependencyMap($loader->getShared('EE_Dependency_Map'));
+		}
+		// setter inject domain if required
+		if(
+			$addon instanceof RequiresDomainInterface
+			&& self::$_settings[ $addon_name ]['domain_fqcn'] !== ''
+			&& $addon->domain() === null
+		){
+			$addon->setDomain(
+				$loader->getShared(
+					self::$_settings[ $addon_name ]['domain_fqcn'],
+					array(
+						self::$_settings[ $addon_name ]['main_file_path'],
+						self::$_settings[ $addon_name ]['version']
+					)
+				)
+			);
+		}
 
-        $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
-        //unfortunately this can't be hooked in upon construction, because we don't have
-        //the plugin mainfile's path upon construction.
-        register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
-        // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[ $addon_name ]['admin_callback'])
-            );
-        }
-        return $addon;
-    }
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
+		$addon->set_version(self::$_settings[ $addon_name ]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
+		$addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
+		$addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
+		$addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+		//unfortunately this can't be hooked in upon construction, because we don't have
+		//the plugin mainfile's path upon construction.
+		register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
+		// call any additional admin_callback functions during load_admin_controller hook
+		if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				array($addon, self::$_settings[ $addon_name ]['admin_callback'])
+			);
+		}
+		return $addon;
+	}
 
 
-    /**
-     *    load_pue_update - Update notifications
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function load_pue_update()
-    {
-        // load PUE client
-        require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
-        // cycle thru settings
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
-                // initiate the class and start the plugin update engine!
-                new PluginUpdateEngineChecker(
-                // host file URL
-                    'https://eventespresso.com',
-                    // plugin slug(s)
-                    array(
-                        'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
-                    ),
-                    // options
-                    array(
-                        'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
-                        'lang_domain'       => 'event_espresso',
-                        'checkPeriod'       => $settings['pue_options']['checkPeriod'],
-                        'option_key'        => 'site_license_key',
-                        'options_page_slug' => 'event_espresso',
-                        'plugin_basename'   => $settings['pue_options']['plugin_basename'],
-                        // if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
-                        'use_wp_update'     => $settings['pue_options']['use_wp_update'],
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 *    load_pue_update - Update notifications
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function load_pue_update()
+	{
+		// load PUE client
+		require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+		// cycle thru settings
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['pue_options'])) {
+				// initiate the class and start the plugin update engine!
+				new PluginUpdateEngineChecker(
+				// host file URL
+					'https://eventespresso.com',
+					// plugin slug(s)
+					array(
+						'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
+						'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+					),
+					// options
+					array(
+						'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
+						'lang_domain'       => 'event_espresso',
+						'checkPeriod'       => $settings['pue_options']['checkPeriod'],
+						'option_key'        => 'site_license_key',
+						'options_page_slug' => 'event_espresso',
+						'plugin_basename'   => $settings['pue_options']['plugin_basename'],
+						// if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
+						'use_wp_update'     => $settings['pue_options']['use_wp_update'],
+					)
+				);
+			}
+		}
+	}
 
 
-    /**
-     * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
-     *
-     * @since 4.4.0
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_message_types()
-    {
-        foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
-                foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::register($message_type, $message_type_settings);
-                }
-            }
-        }
-    }
+	/**
+	 * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_message_types()
+	{
+		foreach (self::$_settings as $addon_name => $settings) {
+			if (! empty($settings['message_types'])) {
+				foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::register($message_type, $message_type_settings);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters an addon that was previously registered with a specific addon_name.
-     *
-     * @since    4.3.0
-     * @param string $addon_name the name for the addon that was previously registered
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function deregister($addon_name = null)
-    {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
-            try {
-                do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-                $class_name = self::$_settings[$addon_name]['class_name'];
-                if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
-                    // setup DMS
-                    EE_Register_Data_Migration_Scripts::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[$addon_name]['admin_path'])) {
-                    // register admin page
-                    EE_Register_Admin_Page::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[$addon_name]['module_paths'])) {
-                    // add to list of modules to be registered
-                    EE_Register_Module::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[$addon_name]['shortcode_paths'])
-                    || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Shortcode::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[$addon_name]['config_class'])) {
-                    // if config_class present let's register config.
-                    EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
-                }
-                if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
-                    // add to list of widgets to be registered
-                    EE_Register_Widget::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[$addon_name]['model_paths'])
-                    || ! empty(self::$_settings[$addon_name]['class_paths'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Model::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[$addon_name]['model_extension_paths'])
-                    || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Model_Extensions::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[$addon_name]['message_types'])) {
-                    foreach (
-                        (array)self::$_settings[$addon_name]['message_types'] as $message_type =>
-                        $message_type_settings
-                    ) {
-                        EE_Register_Message_Type::deregister($message_type);
-                    }
-                }
-                //deregister capabilities for addon
-                if (
-                    ! empty(self::$_settings[$addon_name]['capabilities'])
-                    || ! empty(self::$_settings[$addon_name]['capability_maps'])
-                ) {
-                    EE_Register_Capabilities::deregister($addon_name);
-                }
-                //deregister custom_post_types for addon
-                if (! empty(self::$_settings[$addon_name]['custom_post_types'])) {
-                    EE_Register_CPT::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
-                    EE_Register_Payment_Method::deregister($addon_name);
-                }
-                $addon = EE_Registry::instance()->getAddon($class_name);
-                if ($addon instanceof EE_Addon) {
-                    remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
-                        array($addon, 'deactivation')
-                    );
-                    remove_action(
-                        'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-                        array($addon, 'initialize_db_if_no_migrations_required')
-                    );
-                    //remove `after_registration` call
-                    remove_action(
-                        'AHEE__EE_System__load_espresso_addons__complete',
-                        array($addon, 'after_registration'),
-                        999
-                    );
-                }
-                EE_Registry::instance()->removeAddon($class_name);
-            } catch (OutOfBoundsException $addon_not_yet_registered_exception) {
-                //the add-on was not yet registered in the registry, so RegistryContainer::__get() throws this exception.
-                //also no need to worry about this or log it, it's ok to deregister an add-on before its registered in the registry
-            } catch (Exception $e) {
-                new ExceptionLogger($e);
-             }
-            unset(self::$_settings[ $addon_name ]);
-            do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
-        }
-    }
+	/**
+	 * This deregisters an addon that was previously registered with a specific addon_name.
+	 *
+	 * @since    4.3.0
+	 * @param string $addon_name the name for the addon that was previously registered
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function deregister($addon_name = null)
+	{
+		if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+			try {
+				do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
+				$class_name = self::$_settings[$addon_name]['class_name'];
+				if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
+					// setup DMS
+					EE_Register_Data_Migration_Scripts::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[$addon_name]['admin_path'])) {
+					// register admin page
+					EE_Register_Admin_Page::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[$addon_name]['module_paths'])) {
+					// add to list of modules to be registered
+					EE_Register_Module::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[$addon_name]['shortcode_paths'])
+					|| ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Shortcode::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[$addon_name]['config_class'])) {
+					// if config_class present let's register config.
+					EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
+				}
+				if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
+					// add to list of widgets to be registered
+					EE_Register_Widget::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[$addon_name]['model_paths'])
+					|| ! empty(self::$_settings[$addon_name]['class_paths'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Model::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[$addon_name]['model_extension_paths'])
+					|| ! empty(self::$_settings[$addon_name]['class_extension_paths'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Model_Extensions::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[$addon_name]['message_types'])) {
+					foreach (
+						(array)self::$_settings[$addon_name]['message_types'] as $message_type =>
+						$message_type_settings
+					) {
+						EE_Register_Message_Type::deregister($message_type);
+					}
+				}
+				//deregister capabilities for addon
+				if (
+					! empty(self::$_settings[$addon_name]['capabilities'])
+					|| ! empty(self::$_settings[$addon_name]['capability_maps'])
+				) {
+					EE_Register_Capabilities::deregister($addon_name);
+				}
+				//deregister custom_post_types for addon
+				if (! empty(self::$_settings[$addon_name]['custom_post_types'])) {
+					EE_Register_CPT::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+					EE_Register_Payment_Method::deregister($addon_name);
+				}
+				$addon = EE_Registry::instance()->getAddon($class_name);
+				if ($addon instanceof EE_Addon) {
+					remove_action(
+						'deactivate_' . $addon->get_main_plugin_file_basename(),
+						array($addon, 'deactivation')
+					);
+					remove_action(
+						'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+						array($addon, 'initialize_db_if_no_migrations_required')
+					);
+					//remove `after_registration` call
+					remove_action(
+						'AHEE__EE_System__load_espresso_addons__complete',
+						array($addon, 'after_registration'),
+						999
+					);
+				}
+				EE_Registry::instance()->removeAddon($class_name);
+			} catch (OutOfBoundsException $addon_not_yet_registered_exception) {
+				//the add-on was not yet registered in the registry, so RegistryContainer::__get() throws this exception.
+				//also no need to worry about this or log it, it's ok to deregister an add-on before its registered in the registry
+			} catch (Exception $e) {
+				new ExceptionLogger($e);
+			 }
+			unset(self::$_settings[ $addon_name ]);
+			do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
+		}
+	}
 
 
 }

Spacing +101 added lines, -101 removed lines

@@ -72,15 +72,15 @@ 
         // offsets:    0 . 1 . 2 . 3 . 4
         $version_parts = explode('.', $min_core_version);
         //check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
+        if ( ! isset($version_parts[2])) {
             $version_parts[2] = '0';
         }
         //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
         //soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
+        if ( ! isset($version_parts[3])) {
             $version_parts[3] = 'dev';
         }
-        if (! isset($version_parts[4])) {
+        if ( ! isset($version_parts[4])) {
             $version_parts[4] = '000';
         }
         return implode('.', $version_parts);
@@ -251,7 +251,7 @@ 
         // setup PUE
         EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
         // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+        if ( ! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return;
         }
         // register namespaces
@@ -309,7 +309,7 @@ 
                 )
             );
         }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+        if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -321,7 +321,7 @@ 
             );
         }
         // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -353,7 +353,7 @@ 
         // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
         return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
             ? $class_name
-            : 'EE_' . $class_name;
+            : 'EE_'.$class_name;
     }
 
 
@@ -512,9 +512,9 @@ 
         $incompatibility_message = '';
         //check whether this addon version is compatible with EE core
         if (
-            isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+            isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
             && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 $addon_settings['version']
             )
         ) {
@@ -524,7 +524,7 @@ 
                 ),
                 $addon_name,
                 '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 '<span style="font-weight: bold; color: #D54E21;">',
                 '</span><br />'
             );
@@ -556,7 +556,7 @@ 
                 '</span><br />'
             );
         }
-        if (! empty($incompatibility_message)) {
+        if ( ! empty($incompatibility_message)) {
             // remove 'activate' from the REQUEST
             // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
             unset($_GET['activate'], $_REQUEST['activate']);
@@ -584,11 +584,11 @@ 
      */
     private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
     {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[ $addon_name ]['pue_options'] = array(
+        if ( ! empty($setup_args['pue_options'])) {
+            self::$_settings[$addon_name]['pue_options'] = array(
                 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
                     ? (string) $setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
+                    : 'espresso_'.strtolower($class_name),
                 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
                     ? (string) $setup_args['pue_options']['plugin_basename']
                     : plugin_basename($setup_args['main_file_path']),
@@ -648,12 +648,12 @@ 
             //(as the newly-activated addon wasn't around the first time addons were registered).
             //Note: the presence of pue_options in the addon registration options will initialize the $_settings
             //property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
+            if ( ! isset(self::$_settings[$addon_name])
+                || (isset(self::$_settings[$addon_name])
+                    && ! isset(self::$_settings[$addon_name]['class_name'])
                 )
             ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
+                self::$_settings[$addon_name] = $addon_settings;
                 $addon                          = self::_load_and_init_addon_class($addon_name);
                 $addon->set_activation_indicator_option();
                 // dont bother setting up the rest of the addon.
@@ -679,10 +679,10 @@ 
             );
         }
         // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
+        if (isset(self::$_settings[$addon_name])) {
+            self::$_settings[$addon_name] += $addon_settings;
         } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
+            self::$_settings[$addon_name] = $addon_settings;
         }
         return false;
     }
@@ -695,13 +695,13 @@ 
      */
     private static function _setup_autoloaders($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
             // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
         }
         // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+            foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
             }
         }
@@ -719,27 +719,27 @@ 
     {
         // register new models
         if (
-            ! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+            ! empty(self::$_settings[$addon_name]['model_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_paths'])
         ) {
             EE_Register_Model::register(
                 $addon_name,
                 array(
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
+                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
                 )
             );
         }
         // register model extensions
         if (
-            ! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+            ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
         ) {
             EE_Register_Model_Extensions::register(
                 $addon_name,
                 array(
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
                 )
             );
         }
@@ -754,10 +754,10 @@ 
     private static function _register_data_migration_scripts($addon_name)
     {
         // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
             EE_Register_Data_Migration_Scripts::register(
                 $addon_name,
-                array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
+                array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
             );
         }
     }
@@ -771,12 +771,12 @@ 
     private static function _register_config($addon_name)
     {
         // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+        if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
             EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
+                self::$_settings[$addon_name]['config_class'],
                 array(
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+                    'config_section' => self::$_settings[$addon_name]['config_section'],
+                    'config_name'    => self::$_settings[$addon_name]['config_name'],
                 )
             );
         }
@@ -790,10 +790,10 @@ 
      */
     private static function _register_admin_pages($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
             EE_Register_Admin_Page::register(
                 $addon_name,
-                array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
+                array('page_path' => self::$_settings[$addon_name]['admin_path'])
             );
         }
     }
@@ -806,10 +806,10 @@ 
      */
     private static function _register_modules($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
             EE_Register_Module::register(
                 $addon_name,
-                array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
+                array('module_paths' => self::$_settings[$addon_name]['module_paths'])
             );
         }
     }
@@ -822,17 +822,17 @@ 
      */
     private static function _register_shortcodes($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+        if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+            || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
         ) {
             EE_Register_Shortcode::register(
                 $addon_name,
                 array(
-                    'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
-                        ? self::$_settings[ $addon_name ]['shortcode_paths']
+                    'shortcode_paths' => isset(self::$_settings[$addon_name]['shortcode_paths'])
+                        ? self::$_settings[$addon_name]['shortcode_paths']
                         : array(),
-                    'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                        ? self::$_settings[ $addon_name ]['shortcode_fqcns']
+                    'shortcode_fqcns' => isset(self::$_settings[$addon_name]['shortcode_fqcns'])
+                        ? self::$_settings[$addon_name]['shortcode_fqcns']
                         : array(),
                 )
             );
@@ -847,10 +847,10 @@ 
      */
     private static function _register_widgets($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
             EE_Register_Widget::register(
                 $addon_name,
-                array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
+                array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
             );
         }
     }
@@ -863,12 +863,12 @@ 
      */
     private static function _register_capabilities($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+        if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
             EE_Register_Capabilities::register(
                 $addon_name,
                 array(
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+                    'capabilities'    => self::$_settings[$addon_name]['capabilities'],
+                    'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
                 )
             );
         }
@@ -882,7 +882,7 @@ 
      */
     private static function _register_message_types($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+        if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
             add_action(
                 'EE_Brewing_Regular___messages_caf',
                 array('EE_Register_Addon', 'register_message_types')
@@ -899,15 +899,15 @@ 
     private static function _register_custom_post_types($addon_name)
     {
         if (
-            ! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+            ! empty(self::$_settings[$addon_name]['custom_post_types'])
+            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
         ) {
             EE_Register_CPT::register(
                 $addon_name,
                 array(
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
                 )
             );
         }
@@ -925,10 +925,10 @@ 
      */
     private static function _register_payment_methods($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
             EE_Register_Payment_Method::register(
                 $addon_name,
-                array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
+                array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
             );
         }
     }
@@ -949,49 +949,49 @@ 
     {
         $loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
         $addon = $loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
+            self::$_settings[$addon_name]['class_name'],
             array('EE_Registry::create(addon)' => true)
         );
         // setter inject dep map if required
-        if($addon instanceof RequiresDependencyMapInterface && $addon->dependencyMap() === null){
+        if ($addon instanceof RequiresDependencyMapInterface && $addon->dependencyMap() === null) {
             $addon->setDependencyMap($loader->getShared('EE_Dependency_Map'));
         }
         // setter inject domain if required
-        if(
+        if (
             $addon instanceof RequiresDomainInterface
-            && self::$_settings[ $addon_name ]['domain_fqcn'] !== ''
+            && self::$_settings[$addon_name]['domain_fqcn'] !== ''
             && $addon->domain() === null
-        ){
+        ) {
             $addon->setDomain(
                 $loader->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
+                    self::$_settings[$addon_name]['domain_fqcn'],
                     array(
-                        self::$_settings[ $addon_name ]['main_file_path'],
-                        self::$_settings[ $addon_name ]['version']
+                        self::$_settings[$addon_name]['main_file_path'],
+                        self::$_settings[$addon_name]['version']
                     )
                 )
             );
         }
 
         $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+        $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+        $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+        $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+        $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+        $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+        $addon->set_version(self::$_settings[$addon_name]['version']);
+        $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+        $addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+        $addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+        $addon->set_config_name(self::$_settings[$addon_name]['config_name']);
         //unfortunately this can't be hooked in upon construction, because we don't have
         //the plugin mainfile's path upon construction.
         register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
         // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
                 'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[ $addon_name ]['admin_callback'])
+                array($addon, self::$_settings[$addon_name]['admin_callback'])
             );
         }
         return $addon;
@@ -1009,10 +1009,10 @@ 
     public static function load_pue_update()
     {
         // load PUE client
-        require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+        require_once EE_THIRD_PARTY.'pue'.DS.'pue-client.php';
         // cycle thru settings
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
+            if ( ! empty($settings['pue_options'])) {
                 // initiate the class and start the plugin update engine!
                 new PluginUpdateEngineChecker(
                 // host file URL
@@ -1020,7 +1020,7 @@ 
                     // plugin slug(s)
                     array(
                         'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'),
                     ),
                     // options
                     array(
@@ -1049,7 +1049,7 @@ 
     public static function register_message_types()
     {
         foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
+            if ( ! empty($settings['message_types'])) {
                 foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::register($message_type, $message_type_settings);
                 }
@@ -1071,51 +1071,51 @@ 
      */
     public static function deregister($addon_name = null)
     {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+        if (isset(self::$_settings[$addon_name]['class_name'])) {
             try {
                 do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
                 $class_name = self::$_settings[$addon_name]['class_name'];
-                if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
                     // setup DMS
                     EE_Register_Data_Migration_Scripts::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[$addon_name]['admin_path'])) {
+                if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
                     // register admin page
                     EE_Register_Admin_Page::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[$addon_name]['module_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
                     // add to list of modules to be registered
                     EE_Register_Module::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[$addon_name]['shortcode_paths'])
+                if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])
                     || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Shortcode::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[$addon_name]['config_class'])) {
+                if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
                     // if config_class present let's register config.
                     EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
                 }
-                if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
                     // add to list of widgets to be registered
                     EE_Register_Widget::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[$addon_name]['model_paths'])
+                if ( ! empty(self::$_settings[$addon_name]['model_paths'])
                     || ! empty(self::$_settings[$addon_name]['class_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[$addon_name]['model_extension_paths'])
+                if ( ! empty(self::$_settings[$addon_name]['model_extension_paths'])
                     || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model_Extensions::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[$addon_name]['message_types'])) {
+                if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
                     foreach (
-                        (array)self::$_settings[$addon_name]['message_types'] as $message_type =>
+                        (array) self::$_settings[$addon_name]['message_types'] as $message_type =>
                         $message_type_settings
                     ) {
                         EE_Register_Message_Type::deregister($message_type);
@@ -1129,16 +1129,16 @@ 
                     EE_Register_Capabilities::deregister($addon_name);
                 }
                 //deregister custom_post_types for addon
-                if (! empty(self::$_settings[$addon_name]['custom_post_types'])) {
+                if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
                     EE_Register_CPT::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
                     EE_Register_Payment_Method::deregister($addon_name);
                 }
                 $addon = EE_Registry::instance()->getAddon($class_name);
                 if ($addon instanceof EE_Addon) {
                     remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
+                        'deactivate_'.$addon->get_main_plugin_file_basename(),
                         array($addon, 'deactivation')
                     );
                     remove_action(
@@ -1159,7 +1159,7 @@ 
             } catch (Exception $e) {
                 new ExceptionLogger($e);
              }
-            unset(self::$_settings[ $addon_name ]);
+            unset(self::$_settings[$addon_name]);
             do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
         }
     }

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1859 added lines, -1859 removed lines

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

core/helpers/EEH_Venue_View.helper.php

Spacing +114 added lines, -114 removed lines

@@ -45,25 +45,25 @@ 
 	 * @param bool $password_check
 	 * @return \EE_Venue|null
 	 */
-	public static function get_venue( $VNU_ID = 0, $look_in_event = TRUE, $privacy_check = true, $password_check = true ) {
-		$VNU_ID = absint( $VNU_ID );
+	public static function get_venue($VNU_ID = 0, $look_in_event = TRUE, $privacy_check = true, $password_check = true) {
+		$VNU_ID = absint($VNU_ID);
 		// do we already have the Venue you are looking for?
-		if ( EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID ) {
+		if (EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
 			//If the Venue ID matches $VNU_ID, return the venue.
-			if( EEH_Venue_View::$_venue->ID() === $VNU_ID ) {
-				return EEH_Venue_View::_get_venue( $privacy_check );
+			if (EEH_Venue_View::$_venue->ID() === $VNU_ID) {
+				return EEH_Venue_View::_get_venue($privacy_check);
 			}
 			//If the Venue ID does not match, try pulling a venue using $VNU_ID.
-			$venue = EEM_Venue::instance()->get_one_by_ID( $VNU_ID );
-			if( $venue instanceof EE_Venue ) {
+			$venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+			if ($venue instanceof EE_Venue) {
 				EEH_Venue_View::$_venue = $venue;
-				return EEH_Venue_View::_get_venue( $privacy_check );
+				return EEH_Venue_View::_get_venue($privacy_check);
 			}
 		}
 		// international newspaper?
 		global $post;
-		if ( $post instanceof WP_Post ) {
-			switch ( $post->post_type ) {
+		if ($post instanceof WP_Post) {
+			switch ($post->post_type) {
 				// if this is being called from an EE_Venue post,
 				// and the EE_Venue post corresponds to the EE_Venue that is being asked for,
 				// then we can try to just grab the attached EE_Venue object
@@ -71,31 +71,31 @@ 
 					// the post already contains the related EE_Venue object AND one of the following is TRUE:
 					// the requested Venue ID matches the post ID OR...
 					// there was no specific Venue ID requested
-					if ( isset( $post->EE_Venue ) && ( $VNU_ID == $post->ID || ! $VNU_ID )) {
+					if (isset($post->EE_Venue) && ($VNU_ID == $post->ID || ! $VNU_ID)) {
 						// use existing related EE_Venue object
-						EEH_Venue_View::$_venue =  $post->EE_Venue;
-					} else if ( $VNU_ID ) {
+						EEH_Venue_View::$_venue = $post->EE_Venue;
+					} else if ($VNU_ID) {
 						// there WAS a specific Venue ID requested, but it's NOT the current post object
-						EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID( $VNU_ID );
+						EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
 					} else {
 						// no specific Venue ID requested, so use post ID to generate EE_Venue object
-						EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID( $post->ID );
+						EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($post->ID);
 					}
 				break;
 
 				case 'espresso_events':
-					if ( $look_in_event ) {
+					if ($look_in_event) {
 						// grab the events related venues
 						$venues = EEH_Venue_View::get_event_venues();
 						// make sure the result is an array
-						$venues = is_array( $venues ) ? $venues : array();
+						$venues = is_array($venues) ? $venues : array();
 						// do we have an ID for a specific venue?
-						if ( $VNU_ID ) {
+						if ($VNU_ID) {
 							// loop thru the related venues
-							foreach( $venues as $venue ) {
-								if ( $venue instanceof EE_Venue ) {
+							foreach ($venues as $venue) {
+								if ($venue instanceof EE_Venue) {
 									// until we find the venue we're looking for
-									if ( $venue->ID() == $VNU_ID ) {
+									if ($venue->ID() == $VNU_ID) {
 										EEH_Venue_View::$_venue = $venue;
 										break;
 									}
@@ -105,7 +105,7 @@ 
 						// then the global post is an events post and this function was called with no argument
 						} else {
 							// just grab the first related event venue
-							EEH_Venue_View::$_venue = reset( $venues );
+							EEH_Venue_View::$_venue = reset($venues);
 						}
 					}
 				break;
@@ -113,11 +113,11 @@ 
 			}
 		}
 		// now if we STILL do NOT have an EE_Venue model object, BUT we have a Venue ID...
-		if ( ! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID ) {
+		if ( ! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
 			// sigh... pull it from the db
-			EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID( $VNU_ID );
+			EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
 		}
-		return EEH_Venue_View::_get_venue( $privacy_check, $password_check );
+		return EEH_Venue_View::_get_venue($privacy_check, $password_check);
 	}
 
 
@@ -130,13 +130,13 @@ 
 	 * @param bool $password_check
 	 * @return 	EE_Venue
 	 */
-	protected static function _get_venue( $privacy_check = true, $password_check = true ) {
+	protected static function _get_venue($privacy_check = true, $password_check = true) {
 		// check for private venues.
 		if (
 			EEH_Venue_View::$_venue instanceof EE_Venue
 			&& EEH_Venue_View::$_venue->status() == 'private'
 			&& $privacy_check
-			&& ! EE_Registry::instance()->CAP->current_user_can( 'ee_read_private_venues', 'get_venues' )
+			&& ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')
 		) {
 			return null;
 		}
@@ -144,7 +144,7 @@ 
 		if (
 			EEH_Venue_View::$_venue instanceof EE_Venue
 			&& $password_check
-			&& post_password_required( EEH_Venue_View::$_venue->ID() )
+			&& post_password_required(EEH_Venue_View::$_venue->ID())
 		) {
 			return null;
 		}
@@ -161,8 +161,8 @@ 
 	 */
 	public static function get_event_venues() {
 		global $post;
-		if ( $post->post_type == 'espresso_events' ) {
-			if ( isset( $post->EE_Event ) && $post->EE_Event instanceof EE_Event ) {
+		if ($post->post_type == 'espresso_events') {
+			if (isset($post->EE_Event) && $post->EE_Event instanceof EE_Event) {
 				return $post->EE_Event->venues();
 			}
 		}
@@ -182,9 +182,9 @@ 
 	 *
 	 * @return bool|null
 	 */
-	public static function is_venue_private( $VNU_ID = false ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID, true, true );
-		if ( ! $venue instanceof EE_Venue ) {
+	public static function is_venue_private($VNU_ID = false) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID, true, true);
+		if ( ! $venue instanceof EE_Venue) {
 			return null;
 		}
 
@@ -199,11 +199,11 @@ 
 	 * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
 	 * @return bool
 	 */
-	public static function is_venue_password_protected( $VNU_ID = false ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID, true, true, false );
+	public static function is_venue_password_protected($VNU_ID = false) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
 		if (
 			$venue instanceof EE_Venue
-			&& post_password_required( $venue->ID() )
+			&& post_password_required($venue->ID())
 		) {
 			return true;
 		}
@@ -220,13 +220,13 @@ 
 	 *
 	 * @return string
 	 */
-	public static function password_protected_venue_form( $VNU_ID = false ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID, true, true, false );
+	public static function password_protected_venue_form($VNU_ID = false) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
 		if (
 			$venue instanceof EE_Venue
-			&& post_password_required( $venue->ID() )
+			&& post_password_required($venue->ID())
 		) {
-			return get_the_password_form( $venue->ID() );
+			return get_the_password_form($venue->ID());
 		}
 		return '';
 	}
@@ -240,9 +240,9 @@ 
 	 * @param int $VNU_ID
 	 * @return string
 	 */
-	public static function venue_description( $VNU_ID = 0 ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
+	public static function venue_description($VNU_ID = 0) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
 			return$venue->description();
 		}
 		return '';
@@ -257,12 +257,12 @@ 
 	 * @param int $VNU_ID
 	 * @return string
 	 */
-	public static function venue_excerpt( $VNU_ID = 0 ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
+	public static function venue_excerpt($VNU_ID = 0) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
 			$excerpt = $venue->excerpt() != NULL && $venue->excerpt() ? $venue->excerpt() : $venue->description();
-			$venue_link = ' ' . EEH_Venue_View::venue_details_link( $venue->ID(), __( 'more', 'event_espresso' ) . '…' );
-			return ! empty( $excerpt ) ? wp_trim_words( $excerpt, 25, '' ) . $venue_link : '';
+			$venue_link = ' '.EEH_Venue_View::venue_details_link($venue->ID(), __('more', 'event_espresso').'…');
+			return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '').$venue_link : '';
 		}
 		return '';
 	}
@@ -277,22 +277,22 @@ 
 	 * @param bool $hide_uncategorized
 	 * @return string
 	 */
-	public static function venue_categories( $VNU_ID = 0, $hide_uncategorized = TRUE ) {
+	public static function venue_categories($VNU_ID = 0, $hide_uncategorized = TRUE) {
 		$category_links = array();
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
 			// get category terms
-			if ( $venue_categories = get_the_terms( $venue->ID(), 'espresso_venue_categories' )) {
+			if ($venue_categories = get_the_terms($venue->ID(), 'espresso_venue_categories')) {
 				// loop thru terms and create links
-				foreach ( $venue_categories as $term ) {
-					$url = get_term_link( $term, 'espresso_venue_categories' );
-					if ( ! is_wp_error( $url ) && (( $hide_uncategorized && strtolower( $term->name ) != __( 'uncategorized', 'event_espresso' )) || ! $hide_uncategorized )) {
-						$category_links[] = '<a href="' . esc_url( $url ) . '" rel="tag">' . $term->name . '</a> ';
+				foreach ($venue_categories as $term) {
+					$url = get_term_link($term, 'espresso_venue_categories');
+					if ( ! is_wp_error($url) && (($hide_uncategorized && strtolower($term->name) != __('uncategorized', 'event_espresso')) || ! $hide_uncategorized)) {
+						$category_links[] = '<a href="'.esc_url($url).'" rel="tag">'.$term->name.'</a> ';
 					}
 				}
 			}
 		}
-		return implode( ', ', $category_links );
+		return implode(', ', $category_links);
 	}
 
 
@@ -307,10 +307,10 @@ 
 	 * @param bool $add_wrapper
 	 * @return string
 	 */
-	public static function venue_address( $type = 'multiline', $VNU_ID = 0, $use_schema = true, $add_wrapper = true ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
-			return EEH_Address::format( $venue, $type, $use_schema, $add_wrapper );
+	public static function venue_address($type = 'multiline', $VNU_ID = 0, $use_schema = true, $add_wrapper = true) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Address::format($venue, $type, $use_schema, $add_wrapper);
 		}
 		return '';
 	}
@@ -324,10 +324,10 @@ 
 	 * @param int $VNU_ID
 	 * @return bool|string
 	 */
-	public static function venue_has_address( $VNU_ID = 0 ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
-			return EEH_Address::format( $venue, 'inline', FALSE, FALSE );
+	public static function venue_has_address($VNU_ID = 0) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Address::format($venue, 'inline', FALSE, FALSE);
 		}
 		return false;
 	}
@@ -342,30 +342,30 @@ 
 	 * @param int $VNU_ID
 	 * @return string
 	 */
-	public static function venue_name( $link_to = 'details', $VNU_ID = 0 ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
+	public static function venue_name($link_to = 'details', $VNU_ID = 0) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
 			$venue_name = apply_filters(
 				'FHEE__EEH_Venue__venue_name__append_private_venue_name',
 				EEH_Venue_View::is_venue_private()
-					? EEH_Venue_View::$_venue->name() . "&nbsp;" . __( '(Private)', 'event_espresso' )
+					? EEH_Venue_View::$_venue->name()."&nbsp;".__('(Private)', 'event_espresso')
 					: EEH_Venue_View::$_venue->name(),
 				EEH_Venue_View::$_venue
 			);
-			$venue_name = EEH_Schema::name( $venue_name );
+			$venue_name = EEH_Schema::name($venue_name);
 
 			//if venue is trashed then ignore the "link to" setting because the venue is trashed.
-			if ( $venue->get('status') == 'trash' ) {
+			if ($venue->get('status') == 'trash') {
 				$link_to = '';
 			}
-			switch( $link_to ) {
+			switch ($link_to) {
 
 				case 'details' :
-					return EEH_Venue_View::venue_details_link( $venue->ID(), $venue_name );
+					return EEH_Venue_View::venue_details_link($venue->ID(), $venue_name);
 				break;
 
 				case 'website' :
-					return EEH_Venue_View::venue_website_link( $venue->ID(), $venue_name );
+					return EEH_Venue_View::venue_website_link($venue->ID(), $venue_name);
 				break;
 
 				default :
@@ -385,10 +385,10 @@ 
 	 * @param    string $text
 	 * @return string
 	 */
-	public static function venue_details_link( $VNU_ID = 0, $text = '' ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
-			return EEH_Schema::url( get_permalink( $venue->ID() ), $text );
+	public static function venue_details_link($VNU_ID = 0, $text = '') {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Schema::url(get_permalink($venue->ID()), $text);
 		}
 		return '';
 	}
@@ -403,12 +403,12 @@ 
 	 * @param    string $text
 	 * @return string
 	 */
-	public static function venue_website_link( $VNU_ID = 0, $text = '' ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
+	public static function venue_website_link($VNU_ID = 0, $text = '') {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
 			$url = $venue->venue_url();
-			$text = ! empty( $text ) ? $text : $url;
-			return ! empty( $url ) ? EEH_Schema::url( $url, $text ) : '';
+			$text = ! empty($text) ? $text : $url;
+			return ! empty($url) ? EEH_Schema::url($url, $text) : '';
 		}
 		return '';
 	}
@@ -422,10 +422,10 @@ 
 	 * @param int $VNU_ID
 	 * @return string
 	 */
-	public static function venue_phone( $VNU_ID = 0) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
-			return EEH_Schema::telephone( $venue->phone() );
+	public static function venue_phone($VNU_ID = 0) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Schema::telephone($venue->phone());
 		}
 		return '';
 	}
@@ -441,48 +441,48 @@ 
 	 * @param    array $gmap map options
 	 * @return string
 	 */
-	public static function venue_gmap( $VNU_ID = 0, $map_ID = FALSE, $gmap = array() ) {
+	public static function venue_gmap($VNU_ID = 0, $map_ID = FALSE, $gmap = array()) {
 
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
 			// check for global espresso_events post and use it's ID if no map_ID is set
 			global $post;
-			$map_ID = empty( $map_ID ) && $post->post_type == 'espresso_events' ? $post->ID : $map_ID;
+			$map_ID = empty($map_ID) && $post->post_type == 'espresso_events' ? $post->ID : $map_ID;
 			// grab map settings
 			$map_cfg = EE_Registry::instance()->CFG->map_settings;
 			// are maps enabled ?
-			if ( $map_cfg->use_google_maps && $venue->enable_for_gmap() ) {
+			if ($map_cfg->use_google_maps && $venue->enable_for_gmap()) {
 
 				$details_page = is_single();
 				$options = array();
-				$options['map_ID'] = $map_ID && $map_ID != $venue->ID() ? $map_ID . '-' . $venue->ID()/* . '-' . $static_map_id*/ : $venue->ID()/* . '-' . $static_map_id*/;
+				$options['map_ID'] = $map_ID && $map_ID != $venue->ID() ? $map_ID.'-'.$venue->ID()/* . '-' . $static_map_id*/ : $venue->ID()/* . '-' . $static_map_id*/;
 
-				$options['location'] = EEH_Address::format( $venue, 'inline', FALSE, FALSE );
+				$options['location'] = EEH_Address::format($venue, 'inline', FALSE, FALSE);
 
 				$options['ee_map_width'] = $details_page ? $map_cfg->event_details_map_width : $map_cfg->event_list_map_width;
-				$options['ee_map_width'] = isset( $gmap['ee_map_width'] ) && ! empty( $gmap['ee_map_width'] ) ? $gmap['ee_map_width'] : $options['ee_map_width'];
+				$options['ee_map_width'] = isset($gmap['ee_map_width']) && ! empty($gmap['ee_map_width']) ? $gmap['ee_map_width'] : $options['ee_map_width'];
 
 				$options['ee_map_height'] = $details_page ? $map_cfg->event_details_map_height : $map_cfg->event_list_map_height;
-				$options['ee_map_height'] = isset( $gmap['ee_map_height'] ) && ! empty( $gmap['ee_map_height'] ) ? $gmap['ee_map_height'] : $options['ee_map_height'];
+				$options['ee_map_height'] = isset($gmap['ee_map_height']) && ! empty($gmap['ee_map_height']) ? $gmap['ee_map_height'] : $options['ee_map_height'];
 
 				$options['ee_map_zoom'] = $details_page ? $map_cfg->event_details_map_zoom : $map_cfg->event_list_map_zoom;
-				$options['ee_map_zoom'] = isset( $gmap['ee_map_zoom'] ) && ! empty( $gmap['ee_map_zoom'] ) ? $gmap['ee_map_zoom'] : $options['ee_map_zoom'];
+				$options['ee_map_zoom'] = isset($gmap['ee_map_zoom']) && ! empty($gmap['ee_map_zoom']) ? $gmap['ee_map_zoom'] : $options['ee_map_zoom'];
 
 				$options['ee_map_nav_display'] = $details_page ? $map_cfg->event_details_display_nav : $map_cfg->event_list_display_nav;
-				$options['ee_map_nav_display'] = isset( $gmap['ee_map_nav_display'] ) && ! empty( $gmap['ee_map_nav_display'] ) ? 'true' : $options['ee_map_nav_display'];;
+				$options['ee_map_nav_display'] = isset($gmap['ee_map_nav_display']) && ! empty($gmap['ee_map_nav_display']) ? 'true' : $options['ee_map_nav_display']; ;
 
 				$options['ee_map_nav_size'] = $details_page ? $map_cfg->event_details_nav_size : $map_cfg->event_list_nav_size;
-				$options['ee_map_nav_size'] =  isset( $gmap['ee_map_nav_size'] ) && ! empty( $gmap['ee_map_nav_size'] )? $gmap['ee_map_nav_size'] : $options['ee_map_nav_size'];
+				$options['ee_map_nav_size'] = isset($gmap['ee_map_nav_size']) && ! empty($gmap['ee_map_nav_size']) ? $gmap['ee_map_nav_size'] : $options['ee_map_nav_size'];
 
 				$options['ee_map_type_control'] = $details_page ? $map_cfg->event_details_control_type : $map_cfg->event_list_control_type;
-				$options['ee_map_type_control'] =  isset( $gmap['ee_map_type_control'] ) && ! empty( $gmap['ee_map_type_control'] )? $gmap['ee_map_type_control'] : $options['ee_map_type_control'];
+				$options['ee_map_type_control'] = isset($gmap['ee_map_type_control']) && ! empty($gmap['ee_map_type_control']) ? $gmap['ee_map_type_control'] : $options['ee_map_type_control'];
 
 				$options['ee_map_align'] = $details_page ? $map_cfg->event_details_map_align : $map_cfg->event_list_map_align;
-				$options['ee_map_align'] =  isset( $gmap['ee_map_align'] ) && ! empty( $gmap['ee_map_align'] )? $gmap['ee_map_align'] : $options['ee_map_align'];
+				$options['ee_map_align'] = isset($gmap['ee_map_align']) && ! empty($gmap['ee_map_align']) ? $gmap['ee_map_align'] : $options['ee_map_align'];
 
-				$options['ee_static_url'] =  isset( $gmap['ee_static_url'] ) && ! empty( $gmap['ee_static_url'] ) ? (bool)absint( $gmap['ee_static_url'] ) : $venue->google_map_link();
+				$options['ee_static_url'] = isset($gmap['ee_static_url']) && ! empty($gmap['ee_static_url']) ? (bool) absint($gmap['ee_static_url']) : $venue->google_map_link();
 
-				return EEH_Maps::google_map( $options );
+				return EEH_Maps::google_map($options);
 
 			}
 		}
@@ -497,7 +497,7 @@ 
 	 * @param array $atts like EEH_Maps::google_map_link
 	 * @return string
 	 */
-	public static function espresso_google_static_map( EE_Venue $venue, $atts = array() ){
+	public static function espresso_google_static_map(EE_Venue $venue, $atts = array()) {
 		$state = $venue->state_obj();
 		$country = $venue->country_obj();
 		$atts = shortcode_atts(
@@ -528,23 +528,23 @@ 
 	 * @param string $after
 	 * @return string
 	 */
-	public static function edit_venue_link( $VNU_ID = 0, $link = '', $before = '<p class="edit-venue-lnk small-txt">', $after = '</p>' ) {
-		$venue = EEH_Venue_View::get_venue( $VNU_ID );
-		if ( $venue instanceof EE_Venue ) {
+	public static function edit_venue_link($VNU_ID = 0, $link = '', $before = '<p class="edit-venue-lnk small-txt">', $after = '</p>') {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
 			// can the user edit this post ?
-			if ( current_user_can( 'edit_post', $venue->ID() )) {
+			if (current_user_can('edit_post', $venue->ID())) {
 				// set link text
-				$link = ! empty( $link ) ? $link : __('edit this venue');
+				$link = ! empty($link) ? $link : __('edit this venue');
 				// generate nonce
-				$nonce = wp_create_nonce( 'edit_nonce' );
+				$nonce = wp_create_nonce('edit_nonce');
 				// generate url to venue editor for this venue
-				$url = add_query_arg( array( 'page' => 'espresso_venues', 'action' => 'edit', 'post' => $venue->ID(), 'edit_nonce' => $nonce ), admin_url( 'admin.php' ) );
+				$url = add_query_arg(array('page' => 'espresso_venues', 'action' => 'edit', 'post' => $venue->ID(), 'edit_nonce' => $nonce), admin_url('admin.php'));
 				// get edit CPT text
-				$post_type_obj = get_post_type_object( 'espresso_venues' );
+				$post_type_obj = get_post_type_object('espresso_venues');
 				// build final link html
-				$link = '<a class="post-edit-link" href="' . $url . '" title="' . esc_attr( $post_type_obj->labels->edit_item ) . '">' . $link . '</a>';
+				$link = '<a class="post-edit-link" href="'.$url.'" title="'.esc_attr($post_type_obj->labels->edit_item).'">'.$link.'</a>';
 				// put it all together
-				return $before . apply_filters( 'edit_post_link', $link, $venue->ID() ) . $after;
+				return $before.apply_filters('edit_post_link', $link, $venue->ID()).$after;
 			}
 		}
 		return '';

core/libraries/form_sections/base/EE_Form_Section_Proper.form.php

Doc Comments +1 added lines, -1 removed lines

@@ -425,7 +425,7 @@
      *                                                      with construction finalize being called later
      *                                                      (realizing that the subsections' html names
      *                                                      might not be set yet, etc.)
-     * @return EE_Form_Section_Base
+     * @return EE_Form_Section_Validatable|null
      * @throws EE_Error
      */
     public function get_subsection($name, $require_construction_to_be_finalized = true)

Indentation +1416 added lines, -1416 removed lines

@@ -14,1421 +14,1421 @@
 class EE_Form_Section_Proper extends EE_Form_Section_Validatable
 {
 
-    const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
-
-    /**
-     * Subsections
-     *
-     * @var EE_Form_Section_Validatable[]
-     */
-    protected $_subsections = array();
-
-    /**
-     * Strategy for laying out the form
-     *
-     * @var EE_Form_Section_Layout_Base
-     */
-    protected $_layout_strategy;
-
-    /**
-     * Whether or not this form has received and validated a form submission yet
-     *
-     * @var boolean
-     */
-    protected $_received_submission = false;
-
-    /**
-     * message displayed to users upon successful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_success_message = '';
-
-    /**
-     * message displayed to users upon unsuccessful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_error_message = '';
-
-    /**
-     * Stores all the data that will localized for form validation
-     *
-     * @var array
-     */
-    static protected $_js_localization = array();
-
-    /**
-     * whether or not the form's localized validation JS vars have been set
-     *
-     * @type boolean
-     */
-    static protected $_scripts_localized = false;
-
-
-    /**
-     * when constructing a proper form section, calls _construct_finalize on children
-     * so that they know who their parent is, and what name they've been given.
-     *
-     * @param array[] $options_array   {
-     * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
-     * @type          $include         string[] numerically-indexed where values are section names to be included,
-     *                                 and in that order. This is handy if you want
-     *                                 the subsections to be ordered differently than the default, and if you override
-     *                                 which fields are shown
-     * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
-     *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
-     *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
-     *                                 items from that list of inclusions)
-     * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
-     *                                 } @see EE_Form_Section_Validatable::__construct()
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        $options_array = (array) apply_filters(
-            'FHEE__EE_Form_Section_Proper___construct__options_array',
-            $options_array,
-            $this
-        );
-        //call parent first, as it may be setting the name
-        parent::__construct($options_array);
-        //if they've included subsections in the constructor, add them now
-        if (isset($options_array['include'])) {
-            //we are going to make sure we ONLY have those subsections to include
-            //AND we are going to make sure they're in that specified order
-            $reordered_subsections = array();
-            foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
-                }
-            }
-            $this->_subsections = $reordered_subsections;
-        }
-        if (isset($options_array['exclude'])) {
-            $exclude            = $options_array['exclude'];
-            $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
-        }
-        if (isset($options_array['layout_strategy'])) {
-            $this->_layout_strategy = $options_array['layout_strategy'];
-        }
-        if (! $this->_layout_strategy) {
-            $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
-        }
-        $this->_layout_strategy->_construct_finalize($this);
-        //ok so we are definitely going to want the forms JS,
-        //so enqueue it or remember to enqueue it during wp_enqueue_scripts
-        if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
-            //ok so they've constructed this object after when they should have.
-            //just enqueue the generic form scripts and initialize the form immediately in the JS
-            EE_Form_Section_Proper::wp_enqueue_scripts(true);
-        } else {
-            add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-            add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-        }
-        add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
-        /**
-         * Gives other plugins a chance to hook in before construct finalize is called.
-         * The form probably doesn't yet have a parent form section.
-         * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
-         * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
-         * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
-         *
-         * @since 4.9.32
-         * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
-         *                                              except maybe calling _construct_finalize has been done
-         * @param array                  $options_array options passed into the constructor
-         */
-        do_action(
-            'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
-            $this,
-            $options_array
-        );
-        if (isset($options_array['name'])) {
-            $this->_construct_finalize(null, $options_array['name']);
-        }
-    }
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper $parent_form_section
-     * @param string                 $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        $this->_set_default_name_if_empty();
-        $this->_set_default_html_id_if_empty();
-        foreach ($this->_subsections as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Base) {
-                $subsection->_construct_finalize($this, $subsection_name);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
-                            'event_espresso'
-                        ),
-                        $subsection_name,
-                        get_class($this),
-                        $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                    )
-                );
-            }
-        }
-        /**
-         * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
-         * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
-         * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
-         * This might only happen just before displaying the form, or just before it receives form submission data.
-         * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
-         * ensured it has a name, HTML IDs, etc
-         *
-         * @param EE_Form_Section_Proper      $this
-         * @param EE_Form_Section_Proper|null $parent_form_section
-         * @param string                      $name
-         */
-        do_action(
-            'AHEE__EE_Form_Section_Proper___construct_finalize__end',
-            $this,
-            $parent_form_section,
-            $name
-        );
-    }
-
-
-    /**
-     * Gets the layout strategy for this form section
-     *
-     * @return EE_Form_Section_Layout_Base
-     */
-    public function get_layout_strategy()
-    {
-        return $this->_layout_strategy;
-    }
-
-
-    /**
-     * Gets the HTML for a single input for this form section according
-     * to the layout strategy
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function get_html_for_input($input)
-    {
-        return $this->_layout_strategy->layout_input($input);
-    }
-
-
-    /**
-     * was_submitted - checks if form inputs are present in request data
-     * Basically an alias for form_data_present_in() (which is used by both
-     * proper form sections and form inputs)
-     *
-     * @param null $form_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function was_submitted($form_data = null)
-    {
-        return $this->form_data_present_in($form_data);
-    }
-
-
-    /**
-     * After the form section is initially created, call this to sanitize the data in the submission
-     * which relates to this form section, validate it, and set it as properties on the form.
-     *
-     * @param array|null $req_data should usually be $_POST (the default).
-     *                             However, you CAN supply a different array.
-     *                             Consider using set_defaults() instead however.
-     *                             (If you rendered the form in the page using echo $form_x->get_html()
-     *                             the inputs will have the correct name in the request data for this function
-     *                             to find them and populate the form with them.
-     *                             If you have a flat form (with only input subsections),
-     *                             you can supply a flat array where keys
-     *                             are the form input names and values are their values)
-     * @param boolean    $validate whether or not to perform validation on this data. Default is,
-     *                             of course, to validate that data, and set errors on the invalid values.
-     *                             But if the data has already been validated
-     *                             (eg you validated the data then stored it in the DB)
-     *                             you may want to skip this step.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function receive_form_submission($req_data = null, $validate = true)
-    {
-        $req_data = apply_filters(
-            'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-            $req_data,
-            $this,
-            $validate
-        );
-        if ($req_data === null) {
-            $req_data = array_merge($_GET, $_POST);
-        }
-        $req_data = apply_filters(
-            'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-            $req_data,
-            $this
-        );
-        $this->_normalize($req_data);
-        if ($validate) {
-            $this->_validate();
-            //if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
-                $this->store_submitted_form_data_in_session();
-            }
-        }
-        do_action(
-            'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
-            $req_data,
-            $this,
-            $validate
-        );
-    }
-
-
-    /**
-     * caches the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return boolean whether or not the data was successfully stored in the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function store_submitted_form_data_in_session()
-    {
-        return EE_Registry::instance()->SSN->set_session_data(
-            array(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
-            )
-        );
-    }
-
-
-    /**
-     * retrieves the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function get_submitted_form_data_from_session()
-    {
-        $session = EE_Registry::instance()->SSN;
-        if ($session instanceof EE_Session) {
-            return $session->get_session_data(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
-            );
-        }
-        return array();
-    }
-
-
-    /**
-     * flushed the originally submitted input values from the session
-     *
-     * @return boolean whether or not the data was successfully removed from the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function flush_submitted_form_data_from_session()
-    {
-        return EE_Registry::instance()->SSN->reset_data(
-            array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
-        );
-    }
-
-
-    /**
-     * Populates this form and its subsections with data from the session.
-     * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
-     * validation errors when displaying too)
-     * Returns true if the form was populated from the session, false otherwise
-     *
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function populate_from_session()
-    {
-        $form_data_in_session = $this->get_submitted_form_data_from_session();
-        if (empty($form_data_in_session)) {
-            return false;
-        }
-        $this->receive_form_submission($form_data_in_session);
-        $this->flush_submitted_form_data_from_session();
-        if ($this->form_data_present_in($form_data_in_session)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Populates the default data for the form, given an array where keys are
-     * the input names, and values are their values (preferably normalized to be their
-     * proper PHP types, not all strings... although that should be ok too).
-     * Proper subsections are sub-arrays, the key being the subsection's name, and
-     * the value being an array formatted in teh same way
-     *
-     * @param array $default_data
-     * @throws EE_Error
-     */
-    public function populate_defaults($default_data)
-    {
-        foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
-                if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
-                } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * returns true if subsection exists
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function subsection_exists($name)
-    {
-        return isset($this->_subsections[ $name ]) ? true : false;
-    }
-
-
-    /**
-     * Gets the subsection specified by its name
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
-     *                                                      so that the inputs will be properly configured.
-     *                                                      However, some client code may be ok
-     *                                                      with construction finalize being called later
-     *                                                      (realizing that the subsections' html names
-     *                                                      might not be set yet, etc.)
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function get_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
-    }
-
-
-    /**
-     * Gets all the validatable subsections of this form section
-     *
-     * @return EE_Form_Section_Validatable[]
-     * @throws EE_Error
-     */
-    public function get_validatable_subsections()
-    {
-        $validatable_subsections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
-            }
-        }
-        return $validatable_subsections;
-    }
-
-
-    /**
-     * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
-     * throw an EE_Error.
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function get_input($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Input_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this),
-                    $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Like get_input(), gets the proper subsection of the form given the name,
-     * otherwise throws an EE_Error
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this)
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Gets the value of the specified input. Should be called after receive_form_submission()
-     * or populate_defaults() on the form, where the normalized value on the input is set.
-     *
-     * @param string $name
-     * @return mixed depending on the input's type and its normalization strategy
-     * @throws EE_Error
-     */
-    public function get_input_value($name)
-    {
-        $input = $this->get_input($name);
-        return $input->normalized_value();
-    }
-
-
-    /**
-     * Checks if this form section itself is valid, and then checks its subsections
-     *
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if (! $this->has_received_submission()) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
-                        'event_espresso'
-                    )
-                )
-            );
-        }
-        if (! parent::is_valid()) {
-            return false;
-        }
-        // ok so no general errors to this entire form section.
-        // so let's check the subsections, but only set errors if that hasn't been done yet
-        $set_submission_errors = $this->submission_error_message() === '';
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if (! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
-                if ($set_submission_errors) {
-                    $this->set_submission_error_message(
-                        $subsection->get_validation_error_string()
-                    );
-                }
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * gets the default name of this form section if none is specified
-     *
-     * @return void
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $classname    = get_class($this);
-            $default_name = str_replace('EE_', '', $classname);
-            $this->_name  = $default_name;
-        }
-    }
-
-
-    /**
-     * Returns the HTML for the form, except for the form opening and closing tags
-     * (as the form section doesn't know where you necessarily want to send the information to),
-     * and except for a submit button. Enqueues JS and CSS; if called early enough we will
-     * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
-     * Not doing_it_wrong because theoretically this CAN be used properly,
-     * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
-     * any CSS.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_html_and_js()
-    {
-        $this->enqueue_js();
-        return $this->get_html();
-    }
-
-
-    /**
-     * returns HTML for displaying this form section. recursively calls display_section() on all subsections
-     *
-     * @param bool $display_previously_submitted_data
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_html($display_previously_submitted_data = true)
-    {
-        $this->ensure_construct_finalized_called();
-        if ($display_previously_submitted_data) {
-            $this->populate_from_session();
-        }
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
-            : $this->_layout_strategy->layout_form();
-    }
-
-
-    /**
-     * enqueues JS and CSS for the form.
-     * It is preferred to call this before wp_enqueue_scripts so the
-     * scripts and styles can be put in the header, but if called later
-     * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
-     * only be in the header; but in HTML5 its ok in the body.
-     * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
-     * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_js()
-    {
-        $this->_enqueue_and_localize_form_js();
-        foreach ($this->subsections() as $subsection) {
-            $subsection->enqueue_js();
-        }
-    }
-
-
-    /**
-     * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
-     * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
-     * the wp_enqueue_scripts hook.
-     * However, registering the form js and localizing it can happen when we
-     * actually output the form (which is preferred, seeing how teh form's fields
-     * could change until it's actually outputted)
-     *
-     * @param boolean $init_form_validation_automatically whether or not we want the form validation
-     *                                                    to be triggered automatically or not
-     * @return void
-     */
-    public static function wp_enqueue_scripts($init_form_validation_automatically = true)
-    {
-        wp_register_script(
-            'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
-            array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_validation_init',
-            array('init' => $init_form_validation_automatically ? '1' : '0')
-        );
-    }
-
-
-    /**
-     * gets the variables used by form_section_validation.js.
-     * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
-     * but before the wordpress hook wp_loaded
-     *
-     * @throws EE_Error
-     */
-    public function _enqueue_and_localize_form_js()
-    {
-        $this->ensure_construct_finalized_called();
-        //actually, we don't want to localize just yet. There may be other forms on the page.
-        //so we need to add our form section data to a static variable accessible by all form sections
-        //and localize it just before the footer
-        $this->localize_validation_rules();
-        add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
-        add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
-    }
-
-
-    /**
-     * add our form section data to a static variable accessible by all form sections
-     *
-     * @param bool $return_for_subsection
-     * @return void
-     * @throws EE_Error
-     */
-    public function localize_validation_rules($return_for_subsection = false)
-    {
-        // we only want to localize vars ONCE for the entire form,
-        // so if the form section doesn't have a parent, then it must be the top dog
-        if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
-                'form_section_id'  => $this->html_id(true),
-                'validation_rules' => $this->get_jquery_validation_rules(),
-                'other_data'       => $this->get_other_js_data(),
-                'errors'           => $this->subsection_validation_errors_by_html_name(),
-            );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
-        }
-    }
-
-
-    /**
-     * Gets an array of extra data that will be useful for client-side javascript.
-     * This is primarily data added by inputs and forms in addition to any
-     * scripts they might enqueue
-     *
-     * @param array $form_other_js_data
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        foreach ($this->subsections() as $subsection) {
-            $form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Gets a flat array of inputs for this form section and its subsections.
-     * Keys are their form names, and values are the inputs themselves
-     *
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function inputs_in_subsections()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs += $subsection->inputs_in_subsections();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets a flat array of all the validation errors.
-     * Keys are html names (because those should be unique)
-     * and values are a string of all their validation errors
-     *
-     * @return string[]
-     * @throws EE_Error
-     */
-    public function subsection_validation_errors_by_html_name()
-    {
-        $inputs = $this->inputs();
-        $errors = array();
-        foreach ($inputs as $form_input) {
-            if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
-     * Should be setup by each form during the _enqueues_and_localize_form_js
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function localize_script_for_all_forms()
-    {
-        //allow inputs and stuff to hook in their JS and stuff here
-        do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
-        EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
-        $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
-            : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
-        wp_enqueue_script('ee_form_section_validation');
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_vars',
-            EE_Form_Section_Proper::$_js_localization
-        );
-    }
-
-
-    /**
-     * ensure_scripts_localized
-     *
-     * @throws EE_Error
-     */
-    public function ensure_scripts_localized()
-    {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
-            $this->_enqueue_and_localize_form_js();
-        }
-    }
-
-
-    /**
-     * Gets the hard-coded validation error messages to be used in the JS. The convention
-     * is that the key here should be the same as the custom validation rule put in the JS file
-     *
-     * @return array keys are custom validation rules, and values are internationalized strings
-     */
-    private static function _get_localized_error_messages()
-    {
-        return array(
-            'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'),
-            'regex'    => esc_html__('Please check your input', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function js_localization()
-    {
-        return self::$_js_localization;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function reset_js_localization()
-    {
-        self::$_js_localization = array();
-    }
-
-
-    /**
-     * Gets the JS to put inside the jquery validation rules for subsection of this form section.
-     * See parent function for more...
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_jquery_validation_rules()
-    {
-        $jquery_validation_rules = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $jquery_validation_rules = array_merge(
-                $jquery_validation_rules,
-                $subsection->get_jquery_validation_rules()
-            );
-        }
-        return $jquery_validation_rules;
-    }
-
-
-    /**
-     * Sanitizes all the data and sets the sanitized value of each field
-     *
-     * @param array $req_data like $_POST
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        $this->_received_submission = true;
-        $this->_validation_errors   = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            try {
-                $subsection->_normalize($req_data);
-            } catch (EE_Validation_Error $e) {
-                $subsection->add_validation_error($e);
-            }
-        }
-    }
-
-
-    /**
-     * Performs validation on this form section and its subsections.
-     * For each subsection,
-     * calls _validate_{subsection_name} on THIS form (if the function exists)
-     * and passes it the subsection, then calls _validate on that subsection.
-     * If you need to perform validation on the form as a whole (considering multiple)
-     * you would be best to override this _validate method,
-     * calling parent::_validate() first.
-     *
-     * @throws EE_Error
-     */
-    protected function _validate()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
-            }
-            $subsection->_validate();
-        }
-    }
-
-
-    /**
-     * Gets all the validated inputs for the form section
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function valid_data()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
-            } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the inputs on this form section
-     *
-     * @return EE_Form_Input_Base[]
-     * @throws EE_Error
-     */
-    public function inputs()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the subsections which are a proper form
-     *
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subforms()
-    {
-        $form_sections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
-            }
-        }
-        return $form_sections;
-    }
-
-
-    /**
-     * Gets all the subsections (inputs, proper subsections, or html-only sections).
-     * Consider using inputs() or subforms()
-     * if you only want form inputs or proper form sections.
-     *
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subsections($require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->_subsections;
-    }
-
-
-    /**
-     * Returns a simple array where keys are input names, and values are their normalized
-     * values. (Similar to calling get_input_value on inputs)
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(false, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
-     * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
-     * is not necessarily the value we want to display to users. This creates an array
-     * where keys are the input names, and values are their display values
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_pretty_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(true, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Gets the input values from the form
-     *
-     * @param boolean $pretty                 Whether to retrieve the pretty value,
-     *                                        or just the normalized value
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
-     *                                        input names (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
-    {
-        $input_values = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
-                    ? $subsection->pretty_value()
-                    : $subsection->normalized_value();
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
-                $subform_input_values = $subsection->_input_values(
-                    $pretty,
-                    $include_subform_inputs,
-                    $flatten
-                );
-                if ($flatten) {
-                    $input_values = array_merge($input_values, $subform_input_values);
-                } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
-                }
-            }
-        }
-        return $input_values;
-    }
-
-
-    /**
-     * Gets the originally submitted input values from the form
-     *
-     * @param boolean $include_subforms  Whether to include inputs from subforms,
-     *                                   or just this forms' direct children inputs
-     * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
-     *                                   with array keys being input names
-     *                                   (regardless of whether they are from a subsection or not),
-     *                                   and if $flatten is FALSE it can be a multidimensional array
-     *                                   where keys are always subsection names and values are either
-     *                                   the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function submitted_values($include_subforms = false)
-    {
-        $submitted_values = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                // is this input part of an array of inputs?
-                if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
-                        explode(
-                            '[',
-                            str_replace(']', '', $subsection->html_name())
-                        ),
-                        $subsection->raw_value()
-                    );
-                    $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
-                } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
-                $subform_input_values = $subsection->submitted_values($include_subforms);
-                $submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
-            }
-        }
-        return $submitted_values;
-    }
-
-
-    /**
-     * Indicates whether or not this form has received a submission yet
-     * (ie, had receive_form_submission called on it yet)
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function has_received_submission()
-    {
-        $this->ensure_construct_finalized_called();
-        return $this->_received_submission;
-    }
-
-
-    /**
-     * Equivalent to passing 'exclude' in the constructor's options array.
-     * Removes the listed inputs from the form
-     *
-     * @param array $inputs_to_exclude values are the input names
-     * @return void
-     */
-    public function exclude(array $inputs_to_exclude = array())
-    {
-        foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
-        }
-    }
-
-
-    /**
-     * @param array $inputs_to_hide
-     * @throws EE_Error
-     */
-    public function hide(array $inputs_to_hide = array())
-    {
-        foreach ($inputs_to_hide as $input_to_hide) {
-            $input = $this->get_input($input_to_hide);
-            $input->set_display_strategy(new EE_Hidden_Display_Strategy());
-        }
-    }
-
-
-    /**
-     * add_subsections
-     * Adds the listed subsections to the form section.
-     * If $subsection_name_to_target is provided,
-     * then new subsections are added before or after that subsection,
-     * otherwise to the start or end of the entire subsections array.
-     *
-     * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
-     *                                                          where keys are their names
-     * @param string                 $subsection_name_to_target an existing for section that $new_subsections
-     *                                                          should be added before or after
-     *                                                          IF $subsection_name_to_target is null,
-     *                                                          then $new_subsections will be added to
-     *                                                          the beginning or end of the entire subsections array
-     * @param boolean                $add_before                whether to add $new_subsections, before or after
-     *                                                          $subsection_name_to_target,
-     *                                                          or if $subsection_name_to_target is null,
-     *                                                          before or after entire subsections array
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
-    {
-        foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
-                            'event_espresso'
-                        ),
-                        get_class($subsection),
-                        $subsection_name,
-                        $this->name()
-                    )
-                );
-                unset($new_subsections[ $subsection_name ]);
-            }
-        }
-        $this->_subsections = EEH_Array::insert_into_array(
-            $this->_subsections,
-            $new_subsections,
-            $subsection_name_to_target,
-            $add_before
-        );
-        if ($this->_construction_finalized) {
-            foreach ($this->_subsections as $name => $subsection) {
-                $subsection->_construct_finalize($this, $name);
-            }
-        }
-    }
-
-
-    /**
-     * Just gets all validatable subsections to clean their sensitive data
-     *
-     * @throws EE_Error
-     */
-    public function clean_sensitive_data()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $subsection->clean_sensitive_data();
-        }
-    }
-
-
-    /**
-     * @param string $form_submission_error_message
-     */
-    public function set_submission_error_message($form_submission_error_message = '')
-    {
-        $this->_form_submission_error_message .= ! empty($form_submission_error_message)
-            ? $form_submission_error_message
-            : esc_html__('Form submission failed due to errors', 'event_espresso');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function submission_error_message()
-    {
-        return $this->_form_submission_error_message;
-    }
-
-
-    /**
-     * @param string $form_submission_success_message
-     */
-    public function set_submission_success_message($form_submission_success_message)
-    {
-        $this->_form_submission_success_message .= ! empty($form_submission_success_message)
-            ? $form_submission_success_message
-            : esc_html__('Form submitted successfully', 'event_espresso');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function submission_success_message()
-    {
-        return $this->_form_submission_success_message;
-    }
-
-
-    /**
-     * Returns the prefix that should be used on child of this form section for
-     * their html names. If this form section itself has a parent, prepends ITS
-     * prefix onto this form section's prefix. Used primarily by
-     * EE_Form_Input_Base::_set_default_html_name_if_empty
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name_prefix()
-    {
-        if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
-        }
-        return $this->name();
-    }
-
-
-    /**
-     * Gets the name, but first checks _construct_finalize has been called. If not,
-     * calls it (assumes there is no parent and that we want the name to be whatever
-     * was set, which is probably nothing, or the classname)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::name();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function parent_section()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::parent_section();
-    }
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-    /**
-     * Checks if any of this form section's inputs, or any of its children's inputs,
-     * are in teh form data. If any are found, returns true. Else false
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        if ($req_data === null) {
-            $req_data = $_POST;
-        }
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets validation errors for this form section and subsections
-     * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
-     * gets the validation errors for ALL subsection
-     *
-     * @return EE_Validation_Error[]
-     * @throws EE_Error
-     */
-    public function get_validation_errors_accumulated()
-    {
-        $validation_errors = $this->get_validation_errors();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
-            } else {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors();
-            }
-            if ($validation_errors_on_this_subsection) {
-                $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
-            }
-        }
-        return $validation_errors;
-    }
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        //check if we can find the input from purely going straight up the tree
-        $input = parent::find_section_from_path($form_section_path);
-        if ($input instanceof EE_Form_Section_Base) {
-            return $input;
-        }
-        $next_slash_pos = strpos($form_section_path, '/');
-        if ($next_slash_pos !== false) {
-            $child_section_name = substr($form_section_path, 0, $next_slash_pos);
-            $subpath            = substr($form_section_path, $next_slash_pos + 1);
-        } else {
-            $child_section_name = $form_section_path;
-            $subpath            = '';
-        }
-        $child_section = $this->get_subsection($child_section_name);
-        if ($child_section instanceof EE_Form_Section_Base) {
-            return $child_section->find_section_from_path($subpath);
-        }
-        return null;
-    }
+	const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
+
+	/**
+	 * Subsections
+	 *
+	 * @var EE_Form_Section_Validatable[]
+	 */
+	protected $_subsections = array();
+
+	/**
+	 * Strategy for laying out the form
+	 *
+	 * @var EE_Form_Section_Layout_Base
+	 */
+	protected $_layout_strategy;
+
+	/**
+	 * Whether or not this form has received and validated a form submission yet
+	 *
+	 * @var boolean
+	 */
+	protected $_received_submission = false;
+
+	/**
+	 * message displayed to users upon successful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_success_message = '';
+
+	/**
+	 * message displayed to users upon unsuccessful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_error_message = '';
+
+	/**
+	 * Stores all the data that will localized for form validation
+	 *
+	 * @var array
+	 */
+	static protected $_js_localization = array();
+
+	/**
+	 * whether or not the form's localized validation JS vars have been set
+	 *
+	 * @type boolean
+	 */
+	static protected $_scripts_localized = false;
+
+
+	/**
+	 * when constructing a proper form section, calls _construct_finalize on children
+	 * so that they know who their parent is, and what name they've been given.
+	 *
+	 * @param array[] $options_array   {
+	 * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
+	 * @type          $include         string[] numerically-indexed where values are section names to be included,
+	 *                                 and in that order. This is handy if you want
+	 *                                 the subsections to be ordered differently than the default, and if you override
+	 *                                 which fields are shown
+	 * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
+	 *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
+	 *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
+	 *                                 items from that list of inclusions)
+	 * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
+	 *                                 } @see EE_Form_Section_Validatable::__construct()
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		$options_array = (array) apply_filters(
+			'FHEE__EE_Form_Section_Proper___construct__options_array',
+			$options_array,
+			$this
+		);
+		//call parent first, as it may be setting the name
+		parent::__construct($options_array);
+		//if they've included subsections in the constructor, add them now
+		if (isset($options_array['include'])) {
+			//we are going to make sure we ONLY have those subsections to include
+			//AND we are going to make sure they're in that specified order
+			$reordered_subsections = array();
+			foreach ($options_array['include'] as $input_name) {
+				if (isset($this->_subsections[ $input_name ])) {
+					$reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+				}
+			}
+			$this->_subsections = $reordered_subsections;
+		}
+		if (isset($options_array['exclude'])) {
+			$exclude            = $options_array['exclude'];
+			$this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
+		}
+		if (isset($options_array['layout_strategy'])) {
+			$this->_layout_strategy = $options_array['layout_strategy'];
+		}
+		if (! $this->_layout_strategy) {
+			$this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
+		}
+		$this->_layout_strategy->_construct_finalize($this);
+		//ok so we are definitely going to want the forms JS,
+		//so enqueue it or remember to enqueue it during wp_enqueue_scripts
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			//ok so they've constructed this object after when they should have.
+			//just enqueue the generic form scripts and initialize the form immediately in the JS
+			EE_Form_Section_Proper::wp_enqueue_scripts(true);
+		} else {
+			add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+			add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+		}
+		add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
+		/**
+		 * Gives other plugins a chance to hook in before construct finalize is called.
+		 * The form probably doesn't yet have a parent form section.
+		 * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
+		 * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
+		 * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
+		 *
+		 * @since 4.9.32
+		 * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
+		 *                                              except maybe calling _construct_finalize has been done
+		 * @param array                  $options_array options passed into the constructor
+		 */
+		do_action(
+			'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
+			$this,
+			$options_array
+		);
+		if (isset($options_array['name'])) {
+			$this->_construct_finalize(null, $options_array['name']);
+		}
+	}
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper $parent_form_section
+	 * @param string                 $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		$this->_set_default_name_if_empty();
+		$this->_set_default_html_id_if_empty();
+		foreach ($this->_subsections as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Base) {
+				$subsection->_construct_finalize($this, $subsection_name);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
+							'event_espresso'
+						),
+						$subsection_name,
+						get_class($this),
+						$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+					)
+				);
+			}
+		}
+		/**
+		 * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
+		 * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
+		 * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
+		 * This might only happen just before displaying the form, or just before it receives form submission data.
+		 * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
+		 * ensured it has a name, HTML IDs, etc
+		 *
+		 * @param EE_Form_Section_Proper      $this
+		 * @param EE_Form_Section_Proper|null $parent_form_section
+		 * @param string                      $name
+		 */
+		do_action(
+			'AHEE__EE_Form_Section_Proper___construct_finalize__end',
+			$this,
+			$parent_form_section,
+			$name
+		);
+	}
+
+
+	/**
+	 * Gets the layout strategy for this form section
+	 *
+	 * @return EE_Form_Section_Layout_Base
+	 */
+	public function get_layout_strategy()
+	{
+		return $this->_layout_strategy;
+	}
+
+
+	/**
+	 * Gets the HTML for a single input for this form section according
+	 * to the layout strategy
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function get_html_for_input($input)
+	{
+		return $this->_layout_strategy->layout_input($input);
+	}
+
+
+	/**
+	 * was_submitted - checks if form inputs are present in request data
+	 * Basically an alias for form_data_present_in() (which is used by both
+	 * proper form sections and form inputs)
+	 *
+	 * @param null $form_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function was_submitted($form_data = null)
+	{
+		return $this->form_data_present_in($form_data);
+	}
+
+
+	/**
+	 * After the form section is initially created, call this to sanitize the data in the submission
+	 * which relates to this form section, validate it, and set it as properties on the form.
+	 *
+	 * @param array|null $req_data should usually be $_POST (the default).
+	 *                             However, you CAN supply a different array.
+	 *                             Consider using set_defaults() instead however.
+	 *                             (If you rendered the form in the page using echo $form_x->get_html()
+	 *                             the inputs will have the correct name in the request data for this function
+	 *                             to find them and populate the form with them.
+	 *                             If you have a flat form (with only input subsections),
+	 *                             you can supply a flat array where keys
+	 *                             are the form input names and values are their values)
+	 * @param boolean    $validate whether or not to perform validation on this data. Default is,
+	 *                             of course, to validate that data, and set errors on the invalid values.
+	 *                             But if the data has already been validated
+	 *                             (eg you validated the data then stored it in the DB)
+	 *                             you may want to skip this step.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function receive_form_submission($req_data = null, $validate = true)
+	{
+		$req_data = apply_filters(
+			'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+			$req_data,
+			$this,
+			$validate
+		);
+		if ($req_data === null) {
+			$req_data = array_merge($_GET, $_POST);
+		}
+		$req_data = apply_filters(
+			'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+			$req_data,
+			$this
+		);
+		$this->_normalize($req_data);
+		if ($validate) {
+			$this->_validate();
+			//if it's invalid, we're going to want to re-display so remember what they submitted
+			if (! $this->is_valid()) {
+				$this->store_submitted_form_data_in_session();
+			}
+		}
+		do_action(
+			'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
+			$req_data,
+			$this,
+			$validate
+		);
+	}
+
+
+	/**
+	 * caches the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return boolean whether or not the data was successfully stored in the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function store_submitted_form_data_in_session()
+	{
+		return EE_Registry::instance()->SSN->set_session_data(
+			array(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
+			)
+		);
+	}
+
+
+	/**
+	 * retrieves the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function get_submitted_form_data_from_session()
+	{
+		$session = EE_Registry::instance()->SSN;
+		if ($session instanceof EE_Session) {
+			return $session->get_session_data(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
+			);
+		}
+		return array();
+	}
+
+
+	/**
+	 * flushed the originally submitted input values from the session
+	 *
+	 * @return boolean whether or not the data was successfully removed from the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function flush_submitted_form_data_from_session()
+	{
+		return EE_Registry::instance()->SSN->reset_data(
+			array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
+		);
+	}
+
+
+	/**
+	 * Populates this form and its subsections with data from the session.
+	 * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
+	 * validation errors when displaying too)
+	 * Returns true if the form was populated from the session, false otherwise
+	 *
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function populate_from_session()
+	{
+		$form_data_in_session = $this->get_submitted_form_data_from_session();
+		if (empty($form_data_in_session)) {
+			return false;
+		}
+		$this->receive_form_submission($form_data_in_session);
+		$this->flush_submitted_form_data_from_session();
+		if ($this->form_data_present_in($form_data_in_session)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Populates the default data for the form, given an array where keys are
+	 * the input names, and values are their values (preferably normalized to be their
+	 * proper PHP types, not all strings... although that should be ok too).
+	 * Proper subsections are sub-arrays, the key being the subsection's name, and
+	 * the value being an array formatted in teh same way
+	 *
+	 * @param array $default_data
+	 * @throws EE_Error
+	 */
+	public function populate_defaults($default_data)
+	{
+		foreach ($this->subsections(false) as $subsection_name => $subsection) {
+			if (isset($default_data[ $subsection_name ])) {
+				if ($subsection instanceof EE_Form_Input_Base) {
+					$subsection->set_default($default_data[ $subsection_name ]);
+				} elseif ($subsection instanceof EE_Form_Section_Proper) {
+					$subsection->populate_defaults($default_data[ $subsection_name ]);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if subsection exists
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function subsection_exists($name)
+	{
+		return isset($this->_subsections[ $name ]) ? true : false;
+	}
+
+
+	/**
+	 * Gets the subsection specified by its name
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
+	 *                                                      so that the inputs will be properly configured.
+	 *                                                      However, some client code may be ok
+	 *                                                      with construction finalize being called later
+	 *                                                      (realizing that the subsections' html names
+	 *                                                      might not be set yet, etc.)
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function get_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+	}
+
+
+	/**
+	 * Gets all the validatable subsections of this form section
+	 *
+	 * @return EE_Form_Section_Validatable[]
+	 * @throws EE_Error
+	 */
+	public function get_validatable_subsections()
+	{
+		$validatable_subsections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Validatable) {
+				$validatable_subsections[ $name ] = $obj;
+			}
+		}
+		return $validatable_subsections;
+	}
+
+
+	/**
+	 * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
+	 * throw an EE_Error.
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function get_input($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Input_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this),
+					$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Like get_input(), gets the proper subsection of the form given the name,
+	 * otherwise throws an EE_Error
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Section_Proper) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this)
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Gets the value of the specified input. Should be called after receive_form_submission()
+	 * or populate_defaults() on the form, where the normalized value on the input is set.
+	 *
+	 * @param string $name
+	 * @return mixed depending on the input's type and its normalization strategy
+	 * @throws EE_Error
+	 */
+	public function get_input_value($name)
+	{
+		$input = $this->get_input($name);
+		return $input->normalized_value();
+	}
+
+
+	/**
+	 * Checks if this form section itself is valid, and then checks its subsections
+	 *
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if (! $this->has_received_submission()) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
+						'event_espresso'
+					)
+				)
+			);
+		}
+		if (! parent::is_valid()) {
+			return false;
+		}
+		// ok so no general errors to this entire form section.
+		// so let's check the subsections, but only set errors if that hasn't been done yet
+		$set_submission_errors = $this->submission_error_message() === '';
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if (! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
+				if ($set_submission_errors) {
+					$this->set_submission_error_message(
+						$subsection->get_validation_error_string()
+					);
+				}
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * gets the default name of this form section if none is specified
+	 *
+	 * @return void
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$classname    = get_class($this);
+			$default_name = str_replace('EE_', '', $classname);
+			$this->_name  = $default_name;
+		}
+	}
+
+
+	/**
+	 * Returns the HTML for the form, except for the form opening and closing tags
+	 * (as the form section doesn't know where you necessarily want to send the information to),
+	 * and except for a submit button. Enqueues JS and CSS; if called early enough we will
+	 * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
+	 * Not doing_it_wrong because theoretically this CAN be used properly,
+	 * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
+	 * any CSS.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_html_and_js()
+	{
+		$this->enqueue_js();
+		return $this->get_html();
+	}
+
+
+	/**
+	 * returns HTML for displaying this form section. recursively calls display_section() on all subsections
+	 *
+	 * @param bool $display_previously_submitted_data
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_html($display_previously_submitted_data = true)
+	{
+		$this->ensure_construct_finalized_called();
+		if ($display_previously_submitted_data) {
+			$this->populate_from_session();
+		}
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
+			: $this->_layout_strategy->layout_form();
+	}
+
+
+	/**
+	 * enqueues JS and CSS for the form.
+	 * It is preferred to call this before wp_enqueue_scripts so the
+	 * scripts and styles can be put in the header, but if called later
+	 * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
+	 * only be in the header; but in HTML5 its ok in the body.
+	 * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
+	 * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_js()
+	{
+		$this->_enqueue_and_localize_form_js();
+		foreach ($this->subsections() as $subsection) {
+			$subsection->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
+	 * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
+	 * the wp_enqueue_scripts hook.
+	 * However, registering the form js and localizing it can happen when we
+	 * actually output the form (which is preferred, seeing how teh form's fields
+	 * could change until it's actually outputted)
+	 *
+	 * @param boolean $init_form_validation_automatically whether or not we want the form validation
+	 *                                                    to be triggered automatically or not
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts($init_form_validation_automatically = true)
+	{
+		wp_register_script(
+			'ee_form_section_validation',
+			EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
+			array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_validation_init',
+			array('init' => $init_form_validation_automatically ? '1' : '0')
+		);
+	}
+
+
+	/**
+	 * gets the variables used by form_section_validation.js.
+	 * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
+	 * but before the wordpress hook wp_loaded
+	 *
+	 * @throws EE_Error
+	 */
+	public function _enqueue_and_localize_form_js()
+	{
+		$this->ensure_construct_finalized_called();
+		//actually, we don't want to localize just yet. There may be other forms on the page.
+		//so we need to add our form section data to a static variable accessible by all form sections
+		//and localize it just before the footer
+		$this->localize_validation_rules();
+		add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
+		add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
+	}
+
+
+	/**
+	 * add our form section data to a static variable accessible by all form sections
+	 *
+	 * @param bool $return_for_subsection
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function localize_validation_rules($return_for_subsection = false)
+	{
+		// we only want to localize vars ONCE for the entire form,
+		// so if the form section doesn't have a parent, then it must be the top dog
+		if ($return_for_subsection || ! $this->parent_section()) {
+			EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+				'form_section_id'  => $this->html_id(true),
+				'validation_rules' => $this->get_jquery_validation_rules(),
+				'other_data'       => $this->get_other_js_data(),
+				'errors'           => $this->subsection_validation_errors_by_html_name(),
+			);
+			EE_Form_Section_Proper::$_scripts_localized                                = true;
+		}
+	}
+
+
+	/**
+	 * Gets an array of extra data that will be useful for client-side javascript.
+	 * This is primarily data added by inputs and forms in addition to any
+	 * scripts they might enqueue
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		foreach ($this->subsections() as $subsection) {
+			$form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Gets a flat array of inputs for this form section and its subsections.
+	 * Keys are their form names, and values are the inputs themselves
+	 *
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function inputs_in_subsections()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection->html_name() ] = $subsection;
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs += $subsection->inputs_in_subsections();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets a flat array of all the validation errors.
+	 * Keys are html names (because those should be unique)
+	 * and values are a string of all their validation errors
+	 *
+	 * @return string[]
+	 * @throws EE_Error
+	 */
+	public function subsection_validation_errors_by_html_name()
+	{
+		$inputs = $this->inputs();
+		$errors = array();
+		foreach ($inputs as $form_input) {
+			if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
+				$errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
+	 * Should be setup by each form during the _enqueues_and_localize_form_js
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function localize_script_for_all_forms()
+	{
+		//allow inputs and stuff to hook in their JS and stuff here
+		do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
+		EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
+		$email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+			? EE_Registry::instance()->CFG->registration->email_validation_level
+			: 'wp_default';
+		EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+		wp_enqueue_script('ee_form_section_validation');
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_vars',
+			EE_Form_Section_Proper::$_js_localization
+		);
+	}
+
+
+	/**
+	 * ensure_scripts_localized
+	 *
+	 * @throws EE_Error
+	 */
+	public function ensure_scripts_localized()
+	{
+		if (! EE_Form_Section_Proper::$_scripts_localized) {
+			$this->_enqueue_and_localize_form_js();
+		}
+	}
+
+
+	/**
+	 * Gets the hard-coded validation error messages to be used in the JS. The convention
+	 * is that the key here should be the same as the custom validation rule put in the JS file
+	 *
+	 * @return array keys are custom validation rules, and values are internationalized strings
+	 */
+	private static function _get_localized_error_messages()
+	{
+		return array(
+			'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'),
+			'regex'    => esc_html__('Please check your input', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function js_localization()
+	{
+		return self::$_js_localization;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_js_localization()
+	{
+		self::$_js_localization = array();
+	}
+
+
+	/**
+	 * Gets the JS to put inside the jquery validation rules for subsection of this form section.
+	 * See parent function for more...
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_jquery_validation_rules()
+	{
+		$jquery_validation_rules = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$jquery_validation_rules = array_merge(
+				$jquery_validation_rules,
+				$subsection->get_jquery_validation_rules()
+			);
+		}
+		return $jquery_validation_rules;
+	}
+
+
+	/**
+	 * Sanitizes all the data and sets the sanitized value of each field
+	 *
+	 * @param array $req_data like $_POST
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		$this->_received_submission = true;
+		$this->_validation_errors   = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			try {
+				$subsection->_normalize($req_data);
+			} catch (EE_Validation_Error $e) {
+				$subsection->add_validation_error($e);
+			}
+		}
+	}
+
+
+	/**
+	 * Performs validation on this form section and its subsections.
+	 * For each subsection,
+	 * calls _validate_{subsection_name} on THIS form (if the function exists)
+	 * and passes it the subsection, then calls _validate on that subsection.
+	 * If you need to perform validation on the form as a whole (considering multiple)
+	 * you would be best to override this _validate method,
+	 * calling parent::_validate() first.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _validate()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if (method_exists($this, '_validate_' . $subsection_name)) {
+				call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+			}
+			$subsection->_validate();
+		}
+	}
+
+
+	/**
+	 * Gets all the validated inputs for the form section
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function valid_data()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs[ $subsection_name ] = $subsection->valid_data();
+			} elseif ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection->normalized_value();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the inputs on this form section
+	 *
+	 * @return EE_Form_Input_Base[]
+	 * @throws EE_Error
+	 */
+	public function inputs()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection;
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the subsections which are a proper form
+	 *
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subforms()
+	{
+		$form_sections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Proper) {
+				$form_sections[ $name ] = $obj;
+			}
+		}
+		return $form_sections;
+	}
+
+
+	/**
+	 * Gets all the subsections (inputs, proper subsections, or html-only sections).
+	 * Consider using inputs() or subforms()
+	 * if you only want form inputs or proper form sections.
+	 *
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subsections($require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->_subsections;
+	}
+
+
+	/**
+	 * Returns a simple array where keys are input names, and values are their normalized
+	 * values. (Similar to calling get_input_value on inputs)
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(false, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
+	 * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
+	 * is not necessarily the value we want to display to users. This creates an array
+	 * where keys are the input names, and values are their display values
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_pretty_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(true, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Gets the input values from the form
+	 *
+	 * @param boolean $pretty                 Whether to retrieve the pretty value,
+	 *                                        or just the normalized value
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
+	 *                                        input names (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
+	{
+		$input_values = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$input_values[ $subsection_name ] = $pretty
+					? $subsection->pretty_value()
+					: $subsection->normalized_value();
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
+				$subform_input_values = $subsection->_input_values(
+					$pretty,
+					$include_subform_inputs,
+					$flatten
+				);
+				if ($flatten) {
+					$input_values = array_merge($input_values, $subform_input_values);
+				} else {
+					$input_values[ $subsection_name ] = $subform_input_values;
+				}
+			}
+		}
+		return $input_values;
+	}
+
+
+	/**
+	 * Gets the originally submitted input values from the form
+	 *
+	 * @param boolean $include_subforms  Whether to include inputs from subforms,
+	 *                                   or just this forms' direct children inputs
+	 * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                   with array keys being input names
+	 *                                   (regardless of whether they are from a subsection or not),
+	 *                                   and if $flatten is FALSE it can be a multidimensional array
+	 *                                   where keys are always subsection names and values are either
+	 *                                   the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function submitted_values($include_subforms = false)
+	{
+		$submitted_values = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				// is this input part of an array of inputs?
+				if (strpos($subsection->html_name(), '[') !== false) {
+					$full_input_name  = EEH_Array::convert_array_values_to_keys(
+						explode(
+							'[',
+							str_replace(']', '', $subsection->html_name())
+						),
+						$subsection->raw_value()
+					);
+					$submitted_values = array_replace_recursive($submitted_values, $full_input_name);
+				} else {
+					$submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
+				$subform_input_values = $subsection->submitted_values($include_subforms);
+				$submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
+			}
+		}
+		return $submitted_values;
+	}
+
+
+	/**
+	 * Indicates whether or not this form has received a submission yet
+	 * (ie, had receive_form_submission called on it yet)
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function has_received_submission()
+	{
+		$this->ensure_construct_finalized_called();
+		return $this->_received_submission;
+	}
+
+
+	/**
+	 * Equivalent to passing 'exclude' in the constructor's options array.
+	 * Removes the listed inputs from the form
+	 *
+	 * @param array $inputs_to_exclude values are the input names
+	 * @return void
+	 */
+	public function exclude(array $inputs_to_exclude = array())
+	{
+		foreach ($inputs_to_exclude as $input_to_exclude_name) {
+			unset($this->_subsections[ $input_to_exclude_name ]);
+		}
+	}
+
+
+	/**
+	 * @param array $inputs_to_hide
+	 * @throws EE_Error
+	 */
+	public function hide(array $inputs_to_hide = array())
+	{
+		foreach ($inputs_to_hide as $input_to_hide) {
+			$input = $this->get_input($input_to_hide);
+			$input->set_display_strategy(new EE_Hidden_Display_Strategy());
+		}
+	}
+
+
+	/**
+	 * add_subsections
+	 * Adds the listed subsections to the form section.
+	 * If $subsection_name_to_target is provided,
+	 * then new subsections are added before or after that subsection,
+	 * otherwise to the start or end of the entire subsections array.
+	 *
+	 * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
+	 *                                                          where keys are their names
+	 * @param string                 $subsection_name_to_target an existing for section that $new_subsections
+	 *                                                          should be added before or after
+	 *                                                          IF $subsection_name_to_target is null,
+	 *                                                          then $new_subsections will be added to
+	 *                                                          the beginning or end of the entire subsections array
+	 * @param boolean                $add_before                whether to add $new_subsections, before or after
+	 *                                                          $subsection_name_to_target,
+	 *                                                          or if $subsection_name_to_target is null,
+	 *                                                          before or after entire subsections array
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
+	{
+		foreach ($new_subsections as $subsection_name => $subsection) {
+			if (! $subsection instanceof EE_Form_Section_Base) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							"Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
+							'event_espresso'
+						),
+						get_class($subsection),
+						$subsection_name,
+						$this->name()
+					)
+				);
+				unset($new_subsections[ $subsection_name ]);
+			}
+		}
+		$this->_subsections = EEH_Array::insert_into_array(
+			$this->_subsections,
+			$new_subsections,
+			$subsection_name_to_target,
+			$add_before
+		);
+		if ($this->_construction_finalized) {
+			foreach ($this->_subsections as $name => $subsection) {
+				$subsection->_construct_finalize($this, $name);
+			}
+		}
+	}
+
+
+	/**
+	 * Just gets all validatable subsections to clean their sensitive data
+	 *
+	 * @throws EE_Error
+	 */
+	public function clean_sensitive_data()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$subsection->clean_sensitive_data();
+		}
+	}
+
+
+	/**
+	 * @param string $form_submission_error_message
+	 */
+	public function set_submission_error_message($form_submission_error_message = '')
+	{
+		$this->_form_submission_error_message .= ! empty($form_submission_error_message)
+			? $form_submission_error_message
+			: esc_html__('Form submission failed due to errors', 'event_espresso');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function submission_error_message()
+	{
+		return $this->_form_submission_error_message;
+	}
+
+
+	/**
+	 * @param string $form_submission_success_message
+	 */
+	public function set_submission_success_message($form_submission_success_message)
+	{
+		$this->_form_submission_success_message .= ! empty($form_submission_success_message)
+			? $form_submission_success_message
+			: esc_html__('Form submitted successfully', 'event_espresso');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function submission_success_message()
+	{
+		return $this->_form_submission_success_message;
+	}
+
+
+	/**
+	 * Returns the prefix that should be used on child of this form section for
+	 * their html names. If this form section itself has a parent, prepends ITS
+	 * prefix onto this form section's prefix. Used primarily by
+	 * EE_Form_Input_Base::_set_default_html_name_if_empty
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name_prefix()
+	{
+		if ($this->parent_section() instanceof EE_Form_Section_Proper) {
+			return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+		}
+		return $this->name();
+	}
+
+
+	/**
+	 * Gets the name, but first checks _construct_finalize has been called. If not,
+	 * calls it (assumes there is no parent and that we want the name to be whatever
+	 * was set, which is probably nothing, or the classname)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::name();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function parent_section()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::parent_section();
+	}
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+	/**
+	 * Checks if any of this form section's inputs, or any of its children's inputs,
+	 * are in teh form data. If any are found, returns true. Else false
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		if ($req_data === null) {
+			$req_data = $_POST;
+		}
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets validation errors for this form section and subsections
+	 * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
+	 * gets the validation errors for ALL subsection
+	 *
+	 * @return EE_Validation_Error[]
+	 * @throws EE_Error
+	 */
+	public function get_validation_errors_accumulated()
+	{
+		$validation_errors = $this->get_validation_errors();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
+			} else {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors();
+			}
+			if ($validation_errors_on_this_subsection) {
+				$validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
+			}
+		}
+		return $validation_errors;
+	}
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		//check if we can find the input from purely going straight up the tree
+		$input = parent::find_section_from_path($form_section_path);
+		if ($input instanceof EE_Form_Section_Base) {
+			return $input;
+		}
+		$next_slash_pos = strpos($form_section_path, '/');
+		if ($next_slash_pos !== false) {
+			$child_section_name = substr($form_section_path, 0, $next_slash_pos);
+			$subpath            = substr($form_section_path, $next_slash_pos + 1);
+		} else {
+			$child_section_name = $form_section_path;
+			$subpath            = '';
+		}
+		$child_section = $this->get_subsection($child_section_name);
+		if ($child_section instanceof EE_Form_Section_Base) {
+			return $child_section->find_section_from_path($subpath);
+		}
+		return null;
+	}
 }
 

Spacing +38 added lines, -38 removed lines

@@ -99,8 +99,8 @@ 
             //AND we are going to make sure they're in that specified order
             $reordered_subsections = array();
             foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+                if (isset($this->_subsections[$input_name])) {
+                    $reordered_subsections[$input_name] = $this->_subsections[$input_name];
                 }
             }
             $this->_subsections = $reordered_subsections;
@@ -112,7 +112,7 @@ 
         if (isset($options_array['layout_strategy'])) {
             $this->_layout_strategy = $options_array['layout_strategy'];
         }
-        if (! $this->_layout_strategy) {
+        if ( ! $this->_layout_strategy) {
             $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
         }
         $this->_layout_strategy->_construct_finalize($this);
@@ -282,7 +282,7 @@ 
         if ($validate) {
             $this->_validate();
             //if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
+            if ( ! $this->is_valid()) {
                 $this->store_submitted_form_data_in_session();
             }
         }
@@ -392,11 +392,11 @@ 
     public function populate_defaults($default_data)
     {
         foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
+            if (isset($default_data[$subsection_name])) {
                 if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
+                    $subsection->set_default($default_data[$subsection_name]);
                 } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
+                    $subsection->populate_defaults($default_data[$subsection_name]);
                 }
             }
         }
@@ -411,7 +411,7 @@ 
      */
     public function subsection_exists($name)
     {
-        return isset($this->_subsections[ $name ]) ? true : false;
+        return isset($this->_subsections[$name]) ? true : false;
     }
 
 
@@ -433,7 +433,7 @@ 
         if ($require_construction_to_be_finalized) {
             $this->ensure_construct_finalized_called();
         }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+        return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
     }
 
 
@@ -448,7 +448,7 @@ 
         $validatable_subsections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
+                $validatable_subsections[$name] = $obj;
             }
         }
         return $validatable_subsections;
@@ -475,7 +475,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Input_Base) {
+        if ( ! $subsection instanceof EE_Form_Input_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -512,7 +512,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
+        if ( ! $subsection instanceof EE_Form_Section_Proper) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -551,7 +551,7 @@ 
      */
     public function is_valid()
     {
-        if (! $this->has_received_submission()) {
+        if ( ! $this->has_received_submission()) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -561,14 +561,14 @@ 
                 )
             );
         }
-        if (! parent::is_valid()) {
+        if ( ! parent::is_valid()) {
             return false;
         }
         // ok so no general errors to this entire form section.
         // so let's check the subsections, but only set errors if that hasn't been done yet
         $set_submission_errors = $this->submission_error_message() === '';
         foreach ($this->get_validatable_subsections() as $subsection) {
-            if (! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
+            if ( ! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
                 if ($set_submission_errors) {
                     $this->set_submission_error_message(
                         $subsection->get_validation_error_string()
@@ -588,7 +588,7 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
+        if ( ! $this->_name) {
             $classname    = get_class($this);
             $default_name = str_replace('EE_', '', $classname);
             $this->_name  = $default_name;
@@ -678,7 +678,7 @@ 
     {
         wp_register_script(
             'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
+            EE_GLOBAL_ASSETS_URL.'scripts'.DS.'form_section_validation.js',
             array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -722,13 +722,13 @@ 
         // we only want to localize vars ONCE for the entire form,
         // so if the form section doesn't have a parent, then it must be the top dog
         if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+            EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
                 'form_section_id'  => $this->html_id(true),
                 'validation_rules' => $this->get_jquery_validation_rules(),
                 'other_data'       => $this->get_other_js_data(),
                 'errors'           => $this->subsection_validation_errors_by_html_name(),
             );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
+            EE_Form_Section_Proper::$_scripts_localized = true;
         }
     }
 
@@ -763,7 +763,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
+                $inputs[$subsection->html_name()] = $subsection;
             } elseif ($subsection instanceof EE_Form_Section_Proper) {
                 $inputs += $subsection->inputs_in_subsections();
             }
@@ -786,7 +786,7 @@ 
         $errors = array();
         foreach ($inputs as $form_input) {
             if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+                $errors[$form_input->html_name()] = $form_input->get_validation_error_string();
             }
         }
         return $errors;
@@ -809,7 +809,7 @@ 
         $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
             ? EE_Registry::instance()->CFG->registration->email_validation_level
             : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+        EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
         wp_enqueue_script('ee_form_section_validation');
         wp_localize_script(
             'ee_form_section_validation',
@@ -826,7 +826,7 @@ 
      */
     public function ensure_scripts_localized()
     {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
+        if ( ! EE_Form_Section_Proper::$_scripts_localized) {
             $this->_enqueue_and_localize_form_js();
         }
     }
@@ -920,8 +920,8 @@ 
     protected function _validate()
     {
         foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+            if (method_exists($this, '_validate_'.$subsection_name)) {
+                call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
             }
             $subsection->_validate();
         }
@@ -939,9 +939,9 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
+                $inputs[$subsection_name] = $subsection->valid_data();
             } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
+                $inputs[$subsection_name] = $subsection->normalized_value();
             }
         }
         return $inputs;
@@ -959,7 +959,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
+                $inputs[$subsection_name] = $subsection;
             }
         }
         return $inputs;
@@ -977,7 +977,7 @@ 
         $form_sections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
+                $form_sections[$name] = $obj;
             }
         }
         return $form_sections;
@@ -1074,7 +1074,7 @@ 
         $input_values = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
+                $input_values[$subsection_name] = $pretty
                     ? $subsection->pretty_value()
                     : $subsection->normalized_value();
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
@@ -1086,7 +1086,7 @@ 
                 if ($flatten) {
                     $input_values = array_merge($input_values, $subform_input_values);
                 } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
+                    $input_values[$subsection_name] = $subform_input_values;
                 }
             }
         }
@@ -1114,7 +1114,7 @@ 
             if ($subsection instanceof EE_Form_Input_Base) {
                 // is this input part of an array of inputs?
                 if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
+                    $full_input_name = EEH_Array::convert_array_values_to_keys(
                         explode(
                             '[',
                             str_replace(']', '', $subsection->html_name())
@@ -1123,7 +1123,7 @@ 
                     );
                     $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
                 } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+                    $submitted_values[$subsection->html_name()] = $subsection->raw_value();
                 }
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
                 $subform_input_values = $subsection->submitted_values($include_subforms);
@@ -1158,7 +1158,7 @@ 
     public function exclude(array $inputs_to_exclude = array())
     {
         foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
+            unset($this->_subsections[$input_to_exclude_name]);
         }
     }
 
@@ -1200,7 +1200,7 @@ 
     public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
     {
         foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
+            if ( ! $subsection instanceof EE_Form_Section_Base) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -1212,7 +1212,7 @@ 
                         $this->name()
                     )
                 );
-                unset($new_subsections[ $subsection_name ]);
+                unset($new_subsections[$subsection_name]);
             }
         }
         $this->_subsections = EEH_Array::insert_into_array(
@@ -1294,7 +1294,7 @@ 
     public function html_name_prefix()
     {
         if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+            return $this->parent_section()->html_name_prefix().'['.$this->name().']';
         }
         return $this->name();
     }
@@ -1334,7 +1334,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }

core/libraries/messages/EE_Messages_Queue.lib.php

Indentation +689 added lines, -689 removed lines

@@ -2,7 +2,7 @@ 
 use \EventEspresso\core\exceptions\SendMessageException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -18,693 +18,693 @@ 
 {
 
 
-    /**
-     * @type    string  reference for sending action
-     */
-    const action_sending = 'sending';
-
-    /**
-     * @type    string  reference for generation action
-     */
-    const action_generating = 'generation';
-
-
-    /**
-     * @type EE_Message_Repository $_message_repository
-     */
-    protected $_message_repository;
-
-    /**
-     * Sets the limit of how many messages are generated per process.
-     *
-     * @type int
-     */
-    protected $_batch_count;
-
-
-    /**
-     * This is an array of cached queue items being stored in this object.
-     * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
-     * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
-     *
-     * @type EE_Message[]
-     */
-    protected $_cached_queue_items;
-
-    /**
-     * Tracks the number of unsaved queue items.
-     *
-     * @type int
-     */
-    protected $_unsaved_count = 0;
-
-    /**
-     * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
-     * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
-     *
-     * @type array
-     */
-    protected $_did_hook = array();
-
-
-    /**
-     * Constructor.
-     * Setup all the initial properties and load a EE_Message_Repository.
-     *
-     * @param \EE_Message_Repository $message_repository
-     */
-    public function __construct(EE_Message_Repository $message_repository)
-    {
-        $this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
-        $this->_message_repository = $message_repository;
-    }
-
-
-    /**
-     * Add a EE_Message object to the queue
-     *
-     * @param EE_Message $message
-     * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
-     *                                 object is persisted, this data will be saved on an extra_meta object related to
-     *                                 EE_Message.
-     * @param  bool      $preview      Whether this EE_Message represents a preview or not.
-     * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
-     *                                 use the messenger send method but typically is based on preview data.
-     * @return bool          Whether the message was successfully added to the repository or not.
-     */
-    public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
-    {
-        $data['preview']   = $preview;
-        $data['test_send'] = $test_send;
-        return $this->_message_repository->add($message, $data);
-    }
-
-
-    /**
-     * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
-     *
-     * @param EE_Message $message The message to detach from the queue
-     * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
-     * @return bool
-     */
-    public function remove(EE_Message $message, $persist = false)
-    {
-        if ($persist && $this->_message_repository->current() !== $message) {
-            //get pointer on right message
-            if ($this->_message_repository->has($message)) {
-                $this->_message_repository->rewind();
-                while ($this->_message_repository->valid()) {
-                    if ($this->_message_repository->current() === $message) {
-                        break;
-                    }
-                    $this->_message_repository->next();
-                }
-            } else {
-                return false;
-            }
-        }
-        return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
-    }
-
-
-    /**
-     * Persists all queued EE_Message objects to the db.
-     *
-     * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
-     * @return array @see EE_Messages_Repository::saveAll() for return values.
-     */
-    public function save($do_hooks_only = false)
-    {
-        return $this->_message_repository->saveAll($do_hooks_only);
-    }
-
-
-    /**
-     * @return EE_Message_Repository
-     */
-    public function get_message_repository()
-    {
-        return $this->_message_repository;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
-     * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
-     * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
-     * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
-     * removed.
-     *
-     * @return bool  true if successfully retrieved batch, false no batch ready.
-     */
-    public function get_batch_to_generate()
-    {
-        if ($this->is_locked(EE_Messages_Queue::action_generating)) {
-            return false;
-        }
-
-        //lock batch generation to prevent race conditions.
-        $this->lock_queue(EE_Messages_Queue::action_generating);
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => EEM_Message::status_incomplete),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $this->_batch_count,
-        );
-        $messages   = EEM_Message::instance()->get_all($query_args);
-
-        if ( ! $messages) {
-            return false; //nothing to generate
-        }
-
-        foreach ($messages as $message) {
-            if ($message instanceof EE_Message) {
-                $data = $message->all_extra_meta_array();
-                $this->add($message, $data);
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This does the following things:
-     * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
-     * false).
-     * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
-     * return false.
-     * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
-     * 3. On success or unsuccessful send, sets status appropriately.
-     * 4. Saves messages via the queue
-     * 5. Releases lock.
-     *
-     * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
-     *               necessarily mean that all messages were successfully sent.  It just means that this method
-     *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
-     *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
-     *               will also have a saved error message on it to assist with notifying user.
-     */
-    public function get_to_send_batch_and_send()
-    {
-        $rate_limit = $this->get_rate_limit();
-        if ($rate_limit < 1 || $this->is_locked(EE_Messages_Queue::action_sending)) {
-            return false;
-        }
-
-        $this->lock_queue(EE_Messages_Queue::action_sending);
-
-        $batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
-
-        $query_args = array(
-            // key 0 = where conditions
-            0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
-            'order_by' => $this->_get_priority_orderby(),
-            'limit'    => $batch,
-        );
-
-        $messages_to_send = EEM_Message::instance()->get_all($query_args);
-
-
-        //any to send?
-        if ( ! $messages_to_send) {
-            $this->unlock_queue(EE_Messages_Queue::action_sending);
-            return false;
-        }
-
-        $queue_count = 0;
-
-        //add to queue.
-        foreach ($messages_to_send as $message) {
-            if ($message instanceof EE_Message) {
-                $queue_count++;
-                $this->add($message);
-            }
-        }
-
-        //send messages  (this also updates the rate limit)
-        $this->execute();
-
-        //release lock
-        $this->unlock_queue(EE_Messages_Queue::action_sending);
-        //update rate limit
-        $this->set_rate_limit($queue_count);
-        return true;
-    }
-
-
-    /**
-     * Locks the queue so that no other queues can call the "batch" methods.
-     *
-     * @param   string $type The type of queue being locked.
-     */
-    public function lock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
-    }
-
-
-    /**
-     * Unlocks the queue so that batch methods can be used.
-     *
-     * @param   string $type The type of queue being unlocked.
-     */
-    public function unlock_queue($type = EE_Messages_Queue::action_generating)
-    {
-        delete_option($this->_get_lock_key($type));
-    }
-
-
-    /**
-     * Retrieve the key used for the lock transient.
-     *
-     * @param string $type The type of lock.
-     * @return string
-     */
-    protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
-    {
-        return '_ee_lock_' . $type;
-    }
-
-
-    /**
-     * Retrieve the expiry time for the lock transient.
-     *
-     * @param string $type The type of lock
-     * @return int   time to expiry in seconds.
-     */
-    protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
-    }
-
-
-    /**
-     * Returns the key used for rate limit transient.
-     *
-     * @return string
-     */
-    protected function _get_rate_limit_key()
-    {
-        return '_ee_rate_limit';
-    }
-
-
-    /**
-     * Returns the rate limit expiry time.
-     *
-     * @return int
-     */
-    protected function _get_rate_limit_expiry()
-    {
-        return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
-    }
-
-
-    /**
-     * Returns the default rate limit for sending messages.
-     *
-     * @return int
-     */
-    protected function _default_rate_limit()
-    {
-        return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
-    }
-
-
-    /**
-     * Return the orderby array for priority.
-     *
-     * @return array
-     */
-    protected function _get_priority_orderby()
-    {
-        return array(
-            'MSG_priority' => 'ASC',
-            'MSG_modified' => 'DESC',
-        );
-    }
-
-
-    /**
-     * Returns whether batch methods are "locked" or not.
-     *
-     * @param  string $type The type of lock being checked for.
-     * @return bool
-     */
-    public function is_locked($type = EE_Messages_Queue::action_generating)
-    {
-        $lock = (int) get_option($this->_get_lock_key($type), 0);
-        /**
-         * This filters the default is_locked behaviour.
-         */
-        $is_locked = filter_var(
-            apply_filters(
-                'FHEE__EE_Messages_Queue__is_locked',
-                $lock > time(),
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-
-        /**
-         * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
-         *            Also implemented here because messages processed on the same request should not have any locks applied.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $is_locked = false;
-        }
-
-
-        return $is_locked;
-    }
-
-
-    /**
-     * Retrieves the rate limit that may be cached as a transient.
-     * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
-     *
-     * @param bool $return_expiry  If true then return the expiry time not the rate_limit.
-     * @return int
-     */
-    protected function get_rate_limit($return_expiry = false)
-    {
-        $stored_rate_info = get_option($this->_get_rate_limit_key(), array());
-        $rate_limit = isset($stored_rate_info[0])
-            ? (int) $stored_rate_info[0]
-            : 0;
-        $expiry = isset($stored_rate_info[1])
-            ? (int) $stored_rate_info[1]
-            : 0;
-        //set the default for tracking?
-        if (empty($stored_rate_info) || time() > $expiry) {
-            $expiry = $this->_get_rate_limit_expiry();
-            $rate_limit = $this->_default_rate_limit();
-            update_option($this->_get_rate_limit_key(), array($rate_limit, $expiry));
-        }
-        return $return_expiry ? $expiry : $rate_limit;
-    }
-
-
-    /**
-     * This updates existing rate limit with the new limit which is the old minus the batch.
-     *
-     * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
-     */
-    protected function set_rate_limit($batch_completed)
-    {
-        //first get the most up to date rate limit (in case its expired and reset)
-        $rate_limit = $this->get_rate_limit();
-        $expiry = $this->get_rate_limit(true);
-        $new_limit  = $rate_limit - $batch_completed;
-        //updating the transient option directly to avoid resetting the expiry.
-
-        update_option($this->_get_rate_limit_key(), array($new_limit, $expiry));
-    }
-
-
-    /**
-     * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
-     * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
-     * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
-     * request running on a queue for the given task.
-     *
-     * @param string $task     This indicates what type of request is going to be initiated.
-     * @param int    $priority This indicates the priority that triggers initiating the request.
-     */
-    public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
-    {
-        //determine what status is matched with the priority as part of the trigger conditions.
-        $status = $task == 'generate'
-            ? EEM_Message::status_incomplete
-            : EEM_Message::instance()->stati_indicating_to_send();
-        // always make sure we save because either this will get executed immediately on a separate request
-        // or remains in the queue for the regularly scheduled queue batch.
-        $this->save();
-        /**
-         * This filter/option allows users to override processing of messages on separate requests and instead have everything
-         * happen on the same request.  If this is utilized remember:
-         * - message priorities don't matter
-         * - existing unprocessed messages in the queue will not get processed unless manually triggered.
-         * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
-         *   processing happening on the same request.
-         * - any race condition protection (locks) are removed because they don't apply when things are processed on
-         *   the same request.
-         */
-        if (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
-            if ($messages_processor instanceof EE_Messages_Processor) {
-                return $messages_processor->process_immediately_from_queue($this);
-            }
-            //if we get here then that means the messages processor couldn't be loaded so messages will just remain
-            //queued for manual triggering by end user.
-        }
-
-        if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
-            EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
-        }
-    }
-
-
-    /**
-     *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
-     *
-     * @param   bool     $save                    Used to indicate whether to save the message queue after sending
-     *                                            (default will save).
-     * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
-     *                                            what is on the EE_Message object in the queue.
-     *                                            For instance, showing the browser view of an email message,
-     *                                            or giving a pdf generated view of an html document.
-     *                                            This should be an instance of EE_messenger but if you call this
-     *                                            method
-     *                                            intending it to be a sending messenger but a valid one could not be
-     *                                            retrieved then send in an instance of EE_Error that contains the
-     *                                            related error message.
-     * @param   bool|int $by_priority             When set, this indicates that only messages
-     *                                            matching the given priority should be executed.
-     * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
-     *                                            Also, if the messenger is an request type messenger (or a preview),
-     *                                            its entirely possible that the messenger will exit before
-     */
-    public function execute($save = true, $sending_messenger = null, $by_priority = false)
-    {
-        $messages_sent   = 0;
-        $this->_did_hook = array();
-        $this->_message_repository->rewind();
-
-        while ($this->_message_repository->valid()) {
-            $error_messages = array();
-            /** @type EE_Message $message */
-            $message = $this->_message_repository->current();
-            //only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
-                $this->_message_repository->next();
-                continue;
-            }
-            //if $by_priority is set and does not match then continue;
-            if ($by_priority && $by_priority != $message->priority()) {
-                $this->_message_repository->next();
-                continue;
-            }
-            //error checking
-            if (! $message->valid_messenger()) {
-                $error_messages[] = sprintf(
-                    __('The %s messenger is not active at time of sending.', 'event_espresso'),
-                    $message->messenger()
-                );
-            }
-            if (! $message->valid_message_type()) {
-                $error_messages[] = sprintf(
-                    __('The %s message type is not active at the time of sending.', 'event_espresso'),
-                    $message->message_type()
-                );
-            }
-            // if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
-            // then it will instead be an EE_Error object, so let's check for that
-            if ($sending_messenger instanceof EE_Error) {
-                $error_messages[] = $sending_messenger->getMessage();
-            }
-            // if there are no errors, then let's process the message
-            if (empty($error_messages)) {
-                if ($save) {
-                    $message->set_messenger_is_executing();
-                }
-                if ($this->_process_message($message, $sending_messenger)) {
-                    $messages_sent++;
-                }
-            }
-            $this->_set_error_message($message, $error_messages);
-            //add modified time
-            $message->set_modified(time());
-            //we save each message after its processed to make sure its status persists in case PHP times-out or runs
-            //out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
-            if ($save) {
-                $message->save();
-            }
-
-            $this->_message_repository->next();
-        }
-        if ($save) {
-            $this->save(true);
-        }
-        return $messages_sent;
-    }
-
-
-    /**
-     * _process_message
-     *
-     * @param EE_Message $message
-     * @param mixed      $sending_messenger (optional)
-     * @return bool
-     */
-    protected function _process_message(EE_Message $message, $sending_messenger = null)
-    {
-        // these *should* have been validated in the execute() method above
-        $messenger    = $message->messenger_object();
-        $message_type = $message->message_type_object();
-        //do actions for sending messenger if it differs from generating messenger and swap values.
-        if (
-            $sending_messenger instanceof EE_messenger
-            && $messenger instanceof EE_messenger
-            && $sending_messenger->name != $messenger->name
-        ) {
-            $messenger->do_secondary_messenger_hooks($sending_messenger->name);
-            $messenger = $sending_messenger;
-        }
-        // send using messenger, but double check objects
-        if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
-            //set hook for message type (but only if not using another messenger to send).
-            if ( ! isset($this->_did_hook[$message_type->name])) {
-                $message_type->do_messenger_hooks($messenger);
-                $this->_did_hook[$message_type->name] = 1;
-            }
-            //if preview then use preview method
-            return $this->_message_repository->is_preview()
-                ? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
-                : $this->_do_send($message, $messenger, $message_type);
-        }
-        return false;
-    }
-
-
-    /**
-     * The intention of this method is to count how many EE_Message objects
-     * are in the queue with a given status.
-     * Example usage:
-     * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
-     * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
-     *
-     * @param array|string $status Stati to check for in queue
-     * @return int  Count of EE_Message's matching the given status.
-     */
-    public function count_STS_in_queue($status)
-    {
-        $count  = 0;
-        $status = is_array($status) ? $status : array($status);
-        $this->_message_repository->rewind();
-        foreach ($this->_message_repository as $message) {
-            if (in_array($message->STS_ID(), $status)) {
-                $count++;
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Executes the get_preview method on the provided messenger.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param                 $test_send
-     * @return bool   true means all went well, false means, not so much.
-     */
-    protected function _do_preview(
-        EE_Message $message,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $test_send
-    ) {
-        if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
-            if ( ! $test_send) {
-                $message->set_content($preview);
-            }
-            $message->set_STS_ID(EEM_Message::status_sent);
-            return true;
-        } else {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            return false;
-        }
-    }
-
-
-    /**
-     * Executes the send method on the provided messenger
-     * EE_Messengers are expected to:
-     * - return true if the send was successful.
-     * - return false if the send was unsuccessful but can be tried again.
-     * - throw an Exception if the send was unsuccessful and cannot be tried again.
-     *
-     * @param EE_Message      $message
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @return bool true means all went well, false means, not so much.
-     */
-    protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
-    {
-        try {
-            if ($messenger->send_message($message, $message_type)) {
-                $message->set_STS_ID(EEM_Message::status_sent);
-                return true;
-            } else {
-                $message->set_STS_ID(EEM_Message::status_retry);
-                return false;
-            }
-        } catch (SendMessageException $e) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message($e->getMessage());
-            return false;
-        }
-    }
-
-
-    /**
-     * This sets any necessary error messages on the message object and its status to failed.
-     *
-     * @param EE_Message $message
-     * @param array      $error_messages the response from the messenger.
-     */
-    protected function _set_error_message(EE_Message $message, $error_messages)
-    {
-        $error_messages = (array)$error_messages;
-        if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
-            $notices          = EE_Error::has_notices();
-            $error_messages[] = __(
-                'Messenger and Message Type were valid and active, but the messenger send method failed.',
-                'event_espresso'
-            );
-            if ($notices === 1) {
-                $notices           = EE_Error::get_vanilla_notices();
-                $notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
-                $error_messages[]  = implode("\n", $notices['errors']);
-            }
-        }
-        if (count($error_messages) > 0) {
-            $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
-            $message->set_error_message($msg);
-        }
-    }
+	/**
+	 * @type    string  reference for sending action
+	 */
+	const action_sending = 'sending';
+
+	/**
+	 * @type    string  reference for generation action
+	 */
+	const action_generating = 'generation';
+
+
+	/**
+	 * @type EE_Message_Repository $_message_repository
+	 */
+	protected $_message_repository;
+
+	/**
+	 * Sets the limit of how many messages are generated per process.
+	 *
+	 * @type int
+	 */
+	protected $_batch_count;
+
+
+	/**
+	 * This is an array of cached queue items being stored in this object.
+	 * The array keys will be the ID of the EE_Message in the db if saved.  If the EE_Message
+	 * is not saved to the db then its key will be an increment of "UNS" (i.e. UNS1, UNS2 etc.)
+	 *
+	 * @type EE_Message[]
+	 */
+	protected $_cached_queue_items;
+
+	/**
+	 * Tracks the number of unsaved queue items.
+	 *
+	 * @type int
+	 */
+	protected $_unsaved_count = 0;
+
+	/**
+	 * used to record if a do_messenger_hooks has already been called for a message type.  This prevents multiple
+	 * hooks getting fired if users have setup their action/filter hooks to prevent duplicate calls.
+	 *
+	 * @type array
+	 */
+	protected $_did_hook = array();
+
+
+	/**
+	 * Constructor.
+	 * Setup all the initial properties and load a EE_Message_Repository.
+	 *
+	 * @param \EE_Message_Repository $message_repository
+	 */
+	public function __construct(EE_Message_Repository $message_repository)
+	{
+		$this->_batch_count        = apply_filters('FHEE__EE_Messages_Queue___batch_count', 50);
+		$this->_message_repository = $message_repository;
+	}
+
+
+	/**
+	 * Add a EE_Message object to the queue
+	 *
+	 * @param EE_Message $message
+	 * @param array      $data         This will be an array of data to attach to the object in the repository.  If the
+	 *                                 object is persisted, this data will be saved on an extra_meta object related to
+	 *                                 EE_Message.
+	 * @param  bool      $preview      Whether this EE_Message represents a preview or not.
+	 * @param  bool      $test_send    This indicates whether to do a test send instead of actual send. A test send will
+	 *                                 use the messenger send method but typically is based on preview data.
+	 * @return bool          Whether the message was successfully added to the repository or not.
+	 */
+	public function add(EE_Message $message, $data = array(), $preview = false, $test_send = false)
+	{
+		$data['preview']   = $preview;
+		$data['test_send'] = $test_send;
+		return $this->_message_repository->add($message, $data);
+	}
+
+
+	/**
+	 * Removes EE_Message from _queue that matches the given EE_Message if the pointer is on a matching EE_Message
+	 *
+	 * @param EE_Message $message The message to detach from the queue
+	 * @param bool       $persist This flag indicates whether to attempt to delete the object from the db as well.
+	 * @return bool
+	 */
+	public function remove(EE_Message $message, $persist = false)
+	{
+		if ($persist && $this->_message_repository->current() !== $message) {
+			//get pointer on right message
+			if ($this->_message_repository->has($message)) {
+				$this->_message_repository->rewind();
+				while ($this->_message_repository->valid()) {
+					if ($this->_message_repository->current() === $message) {
+						break;
+					}
+					$this->_message_repository->next();
+				}
+			} else {
+				return false;
+			}
+		}
+		return $persist ? $this->_message_repository->delete() : $this->_message_repository->remove($message);
+	}
+
+
+	/**
+	 * Persists all queued EE_Message objects to the db.
+	 *
+	 * @param bool $do_hooks_only       @see EE_Message_Repository::saveAll
+	 * @return array @see EE_Messages_Repository::saveAll() for return values.
+	 */
+	public function save($do_hooks_only = false)
+	{
+		return $this->_message_repository->saveAll($do_hooks_only);
+	}
+
+
+	/**
+	 * @return EE_Message_Repository
+	 */
+	public function get_message_repository()
+	{
+		return $this->_message_repository;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on generation (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. If no lock, sets lock, then retrieves a batch of non-generated EE_Message objects and adds to queue
+	 * 3. Returns bool.  True = batch ready.  False = no batch ready (or nothing available for generation).
+	 * Note: Callers should make sure they release the lock otherwise batch generation will be prevented from
+	 * continuing. The lock is on a transient that is set to expire after one hour as a fallback in case locks are not
+	 * removed.
+	 *
+	 * @return bool  true if successfully retrieved batch, false no batch ready.
+	 */
+	public function get_batch_to_generate()
+	{
+		if ($this->is_locked(EE_Messages_Queue::action_generating)) {
+			return false;
+		}
+
+		//lock batch generation to prevent race conditions.
+		$this->lock_queue(EE_Messages_Queue::action_generating);
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => EEM_Message::status_incomplete),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $this->_batch_count,
+		);
+		$messages   = EEM_Message::instance()->get_all($query_args);
+
+		if ( ! $messages) {
+			return false; //nothing to generate
+		}
+
+		foreach ($messages as $message) {
+			if ($message instanceof EE_Message) {
+				$data = $message->all_extra_meta_array();
+				$this->add($message, $data);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This does the following things:
+	 * 1. Checks if there is a lock on sending (prevents race conditions).  If there is a lock then exits (return
+	 * false).
+	 * 2. Grabs the allowed number of messages to send for the rate_limit.  If cannot send any more messages, then
+	 * return false.
+	 * 2. If no lock, sets lock, then retrieves a batch of EE_Message objects, adds to queue and triggers execution.
+	 * 3. On success or unsuccessful send, sets status appropriately.
+	 * 4. Saves messages via the queue
+	 * 5. Releases lock.
+	 *
+	 * @return bool  true on success, false if something preventing sending (i.e. lock set).  Note: true does not
+	 *               necessarily mean that all messages were successfully sent.  It just means that this method
+	 *               successfully completed. On true, client may want to call $this->count_STS_in_queue(
+	 *               EEM_Message::status_failed ) to see if any failed EE_Message objects.  Each failed message object
+	 *               will also have a saved error message on it to assist with notifying user.
+	 */
+	public function get_to_send_batch_and_send()
+	{
+		$rate_limit = $this->get_rate_limit();
+		if ($rate_limit < 1 || $this->is_locked(EE_Messages_Queue::action_sending)) {
+			return false;
+		}
+
+		$this->lock_queue(EE_Messages_Queue::action_sending);
+
+		$batch = $this->_batch_count < $rate_limit ? $this->_batch_count : $rate_limit;
+
+		$query_args = array(
+			// key 0 = where conditions
+			0          => array('STS_ID' => array('IN', EEM_Message::instance()->stati_indicating_to_send())),
+			'order_by' => $this->_get_priority_orderby(),
+			'limit'    => $batch,
+		);
+
+		$messages_to_send = EEM_Message::instance()->get_all($query_args);
+
+
+		//any to send?
+		if ( ! $messages_to_send) {
+			$this->unlock_queue(EE_Messages_Queue::action_sending);
+			return false;
+		}
+
+		$queue_count = 0;
+
+		//add to queue.
+		foreach ($messages_to_send as $message) {
+			if ($message instanceof EE_Message) {
+				$queue_count++;
+				$this->add($message);
+			}
+		}
+
+		//send messages  (this also updates the rate limit)
+		$this->execute();
+
+		//release lock
+		$this->unlock_queue(EE_Messages_Queue::action_sending);
+		//update rate limit
+		$this->set_rate_limit($queue_count);
+		return true;
+	}
+
+
+	/**
+	 * Locks the queue so that no other queues can call the "batch" methods.
+	 *
+	 * @param   string $type The type of queue being locked.
+	 */
+	public function lock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		update_option($this->_get_lock_key($type), $this->_get_lock_expiry($type));
+	}
+
+
+	/**
+	 * Unlocks the queue so that batch methods can be used.
+	 *
+	 * @param   string $type The type of queue being unlocked.
+	 */
+	public function unlock_queue($type = EE_Messages_Queue::action_generating)
+	{
+		delete_option($this->_get_lock_key($type));
+	}
+
+
+	/**
+	 * Retrieve the key used for the lock transient.
+	 *
+	 * @param string $type The type of lock.
+	 * @return string
+	 */
+	protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
+	{
+		return '_ee_lock_' . $type;
+	}
+
+
+	/**
+	 * Retrieve the expiry time for the lock transient.
+	 *
+	 * @param string $type The type of lock
+	 * @return int   time to expiry in seconds.
+	 */
+	protected function _get_lock_expiry($type = EE_Messages_Queue::action_generating)
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__lock_expiry', HOUR_IN_SECONDS, $type);
+	}
+
+
+	/**
+	 * Returns the key used for rate limit transient.
+	 *
+	 * @return string
+	 */
+	protected function _get_rate_limit_key()
+	{
+		return '_ee_rate_limit';
+	}
+
+
+	/**
+	 * Returns the rate limit expiry time.
+	 *
+	 * @return int
+	 */
+	protected function _get_rate_limit_expiry()
+	{
+		return time() + (int) apply_filters('FHEE__EE_Messages_Queue__rate_limit_expiry', HOUR_IN_SECONDS);
+	}
+
+
+	/**
+	 * Returns the default rate limit for sending messages.
+	 *
+	 * @return int
+	 */
+	protected function _default_rate_limit()
+	{
+		return (int) apply_filters('FHEE__EE_Messages_Queue___rate_limit', 200);
+	}
+
+
+	/**
+	 * Return the orderby array for priority.
+	 *
+	 * @return array
+	 */
+	protected function _get_priority_orderby()
+	{
+		return array(
+			'MSG_priority' => 'ASC',
+			'MSG_modified' => 'DESC',
+		);
+	}
+
+
+	/**
+	 * Returns whether batch methods are "locked" or not.
+	 *
+	 * @param  string $type The type of lock being checked for.
+	 * @return bool
+	 */
+	public function is_locked($type = EE_Messages_Queue::action_generating)
+	{
+		$lock = (int) get_option($this->_get_lock_key($type), 0);
+		/**
+		 * This filters the default is_locked behaviour.
+		 */
+		$is_locked = filter_var(
+			apply_filters(
+				'FHEE__EE_Messages_Queue__is_locked',
+				$lock > time(),
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+
+		/**
+		 * @see usage of this filter in EE_Messages_Queue::initiate_request_by_priority() method.
+		 *            Also implemented here because messages processed on the same request should not have any locks applied.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$is_locked = false;
+		}
+
+
+		return $is_locked;
+	}
+
+
+	/**
+	 * Retrieves the rate limit that may be cached as a transient.
+	 * If the rate limit is not set, then this sets the default rate limit and expiry and returns it.
+	 *
+	 * @param bool $return_expiry  If true then return the expiry time not the rate_limit.
+	 * @return int
+	 */
+	protected function get_rate_limit($return_expiry = false)
+	{
+		$stored_rate_info = get_option($this->_get_rate_limit_key(), array());
+		$rate_limit = isset($stored_rate_info[0])
+			? (int) $stored_rate_info[0]
+			: 0;
+		$expiry = isset($stored_rate_info[1])
+			? (int) $stored_rate_info[1]
+			: 0;
+		//set the default for tracking?
+		if (empty($stored_rate_info) || time() > $expiry) {
+			$expiry = $this->_get_rate_limit_expiry();
+			$rate_limit = $this->_default_rate_limit();
+			update_option($this->_get_rate_limit_key(), array($rate_limit, $expiry));
+		}
+		return $return_expiry ? $expiry : $rate_limit;
+	}
+
+
+	/**
+	 * This updates existing rate limit with the new limit which is the old minus the batch.
+	 *
+	 * @param int $batch_completed This sets the new rate limit based on the given batch that was completed.
+	 */
+	protected function set_rate_limit($batch_completed)
+	{
+		//first get the most up to date rate limit (in case its expired and reset)
+		$rate_limit = $this->get_rate_limit();
+		$expiry = $this->get_rate_limit(true);
+		$new_limit  = $rate_limit - $batch_completed;
+		//updating the transient option directly to avoid resetting the expiry.
+
+		update_option($this->_get_rate_limit_key(), array($new_limit, $expiry));
+	}
+
+
+	/**
+	 * This method checks the queue for ANY EE_Message objects with a priority matching the given priority passed in.
+	 * If that exists, then we immediately initiate a non-blocking request to do the requested action type.
+	 * Note: Keep in mind that there is the possibility that the request will not execute if there is already another
+	 * request running on a queue for the given task.
+	 *
+	 * @param string $task     This indicates what type of request is going to be initiated.
+	 * @param int    $priority This indicates the priority that triggers initiating the request.
+	 */
+	public function initiate_request_by_priority($task = 'generate', $priority = EEM_Message::priority_high)
+	{
+		//determine what status is matched with the priority as part of the trigger conditions.
+		$status = $task == 'generate'
+			? EEM_Message::status_incomplete
+			: EEM_Message::instance()->stati_indicating_to_send();
+		// always make sure we save because either this will get executed immediately on a separate request
+		// or remains in the queue for the regularly scheduled queue batch.
+		$this->save();
+		/**
+		 * This filter/option allows users to override processing of messages on separate requests and instead have everything
+		 * happen on the same request.  If this is utilized remember:
+		 * - message priorities don't matter
+		 * - existing unprocessed messages in the queue will not get processed unless manually triggered.
+		 * - things will be perceived to take longer to happen for end users (i.e. registrations) because of the additional
+		 *   processing happening on the same request.
+		 * - any race condition protection (locks) are removed because they don't apply when things are processed on
+		 *   the same request.
+		 */
+		if (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$messages_processor = EE_Registry::instance()->load_lib('Messages_Processor');
+			if ($messages_processor instanceof EE_Messages_Processor) {
+				return $messages_processor->process_immediately_from_queue($this);
+			}
+			//if we get here then that means the messages processor couldn't be loaded so messages will just remain
+			//queued for manual triggering by end user.
+		}
+
+		if ($this->_message_repository->count_by_priority_and_status($priority, $status)) {
+			EE_Messages_Scheduler::initiate_scheduled_non_blocking_request($task);
+		}
+	}
+
+
+	/**
+	 *  Loops through the EE_Message objects in the _queue and calls the messenger send methods for each message.
+	 *
+	 * @param   bool     $save                    Used to indicate whether to save the message queue after sending
+	 *                                            (default will save).
+	 * @param   mixed    $sending_messenger       (optional) When the sending messenger is different than
+	 *                                            what is on the EE_Message object in the queue.
+	 *                                            For instance, showing the browser view of an email message,
+	 *                                            or giving a pdf generated view of an html document.
+	 *                                            This should be an instance of EE_messenger but if you call this
+	 *                                            method
+	 *                                            intending it to be a sending messenger but a valid one could not be
+	 *                                            retrieved then send in an instance of EE_Error that contains the
+	 *                                            related error message.
+	 * @param   bool|int $by_priority             When set, this indicates that only messages
+	 *                                            matching the given priority should be executed.
+	 * @return int        Number of messages sent.  Note, 0 does not mean that no messages were processed.
+	 *                                            Also, if the messenger is an request type messenger (or a preview),
+	 *                                            its entirely possible that the messenger will exit before
+	 */
+	public function execute($save = true, $sending_messenger = null, $by_priority = false)
+	{
+		$messages_sent   = 0;
+		$this->_did_hook = array();
+		$this->_message_repository->rewind();
+
+		while ($this->_message_repository->valid()) {
+			$error_messages = array();
+			/** @type EE_Message $message */
+			$message = $this->_message_repository->current();
+			//only process things that are queued for sending
+			if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+				$this->_message_repository->next();
+				continue;
+			}
+			//if $by_priority is set and does not match then continue;
+			if ($by_priority && $by_priority != $message->priority()) {
+				$this->_message_repository->next();
+				continue;
+			}
+			//error checking
+			if (! $message->valid_messenger()) {
+				$error_messages[] = sprintf(
+					__('The %s messenger is not active at time of sending.', 'event_espresso'),
+					$message->messenger()
+				);
+			}
+			if (! $message->valid_message_type()) {
+				$error_messages[] = sprintf(
+					__('The %s message type is not active at the time of sending.', 'event_espresso'),
+					$message->message_type()
+				);
+			}
+			// if there was supposed to be a sending messenger for this message, but it was invalid/inactive,
+			// then it will instead be an EE_Error object, so let's check for that
+			if ($sending_messenger instanceof EE_Error) {
+				$error_messages[] = $sending_messenger->getMessage();
+			}
+			// if there are no errors, then let's process the message
+			if (empty($error_messages)) {
+				if ($save) {
+					$message->set_messenger_is_executing();
+				}
+				if ($this->_process_message($message, $sending_messenger)) {
+					$messages_sent++;
+				}
+			}
+			$this->_set_error_message($message, $error_messages);
+			//add modified time
+			$message->set_modified(time());
+			//we save each message after its processed to make sure its status persists in case PHP times-out or runs
+			//out of memory. @see https://events.codebasehq.com/projects/event-espresso/tickets/10281
+			if ($save) {
+				$message->save();
+			}
+
+			$this->_message_repository->next();
+		}
+		if ($save) {
+			$this->save(true);
+		}
+		return $messages_sent;
+	}
+
+
+	/**
+	 * _process_message
+	 *
+	 * @param EE_Message $message
+	 * @param mixed      $sending_messenger (optional)
+	 * @return bool
+	 */
+	protected function _process_message(EE_Message $message, $sending_messenger = null)
+	{
+		// these *should* have been validated in the execute() method above
+		$messenger    = $message->messenger_object();
+		$message_type = $message->message_type_object();
+		//do actions for sending messenger if it differs from generating messenger and swap values.
+		if (
+			$sending_messenger instanceof EE_messenger
+			&& $messenger instanceof EE_messenger
+			&& $sending_messenger->name != $messenger->name
+		) {
+			$messenger->do_secondary_messenger_hooks($sending_messenger->name);
+			$messenger = $sending_messenger;
+		}
+		// send using messenger, but double check objects
+		if ($messenger instanceof EE_messenger && $message_type instanceof EE_message_type) {
+			//set hook for message type (but only if not using another messenger to send).
+			if ( ! isset($this->_did_hook[$message_type->name])) {
+				$message_type->do_messenger_hooks($messenger);
+				$this->_did_hook[$message_type->name] = 1;
+			}
+			//if preview then use preview method
+			return $this->_message_repository->is_preview()
+				? $this->_do_preview($message, $messenger, $message_type, $this->_message_repository->is_test_send())
+				: $this->_do_send($message, $messenger, $message_type);
+		}
+		return false;
+	}
+
+
+	/**
+	 * The intention of this method is to count how many EE_Message objects
+	 * are in the queue with a given status.
+	 * Example usage:
+	 * After a caller calls the "EE_Message_Queue::execute()" method, the caller can check if there were any failed
+	 * sends by calling $queue->count_STS_in_queue( EEM_Message_Queue::status_failed ).
+	 *
+	 * @param array|string $status Stati to check for in queue
+	 * @return int  Count of EE_Message's matching the given status.
+	 */
+	public function count_STS_in_queue($status)
+	{
+		$count  = 0;
+		$status = is_array($status) ? $status : array($status);
+		$this->_message_repository->rewind();
+		foreach ($this->_message_repository as $message) {
+			if (in_array($message->STS_ID(), $status)) {
+				$count++;
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Executes the get_preview method on the provided messenger.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param                 $test_send
+	 * @return bool   true means all went well, false means, not so much.
+	 */
+	protected function _do_preview(
+		EE_Message $message,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$test_send
+	) {
+		if ($preview = $messenger->get_preview($message, $message_type, $test_send)) {
+			if ( ! $test_send) {
+				$message->set_content($preview);
+			}
+			$message->set_STS_ID(EEM_Message::status_sent);
+			return true;
+		} else {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Executes the send method on the provided messenger
+	 * EE_Messengers are expected to:
+	 * - return true if the send was successful.
+	 * - return false if the send was unsuccessful but can be tried again.
+	 * - throw an Exception if the send was unsuccessful and cannot be tried again.
+	 *
+	 * @param EE_Message      $message
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @return bool true means all went well, false means, not so much.
+	 */
+	protected function _do_send(EE_Message $message, EE_messenger $messenger, EE_message_type $message_type)
+	{
+		try {
+			if ($messenger->send_message($message, $message_type)) {
+				$message->set_STS_ID(EEM_Message::status_sent);
+				return true;
+			} else {
+				$message->set_STS_ID(EEM_Message::status_retry);
+				return false;
+			}
+		} catch (SendMessageException $e) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message($e->getMessage());
+			return false;
+		}
+	}
+
+
+	/**
+	 * This sets any necessary error messages on the message object and its status to failed.
+	 *
+	 * @param EE_Message $message
+	 * @param array      $error_messages the response from the messenger.
+	 */
+	protected function _set_error_message(EE_Message $message, $error_messages)
+	{
+		$error_messages = (array)$error_messages;
+		if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
+			$notices          = EE_Error::has_notices();
+			$error_messages[] = __(
+				'Messenger and Message Type were valid and active, but the messenger send method failed.',
+				'event_espresso'
+			);
+			if ($notices === 1) {
+				$notices           = EE_Error::get_vanilla_notices();
+				$notices['errors'] = isset($notices['errors']) ? $notices['errors'] : array();
+				$error_messages[]  = implode("\n", $notices['errors']);
+			}
+		}
+		if (count($error_messages) > 0) {
+			$msg = __('Message was not executed successfully.', 'event_espresso');
+			$msg = $msg . "\n" . implode("\n", $error_messages);
+			$message->set_error_message($msg);
+		}
+	}
 
 } //end EE_Messages_Queue class

Spacing +8 added lines, -8 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 use \EventEspresso\core\exceptions\SendMessageException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -175,7 +175,7 @@ 
             'order_by' => $this->_get_priority_orderby(),
             'limit'    => $this->_batch_count,
         );
-        $messages   = EEM_Message::instance()->get_all($query_args);
+        $messages = EEM_Message::instance()->get_all($query_args);
 
         if ( ! $messages) {
             return false; //nothing to generate
@@ -286,7 +286,7 @@ 
      */
     protected function _get_lock_key($type = EE_Messages_Queue::action_generating)
     {
-        return '_ee_lock_' . $type;
+        return '_ee_lock_'.$type;
     }
 
 
@@ -506,7 +506,7 @@ 
             /** @type EE_Message $message */
             $message = $this->_message_repository->current();
             //only process things that are queued for sending
-            if (! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
+            if ( ! in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_to_send())) {
                 $this->_message_repository->next();
                 continue;
             }
@@ -516,13 +516,13 @@ 
                 continue;
             }
             //error checking
-            if (! $message->valid_messenger()) {
+            if ( ! $message->valid_messenger()) {
                 $error_messages[] = sprintf(
                     __('The %s messenger is not active at time of sending.', 'event_espresso'),
                     $message->messenger()
                 );
             }
-            if (! $message->valid_message_type()) {
+            if ( ! $message->valid_message_type()) {
                 $error_messages[] = sprintf(
                     __('The %s message type is not active at the time of sending.', 'event_espresso'),
                     $message->message_type()
@@ -687,7 +687,7 @@ 
      */
     protected function _set_error_message(EE_Message $message, $error_messages)
     {
-        $error_messages = (array)$error_messages;
+        $error_messages = (array) $error_messages;
         if (in_array($message->STS_ID(), EEM_Message::instance()->stati_indicating_failed_sending())) {
             $notices          = EE_Error::has_notices();
             $error_messages[] = __(
@@ -702,7 +702,7 @@ 
         }
         if (count($error_messages) > 0) {
             $msg = __('Message was not executed successfully.', 'event_espresso');
-            $msg = $msg . "\n" . implode("\n", $error_messages);
+            $msg = $msg."\n".implode("\n", $error_messages);
             $message->set_error_message($msg);
         }
     }