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 +303 added lines, -303 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,18 +139,18 @@ 
 				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');
-        $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,
@@ -167,25 +167,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,
@@ -200,34 +200,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,
@@ -235,9 +235,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 '',
@@ -258,11 +258,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,
@@ -273,12 +273,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,
@@ -310,18 +310,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 '',
@@ -333,9 +333,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',
@@ -352,9 +352,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,
@@ -370,24 +370,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,
@@ -401,18 +401,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,
@@ -422,9 +422,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,
@@ -448,18 +448,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,
@@ -467,9 +467,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,
@@ -477,9 +477,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',
@@ -491,9 +491,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,
@@ -512,10 +512,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,
@@ -528,9 +528,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',
@@ -539,9 +539,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,
@@ -564,9 +564,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,
@@ -579,165 +579,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/db_models/strategies/EE_Restriction_Generator_Public.strategy.php

Spacing +22 added lines, -22 removed lines

@@ -19,7 +19,7 @@ 
     protected function _generate_restrictions(): array
     {
         // if there are no standard caps for this model, then for allow full access
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [];
         }
 
@@ -32,17 +32,17 @@ 
             )
         ) {
             if ($this->model() instanceof EEM_CPT_Base) {
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+                $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                     $this->model(),
                     $this->action()
-                ) ] = new EE_Default_Where_Conditions(
+                )] = new EE_Default_Where_Conditions(
                     $this->addPublishedPostConditions()
                 );
             } elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+                $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                     $this->model(),
                     $this->action()
-                ) ] = new EE_Default_Where_Conditions(
+                )] = new EE_Default_Where_Conditions(
                     [$this->model()->deleted_field_name() => false]
                 );
             }
@@ -52,21 +52,21 @@ 
             if (
                 EE_Restriction_Generator_Base::is_cap(
                     $this->model(),
-                    $this->action() . '_others'
+                    $this->action().'_others'
                 )
             ) {// both caps exist
                 if ($this->model() instanceof EEM_CPT_Base) {
                     // then if they don't have the others cap,
                     // AT MOST show them their own and other published ones
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+                    $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_others'
-                    ) ] = new EE_Default_Where_Conditions(
+                        $this->action().'_others'
+                    )] = new EE_Default_Where_Conditions(
                         [
-                            'OR*' .
+                            'OR*'.
                             EE_Restriction_Generator_Base::get_cap_name(
                                 $this->model(),
-                                $this->action() . '_others'
+                                $this->action().'_others'
                             ) => $this->addPublishedPostConditions(
                                 [
                                     EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
@@ -77,15 +77,15 @@ 
                 } elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
                     // then if they don't have the other cap,
                     // AT MOST show them their own or non deleted ones
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+                    $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_others'
-                    ) ] = new EE_Default_Where_Conditions(
+                        $this->action().'_others'
+                    )] = new EE_Default_Where_Conditions(
                         [
-                            'OR*' .
+                            'OR*'.
                             EE_Restriction_Generator_Base::get_cap_name(
                                 $this->model(),
-                                $this->action() . '_others'
+                                $this->action().'_others'
                             ) => [
                                 EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                                 $this->model()->deleted_field_name(
@@ -101,20 +101,20 @@ 
                 if (
                     EE_Restriction_Generator_Base::is_cap(
                         $this->model(),
-                        $this->action() . '_private'
+                        $this->action().'_private'
                     ) && $this->model() instanceof EEM_CPT_Base
                 ) {
                     // if they have basic and others, but not private,
                     // restrict them to see theirs and others' that aren't private
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+                    $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_private'
-                    ) ] = new EE_Default_Where_Conditions(
+                        $this->action().'_private'
+                    )] = new EE_Default_Where_Conditions(
                         [
-                            'OR*' .
+                            'OR*'.
                             EE_Restriction_Generator_Base::get_cap_name(
                                 $this->model(),
-                                $this->action() . '_private'
+                                $this->action().'_private'
                             ) => $this->addPublishedPostConditions(
                                 [
                                     EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,

Indentation +116 added lines, -116 removed lines

@@ -11,123 +11,123 @@
  */
 class EE_Restriction_Generator_Public extends EE_Restriction_Generator_Base
 {
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for allow full access
-        if (! $this->model()->cap_slug()) {
-            return [];
-        }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for allow full access
+		if (! $this->model()->cap_slug()) {
+			return [];
+		}
 
-        $restrictions = [];
-        // does the basic cap exist? (eg 'ee_read_registrations')
-        if (
-            EE_Restriction_Generator_Base::is_cap(
-                $this->model(),
-                $this->action()
-            )
-        ) {
-            if ($this->model() instanceof EEM_CPT_Base) {
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                    $this->model(),
-                    $this->action()
-                ) ] = new EE_Default_Where_Conditions(
-                    $this->addPublishedPostConditions()
-                );
-            } elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                    $this->model(),
-                    $this->action()
-                ) ] = new EE_Default_Where_Conditions(
-                    [$this->model()->deleted_field_name() => false]
-                );
-            }
-            // don't impose any restrictions if they don't have the basic reading cap
+		$restrictions = [];
+		// does the basic cap exist? (eg 'ee_read_registrations')
+		if (
+			EE_Restriction_Generator_Base::is_cap(
+				$this->model(),
+				$this->action()
+			)
+		) {
+			if ($this->model() instanceof EEM_CPT_Base) {
+				$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+					$this->model(),
+					$this->action()
+				) ] = new EE_Default_Where_Conditions(
+					$this->addPublishedPostConditions()
+				);
+			} elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
+				$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+					$this->model(),
+					$this->action()
+				) ] = new EE_Default_Where_Conditions(
+					[$this->model()->deleted_field_name() => false]
+				);
+			}
+			// don't impose any restrictions if they don't have the basic reading cap
 
-            // does the others cap exist? (eg 'ee_read_others_registrations')
-            if (
-                EE_Restriction_Generator_Base::is_cap(
-                    $this->model(),
-                    $this->action() . '_others'
-                )
-            ) {// both caps exist
-                if ($this->model() instanceof EEM_CPT_Base) {
-                    // then if they don't have the others cap,
-                    // AT MOST show them their own and other published ones
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_others'
-                    ) ] = new EE_Default_Where_Conditions(
-                        [
-                            'OR*' .
-                            EE_Restriction_Generator_Base::get_cap_name(
-                                $this->model(),
-                                $this->action() . '_others'
-                            ) => $this->addPublishedPostConditions(
-                                [
-                                    EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                                ]
-                            ),
-                        ]
-                    );
-                } elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
-                    // then if they don't have the other cap,
-                    // AT MOST show them their own or non deleted ones
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_others'
-                    ) ] = new EE_Default_Where_Conditions(
-                        [
-                            'OR*' .
-                            EE_Restriction_Generator_Base::get_cap_name(
-                                $this->model(),
-                                $this->action() . '_others'
-                            ) => [
-                                EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                                $this->model()->deleted_field_name(
-                                )                                    => false,
-                            ],
-                        ]
-                    );
-                }
-                // again, if they don't have the others cap,
-                // continue showing all because there are no inherently hidden ones
+			// does the others cap exist? (eg 'ee_read_others_registrations')
+			if (
+				EE_Restriction_Generator_Base::is_cap(
+					$this->model(),
+					$this->action() . '_others'
+				)
+			) {// both caps exist
+				if ($this->model() instanceof EEM_CPT_Base) {
+					// then if they don't have the others cap,
+					// AT MOST show them their own and other published ones
+					$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_others'
+					) ] = new EE_Default_Where_Conditions(
+						[
+							'OR*' .
+							EE_Restriction_Generator_Base::get_cap_name(
+								$this->model(),
+								$this->action() . '_others'
+							) => $this->addPublishedPostConditions(
+								[
+									EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+								]
+							),
+						]
+					);
+				} elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
+					// then if they don't have the other cap,
+					// AT MOST show them their own or non deleted ones
+					$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_others'
+					) ] = new EE_Default_Where_Conditions(
+						[
+							'OR*' .
+							EE_Restriction_Generator_Base::get_cap_name(
+								$this->model(),
+								$this->action() . '_others'
+							) => [
+								EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+								$this->model()->deleted_field_name(
+								)                                    => false,
+							],
+						]
+					);
+				}
+				// again, if they don't have the others cap,
+				// continue showing all because there are no inherently hidden ones
 
-                // does the private cap exist (eg 'ee_read_others_private_events')
-                if (
-                    EE_Restriction_Generator_Base::is_cap(
-                        $this->model(),
-                        $this->action() . '_private'
-                    ) && $this->model() instanceof EEM_CPT_Base
-                ) {
-                    // if they have basic and others, but not private,
-                    // restrict them to see theirs and others' that aren't private
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_private'
-                    ) ] = new EE_Default_Where_Conditions(
-                        [
-                            'OR*' .
-                            EE_Restriction_Generator_Base::get_cap_name(
-                                $this->model(),
-                                $this->action() . '_private'
-                            ) => $this->addPublishedPostConditions(
-                                [
-                                    EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                                ],
-                                false
-                            ),
-                        ]
-                    );
-                }
-            }
-        } else {
-            // there is no basic cap. So allow full access
-            $restrictions = [];
-        }
-        return $restrictions;
-    }
+				// does the private cap exist (eg 'ee_read_others_private_events')
+				if (
+					EE_Restriction_Generator_Base::is_cap(
+						$this->model(),
+						$this->action() . '_private'
+					) && $this->model() instanceof EEM_CPT_Base
+				) {
+					// if they have basic and others, but not private,
+					// restrict them to see theirs and others' that aren't private
+					$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_private'
+					) ] = new EE_Default_Where_Conditions(
+						[
+							'OR*' .
+							EE_Restriction_Generator_Base::get_cap_name(
+								$this->model(),
+								$this->action() . '_private'
+							) => $this->addPublishedPostConditions(
+								[
+									EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+								],
+								false
+							),
+						]
+					);
+				}
+			}
+		} else {
+			// there is no basic cap. So allow full access
+			$restrictions = [];
+		}
+		return $restrictions;
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Default_Protected.strategy.php

Spacing +10 added lines, -10 removed lines

@@ -43,7 +43,7 @@ 
     public function __construct(string $default_field_name, string $path_to_event_model)
     {
         $this->_default_field_name  = $default_field_name;
-        $this->_path_to_event_model = rtrim($path_to_event_model, '.') . '.';
+        $this->_path_to_event_model = rtrim($path_to_event_model, '.').'.';
     }
 
 
@@ -55,7 +55,7 @@ 
     {
         // if there are no standard caps for this model, then for now
         // all we know is if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
             ];
@@ -83,7 +83,7 @@ 
         // if they don't have the "others" default capability,
         // restrict access to only their default ones, and non-default ones
         if (EE_Restriction_Generator_Base::is_cap($this->model(), $others_default)) {
-            $restrictions[ $this->getCapKey($this->model(), $others_default) ] = $this->othersDefaultRestrictions(
+            $restrictions[$this->getCapKey($this->model(), $others_default)] = $this->othersDefaultRestrictions(
                 $others_default
             );
         }
@@ -126,9 +126,9 @@ 
             [
                 // if they don't have the others default cap, they can't access others default items
                 // (but they can access their own default items, and non-default items)
-                'OR*no_' . $this->getCapKey($this->model(), $action) => [
+                'OR*no_'.$this->getCapKey($this->model(), $action) => [
                     'AND'                      => [
-                        $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                        $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         $this->_default_field_name                  => true,
                     ],
                     $this->_default_field_name => false,
@@ -148,8 +148,8 @@ 
     {
         return new EE_Default_Where_Conditions(
             [
-                'OR*no_' . $this->getCapKey($event_model, $action) => [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                'OR*no_'.$this->getCapKey($event_model, $action) => [
+                    $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                 ],
                 $this->_default_field_name                         => true,
             ]
@@ -167,9 +167,9 @@ 
     {
         return new EE_Default_Where_Conditions(
             [
-                'OR*no_' . $this->getCapKey($event_model, $action) => [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                    $this->_path_to_event_model . 'status'      => ['!=', 'private'],
+                'OR*no_'.$this->getCapKey($event_model, $action) => [
+                    $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                    $this->_path_to_event_model.'status'      => ['!=', 'private'],
                     $this->_default_field_name                  => true,
                 ],
             ]

Indentation +160 added lines, -160 removed lines

@@ -14,164 +14,164 @@
  */
 class EE_Restriction_Generator_Default_Protected extends EE_Restriction_Generator_Base
 {
-    /**
-     * Name of the field on this model (or a related model, including the model chain to it)
-     * that is a boolean indicating whether or not a model object is considered "Default" or not
-     *
-     * @var string
-     */
-    protected $_default_field_name;
-
-    /**
-     * The model chain to follow to get to the event model, including the event model itself.
-     * Eg 'Ticket.Datetime.Event'
-     *
-     * @var string
-     */
-    protected $_path_to_event_model;
-
-
-    /**
-     * @param string $default_field_name  the name of the field Name of the field on this model
-     *                                    (or a related model, including the model chain to it)
-     *                                    that is a boolean indicating whether or not a model object
-     *                                    is considered "Default" or not
-     * @param string $path_to_event_model The model chain to follow to get to the event model,
-     *                                    including the event model itself. Eg 'Ticket.Datetime.Event'
-     */
-    public function __construct(string $default_field_name, string $path_to_event_model)
-    {
-        $this->_default_field_name  = $default_field_name;
-        $this->_path_to_event_model = rtrim($path_to_event_model, '.') . '.';
-    }
-
-
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now
-        // all we know is if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
-            ];
-        }
-
-        $action         = $this->action();
-        $others         = "{$action}_others";
-        $private        = "{$action}_private";
-        $default        = "{$action}_default";
-        $others_default = "{$action}_others_default";
-        $event_model    = EEM_Event::instance();
-
-        $restrictions = [
-            // first: access to non-defaults is essentially controlled by which events are accessible
-            // if they don't have the basic event cap, they can't access ANY non-default items
-            $this->getCapKey($event_model, $action)    => $this->nonDefaultRestrictions(true),
-            // if they don't have the others event cap, they can't access others' non-default items
-            $this->getCapKey($event_model, $others)    => $this->othersNonDefaultRestrictions($event_model, $others),
-            // if they have basic and others, but not private, they can't access others' private non-default items
-            $this->getCapKey($event_model, $private)   => $this->privateRestrictions($event_model, $private),
-            // second: access to defaults is controlled by the default capabilities
-            // if they don't have the default capability, restrict access to only non-default items
-            $this->getCapKey($this->model(), $default) => $this->nonDefaultRestrictions(false),
-        ];
-        // if they don't have the "others" default capability,
-        // restrict access to only their default ones, and non-default ones
-        if (EE_Restriction_Generator_Base::is_cap($this->model(), $others_default)) {
-            $restrictions[ $this->getCapKey($this->model(), $others_default) ] = $this->othersDefaultRestrictions(
-                $others_default
-            );
-        }
-        return $restrictions;
-    }
-
-
-    /**
-     * @param EEM_Base $model
-     * @param string   $action
-     * @return string
-     * @since   5.0.0.p
-     */
-    private function getCapKey(EEM_Base $model, string $action): string
-    {
-        return EE_Restriction_Generator_Base::get_cap_name($model, $action);
-    }
-
-
-    /**
-     * @param bool $use_default_field_name
-     * @return EE_Default_Where_Conditions
-     * @since   5.0.0.p
-     */
-    private function nonDefaultRestrictions(bool $use_default_field_name): EE_Default_Where_Conditions
-    {
-        return new EE_Default_Where_Conditions([$this->_default_field_name => $use_default_field_name]);
-    }
-
-
-    /**
-     * @param string $action
-     * @return EE_Default_Where_Conditions
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function othersDefaultRestrictions(string $action): EE_Default_Where_Conditions
-    {
-        return new EE_Default_Where_Conditions(
-            [
-                // if they don't have the others default cap, they can't access others default items
-                // (but they can access their own default items, and non-default items)
-                'OR*no_' . $this->getCapKey($this->model(), $action) => [
-                    'AND'                      => [
-                        $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        $this->_default_field_name                  => true,
-                    ],
-                    $this->_default_field_name => false,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @param EEM_Event $event_model
-     * @param string    $action
-     * @return EE_Default_Where_Conditions
-     * @since   5.0.0.p
-     */
-    private function othersNonDefaultRestrictions(EEM_Event $event_model, string $action): EE_Default_Where_Conditions
-    {
-        return new EE_Default_Where_Conditions(
-            [
-                'OR*no_' . $this->getCapKey($event_model, $action) => [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                ],
-                $this->_default_field_name                         => true,
-            ]
-        );
-    }
-
-
-    /**
-     * @param EEM_Event $event_model
-     * @param string    $action
-     * @return EE_Default_Where_Conditions
-     * @since   5.0.0.p
-     */
-    private function privateRestrictions(EEM_Event $event_model, string $action): EE_Default_Where_Conditions
-    {
-        return new EE_Default_Where_Conditions(
-            [
-                'OR*no_' . $this->getCapKey($event_model, $action) => [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                    $this->_path_to_event_model . 'status'      => ['!=', 'private'],
-                    $this->_default_field_name                  => true,
-                ],
-            ]
-        );
-    }
+	/**
+	 * Name of the field on this model (or a related model, including the model chain to it)
+	 * that is a boolean indicating whether or not a model object is considered "Default" or not
+	 *
+	 * @var string
+	 */
+	protected $_default_field_name;
+
+	/**
+	 * The model chain to follow to get to the event model, including the event model itself.
+	 * Eg 'Ticket.Datetime.Event'
+	 *
+	 * @var string
+	 */
+	protected $_path_to_event_model;
+
+
+	/**
+	 * @param string $default_field_name  the name of the field Name of the field on this model
+	 *                                    (or a related model, including the model chain to it)
+	 *                                    that is a boolean indicating whether or not a model object
+	 *                                    is considered "Default" or not
+	 * @param string $path_to_event_model The model chain to follow to get to the event model,
+	 *                                    including the event model itself. Eg 'Ticket.Datetime.Event'
+	 */
+	public function __construct(string $default_field_name, string $path_to_event_model)
+	{
+		$this->_default_field_name  = $default_field_name;
+		$this->_path_to_event_model = rtrim($path_to_event_model, '.') . '.';
+	}
+
+
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now
+		// all we know is if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
+			];
+		}
+
+		$action         = $this->action();
+		$others         = "{$action}_others";
+		$private        = "{$action}_private";
+		$default        = "{$action}_default";
+		$others_default = "{$action}_others_default";
+		$event_model    = EEM_Event::instance();
+
+		$restrictions = [
+			// first: access to non-defaults is essentially controlled by which events are accessible
+			// if they don't have the basic event cap, they can't access ANY non-default items
+			$this->getCapKey($event_model, $action)    => $this->nonDefaultRestrictions(true),
+			// if they don't have the others event cap, they can't access others' non-default items
+			$this->getCapKey($event_model, $others)    => $this->othersNonDefaultRestrictions($event_model, $others),
+			// if they have basic and others, but not private, they can't access others' private non-default items
+			$this->getCapKey($event_model, $private)   => $this->privateRestrictions($event_model, $private),
+			// second: access to defaults is controlled by the default capabilities
+			// if they don't have the default capability, restrict access to only non-default items
+			$this->getCapKey($this->model(), $default) => $this->nonDefaultRestrictions(false),
+		];
+		// if they don't have the "others" default capability,
+		// restrict access to only their default ones, and non-default ones
+		if (EE_Restriction_Generator_Base::is_cap($this->model(), $others_default)) {
+			$restrictions[ $this->getCapKey($this->model(), $others_default) ] = $this->othersDefaultRestrictions(
+				$others_default
+			);
+		}
+		return $restrictions;
+	}
+
+
+	/**
+	 * @param EEM_Base $model
+	 * @param string   $action
+	 * @return string
+	 * @since   5.0.0.p
+	 */
+	private function getCapKey(EEM_Base $model, string $action): string
+	{
+		return EE_Restriction_Generator_Base::get_cap_name($model, $action);
+	}
+
+
+	/**
+	 * @param bool $use_default_field_name
+	 * @return EE_Default_Where_Conditions
+	 * @since   5.0.0.p
+	 */
+	private function nonDefaultRestrictions(bool $use_default_field_name): EE_Default_Where_Conditions
+	{
+		return new EE_Default_Where_Conditions([$this->_default_field_name => $use_default_field_name]);
+	}
+
+
+	/**
+	 * @param string $action
+	 * @return EE_Default_Where_Conditions
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function othersDefaultRestrictions(string $action): EE_Default_Where_Conditions
+	{
+		return new EE_Default_Where_Conditions(
+			[
+				// if they don't have the others default cap, they can't access others default items
+				// (but they can access their own default items, and non-default items)
+				'OR*no_' . $this->getCapKey($this->model(), $action) => [
+					'AND'                      => [
+						$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						$this->_default_field_name                  => true,
+					],
+					$this->_default_field_name => false,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @param EEM_Event $event_model
+	 * @param string    $action
+	 * @return EE_Default_Where_Conditions
+	 * @since   5.0.0.p
+	 */
+	private function othersNonDefaultRestrictions(EEM_Event $event_model, string $action): EE_Default_Where_Conditions
+	{
+		return new EE_Default_Where_Conditions(
+			[
+				'OR*no_' . $this->getCapKey($event_model, $action) => [
+					$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+				],
+				$this->_default_field_name                         => true,
+			]
+		);
+	}
+
+
+	/**
+	 * @param EEM_Event $event_model
+	 * @param string    $action
+	 * @return EE_Default_Where_Conditions
+	 * @since   5.0.0.p
+	 */
+	private function privateRestrictions(EEM_Event $event_model, string $action): EE_Default_Where_Conditions
+	{
+		return new EE_Default_Where_Conditions(
+			[
+				'OR*no_' . $this->getCapKey($event_model, $action) => [
+					$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+					$this->_path_to_event_model . 'status'      => ['!=', 'private'],
+					$this->_default_field_name                  => true,
+				],
+			]
+		);
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Protected.strategy.php

Spacing +15 added lines, -15 removed lines

@@ -29,7 +29,7 @@ 
     {
         // if there are no standard caps for this model, then for now all we know
         // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 EE_Restriction_Generator_Base::get_default_restrictions_cap(
                 ) => new EE_Return_None_Where_Conditions(),
@@ -44,22 +44,22 @@ 
                 $this->action()
             )
         ) {
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+            $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
                 $this->action()
-            ) ] = new EE_Return_None_Where_Conditions();
+            )] = new EE_Return_None_Where_Conditions();
             // does the others cap exist? (eg 'ee_read_others_registrations')
             if (
                 EE_Restriction_Generator_Base::is_cap(
                     $this->model(),
-                    $this->action() . '_others'
+                    $this->action().'_others'
                 )
             ) {
                 // both caps exist
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+                $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                     $this->model(),
-                    $this->action() . '_others'
-                ) ] = new EE_Default_Where_Conditions(
+                    $this->action().'_others'
+                )] = new EE_Default_Where_Conditions(
                     [
                         EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                     ]
@@ -68,20 +68,20 @@ 
                 if (
                     EE_Restriction_Generator_Base::is_cap(
                         $this->model(),
-                        $this->action() . '_private'
+                        $this->action().'_private'
                     ) && $this->model() instanceof EEM_CPT_Base
                 ) {
                     // if they have basic and others, but not private,
                     // restrict them to see theirs and others' that aren't private
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+                    $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_private'
-                    ) ] = new EE_Default_Where_Conditions(
+                        $this->action().'_private'
+                    )] = new EE_Default_Where_Conditions(
                         [
-                            'OR*no_' .
+                            'OR*no_'.
                             EE_Restriction_Generator_Base::get_cap_name(
                                 $this->model(),
-                                $this->action() . '_private'
+                                $this->action().'_private'
                             ) => [
                                 EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                                 'status'                             => [
@@ -96,8 +96,8 @@ 
         } else {
             // there is no basic cap.
             // So they can only access this if they have the default admin cap
-            $restrictions[ EE_Restriction_Generator_Base::get_default_restrictions_cap(
-            ) ] = new EE_Return_None_Where_Conditions();
+            $restrictions[EE_Restriction_Generator_Base::get_default_restrictions_cap(
+            )] = new EE_Return_None_Where_Conditions();
         }
         return $restrictions;
     }

Indentation +79 added lines, -79 removed lines

@@ -20,84 +20,84 @@
  */
 class EE_Restriction_Generator_Protected extends EE_Restriction_Generator_Base
 {
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now all we know
-        // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                EE_Restriction_Generator_Base::get_default_restrictions_cap(
-                ) => new EE_Return_None_Where_Conditions(),
-            ];
-        }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now all we know
+		// if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				EE_Restriction_Generator_Base::get_default_restrictions_cap(
+				) => new EE_Return_None_Where_Conditions(),
+			];
+		}
 
-        $restrictions = [];
-        // does the basic cap exist? (eg 'ee_read_registrations')
-        if (
-            EE_Restriction_Generator_Base::is_cap(
-                $this->model(),
-                $this->action()
-            )
-        ) {
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action()
-            ) ] = new EE_Return_None_Where_Conditions();
-            // does the others cap exist? (eg 'ee_read_others_registrations')
-            if (
-                EE_Restriction_Generator_Base::is_cap(
-                    $this->model(),
-                    $this->action() . '_others'
-                )
-            ) {
-                // both caps exist
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                    $this->model(),
-                    $this->action() . '_others'
-                ) ] = new EE_Default_Where_Conditions(
-                    [
-                        EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                    ]
-                );
-                // does the private cap exist (eg 'ee_read_others_private_events')
-                if (
-                    EE_Restriction_Generator_Base::is_cap(
-                        $this->model(),
-                        $this->action() . '_private'
-                    ) && $this->model() instanceof EEM_CPT_Base
-                ) {
-                    // if they have basic and others, but not private,
-                    // restrict them to see theirs and others' that aren't private
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_private'
-                    ) ] = new EE_Default_Where_Conditions(
-                        [
-                            'OR*no_' .
-                            EE_Restriction_Generator_Base::get_cap_name(
-                                $this->model(),
-                                $this->action() . '_private'
-                            ) => [
-                                EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                                'status'                             => [
-                                    '!=',
-                                    'private',
-                                ],
-                            ],
-                        ]
-                    );
-                }
-            }
-        } else {
-            // there is no basic cap.
-            // So they can only access this if they have the default admin cap
-            $restrictions[ EE_Restriction_Generator_Base::get_default_restrictions_cap(
-            ) ] = new EE_Return_None_Where_Conditions();
-        }
-        return $restrictions;
-    }
+		$restrictions = [];
+		// does the basic cap exist? (eg 'ee_read_registrations')
+		if (
+			EE_Restriction_Generator_Base::is_cap(
+				$this->model(),
+				$this->action()
+			)
+		) {
+			$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action()
+			) ] = new EE_Return_None_Where_Conditions();
+			// does the others cap exist? (eg 'ee_read_others_registrations')
+			if (
+				EE_Restriction_Generator_Base::is_cap(
+					$this->model(),
+					$this->action() . '_others'
+				)
+			) {
+				// both caps exist
+				$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+					$this->model(),
+					$this->action() . '_others'
+				) ] = new EE_Default_Where_Conditions(
+					[
+						EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+					]
+				);
+				// does the private cap exist (eg 'ee_read_others_private_events')
+				if (
+					EE_Restriction_Generator_Base::is_cap(
+						$this->model(),
+						$this->action() . '_private'
+					) && $this->model() instanceof EEM_CPT_Base
+				) {
+					// if they have basic and others, but not private,
+					// restrict them to see theirs and others' that aren't private
+					$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_private'
+					) ] = new EE_Default_Where_Conditions(
+						[
+							'OR*no_' .
+							EE_Restriction_Generator_Base::get_cap_name(
+								$this->model(),
+								$this->action() . '_private'
+							) => [
+								EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+								'status'                             => [
+									'!=',
+									'private',
+								],
+							],
+						]
+					);
+				}
+			}
+		} else {
+			// there is no basic cap.
+			// So they can only access this if they have the default admin cap
+			$restrictions[ EE_Restriction_Generator_Base::get_default_restrictions_cap(
+			) ] = new EE_Return_None_Where_Conditions();
+		}
+		return $restrictions;
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Global.strategy.php

Spacing +5 added lines, -5 removed lines

@@ -48,7 +48,7 @@ 
     {
         // if there are no standard caps for this model, then for now
         // all we know is if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 EE_Restriction_Generator_Base::get_default_restrictions_cap(
                 ) => new EE_Return_None_Where_Conditions(),
@@ -61,14 +61,14 @@ 
             ) => new EE_Return_None_Where_Conditions(),
             EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_others'
+                $this->action().'_others'
             ) => new EE_Default_Where_Conditions(
                 [
                     // I need to be the owner, or it must be a global item
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_others'
+                        $this->action().'_others'
                     ) => [
                         EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         $this->_global_field_name            => true,
@@ -77,7 +77,7 @@ 
             ),
             EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_global'
+                $this->action().'_global'
             ) => new EE_Default_Where_Conditions(
                 [
                     // it mustn't be global

Indentation +62 added lines, -62 removed lines

@@ -19,70 +19,70 @@
  */
 class EE_Restriction_Generator_Global extends EE_Restriction_Generator_Base
 {
-    /**
-     * name of the model field that indicates whether or not a model object is
-     * "global"
-     *
-     * @var string
-     */
-    protected $_global_field_name;
+	/**
+	 * name of the model field that indicates whether or not a model object is
+	 * "global"
+	 *
+	 * @var string
+	 */
+	protected $_global_field_name;
 
 
-    /**
-     * @param string $global_field_name name of the model field that indicates
-     *                                  whether or not a model object is
-     *                                  "global"
-     */
-    public function __construct(string $global_field_name)
-    {
-        $this->_global_field_name = $global_field_name;
-    }
+	/**
+	 * @param string $global_field_name name of the model field that indicates
+	 *                                  whether or not a model object is
+	 *                                  "global"
+	 */
+	public function __construct(string $global_field_name)
+	{
+		$this->_global_field_name = $global_field_name;
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now
-        // all we know is if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                EE_Restriction_Generator_Base::get_default_restrictions_cap(
-                ) => new EE_Return_None_Where_Conditions(),
-            ];
-        }
-        return [
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action()
-            ) => new EE_Return_None_Where_Conditions(),
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_others'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    // I need to be the owner, or it must be a global item
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_others'
-                    ) => [
-                        EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        $this->_global_field_name            => true,
-                    ],
-                ]
-            ),
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_global'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    // it mustn't be global
-                    $this->_global_field_name => false,
-                ]
-            ),
-        ];
-    }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now
+		// all we know is if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				EE_Restriction_Generator_Base::get_default_restrictions_cap(
+				) => new EE_Return_None_Where_Conditions(),
+			];
+		}
+		return [
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action()
+			) => new EE_Return_None_Where_Conditions(),
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_others'
+			) => new EE_Default_Where_Conditions(
+				[
+					// I need to be the owner, or it must be a global item
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_others'
+					) => [
+						EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						$this->_global_field_name            => true,
+					],
+				]
+			),
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_global'
+			) => new EE_Default_Where_Conditions(
+				[
+					// it mustn't be global
+					$this->_global_field_name => false,
+				]
+			),
+		];
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Event_Related_Public.strategy.php

Spacing +9 added lines, -9 removed lines

@@ -44,7 +44,7 @@ 
     {
         // if there are no standard caps for this model, then for now
         // all we know if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
             ];
@@ -67,15 +67,15 @@ 
             // they can't access others' non-default items
             self::get_cap_name(
                 $event_model,
-                $this->action() . '_others'
+                $this->action().'_others'
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*' . self::get_cap_name(
+                    'OR*'.self::get_cap_name(
                         $event_model,
-                        $this->action() . '_others'
+                        $this->action().'_others'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         ],
                         true,
                         $this->_path_to_event_model
@@ -84,14 +84,14 @@ 
             ),
             // if they have basic and others, but not private,
             // they can't access others' private non-default items
-            self::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
+            self::get_cap_name($event_model, $this->action().'_private') => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' . self::get_cap_name(
+                    'OR*no_'.self::get_cap_name(
                         $event_model,
-                        $this->action() . '_private'
+                        $this->action().'_private'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         ],
                         false,
                         $this->_path_to_event_model

Indentation +81 added lines, -81 removed lines

@@ -13,90 +13,90 @@
  */
 class EE_Restriction_Generator_Event_Related_Public extends EE_Restriction_Generator_Base
 {
-    /**
-     * Path to the event model from the model this restriction generator will
-     * be applied to; including the event model itself. Eg
-     * "Ticket.Datetime.Event"
-     *
-     * @var string
-     */
-    protected $_path_to_event_model;
+	/**
+	 * Path to the event model from the model this restriction generator will
+	 * be applied to; including the event model itself. Eg
+	 * "Ticket.Datetime.Event"
+	 *
+	 * @var string
+	 */
+	protected $_path_to_event_model;
 
 
-    /**
-     * @param string $path_to_event_model
-     */
-    public function __construct(string $path_to_event_model)
-    {
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-    }
+	/**
+	 * @param string $path_to_event_model
+	 */
+	public function __construct(string $path_to_event_model)
+	{
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now
-        // all we know if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
-            ];
-        }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now
+		// all we know if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions(),
+			];
+		}
 
-        $event_model = EEM_Event::instance();
-        return [
-            // first: basically access to non-defaults is essentially
-            // controlled by which events are accessible
-            // if they don't have the basic event cap,
-            // they can only read things for published events
-            self::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(
-                $this->addPublishedPostConditions(
-                    [],
-                    true,
-                    $this->_path_to_event_model
-                )
-            ),
-            // if they don't have the others event cap,
-            // they can't access others' non-default items
-            self::get_cap_name(
-                $event_model,
-                $this->action() . '_others'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*' . self::get_cap_name(
-                        $event_model,
-                        $this->action() . '_others'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        ],
-                        true,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-            // if they have basic and others, but not private,
-            // they can't access others' private non-default items
-            self::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' . self::get_cap_name(
-                        $event_model,
-                        $this->action() . '_private'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        ],
-                        false,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-        ];
-    }
+		$event_model = EEM_Event::instance();
+		return [
+			// first: basically access to non-defaults is essentially
+			// controlled by which events are accessible
+			// if they don't have the basic event cap,
+			// they can only read things for published events
+			self::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(
+				$this->addPublishedPostConditions(
+					[],
+					true,
+					$this->_path_to_event_model
+				)
+			),
+			// if they don't have the others event cap,
+			// they can't access others' non-default items
+			self::get_cap_name(
+				$event_model,
+				$this->action() . '_others'
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*' . self::get_cap_name(
+						$event_model,
+						$this->action() . '_others'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						],
+						true,
+						$this->_path_to_event_model
+					),
+				]
+			),
+			// if they have basic and others, but not private,
+			// they can't access others' private non-default items
+			self::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' . self::get_cap_name(
+						$event_model,
+						$this->action() . '_private'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						],
+						false,
+						$this->_path_to_event_model
+					),
+				]
+			),
+		];
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Default_Public.strategy.php

Spacing +17 added lines, -17 removed lines

@@ -63,7 +63,7 @@ 
     {
         // if there are no standard caps for this model, then for now all we know
         // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 self::get_default_restrictions_cap(
                 ) => new EE_Return_None_Where_Conditions(),
@@ -82,7 +82,7 @@ 
                 $this->action()
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $event_model,
                         $this->action()
@@ -100,16 +100,16 @@ 
             // others' that are for published events, or defaults
             EE_Restriction_Generator_Base::get_cap_name(
                 $event_model,
-                $this->action() . '_others'
+                $this->action().'_others'
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $event_model,
-                        $this->action() . '_others'
+                        $this->action().'_others'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                             $this->_default_field_name                  => true,
                         ],
                         true,
@@ -122,16 +122,16 @@ 
             // and others' that aren't private
             EE_Restriction_Generator_Base::get_cap_name(
                 $event_model,
-                $this->action() . '_private'
+                $this->action().'_private'
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $event_model,
-                        $this->action() . '_private'
+                        $this->action().'_private'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                             $this->_default_field_name                  => true,
                         ],
                         false,
@@ -145,7 +145,7 @@ 
             // restrict access to only non-default items
             EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_default'
+                $this->action().'_default'
             ) => new EE_Default_Where_Conditions(
                 [$this->_default_field_name => false]
             ),
@@ -153,24 +153,24 @@ 
         if (
             EE_Restriction_Generator_Base::is_cap(
                 $this->model(),
-                $this->action() . '_others_default'
+                $this->action().'_others_default'
             )
         ) {
             // if they don't have the "others" default capability,
             // restrict access to only their default ones, and non-default ones
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+            $restrictions[EE_Restriction_Generator_Base::get_cap_name(
                 $this->model(),
-                $this->action() . '_others_default'
-            ) ] = new EE_Default_Where_Conditions(
+                $this->action().'_others_default'
+            )] = new EE_Default_Where_Conditions(
                 [
                     // if they don't have the others default cap,
                     // they can't access others default items
                     // (but they can access their own default items,
                     // and non-default items)
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $this->model(),
-                        $this->action() . '_others_default'
+                        $this->action().'_others_default'
                     ) => [
                         'AND'                      => [
                             EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,

Indentation +161 added lines, -161 removed lines

@@ -14,172 +14,172 @@
  */
 class EE_Restriction_Generator_Default_Public extends EE_Restriction_Generator_Base
 {
-    /**
-     * Name of the field on this model (or a related model, including the model
-     * chain to it) that is a boolean indicating whether or not a model object
-     * is considered "Default" or not
-     *
-     * @var string
-     */
-    protected $_default_field_name;
+	/**
+	 * Name of the field on this model (or a related model, including the model
+	 * chain to it) that is a boolean indicating whether or not a model object
+	 * is considered "Default" or not
+	 *
+	 * @var string
+	 */
+	protected $_default_field_name;
 
-    /**
-     * The model chain to follow to get to the event model, including the event
-     * model itself. Eg 'Ticket.Datetime.Event'
-     *
-     * @var string
-     */
-    protected $_path_to_event_model;
+	/**
+	 * The model chain to follow to get to the event model, including the event
+	 * model itself. Eg 'Ticket.Datetime.Event'
+	 *
+	 * @var string
+	 */
+	protected $_path_to_event_model;
 
 
-    /**
-     * @param string $default_field_name  the name of the field Name of the
-     *                                    field on this model (or a related
-     *                                    model, including the model chain to
-     *                                    it) that is a boolean indicating
-     *                                    whether or not a model object is
-     *                                    considered "Default" or not
-     * @param string $path_to_event_model The model chain to follow to get to
-     *                                    the event model, including the event
-     *                                    model itself. Eg
-     *                                    'Ticket.Datetime.Event'
-     */
-    public function __construct(string $default_field_name, string $path_to_event_model)
-    {
-        $this->_default_field_name = $default_field_name;
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-    }
+	/**
+	 * @param string $default_field_name  the name of the field Name of the
+	 *                                    field on this model (or a related
+	 *                                    model, including the model chain to
+	 *                                    it) that is a boolean indicating
+	 *                                    whether or not a model object is
+	 *                                    considered "Default" or not
+	 * @param string $path_to_event_model The model chain to follow to get to
+	 *                                    the event model, including the event
+	 *                                    model itself. Eg
+	 *                                    'Ticket.Datetime.Event'
+	 */
+	public function __construct(string $default_field_name, string $path_to_event_model)
+	{
+		$this->_default_field_name = $default_field_name;
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now all we know
-        // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                self::get_default_restrictions_cap(
-                ) => new EE_Return_None_Where_Conditions(),
-            ];
-        }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now all we know
+		// if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				self::get_default_restrictions_cap(
+				) => new EE_Return_None_Where_Conditions(),
+			];
+		}
 
-        $event_model = EEM_Event::instance();
+		$event_model = EEM_Event::instance();
 
-        $restrictions = [
-            // first: basically access to non-defaults is essentially
-            // controlled by which events are accessible
-            // if they don't have the basic event cap,
-            // they can't access ANY non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action()
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $event_model,
-                        $this->action()
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_default_field_name => true,
-                        ],
-                        true,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-            // if they don't have the others event cap,
-            // they can only access their own,
-            // others' that are for published events, or defaults
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action() . '_others'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $event_model,
-                        $this->action() . '_others'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                            $this->_default_field_name                  => true,
-                        ],
-                        true,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-            // if they have basic and others, but not private,
-            // they can access default, their own,
-            // and others' that aren't private
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action() . '_private'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $event_model,
-                        $this->action() . '_private'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                            $this->_default_field_name                  => true,
-                        ],
-                        false,
-                        $this->_path_to_event_model
-                    ),
-                ]
-            ),
-            // second: access to defaults is controlled
-            // by the default capabilities
-            // if they don't have the basic default capability,
-            // restrict access to only non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_default'
-            ) => new EE_Default_Where_Conditions(
-                [$this->_default_field_name => false]
-            ),
-        ];
-        if (
-            EE_Restriction_Generator_Base::is_cap(
-                $this->model(),
-                $this->action() . '_others_default'
-            )
-        ) {
-            // if they don't have the "others" default capability,
-            // restrict access to only their default ones, and non-default ones
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name(
-                $this->model(),
-                $this->action() . '_others_default'
-            ) ] = new EE_Default_Where_Conditions(
-                [
-                    // if they don't have the others default cap,
-                    // they can't access others default items
-                    // (but they can access their own default items,
-                    // and non-default items)
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $this->model(),
-                        $this->action() . '_others_default'
-                    ) => [
-                        'AND'                      => [
-                            EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                            $this->_default_field_name           => true
-                        ],
-                        $this->_default_field_name => false
-                    ]
-                ]
-            );
-        }
-        return $restrictions;
-    }
+		$restrictions = [
+			// first: basically access to non-defaults is essentially
+			// controlled by which events are accessible
+			// if they don't have the basic event cap,
+			// they can't access ANY non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action()
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$event_model,
+						$this->action()
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_default_field_name => true,
+						],
+						true,
+						$this->_path_to_event_model
+					),
+				]
+			),
+			// if they don't have the others event cap,
+			// they can only access their own,
+			// others' that are for published events, or defaults
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action() . '_others'
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$event_model,
+						$this->action() . '_others'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+							$this->_default_field_name                  => true,
+						],
+						true,
+						$this->_path_to_event_model
+					),
+				]
+			),
+			// if they have basic and others, but not private,
+			// they can access default, their own,
+			// and others' that aren't private
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action() . '_private'
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$event_model,
+						$this->action() . '_private'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+							$this->_default_field_name                  => true,
+						],
+						false,
+						$this->_path_to_event_model
+					),
+				]
+			),
+			// second: access to defaults is controlled
+			// by the default capabilities
+			// if they don't have the basic default capability,
+			// restrict access to only non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_default'
+			) => new EE_Default_Where_Conditions(
+				[$this->_default_field_name => false]
+			),
+		];
+		if (
+			EE_Restriction_Generator_Base::is_cap(
+				$this->model(),
+				$this->action() . '_others_default'
+			)
+		) {
+			// if they don't have the "others" default capability,
+			// restrict access to only their default ones, and non-default ones
+			$restrictions[ EE_Restriction_Generator_Base::get_cap_name(
+				$this->model(),
+				$this->action() . '_others_default'
+			) ] = new EE_Default_Where_Conditions(
+				[
+					// if they don't have the others default cap,
+					// they can't access others default items
+					// (but they can access their own default items,
+					// and non-default items)
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$this->model(),
+						$this->action() . '_others_default'
+					) => [
+						'AND'                      => [
+							EE_QUERY_PLACEHOLDER_USER_FIELD_NAME => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+							$this->_default_field_name           => true
+						],
+						$this->_default_field_name => false
+					]
+				]
+			);
+		}
+		return $restrictions;
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Event_Related_Protected.strategy.php

Spacing +7 added lines, -7 removed lines

@@ -89,7 +89,7 @@ 
     {
         // if there are no standard caps for this model, then for now
         // all we know if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return [
                 self::get_default_restrictions_cap(
                 ) => new EE_Return_None_Where_Conditions(),
@@ -110,26 +110,26 @@ 
             // they can't access others' non-default items
             EE_Restriction_Generator_Base::get_cap_name(
                 $event_model,
-                $this->action_for_event() . '_others'
+                $this->action_for_event().'_others'
             ) => new EE_Default_Where_Conditions(
                 [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                    $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                 ]
             ),
             // if they have basic and others, but not private,
             // they can't access others' private non-default items
             EE_Restriction_Generator_Base::get_cap_name(
                 $event_model,
-                $this->action_for_event() . '_private'
+                $this->action_for_event().'_private'
             ) => new EE_Default_Where_Conditions(
                 [
-                    'OR*no_' .
+                    'OR*no_'.
                     EE_Restriction_Generator_Base::get_cap_name(
                         $event_model,
-                        $this->action_for_event() . '_private'
+                        $this->action_for_event().'_private'
                     ) => $this->addPublishedPostConditions(
                         [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
                         ],
                         false,
                         $this->_path_to_event_model

Indentation +116 added lines, -116 removed lines

@@ -13,128 +13,128 @@
  */
 class EE_Restriction_Generator_Event_Related_Protected extends EE_Restriction_Generator_Base
 {
-    /**
-     * Path to the event model from the model this restriction generator will
-     * be applied to; including the event model itself. Eg
-     * "Ticket.Datetime.Event"
-     *
-     * @var string
-     */
-    protected $_path_to_event_model = null;
+	/**
+	 * Path to the event model from the model this restriction generator will
+	 * be applied to; including the event model itself. Eg
+	 * "Ticket.Datetime.Event"
+	 *
+	 * @var string
+	 */
+	protected $_path_to_event_model = null;
 
-    /**
-     * Capability context on event model when creating restrictions.
-     * Eg, although we may want capability restrictions relating to deleting
-     * datetimes, they don't need to be able to DELETE EVENTS, they just need
-     * to be able to EDIT EVENTS in order to DELETE DATETIMES.
-     *
-     * @var string one of EEM_Base::valid_cap_contexts()
-     */
-    protected $_cap_context_on_event_model = null;
+	/**
+	 * Capability context on event model when creating restrictions.
+	 * Eg, although we may want capability restrictions relating to deleting
+	 * datetimes, they don't need to be able to DELETE EVENTS, they just need
+	 * to be able to EDIT EVENTS in order to DELETE DATETIMES.
+	 *
+	 * @var string one of EEM_Base::valid_cap_contexts()
+	 */
+	protected $_cap_context_on_event_model = null;
 
 
-    /**
-     * @param string $path_to_event_model
-     * @param string $cap_context_on_event_model capability context on event
-     *                                           model when creating
-     *                                           restrictions. Eg, although we
-     *                                           may want capability
-     *                                           restrictions relating to
-     *                                           deleting datetimes, they don't
-     *                                           need to be able to DELETE
-     *                                           EVENTS, they just need to be
-     *                                           able to EDIT EVENTS in order
-     *                                           to DELETE DATETIMES. If none
-     *                                           if provided, assumed to be the
-     *                                           same as on the primary model.
-     */
-    public function __construct(
-        string $path_to_event_model,
-        string $cap_context_on_event_model = ''
-    ) {
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-        $this->_cap_context_on_event_model = $cap_context_on_event_model;
-    }
+	/**
+	 * @param string $path_to_event_model
+	 * @param string $cap_context_on_event_model capability context on event
+	 *                                           model when creating
+	 *                                           restrictions. Eg, although we
+	 *                                           may want capability
+	 *                                           restrictions relating to
+	 *                                           deleting datetimes, they don't
+	 *                                           need to be able to DELETE
+	 *                                           EVENTS, they just need to be
+	 *                                           able to EDIT EVENTS in order
+	 *                                           to DELETE DATETIMES. If none
+	 *                                           if provided, assumed to be the
+	 *                                           same as on the primary model.
+	 */
+	public function __construct(
+		string $path_to_event_model,
+		string $cap_context_on_event_model = ''
+	) {
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+		$this->_cap_context_on_event_model = $cap_context_on_event_model;
+	}
 
 
-    /**
-     * Returns `$this->_cap_context_on_event_model`, the relevant action
-     * ("read",
-     * "read_admin", "edit" or "delete") for the EVENT related to this model.
-     *
-     * @return string one of EEM_Base::valid_cap_contexts()
-     * @throws EE_Error
-     * @see EE_Restriction_Generator_Event_Related_Protected::__construct()
-     */
-    protected function action_for_event(): ?string
-    {
-        if ($this->_cap_context_on_event_model) {
-            return $this->_cap_context_on_event_model;
-        } else {
-            return $this->action();
-        }
-    }
+	/**
+	 * Returns `$this->_cap_context_on_event_model`, the relevant action
+	 * ("read",
+	 * "read_admin", "edit" or "delete") for the EVENT related to this model.
+	 *
+	 * @return string one of EEM_Base::valid_cap_contexts()
+	 * @throws EE_Error
+	 * @see EE_Restriction_Generator_Event_Related_Protected::__construct()
+	 */
+	protected function action_for_event(): ?string
+	{
+		if ($this->_cap_context_on_event_model) {
+			return $this->_cap_context_on_event_model;
+		} else {
+			return $this->action();
+		}
+	}
 
 
-    /**
-     * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions(): array
-    {
-        // if there are no standard caps for this model, then for now
-        // all we know if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return [
-                self::get_default_restrictions_cap(
-                ) => new EE_Return_None_Where_Conditions(),
-            ];
-        }
+	/**
+	 * @return EE_Default_Where_Conditions[]|EE_Return_None_Where_Conditions[]
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions(): array
+	{
+		// if there are no standard caps for this model, then for now
+		// all we know if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return [
+				self::get_default_restrictions_cap(
+				) => new EE_Return_None_Where_Conditions(),
+			];
+		}
 
-        $event_model = EEM_Event::instance();
-        return [
-            // first: basically access to non-defaults is essentially
-            // controlled by which events are accessible
-            // if they don't have the basic event cap,
-            // they can't access ANY non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action_for_event()
-            ) => new EE_Return_None_Where_Conditions(),
-            // if they don't have the others event cap,
-            // they can't access others' non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action_for_event() . '_others'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                ]
-            ),
-            // if they have basic and others, but not private,
-            // they can't access others' private non-default items
-            EE_Restriction_Generator_Base::get_cap_name(
-                $event_model,
-                $this->action_for_event() . '_private'
-            ) => new EE_Default_Where_Conditions(
-                [
-                    'OR*no_' .
-                    EE_Restriction_Generator_Base::get_cap_name(
-                        $event_model,
-                        $this->action_for_event() . '_private'
-                    ) => $this->addPublishedPostConditions(
-                        [
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
-                        ],
-                        false,
-                        $this->_path_to_event_model
-                    )
-                ]
-            ),
-        ];
-    }
+		$event_model = EEM_Event::instance();
+		return [
+			// first: basically access to non-defaults is essentially
+			// controlled by which events are accessible
+			// if they don't have the basic event cap,
+			// they can't access ANY non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action_for_event()
+			) => new EE_Return_None_Where_Conditions(),
+			// if they don't have the others event cap,
+			// they can't access others' non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action_for_event() . '_others'
+			) => new EE_Default_Where_Conditions(
+				[
+					$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+				]
+			),
+			// if they have basic and others, but not private,
+			// they can't access others' private non-default items
+			EE_Restriction_Generator_Base::get_cap_name(
+				$event_model,
+				$this->action_for_event() . '_private'
+			) => new EE_Default_Where_Conditions(
+				[
+					'OR*no_' .
+					EE_Restriction_Generator_Base::get_cap_name(
+						$event_model,
+						$this->action_for_event() . '_private'
+					) => $this->addPublishedPostConditions(
+						[
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_QUERY_PLACEHOLDER_CURRENT_USER,
+						],
+						false,
+						$this->_path_to_event_model
+					)
+				]
+			),
+		];
+	}
 }