eventespresso / event-espresso-core

core/data_migration_scripts/EE_DMS_Core_4_9_0.dms.php

Spacing +5 added lines, -5 removed lines

@@ -9,12 +9,12 @@ 
 // unfortunately, this needs to be done upon INCLUSION of this file,
 // instead of construction, because it only gets constructed on first page load
 // (all other times it gets resurrected from a wordpress option)
-$stages = glob(EE_CORE . 'data_migration_scripts/4_9_0_stages/*');
+$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;
+    $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);
@@ -65,10 +65,10 @@ 
         if (version_compare($version_string, '4.9.0.decaf', '<') && version_compare($version_string, '4.8.0.decaf', '>=')) {
             //          echo "$version_string can be migrated from";
             return true;
-        } elseif (! $version_string) {
+        } 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
+            return false; // changed mind. dont want people thinking they should migrate yet because they cant
         } else {
             //          echo "$version_string doesnt apply";
             return false;
@@ -82,7 +82,7 @@ 
      */
     public function schema_changes_before_migration()
     {
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+        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,

Indentation +310 added lines, -310 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.decaf', '<') && version_compare($version_string, '4.8.0.decaf', '>=')) {
-            //          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.decaf', '<') && version_compare($version_string, '4.8.0.decaf', '>=')) {
+			//          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_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_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_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,165 +590,165 @@ 
 				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');
-        $this->insert_default_data();
-        return true;
-    }
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->insert_default_data();
+		return true;
+	}
 
-    /**
-     * Inserts default data after parent was called.
-     * @since 4.10.0.p
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function insert_default_data()
-    {
-        /** @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();
-    }
+	/**
+	 * Inserts default data after parent was called.
+	 * @since 4.10.0.p
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function insert_default_data()
+	{
+		/** @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 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);
+			}
+		}
+	}
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_invoice_settings.dmsstage.php

Spacing +2 added lines, -2 removed lines

@@ -66,8 +66,8 @@
     {
 
         $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-        $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-        $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+        $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path.'invoice_body.template.php', null, false, false, true);
+        $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path.'receipt_body.template.php', null, false, false, true);
         if ($overridden_invoice_body || $overridden_receipt_body) {
             new PersistentAdminNotice(
                 'invoice_overriding_templates',

Indentation +47 added lines, -47 removed lines

@@ -27,59 +27,59 @@
  */
 class EE_DMS_4_6_0_invoice_settings extends EE_Data_Migration_Script_Stage
 {
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = esc_html__('Update Invoice Settings', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = esc_html__('Update Invoice Settings', 'event_espresso');
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _count_records_to_migrate
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @access protected
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return 1;
-    }
+	/**
+	 * _count_records_to_migrate
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @access protected
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return 1;
+	}
 
 
 
-    /**
-     *    _migration_step
-     *
-     * @access protected
-     * @param int $num_items
-     * @throws EE_Error
-     * @return int number of items ACTUALLY migrated
-     * @throws InvalidDataTypeException
-     */
-    protected function _migration_step($num_items = 1)
-    {
+	/**
+	 *    _migration_step
+	 *
+	 * @access protected
+	 * @param int $num_items
+	 * @throws EE_Error
+	 * @return int number of items ACTUALLY migrated
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _migration_step($num_items = 1)
+	{
 
-        $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-        $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-        $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
-        if ($overridden_invoice_body || $overridden_receipt_body) {
-            new PersistentAdminNotice(
-                'invoice_overriding_templates',
-                esc_html__(
-                    'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents (but this will be removed in an upcoming version). We recommend deleting your old Invoice/Receipt templates and using the new messages system. Then modify the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
-                    'event_espresso'
-                ),
-                true
-            );
-        }
+		$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+		$overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
+		$overridden_receipt_body = EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+		if ($overridden_invoice_body || $overridden_receipt_body) {
+			new PersistentAdminNotice(
+				'invoice_overriding_templates',
+				esc_html__(
+					'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents (but this will be removed in an upcoming version). We recommend deleting your old Invoice/Receipt templates and using the new messages system. Then modify the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
+					'event_espresso'
+				),
+				true
+			);
+		}
 
-        // regardless of whether it worked or not, we ought to continue the migration
-        $this->set_completed();
-        return 1;
-    }
+		// regardless of whether it worked or not, we ought to continue the migration
+		$this->set_completed();
+		return 1;
+	}
 }

core/EE_Load_Textdomain.core.php

Spacing +9 added lines, -9 removed lines

@@ -36,19 +36,19 @@ 
     {
         EE_Load_Textdomain::loadTranslationsForLocale();
         // now load the textdomain
-        if (!empty(EE_Load_Textdomain::$locale)) {
-            $github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
+        if ( ! empty(EE_Load_Textdomain::$locale)) {
+            $github_mo_path = EE_LANGUAGES_SAFE_DIR.'event_espresso-'.EE_Load_Textdomain::$locale.'.mo';
             if (is_readable($github_mo_path)) {
                 load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
                 return;
             }
-            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
+            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR.'event-espresso-4-'.EE_Load_Textdomain::$locale.'.mo';
             if (is_readable($glotpress_mo_path)) {
                 load_textdomain('event_espresso', $glotpress_mo_path);
                 return;
             }
         }
-        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
+        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME).'/languages/');
     }
 
 
@@ -71,7 +71,7 @@ 
         if (empty(EE_Load_Textdomain::$locale)) {
             return;
         }
-        $language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
+        $language_check_option_name = 'ee_lang_check_'.EE_Load_Textdomain::$locale.'_'.EVENT_ESPRESSO_VERSION;
         // check if language files has already been sideloaded
         if (get_option($language_check_option_name)) {
             return;
@@ -81,8 +81,8 @@ 
 
         // load sideloader and sideload the .POT file as this should always be included.
         $sideloader_args = array(
-            '_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
-            '_download_from'   => $repo_base_URL . '.pot?raw=true',
+            '_upload_to'     => EE_PLUGIN_DIR_PATH.'languages/',
+            '_download_from'   => $repo_base_URL.'.pot?raw=true',
             '_new_file_name' => 'event_espresso.pot',
         );
         /** @var EEH_Sideloader $sideloader */
@@ -98,8 +98,8 @@ 
             update_option($language_check_option_name, 1);
             return;
         }
-        $repo_locale_URL = $repo_base_URL . '-' . EE_Load_Textdomain::$locale;
-        $file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
+        $repo_locale_URL = $repo_base_URL.'-'.EE_Load_Textdomain::$locale;
+        $file_name_base = 'event_espresso-'.EE_Load_Textdomain::$locale;
 
         // made it here so let's get the language files from the github repo, first the .mo file
         $sideloader->set_download_from("{$repo_locale_URL}.mo?raw=true");

Indentation +91 added lines, -91 removed lines

@@ -12,105 +12,105 @@
  */
 class EE_Load_Textdomain extends EE_Base
 {
-    /**
-     * holds the current lang in WP
-     *
-     * @var string
-     */
-    private static $locale;
+	/**
+	 * holds the current lang in WP
+	 *
+	 * @var string
+	 */
+	private static $locale;
 
 
-    /**
-     * this takes care of retrieving a matching textdomain for event espresso for the current WPLANG from EE GitHub
-     * repo (if necessary) and then loading it for translations. should only be called in wp plugins_loaded callback
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function load_textdomain()
-    {
-        EE_Load_Textdomain::loadTranslationsForLocale();
-        // now load the textdomain
-        if (!empty(EE_Load_Textdomain::$locale)) {
-            $github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
-            if (is_readable($github_mo_path)) {
-                load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
-                return;
-            }
-            $glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
-            if (is_readable($glotpress_mo_path)) {
-                load_textdomain('event_espresso', $glotpress_mo_path);
-                return;
-            }
-        }
-        load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
-    }
+	/**
+	 * this takes care of retrieving a matching textdomain for event espresso for the current WPLANG from EE GitHub
+	 * repo (if necessary) and then loading it for translations. should only be called in wp plugins_loaded callback
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function load_textdomain()
+	{
+		EE_Load_Textdomain::loadTranslationsForLocale();
+		// now load the textdomain
+		if (!empty(EE_Load_Textdomain::$locale)) {
+			$github_mo_path = EE_LANGUAGES_SAFE_DIR . 'event_espresso-' . EE_Load_Textdomain::$locale . '.mo';
+			if (is_readable($github_mo_path)) {
+				load_plugin_textdomain('event_espresso', false, EE_LANGUAGES_SAFE_LOC);
+				return;
+			}
+			$glotpress_mo_path = EE_LANGUAGES_SAFE_DIR . 'event-espresso-4-' . EE_Load_Textdomain::$locale . '.mo';
+			if (is_readable($glotpress_mo_path)) {
+				load_textdomain('event_espresso', $glotpress_mo_path);
+				return;
+			}
+		}
+		load_plugin_textdomain('event_espresso', false, dirname(EE_PLUGIN_BASENAME) . '/languages/');
+	}
 
 
-    /**
-     * The purpose of this method is to sideload all of the lang files for EE, this includes the POT file and also the PO/MO files for the given WPLANG locale (if necessary).
-     *
-     * @access private
-     * @static
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function loadTranslationsForLocale()
-    {
-        EE_Load_Textdomain::$locale = get_locale();
-        // can't download a language file if a language isn't set <taps temple>
-        if (empty(EE_Load_Textdomain::$locale)) {
-            return;
-        }
-        $language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
-        // check if language files has already been sideloaded
-        if (get_option($language_check_option_name)) {
-            return;
-        }
+	/**
+	 * The purpose of this method is to sideload all of the lang files for EE, this includes the POT file and also the PO/MO files for the given WPLANG locale (if necessary).
+	 *
+	 * @access private
+	 * @static
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function loadTranslationsForLocale()
+	{
+		EE_Load_Textdomain::$locale = get_locale();
+		// can't download a language file if a language isn't set <taps temple>
+		if (empty(EE_Load_Textdomain::$locale)) {
+			return;
+		}
+		$language_check_option_name = 'ee_lang_check_' . EE_Load_Textdomain::$locale . '_' . EVENT_ESPRESSO_VERSION;
+		// check if language files has already been sideloaded
+		if (get_option($language_check_option_name)) {
+			return;
+		}
 
-        $repo_base_URL = 'https://github.com/eventespresso/languages-ee4/blob/master/event_espresso';
+		$repo_base_URL = 'https://github.com/eventespresso/languages-ee4/blob/master/event_espresso';
 
-        // load sideloader and sideload the .POT file as this should always be included.
-        $sideloader_args = array(
-            '_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
-            '_download_from'   => $repo_base_URL . '.pot?raw=true',
-            '_new_file_name' => 'event_espresso.pot',
-        );
-        /** @var EEH_Sideloader $sideloader */
-        $sideloader = EE_Registry::instance()->load_helper('Sideloader', $sideloader_args, false);
-        // sideload the .POT file only for main site of the network, or if not running Multisite.
-        if (is_main_site()) {
-            $sideloader->sideload();
-        }
+		// load sideloader and sideload the .POT file as this should always be included.
+		$sideloader_args = array(
+			'_upload_to'     => EE_PLUGIN_DIR_PATH . 'languages/',
+			'_download_from'   => $repo_base_URL . '.pot?raw=true',
+			'_new_file_name' => 'event_espresso.pot',
+		);
+		/** @var EEH_Sideloader $sideloader */
+		$sideloader = EE_Registry::instance()->load_helper('Sideloader', $sideloader_args, false);
+		// sideload the .POT file only for main site of the network, or if not running Multisite.
+		if (is_main_site()) {
+			$sideloader->sideload();
+		}
 
-        // if locale is "en_US" then lets just get out, since Event Espresso core is already "en_US"
-        if (EE_Load_Textdomain::$locale === 'en_US') {
-            // but set option first else we'll forever be downloading the pot file
-            update_option($language_check_option_name, 1);
-            return;
-        }
-        $repo_locale_URL = $repo_base_URL . '-' . EE_Load_Textdomain::$locale;
-        $file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
+		// if locale is "en_US" then lets just get out, since Event Espresso core is already "en_US"
+		if (EE_Load_Textdomain::$locale === 'en_US') {
+			// but set option first else we'll forever be downloading the pot file
+			update_option($language_check_option_name, 1);
+			return;
+		}
+		$repo_locale_URL = $repo_base_URL . '-' . EE_Load_Textdomain::$locale;
+		$file_name_base = 'event_espresso-' . EE_Load_Textdomain::$locale;
 
-        // made it here so let's get the language files from the github repo, first the .mo file
-        $sideloader->set_download_from("{$repo_locale_URL}.mo?raw=true");
-        $sideloader->set_new_file_name("{$file_name_base}.mo");
-        $sideloader->sideload();
+		// made it here so let's get the language files from the github repo, first the .mo file
+		$sideloader->set_download_from("{$repo_locale_URL}.mo?raw=true");
+		$sideloader->set_new_file_name("{$file_name_base}.mo");
+		$sideloader->sideload();
 
-        // now the .po file:
-        $sideloader->set_download_from("{$repo_locale_URL}.po?raw=true");
-        $sideloader->set_new_file_name("{$file_name_base}.po");
-        $sideloader->sideload();
+		// now the .po file:
+		$sideloader->set_download_from("{$repo_locale_URL}.po?raw=true");
+		$sideloader->set_new_file_name("{$file_name_base}.po");
+		$sideloader->sideload();
 
-        // set option so the above only runs when EE updates.
-        update_option($language_check_option_name, 1);
-    }
+		// set option so the above only runs when EE updates.
+		update_option($language_check_option_name, 1);
+	}
 }

admin_pages/transactions/EE_Admin_Transactions_List_Table.class.php

Spacing +32 added lines, -32 removed lines

@@ -96,7 +96,7 @@ 
     {
         $class = parent::_get_row_class($transaction);
         // add status class
-        $class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
+        $class .= ' ee-status-strip txn-status-'.$transaction->status_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -149,7 +149,7 @@ 
     protected function _add_view_counts()
     {
         foreach ($this->_views as $view) {
-            $this->_views[ $view['slug'] ]['count'] = $this->_admin_page->get_transactions($this->_per_page, true, $view['slug']);
+            $this->_views[$view['slug']]['count'] = $this->_admin_page->get_transactions($this->_per_page, true, $view['slug']);
         }
     }
 
@@ -170,13 +170,13 @@ 
             ),
             TXN_ADMIN_URL
         );
-        $content = '<a href="' . $view_lnk_url . '"'
-                   . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
+        $content = '<a href="'.$view_lnk_url.'"'
+                   . ' title="'.esc_attr__('Go to Transaction Details', 'event_espresso').'">'
                    . $transaction->ID()
                    . '</a>';
 
         // txn timestamp
-        $content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$this->_get_txn_timestamp($transaction).'</span>';
         return $content;
     }
 
@@ -237,9 +237,9 @@ 
             ),
             TXN_ADMIN_URL
         );
-        $txn_date = '<a href="' . $view_lnk_url . '"'
+        $txn_date = '<a href="'.$view_lnk_url.'"'
                     . ' title="'
-                    . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
+                    . esc_attr__('View Transaction Details for TXN #', 'event_espresso').$transaction->ID().'">'
                     . $this->_get_txn_timestamp($transaction)
                     . '</a>';
         // status
@@ -272,7 +272,7 @@ 
                    )
                    . '</span>';
         } else {
-            return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
+            return '<span class="txn-overview-free-event-spn">'.esc_html__('free', 'event_espresso').'</span>';
         }
     }
 
@@ -309,7 +309,7 @@ 
             ? $payment_method->admin_name()
             : esc_html__('Unknown', 'event_espresso');
 
-        $content = '<span class="' . $span_class . ' txn-pad-rght">'
+        $content = '<span class="'.$span_class.' txn-pad-rght">'
                    . $transaction->get_pretty('TXN_paid')
                    . '</span>';
         if ($transaction_paid > 0) {
@@ -351,12 +351,12 @@ 
                 'espresso_registrations_view_registration',
                 $primary_reg->ID()
             )
-                ? '<a href="' . $edit_lnk_url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+                ? '<a href="'.$edit_lnk_url.'"'
+                  . ' title="'.esc_attr__('View Registration Details', 'event_espresso').'">'
                   . $attendee->full_name()
                   . '</a>'
                 : $attendee->full_name();
-            $content .= '<br>' . $attendee->email();
+            $content .= '<br>'.$attendee->email();
             return $content;
         }
         return $transaction->failed() || $transaction->is_abandoned()
@@ -378,8 +378,8 @@ 
     public function column_ATT_email(EE_Transaction $transaction)
     {
         $attendee = $transaction->primary_registration()->get_first_related('Attendee');
-        if (! empty($attendee)) {
-            return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
+        if ( ! empty($attendee)) {
+            return '<a href="mailto:'.$attendee->get('ATT_email').'">'
                    . $attendee->get('ATT_email')
                    . '</a>';
         } else {
@@ -407,7 +407,7 @@ 
     {
         $actions = array();
         $event = $transaction->primary_registration()->get_first_related('Event');
-        if (! empty($event)) {
+        if ( ! empty($event)) {
             $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
                 array('action' => 'edit', 'post' => $event->ID()),
                 EVENTS_ADMIN_URL
@@ -429,11 +429,11 @@ 
                     $event->ID()
                 )
             ) {
-                $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
-                                              . ' title="' . esc_attr__(
+                $actions['filter_by_event'] = '<a href="'.$txn_by_event_lnk.'"'
+                                              . ' title="'.esc_attr__(
                                                   'Filter transactions by this event',
                                                   'event_espresso'
-                                              ) . '">'
+                                              ).'">'
                                               . esc_html__('View Transactions for this event', 'event_espresso')
                                               . '</a>';
             }
@@ -445,7 +445,7 @@ 
                     'espresso_events_edit',
                     $event->ID()
                 )
-                    ? '<a href="' . $edit_event_url . '"'
+                    ? '<a href="'.$edit_event_url.'"'
                       . ' title="'
                       . sprintf(
                           esc_attr__('Edit Event: %s', 'event_espresso'),
@@ -512,8 +512,8 @@ 
         );
         return '
 			<li>
-				<a href="' . $url . '"'
-               . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
+				<a href="' . $url.'"'
+               . ' title="'.esc_attr__('View Transaction Details', 'event_espresso').'" class="tiny-text">
 					<span class="dashicons dashicons-cart"></span>
 				</a>
 			</li>';
@@ -539,8 +539,8 @@ 
             ) {
                 return '
                 <li>
-                    <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+                    <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso').'"'
+                       . ' target="_blank" href="'.$url.'" class="tiny-text">
                         <span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
                     </a>
                 </li>';
@@ -569,8 +569,8 @@ 
             ) {
                 return '
 			<li>
-				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso').'"'
+                       . ' target="_blank" href="'.$url.'" class="tiny-text">
 					<span class="dashicons dashicons-media-default ee-icon-size-18"></span>
 				</a>
 			</li>';
@@ -608,8 +608,8 @@ 
             )
                 ? '
 				<li>
-					<a href="' . $url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
+					<a href="' . $url.'"'
+                  . ' title="'.esc_attr__('View Registration Details', 'event_espresso').'" class="tiny-text">
 						<span class="dashicons dashicons-clipboard"></span>
 					</a>
 				</li>'
@@ -655,8 +655,8 @@ 
             );
             return '
             <li>
-                <a href="' . $url . '"'
-                   . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
+                <a href="' . $url.'"'
+                   . ' title="'.esc_attr__('Send Payment Reminder', 'event_espresso').'" class="tiny-text">
                     <span class="dashicons dashicons-email-alt"></span>
                 </a>
             </li>';
@@ -686,7 +686,7 @@ 
             'ee_read_global_messages',
             'view_filtered_messages'
         )
-            ? '<li>' . $url . '</li>'
+            ? '<li>'.$url.'</li>'
             : '';
     }
 
@@ -708,8 +708,8 @@ 
         ) {
             return '
             <li>
-                <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso') . '"'
-                   . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
+                <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso').'"'
+                   . ' target="_blank" href="'.$registration->payment_overview_url(true).'"'
                    . ' class="tiny-text">
                     <span class="dashicons dashicons-money ee-icon-size-18"></span>
                 </a>

Indentation +665 added lines, -665 removed lines

@@ -14,121 +14,121 @@ 
  */
 class EE_Admin_Transactions_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    private $_status;
-
-
-    /**
-     * @param \Transactions_Admin_Page $admin_page
-     * @param SessionLifespan          $lifespan
-     */
-    public function __construct(\Transactions_Admin_Page $admin_page, SessionLifespan $lifespan)
-    {
-        parent::__construct($admin_page);
-        $this->session_lifespan = $lifespan;
-        $this->_status = $this->_admin_page->get_transaction_status_array();
-    }
-
-
-    /**
-     *_setup_data
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_transactions($this->_per_page);
-        $status = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all';
-        $this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status);
-    }
-
-
-    /**
-     *_set_properties
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('transaction', 'event_espresso'),
-            'plural'   => esc_html__('transactions', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $ID_column_name = esc_html__('ID', 'event_espresso');
-        $ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">';
-        $ID_column_name .= esc_html__('Transaction Date', 'event_espresso');
-        $ID_column_name .= '</span> ';
-        $this->_columns = array(
-            'TXN_ID'        => $ID_column_name,
-            'TXN_timestamp' => esc_html__('Transaction Date', 'event_espresso'),
-            'TXN_total'     => esc_html__('Total', 'event_espresso'),
-            'TXN_paid'      => esc_html__('Paid', 'event_espresso'),
-            'ATT_fname'     => esc_html__('Primary Registrant', 'event_espresso'),
-            'event_name'    => esc_html__('Event', 'event_espresso'),
-            'actions'       => esc_html__('Actions', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'TXN_ID'        => array('TXN_ID' => false),
-            'event_name'    => array('event_name' => false),
-            'ATT_fname'     => array('ATT_fname' => false),
-            'TXN_timestamp' => array('TXN_timestamp' => true) // true means its already sorted
-        );
-
-        $this->_primary_column = 'TXN_ID';
-
-        $this->_hidden_columns = array();
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  EE_Transaction $transaction the current item
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_row_class($transaction)
-    {
-        $class = parent::_get_row_class($transaction);
-        // add status class
-        $class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-        $start_date = isset($this->_req_data['txn-filter-start-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
-            : date(
-                'm/d/Y',
-                strtotime('-10 year')
-            );
-        $end_date = isset($this->_req_data['txn-filter-end-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
-            : date(
-                'm/d/Y',
-                current_time('timestamp')
-            );
-        ob_start();
-        ?>
+	/**
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	private $_status;
+
+
+	/**
+	 * @param \Transactions_Admin_Page $admin_page
+	 * @param SessionLifespan          $lifespan
+	 */
+	public function __construct(\Transactions_Admin_Page $admin_page, SessionLifespan $lifespan)
+	{
+		parent::__construct($admin_page);
+		$this->session_lifespan = $lifespan;
+		$this->_status = $this->_admin_page->get_transaction_status_array();
+	}
+
+
+	/**
+	 *_setup_data
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_transactions($this->_per_page);
+		$status = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all';
+		$this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status);
+	}
+
+
+	/**
+	 *_set_properties
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('transaction', 'event_espresso'),
+			'plural'   => esc_html__('transactions', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$ID_column_name = esc_html__('ID', 'event_espresso');
+		$ID_column_name .= ' : <span class="show-on-mobile-view-only" style="float:none">';
+		$ID_column_name .= esc_html__('Transaction Date', 'event_espresso');
+		$ID_column_name .= '</span> ';
+		$this->_columns = array(
+			'TXN_ID'        => $ID_column_name,
+			'TXN_timestamp' => esc_html__('Transaction Date', 'event_espresso'),
+			'TXN_total'     => esc_html__('Total', 'event_espresso'),
+			'TXN_paid'      => esc_html__('Paid', 'event_espresso'),
+			'ATT_fname'     => esc_html__('Primary Registrant', 'event_espresso'),
+			'event_name'    => esc_html__('Event', 'event_espresso'),
+			'actions'       => esc_html__('Actions', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'TXN_ID'        => array('TXN_ID' => false),
+			'event_name'    => array('event_name' => false),
+			'ATT_fname'     => array('ATT_fname' => false),
+			'TXN_timestamp' => array('TXN_timestamp' => true) // true means its already sorted
+		);
+
+		$this->_primary_column = 'TXN_ID';
+
+		$this->_hidden_columns = array();
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  EE_Transaction $transaction the current item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_row_class($transaction)
+	{
+		$class = parent::_get_row_class($transaction);
+		// add status class
+		$class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+		$start_date = isset($this->_req_data['txn-filter-start-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
+			: date(
+				'm/d/Y',
+				strtotime('-10 year')
+			);
+		$end_date = isset($this->_req_data['txn-filter-end-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
+			: date(
+				'm/d/Y',
+				current_time('timestamp')
+			);
+		ob_start();
+		?>
         <label for="txn-filter-start-date">Display Transactions from </label>
         <input class="datepicker"
                id="txn-filter-start-date"
@@ -146,585 +146,585 @@ 
                value="<?php echo esc_html($end_date); ?>"
         />
         <?php
-        $filters[] = ob_get_contents();
-        ob_end_clean();
-        return $filters;
-    }
-
-
-    /**
-     *_add_view_counts
-     */
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view) {
-            $this->_views[ $view['slug'] ]['count'] = $this->_admin_page->get_transactions($this->_per_page, true, $view['slug']);
-        }
-    }
-
-
-    /**
-     *    column TXN_ID
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_ID(EE_Transaction $transaction)
-    {
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'view_transaction',
-                'TXN_ID' => $transaction->ID(),
-            ),
-            TXN_ADMIN_URL
-        );
-        $content = '<a href="' . $view_lnk_url . '"'
-                   . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
-                   . $transaction->ID()
-                   . '</a>';
-
-        // txn timestamp
-        $content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_txn_timestamp(EE_Transaction $transaction)
-    {
-        // is TXN less than 2 hours old ?
-        if (
-            ($transaction->failed() || $transaction->is_abandoned())
-            && $this->session_lifespan->expiration() < $transaction->datetime(false, true)
-        ) {
-            $timestamp = esc_html__('TXN in progress...', 'event_espresso');
-        } else {
-            $timestamp = $transaction->get_i18n_datetime('TXN_timestamp');
-        }
-        return $timestamp;
-    }
-
-
-    /**
-     *    column_cb
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_cb($transaction)
-    {
-        return sprintf(
-            '<input type="checkbox" name="%1$s[]" value="%2$s" />',
-            $this->_wp_list_args['singular'],
-            $transaction->ID()
-        );
-    }
-
-
-    /**
-     *    column_TXN_timestamp
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_timestamp(EE_Transaction $transaction)
-    {
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'view_transaction',
-                'TXN_ID' => $transaction->ID(),
-            ),
-            TXN_ADMIN_URL
-        );
-        $txn_date = '<a href="' . $view_lnk_url . '"'
-                    . ' title="'
-                    . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
-                    . $this->_get_txn_timestamp($transaction)
-                    . '</a>';
-        // status
-        $txn_date .= '<br><span class="ee-status-text-small">'
-                    . EEH_Template::pretty_status(
-                        $transaction->status_ID(),
-                        false,
-                        'sentence'
-                    )
-                     . '</span>';
-        return $txn_date;
-    }
-
-
-    /**
-     *    column_TXN_total
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_total(EE_Transaction $transaction)
-    {
-        if ($transaction->get('TXN_total') > 0) {
-            return '<span class="txn-pad-rght">'
-                   . apply_filters(
-                       'FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
-                       $transaction->get_pretty('TXN_total'),
-                       $transaction
-                   )
-                   . '</span>';
-        } else {
-            return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
-        }
-    }
-
-
-    /**
-     *    column_TXN_paid
-     *
-     * @param \EE_Transaction $transaction
-     * @return mixed|string
-     * @throws \EE_Error
-     */
-    public function column_TXN_paid(EE_Transaction $transaction)
-    {
-        $transaction_total = $transaction->get('TXN_total');
-        $transaction_paid = $transaction->get('TXN_paid');
-
-        if (\EEH_Money::compare_floats($transaction_total, 0, '>')) {
-            // monies owing
-            $span_class = 'txn-overview-part-payment-spn';
-            if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) {
-                // paid in full
-                $span_class = 'txn-overview-full-payment-spn';
-            } elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) {
-                // no payments made
-                $span_class = 'txn-overview-no-payment-spn';
-            }
-        } else {
-            // transaction_total == 0 so this is a free event
-            $span_class = 'txn-overview-free-event-spn';
-        }
-
-        $payment_method = $transaction->payment_method();
-        $payment_method_name = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-
-        $content = '<span class="' . $span_class . ' txn-pad-rght">'
-                   . $transaction->get_pretty('TXN_paid')
-                   . '</span>';
-        if ($transaction_paid > 0) {
-            $content .= '<br><span class="ee-status-text-small">'
-                        . sprintf(
-                            esc_html__('...via %s', 'event_espresso'),
-                            $payment_method_name
-                        )
-                        . '</span>';
-        }
-        return $content;
-    }
-
-
-    /**
-     *    column_ATT_fname
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_ATT_fname(EE_Transaction $transaction)
-    {
-        $primary_reg = $transaction->primary_registration();
-        $attendee = $primary_reg->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'  => 'view_registration',
-                    '_REG_ID' => $primary_reg->ID(),
-                ),
-                REG_ADMIN_URL
-            );
-            $content = EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registration',
-                'espresso_registrations_view_registration',
-                $primary_reg->ID()
-            )
-                ? '<a href="' . $edit_lnk_url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
-                  . $attendee->full_name()
-                  . '</a>'
-                : $attendee->full_name();
-            $content .= '<br>' . $attendee->email();
-            return $content;
-        }
-        return $transaction->failed() || $transaction->is_abandoned()
-            ? esc_html__('no contact record.', 'event_espresso')
-            : esc_html__(
-                'No contact record, because the transaction was abandoned or the registration process failed.',
-                'event_espresso'
-            );
-    }
-
-
-    /**
-     *    column_ATT_email
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_ATT_email(EE_Transaction $transaction)
-    {
-        $attendee = $transaction->primary_registration()->get_first_related('Attendee');
-        if (! empty($attendee)) {
-            return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
-                   . $attendee->get('ATT_email')
-                   . '</a>';
-        } else {
-            return $transaction->failed() || $transaction->is_abandoned()
-                ? esc_html__('no contact record.', 'event_espresso')
-                : esc_html__(
-                    'No contact record, because the transaction was abandoned or the registration process failed.',
-                    'event_espresso'
-                );
-        }
-    }
-
-
-    /**
-     *    column_event_name
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_event_name(EE_Transaction $transaction)
-    {
-        $actions = array();
-        $event = $transaction->primary_registration()->get_first_related('Event');
-        if (! empty($event)) {
-            $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'edit', 'post' => $event->ID()),
-                EVENTS_ADMIN_URL
-            );
-            $event_name = $event->get('EVT_name');
-
-            // filter this view by transactions for this event
-            $txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'default',
-                    'EVT_ID' => $event->ID(),
-                )
-            );
-            if (
-                empty($this->_req_data['EVT_ID'])
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_event',
-                    'espresso_events_edit',
-                    $event->ID()
-                )
-            ) {
-                $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
-                                              . ' title="' . esc_attr__(
-                                                  'Filter transactions by this event',
-                                                  'event_espresso'
-                                              ) . '">'
-                                              . esc_html__('View Transactions for this event', 'event_espresso')
-                                              . '</a>';
-            }
-
-            return sprintf(
-                '%1$s %2$s',
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_event',
-                    'espresso_events_edit',
-                    $event->ID()
-                )
-                    ? '<a href="' . $edit_event_url . '"'
-                      . ' title="'
-                      . sprintf(
-                          esc_attr__('Edit Event: %s', 'event_espresso'),
-                          $event->get('EVT_name')
-                      )
-                      . '">'
-                      . wp_trim_words(
-                          $event_name,
-                          30,
-                          '...'
-                      )
-                      . '</a>'
-                    : wp_trim_words($event_name, 30, '...'),
-                $this->row_actions($actions)
-            );
-        } else {
-            return esc_html__(
-                'The event associated with this transaction via the primary registration cannot be retrieved.',
-                'event_espresso'
-            );
-        }
-    }
-
-
-    /**
-     *    column_actions
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_actions(EE_Transaction $transaction)
-    {
-        return $this->_action_string(
-            $this->get_transaction_details_link($transaction)
-            . $this->get_invoice_link($transaction)
-            . $this->get_receipt_link($transaction)
-            . $this->get_primary_registration_details_link($transaction)
-            . $this->get_send_payment_reminder_trigger_link($transaction)
-            . $this->get_payment_overview_link($transaction)
-            . $this->get_related_messages_link($transaction),
-            $transaction,
-            'ul',
-            'txn-overview-actions-ul'
-        );
-    }
-
-
-    /**
-     * Get the transaction details link.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_transaction_details_link(EE_Transaction $transaction)
-    {
-        $url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'view_transaction',
-                'TXN_ID' => $transaction->ID(),
-            ),
-            TXN_ADMIN_URL
-        );
-        return '
+		$filters[] = ob_get_contents();
+		ob_end_clean();
+		return $filters;
+	}
+
+
+	/**
+	 *_add_view_counts
+	 */
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view) {
+			$this->_views[ $view['slug'] ]['count'] = $this->_admin_page->get_transactions($this->_per_page, true, $view['slug']);
+		}
+	}
+
+
+	/**
+	 *    column TXN_ID
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_ID(EE_Transaction $transaction)
+	{
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'view_transaction',
+				'TXN_ID' => $transaction->ID(),
+			),
+			TXN_ADMIN_URL
+		);
+		$content = '<a href="' . $view_lnk_url . '"'
+				   . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
+				   . $transaction->ID()
+				   . '</a>';
+
+		// txn timestamp
+		$content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_txn_timestamp(EE_Transaction $transaction)
+	{
+		// is TXN less than 2 hours old ?
+		if (
+			($transaction->failed() || $transaction->is_abandoned())
+			&& $this->session_lifespan->expiration() < $transaction->datetime(false, true)
+		) {
+			$timestamp = esc_html__('TXN in progress...', 'event_espresso');
+		} else {
+			$timestamp = $transaction->get_i18n_datetime('TXN_timestamp');
+		}
+		return $timestamp;
+	}
+
+
+	/**
+	 *    column_cb
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_cb($transaction)
+	{
+		return sprintf(
+			'<input type="checkbox" name="%1$s[]" value="%2$s" />',
+			$this->_wp_list_args['singular'],
+			$transaction->ID()
+		);
+	}
+
+
+	/**
+	 *    column_TXN_timestamp
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_timestamp(EE_Transaction $transaction)
+	{
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'view_transaction',
+				'TXN_ID' => $transaction->ID(),
+			),
+			TXN_ADMIN_URL
+		);
+		$txn_date = '<a href="' . $view_lnk_url . '"'
+					. ' title="'
+					. esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
+					. $this->_get_txn_timestamp($transaction)
+					. '</a>';
+		// status
+		$txn_date .= '<br><span class="ee-status-text-small">'
+					. EEH_Template::pretty_status(
+						$transaction->status_ID(),
+						false,
+						'sentence'
+					)
+					 . '</span>';
+		return $txn_date;
+	}
+
+
+	/**
+	 *    column_TXN_total
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_total(EE_Transaction $transaction)
+	{
+		if ($transaction->get('TXN_total') > 0) {
+			return '<span class="txn-pad-rght">'
+				   . apply_filters(
+					   'FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
+					   $transaction->get_pretty('TXN_total'),
+					   $transaction
+				   )
+				   . '</span>';
+		} else {
+			return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
+		}
+	}
+
+
+	/**
+	 *    column_TXN_paid
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return mixed|string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_paid(EE_Transaction $transaction)
+	{
+		$transaction_total = $transaction->get('TXN_total');
+		$transaction_paid = $transaction->get('TXN_paid');
+
+		if (\EEH_Money::compare_floats($transaction_total, 0, '>')) {
+			// monies owing
+			$span_class = 'txn-overview-part-payment-spn';
+			if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) {
+				// paid in full
+				$span_class = 'txn-overview-full-payment-spn';
+			} elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) {
+				// no payments made
+				$span_class = 'txn-overview-no-payment-spn';
+			}
+		} else {
+			// transaction_total == 0 so this is a free event
+			$span_class = 'txn-overview-free-event-spn';
+		}
+
+		$payment_method = $transaction->payment_method();
+		$payment_method_name = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+
+		$content = '<span class="' . $span_class . ' txn-pad-rght">'
+				   . $transaction->get_pretty('TXN_paid')
+				   . '</span>';
+		if ($transaction_paid > 0) {
+			$content .= '<br><span class="ee-status-text-small">'
+						. sprintf(
+							esc_html__('...via %s', 'event_espresso'),
+							$payment_method_name
+						)
+						. '</span>';
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    column_ATT_fname
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_ATT_fname(EE_Transaction $transaction)
+	{
+		$primary_reg = $transaction->primary_registration();
+		$attendee = $primary_reg->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'  => 'view_registration',
+					'_REG_ID' => $primary_reg->ID(),
+				),
+				REG_ADMIN_URL
+			);
+			$content = EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registration',
+				'espresso_registrations_view_registration',
+				$primary_reg->ID()
+			)
+				? '<a href="' . $edit_lnk_url . '"'
+				  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+				  . $attendee->full_name()
+				  . '</a>'
+				: $attendee->full_name();
+			$content .= '<br>' . $attendee->email();
+			return $content;
+		}
+		return $transaction->failed() || $transaction->is_abandoned()
+			? esc_html__('no contact record.', 'event_espresso')
+			: esc_html__(
+				'No contact record, because the transaction was abandoned or the registration process failed.',
+				'event_espresso'
+			);
+	}
+
+
+	/**
+	 *    column_ATT_email
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_ATT_email(EE_Transaction $transaction)
+	{
+		$attendee = $transaction->primary_registration()->get_first_related('Attendee');
+		if (! empty($attendee)) {
+			return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
+				   . $attendee->get('ATT_email')
+				   . '</a>';
+		} else {
+			return $transaction->failed() || $transaction->is_abandoned()
+				? esc_html__('no contact record.', 'event_espresso')
+				: esc_html__(
+					'No contact record, because the transaction was abandoned or the registration process failed.',
+					'event_espresso'
+				);
+		}
+	}
+
+
+	/**
+	 *    column_event_name
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_event_name(EE_Transaction $transaction)
+	{
+		$actions = array();
+		$event = $transaction->primary_registration()->get_first_related('Event');
+		if (! empty($event)) {
+			$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'edit', 'post' => $event->ID()),
+				EVENTS_ADMIN_URL
+			);
+			$event_name = $event->get('EVT_name');
+
+			// filter this view by transactions for this event
+			$txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'default',
+					'EVT_ID' => $event->ID(),
+				)
+			);
+			if (
+				empty($this->_req_data['EVT_ID'])
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_event',
+					'espresso_events_edit',
+					$event->ID()
+				)
+			) {
+				$actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
+											  . ' title="' . esc_attr__(
+												  'Filter transactions by this event',
+												  'event_espresso'
+											  ) . '">'
+											  . esc_html__('View Transactions for this event', 'event_espresso')
+											  . '</a>';
+			}
+
+			return sprintf(
+				'%1$s %2$s',
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_event',
+					'espresso_events_edit',
+					$event->ID()
+				)
+					? '<a href="' . $edit_event_url . '"'
+					  . ' title="'
+					  . sprintf(
+						  esc_attr__('Edit Event: %s', 'event_espresso'),
+						  $event->get('EVT_name')
+					  )
+					  . '">'
+					  . wp_trim_words(
+						  $event_name,
+						  30,
+						  '...'
+					  )
+					  . '</a>'
+					: wp_trim_words($event_name, 30, '...'),
+				$this->row_actions($actions)
+			);
+		} else {
+			return esc_html__(
+				'The event associated with this transaction via the primary registration cannot be retrieved.',
+				'event_espresso'
+			);
+		}
+	}
+
+
+	/**
+	 *    column_actions
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_actions(EE_Transaction $transaction)
+	{
+		return $this->_action_string(
+			$this->get_transaction_details_link($transaction)
+			. $this->get_invoice_link($transaction)
+			. $this->get_receipt_link($transaction)
+			. $this->get_primary_registration_details_link($transaction)
+			. $this->get_send_payment_reminder_trigger_link($transaction)
+			. $this->get_payment_overview_link($transaction)
+			. $this->get_related_messages_link($transaction),
+			$transaction,
+			'ul',
+			'txn-overview-actions-ul'
+		);
+	}
+
+
+	/**
+	 * Get the transaction details link.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_transaction_details_link(EE_Transaction $transaction)
+	{
+		$url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'view_transaction',
+				'TXN_ID' => $transaction->ID(),
+			),
+			TXN_ADMIN_URL
+		);
+		return '
 			<li>
 				<a href="' . $url . '"'
-               . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
+			   . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
 					<span class="dashicons dashicons-cart"></span>
 				</a>
 			</li>';
-    }
-
-
-    /**
-     * Get the invoice link for the given registration.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_invoice_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url = $registration->invoice_url();
-            // only show invoice link if message type is active.
-            if (
-                $registration->attendee() instanceof EE_Attendee
-                && EEH_MSG_Template::is_mt_active('invoice')
-            ) {
-                return '
+	}
+
+
+	/**
+	 * Get the invoice link for the given registration.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_invoice_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url = $registration->invoice_url();
+			// only show invoice link if message type is active.
+			if (
+				$registration->attendee() instanceof EE_Attendee
+				&& EEH_MSG_Template::is_mt_active('invoice')
+			) {
+				return '
                 <li>
                     <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+					   . ' target="_blank" href="' . $url . '" class="tiny-text">
                         <span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
                     </a>
                 </li>';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * Get the receipt link for the transaction.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_receipt_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url = $registration->receipt_url();
-            // only show receipt link if message type is active.
-            if (
-                $registration->attendee() instanceof EE_Attendee
-                && EEH_MSG_Template::is_mt_active('receipt')
-            ) {
-                return '
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get the receipt link for the transaction.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_receipt_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url = $registration->receipt_url();
+			// only show receipt link if message type is active.
+			if (
+				$registration->attendee() instanceof EE_Attendee
+				&& EEH_MSG_Template::is_mt_active('receipt')
+			) {
+				return '
 			<li>
 				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+					   . ' target="_blank" href="' . $url . '" class="tiny-text">
 					<span class="dashicons dashicons-media-default ee-icon-size-18"></span>
 				</a>
 			</li>';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * Get the link to view the details for the primary registration.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function get_primary_registration_details_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'  => 'view_registration',
-                    '_REG_ID' => $registration->ID(),
-                ),
-                REG_ADMIN_URL
-            );
-            return EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registration',
-                'espresso_registrations_view_registration',
-                $registration->ID()
-            )
-                ? '
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get the link to view the details for the primary registration.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function get_primary_registration_details_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'  => 'view_registration',
+					'_REG_ID' => $registration->ID(),
+				),
+				REG_ADMIN_URL
+			);
+			return EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registration',
+				'espresso_registrations_view_registration',
+				$registration->ID()
+			)
+				? '
 				<li>
 					<a href="' . $url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
+				  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
 						<span class="dashicons dashicons-clipboard"></span>
 					</a>
 				</li>'
-                : '';
-        }
-        return '';
-    }
-
-
-    /**
-     * Get send payment reminder trigger link
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function get_send_payment_reminder_trigger_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if (
-            $registration instanceof EE_Registration
-            && $registration->attendee() instanceof EE_Attendee
-            && EEH_MSG_Template::is_mt_active('payment_reminder')
-            && ! in_array(
-                $transaction->status_ID(),
-                array(EEM_Transaction::complete_status_code, EEM_Transaction::overpaid_status_code),
-                true
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'send_payment_reminder',
-                    'TXN_ID' => $transaction->ID(),
-                ),
-                TXN_ADMIN_URL
-            );
-            return '
+				: '';
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get send payment reminder trigger link
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function get_send_payment_reminder_trigger_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if (
+			$registration instanceof EE_Registration
+			&& $registration->attendee() instanceof EE_Attendee
+			&& EEH_MSG_Template::is_mt_active('payment_reminder')
+			&& ! in_array(
+				$transaction->status_ID(),
+				array(EEM_Transaction::complete_status_code, EEM_Transaction::overpaid_status_code),
+				true
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'send_payment_reminder',
+					'TXN_ID' => $transaction->ID(),
+				),
+				TXN_ADMIN_URL
+			);
+			return '
             <li>
                 <a href="' . $url . '"'
-                   . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
+				   . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
                     <span class="dashicons dashicons-email-alt"></span>
                 </a>
             </li>';
-        }
-        return '';
-    }
-
-
-    /**
-     * Get link to filtered view in the message activity list table of messages for this transaction.
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function get_related_messages_link(EE_Transaction $transaction)
-    {
-        $url = EEH_MSG_Template::get_message_action_link(
-            'see_notifications_for',
-            null,
-            array('TXN_ID' => $transaction->ID())
-        );
-        return EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_global_messages',
-            'view_filtered_messages'
-        )
-            ? '<li>' . $url . '</li>'
-            : '';
-    }
-
-
-    /**
-     * Return the link to make a payment on the frontend
-     *
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_payment_overview_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if (
-            $registration instanceof EE_Registration
-            && $transaction->status_ID() !== EEM_Transaction::complete_status_code
-            && $registration->owes_monies_and_can_pay()
-        ) {
-            return '
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get link to filtered view in the message activity list table of messages for this transaction.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function get_related_messages_link(EE_Transaction $transaction)
+	{
+		$url = EEH_MSG_Template::get_message_action_link(
+			'see_notifications_for',
+			null,
+			array('TXN_ID' => $transaction->ID())
+		);
+		return EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_global_messages',
+			'view_filtered_messages'
+		)
+			? '<li>' . $url . '</li>'
+			: '';
+	}
+
+
+	/**
+	 * Return the link to make a payment on the frontend
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_payment_overview_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if (
+			$registration instanceof EE_Registration
+			&& $transaction->status_ID() !== EEM_Transaction::complete_status_code
+			&& $registration->owes_monies_and_can_pay()
+		) {
+			return '
             <li>
                 <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso') . '"'
-                   . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
-                   . ' class="tiny-text">
+				   . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
+				   . ' class="tiny-text">
                     <span class="dashicons dashicons-money ee-icon-size-18"></span>
                 </a>
             </li>
             ';
-        }
-        return '';
-    }
+		}
+		return '';
+	}
 }

admin_pages/events/Events_Admin_List_Table.class.php

Spacing +29 added lines, -29 removed lines

@@ -114,7 +114,7 @@ 
         $class = parent::_get_row_class($item);
         // add status class
         $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
+            ? ' ee-status-strip event-status-'.$item->get_active_status()
             : '';
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
@@ -143,7 +143,7 @@ 
      */
     public function column_cb($item)
     {
-        if (! $item instanceof EE_Event) {
+        if ( ! $item instanceof EE_Event) {
             return '';
         }
         $this->_dtt = $item->primary_datetime(); // set this for use in other columns
@@ -166,7 +166,7 @@ 
     public function column_id(EE_Event $item)
     {
         $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$item->name().'</span>';
         return $content;
     }
 
@@ -189,7 +189,7 @@ 
         $actions = $this->_column_name_action_setup($item);
         $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
         $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
+                   . $edit_link.'">'
                    . $item->name()
                    . '</a></strong>'
                    . $status;
@@ -218,7 +218,7 @@ 
     protected function _column_name_action_setup(EE_Event $item)
     {
         // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $actions = array();
@@ -237,8 +237,8 @@ 
                 'post'   => $item->ID(),
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $actions['edit'] = '<a href="'.$edit_link.'"'
+                               . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">'
                                . esc_html__('Edit', 'event_espresso')
                                . '</a>';
         }
@@ -258,8 +258,8 @@ 
                 'event_id' => $item->ID(),
             );
             $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+            $actions['attendees'] = '<a href="'.$attendees_link.'"'
+                                    . ' title="'.esc_attr__('View Registrations', 'event_espresso').'">'
                                     . esc_html__('Registrations', 'event_espresso')
                                     . '</a>';
         }
@@ -312,8 +312,8 @@ 
             );
         }
         $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+        $actions['view'] = '<a href="'.$view_link.'"'
+                           . ' title="'.esc_attr__('View Event', 'event_espresso').'">'
                            . esc_html__('View', 'event_espresso')
                            . '</a>';
         if ($item->get('status') === 'trash') {
@@ -324,8 +324,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+                $actions['restore_from_trash'] = '<a href="'.$restore_event_link.'"'
+                                                 . ' title="'.esc_attr__('Restore from Trash', 'event_espresso')
                                                  . '">'
                                                  . esc_html__('Restore from Trash', 'event_espresso')
                                                  . '</a>';
@@ -338,8 +338,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+                $actions['delete'] = '<a href="'.$delete_event_link.'"'
+                                     . ' title="'.esc_attr__('Delete Permanently', 'event_espresso').'">'
                                      . esc_html__('Delete Permanently', 'event_espresso')
                                      . '</a>';
             }
@@ -351,8 +351,8 @@ 
                     $item->ID()
                 )
             ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+                $actions['move to trash'] = '<a href="'.$trash_event_link.'"'
+                                            . ' title="'.esc_attr__('Trash Event', 'event_espresso').'">'
                                             . esc_html__('Trash', 'event_espresso')
                                             . '</a>';
             }
@@ -377,8 +377,8 @@ 
             'EVT_wp_user' => $item->wp_user(),
         );
         $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+        return $gravatar.'  <a href="'.$filter_url.'"'
+               . ' title="'.esc_attr__('Click to filter events by this author.', 'event_espresso').'">'
                . $event_author->display_name
                . '</a>';
     }
@@ -395,7 +395,7 @@ 
         return implode(
             ', ',
             array_map(
-                function (EE_Term $category) {
+                function(EE_Term $category) {
                     return $category->name();
                 },
                 $event_categories
@@ -470,7 +470,7 @@ 
                    'ee_read_registrations',
                    'espresso_registrations_view_registration'
                )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+            ? '<a href="'.$attendees_link.'">'.$registered_attendees.'</a>'
             : $registered_attendees;
     }
 
@@ -500,13 +500,13 @@ 
     public function column_actions(EE_Event $item)
     {
         // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $action_links = array();
         $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                          . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+        $action_links[] = '<a href="'.$view_link.'"'
+                          . ' title="'.esc_attr__('View Event', 'event_espresso').'" target="_blank">';
         $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
         if (
             EE_Registry::instance()->CAP->current_user_can(
@@ -520,8 +520,8 @@ 
                 'post'   => $item->ID(),
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                              . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $action_links[] = '<a href="'.$edit_link.'"'
+                              . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">'
                               . '<div class="ee-icon ee-icon-calendar-edit"></div>'
                               . '</a>';
         }
@@ -540,8 +540,8 @@ 
                 'event_id' => $item->ID(),
             );
             $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                              . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+            $action_links[] = '<a href="'.$attendees_link.'"'
+                              . ' title="'.esc_attr__('View Registrants', 'event_espresso').'">'
                               . '<div class="dashicons dashicons-groups"></div>'
                               . '</a>';
         }
@@ -576,7 +576,7 @@ 
         }
         $column_array = [];
         foreach ($this->_columns as $column => $column_label) {
-            $column_array[ $column ] = $column_label;
+            $column_array[$column] = $column_label;
             if ($column === 'venue') {
                 $column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
             }

Indentation +563 added lines, -563 removed lines

@@ -14,567 +14,567 @@
  */
 class Events_Admin_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * @var EE_Datetime
-     */
-    private $_dtt;
-
-
-    /**
-     * Initial setup of data properties for the list table.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
-        $this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
-    }
-
-
-    /**
-     * Set up of additional properties for the list table.
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('event', 'event_espresso'),
-            'plural'   => esc_html__('events', 'event_espresso'),
-            'ajax'     => true, // for now
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $this->_columns = array(
-            'cb'              => '<input type="checkbox" />',
-            'id'              => esc_html__('ID', 'event_espresso'),
-            'name'            => esc_html__('Name', 'event_espresso'),
-            'author'          => esc_html__('Author', 'event_espresso'),
-            'venue'           => esc_html__('Venue', 'event_espresso'),
-            'start_date_time' => esc_html__('Event Start', 'event_espresso'),
-            'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
-            'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
-                                 . '<span class="screen-reader-text">'
-                                 . esc_html__('Approved Registrations', 'event_espresso')
-                                 . '</span>'
-                                 . '</span>',
-            // 'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
-            'actions'         => esc_html__('Actions', 'event_espresso'),
-        );
-        $this->addConditionalColumns();
-        $this->_sortable_columns = array(
-            'id'              => array('EVT_ID' => true),
-            'name'            => array('EVT_name' => false),
-            'author'          => array('EVT_wp_user' => false),
-            'venue'           => array('Venue.VNU_name' => false),
-            'start_date_time' => array('Datetime.DTT_EVT_start' => false),
-            'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
-        );
-
-        $this->_primary_column = 'id';
-        $this->_hidden_columns = array('author', 'event_category');
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        return array(); // no filters with decaf
-    }
-
-
-    /**
-     * Setup of views properties.
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_admin_page->total_events();
-        $this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_events',
-                'espresso_events_trash_events'
-            )
-        ) {
-            $this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
-        }
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        // add status class
-        $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
-            : '';
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_status(EE_Event $item)
-    {
-        return '<span class="ee-status-strip ee-status-strip-td event-status-'
-               . $item->get_active_status()
-               . '"></span>';
-    }
-
-
-    /**
-     * @param  EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_cb($item)
-    {
-        if (! $item instanceof EE_Event) {
-            return '';
-        }
-        $this->_dtt = $item->primary_datetime(); // set this for use in other columns
-        return sprintf(
-            '<input type="checkbox" name="EVT_IDs[]" value="%s" />',
-            $item->ID()
-        );
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    public function column_id(EE_Event $item)
-    {
-        $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_name(EE_Event $item)
-    {
-        $edit_query_args = array(
-            'action' => 'edit',
-            'post'   => $item->ID(),
-        );
-        $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-        $actions = $this->_column_name_action_setup($item);
-        $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
-        $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
-                   . $item->name()
-                   . '</a></strong>'
-                   . $status;
-        $content .= '<br><span class="ee-status-text-small">'
-                    . EEH_Template::pretty_status(
-                        $item->get_active_status(),
-                        false,
-                        'sentence'
-                    )
-                    . '</span>';
-        $content .= $this->row_actions($actions);
-        return $content;
-    }
-
-
-    /**
-     * Just a method for setting up the actions for the name column
-     *
-     * @param EE_Event $item
-     * @return array array of actions
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _column_name_action_setup(EE_Event $item)
-    {
-        // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $actions = array();
-        $restore_event_link = '';
-        $delete_event_link = '';
-        $trash_event_link = '';
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_event',
-                'espresso_events_edit',
-                $item->ID()
-            )
-        ) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso')
-                               . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
-                                    . esc_html__('Registrations', 'event_espresso')
-                                    . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_trash_event',
-                $item->ID()
-            )
-        ) {
-            $trash_event_query_args = array(
-                'action' => 'trash_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $trash_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_restore_event',
-                $item->ID()
-            )
-        ) {
-            $restore_event_query_args = array(
-                'action' => 'restore_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $restore_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_delete_event',
-                $item->ID()
-            )
-        ) {
-            $delete_event_query_args = array(
-                'action' => 'delete_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $delete_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
-                           . esc_html__('View', 'event_espresso')
-                           . '</a>';
-        if ($item->get('status') === 'trash') {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_restore_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
-                                                 . '">'
-                                                 . esc_html__('Restore from Trash', 'event_espresso')
-                                                 . '</a>';
-            }
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_delete_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        } else {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_trash_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
-                                            . esc_html__('Trash', 'event_espresso')
-                                            . '</a>';
-            }
-        }
-        return $actions;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_author(EE_Event $item)
-    {
-        // user author info
-        $event_author = get_userdata($item->wp_user());
-        $gravatar = get_avatar($item->wp_user(), '15');
-        // filter link
-        $query_args = array(
-            'action'      => 'default',
-            'EVT_wp_user' => $item->wp_user(),
-        );
-        $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
-               . $event_author->display_name
-               . '</a>';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_event_category(EE_Event $event)
-    {
-        $event_categories = $event->get_all_event_categories();
-        return implode(
-            ', ',
-            array_map(
-                function (EE_Term $category) {
-                    return $category->name();
-                },
-                $event_categories
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_venue(EE_Event $item)
-    {
-        $venue = $item->get_first_related('Venue');
-        return ! empty($venue)
-            ? $venue->name()
-            : '';
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_start_date_time(EE_Event $item)
-    {
-        return $this->_dtt instanceof EE_Datetime
-            ? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
-            : esc_html__('No Date was saved for this Event', 'event_espresso');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_reg_begins(EE_Event $item)
-    {
-        $reg_start = $item->get_ticket_with_earliest_start_time();
-        return $reg_start instanceof EE_Ticket
-            ? $reg_start->get_i18n_datetime('TKT_start_date')
-            : esc_html__('No Tickets have been setup for this Event', 'event_espresso');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_attendees(EE_Event $item)
-    {
-        $attendees_query_args = array(
-            'action'   => 'default',
-            'event_id' => $item->ID(),
-        );
-        $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-        $registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
-        return EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_event',
-            'espresso_registrations_view_registration',
-            $item->ID()
-        )
-               && EE_Registry::instance()->CAP->current_user_can(
-                   'ee_read_registrations',
-                   'espresso_registrations_view_registration'
-               )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
-            : $registered_attendees;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_tkts_sold(EE_Event $item)
-    {
-        return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_actions(EE_Event $item)
-    {
-        // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $action_links = array();
-        $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                          . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
-        $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_event',
-                'espresso_events_edit',
-                $item->ID()
-            )
-        ) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                              . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                              . '<div class="ee-icon ee-icon-calendar-edit"></div>'
-                              . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            ) && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                              . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
-                              . '<div class="dashicons dashicons-groups"></div>'
-                              . '</a>';
-        }
-        $action_links = apply_filters(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            $action_links,
-            $item
-        );
-        return $this->_action_string(
-            implode("\n\t", $action_links),
-            $item,
-            'div'
-        );
-    }
-
-
-    /**
-     * Helper for adding columns conditionally
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function addConditionalColumns()
-    {
-        $event_category_count = EEM_Term::instance()->count(
-            [['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]]
-        );
-        if ($event_category_count === 0) {
-            return;
-        }
-        $column_array = [];
-        foreach ($this->_columns as $column => $column_label) {
-            $column_array[ $column ] = $column_label;
-            if ($column === 'venue') {
-                $column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
-            }
-        }
-        $this->_columns = $column_array;
-    }
+	/**
+	 * @var EE_Datetime
+	 */
+	private $_dtt;
+
+
+	/**
+	 * Initial setup of data properties for the list table.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
+		$this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
+	}
+
+
+	/**
+	 * Set up of additional properties for the list table.
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('event', 'event_espresso'),
+			'plural'   => esc_html__('events', 'event_espresso'),
+			'ajax'     => true, // for now
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$this->_columns = array(
+			'cb'              => '<input type="checkbox" />',
+			'id'              => esc_html__('ID', 'event_espresso'),
+			'name'            => esc_html__('Name', 'event_espresso'),
+			'author'          => esc_html__('Author', 'event_espresso'),
+			'venue'           => esc_html__('Venue', 'event_espresso'),
+			'start_date_time' => esc_html__('Event Start', 'event_espresso'),
+			'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
+			'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
+								 . '<span class="screen-reader-text">'
+								 . esc_html__('Approved Registrations', 'event_espresso')
+								 . '</span>'
+								 . '</span>',
+			// 'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
+			'actions'         => esc_html__('Actions', 'event_espresso'),
+		);
+		$this->addConditionalColumns();
+		$this->_sortable_columns = array(
+			'id'              => array('EVT_ID' => true),
+			'name'            => array('EVT_name' => false),
+			'author'          => array('EVT_wp_user' => false),
+			'venue'           => array('Venue.VNU_name' => false),
+			'start_date_time' => array('Datetime.DTT_EVT_start' => false),
+			'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
+		);
+
+		$this->_primary_column = 'id';
+		$this->_hidden_columns = array('author', 'event_category');
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		return array(); // no filters with decaf
+	}
+
+
+	/**
+	 * Setup of views properties.
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_admin_page->total_events();
+		$this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_events',
+				'espresso_events_trash_events'
+			)
+		) {
+			$this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
+		}
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		// add status class
+		$class .= $item instanceof EE_Event
+			? ' ee-status-strip event-status-' . $item->get_active_status()
+			: '';
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_status(EE_Event $item)
+	{
+		return '<span class="ee-status-strip ee-status-strip-td event-status-'
+			   . $item->get_active_status()
+			   . '"></span>';
+	}
+
+
+	/**
+	 * @param  EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_cb($item)
+	{
+		if (! $item instanceof EE_Event) {
+			return '';
+		}
+		$this->_dtt = $item->primary_datetime(); // set this for use in other columns
+		return sprintf(
+			'<input type="checkbox" name="EVT_IDs[]" value="%s" />',
+			$item->ID()
+		);
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	public function column_id(EE_Event $item)
+	{
+		$content = $item->ID();
+		$content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_name(EE_Event $item)
+	{
+		$edit_query_args = array(
+			'action' => 'edit',
+			'post'   => $item->ID(),
+		);
+		$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+		$actions = $this->_column_name_action_setup($item);
+		$status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
+		$content = '<strong><a class="row-title" href="'
+				   . $edit_link . '">'
+				   . $item->name()
+				   . '</a></strong>'
+				   . $status;
+		$content .= '<br><span class="ee-status-text-small">'
+					. EEH_Template::pretty_status(
+						$item->get_active_status(),
+						false,
+						'sentence'
+					)
+					. '</span>';
+		$content .= $this->row_actions($actions);
+		return $content;
+	}
+
+
+	/**
+	 * Just a method for setting up the actions for the name column
+	 *
+	 * @param EE_Event $item
+	 * @return array array of actions
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _column_name_action_setup(EE_Event $item)
+	{
+		// todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$actions = array();
+		$restore_event_link = '';
+		$delete_event_link = '';
+		$trash_event_link = '';
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_event',
+				'espresso_events_edit',
+				$item->ID()
+			)
+		) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_link . '"'
+							   . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso')
+							   . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$actions['attendees'] = '<a href="' . $attendees_link . '"'
+									. ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+									. esc_html__('Registrations', 'event_espresso')
+									. '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_trash_event',
+				$item->ID()
+			)
+		) {
+			$trash_event_query_args = array(
+				'action' => 'trash_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$trash_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_restore_event',
+				$item->ID()
+			)
+		) {
+			$restore_event_query_args = array(
+				'action' => 'restore_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$restore_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_delete_event',
+				$item->ID()
+			)
+		) {
+			$delete_event_query_args = array(
+				'action' => 'delete_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$delete_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		$view_link = get_permalink($item->ID());
+		$actions['view'] = '<a href="' . $view_link . '"'
+						   . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+						   . esc_html__('View', 'event_espresso')
+						   . '</a>';
+		if ($item->get('status') === 'trash') {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_restore_event',
+					$item->ID()
+				)
+			) {
+				$actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
+												 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+												 . '">'
+												 . esc_html__('Restore from Trash', 'event_espresso')
+												 . '</a>';
+			}
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_delete_event',
+					$item->ID()
+				)
+			) {
+				$actions['delete'] = '<a href="' . $delete_event_link . '"'
+									 . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		} else {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_trash_event',
+					$item->ID()
+				)
+			) {
+				$actions['move to trash'] = '<a href="' . $trash_event_link . '"'
+											. ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+											. esc_html__('Trash', 'event_espresso')
+											. '</a>';
+			}
+		}
+		return $actions;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_author(EE_Event $item)
+	{
+		// user author info
+		$event_author = get_userdata($item->wp_user());
+		$gravatar = get_avatar($item->wp_user(), '15');
+		// filter link
+		$query_args = array(
+			'action'      => 'default',
+			'EVT_wp_user' => $item->wp_user(),
+		);
+		$filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
+		return $gravatar . '  <a href="' . $filter_url . '"'
+			   . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+			   . $event_author->display_name
+			   . '</a>';
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_event_category(EE_Event $event)
+	{
+		$event_categories = $event->get_all_event_categories();
+		return implode(
+			', ',
+			array_map(
+				function (EE_Term $category) {
+					return $category->name();
+				},
+				$event_categories
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_venue(EE_Event $item)
+	{
+		$venue = $item->get_first_related('Venue');
+		return ! empty($venue)
+			? $venue->name()
+			: '';
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_start_date_time(EE_Event $item)
+	{
+		return $this->_dtt instanceof EE_Datetime
+			? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
+			: esc_html__('No Date was saved for this Event', 'event_espresso');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_reg_begins(EE_Event $item)
+	{
+		$reg_start = $item->get_ticket_with_earliest_start_time();
+		return $reg_start instanceof EE_Ticket
+			? $reg_start->get_i18n_datetime('TKT_start_date')
+			: esc_html__('No Tickets have been setup for this Event', 'event_espresso');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_attendees(EE_Event $item)
+	{
+		$attendees_query_args = array(
+			'action'   => 'default',
+			'event_id' => $item->ID(),
+		);
+		$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+		$registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
+		return EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_event',
+			'espresso_registrations_view_registration',
+			$item->ID()
+		)
+			   && EE_Registry::instance()->CAP->current_user_can(
+				   'ee_read_registrations',
+				   'espresso_registrations_view_registration'
+			   )
+			? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+			: $registered_attendees;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_tkts_sold(EE_Event $item)
+	{
+		return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_actions(EE_Event $item)
+	{
+		// todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$action_links = array();
+		$view_link = get_permalink($item->ID());
+		$action_links[] = '<a href="' . $view_link . '"'
+						  . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+		$action_links[] = '<div class="dashicons dashicons-search"></div></a>';
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_event',
+				'espresso_events_edit',
+				$item->ID()
+			)
+		) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$action_links[] = '<a href="' . $edit_link . '"'
+							  . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							  . '<div class="ee-icon ee-icon-calendar-edit"></div>'
+							  . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			) && EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$action_links[] = '<a href="' . $attendees_link . '"'
+							  . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+							  . '<div class="dashicons dashicons-groups"></div>'
+							  . '</a>';
+		}
+		$action_links = apply_filters(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			$action_links,
+			$item
+		);
+		return $this->_action_string(
+			implode("\n\t", $action_links),
+			$item,
+			'div'
+		);
+	}
+
+
+	/**
+	 * Helper for adding columns conditionally
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function addConditionalColumns()
+	{
+		$event_category_count = EEM_Term::instance()->count(
+			[['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]]
+		);
+		if ($event_category_count === 0) {
+			return;
+		}
+		$column_array = [];
+		foreach ($this->_columns as $column => $column_label) {
+			$column_array[ $column ] = $column_label;
+			if ($column === 'venue') {
+				$column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
+			}
+		}
+		$this->_columns = $column_array;
+	}
 }

admin_pages/registrations/EE_Attendee_Contact_List_Table.class.php

Indentation +378 added lines, -378 removed lines

@@ -12,382 +12,382 @@
  */
 class EE_Attendee_Contact_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * Initial setup of data (called by parent).
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_view !== 'trash'
-            ? $this->_admin_page->get_attendees($this->_per_page)
-            : $this->_admin_page->get_attendees($this->_per_page, false, true);
-        $this->_all_data_count = $this->_view !== 'trash'
-            ? $this->_admin_page->get_attendees($this->_per_page, true)
-            : $this->_admin_page->get_attendees($this->_per_page, true, true);
-    }
-
-
-    /**
-     * Initial setup of properties.
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('attendee', 'event_espresso'),
-            'plural'   => esc_html__('attendees', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'                 => '<input type="checkbox" />', // Render a checkbox instead of text
-            'ATT_ID'             => esc_html__('ID', 'event_espresso'),
-            'ATT_fname'          => esc_html__('First Name', 'event_espresso'),
-            'ATT_lname'          => esc_html__('Last Name', 'event_espresso'),
-            'ATT_email'          => esc_html__('Email Address', 'event_espresso'),
-            'Registration_Count' => esc_html__('# Registrations', 'event_espresso'),
-            'ATT_phone'          => esc_html__('Phone', 'event_espresso'),
-            'ATT_address'        => esc_html__('Address', 'event_espresso'),
-            'ATT_city'           => esc_html__('City', 'event_espresso'),
-            'STA_ID'             => esc_html__('State/Province', 'event_espresso'),
-            'CNT_ISO'            => esc_html__('Country', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'ATT_ID'             => array('ATT_ID' => false),
-            'ATT_lname'          => array('ATT_lname' => true), // true means its already sorted
-            'ATT_fname'          => array('ATT_fname' => false),
-            'ATT_email'          => array('ATT_email' => false),
-            'Registration_Count' => array('Registration_Count' => false),
-            'ATT_city'           => array('ATT_city' => false),
-            'STA_ID'             => array('STA_ID' => false),
-            'CNT_ISO'            => array('CNT_ISO' => false),
-        );
-
-        $this->_hidden_columns = array(
-            'ATT_phone',
-            'ATT_address',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-        );
-    }
-
-
-    /**
-     * Initial setup of filters
-     *
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        return array();
-    }
-
-
-    /**
-     * Initial setup of counts for views
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true);
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_contacts',
-                'espresso_registrations_delete_registration'
-            )
-        ) {
-            $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true);
-        }
-    }
-
-
-    /**
-     * Get count of attendees.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_attendees_count()
-    {
-        return EEM_Attendee::instance()->count();
-    }
-
-
-    /**
-     * Checkbox column
-     *
-     * @param EE_Attendee $attendee Unable to typehint this method because overrides parent.
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_cb($attendee)
-    {
-        if (! $attendee instanceof EE_Attendee) {
-            return '';
-        }
-        return sprintf(
-            '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-            $attendee->ID()
-        );
-    }
-
-
-    /**
-     * ATT_ID column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_ATT_ID(EE_Attendee $attendee)
-    {
-        $content = $attendee->ID();
-        $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * ATT_lname column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     */
-    public function column_ATT_lname(EE_Attendee $attendee)
-    {
-        // edit attendee link
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">'
-              . $attendee->lname() . '</a>'
-            : $attendee->lname();
-        return $name_link;
-    }
-
-
-    /**
-     * ATT_fname column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     */
-    public function column_ATT_fname(EE_Attendee $attendee)
-    {
-        // Build row actions
-        $actions = array();
-        // edit attendee link
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_contacts',
-                'espresso_registrations_edit_attendee'
-            )
-        ) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'edit_attendee',
-                    'post'   => $attendee->ID(),
-                ),
-                REG_ADMIN_URL
-            );
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Contact', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso') . '</a>';
-        }
-
-        if ($this->_view === 'in_use') {
-            // trash attendee link
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_contacts',
-                    'espresso_registrations_trash_attendees'
-                )
-            ) {
-                $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'trash_attendee',
-                        'ATT_ID' => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                    . esc_attr__('Move Contact to Trash', 'event_espresso')
-                                    . '">' . esc_html__('Trash', 'event_espresso') . '</a>';
-            }
-        } else {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_contacts',
-                    'espresso_registrations_restore_attendees'
-                )
-            ) {
-                // restore attendee link
-                $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'restore_attendees',
-                        'ATT_ID' => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                      . esc_attr__('Restore Contact', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-            }
-        }
-
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
-            : $attendee->fname();
-
-        // Return the name contents
-        return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions));
-    }
-
-
-    /**
-     * Email Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_ATT_email(EE_Attendee $attendee)
-    {
-        return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
-    }
-
-
-    /**
-     * Column displaying count of registrations attached to Attendee.
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_Registration_Count(EE_Attendee $attendee)
-    {
-        $link = EEH_URL::add_query_args_and_nonce(
-            array(
-                'action' => 'default',
-                'ATT_ID' => $attendee->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
-    }
-
-
-    /**
-     * ATT_address column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_address(EE_Attendee $attendee)
-    {
-        return $attendee->address();
-    }
-
-
-    /**
-     * ATT_city column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_city(EE_Attendee $attendee)
-    {
-        return $attendee->city();
-    }
-
-
-    /**
-     * State Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_STA_ID(EE_Attendee $attendee)
-    {
-        $states = EEM_State::instance()->get_all_states();
-        $state = isset($states[ $attendee->state_ID() ])
-            ? $states[ $attendee->state_ID() ]->get('STA_name')
-            : $attendee->state_ID();
-        return ! is_numeric($state) ? $state : '';
-    }
-
-
-    /**
-     * Country Column
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_CNT_ISO(EE_Attendee $attendee)
-    {
-        $countries = EEM_Country::instance()->get_all_countries();
-        $country = isset($countries[ $attendee->country_ID() ])
-            ? $countries[ $attendee->country_ID() ]->get('CNT_name')
-            : $attendee->country_ID();
-        return ! is_numeric($country) ? $country : '';
-    }
-
-
-    /**
-     * Phone Number column
-     *
-     * @param EE_Attendee $attendee
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function column_ATT_phone(EE_Attendee $attendee)
-    {
-        return $attendee->phone();
-    }
+	/**
+	 * Initial setup of data (called by parent).
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_view !== 'trash'
+			? $this->_admin_page->get_attendees($this->_per_page)
+			: $this->_admin_page->get_attendees($this->_per_page, false, true);
+		$this->_all_data_count = $this->_view !== 'trash'
+			? $this->_admin_page->get_attendees($this->_per_page, true)
+			: $this->_admin_page->get_attendees($this->_per_page, true, true);
+	}
+
+
+	/**
+	 * Initial setup of properties.
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('attendee', 'event_espresso'),
+			'plural'   => esc_html__('attendees', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'                 => '<input type="checkbox" />', // Render a checkbox instead of text
+			'ATT_ID'             => esc_html__('ID', 'event_espresso'),
+			'ATT_fname'          => esc_html__('First Name', 'event_espresso'),
+			'ATT_lname'          => esc_html__('Last Name', 'event_espresso'),
+			'ATT_email'          => esc_html__('Email Address', 'event_espresso'),
+			'Registration_Count' => esc_html__('# Registrations', 'event_espresso'),
+			'ATT_phone'          => esc_html__('Phone', 'event_espresso'),
+			'ATT_address'        => esc_html__('Address', 'event_espresso'),
+			'ATT_city'           => esc_html__('City', 'event_espresso'),
+			'STA_ID'             => esc_html__('State/Province', 'event_espresso'),
+			'CNT_ISO'            => esc_html__('Country', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'ATT_ID'             => array('ATT_ID' => false),
+			'ATT_lname'          => array('ATT_lname' => true), // true means its already sorted
+			'ATT_fname'          => array('ATT_fname' => false),
+			'ATT_email'          => array('ATT_email' => false),
+			'Registration_Count' => array('Registration_Count' => false),
+			'ATT_city'           => array('ATT_city' => false),
+			'STA_ID'             => array('STA_ID' => false),
+			'CNT_ISO'            => array('CNT_ISO' => false),
+		);
+
+		$this->_hidden_columns = array(
+			'ATT_phone',
+			'ATT_address',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+		);
+	}
+
+
+	/**
+	 * Initial setup of filters
+	 *
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		return array();
+	}
+
+
+	/**
+	 * Initial setup of counts for views
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true);
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_contacts',
+				'espresso_registrations_delete_registration'
+			)
+		) {
+			$this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true);
+		}
+	}
+
+
+	/**
+	 * Get count of attendees.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_attendees_count()
+	{
+		return EEM_Attendee::instance()->count();
+	}
+
+
+	/**
+	 * Checkbox column
+	 *
+	 * @param EE_Attendee $attendee Unable to typehint this method because overrides parent.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_cb($attendee)
+	{
+		if (! $attendee instanceof EE_Attendee) {
+			return '';
+		}
+		return sprintf(
+			'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+			$attendee->ID()
+		);
+	}
+
+
+	/**
+	 * ATT_ID column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_ATT_ID(EE_Attendee $attendee)
+	{
+		$content = $attendee->ID();
+		$attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
+		$content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * ATT_lname column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 */
+	public function column_ATT_lname(EE_Attendee $attendee)
+	{
+		// edit attendee link
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Contact', 'event_espresso') . '">'
+			  . $attendee->lname() . '</a>'
+			: $attendee->lname();
+		return $name_link;
+	}
+
+
+	/**
+	 * ATT_fname column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 */
+	public function column_ATT_fname(EE_Attendee $attendee)
+	{
+		// Build row actions
+		$actions = array();
+		// edit attendee link
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_contacts',
+				'espresso_registrations_edit_attendee'
+			)
+		) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'edit_attendee',
+					'post'   => $attendee->ID(),
+				),
+				REG_ADMIN_URL
+			);
+			$actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
+							   . esc_attr__('Edit Contact', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso') . '</a>';
+		}
+
+		if ($this->_view === 'in_use') {
+			// trash attendee link
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_contacts',
+					'espresso_registrations_trash_attendees'
+				)
+			) {
+				$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'trash_attendee',
+						'ATT_ID' => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+									. esc_attr__('Move Contact to Trash', 'event_espresso')
+									. '">' . esc_html__('Trash', 'event_espresso') . '</a>';
+			}
+		} else {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_contacts',
+					'espresso_registrations_restore_attendees'
+				)
+			) {
+				// restore attendee link
+				$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'restore_attendees',
+						'ATT_ID' => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
+									  . esc_attr__('Restore Contact', 'event_espresso') . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+			}
+		}
+
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
+			: $attendee->fname();
+
+		// Return the name contents
+		return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions));
+	}
+
+
+	/**
+	 * Email Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_ATT_email(EE_Attendee $attendee)
+	{
+		return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
+	}
+
+
+	/**
+	 * Column displaying count of registrations attached to Attendee.
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_Registration_Count(EE_Attendee $attendee)
+	{
+		$link = EEH_URL::add_query_args_and_nonce(
+			array(
+				'action' => 'default',
+				'ATT_ID' => $attendee->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
+	}
+
+
+	/**
+	 * ATT_address column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_address(EE_Attendee $attendee)
+	{
+		return $attendee->address();
+	}
+
+
+	/**
+	 * ATT_city column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_city(EE_Attendee $attendee)
+	{
+		return $attendee->city();
+	}
+
+
+	/**
+	 * State Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_STA_ID(EE_Attendee $attendee)
+	{
+		$states = EEM_State::instance()->get_all_states();
+		$state = isset($states[ $attendee->state_ID() ])
+			? $states[ $attendee->state_ID() ]->get('STA_name')
+			: $attendee->state_ID();
+		return ! is_numeric($state) ? $state : '';
+	}
+
+
+	/**
+	 * Country Column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_CNT_ISO(EE_Attendee $attendee)
+	{
+		$countries = EEM_Country::instance()->get_all_countries();
+		$country = isset($countries[ $attendee->country_ID() ])
+			? $countries[ $attendee->country_ID() ]->get('CNT_name')
+			: $attendee->country_ID();
+		return ! is_numeric($country) ? $country : '';
+	}
+
+
+	/**
+	 * Phone Number column
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function column_ATT_phone(EE_Attendee $attendee)
+	{
+		return $attendee->phone();
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -129,7 +129,7 @@ 
      */
     public function column_cb($attendee)
     {
-        if (! $attendee instanceof EE_Attendee) {
+        if ( ! $attendee instanceof EE_Attendee) {
             return '';
         }
         return sprintf(
@@ -150,7 +150,7 @@ 
     {
         $content = $attendee->ID();
         $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-        $content .= '  <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$attendee_name.'</span>';
         return $content;
     }
 
@@ -179,9 +179,9 @@ 
             'ee_edit_contacts',
             'espresso_registrations_edit_attendee'
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">'
-              . $attendee->lname() . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Contact', 'event_espresso').'">'
+              . $attendee->lname().'</a>'
             : $attendee->lname();
         return $name_link;
     }
@@ -215,9 +215,9 @@ 
                 ),
                 REG_ADMIN_URL
             );
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Contact', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso') . '</a>';
+            $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="'
+                               . esc_attr__('Edit Contact', 'event_espresso').'">'
+                               . esc_html__('Edit', 'event_espresso').'</a>';
         }
 
         if ($this->_view === 'in_use') {
@@ -235,9 +235,9 @@ 
                     ),
                     REG_ADMIN_URL
                 );
-                $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+                $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'
                                     . esc_attr__('Move Contact to Trash', 'event_espresso')
-                                    . '">' . esc_html__('Trash', 'event_espresso') . '</a>';
+                                    . '">'.esc_html__('Trash', 'event_espresso').'</a>';
             }
         } else {
             if (
@@ -254,9 +254,9 @@ 
                     ),
                     REG_ADMIN_URL
                 );
-                $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                      . esc_attr__('Restore Contact', 'event_espresso') . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
+                $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'
+                                      . esc_attr__('Restore Contact', 'event_espresso').'">'
+                                      . esc_html__('Restore', 'event_espresso').'</a>';
             }
         }
 
@@ -271,8 +271,8 @@ 
             'ee_edit_contacts',
             'espresso_registrations_edit_attendee'
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Contact', 'event_espresso').'">'.$attendee->fname().'</a>'
             : $attendee->fname();
 
         // Return the name contents
@@ -289,7 +289,7 @@ 
      */
     public function column_ATT_email(EE_Attendee $attendee)
     {
-        return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>';
+        return '<a href="mailto:'.$attendee->email().'">'.$attendee->email().'</a>';
     }
 
 
@@ -309,7 +309,7 @@ 
             ),
             REG_ADMIN_URL
         );
-        return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>';
+        return '<a href="'.$link.'">'.$attendee->getCustomSelect('Registration_Count').'</a>';
     }
 
 
@@ -352,8 +352,8 @@ 
     public function column_STA_ID(EE_Attendee $attendee)
     {
         $states = EEM_State::instance()->get_all_states();
-        $state = isset($states[ $attendee->state_ID() ])
-            ? $states[ $attendee->state_ID() ]->get('STA_name')
+        $state = isset($states[$attendee->state_ID()])
+            ? $states[$attendee->state_ID()]->get('STA_name')
             : $attendee->state_ID();
         return ! is_numeric($state) ? $state : '';
     }
@@ -372,8 +372,8 @@ 
     public function column_CNT_ISO(EE_Attendee $attendee)
     {
         $countries = EEM_Country::instance()->get_all_countries();
-        $country = isset($countries[ $attendee->country_ID() ])
-            ? $countries[ $attendee->country_ID() ]->get('CNT_name')
+        $country = isset($countries[$attendee->country_ID()])
+            ? $countries[$attendee->country_ID()]->get('CNT_name')
             : $attendee->country_ID();
         return ! is_numeric($country) ? $country : '';
     }

core/db_classes/EE_Payment.class.php

Spacing +8 added lines, -8 removed lines

@@ -296,7 +296,7 @@ 
      */
     public function timestamp($dt_frmt = '', $tm_frmt = '')
     {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
+        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt.' '.$tm_frmt));
     }
 
 
@@ -481,7 +481,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->STS_ID() ];
+        return $icon.$status[$this->STS_ID()];
     }
 
 
@@ -627,7 +627,7 @@ 
     public function redirect_form($inside_form_html = null)
     {
         $redirect_url = $this->redirect_url();
-        if (! empty($redirect_url)) {
+        if ( ! empty($redirect_url)) {
             // what ? no inner form content?
             if ($inside_form_html === null) {
                 $inside_form_html = EEH_HTML::p(
@@ -657,7 +657,7 @@ 
                 $get_params = null;
                 parse_str($querystring, $get_params);
                 $inside_form_html .= $this->_args_as_inputs($get_params);
-                $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+                $redirect_url = str_replace('?'.$querystring, '', $redirect_url);
             }
             $form = EEH_HTML::nl(1)
                     . '<form method="'
@@ -665,9 +665,9 @@ 
                     . '" name="gateway_form" action="'
                     . $redirect_url
                     . '">';
-            $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+            $form .= EEH_HTML::nl(1).$this->redirect_args_as_inputs();
             $form .= $inside_form_html;
-            $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+            $form .= EEH_HTML::nl(-1).'</form>'.EEH_HTML::nl(-1);
             return $form;
         } else {
             return null;
@@ -725,8 +725,8 @@ 
             return $html;
         }
         return EEH_HTML::nl()
-            . '<input type="hidden" name="' . $name . '"'
-            . ' value="' . esc_attr($value) . '"/>';
+            . '<input type="hidden" name="'.$name.'"'
+            . ' value="'.esc_attr($value).'"/>';
     }
 
 

Indentation +870 added lines, -870 removed lines

@@ -11,874 +11,874 @@
  */
 class EE_Payment extends EE_Base_Class implements EEI_Payment
 {
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Payment
-     * @throws \EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Payment
-     * @throws \EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Set Transaction ID
-     *
-     * @access public
-     * @param int $TXN_ID
-     * @throws \EE_Error
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets the transaction related to this payment
-     *
-     * @return EE_Transaction
-     * @throws \EE_Error
-     */
-    public function transaction()
-    {
-        return $this->get_first_related('Transaction');
-    }
-
-
-    /**
-     * Set Status
-     *
-     * @access public
-     * @param string $STS_ID
-     * @throws \EE_Error
-     */
-    public function set_status($STS_ID = '')
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Set Payment Timestamp
-     *
-     * @access public
-     * @param int $timestamp
-     * @throws \EE_Error
-     */
-    public function set_timestamp($timestamp = 0)
-    {
-        $this->set('PAY_timestamp', $timestamp);
-    }
-
-
-    /**
-     * Set Payment Method
-     *
-     * @access public
-     * @param string $PAY_source
-     * @throws \EE_Error
-     */
-    public function set_source($PAY_source = '')
-    {
-        $this->set('PAY_source', $PAY_source);
-    }
-
-
-    /**
-     * Set Payment Amount
-     *
-     * @access public
-     * @param float $amount
-     * @throws \EE_Error
-     */
-    public function set_amount($amount = 0.00)
-    {
-        $this->set('PAY_amount', (float) $amount);
-    }
-
-
-    /**
-     * Set Payment Gateway Response
-     *
-     * @access public
-     * @param string $gateway_response
-     * @throws \EE_Error
-     */
-    public function set_gateway_response($gateway_response = '')
-    {
-        $this->set('PAY_gateway_response', $gateway_response);
-    }
-
-
-    /**
-     * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
-     * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
-     * used on it
-     *
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public function gateway()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment::gateway',
-            esc_html__(
-                'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
-                'event_espresso'
-            ),
-            '4.6.0'
-        );
-        return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
-    }
-
-
-    /**
-     * Set Gateway Transaction ID
-     *
-     * @access public
-     * @param string $txn_id_chq_nmbr
-     * @throws \EE_Error
-     */
-    public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
-    {
-        $this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
-    }
-
-
-    /**
-     * Set Purchase Order Number
-     *
-     * @access public
-     * @param string $po_number
-     * @throws \EE_Error
-     */
-    public function set_po_number($po_number = '')
-    {
-        $this->set('PAY_po_number', $po_number);
-    }
-
-
-    /**
-     * Set Extra Accounting Field
-     *
-     * @access public
-     * @param string $extra_accntng
-     * @throws \EE_Error
-     */
-    public function set_extra_accntng($extra_accntng = '')
-    {
-        $this->set('PAY_extra_accntng', $extra_accntng);
-    }
-
-
-    /**
-     * Set Payment made via admin flag
-     *
-     * @access public
-     * @param bool $via_admin
-     * @throws \EE_Error
-     */
-    public function set_payment_made_via_admin($via_admin = false)
-    {
-        if ($via_admin) {
-            $this->set('PAY_source', EEM_Payment_Method::scope_admin);
-        } else {
-            $this->set('PAY_source', EEM_Payment_Method::scope_cart);
-        }
-    }
-
-
-    /**
-     * Set Payment Details
-     *
-     * @access public
-     * @param string|array $details
-     * @throws \EE_Error
-     */
-    public function set_details($details = '')
-    {
-        if (is_array($details)) {
-            array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $details = wp_strip_all_tags($details);
-        }
-        $this->set('PAY_details', $details);
-    }
-
-
-    /**
-     * Sets redirect_url
-     *
-     * @param string $redirect_url
-     * @throws \EE_Error
-     */
-    public function set_redirect_url($redirect_url)
-    {
-        $this->set('PAY_redirect_url', $redirect_url);
-    }
-
-
-    /**
-     * Sets redirect_args
-     *
-     * @param array $redirect_args
-     * @throws \EE_Error
-     */
-    public function set_redirect_args($redirect_args)
-    {
-        $this->set('PAY_redirect_args', $redirect_args);
-    }
-
-
-    /**
-     * get Payment Transaction ID
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function status()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Timestamp
-     *
-     * @access public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
-    public function timestamp($dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
-    }
-
-
-    /**
-     * get Payment Source
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function source()
-    {
-        return $this->get('PAY_source');
-    }
-
-
-    /**
-     * get Payment Amount
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function amount()
-    {
-        return (float) $this->get('PAY_amount');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function amount_no_code()
-    {
-        return $this->get_pretty('PAY_amount', 'no_currency_code');
-    }
-
-
-    /**
-     * get Payment Gateway Response
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function gateway_response()
-    {
-        return $this->get('PAY_gateway_response');
-    }
-
-
-    /**
-     * get Payment Gateway Transaction ID
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function txn_id_chq_nmbr()
-    {
-        return $this->get('PAY_txn_id_chq_nmbr');
-    }
-
-
-    /**
-     * get Purchase Order Number
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function po_number()
-    {
-        return $this->get('PAY_po_number');
-    }
-
-
-    /**
-     * get Extra Accounting Field
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function extra_accntng()
-    {
-        return $this->get('PAY_extra_accntng');
-    }
-
-
-    /**
-     * get Payment made via admin source
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function payment_made_via_admin()
-    {
-        return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
-    }
-
-
-    /**
-     * get Payment Details
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function details()
-    {
-        return $this->get('PAY_details');
-    }
-
-
-    /**
-     * Gets redirect_url
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function redirect_url()
-    {
-        return $this->get('PAY_redirect_url');
-    }
-
-
-    /**
-     * Gets redirect_args
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function redirect_args()
-    {
-        return $this->get('PAY_redirect_args');
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws \EE_Error
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws \EE_Error
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->STS_ID() => esc_html__('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon = '';
-        switch ($this->STS_ID()) {
-            case EEM_Payment::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_pending:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->STS_ID() ];
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is approved or not
-     * @throws \EE_Error
-     */
-    public function is_approved()
-    {
-        return $this->status_is(EEM_Payment::status_id_approved);
-    }
-
-
-    /**
-     * Generally determines if the status of this payment equals
-     * the $STS_ID string
-     *
-     * @param string $STS_ID an ID from the esp_status table/
-     *                       one of the status_id_* on the EEM_Payment model
-     * @return boolean whether the status of this payment equals the status id
-     * @throws \EE_Error
-     */
-    protected function status_is($STS_ID)
-    {
-        return $STS_ID === $this->STS_ID() ? true : false;
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is pending or not
-     * @throws \EE_Error
-     */
-    public function is_pending()
-    {
-        return $this->status_is(EEM_Payment::status_id_pending);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_cancelled()
-    {
-        return $this->status_is(EEM_Payment::status_id_cancelled);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_declined()
-    {
-        return $this->status_is(EEM_Payment::status_id_declined);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_failed()
-    {
-        return $this->status_is(EEM_Payment::status_id_failed);
-    }
-
-
-    /**
-     * For determining if the payment is actually a refund ( ie: has a negative value )
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_a_refund()
-    {
-        return $this->amount() < 0 ? true : false;
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     * @throws \EE_Error
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Extra_Meta
-     * @throws \EE_Error
-     */
-    public function extra_meta($query_params = array())
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public function payment_method()
-    {
-        return $this->get_first_related('Payment_Method');
-    }
-
-
-    /**
-     * Gets the HTML for redirecting the user to an offsite gateway
-     * You can pass it special content to put inside the form, or use
-     * the default inner content (or possibly generate this all yourself using
-     * redirect_url() and redirect_args() or redirect_args_as_inputs()).
-     * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
-     * (and any querystring variables in the redirect_url are converted into html inputs
-     * so browsers submit them properly)
-     *
-     * @param string $inside_form_html
-     * @return string html
-     * @throws \EE_Error
-     */
-    public function redirect_form($inside_form_html = null)
-    {
-        $redirect_url = $this->redirect_url();
-        if (! empty($redirect_url)) {
-            // what ? no inner form content?
-            if ($inside_form_html === null) {
-                $inside_form_html = EEH_HTML::p(
-                    sprintf(
-                        esc_html__(
-                            'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
-                            'event_espresso'
-                        ),
-                        EEH_HTML::br(2),
-                        '<input type="submit" value="',
-                        '">'
-                    ),
-                    '',
-                    '',
-                    'text-align:center;'
-                );
-            }
-            $method = apply_filters(
-                'FHEE__EE_Payment__redirect_form__method',
-                $this->redirect_args() ? 'POST' : 'GET',
-                $this
-            );
-            // if it's a GET request, we need to remove all the GET params in the querystring
-            // and put them into the form instead
-            if ($method === 'GET') {
-                $querystring = parse_url($redirect_url, PHP_URL_QUERY);
-                $get_params = null;
-                parse_str($querystring, $get_params);
-                $inside_form_html .= $this->_args_as_inputs($get_params);
-                $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
-            }
-            $form = EEH_HTML::nl(1)
-                    . '<form method="'
-                    . $method
-                    . '" name="gateway_form" action="'
-                    . $redirect_url
-                    . '">';
-            $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
-            $form .= $inside_form_html;
-            $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
-            return $form;
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Changes all the name-value pairs of the redirect args into html inputs
-     * and returns the html as a string
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function redirect_args_as_inputs()
-    {
-        return $this->_args_as_inputs($this->redirect_args());
-    }
-
-
-    /**
-     * Converts a 2d array of key-value pairs into html hidden inputs
-     * and returns the string of html
-     *
-     * @param array $args key-value pairs
-     * @return string
-     */
-    protected function _args_as_inputs($args)
-    {
-        $html = '';
-        if ($args !== null && is_array($args)) {
-            foreach ($args as $name => $value) {
-                $html .= $this->generateInput($name, $value);
-            }
-        }
-        return $html;
-    }
-
-    /**
-     * Converts either a single name and value or array of values into html hidden inputs
-     * and returns the string of html
-     *
-     * @param string $name
-     * @param string|array $value
-     * @return string
-     */
-    private function generateInput($name, $value)
-    {
-        if (is_array($value)) {
-            $html = '';
-            $name = "{$name}[]";
-            foreach ($value as $array_value) {
-                $html .= $this->generateInput($name, $array_value);
-            }
-            return $html;
-        }
-        return EEH_HTML::nl()
-            . '<input type="hidden" name="' . $name . '"'
-            . ' value="' . esc_attr($value) . '"/>';
-    }
-
-
-    /**
-     * Returns the currency of the payment.
-     * (At the time of writing, this will always be the currency in the configuration;
-     * however in the future it is anticipated that this will be stored on the payment
-     * object itself)
-     *
-     * @return string for the currency code
-     */
-    public function currency_code()
-    {
-        return EE_Config::instance()->currency->code;
-    }
-
-
-    /**
-     * apply wp_strip_all_tags to all elements within an array
-     *
-     * @access private
-     * @param mixed $item
-     */
-    private function _strip_all_tags_within_array(&$item)
-    {
-        if (is_object($item)) {
-            $item = (array) $item;
-        }
-        if (is_array($item)) {
-            array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $item = wp_strip_all_tags($item);
-        }
-    }
-
-
-    /**
-     * Returns TRUE is this payment was set to approved during this request (or
-     * is approved and was created during this request). False otherwise.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function just_approved()
-    {
-        $original_status = EEH_Array::is_set(
-            $this->_props_n_values_provided_in_constructor,
-            'STS_ID',
-            $this->get_model()->field_settings_for('STS_ID')->get_default_value()
-        );
-        $current_status = $this->status();
-        if (
-            $original_status !== EEM_Payment::status_id_approved
-            && $current_status === EEM_Payment::status_id_approved
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Overrides parents' get_pretty() function just for legacy reasons
-     * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        if ($field_name === 'PAY_gateway') {
-            return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
-        }
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-    /**
-     * Gets details regarding which registrations this payment was applied to
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Registration_Payment[]
-     * @throws \EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @return EE_Event|null
-     */
-    public function get_first_event()
-    {
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $primary_registrant = $transaction->primary_registration();
-            if ($primary_registrant instanceof EE_Registration) {
-                return $primary_registrant->event_obj();
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @return string
-     */
-    public function get_first_event_name()
-    {
-        $event = $this->get_first_event();
-        return $event instanceof EE_Event ? $event->name() : esc_html__('Event', 'event_espresso');
-    }
-
-
-    /**
-     * Returns the payment's transaction's primary registration
-     *
-     * @return EE_Registration|null
-     */
-    public function get_primary_registration()
-    {
-        if ($this->transaction() instanceof EE_Transaction) {
-            return $this->transaction()->primary_registration();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the payment's transaction's primary registration's attendee, or null
-     *
-     * @return EE_Attendee|null
-     */
-    public function get_primary_attendee()
-    {
-        $primary_reg = $this->get_primary_registration();
-        if ($primary_reg instanceof EE_Registration) {
-            return $primary_reg->attendee();
-        }
-        return null;
-    }
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Payment
+	 * @throws \EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Payment
+	 * @throws \EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Set Transaction ID
+	 *
+	 * @access public
+	 * @param int $TXN_ID
+	 * @throws \EE_Error
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets the transaction related to this payment
+	 *
+	 * @return EE_Transaction
+	 * @throws \EE_Error
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related('Transaction');
+	}
+
+
+	/**
+	 * Set Status
+	 *
+	 * @access public
+	 * @param string $STS_ID
+	 * @throws \EE_Error
+	 */
+	public function set_status($STS_ID = '')
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Set Payment Timestamp
+	 *
+	 * @access public
+	 * @param int $timestamp
+	 * @throws \EE_Error
+	 */
+	public function set_timestamp($timestamp = 0)
+	{
+		$this->set('PAY_timestamp', $timestamp);
+	}
+
+
+	/**
+	 * Set Payment Method
+	 *
+	 * @access public
+	 * @param string $PAY_source
+	 * @throws \EE_Error
+	 */
+	public function set_source($PAY_source = '')
+	{
+		$this->set('PAY_source', $PAY_source);
+	}
+
+
+	/**
+	 * Set Payment Amount
+	 *
+	 * @access public
+	 * @param float $amount
+	 * @throws \EE_Error
+	 */
+	public function set_amount($amount = 0.00)
+	{
+		$this->set('PAY_amount', (float) $amount);
+	}
+
+
+	/**
+	 * Set Payment Gateway Response
+	 *
+	 * @access public
+	 * @param string $gateway_response
+	 * @throws \EE_Error
+	 */
+	public function set_gateway_response($gateway_response = '')
+	{
+		$this->set('PAY_gateway_response', $gateway_response);
+	}
+
+
+	/**
+	 * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
+	 * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
+	 * used on it
+	 *
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function gateway()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment::gateway',
+			esc_html__(
+				'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
+				'event_espresso'
+			),
+			'4.6.0'
+		);
+		return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
+	}
+
+
+	/**
+	 * Set Gateway Transaction ID
+	 *
+	 * @access public
+	 * @param string $txn_id_chq_nmbr
+	 * @throws \EE_Error
+	 */
+	public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
+	{
+		$this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
+	}
+
+
+	/**
+	 * Set Purchase Order Number
+	 *
+	 * @access public
+	 * @param string $po_number
+	 * @throws \EE_Error
+	 */
+	public function set_po_number($po_number = '')
+	{
+		$this->set('PAY_po_number', $po_number);
+	}
+
+
+	/**
+	 * Set Extra Accounting Field
+	 *
+	 * @access public
+	 * @param string $extra_accntng
+	 * @throws \EE_Error
+	 */
+	public function set_extra_accntng($extra_accntng = '')
+	{
+		$this->set('PAY_extra_accntng', $extra_accntng);
+	}
+
+
+	/**
+	 * Set Payment made via admin flag
+	 *
+	 * @access public
+	 * @param bool $via_admin
+	 * @throws \EE_Error
+	 */
+	public function set_payment_made_via_admin($via_admin = false)
+	{
+		if ($via_admin) {
+			$this->set('PAY_source', EEM_Payment_Method::scope_admin);
+		} else {
+			$this->set('PAY_source', EEM_Payment_Method::scope_cart);
+		}
+	}
+
+
+	/**
+	 * Set Payment Details
+	 *
+	 * @access public
+	 * @param string|array $details
+	 * @throws \EE_Error
+	 */
+	public function set_details($details = '')
+	{
+		if (is_array($details)) {
+			array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$details = wp_strip_all_tags($details);
+		}
+		$this->set('PAY_details', $details);
+	}
+
+
+	/**
+	 * Sets redirect_url
+	 *
+	 * @param string $redirect_url
+	 * @throws \EE_Error
+	 */
+	public function set_redirect_url($redirect_url)
+	{
+		$this->set('PAY_redirect_url', $redirect_url);
+	}
+
+
+	/**
+	 * Sets redirect_args
+	 *
+	 * @param array $redirect_args
+	 * @throws \EE_Error
+	 */
+	public function set_redirect_args($redirect_args)
+	{
+		$this->set('PAY_redirect_args', $redirect_args);
+	}
+
+
+	/**
+	 * get Payment Transaction ID
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function status()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Timestamp
+	 *
+	 * @access public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function timestamp($dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
+	}
+
+
+	/**
+	 * get Payment Source
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function source()
+	{
+		return $this->get('PAY_source');
+	}
+
+
+	/**
+	 * get Payment Amount
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function amount()
+	{
+		return (float) $this->get('PAY_amount');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function amount_no_code()
+	{
+		return $this->get_pretty('PAY_amount', 'no_currency_code');
+	}
+
+
+	/**
+	 * get Payment Gateway Response
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function gateway_response()
+	{
+		return $this->get('PAY_gateway_response');
+	}
+
+
+	/**
+	 * get Payment Gateway Transaction ID
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function txn_id_chq_nmbr()
+	{
+		return $this->get('PAY_txn_id_chq_nmbr');
+	}
+
+
+	/**
+	 * get Purchase Order Number
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function po_number()
+	{
+		return $this->get('PAY_po_number');
+	}
+
+
+	/**
+	 * get Extra Accounting Field
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function extra_accntng()
+	{
+		return $this->get('PAY_extra_accntng');
+	}
+
+
+	/**
+	 * get Payment made via admin source
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function payment_made_via_admin()
+	{
+		return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
+	}
+
+
+	/**
+	 * get Payment Details
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function details()
+	{
+		return $this->get('PAY_details');
+	}
+
+
+	/**
+	 * Gets redirect_url
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function redirect_url()
+	{
+		return $this->get('PAY_redirect_url');
+	}
+
+
+	/**
+	 * Gets redirect_args
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function redirect_args()
+	{
+		return $this->get('PAY_redirect_args');
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->STS_ID() => esc_html__('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon = '';
+		switch ($this->STS_ID()) {
+			case EEM_Payment::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_pending:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->STS_ID() ];
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is approved or not
+	 * @throws \EE_Error
+	 */
+	public function is_approved()
+	{
+		return $this->status_is(EEM_Payment::status_id_approved);
+	}
+
+
+	/**
+	 * Generally determines if the status of this payment equals
+	 * the $STS_ID string
+	 *
+	 * @param string $STS_ID an ID from the esp_status table/
+	 *                       one of the status_id_* on the EEM_Payment model
+	 * @return boolean whether the status of this payment equals the status id
+	 * @throws \EE_Error
+	 */
+	protected function status_is($STS_ID)
+	{
+		return $STS_ID === $this->STS_ID() ? true : false;
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is pending or not
+	 * @throws \EE_Error
+	 */
+	public function is_pending()
+	{
+		return $this->status_is(EEM_Payment::status_id_pending);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_is(EEM_Payment::status_id_cancelled);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_declined()
+	{
+		return $this->status_is(EEM_Payment::status_id_declined);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_failed()
+	{
+		return $this->status_is(EEM_Payment::status_id_failed);
+	}
+
+
+	/**
+	 * For determining if the payment is actually a refund ( ie: has a negative value )
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_a_refund()
+	{
+		return $this->amount() < 0 ? true : false;
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 * @throws \EE_Error
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Extra_Meta
+	 * @throws \EE_Error
+	 */
+	public function extra_meta($query_params = array())
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public function payment_method()
+	{
+		return $this->get_first_related('Payment_Method');
+	}
+
+
+	/**
+	 * Gets the HTML for redirecting the user to an offsite gateway
+	 * You can pass it special content to put inside the form, or use
+	 * the default inner content (or possibly generate this all yourself using
+	 * redirect_url() and redirect_args() or redirect_args_as_inputs()).
+	 * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
+	 * (and any querystring variables in the redirect_url are converted into html inputs
+	 * so browsers submit them properly)
+	 *
+	 * @param string $inside_form_html
+	 * @return string html
+	 * @throws \EE_Error
+	 */
+	public function redirect_form($inside_form_html = null)
+	{
+		$redirect_url = $this->redirect_url();
+		if (! empty($redirect_url)) {
+			// what ? no inner form content?
+			if ($inside_form_html === null) {
+				$inside_form_html = EEH_HTML::p(
+					sprintf(
+						esc_html__(
+							'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
+							'event_espresso'
+						),
+						EEH_HTML::br(2),
+						'<input type="submit" value="',
+						'">'
+					),
+					'',
+					'',
+					'text-align:center;'
+				);
+			}
+			$method = apply_filters(
+				'FHEE__EE_Payment__redirect_form__method',
+				$this->redirect_args() ? 'POST' : 'GET',
+				$this
+			);
+			// if it's a GET request, we need to remove all the GET params in the querystring
+			// and put them into the form instead
+			if ($method === 'GET') {
+				$querystring = parse_url($redirect_url, PHP_URL_QUERY);
+				$get_params = null;
+				parse_str($querystring, $get_params);
+				$inside_form_html .= $this->_args_as_inputs($get_params);
+				$redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+			}
+			$form = EEH_HTML::nl(1)
+					. '<form method="'
+					. $method
+					. '" name="gateway_form" action="'
+					. $redirect_url
+					. '">';
+			$form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+			$form .= $inside_form_html;
+			$form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+			return $form;
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Changes all the name-value pairs of the redirect args into html inputs
+	 * and returns the html as a string
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function redirect_args_as_inputs()
+	{
+		return $this->_args_as_inputs($this->redirect_args());
+	}
+
+
+	/**
+	 * Converts a 2d array of key-value pairs into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param array $args key-value pairs
+	 * @return string
+	 */
+	protected function _args_as_inputs($args)
+	{
+		$html = '';
+		if ($args !== null && is_array($args)) {
+			foreach ($args as $name => $value) {
+				$html .= $this->generateInput($name, $value);
+			}
+		}
+		return $html;
+	}
+
+	/**
+	 * Converts either a single name and value or array of values into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param string $name
+	 * @param string|array $value
+	 * @return string
+	 */
+	private function generateInput($name, $value)
+	{
+		if (is_array($value)) {
+			$html = '';
+			$name = "{$name}[]";
+			foreach ($value as $array_value) {
+				$html .= $this->generateInput($name, $array_value);
+			}
+			return $html;
+		}
+		return EEH_HTML::nl()
+			. '<input type="hidden" name="' . $name . '"'
+			. ' value="' . esc_attr($value) . '"/>';
+	}
+
+
+	/**
+	 * Returns the currency of the payment.
+	 * (At the time of writing, this will always be the currency in the configuration;
+	 * however in the future it is anticipated that this will be stored on the payment
+	 * object itself)
+	 *
+	 * @return string for the currency code
+	 */
+	public function currency_code()
+	{
+		return EE_Config::instance()->currency->code;
+	}
+
+
+	/**
+	 * apply wp_strip_all_tags to all elements within an array
+	 *
+	 * @access private
+	 * @param mixed $item
+	 */
+	private function _strip_all_tags_within_array(&$item)
+	{
+		if (is_object($item)) {
+			$item = (array) $item;
+		}
+		if (is_array($item)) {
+			array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$item = wp_strip_all_tags($item);
+		}
+	}
+
+
+	/**
+	 * Returns TRUE is this payment was set to approved during this request (or
+	 * is approved and was created during this request). False otherwise.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function just_approved()
+	{
+		$original_status = EEH_Array::is_set(
+			$this->_props_n_values_provided_in_constructor,
+			'STS_ID',
+			$this->get_model()->field_settings_for('STS_ID')->get_default_value()
+		);
+		$current_status = $this->status();
+		if (
+			$original_status !== EEM_Payment::status_id_approved
+			&& $current_status === EEM_Payment::status_id_approved
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Overrides parents' get_pretty() function just for legacy reasons
+	 * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		if ($field_name === 'PAY_gateway') {
+			return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
+		}
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+	/**
+	 * Gets details regarding which registrations this payment was applied to
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Registration_Payment[]
+	 * @throws \EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @return EE_Event|null
+	 */
+	public function get_first_event()
+	{
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$primary_registrant = $transaction->primary_registration();
+			if ($primary_registrant instanceof EE_Registration) {
+				return $primary_registrant->event_obj();
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @return string
+	 */
+	public function get_first_event_name()
+	{
+		$event = $this->get_first_event();
+		return $event instanceof EE_Event ? $event->name() : esc_html__('Event', 'event_espresso');
+	}
+
+
+	/**
+	 * Returns the payment's transaction's primary registration
+	 *
+	 * @return EE_Registration|null
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->transaction() instanceof EE_Transaction) {
+			return $this->transaction()->primary_registration();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the payment's transaction's primary registration's attendee, or null
+	 *
+	 * @return EE_Attendee|null
+	 */
+	public function get_primary_attendee()
+	{
+		$primary_reg = $this->get_primary_registration();
+		if ($primary_reg instanceof EE_Registration) {
+			return $primary_reg->attendee();
+		}
+		return null;
+	}
 }

core/db_classes/EE_Payment_Method.class.php

Spacing +8 added lines, -8 removed lines

@@ -445,11 +445,11 @@ 
      */
     public function type_obj()
     {
-        if (! $this->_type_obj) {
+        if ( ! $this->_type_obj) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
                 $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
+                if ( ! class_exists($class_name)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -458,7 +458,7 @@ 
                             ),
                             $class_name,
                             '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
+                            '<a href="'.admin_url('plugins.php').'">',
                             '</a>'
                         )
                     );
@@ -499,7 +499,7 @@ 
         foreach ($fields as $key => $value) {
             if (strpos($key, 'PMD_') === 0) {
                 $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
+                $combined_settings_array [$key_sans_model_prefix] = $value;
             }
         }
         $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
@@ -522,14 +522,14 @@ 
 		 <div id="'
                . $this->slug()
                . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+               . $payment_occurs.'-payment-gateway reg-page-payment-option-dv'.$css_class.'">
 			<a id="payment-gateway-button-' . $this->slug()
                . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
-				<img src="' . $this->button_url() . '" alt="' . sprintf(
+               . $this->slug().'" href="'.$url.'" >
+				<img src="' . $this->button_url().'" alt="'.sprintf(
                    esc_attr__('Pay using %s', 'event_espresso'),
                    $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+               ).'" />
 			</a>
 		</div>
 ';

Indentation +572 added lines, -572 removed lines

@@ -13,582 +13,582 @@
  */
 class EE_Payment_Method extends EE_Base_Class
 {
-    /**
-     * Payment Method type object, which has all the info about this type of payment method,
-     * including functions for processing payments, to get settings forms, etc.
-     *
-     * @var EE_PMT_Base
-     */
-    protected $_type_obj;
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values, false);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-
-    /**
-     * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
-     * Otherwise returns a normal EE_Payment_Method
-     *
-     * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
-     *                              the classname minus 'EEPM_')
-     * @return string
-     */
-    // private static function _payment_method_type($props_n_values)
-    // {
-    //     EE_Registry::instance()->load_lib('Payment_Method_Manager');
-    //     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
-    //     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
-    //         return 'EEPM_' . $type_string;
-    //     } else {
-    //         return __CLASS__;
-    //     }
-    // }
-
-
-    /**
-     * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
-     *
-     * @return boolean
-     */
-    public function active()
-    {
-        return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
-    }
-
-
-    /**
-     * Sets this PM as active by making it usable within the CART scope. Offline gateways
-     * are also usable from the admin-scope as well. DOES NOT SAVE it
-     *
-     * @throws \EE_Error
-     */
-    public function set_active()
-    {
-        $default_scopes = array(EEM_Payment_Method::scope_cart);
-        if (
-            $this->type_obj() &&
-            $this->type_obj()->payment_occurs() === EE_PMT_Base::offline
-        ) {
-            $default_scopes[] = EEM_Payment_Method::scope_admin;
-        }
-        $this->set_scope($default_scopes);
-    }
-
-
-    /**
-     * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
-     */
-    public function deactivate()
-    {
-        $this->set_scope(array());
-    }
-
-
-    /**
-     * Gets button_url
-     *
-     * @return string
-     */
-    public function button_url()
-    {
-        return $this->get('PMD_button_url');
-    }
-
-
-    /**
-     * Sets button_url
-     *
-     * @param string $button_url
-     */
-    public function set_button_url($button_url)
-    {
-        $this->set('PMD_button_url', $button_url);
-    }
-
-
-    /**
-     * Gets debug_mode
-     *
-     * @return boolean
-     */
-    public function debug_mode()
-    {
-        return $this->get('PMD_debug_mode');
-    }
-
-
-    /**
-     * Sets debug_mode
-     *
-     * @param boolean $debug_mode
-     */
-    public function set_debug_mode($debug_mode)
-    {
-        $this->set('PMD_debug_mode', $debug_mode);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     */
-    public function description()
-    {
-        return $this->get('PMD_desc');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     */
-    public function set_description($description)
-    {
-        $this->set('PMD_desc', $description);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('PMD_name');
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     */
-    public function set_name($name)
-    {
-        $this->set('PMD_name', $name);
-    }
-
-
-    /**
-     * Gets open_by_default
-     *
-     * @return boolean
-     */
-    public function open_by_default()
-    {
-        return $this->get('PMD_open_by_default');
-    }
-
-
-    /**
-     * Sets open_by_default
-     *
-     * @param boolean $open_by_default
-     */
-    public function set_open_by_default($open_by_default)
-    {
-        $this->set('PMD_open_by_default', $open_by_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('PMD_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->set('PMD_order', $order);
-    }
-
-
-    /**
-     * Gets slug
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->get('PMD_slug');
-    }
-
-
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     */
-    public function set_slug($slug)
-    {
-        $this->set('PMD_slug', $slug);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('PMD_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     */
-    public function set_type($type)
-    {
-        $this->set('PMD_type', $type);
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('PMD_wp_user');
-    }
-
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('PMD_wp_user', $wp_user_id);
-    }
-
-    /**
-     * Overrides parent so when PMD_type is changed we refresh the _type_obj
-     *
-     * @param string $field_name
-     * @param mixed $field_value
-     * @param boolean $use_default
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'PMD_type') {
-            // the type has probably changed, so forget about its old type object
-            $this->_type_obj = null;
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * Gets admin_name
-     *
-     * @return string
-     */
-    public function admin_name()
-    {
-        return $this->get('PMD_admin_name');
-    }
-
-
-    /**
-     * Sets admin_name
-     *
-     * @param string $admin_name
-     */
-    public function set_admin_name($admin_name)
-    {
-        $this->set('PMD_admin_name', $admin_name);
-    }
-
-
-    /**
-     * Gets admin_desc
-     *
-     * @return string
-     */
-    public function admin_desc()
-    {
-        return $this->get('PMD_admin_desc');
-    }
-
-
-    /**
-     * Sets admin_desc
-     *
-     * @param string $admin_desc
-     */
-    public function set_admin_desc($admin_desc)
-    {
-        $this->set('PMD_admin_desc', $admin_desc);
-    }
-
-
-    /**
-     * Gets scope
-     *
-     * @return array
-     */
-    public function scope()
-    {
-        return $this->get('PMD_scope');
-    }
-
-
-    /**
-     * Sets scope
-     *
-     * @param array $scope
-     */
-    public function set_scope($scope)
-    {
-        $this->set('PMD_scope', $scope);
-    }
-
-
-    /**
-     * Gets the payment method type for this payment method instance
-     *
-     * @return EE_PMT_Base
-     * @throws EE_Error
-     */
-    public function type_obj()
-    {
-        if (! $this->_type_obj) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
-                $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
-                                'event_espresso'
-                            ),
-                            $class_name,
-                            '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
-                            '</a>'
-                        )
-                    );
-                }
-                $r = new ReflectionClass($class_name);
-                $this->_type_obj = $r->newInstanceArgs(array($this));
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->type(),
-                        implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
-                    )
-                );
-            }
-        }
-        return $this->_type_obj;
-    }
-
-
-    /**
-     * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
-     * and the extra meta. Mostly used for passing off ot gateways.     *
-     *
-     * @return array
-     */
-    public function settings_array()
-    {
-        $fields = $this->model_field_array();
-        $extra_meta = $this->all_extra_meta_array();
-        // remove the model's prefix from the fields
-        $combined_settings_array = array();
-        foreach ($fields as $key => $value) {
-            if (strpos($key, 'PMD_') === 0) {
-                $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
-            }
-        }
-        $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
-        return $combined_settings_array;
-    }
-
-
-    /**
-     * Gets the HTML for displaying the payment method on a page.
-     *
-     * @param string $url
-     * @param string $css_class
-     * @return string of HTML for displaying the button
-     * @throws \EE_Error
-     */
-    public function button_html($url = '', $css_class = '')
-    {
-        $payment_occurs = $this->type_obj()->payment_occurs();
-        return '
+	/**
+	 * Payment Method type object, which has all the info about this type of payment method,
+	 * including functions for processing payments, to get settings forms, etc.
+	 *
+	 * @var EE_PMT_Base
+	 */
+	protected $_type_obj;
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values, false);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+
+	/**
+	 * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
+	 * Otherwise returns a normal EE_Payment_Method
+	 *
+	 * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
+	 *                              the classname minus 'EEPM_')
+	 * @return string
+	 */
+	// private static function _payment_method_type($props_n_values)
+	// {
+	//     EE_Registry::instance()->load_lib('Payment_Method_Manager');
+	//     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
+	//     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
+	//         return 'EEPM_' . $type_string;
+	//     } else {
+	//         return __CLASS__;
+	//     }
+	// }
+
+
+	/**
+	 * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
+	 *
+	 * @return boolean
+	 */
+	public function active()
+	{
+		return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
+	}
+
+
+	/**
+	 * Sets this PM as active by making it usable within the CART scope. Offline gateways
+	 * are also usable from the admin-scope as well. DOES NOT SAVE it
+	 *
+	 * @throws \EE_Error
+	 */
+	public function set_active()
+	{
+		$default_scopes = array(EEM_Payment_Method::scope_cart);
+		if (
+			$this->type_obj() &&
+			$this->type_obj()->payment_occurs() === EE_PMT_Base::offline
+		) {
+			$default_scopes[] = EEM_Payment_Method::scope_admin;
+		}
+		$this->set_scope($default_scopes);
+	}
+
+
+	/**
+	 * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
+	 */
+	public function deactivate()
+	{
+		$this->set_scope(array());
+	}
+
+
+	/**
+	 * Gets button_url
+	 *
+	 * @return string
+	 */
+	public function button_url()
+	{
+		return $this->get('PMD_button_url');
+	}
+
+
+	/**
+	 * Sets button_url
+	 *
+	 * @param string $button_url
+	 */
+	public function set_button_url($button_url)
+	{
+		$this->set('PMD_button_url', $button_url);
+	}
+
+
+	/**
+	 * Gets debug_mode
+	 *
+	 * @return boolean
+	 */
+	public function debug_mode()
+	{
+		return $this->get('PMD_debug_mode');
+	}
+
+
+	/**
+	 * Sets debug_mode
+	 *
+	 * @param boolean $debug_mode
+	 */
+	public function set_debug_mode($debug_mode)
+	{
+		$this->set('PMD_debug_mode', $debug_mode);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->get('PMD_desc');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 */
+	public function set_description($description)
+	{
+		$this->set('PMD_desc', $description);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('PMD_name');
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 */
+	public function set_name($name)
+	{
+		$this->set('PMD_name', $name);
+	}
+
+
+	/**
+	 * Gets open_by_default
+	 *
+	 * @return boolean
+	 */
+	public function open_by_default()
+	{
+		return $this->get('PMD_open_by_default');
+	}
+
+
+	/**
+	 * Sets open_by_default
+	 *
+	 * @param boolean $open_by_default
+	 */
+	public function set_open_by_default($open_by_default)
+	{
+		$this->set('PMD_open_by_default', $open_by_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('PMD_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->set('PMD_order', $order);
+	}
+
+
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->get('PMD_slug');
+	}
+
+
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('PMD_slug', $slug);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('PMD_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 */
+	public function set_type($type)
+	{
+		$this->set('PMD_type', $type);
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('PMD_wp_user');
+	}
+
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('PMD_wp_user', $wp_user_id);
+	}
+
+	/**
+	 * Overrides parent so when PMD_type is changed we refresh the _type_obj
+	 *
+	 * @param string $field_name
+	 * @param mixed $field_value
+	 * @param boolean $use_default
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'PMD_type') {
+			// the type has probably changed, so forget about its old type object
+			$this->_type_obj = null;
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * Gets admin_name
+	 *
+	 * @return string
+	 */
+	public function admin_name()
+	{
+		return $this->get('PMD_admin_name');
+	}
+
+
+	/**
+	 * Sets admin_name
+	 *
+	 * @param string $admin_name
+	 */
+	public function set_admin_name($admin_name)
+	{
+		$this->set('PMD_admin_name', $admin_name);
+	}
+
+
+	/**
+	 * Gets admin_desc
+	 *
+	 * @return string
+	 */
+	public function admin_desc()
+	{
+		return $this->get('PMD_admin_desc');
+	}
+
+
+	/**
+	 * Sets admin_desc
+	 *
+	 * @param string $admin_desc
+	 */
+	public function set_admin_desc($admin_desc)
+	{
+		$this->set('PMD_admin_desc', $admin_desc);
+	}
+
+
+	/**
+	 * Gets scope
+	 *
+	 * @return array
+	 */
+	public function scope()
+	{
+		return $this->get('PMD_scope');
+	}
+
+
+	/**
+	 * Sets scope
+	 *
+	 * @param array $scope
+	 */
+	public function set_scope($scope)
+	{
+		$this->set('PMD_scope', $scope);
+	}
+
+
+	/**
+	 * Gets the payment method type for this payment method instance
+	 *
+	 * @return EE_PMT_Base
+	 * @throws EE_Error
+	 */
+	public function type_obj()
+	{
+		if (! $this->_type_obj) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
+				$class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
+				if (! class_exists($class_name)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
+								'event_espresso'
+							),
+							$class_name,
+							'<br />',
+							'<a href="' . admin_url('plugins.php') . '">',
+							'</a>'
+						)
+					);
+				}
+				$r = new ReflectionClass($class_name);
+				$this->_type_obj = $r->newInstanceArgs(array($this));
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
+							'event_espresso'
+						),
+						$this->type(),
+						implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
+					)
+				);
+			}
+		}
+		return $this->_type_obj;
+	}
+
+
+	/**
+	 * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
+	 * and the extra meta. Mostly used for passing off ot gateways.     *
+	 *
+	 * @return array
+	 */
+	public function settings_array()
+	{
+		$fields = $this->model_field_array();
+		$extra_meta = $this->all_extra_meta_array();
+		// remove the model's prefix from the fields
+		$combined_settings_array = array();
+		foreach ($fields as $key => $value) {
+			if (strpos($key, 'PMD_') === 0) {
+				$key_sans_model_prefix = str_replace('PMD_', '', $key);
+				$combined_settings_array [ $key_sans_model_prefix ] = $value;
+			}
+		}
+		$combined_settings_array = array_merge($extra_meta, $combined_settings_array);
+		return $combined_settings_array;
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the payment method on a page.
+	 *
+	 * @param string $url
+	 * @param string $css_class
+	 * @return string of HTML for displaying the button
+	 * @throws \EE_Error
+	 */
+	public function button_html($url = '', $css_class = '')
+	{
+		$payment_occurs = $this->type_obj()->payment_occurs();
+		return '
 		 <div id="'
-               . $this->slug()
-               . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+			   . $this->slug()
+			   . '-payment-option-dv" class="'
+			   . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
 			<a id="payment-gateway-button-' . $this->slug()
-               . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
+			   . '" class="reg-page-payment-option-lnk" rel="'
+			   . $this->slug() . '" href="' . $url . '" >
 				<img src="' . $this->button_url() . '" alt="' . sprintf(
-                   esc_attr__('Pay using %s', 'event_espresso'),
-                   $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+				   esc_attr__('Pay using %s', 'event_espresso'),
+				   $this->get_pretty('PMD_name', 'form_input')
+			   ) . '" />
 			</a>
 		</div>
 ';
-    }
-
-
-    /**
-     * Gets all the currencies which are an option for this payment method
-     * (as defined by the gateway and the currently active currencies)
-     *
-     * @return EE_Currency[]
-     * @throws \EE_Error
-     */
-    public function get_all_usable_currencies()
-    {
-        return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
-    }
-
-
-    /**
-     * Reports whether or not this payment method can be used for this payment method
-     *
-     * @param string $currency_code currency ID (code)
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function usable_for_currency($currency_code)
-    {
-        foreach ($this->get_all_usable_currencies() as $currency_obj) {
-            if ($currency_obj->ID() === $currency_code) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_on_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_off_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method does not utilize a gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_off_line()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
-    }
-
-    /**
-     * Overrides default __sleep so the object type is NOT cached.
-     * This way we can rely on the normal EE_Payment_Method::type_obj() logic
-     * to load the required classes, and don't need them at the time of unserialization
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_type_obj']);
-        return array_keys($properties);
-    }
-
-
-    /**
-     * Overrides parent to add some logging for when payment methods get deactivated
-     *
-     * @param array $set_cols_n_values
-     * @return int @see EE_Base_Class::save()
-     * @throws \EE_Error
-     */
-    public function save($set_cols_n_values = array())
-    {
-        $results = parent::save($set_cols_n_values);
-        if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
-            /** @var CurrentPage $current_page */
-            $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-            EE_Log::instance()->log(
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
-                    $this->name(),
-                    serialize($this->get_original('PMD_scope')),
-                    serialize($this->get('PMD_scope')),
-                    $current_page->getPermalink()
-                ),
-                'payment_method_change'
-            );
-        }
-        return $results;
-    }
+	}
+
+
+	/**
+	 * Gets all the currencies which are an option for this payment method
+	 * (as defined by the gateway and the currently active currencies)
+	 *
+	 * @return EE_Currency[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_usable_currencies()
+	{
+		return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
+	}
+
+
+	/**
+	 * Reports whether or not this payment method can be used for this payment method
+	 *
+	 * @param string $currency_code currency ID (code)
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function usable_for_currency($currency_code)
+	{
+		foreach ($this->get_all_usable_currencies() as $currency_obj) {
+			if ($currency_obj->ID() === $currency_code) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_on_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_off_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method does not utilize a gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_off_line()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
+	}
+
+	/**
+	 * Overrides default __sleep so the object type is NOT cached.
+	 * This way we can rely on the normal EE_Payment_Method::type_obj() logic
+	 * to load the required classes, and don't need them at the time of unserialization
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_type_obj']);
+		return array_keys($properties);
+	}
+
+
+	/**
+	 * Overrides parent to add some logging for when payment methods get deactivated
+	 *
+	 * @param array $set_cols_n_values
+	 * @return int @see EE_Base_Class::save()
+	 * @throws \EE_Error
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		$results = parent::save($set_cols_n_values);
+		if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
+			/** @var CurrentPage $current_page */
+			$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+			EE_Log::instance()->log(
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
+					$this->name(),
+					serialize($this->get_original('PMD_scope')),
+					serialize($this->get('PMD_scope')),
+					$current_page->getPermalink()
+				),
+				'payment_method_change'
+			);
+		}
+		return $results;
+	}
 }

core/db_models/EEM_Message.model.php

Spacing +8 added lines, -8 removed lines

@@ -126,7 +126,7 @@ 
             self::priority_low    => esc_html__('low', 'event_espresso'),
         );
 
-        $this->_fields          = array(
+        $this->_fields = array(
             'Message' => array(
                 'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
                 'MSG_token'          => new EE_Plain_Text_Field(
@@ -436,7 +436,7 @@ 
                         );
                         break;
                     default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+                        $query_params[0]['AND**filter_by']['OR**filter_by_'.$request_key][$model_name.'.'.$request_key] = $request_value;
                         break;
                 }
             }
@@ -499,8 +499,8 @@ 
         if ($label_parts) {
             // prepend to the last element of $label_parts an "and".
             if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+                $label_parts_index_to_prepend = count($label_parts) - 1;
+                $label_parts[$label_parts_index_to_prepend] = 'and'.$label_parts[$label_parts_index_to_prepend];
             }
 
             $pretty_label .= sprintf(
@@ -560,7 +560,7 @@ 
             $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
         }
 
-        if (! is_null($set_debug)) {
+        if ( ! is_null($set_debug)) {
             $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
         }
 
@@ -627,13 +627,13 @@ 
             )
         );
 
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+        if ( ! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
             global $wpdb;
             $number_deleted = $wpdb->query('
                 DELETE
-                FROM ' . $this->table() . '
+                FROM ' . $this->table().'
                 WHERE
-                    MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
+                    MSG_ID IN (' . implode(",", $message_ids_to_delete).')
             ');
         }
 

Indentation +640 added lines, -640 removed lines

@@ -12,649 +12,649 @@
  */
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
-    // private instance of the Message object
-    protected static $_instance = null;
-
-
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
-
-
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
-     *                         the date time model field objects.  Default is null (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Message', 'event_espresso');
-        $this->plural_item   = esc_html__('Messages', 'event_espresso');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => esc_html__('high', 'event_espresso'),
-            self::priority_medium => esc_html__('medium', 'event_espresso'),
-            self::priority_low    => esc_html__('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field(
-                    'MSG_token',
-                    esc_html__(
-                        'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEH_URL::generate_unique_token()
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
-                    true,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__(
-                        'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    'Transaction'
-                ),
-                'MSG_messenger'      => new EE_Plain_Text_Field(
-                    'MSG_messenger',
-                    esc_html__(
-                        'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MSG_message_type'   => new EE_Plain_Text_Field(
-                    'MSG_message_type',
-                    esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false,
-                    'receipt'
-                ),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
-                    'MSG_recipient_ID',
-                    esc_html__('Recipient ID', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
-                    'MSG_recipient_type',
-                    esc_html__('Recipient Type', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_content',
-                    esc_html__('Content', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_to',
-                    esc_html__('Address To', 'event_espresso'),
-                    true
-                ),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_from',
-                    esc_html__('Address From', 'event_espresso'),
-                    true
-                ),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_subject',
-                    esc_html__('Subject', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_priority'       => new EE_Enum_Integer_Field(
-                    'MSG_priority',
-                    esc_html__('Priority', 'event_espresso'),
-                    false,
-                    self::priority_low,
-                    $allowed_priority
-                ),
-                'STS_ID'             => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status', 'event_espresso'),
-                    false,
-                    self::status_incomplete,
-                    'Status'
-                ),
-                'MSG_created'        => new EE_Datetime_Field(
-                    'MSG_created',
-                    esc_html__('Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'MSG_modified'       => new EE_Datetime_Field(
-                    'MSG_modified',
-                    esc_html__('Modified', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend)
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        // if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = $request->getRequestParam($request_key);
-            if ($request_value) {
-                // special case
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_pretty_label_for_results()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
-            $model = EEM_Base::$loader->getShared($model_name);
-            $model_field_value = $request->getRequestParam($request_key);
-            if ($model instanceof EEM_Base && $model_field_value !== '') {
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID':
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID':
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID':
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-            // prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        // initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if (! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        // return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
-
-
-    /**
-     * Deletes old messages meeting certain criteria for removal from the database.
-     * By default, this will delete messages that:
-     * - are older than the value of the delete_threshold in months.
-     * - have a STS_ID other than EEM_Message::status_idle
-     *
-     * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
-     *                              months.
-     * @return bool|false|int Either the number of records affected or false if there was an error (you can call
-     *                              $wpdb->last_error to find out what the error was.
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_old_messages($delete_threshold = 6)
-    {
-        $number_deleted = 0;
-        /**
-         * Allows code to change the boundary for what messages are kept.
-         * Uses the value of the `delete_threshold` variable by default.
-         *
-         * @param int $seconds seconds that will be subtracted from the timestamp for now.
-         * @return int
-         */
-        $time_to_leave_alone = absint(
-            apply_filters(
-                'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
-                ((int) $delete_threshold) * MONTH_IN_SECONDS
-            )
-        );
-
-
-        /**
-         * Allows code to change what message stati are ignored when deleting.
-         * Defaults to only ignore EEM_Message::status_idle messages.
-         *
-         * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
-         */
-        $message_stati_to_keep = (array) apply_filters(
-            'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
-            array(
-                EEM_Message::status_idle
-            )
-        );
-
-        // first get all the ids of messages being deleted
-        $message_ids_to_delete = EEM_Message::instance()->get_col(
-            array(
-                0 => array(
-                    'STS_ID' => array('NOT_IN', $message_stati_to_keep),
-                    'MSG_modified' => array('<', time() - $time_to_leave_alone)
-                ),
-                'limit' => apply_filters(
-                    'EEM_Message__delete_old_messages__limit',
-                    2000,
-                    $delete_threshold
-                )
-            )
-        );
-
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
-            global $wpdb;
-            $number_deleted = $wpdb->query('
+	// private instance of the Message object
+	protected static $_instance = null;
+
+
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
+
+
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
+	 *                         the date time model field objects.  Default is null (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Message', 'event_espresso');
+		$this->plural_item   = esc_html__('Messages', 'event_espresso');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => esc_html__('high', 'event_espresso'),
+			self::priority_medium => esc_html__('medium', 'event_espresso'),
+			self::priority_low    => esc_html__('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field(
+					'MSG_token',
+					esc_html__(
+						'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'
+					),
+					false,
+					EEH_URL::generate_unique_token()
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
+					true,
+					0,
+					'Message_Template_Group'
+				),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__(
+						'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'
+					),
+					true,
+					0,
+					'Transaction'
+				),
+				'MSG_messenger'      => new EE_Plain_Text_Field(
+					'MSG_messenger',
+					esc_html__(
+						'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MSG_message_type'   => new EE_Plain_Text_Field(
+					'MSG_message_type',
+					esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false,
+					'receipt'
+				),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
+					'MSG_recipient_ID',
+					esc_html__('Recipient ID', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
+					'MSG_recipient_type',
+					esc_html__('Recipient Type', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_content',
+					esc_html__('Content', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
+					'MSG_to',
+					esc_html__('Address To', 'event_espresso'),
+					true
+				),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
+					'MSG_from',
+					esc_html__('Address From', 'event_espresso'),
+					true
+				),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_subject',
+					esc_html__('Subject', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_priority'       => new EE_Enum_Integer_Field(
+					'MSG_priority',
+					esc_html__('Priority', 'event_espresso'),
+					false,
+					self::priority_low,
+					$allowed_priority
+				),
+				'STS_ID'             => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status', 'event_espresso'),
+					false,
+					self::status_incomplete,
+					'Status'
+				),
+				'MSG_created'        => new EE_Datetime_Field(
+					'MSG_created',
+					esc_html__('Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'MSG_modified'       => new EE_Datetime_Field(
+					'MSG_modified',
+					esc_html__('Modified', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend)
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		// if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = $request->getRequestParam($request_key);
+			if ($request_value) {
+				// special case
+				switch ($request_key) {
+					case '_REG_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default:
+						$query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_pretty_label_for_results()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
+			$model = EEM_Base::$loader->getShared($model_name);
+			$model_field_value = $request->getRequestParam($request_key);
+			if ($model instanceof EEM_Base && $model_field_value !== '') {
+				switch ($request_key) {
+					case '_REG_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID':
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID':
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID':
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+			// prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		// initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if (! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		// return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
+
+
+	/**
+	 * Deletes old messages meeting certain criteria for removal from the database.
+	 * By default, this will delete messages that:
+	 * - are older than the value of the delete_threshold in months.
+	 * - have a STS_ID other than EEM_Message::status_idle
+	 *
+	 * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
+	 *                              months.
+	 * @return bool|false|int Either the number of records affected or false if there was an error (you can call
+	 *                              $wpdb->last_error to find out what the error was.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_old_messages($delete_threshold = 6)
+	{
+		$number_deleted = 0;
+		/**
+		 * Allows code to change the boundary for what messages are kept.
+		 * Uses the value of the `delete_threshold` variable by default.
+		 *
+		 * @param int $seconds seconds that will be subtracted from the timestamp for now.
+		 * @return int
+		 */
+		$time_to_leave_alone = absint(
+			apply_filters(
+				'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
+				((int) $delete_threshold) * MONTH_IN_SECONDS
+			)
+		);
+
+
+		/**
+		 * Allows code to change what message stati are ignored when deleting.
+		 * Defaults to only ignore EEM_Message::status_idle messages.
+		 *
+		 * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
+		 */
+		$message_stati_to_keep = (array) apply_filters(
+			'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
+			array(
+				EEM_Message::status_idle
+			)
+		);
+
+		// first get all the ids of messages being deleted
+		$message_ids_to_delete = EEM_Message::instance()->get_col(
+			array(
+				0 => array(
+					'STS_ID' => array('NOT_IN', $message_stati_to_keep),
+					'MSG_modified' => array('<', time() - $time_to_leave_alone)
+				),
+				'limit' => apply_filters(
+					'EEM_Message__delete_old_messages__limit',
+					2000,
+					$delete_threshold
+				)
+			)
+		);
+
+		if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+			global $wpdb;
+			$number_deleted = $wpdb->query('
                 DELETE
                 FROM ' . $this->table() . '
                 WHERE
                     MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
             ');
-        }
-
-        /**
-         * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
-         * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
-         * below.
-         */
-        if ($number_deleted !== false) {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
-        } else {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
-        }
-        return $number_deleted;
-    }
+		}
+
+		/**
+		 * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
+		 * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
+		 * below.
+		 */
+		if ($number_deleted !== false) {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
+		} else {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
+		}
+		return $number_deleted;
+	}
 }