eventespresso / event-espresso-core

core/db_models/EEM_Question_Group.model.php

Indentation +51 added lines, -51 removed lines

@@ -10,58 +10,58 @@
  */
 class EEM_Question_Group extends EEM_Soft_Delete_Base
 {
-    const system_personal = 1;
-    const system_address = 2;
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	const system_personal = 1;
+	const system_address = 2;
+	// private instance of the Attendee object
+	protected static $_instance = null;
         
         
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Question Group', 'event_espresso');
-        $this->plural_item = __('Question Groups', 'event_espresso');
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Question Group', 'event_espresso');
+		$this->plural_item = __('Question Groups', 'event_espresso');
 
-        $this->_tables = array(
-            'Question_Group'=>new EE_Primary_Table('esp_question_group', 'QSG_ID')
-        );
-        $this->_fields = array(
-            'Question_Group'=>array(
-                'QSG_ID'=>new EE_Primary_Key_Int_Field('QSG_ID', __('Question Group ID', 'event_espresso')),
-                'QSG_name'=>new EE_Plain_Text_Field('QSG_name', __('Question Group Name', 'event_espresso'), false, ''),
-                'QSG_identifier'=>new EE_Plain_Text_Field('QSG_identifier', __('Text ID for question Group', 'event_espresso'), false, ''),
-                'QSG_desc'=>new EE_Post_Content_Field('QSG_desc', __('Description of Question Group', 'event_espresso'), true, ''),
-                'QSG_order'=>new EE_Integer_Field('QSG_order', __('Order in which to show the question group', 'event_espresso'), true, 0),
-                'QSG_show_group_name'=>new EE_Boolean_Field('QSG_show_group_name', __('Flag indicating whether to show the group\'s name on the registration page', 'event_espresso'), false, true),
-                'QSG_show_group_desc'=>new EE_Boolean_Field('QSG_show_group_desc', __('Flag indicating whether to show the group\s description on the registration page', 'event_espresso'), false, false),
-                'QSG_wp_user' => new EE_WP_User_Field('QSG_wp_user', __('Question Group Creator ID', 'event_espresso'), false),
-                'QSG_system'=>new EE_Integer_Field('QSG_system', __('Indicate IF this is a system group and if it is what system group it corresponds to.', 'event_espresso'), false, 0),
-                'QSG_deleted'=>new EE_Trashed_Flag_Field('QSG_deleted', __('Flag indicating this question group was deleted', 'event_espresso'), false, false)
-            )
-        );
-        $this->_model_relations = array(
-            'Question'=>new EE_HABTM_Relation('Question_Group_Question'),
-            'Event'=>new EE_HABTM_Relation('Event_Question_Group'),
-            'Event_Question_Group'=>new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        parent::__construct($timezone);
-    }
-    /**
-     * searches the db for the question group with the latest question order and returns that value.
-     * @access public
-     * @return int
-     */
-    public function get_latest_question_group_order()
-    {
-        $columns_to_select = array(
-            'max_order' => array("MAX(QSG_order)","%d")
-            );
-        $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
-        return $max[0]['max_order'];
-    }
+		$this->_tables = array(
+			'Question_Group'=>new EE_Primary_Table('esp_question_group', 'QSG_ID')
+		);
+		$this->_fields = array(
+			'Question_Group'=>array(
+				'QSG_ID'=>new EE_Primary_Key_Int_Field('QSG_ID', __('Question Group ID', 'event_espresso')),
+				'QSG_name'=>new EE_Plain_Text_Field('QSG_name', __('Question Group Name', 'event_espresso'), false, ''),
+				'QSG_identifier'=>new EE_Plain_Text_Field('QSG_identifier', __('Text ID for question Group', 'event_espresso'), false, ''),
+				'QSG_desc'=>new EE_Post_Content_Field('QSG_desc', __('Description of Question Group', 'event_espresso'), true, ''),
+				'QSG_order'=>new EE_Integer_Field('QSG_order', __('Order in which to show the question group', 'event_espresso'), true, 0),
+				'QSG_show_group_name'=>new EE_Boolean_Field('QSG_show_group_name', __('Flag indicating whether to show the group\'s name on the registration page', 'event_espresso'), false, true),
+				'QSG_show_group_desc'=>new EE_Boolean_Field('QSG_show_group_desc', __('Flag indicating whether to show the group\s description on the registration page', 'event_espresso'), false, false),
+				'QSG_wp_user' => new EE_WP_User_Field('QSG_wp_user', __('Question Group Creator ID', 'event_espresso'), false),
+				'QSG_system'=>new EE_Integer_Field('QSG_system', __('Indicate IF this is a system group and if it is what system group it corresponds to.', 'event_espresso'), false, 0),
+				'QSG_deleted'=>new EE_Trashed_Flag_Field('QSG_deleted', __('Flag indicating this question group was deleted', 'event_espresso'), false, false)
+			)
+		);
+		$this->_model_relations = array(
+			'Question'=>new EE_HABTM_Relation('Question_Group_Question'),
+			'Event'=>new EE_HABTM_Relation('Event_Question_Group'),
+			'Event_Question_Group'=>new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+		parent::__construct($timezone);
+	}
+	/**
+	 * searches the db for the question group with the latest question order and returns that value.
+	 * @access public
+	 * @return int
+	 */
+	public function get_latest_question_group_order()
+	{
+		$columns_to_select = array(
+			'max_order' => array("MAX(QSG_order)","%d")
+			);
+		$max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
+		return $max[0]['max_order'];
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -45,10 +45,10 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form('QSG_system');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form('QSG_system');
         parent::__construct($timezone);
     }
     /**
@@ -59,7 +59,7 @@ 
     public function get_latest_question_group_order()
     {
         $columns_to_select = array(
-            'max_order' => array("MAX(QSG_order)","%d")
+            'max_order' => array("MAX(QSG_order)", "%d")
             );
         $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
         return $max[0]['max_order'];

core/db_models/EEM_WP_User.model.php

Indentation +113 added lines, -113 removed lines

@@ -13,126 +13,126 @@
 class EEM_WP_User extends EEM_Base
 {
 
-    /**
-     * private instance of the EEM_WP_User object
-     *
-     * @type EEM_WP_User
-     */
-    protected static $_instance;
+	/**
+	 * private instance of the EEM_WP_User object
+	 *
+	 * @type EEM_WP_User
+	 */
+	protected static $_instance;
 
 
 
-    /**
-     *    constructor
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = __('WP_User', 'event_espresso');
-        $this->plural_item = __('WP_Users', 'event_espresso');
-        global $wpdb;
-        $this->_tables = array(
-            'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
-        );
-        $this->_fields = array(
-            'WP_User' => array(
-                'ID'                  => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    __('WP_User ID', 'event_espresso')
-                ),
-                'user_login'          => $model_field_factory->createPlainTextField(
-                    'user_login',
-                    __('User Login', 'event_espresso'),
-                    false
-                ),
-                'user_pass'           => $model_field_factory->createPlainTextField(
-                    'user_pass',
-                    __('User Password', 'event_espresso'),
-                    false
-                ),
-                'user_nicename'       => $model_field_factory->createPlainTextField(
-                    'user_nicename',
-                    __(' User Nice Name', 'event_espresso'),
-                    false
-                ),
-                'user_email'          => $model_field_factory->createEmailField(
-                    'user_email',
-                    __('User Email', 'event_espresso'),
-                    false,
-                    null
-                ),
-                'user_registered'     => $model_field_factory->createDatetimeField(
-                    'user_registered',
-                    __('Date User Registered', 'event_espresso'),
-                    $timezone
-                ),
-                'user_activation_key' => $model_field_factory->createPlainTextField(
-                    'user_activation_key',
-                    __('User Activation Key', 'event_espresso'),
-                    false
-                ),
-                'user_status'         => $model_field_factory->createIntegerField(
-                    'user_status',
-                    __('User Status', 'event_espresso')
-                ),
-                'display_name'        => $model_field_factory->createPlainTextField(
-                    'display_name',
-                    __('Display Name', 'event_espresso'),
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'       => new EE_Has_Many_Relation(),
-            // all models are related to the change log
-            // 'Change_Log'     => new EE_Has_Many_Relation(),
-            'Event'          => new EE_Has_Many_Relation(),
-            'Payment_Method' => new EE_Has_Many_Relation(),
-            'Price'          => new EE_Has_Many_Relation(),
-            'Price_Type'     => new EE_Has_Many_Relation(),
-            'Question'       => new EE_Has_Many_Relation(),
-            'Question_Group' => new EE_Has_Many_Relation(),
-            'Ticket'         => new EE_Has_Many_Relation(),
-            'Venue'          => new EE_Has_Many_Relation(),
-            'Message'        => new EE_Has_Many_Relation(),
-        );
-        $this->_wp_core_model = true;
-        $this->_caps_slug = 'users';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
-        }
-        // @todo: account for create_users controls whether they can create users at all
-        parent::__construct($timezone);
-    }
+	/**
+	 *    constructor
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = __('WP_User', 'event_espresso');
+		$this->plural_item = __('WP_Users', 'event_espresso');
+		global $wpdb;
+		$this->_tables = array(
+			'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
+		);
+		$this->_fields = array(
+			'WP_User' => array(
+				'ID'                  => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					__('WP_User ID', 'event_espresso')
+				),
+				'user_login'          => $model_field_factory->createPlainTextField(
+					'user_login',
+					__('User Login', 'event_espresso'),
+					false
+				),
+				'user_pass'           => $model_field_factory->createPlainTextField(
+					'user_pass',
+					__('User Password', 'event_espresso'),
+					false
+				),
+				'user_nicename'       => $model_field_factory->createPlainTextField(
+					'user_nicename',
+					__(' User Nice Name', 'event_espresso'),
+					false
+				),
+				'user_email'          => $model_field_factory->createEmailField(
+					'user_email',
+					__('User Email', 'event_espresso'),
+					false,
+					null
+				),
+				'user_registered'     => $model_field_factory->createDatetimeField(
+					'user_registered',
+					__('Date User Registered', 'event_espresso'),
+					$timezone
+				),
+				'user_activation_key' => $model_field_factory->createPlainTextField(
+					'user_activation_key',
+					__('User Activation Key', 'event_espresso'),
+					false
+				),
+				'user_status'         => $model_field_factory->createIntegerField(
+					'user_status',
+					__('User Status', 'event_espresso')
+				),
+				'display_name'        => $model_field_factory->createPlainTextField(
+					'display_name',
+					__('Display Name', 'event_espresso'),
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'       => new EE_Has_Many_Relation(),
+			// all models are related to the change log
+			// 'Change_Log'     => new EE_Has_Many_Relation(),
+			'Event'          => new EE_Has_Many_Relation(),
+			'Payment_Method' => new EE_Has_Many_Relation(),
+			'Price'          => new EE_Has_Many_Relation(),
+			'Price_Type'     => new EE_Has_Many_Relation(),
+			'Question'       => new EE_Has_Many_Relation(),
+			'Question_Group' => new EE_Has_Many_Relation(),
+			'Ticket'         => new EE_Has_Many_Relation(),
+			'Venue'          => new EE_Has_Many_Relation(),
+			'Message'        => new EE_Has_Many_Relation(),
+		);
+		$this->_wp_core_model = true;
+		$this->_caps_slug = 'users';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
+		}
+		// @todo: account for create_users controls whether they can create users at all
+		parent::__construct($timezone);
+	}
 
 
 
-    /**
-     * We don't need a foreign key to the WP_User model, we just need its primary key
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function wp_user_field_name()
-    {
-        return $this->primary_key_name();
-    }
+	/**
+	 * We don't need a foreign key to the WP_User model, we just need its primary key
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function wp_user_field_name()
+	{
+		return $this->primary_key_name();
+	}
 
 
 
-    /**
-     * This WP_User model IS owned, even though it doesn't have a foreign key to itself
-     *
-     * @return boolean
-     */
-    public function is_owned()
-    {
-        return true;
-    }
+	/**
+	 * This WP_User model IS owned, even though it doesn't have a foreign key to itself
+	 *
+	 * @return boolean
+	 */
+	public function is_owned()
+	{
+		return true;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -102,10 +102,10 @@
         );
         $this->_wp_core_model = true;
         $this->_caps_slug = 'users';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
+        $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read] = 'list';
+        $this->_cap_contexts_to_cap_action_map[EEM_Base::caps_read_admin] = 'list';
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_WP_User();
         }
         // @todo: account for create_users controls whether they can create users at all
         parent::__construct($timezone);

core/db_models/EEM_Extra_Join.model.php

Indentation +26 added lines, -26 removed lines

@@ -23,32 +23,32 @@
  */
 class EEM_Extra_Join extends EEM_Base
 {
-    // private instance of the Extra Join object
-    protected static $_instance = null;
+	// private instance of the Extra Join object
+	protected static $_instance = null;
     
-    public function __construct($timezone = null)
-    {
-        $models_this_can_join = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_tables = array(
-            'Extra_Join' => new EE_Primary_Table('esp_extra_join', 'EXJ_ID'),
-        );
-        $this->_fields = array(
-            'Extra_Join' => array(
-                'EXJ_ID' => new EE_Primary_Key_Int_Field('EXJ_ID', __('Extra Join ID', 'event_espresso')),
-                'EXJ_first_model_ID' => new EE_Foreign_Key_String_Field('EXJ_first_model_ID', __('First Model ID', 'event_espresso'), true, 0, $models_this_can_join),
-                'EXJ_first_model_name' => new EE_Any_Foreign_Model_Name_Field('EXJ_first_model_name', __('First Model Name', 'event_espresso'), true, '', $models_this_can_join),
-                'EXJ_second_model_ID' => new EE_Foreign_Key_String_Field('EXJ_second_model_ID', __('Second Model ID', 'event_espresso'), true, 0, $models_this_can_join),
-                'EXJ_second_model_name' => new EE_Any_Foreign_Model_Name_Field('EXJ_second_model_name', __('Second Model Name', 'event_espresso'), true, '', $models_this_can_join),
+	public function __construct($timezone = null)
+	{
+		$models_this_can_join = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_tables = array(
+			'Extra_Join' => new EE_Primary_Table('esp_extra_join', 'EXJ_ID'),
+		);
+		$this->_fields = array(
+			'Extra_Join' => array(
+				'EXJ_ID' => new EE_Primary_Key_Int_Field('EXJ_ID', __('Extra Join ID', 'event_espresso')),
+				'EXJ_first_model_ID' => new EE_Foreign_Key_String_Field('EXJ_first_model_ID', __('First Model ID', 'event_espresso'), true, 0, $models_this_can_join),
+				'EXJ_first_model_name' => new EE_Any_Foreign_Model_Name_Field('EXJ_first_model_name', __('First Model Name', 'event_espresso'), true, '', $models_this_can_join),
+				'EXJ_second_model_ID' => new EE_Foreign_Key_String_Field('EXJ_second_model_ID', __('Second Model ID', 'event_espresso'), true, 0, $models_this_can_join),
+				'EXJ_second_model_name' => new EE_Any_Foreign_Model_Name_Field('EXJ_second_model_name', __('Second Model Name', 'event_espresso'), true, '', $models_this_can_join),
                 
-            )
-        );
-        // this model is weird in that it has two foreign key columns which can point to any model/table.
-        // eg a foreign key to event will be in "EXJ_first_model_ID", provided the other
-        // model linked to is alphabetically greater than event (eg venue).
-        // but if the model linked to is alphabetically lower (eg attendee),
-        // the foreign key to the event will be in "EXJ_second_model_ID"
-        // so normal usage of foreign keys is weird. So don't define any
-        // relations to other models because they won't work properly with this model
-        parent::__construct($timezone);
-    }
+			)
+		);
+		// this model is weird in that it has two foreign key columns which can point to any model/table.
+		// eg a foreign key to event will be in "EXJ_first_model_ID", provided the other
+		// model linked to is alphabetically greater than event (eg venue).
+		// but if the model linked to is alphabetically lower (eg attendee),
+		// the foreign key to the event will be in "EXJ_second_model_ID"
+		// so normal usage of foreign keys is weird. So don't define any
+		// relations to other models because they won't work properly with this model
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_State.model.php

Indentation +157 added lines, -157 removed lines

@@ -11,161 +11,161 @@
 class EEM_State extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
-    // array of all states
-    private static $_all_states = false;
-    // array of all active states
-    private static $_active_states = false;
-
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('State/Province', 'event_espresso');
-        $this->plural_item = __('States/Provinces', 'event_espresso');
-
-        $this->_tables = array(
-            'State'=> new EE_Primary_Table('esp_state', 'STA_ID')
-        );
-
-        $this->_fields = array(
-            'State'=>array(
-                'STA_ID'=> new EE_Primary_Key_Int_Field('STA_ID', __('State ID', 'event_espresso')),
-                'CNT_ISO'=> new EE_Foreign_Key_String_Field('CNT_ISO', __('Country ISO Code', 'event_espresso'), false, null, 'Country'),
-                'STA_abbrev' => new EE_Plain_Text_Field('STA_abbrev', __('State Abbreviation', 'event_espresso'), false, ''),
-                'STA_name' => new EE_Plain_Text_Field('STA_name', __('State Name', 'event_espresso'), false, ''),
-                'STA_active'=> new EE_Boolean_Field('STA_active', __('State Active Flag', 'event_espresso'), false, false)
-                ));
-        $this->_model_relations = array(
-            'Attendee'=>new EE_Has_Many_Relation(),
-            'Country' => new EE_Belongs_To_Relation(),
-            'Venue'=>new EE_Has_Many_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        // @todo: only show STA_active
-        parent::__construct($timezone);
-    }
-
-
-
-
-    /**
-    *   reset_cached_states
-    *
-    *   @access     private
-    *   @return         void
-    */
-    public function reset_cached_states()
-    {
-        EEM_State::$_active_states = array();
-        EEM_State::$_all_states = array();
-    }
-
-
-
-
-    /**
-    *       _get_states
-    *
-    *       @access     private
-    *       @return         array
-    */
-    public function get_all_states()
-    {
-        if (! self::$_all_states) {
-            self::$_all_states = $this->get_all(array( 'order_by'=>array( 'STA_name'=>'ASC' ), 'limit'=> array( 0, 99999 )));
-        }
-        return self::$_all_states;
-    }
-
-
-
-    /**
-     *        _get_states
-     *
-     * @access        public
-     * @param array $countries
-     * @param bool  $flush_cache
-     * @return        array
-     */
-    public function get_all_active_states($countries = array(), $flush_cache = false)
-    {
-        if (! self::$_active_states || $flush_cache) {
-            $countries = is_array($countries) && ! empty($countries) ? $countries : EEM_Country::instance()->get_all_active_countries();
-            self::$_active_states =  $this->get_all(array(
-                array( 'STA_active' => true, 'CNT_ISO' => array( 'IN', array_keys($countries))),
-                'order_by' => array( 'STA_name'=>'ASC' ),
-                'limit' => array( 0, 99999 ),
-                'force_join' => array( 'Country' )
-            ));
-        }
-        return self::$_active_states;
-    }
-
-
-
-    /**
-     *  get_all_states_of_active_countries
-     * @return array
-     */
-    public function get_all_states_of_active_countries()
-    {
-        if ($states = $this->get_all(array( array( 'Country.CNT_active' => true, 'STA_active' => true ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
-            return $states;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *  get_all_states_of_active_countries
-     * @return array
-     */
-    public function get_all_active_states_for_these_countries($countries)
-    {
-        if (! $countries) {
-            return false;
-        }
-        if ($states = $this->get_all(array(  array( 'Country.CNT_ISO' => array( 'IN', array_keys($countries)), 'STA_active' => true ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
-            return $states;
-        }
-        return false;
-    }
-
-
-
-    /**
-     *  get_all_states_of_active_countries
-     * @return array
-     */
-    public function get_all_states_for_these_countries($countries)
-    {
-        if (! $countries) {
-            return false;
-        }
-        if ($states = $this->get_all(array( array( 'Country.CNT_ISO' => array( 'IN', array_keys($countries))),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
-            return $states;
-        }
-        return false;
-    }
-
-    /**
-     * Gets the state's name by its ID
-     * @param string $state_ID
-     * @return string
-     */
-    public function get_state_name_by_ID($state_ID)
-    {
-        if (isset(self::$_all_states[ $state_ID ]) &&
-                self::$_all_states[ $state_ID ] instanceof EE_State ) {
-            return self::$_all_states[ $state_ID ]->name();
-        }
-        $names = $this->get_col(array( array( 'STA_ID' => $state_ID ), 'limit' => 1), 'STA_name');
-        if (is_array($names) && ! empty($names)) {
-            return reset($names);
-        } else {
-            return '';
-        }
-    }
+	// private instance of the Attendee object
+	protected static $_instance = null;
+	// array of all states
+	private static $_all_states = false;
+	// array of all active states
+	private static $_active_states = false;
+
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('State/Province', 'event_espresso');
+		$this->plural_item = __('States/Provinces', 'event_espresso');
+
+		$this->_tables = array(
+			'State'=> new EE_Primary_Table('esp_state', 'STA_ID')
+		);
+
+		$this->_fields = array(
+			'State'=>array(
+				'STA_ID'=> new EE_Primary_Key_Int_Field('STA_ID', __('State ID', 'event_espresso')),
+				'CNT_ISO'=> new EE_Foreign_Key_String_Field('CNT_ISO', __('Country ISO Code', 'event_espresso'), false, null, 'Country'),
+				'STA_abbrev' => new EE_Plain_Text_Field('STA_abbrev', __('State Abbreviation', 'event_espresso'), false, ''),
+				'STA_name' => new EE_Plain_Text_Field('STA_name', __('State Name', 'event_espresso'), false, ''),
+				'STA_active'=> new EE_Boolean_Field('STA_active', __('State Active Flag', 'event_espresso'), false, false)
+				));
+		$this->_model_relations = array(
+			'Attendee'=>new EE_Has_Many_Relation(),
+			'Country' => new EE_Belongs_To_Relation(),
+			'Venue'=>new EE_Has_Many_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		// @todo: only show STA_active
+		parent::__construct($timezone);
+	}
+
+
+
+
+	/**
+	 *   reset_cached_states
+	 *
+	 *   @access     private
+	 *   @return         void
+	 */
+	public function reset_cached_states()
+	{
+		EEM_State::$_active_states = array();
+		EEM_State::$_all_states = array();
+	}
+
+
+
+
+	/**
+	 *       _get_states
+	 *
+	 *       @access     private
+	 *       @return         array
+	 */
+	public function get_all_states()
+	{
+		if (! self::$_all_states) {
+			self::$_all_states = $this->get_all(array( 'order_by'=>array( 'STA_name'=>'ASC' ), 'limit'=> array( 0, 99999 )));
+		}
+		return self::$_all_states;
+	}
+
+
+
+	/**
+	 *        _get_states
+	 *
+	 * @access        public
+	 * @param array $countries
+	 * @param bool  $flush_cache
+	 * @return        array
+	 */
+	public function get_all_active_states($countries = array(), $flush_cache = false)
+	{
+		if (! self::$_active_states || $flush_cache) {
+			$countries = is_array($countries) && ! empty($countries) ? $countries : EEM_Country::instance()->get_all_active_countries();
+			self::$_active_states =  $this->get_all(array(
+				array( 'STA_active' => true, 'CNT_ISO' => array( 'IN', array_keys($countries))),
+				'order_by' => array( 'STA_name'=>'ASC' ),
+				'limit' => array( 0, 99999 ),
+				'force_join' => array( 'Country' )
+			));
+		}
+		return self::$_active_states;
+	}
+
+
+
+	/**
+	 *  get_all_states_of_active_countries
+	 * @return array
+	 */
+	public function get_all_states_of_active_countries()
+	{
+		if ($states = $this->get_all(array( array( 'Country.CNT_active' => true, 'STA_active' => true ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+			return $states;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *  get_all_states_of_active_countries
+	 * @return array
+	 */
+	public function get_all_active_states_for_these_countries($countries)
+	{
+		if (! $countries) {
+			return false;
+		}
+		if ($states = $this->get_all(array(  array( 'Country.CNT_ISO' => array( 'IN', array_keys($countries)), 'STA_active' => true ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+			return $states;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 *  get_all_states_of_active_countries
+	 * @return array
+	 */
+	public function get_all_states_for_these_countries($countries)
+	{
+		if (! $countries) {
+			return false;
+		}
+		if ($states = $this->get_all(array( array( 'Country.CNT_ISO' => array( 'IN', array_keys($countries))),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+			return $states;
+		}
+		return false;
+	}
+
+	/**
+	 * Gets the state's name by its ID
+	 * @param string $state_ID
+	 * @return string
+	 */
+	public function get_state_name_by_ID($state_ID)
+	{
+		if (isset(self::$_all_states[ $state_ID ]) &&
+				self::$_all_states[ $state_ID ] instanceof EE_State ) {
+			return self::$_all_states[ $state_ID ]->name();
+		}
+		$names = $this->get_col(array( array( 'STA_ID' => $state_ID ), 'limit' => 1), 'STA_name');
+		if (is_array($names) && ! empty($names)) {
+			return reset($names);
+		} else {
+			return '';
+		}
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -41,7 +41,7 @@ 
             'Venue'=>new EE_Has_Many_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         // @todo: only show STA_active
         parent::__construct($timezone);
     }
@@ -72,8 +72,8 @@ 
     */
     public function get_all_states()
     {
-        if (! self::$_all_states) {
-            self::$_all_states = $this->get_all(array( 'order_by'=>array( 'STA_name'=>'ASC' ), 'limit'=> array( 0, 99999 )));
+        if ( ! self::$_all_states) {
+            self::$_all_states = $this->get_all(array('order_by'=>array('STA_name'=>'ASC'), 'limit'=> array(0, 99999)));
         }
         return self::$_all_states;
     }
@@ -90,13 +90,13 @@ 
      */
     public function get_all_active_states($countries = array(), $flush_cache = false)
     {
-        if (! self::$_active_states || $flush_cache) {
+        if ( ! self::$_active_states || $flush_cache) {
             $countries = is_array($countries) && ! empty($countries) ? $countries : EEM_Country::instance()->get_all_active_countries();
-            self::$_active_states =  $this->get_all(array(
-                array( 'STA_active' => true, 'CNT_ISO' => array( 'IN', array_keys($countries))),
-                'order_by' => array( 'STA_name'=>'ASC' ),
-                'limit' => array( 0, 99999 ),
-                'force_join' => array( 'Country' )
+            self::$_active_states = $this->get_all(array(
+                array('STA_active' => true, 'CNT_ISO' => array('IN', array_keys($countries))),
+                'order_by' => array('STA_name'=>'ASC'),
+                'limit' => array(0, 99999),
+                'force_join' => array('Country')
             ));
         }
         return self::$_active_states;
@@ -110,7 +110,7 @@ 
      */
     public function get_all_states_of_active_countries()
     {
-        if ($states = $this->get_all(array( array( 'Country.CNT_active' => true, 'STA_active' => true ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+        if ($states = $this->get_all(array(array('Country.CNT_active' => true, 'STA_active' => true), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
             return $states;
         }
         return false;
@@ -124,10 +124,10 @@ 
      */
     public function get_all_active_states_for_these_countries($countries)
     {
-        if (! $countries) {
+        if ( ! $countries) {
             return false;
         }
-        if ($states = $this->get_all(array(  array( 'Country.CNT_ISO' => array( 'IN', array_keys($countries)), 'STA_active' => true ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+        if ($states = $this->get_all(array(array('Country.CNT_ISO' => array('IN', array_keys($countries)), 'STA_active' => true), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
             return $states;
         }
         return false;
@@ -141,10 +141,10 @@ 
      */
     public function get_all_states_for_these_countries($countries)
     {
-        if (! $countries) {
+        if ( ! $countries) {
             return false;
         }
-        if ($states = $this->get_all(array( array( 'Country.CNT_ISO' => array( 'IN', array_keys($countries))),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+        if ($states = $this->get_all(array(array('Country.CNT_ISO' => array('IN', array_keys($countries))), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
             return $states;
         }
         return false;
@@ -157,11 +157,11 @@ 
      */
     public function get_state_name_by_ID($state_ID)
     {
-        if (isset(self::$_all_states[ $state_ID ]) &&
-                self::$_all_states[ $state_ID ] instanceof EE_State ) {
-            return self::$_all_states[ $state_ID ]->name();
+        if (isset(self::$_all_states[$state_ID]) &&
+                self::$_all_states[$state_ID] instanceof EE_State) {
+            return self::$_all_states[$state_ID]->name();
         }
-        $names = $this->get_col(array( array( 'STA_ID' => $state_ID ), 'limit' => 1), 'STA_name');
+        $names = $this->get_col(array(array('STA_ID' => $state_ID), 'limit' => 1), 'STA_name');
         if (is_array($names) && ! empty($names)) {
             return reset($names);
         } else {

core/db_models/EEM_Ticket_Template.model.php

Indentation +34 added lines, -34 removed lines

@@ -13,40 +13,40 @@
 
 
 
-    // private instance of the EEM_Ticket_Template object
-    protected static $_instance = null;
+	// private instance of the EEM_Ticket_Template object
+	protected static $_instance = null;
 
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access private
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return void
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Ticket Template', 'event_espresso');
-        $this->plural_item = __('Ticket Templates', 'event_espresso');
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access private
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return void
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Ticket Template', 'event_espresso');
+		$this->plural_item = __('Ticket Templates', 'event_espresso');
 
-        $this->_tables = array(
-            'Ticket_Template'=> new EE_Primary_Table('esp_ticket_template', 'TTM_ID')
-        );
-        $this->_fields = array(
-            'Ticket_Template'=>array(
-                'TTM_ID'=>new EE_Primary_Key_Int_Field('TTM_ID', __('Ticket Template ID', 'event_espresso')),
-                'TTM_name'=>new EE_Plain_Text_Field('TTM_name', __('The name of the ticket template', 'event_espresso'), false, ''),
-                'TTM_description'=>new EE_Plain_Text_Field('TTM_description', __('The description for the ticket template', 'event_espresso'), true, ''),
-                'TTM_file'=>new EE_Plain_Text_Field('TTM_file', __('The file name for the actual template file saved on disk', 'event_espresso'), true, ''),
-            ));
-        $this->_model_relations = array(
-            'Ticket'=>new EE_Has_Many_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        parent::__construct($timezone);
-    }
+		$this->_tables = array(
+			'Ticket_Template'=> new EE_Primary_Table('esp_ticket_template', 'TTM_ID')
+		);
+		$this->_fields = array(
+			'Ticket_Template'=>array(
+				'TTM_ID'=>new EE_Primary_Key_Int_Field('TTM_ID', __('Ticket Template ID', 'event_espresso')),
+				'TTM_name'=>new EE_Plain_Text_Field('TTM_name', __('The name of the ticket template', 'event_espresso'), false, ''),
+				'TTM_description'=>new EE_Plain_Text_Field('TTM_description', __('The description for the ticket template', 'event_espresso'), true, ''),
+				'TTM_file'=>new EE_Plain_Text_Field('TTM_file', __('The file name for the actual template file saved on disk', 'event_espresso'), true, ''),
+			));
+		$this->_model_relations = array(
+			'Ticket'=>new EE_Has_Many_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Ticket';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		parent::__construct($timezone);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -42,11 +42,11 @@
             'Ticket'=>new EE_Has_Many_Relation()
         );
         $this->_model_chain_to_wp_user = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         parent::__construct($timezone);
     }
 }

core/db_models/EEM_Term_Relationship.model.php

Spacing +12 added lines, -12 removed lines

@@ -58,24 +58,24 @@ 
             'Term_Taxonomy' => new EE_Belongs_To_Relation(),
         );
         foreach ($models_this_can_attach_to as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
+            $this->_model_relations[$model_name] = new EE_Belongs_To_Relation();
         }
         $this->_wp_core_model = true;
         $this->_indexes = array(
             'PRIMARY' => new EE_Primary_Key_Index(array('object_id', 'term_taxonomy_id')),
         );
         $path_to_event_model = 'Event.';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Event_Related_Public(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event_model,
                 EEM_Base::caps_edit
@@ -85,27 +85,27 @@ 
         // and for deleting term relations too
         $cap_contexts_affected = array(EEM_Base::caps_edit, EEM_Base::caps_delete);
         foreach ($cap_contexts_affected as $cap_context_affected) {
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_event_category'] =
                 new EE_Default_Where_Conditions(
                     array(
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_category' => array(
+                        $path_to_tax_model.'taxonomy*ee_assign_event_category' => array(
                             '!=',
                             'espresso_event_categories',
                         ),
                     )
                 );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_venue_category'] =
                 new EE_Default_Where_Conditions(
                     array(
-                        $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => array(
+                        $path_to_tax_model.'taxonomy*ee_assign_venue_category' => array(
                             '!=',
                             'espresso_venue_categories',
                         ),
                     )
                 );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type'] = new EE_Default_Where_Conditions(
+            $this->_cap_restrictions[$cap_context_affected]['ee_assign_event_type'] = new EE_Default_Where_Conditions(
                 array(
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_type' => array('!=', 'espresso_event_type'),
+                    $path_to_tax_model.'taxonomy*ee_assign_event_type' => array('!=', 'espresso_event_type'),
                 )
             );
         }
@@ -227,7 +227,7 @@ 
     {
         if ($model === EEM_Term_Relationship::instance()) {
             $taxonomies = get_taxonomies(array('show_in_rest' => true));
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['Term_Taxonomy.taxonomy'] = array('IN', $taxonomies);
             }
         }

Indentation +223 added lines, -223 removed lines

@@ -9,233 +9,233 @@
 class EEM_Term_Relationship extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
-
-
-
-    /**
-     * EEM_Term_Relationship constructor.
-     *
-     * @param string $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Term Relationship', 'event_espresso');
-        $this->plural_item = __('Term Relationships', 'event_espresso');
-        $this->_tables = array(
-            'Term_Relationship' => new EE_Primary_Table('term_relationships'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields = array(
-            'Term_Relationship' => array(
-                'object_id'        => new EE_Foreign_Key_Int_Field(
-                    'object_id',
-                    __('Object(Post) ID', 'event_espresso'),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
-                    'term_taxonomy_id',
-                    __(
-                        'Term (in context of a taxonomy) ID',
-                        'event_espresso'
-                    ),
-                    false,
-                    0,
-                    'Term_Taxonomy'
-                ),
-                'term_order'       => new EE_Integer_Field(
-                    'term_order',
-                    __('Term Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Term_Taxonomy' => new EE_Belongs_To_Relation(),
-        );
-        foreach ($models_this_can_attach_to as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
-        }
-        $this->_wp_core_model = true;
-        $this->_indexes = array(
-            'PRIMARY' => new EE_Primary_Key_Index(array('object_id', 'term_taxonomy_id')),
-        );
-        $path_to_event_model = 'Event.';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model,
-                EEM_Base::caps_edit
-            );
-        $path_to_tax_model = 'Term_Taxonomy.';
-        // add cap restrictions for editing term relations to the "ee_assign_*"
-        // and for deleting term relations too
-        $cap_contexts_affected = array(EEM_Base::caps_edit, EEM_Base::caps_delete);
-        foreach ($cap_contexts_affected as $cap_context_affected) {
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
-                new EE_Default_Where_Conditions(
-                    array(
-                        $path_to_tax_model . 'taxonomy*ee_assign_event_category' => array(
-                            '!=',
-                            'espresso_event_categories',
-                        ),
-                    )
-                );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
-                new EE_Default_Where_Conditions(
-                    array(
-                        $path_to_tax_model . 'taxonomy*ee_assign_venue_category' => array(
-                            '!=',
-                            'espresso_venue_categories',
-                        ),
-                    )
-                );
-            $this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type'] = new EE_Default_Where_Conditions(
-                array(
-                    $path_to_tax_model . 'taxonomy*ee_assign_event_type' => array('!=', 'espresso_event_type'),
-                )
-            );
-        }
-        parent::__construct($timezone);
-        add_filter(
-            'FHEE__Read__create_model_query_params',
-            array('EEM_Term_Relationship', 'rest_api_query_params'),
-            10,
-            3
-        );
-    }
-
-
-    /**
-     * Makes sure all term-taxonomy counts are correct
-     *
-     * @param int   $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
-     * @global wpdb $wpdb
-     * @return int the number of rows affected
-     * @throws EE_Error
-     */
-    public function update_term_taxonomy_counts($term_taxonomy_id = null)
-    {
-        // because this uses a subquery and sometimes assigning to column to be another column's
-        // value, we just write the SQL directly.
-        global $wpdb;
-
-        $query = "
+	// private instance of the Attendee object
+	protected static $_instance = null;
+
+
+
+	/**
+	 * EEM_Term_Relationship constructor.
+	 *
+	 * @param string $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Term Relationship', 'event_espresso');
+		$this->plural_item = __('Term Relationships', 'event_espresso');
+		$this->_tables = array(
+			'Term_Relationship' => new EE_Primary_Table('term_relationships'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields = array(
+			'Term_Relationship' => array(
+				'object_id'        => new EE_Foreign_Key_Int_Field(
+					'object_id',
+					__('Object(Post) ID', 'event_espresso'),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'term_taxonomy_id' => new EE_Foreign_Key_Int_Field(
+					'term_taxonomy_id',
+					__(
+						'Term (in context of a taxonomy) ID',
+						'event_espresso'
+					),
+					false,
+					0,
+					'Term_Taxonomy'
+				),
+				'term_order'       => new EE_Integer_Field(
+					'term_order',
+					__('Term Order', 'event_espresso'),
+					false,
+					0
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Term_Taxonomy' => new EE_Belongs_To_Relation(),
+		);
+		foreach ($models_this_can_attach_to as $model_name) {
+			$this->_model_relations[ $model_name ] = new EE_Belongs_To_Relation();
+		}
+		$this->_wp_core_model = true;
+		$this->_indexes = array(
+			'PRIMARY' => new EE_Primary_Key_Index(array('object_id', 'term_taxonomy_id')),
+		);
+		$path_to_event_model = 'Event.';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model,
+				EEM_Base::caps_edit
+			);
+		$path_to_tax_model = 'Term_Taxonomy.';
+		// add cap restrictions for editing term relations to the "ee_assign_*"
+		// and for deleting term relations too
+		$cap_contexts_affected = array(EEM_Base::caps_edit, EEM_Base::caps_delete);
+		foreach ($cap_contexts_affected as $cap_context_affected) {
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_category'] =
+				new EE_Default_Where_Conditions(
+					array(
+						$path_to_tax_model . 'taxonomy*ee_assign_event_category' => array(
+							'!=',
+							'espresso_event_categories',
+						),
+					)
+				);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_venue_category'] =
+				new EE_Default_Where_Conditions(
+					array(
+						$path_to_tax_model . 'taxonomy*ee_assign_venue_category' => array(
+							'!=',
+							'espresso_venue_categories',
+						),
+					)
+				);
+			$this->_cap_restrictions[ $cap_context_affected ]['ee_assign_event_type'] = new EE_Default_Where_Conditions(
+				array(
+					$path_to_tax_model . 'taxonomy*ee_assign_event_type' => array('!=', 'espresso_event_type'),
+				)
+			);
+		}
+		parent::__construct($timezone);
+		add_filter(
+			'FHEE__Read__create_model_query_params',
+			array('EEM_Term_Relationship', 'rest_api_query_params'),
+			10,
+			3
+		);
+	}
+
+
+	/**
+	 * Makes sure all term-taxonomy counts are correct
+	 *
+	 * @param int   $term_taxonomy_id the id of the term taxonomy to update. If NULL, updates ALL
+	 * @global wpdb $wpdb
+	 * @return int the number of rows affected
+	 * @throws EE_Error
+	 */
+	public function update_term_taxonomy_counts($term_taxonomy_id = null)
+	{
+		// because this uses a subquery and sometimes assigning to column to be another column's
+		// value, we just write the SQL directly.
+		global $wpdb;
+
+		$query = "
                 UPDATE {$wpdb->term_taxonomy} AS tt 
                 SET count = (
                     select count(*) as proper_count from {$wpdb->term_relationships} AS tr 
                     WHERE tt.term_taxonomy_id = tr.term_taxonomy_id
                 )";
 
-        if ($term_taxonomy_id) {
-            $query .= ' WHERE tt.term_taxonomy_id = %d';
-            $query = $wpdb->prepare(
-                $query,
-                $term_taxonomy_id
-            );
-        }
-        $rows_affected = $this->_do_wpdb_query(
-            'query',
-            array(
-                $query,
-            )
-        );
-        return $rows_affected;
-    }
-
-
-
-    /**
-     * Overrides the parent to also make sure term-taxonomy counts are up-to-date after
-     * inserting
-     *
-     * @param array $field_n_values @see EEM_Base::insert
-     * @return boolean
-     */
-    public function insert($field_n_values)
-    {
-        $return = parent::insert($field_n_values);
-        if (isset($field_n_values['term_taxonomy_id'])) {
-            $this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']);
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * Overrides parent so that after an update, we also check the term_taxonomy_counts are
-     * all ok
-     *
-     * @param array   $fields_n_values         see EEM_Base::update
-     * @param array   $query_params            @see EEM_Base::get_all
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match
-     *                                         $query_params. This obviously has some overhead, so you can disable it
-     *                                         by setting this to FALSE, but be aware that model objects being used
-     *                                         could get out-of-sync with the database
-     * @return int
-     */
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-        if ($count) {
-            $this->update_term_taxonomy_counts();
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Overrides parent so that after running this, we also double-check
-     * the term taxonomy counts are up-to-date
-     *
-     * @param array   $query_params @see EEM_Base::get_all
-     * @param boolean $allow_blocking
-     * @return int @see EEM_Base::delete
-     */
-    public function delete($query_params, $allow_blocking = true)
-    {
-        $count = parent::delete($query_params, $allow_blocking);
-        if ($count) {
-            $this->update_term_taxonomy_counts();
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Makes sure that during REST API queries, we only return term relationships
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     */
-    public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
-    {
-        if ($model === EEM_Term_Relationship::instance()) {
-            $taxonomies = get_taxonomies(array('show_in_rest' => true));
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['Term_Taxonomy.taxonomy'] = array('IN', $taxonomies);
-            }
-        }
-        return $model_query_params;
-    }
+		if ($term_taxonomy_id) {
+			$query .= ' WHERE tt.term_taxonomy_id = %d';
+			$query = $wpdb->prepare(
+				$query,
+				$term_taxonomy_id
+			);
+		}
+		$rows_affected = $this->_do_wpdb_query(
+			'query',
+			array(
+				$query,
+			)
+		);
+		return $rows_affected;
+	}
+
+
+
+	/**
+	 * Overrides the parent to also make sure term-taxonomy counts are up-to-date after
+	 * inserting
+	 *
+	 * @param array $field_n_values @see EEM_Base::insert
+	 * @return boolean
+	 */
+	public function insert($field_n_values)
+	{
+		$return = parent::insert($field_n_values);
+		if (isset($field_n_values['term_taxonomy_id'])) {
+			$this->update_term_taxonomy_counts($field_n_values['term_taxonomy_id']);
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * Overrides parent so that after an update, we also check the term_taxonomy_counts are
+	 * all ok
+	 *
+	 * @param array   $fields_n_values         see EEM_Base::update
+	 * @param array   $query_params            @see EEM_Base::get_all
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
+	 *                                         by setting this to FALSE, but be aware that model objects being used
+	 *                                         could get out-of-sync with the database
+	 * @return int
+	 */
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$count = parent::update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+		if ($count) {
+			$this->update_term_taxonomy_counts();
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Overrides parent so that after running this, we also double-check
+	 * the term taxonomy counts are up-to-date
+	 *
+	 * @param array   $query_params @see EEM_Base::get_all
+	 * @param boolean $allow_blocking
+	 * @return int @see EEM_Base::delete
+	 */
+	public function delete($query_params, $allow_blocking = true)
+	{
+		$count = parent::delete($query_params, $allow_blocking);
+		if ($count) {
+			$this->update_term_taxonomy_counts();
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Makes sure that during REST API queries, we only return term relationships
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
+	{
+		if ($model === EEM_Term_Relationship::instance()) {
+			$taxonomies = get_taxonomies(array('show_in_rest' => true));
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['Term_Taxonomy.taxonomy'] = array('IN', $taxonomies);
+			}
+		}
+		return $model_query_params;
+	}
 }

core/db_models/EEM_Message.model.php

Indentation +612 added lines, -612 removed lines

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

Spacing +8 added lines, -8 removed lines

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

core/db_models/EEM_Event_Venue.model.php

Indentation +28 added lines, -28 removed lines

@@ -7,34 +7,34 @@
  */
 class EEM_Event_Venue extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Event to Question Group Link', 'event_espresso');
-        $this->plural_item = __('Event to Question Group Links', 'event_espresso');
-        $this->_tables = array(
-            'Event_Venue'=>new EE_Primary_Table('esp_event_venue', 'EVV_ID')
-        );
-        $this->_fields = array(
-            'Event_Venue'=>array(
-                'EVV_ID'=>new EE_Primary_Key_Int_Field('EVV_ID', __('Event to Venue Link ID', 'event_espresso')),
-                'EVT_ID'=>new EE_Foreign_Key_Int_Field('EVT_ID', __('Event ID', 'event_espresso'), false, 0, 'Event'),
-                'VNU_ID'=>new EE_Foreign_Key_Int_Field('VNU_ID', __('Venue ID', 'event_espresso'), false, 0, 'Venue'),
-                'EVV_primary'=>new EE_Boolean_Field('EVV_primary', __("Flag indicating venue is primary one for event", "event_espresso"), false, true)
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Event to Question Group Link', 'event_espresso');
+		$this->plural_item = __('Event to Question Group Links', 'event_espresso');
+		$this->_tables = array(
+			'Event_Venue'=>new EE_Primary_Table('esp_event_venue', 'EVV_ID')
+		);
+		$this->_fields = array(
+			'Event_Venue'=>array(
+				'EVV_ID'=>new EE_Primary_Key_Int_Field('EVV_ID', __('Event to Venue Link ID', 'event_espresso')),
+				'EVT_ID'=>new EE_Foreign_Key_Int_Field('EVT_ID', __('Event ID', 'event_espresso'), false, 0, 'Event'),
+				'VNU_ID'=>new EE_Foreign_Key_Int_Field('VNU_ID', __('Venue ID', 'event_espresso'), false, 0, 'Venue'),
+				'EVV_primary'=>new EE_Boolean_Field('EVV_primary', __("Flag indicating venue is primary one for event", "event_espresso"), false, true)
 
-            )
-        );
-        $this->_model_relations = array(
-            'Event'=>new EE_Belongs_To_Relation(),
-            'Venue'=>new EE_Belongs_To_Relation()
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public('Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected('Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected('Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected('Event', EEM_Base::caps_edit);
-        parent::__construct($timezone);
-    }
+			)
+		);
+		$this->_model_relations = array(
+			'Event'=>new EE_Belongs_To_Relation(),
+			'Venue'=>new EE_Belongs_To_Relation()
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public('Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected('Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected('Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected('Event', EEM_Base::caps_edit);
+		parent::__construct($timezone);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -31,10 +31,10 @@
             'Venue'=>new EE_Belongs_To_Relation()
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public('Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected('Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected('Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected('Event', EEM_Base::caps_edit);
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Event_Related_Public('Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected('Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Event_Related_Protected('Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Event_Related_Protected('Event', EEM_Base::caps_edit);
         parent::__construct($timezone);
     }
 }

core/db_models/EEM_Datetime_Ticket.model.php

Indentation +33 added lines, -33 removed lines

@@ -12,39 +12,39 @@
 {
 
 
-    // private instance of the EEM_Datetime_Ticket object
-    protected static $_instance = null;
+	// private instance of the EEM_Datetime_Ticket object
+	protected static $_instance = null;
 
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access private
-     *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     *      @return void
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Datetime Ticket', 'event_espresso');
-        $this->plural_item = __('Datetime Tickets', 'event_espresso');
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access private
+	 *      @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 *      @return void
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Datetime Ticket', 'event_espresso');
+		$this->plural_item = __('Datetime Tickets', 'event_espresso');
 
-        $this->_tables = array(
-            'Datetime_Ticket'=> new EE_Primary_Table('esp_datetime_ticket', 'DTK_ID')
-        );
-        $this->_fields = array(
-            'Datetime_Ticket'=>array(
-                'DTK_ID'=>new EE_Primary_Key_Int_Field('DTK_ID', __('Datetime Ticket ID', 'event_espresso')),
-                'DTT_ID'=>new EE_Foreign_Key_Int_Field('DTT_ID', __('The ID to the Datetime', 'event_espresso'), false, 0, 'Datetime'),
-                'TKT_ID'=>new EE_Foreign_Key_Int_Field('TKT_ID', __('The ID to the Ticket', 'event_espresso'), false, 0, 'Ticket')
-            ));
-        $this->_model_relations = array(
-            'Ticket'=>new EE_Belongs_To_Relation(),
-            'Datetime'=>new EE_Belongs_To_Relation()
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public('Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event', EEM_Base::caps_edit);
-        parent::__construct($timezone);
-    }
+		$this->_tables = array(
+			'Datetime_Ticket'=> new EE_Primary_Table('esp_datetime_ticket', 'DTK_ID')
+		);
+		$this->_fields = array(
+			'Datetime_Ticket'=>array(
+				'DTK_ID'=>new EE_Primary_Key_Int_Field('DTK_ID', __('Datetime Ticket ID', 'event_espresso')),
+				'DTT_ID'=>new EE_Foreign_Key_Int_Field('DTT_ID', __('The ID to the Datetime', 'event_espresso'), false, 0, 'Datetime'),
+				'TKT_ID'=>new EE_Foreign_Key_Int_Field('TKT_ID', __('The ID to the Ticket', 'event_espresso'), false, 0, 'Ticket')
+			));
+		$this->_model_relations = array(
+			'Ticket'=>new EE_Belongs_To_Relation(),
+			'Datetime'=>new EE_Belongs_To_Relation()
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public('Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event', EEM_Base::caps_edit);
+		parent::__construct($timezone);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -41,10 +41,10 @@
             'Datetime'=>new EE_Belongs_To_Relation()
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Event_Related_Public('Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event', EEM_Base::caps_edit);
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Event_Related_Public('Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event');
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Event_Related_Protected('Datetime.Event', EEM_Base::caps_edit);
         parent::__construct($timezone);
     }
 }