eventespresso / event-espresso-core

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', esc_html__('Extra Join ID', 'event_espresso')),
-                'EXJ_first_model_ID' => new EE_Foreign_Key_String_Field('EXJ_first_model_ID', esc_html__('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', esc_html__('First Model Name', 'event_espresso'), true, '', $models_this_can_join),
-                'EXJ_second_model_ID' => new EE_Foreign_Key_String_Field('EXJ_second_model_ID', esc_html__('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', esc_html__('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', esc_html__('Extra Join ID', 'event_espresso')),
+				'EXJ_first_model_ID' => new EE_Foreign_Key_String_Field('EXJ_first_model_ID', esc_html__('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', esc_html__('First Model Name', 'event_espresso'), true, '', $models_this_can_join),
+				'EXJ_second_model_ID' => new EE_Foreign_Key_String_Field('EXJ_second_model_ID', esc_html__('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', esc_html__('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_Registration_Payment.model.php

Spacing +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
     {
 
         $this->singular_item = esc_html__('Registration Payment', 'event_espresso');
-        $this->plural_item  = esc_html__('Registration Payments', 'event_espresso');
+        $this->plural_item = esc_html__('Registration Payments', 'event_espresso');
 
         $this->_tables = array(
             'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID')

Indentation +23 added lines, -23 removed lines

@@ -12,34 +12,34 @@
  */
 class EEM_Registration_Payment extends EEM_Base
 {
-    // private instance
-    protected static $_instance = null;
+	// private instance
+	protected static $_instance = null;
 
 
-    protected function __construct($timezone = null)
-    {
+	protected function __construct($timezone = null)
+	{
 
-        $this->singular_item = esc_html__('Registration Payment', 'event_espresso');
-        $this->plural_item  = esc_html__('Registration Payments', 'event_espresso');
+		$this->singular_item = esc_html__('Registration Payment', 'event_espresso');
+		$this->plural_item  = esc_html__('Registration Payments', 'event_espresso');
 
-        $this->_tables = array(
-            'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID')
-        );
+		$this->_tables = array(
+			'Registration_Payment' => new EE_Primary_Table('esp_registration_payment', 'RPY_ID')
+		);
 
-        $this->_fields = array(
-            'Registration_Payment' => array(
-                'RPY_ID'                => new EE_Primary_Key_Int_Field('RPY_ID', esc_html__('Registration Payment ID', 'event_espresso')),
-                'REG_ID'                => new EE_Foreign_Key_Int_Field('REG_ID', esc_html__('Registration ID', 'event_espresso'), false, 0, 'Registration'),
-                'PAY_ID'                => new EE_Foreign_Key_Int_Field('PAY_ID', esc_html__('Payment ID', 'event_espresso'), true, null, 'Payment'),
-                'RPY_amount'    => new EE_Money_Field('RPY_amount', esc_html__('Amount attributed to the registration', 'event_espresso'), false, 0),
-            )
-        );
+		$this->_fields = array(
+			'Registration_Payment' => array(
+				'RPY_ID'                => new EE_Primary_Key_Int_Field('RPY_ID', esc_html__('Registration Payment ID', 'event_espresso')),
+				'REG_ID'                => new EE_Foreign_Key_Int_Field('REG_ID', esc_html__('Registration ID', 'event_espresso'), false, 0, 'Registration'),
+				'PAY_ID'                => new EE_Foreign_Key_Int_Field('PAY_ID', esc_html__('Payment ID', 'event_espresso'), true, null, 'Payment'),
+				'RPY_amount'    => new EE_Money_Field('RPY_amount', esc_html__('Amount attributed to the registration', 'event_espresso'), false, 0),
+			)
+		);
 
-        $this->_model_relations = array(
-            'Registration'  => new EE_Belongs_To_Relation(),
-            'Payment'       => new EE_Belongs_To_Relation(),
-        );
+		$this->_model_relations = array(
+			'Registration'  => new EE_Belongs_To_Relation(),
+			'Payment'       => new EE_Belongs_To_Relation(),
+		);
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_CPT_Base.model.php

Spacing +31 added lines, -31 removed lines

@@ -84,63 +84,63 @@ 
             }
         }
         // set default wp post statuses if child has not already set.
-        if (! isset($this->_fields[ $primary_table_name ]['status'])) {
-            $this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['status'])) {
+            $this->_fields[$primary_table_name]['status'] = new EE_WP_Post_Status_Field(
                 'post_status',
                 esc_html__("Event Status", "event_espresso"),
                 false,
                 'draft'
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
-            $this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['to_ping'])) {
+            $this->_fields[$primary_table_name]['to_ping'] = new EE_DB_Only_Text_Field(
                 'to_ping',
                 esc_html__('To Ping', 'event_espresso'),
                 false,
                 ''
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
-            $this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['pinged'])) {
+            $this->_fields[$primary_table_name]['pinged'] = new EE_DB_Only_Text_Field(
                 'pinged',
                 esc_html__('Pinged', 'event_espresso'),
                 false,
                 ''
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
-            $this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['comment_status'])) {
+            $this->_fields[$primary_table_name]['comment_status'] = new EE_Plain_Text_Field(
                 'comment_status',
                 esc_html__('Comment Status', 'event_espresso'),
                 false,
                 'open'
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
-            $this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['ping_status'])) {
+            $this->_fields[$primary_table_name]['ping_status'] = new EE_Plain_Text_Field(
                 'ping_status',
                 esc_html__('Ping Status', 'event_espresso'),
                 false,
                 'open'
             );
         }
-        if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
-            $this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
+        if ( ! isset($this->_fields[$primary_table_name]['post_content_filtered'])) {
+            $this->_fields[$primary_table_name]['post_content_filtered'] = new EE_DB_Only_Text_Field(
                 'post_content_filtered',
                 esc_html__('Post Content Filtered', 'event_espresso'),
                 false,
                 ''
             );
         }
-        if (! isset($this->_model_relations['Post_Meta'])) {
+        if ( ! isset($this->_model_relations['Post_Meta'])) {
             // don't block deletes though because we want to maintain the current behaviour
             $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
         }
-        if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             // nothing was set during child constructor, so set default
             $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
         }
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             // nothing was set during child constructor, so set default
             // it's ok for child classes to specify this, but generally this is more DRY
             $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
@@ -214,7 +214,7 @@ 
     protected function _alter_query_params_so_only_trashed_items_included($query_params)
     {
         $post_status_field_name = $this->post_status_field_name();
-        $query_params[0][ $post_status_field_name ] = self::post_status_trashed;
+        $query_params[0][$post_status_field_name] = self::post_status_trashed;
         return $query_params;
     }
 
@@ -282,7 +282,7 @@ 
                 $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
             }
         }
-        if (! $all) {
+        if ( ! $all) {
             foreach ($all_fields as $name => $obj) {
                 if ($obj instanceof EE_DB_Only_Field_Base) {
                     continue;
@@ -314,7 +314,7 @@ 
         $parent_term_taxonomy_id = null
     ) {
         // create term
-        require_once(EE_MODELS . 'EEM_Term.model.php');
+        require_once(EE_MODELS.'EEM_Term.model.php');
         // first, check for a term by the same name or slug
         $category_slug = sanitize_title($category_name);
         $term = EEM_Term::instance()->get_one(
@@ -328,7 +328,7 @@ 
                 ),
             )
         );
-        if (! $term) {
+        if ( ! $term) {
             $term = EE_Term::new_instance(
                 array(
                     'name' => $category_name,
@@ -338,7 +338,7 @@ 
             $term->save();
         }
         // make sure there's a term-taxonomy entry too
-        require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
+        require_once(EE_MODELS.'EEM_Term_Taxonomy.model.php');
         $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
             array(
                 array(
@@ -348,7 +348,7 @@ 
             )
         );
         /** @var $term_taxonomy EE_Term_Taxonomy */
-        if (! $term_taxonomy) {
+        if ( ! $term_taxonomy) {
             $term_taxonomy = EE_Term_Taxonomy::new_instance(
                 array(
                     'term_id'     => $term->ID(),
@@ -421,7 +421,7 @@ 
         global $wp_post_statuses;
         $statuses = array();
         foreach ($wp_post_statuses as $post_status => $args_object) {
-            $statuses[ $post_status ] = $args_object->label;
+            $statuses[$post_status] = $args_object->label;
         }
         return $statuses;
     }
@@ -438,7 +438,7 @@ 
         // first the global filter
         $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
         // now the class specific filter
-        $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
+        $statuses = apply_filters('FHEE_EEM_'.get_class($this).'__get_status_array', $statuses);
         return $statuses;
     }
 
@@ -452,7 +452,7 @@ 
     {
         $new_stati = array();
         foreach ($this->_custom_stati as $status => $props) {
-            $new_stati[ $status ] = $props['label'];
+            $new_stati[$status] = $props['label'];
         }
         return $new_stati;
     }
@@ -476,15 +476,15 @@ 
             $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
             foreach ($fields_for_that_table as $field_obj) {
                 if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
+                    ! isset($post[$field_obj->get_table_column()])
+                    && ! isset($post[$field_obj->get_qualified_column()])
                 ) {
                     $has_all_necessary_fields_for_table = false;
                 }
             }
         }
         // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if (! $has_all_necessary_fields_for_table) {
+        if ( ! $has_all_necessary_fields_for_table) {
             return $this->get_one_by_ID($post['ID']);
         } else {
             return $this->instantiate_class_from_array_or_object($post);
@@ -508,10 +508,10 @@ 
             $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
             foreach ($fields_for_that_table as $field_obj) {
                 if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
+                    ! isset($post[$field_obj->get_table_column()])
+                    && ! isset($post[$field_obj->get_qualified_column()])
                 ) {
-                    $tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
+                    $tables_needing_to_be_queried[$table_obj->get_table_alias()] = $table_obj;
                 }
             }
         }
@@ -537,7 +537,7 @@ 
                         ARRAY_A,
                     )
                 );
-                if (! empty($missing_data)) {
+                if ( ! empty($missing_data)) {
                     $post = array_merge($post, $missing_data);
                 }
             } else {

Indentation +560 added lines, -560 removed lines

@@ -14,564 +14,564 @@
  */
 abstract class EEM_CPT_Base extends EEM_Soft_Delete_Base
 {
-    const EVENT_CATEGORY_TAXONOMY = 'espresso_event_categories';
-
-    /**
-     * @var string post_status_publish - the wp post status for published cpts
-     */
-    const post_status_publish = 'publish';
-
-    /**
-     * @var string post_status_future - the wp post status for scheduled cpts
-     */
-    const post_status_future = 'future';
-
-    /**
-     * @var string post_status_draft - the wp post status for draft cpts
-     */
-    const post_status_draft = 'draft';
-
-    /**
-     * @var string post_status_pending - the wp post status for pending cpts
-     */
-    const post_status_pending = 'pending';
-
-    /**
-     * @var string post_status_private - the wp post status for private cpts
-     */
-    const post_status_private = 'private';
-
-    /**
-     * @var string post_status_trashed - the wp post status for trashed cpts
-     */
-    const post_status_trashed = 'trash';
-
-    /**
-     * This is an array of custom statuses for the given CPT model (modified by children)
-     * format:
-     * array(
-     *        'status_name' => array(
-     *            'label' => esc_html__('Status Name', 'event_espresso'),
-     *            'public' => TRUE //whether a public status or not.
-     *        )
-     * )
-     *
-     * @var array
-     */
-    protected $_custom_stati = array();
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        // adds a relationship to Term_Taxonomy for all these models. For this to work
-        // Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly
-        // eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry
-        // with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value
-        // must also be new EE_HABTM_Relation('Term_Relationship');
-        $this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship');
-        $primary_table_name = null;
-        // add  the common _status field to all CPT primary tables.
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Primary_Table) {
-                $primary_table_name = $alias;
-            }
-        }
-        // set default wp post statuses if child has not already set.
-        if (! isset($this->_fields[ $primary_table_name ]['status'])) {
-            $this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
-                'post_status',
-                esc_html__("Event Status", "event_espresso"),
-                false,
-                'draft'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
-            $this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
-                'to_ping',
-                esc_html__('To Ping', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
-            $this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
-                'pinged',
-                esc_html__('Pinged', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
-            $this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
-                'comment_status',
-                esc_html__('Comment Status', 'event_espresso'),
-                false,
-                'open'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
-            $this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
-                'ping_status',
-                esc_html__('Ping Status', 'event_espresso'),
-                false,
-                'open'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
-            $this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
-                'post_content_filtered',
-                esc_html__('Post Content Filtered', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_model_relations['Post_Meta'])) {
-            // don't block deletes though because we want to maintain the current behaviour
-            $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
-        }
-        if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
-        }
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            // it's ok for child classes to specify this, but generally this is more DRY
-            $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
-        }
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function public_event_stati()
-    {
-        // @see wp-includes/post.php
-        return get_post_stati(array('public' => true));
-    }
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    '%1$s should not call deleted_field_name()! It should instead use post_status_field_name',
-                    "event_espresso"
-                ),
-                get_called_class()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the field's name that sets the post status
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function post_status_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                        'event_espresso'
-                    ),
-                    get_called_class(),
-                    get_called_class()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $post_status_field_name = $this->post_status_field_name();
-        $query_params[0][ $post_status_field_name ] = self::post_status_trashed;
-        return $query_params;
-    }
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        $query_params['default_where_conditions'] = 'minimum';
-        return $query_params;
-    }
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete       true to indicate deletion, false to indicate restoration
-     * @param array $query_params
-     * @return boolean success
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function delete_or_restore($delete = true, $query_params = array())
-    {
-        $post_status_field_name = $this->post_status_field_name();
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        $new_status = $delete ? self::post_status_trashed : 'draft';
-        return (bool) $this->update([$post_status_field_name => $new_status], $query_params);
-    }
-
-
-    /**
-     * meta_table
-     * returns first EE_Secondary_Table table name
-     *
-     * @access public
-     * @return string
-     */
-    public function meta_table()
-    {
-        $meta_table = $this->_get_other_tables();
-        $meta_table = reset($meta_table);
-        return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
-    }
-
-
-    /**
-     * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
-     *
-     * @param  bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
-     *                   db only fields)
-     * @return array
-     */
-    public function get_meta_table_fields($all = false)
-    {
-        $all_fields = $fields_to_return = array();
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Secondary_Table) {
-                $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
-            }
-        }
-        if (! $all) {
-            foreach ($all_fields as $name => $obj) {
-                if ($obj instanceof EE_DB_Only_Field_Base) {
-                    continue;
-                }
-                $fields_to_return[] = $name;
-            }
-        } else {
-            $fields_to_return = array_keys($all_fields);
-        }
-        return $fields_to_return;
-    }
-
-
-    /**
-     * Adds an event category with the specified name and description to the specified
-     * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
-     * and adds an entry in the term_relationship if necessary.
-     *
-     * @param EE_CPT_Base $cpt_model_object
-     * @param string      $category_name (used to derive the term slug too)
-     * @param string      $category_description
-     * @param int         $parent_term_taxonomy_id
-     * @return EE_Term_Taxonomy
-     */
-    public function add_event_category(
-        EE_CPT_Base $cpt_model_object,
-        $category_name,
-        $category_description = '',
-        $parent_term_taxonomy_id = null
-    ) {
-        // create term
-        require_once(EE_MODELS . 'EEM_Term.model.php');
-        // first, check for a term by the same name or slug
-        $category_slug = sanitize_title($category_name);
-        $term = EEM_Term::instance()->get_one(
-            array(
-                array(
-                    'OR' => array(
-                        'name' => $category_name,
-                        'slug' => $category_slug,
-                    ),
-                    'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY
-                ),
-            )
-        );
-        if (! $term) {
-            $term = EE_Term::new_instance(
-                array(
-                    'name' => $category_name,
-                    'slug' => $category_slug,
-                )
-            );
-            $term->save();
-        }
-        // make sure there's a term-taxonomy entry too
-        require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
-        $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
-            array(
-                array(
-                    'term_id'  => $term->ID(),
-                    'taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
-                ),
-            )
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if (! $term_taxonomy) {
-            $term_taxonomy = EE_Term_Taxonomy::new_instance(
-                array(
-                    'term_id'     => $term->ID(),
-                    'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
-                    'description' => $category_description,
-                    'term_count'       => 1,
-                    'parent'      => $parent_term_taxonomy_id,
-                )
-            );
-            $term_taxonomy->save();
-        } else {
-            $term_taxonomy->set_count($term_taxonomy->count() + 1);
-            $term_taxonomy->save();
-        }
-        return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * Removed the category specified by name as having a relation to this event.
-     * Does not remove the term or term_taxonomy.
-     *
-     * @param EE_CPT_Base $cpt_model_object_event
-     * @param string      $category_name name of the event category (term)
-     * @return bool
-     */
-    public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
-    {
-        // find the term_taxonomy by that name
-        $term_taxonomy = $this->get_first_related(
-            $cpt_model_object_event,
-            'Term_Taxonomy',
-            array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY))
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if ($term_taxonomy) {
-            $term_taxonomy->set_count($term_taxonomy->count() - 1);
-            $term_taxonomy->save();
-        }
-        return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
-     * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access public
-     * @param int          $id   the ID for the cpt we want the feature image for
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     */
-    public function get_feature_image($id, $size = 'thumbnail', $attr = '')
-    {
-        return get_the_post_thumbnail($id, $size, $attr);
-    }
-
-
-    /**
-     * Just a handy way to get the list of post statuses currently registered with WP.
-     *
-     * @global array $wp_post_statuses set in wp core for storing all the post stati
-     * @return array
-     */
-    public function get_post_statuses()
-    {
-        global $wp_post_statuses;
-        $statuses = array();
-        foreach ($wp_post_statuses as $post_status => $args_object) {
-            $statuses[ $post_status ] = $args_object->label;
-        }
-        return $statuses;
-    }
-
-
-    /**
-     * public method that can be used to retrieve the protected status array on the instantiated cpt model
-     *
-     * @return array array of statuses.
-     */
-    public function get_status_array()
-    {
-        $statuses = $this->get_post_statuses();
-        // first the global filter
-        $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
-        // now the class specific filter
-        $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
-        return $statuses;
-    }
-
-
-    /**
-     * this returns the post statuses that are NOT the default wordpress status
-     *
-     * @return array
-     */
-    public function get_custom_post_statuses()
-    {
-        $new_stati = array();
-        foreach ($this->_custom_stati as $status => $props) {
-            $new_stati[ $status ] = $props['label'];
-        }
-        return $new_stati;
-    }
-
-
-    /**
-     * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
-     * are a row from the posts table. If we're missing any fields required for the model,
-     * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
-     * make sure you are attaching all the model's fields onto the post)
-     *
-     * @param WP_Post|array $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object_orig($post)
-    {
-        $post = (array) $post;
-        $has_all_necessary_fields_for_table = true;
-        // check if the post has fields on the meta table already
-        foreach ($this->_get_other_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $has_all_necessary_fields_for_table = false;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if (! $has_all_necessary_fields_for_table) {
-            return $this->get_one_by_ID($post['ID']);
-        } else {
-            return $this->instantiate_class_from_array_or_object($post);
-        }
-    }
-
-
-    /**
-     * @param null $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object($post = null)
-    {
-        if (empty($post)) {
-            global $post;
-        }
-        $post = (array) $post;
-        $tables_needing_to_be_queried = array();
-        // check if the post has fields on the meta table already
-        foreach ($this->get_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if ($tables_needing_to_be_queried) {
-            if (
-                count($tables_needing_to_be_queried) == 1
-                && reset($tables_needing_to_be_queried)
-                   instanceof
-                   EE_Secondary_Table
-            ) {
-                // so we're only missing data from a secondary table. Well that's not too hard to query for
-                $table_to_query = reset($tables_needing_to_be_queried);
-                $missing_data = $this->_do_wpdb_query(
-                    'get_row',
-                    array(
-                        'SELECT * FROM '
-                        . $table_to_query->get_table_name()
-                        . ' WHERE '
-                        . $table_to_query->get_fk_on_table()
-                        . ' = '
-                        . $post['ID'],
-                        ARRAY_A,
-                    )
-                );
-                if (! empty($missing_data)) {
-                    $post = array_merge($post, $missing_data);
-                }
-            } else {
-                return $this->get_one_by_ID($post['ID']);
-            }
-        }
-        return $this->instantiate_class_from_array_or_object($post);
-    }
-
-
-    /**
-     * Gets the post type associated with this
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function post_type()
-    {
-        $post_type_field = null;
-        foreach ($this->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_WP_Post_Type_Field) {
-                $post_type_field = $field_obj;
-                break;
-            }
-        }
-        if ($post_type_field == null) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $post_type_field->get_default_value();
-    }
+	const EVENT_CATEGORY_TAXONOMY = 'espresso_event_categories';
+
+	/**
+	 * @var string post_status_publish - the wp post status for published cpts
+	 */
+	const post_status_publish = 'publish';
+
+	/**
+	 * @var string post_status_future - the wp post status for scheduled cpts
+	 */
+	const post_status_future = 'future';
+
+	/**
+	 * @var string post_status_draft - the wp post status for draft cpts
+	 */
+	const post_status_draft = 'draft';
+
+	/**
+	 * @var string post_status_pending - the wp post status for pending cpts
+	 */
+	const post_status_pending = 'pending';
+
+	/**
+	 * @var string post_status_private - the wp post status for private cpts
+	 */
+	const post_status_private = 'private';
+
+	/**
+	 * @var string post_status_trashed - the wp post status for trashed cpts
+	 */
+	const post_status_trashed = 'trash';
+
+	/**
+	 * This is an array of custom statuses for the given CPT model (modified by children)
+	 * format:
+	 * array(
+	 *        'status_name' => array(
+	 *            'label' => esc_html__('Status Name', 'event_espresso'),
+	 *            'public' => TRUE //whether a public status or not.
+	 *        )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_custom_stati = array();
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		// adds a relationship to Term_Taxonomy for all these models. For this to work
+		// Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly
+		// eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry
+		// with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value
+		// must also be new EE_HABTM_Relation('Term_Relationship');
+		$this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship');
+		$primary_table_name = null;
+		// add  the common _status field to all CPT primary tables.
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Primary_Table) {
+				$primary_table_name = $alias;
+			}
+		}
+		// set default wp post statuses if child has not already set.
+		if (! isset($this->_fields[ $primary_table_name ]['status'])) {
+			$this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
+				'post_status',
+				esc_html__("Event Status", "event_espresso"),
+				false,
+				'draft'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
+			$this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
+				'to_ping',
+				esc_html__('To Ping', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
+			$this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
+				'pinged',
+				esc_html__('Pinged', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
+			$this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
+				'comment_status',
+				esc_html__('Comment Status', 'event_espresso'),
+				false,
+				'open'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
+			$this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
+				'ping_status',
+				esc_html__('Ping Status', 'event_espresso'),
+				false,
+				'open'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
+			$this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
+				'post_content_filtered',
+				esc_html__('Post Content Filtered', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_model_relations['Post_Meta'])) {
+			// don't block deletes though because we want to maintain the current behaviour
+			$this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
+		}
+		if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			$this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
+		}
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			// it's ok for child classes to specify this, but generally this is more DRY
+			$this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
+		}
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function public_event_stati()
+	{
+		// @see wp-includes/post.php
+		return get_post_stati(array('public' => true));
+	}
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'%1$s should not call deleted_field_name()! It should instead use post_status_field_name',
+					"event_espresso"
+				),
+				get_called_class()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the field's name that sets the post status
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function post_status_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+						'event_espresso'
+					),
+					get_called_class(),
+					get_called_class()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$post_status_field_name = $this->post_status_field_name();
+		$query_params[0][ $post_status_field_name ] = self::post_status_trashed;
+		return $query_params;
+	}
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		$query_params['default_where_conditions'] = 'minimum';
+		return $query_params;
+	}
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete       true to indicate deletion, false to indicate restoration
+	 * @param array $query_params
+	 * @return boolean success
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function delete_or_restore($delete = true, $query_params = array())
+	{
+		$post_status_field_name = $this->post_status_field_name();
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		$new_status = $delete ? self::post_status_trashed : 'draft';
+		return (bool) $this->update([$post_status_field_name => $new_status], $query_params);
+	}
+
+
+	/**
+	 * meta_table
+	 * returns first EE_Secondary_Table table name
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function meta_table()
+	{
+		$meta_table = $this->_get_other_tables();
+		$meta_table = reset($meta_table);
+		return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
+	}
+
+
+	/**
+	 * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
+	 *
+	 * @param  bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
+	 *                   db only fields)
+	 * @return array
+	 */
+	public function get_meta_table_fields($all = false)
+	{
+		$all_fields = $fields_to_return = array();
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Secondary_Table) {
+				$all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
+			}
+		}
+		if (! $all) {
+			foreach ($all_fields as $name => $obj) {
+				if ($obj instanceof EE_DB_Only_Field_Base) {
+					continue;
+				}
+				$fields_to_return[] = $name;
+			}
+		} else {
+			$fields_to_return = array_keys($all_fields);
+		}
+		return $fields_to_return;
+	}
+
+
+	/**
+	 * Adds an event category with the specified name and description to the specified
+	 * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
+	 * and adds an entry in the term_relationship if necessary.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object
+	 * @param string      $category_name (used to derive the term slug too)
+	 * @param string      $category_description
+	 * @param int         $parent_term_taxonomy_id
+	 * @return EE_Term_Taxonomy
+	 */
+	public function add_event_category(
+		EE_CPT_Base $cpt_model_object,
+		$category_name,
+		$category_description = '',
+		$parent_term_taxonomy_id = null
+	) {
+		// create term
+		require_once(EE_MODELS . 'EEM_Term.model.php');
+		// first, check for a term by the same name or slug
+		$category_slug = sanitize_title($category_name);
+		$term = EEM_Term::instance()->get_one(
+			array(
+				array(
+					'OR' => array(
+						'name' => $category_name,
+						'slug' => $category_slug,
+					),
+					'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY
+				),
+			)
+		);
+		if (! $term) {
+			$term = EE_Term::new_instance(
+				array(
+					'name' => $category_name,
+					'slug' => $category_slug,
+				)
+			);
+			$term->save();
+		}
+		// make sure there's a term-taxonomy entry too
+		require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
+		$term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
+			array(
+				array(
+					'term_id'  => $term->ID(),
+					'taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
+				),
+			)
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if (! $term_taxonomy) {
+			$term_taxonomy = EE_Term_Taxonomy::new_instance(
+				array(
+					'term_id'     => $term->ID(),
+					'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
+					'description' => $category_description,
+					'term_count'       => 1,
+					'parent'      => $parent_term_taxonomy_id,
+				)
+			);
+			$term_taxonomy->save();
+		} else {
+			$term_taxonomy->set_count($term_taxonomy->count() + 1);
+			$term_taxonomy->save();
+		}
+		return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * Removed the category specified by name as having a relation to this event.
+	 * Does not remove the term or term_taxonomy.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object_event
+	 * @param string      $category_name name of the event category (term)
+	 * @return bool
+	 */
+	public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
+	{
+		// find the term_taxonomy by that name
+		$term_taxonomy = $this->get_first_related(
+			$cpt_model_object_event,
+			'Term_Taxonomy',
+			array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY))
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if ($term_taxonomy) {
+			$term_taxonomy->set_count($term_taxonomy->count() - 1);
+			$term_taxonomy->save();
+		}
+		return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
+	 * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access public
+	 * @param int          $id   the ID for the cpt we want the feature image for
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 */
+	public function get_feature_image($id, $size = 'thumbnail', $attr = '')
+	{
+		return get_the_post_thumbnail($id, $size, $attr);
+	}
+
+
+	/**
+	 * Just a handy way to get the list of post statuses currently registered with WP.
+	 *
+	 * @global array $wp_post_statuses set in wp core for storing all the post stati
+	 * @return array
+	 */
+	public function get_post_statuses()
+	{
+		global $wp_post_statuses;
+		$statuses = array();
+		foreach ($wp_post_statuses as $post_status => $args_object) {
+			$statuses[ $post_status ] = $args_object->label;
+		}
+		return $statuses;
+	}
+
+
+	/**
+	 * public method that can be used to retrieve the protected status array on the instantiated cpt model
+	 *
+	 * @return array array of statuses.
+	 */
+	public function get_status_array()
+	{
+		$statuses = $this->get_post_statuses();
+		// first the global filter
+		$statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
+		// now the class specific filter
+		$statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
+		return $statuses;
+	}
+
+
+	/**
+	 * this returns the post statuses that are NOT the default wordpress status
+	 *
+	 * @return array
+	 */
+	public function get_custom_post_statuses()
+	{
+		$new_stati = array();
+		foreach ($this->_custom_stati as $status => $props) {
+			$new_stati[ $status ] = $props['label'];
+		}
+		return $new_stati;
+	}
+
+
+	/**
+	 * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
+	 * are a row from the posts table. If we're missing any fields required for the model,
+	 * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
+	 * make sure you are attaching all the model's fields onto the post)
+	 *
+	 * @param WP_Post|array $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object_orig($post)
+	{
+		$post = (array) $post;
+		$has_all_necessary_fields_for_table = true;
+		// check if the post has fields on the meta table already
+		foreach ($this->_get_other_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (
+					! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$has_all_necessary_fields_for_table = false;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if (! $has_all_necessary_fields_for_table) {
+			return $this->get_one_by_ID($post['ID']);
+		} else {
+			return $this->instantiate_class_from_array_or_object($post);
+		}
+	}
+
+
+	/**
+	 * @param null $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object($post = null)
+	{
+		if (empty($post)) {
+			global $post;
+		}
+		$post = (array) $post;
+		$tables_needing_to_be_queried = array();
+		// check if the post has fields on the meta table already
+		foreach ($this->get_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (
+					! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if ($tables_needing_to_be_queried) {
+			if (
+				count($tables_needing_to_be_queried) == 1
+				&& reset($tables_needing_to_be_queried)
+				   instanceof
+				   EE_Secondary_Table
+			) {
+				// so we're only missing data from a secondary table. Well that's not too hard to query for
+				$table_to_query = reset($tables_needing_to_be_queried);
+				$missing_data = $this->_do_wpdb_query(
+					'get_row',
+					array(
+						'SELECT * FROM '
+						. $table_to_query->get_table_name()
+						. ' WHERE '
+						. $table_to_query->get_fk_on_table()
+						. ' = '
+						. $post['ID'],
+						ARRAY_A,
+					)
+				);
+				if (! empty($missing_data)) {
+					$post = array_merge($post, $missing_data);
+				}
+			} else {
+				return $this->get_one_by_ID($post['ID']);
+			}
+		}
+		return $this->instantiate_class_from_array_or_object($post);
+	}
+
+
+	/**
+	 * Gets the post type associated with this
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function post_type()
+	{
+		$post_type_field = null;
+		foreach ($this->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_WP_Post_Type_Field) {
+				$post_type_field = $field_obj;
+				break;
+			}
+		}
+		if ($post_type_field == null) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $post_type_field->get_default_value();
+	}
 }

core/db_models/relations/EE_Model_Relation_Base.php

Indentation +497 added lines, -497 removed lines

@@ -16,502 +16,502 @@
  */
 abstract class EE_Model_Relation_Base implements HasSchemaInterface
 {
-    /**
-     * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private $_this_model_name;
-    /**
-     * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private $_other_model_name;
-
-    /**
-     * this is typically used when calling the relation models to make sure they inherit any set timezone from the
-     * initiating model.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-    /**
-     * If you try to delete "this_model", and there are related "other_models",
-     * and this isn't null, then abandon the deletion and add this warning.
-     * This effectively makes it impossible to delete "this_model" while there are
-     * related "other_models" along this relation.
-     *
-     * @var string (internationalized)
-     */
-    protected $_blocking_delete_error_message;
-
-    protected $_blocking_delete = false;
-
-    /**
-     * Object representing the relationship between two models. This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param boolean $block_deletes                 if there are related models across this relation, block (prevent
-     *                                               and add an error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($block_deletes, $blocking_delete_error_message)
-    {
-        $this->_blocking_delete               = $block_deletes;
-        $this->_blocking_delete_error_message = $blocking_delete_error_message;
-    }
-
-
-    /**
-     * @param $this_model_name
-     * @param $other_model_name
-     * @throws EE_Error
-     */
-    public function _construct_finalize_set_models($this_model_name, $other_model_name)
-    {
-        $this->_this_model_name  = $this_model_name;
-        $this->_other_model_name = $other_model_name;
-        if (is_string($this->_blocking_delete)) {
-            throw new EE_Error(sprintf(
-                esc_html__(
-                    "When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)",
-                    "event_espresso"
-                ),
-                get_class($this),
-                $this_model_name,
-                $other_model_name,
-                $this->_blocking_delete
-            ));
-        }
-    }
-
-
-    /**
-     * Gets the model where this relation is defined.
-     *
-     * @return EEM_Base
-     */
-    public function get_this_model()
-    {
-        return $this->_get_model($this->_this_model_name);
-    }
-
-
-    /**
-     * Gets the model which this relation establishes the relation TO (ie,
-     * this relation object was defined on get_this_model(), get_other_model() is the other one)
-     *
-     * @return EEM_Base
-     */
-    public function get_other_model()
-    {
-        return $this->_get_model($this->_other_model_name);
-    }
-
-
-    /**
-     * Internally used by get_this_model() and get_other_model()
-     *
-     * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-     * @return EEM_Base
-     */
-    protected function _get_model($model_name)
-    {
-        $modelInstance = EE_Registry::instance()->load_model($model_name);
-        $modelInstance->set_timezone($this->_timezone);
-        return $modelInstance;
-    }
-
-
-    /**
-     * entirely possible that relations may be called from a model and we need to make sure those relations have their
-     * timezone set correctly.
-     *
-     * @param string $timezone timezone to set.
-     */
-    public function set_timezone($timezone)
-    {
-        if ($timezone !== null) {
-            $this->_timezone = $timezone;
-        }
-    }
-
-
-    /**
-     * @param        $other_table
-     * @param        $other_table_alias
-     * @param        $other_table_column
-     * @param        $this_table_alias
-     * @param        $this_table_join_column
-     * @param string $extra_join_sql
-     * @return string
-     */
-    protected function _left_join(
-        $other_table,
-        $other_table_alias,
-        $other_table_column,
-        $this_table_alias,
-        $this_table_join_column,
-        $extra_join_sql = ''
-    ) {
-        return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
-    }
-
-
-    /**
-     * Gets all the model objects of type of other model related to $model_object,
-     * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
-     * For both of those child classes, $model_object must be saved so that it has an ID before querying,
-     * otherwise an error will be thrown. Note: by default we disable default_where_conditions
-     * EE_Belongs_To_Relation doesn't need to be saved before querying.
-     *
-     * @param EE_Base_Class|int $model_object_or_id                      or the primary key of this model
-     * @param array             $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        $query_params = array(),
-        $values_already_prepared_by_model_object = false
-    ) {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                esc_html__('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
-                '4.8.1'
-            );
-        }
-        $query_params                                      = $this->_disable_default_where_conditions_on_query_param($query_params);
-        $query_param_where_this_model_pk                   = $this->get_this_model()->get_this_model_name()
-                                                             . "."
-                                                             . $this->get_this_model()->get_primary_key_field()->get_name();
-        $model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
-        return $this->get_other_model()->get_all($query_params);
-    }
-
-
-    /**
-     * Alters the $query_params to disable default where conditions, unless otherwise specified
-     *
-     * @param string $query_params
-     * @return array
-     */
-    protected function _disable_default_where_conditions_on_query_param($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws \EE_Error
-     */
-    public function delete_all_related($model_object_or_id, $query_params = array())
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $related_model_object->delete();
-                $deleted_count++;
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws \EE_Error
-     */
-    public function delete_related_permanently($model_object_or_id, $query_params = array())
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $deleted_count++;
-                if (! $delete_is_blocked) {
-                    $related_model_object->delete_permanently();
-                } else {
-                    // delete is blocked
-                    // brent and darren, in this case, wanted to just soft delete it then
-                    $related_model_object->delete();
-                }
-            } else {
-                // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
-                    $this->remove_relation_to($model_object_or_id, $related_model_object);
-                    $related_model_object->delete();
-                    $deleted_count++;
-                }
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * this just returns a model_object_id for incoming item that could be an object or id.
-     *
-     * @param  EE_Base_Class|int $model_object_or_id model object or the primary key of this model
-     * @throws EE_Error
-     * @return int
-     */
-    protected function _get_model_object_id($model_object_or_id)
-    {
-        $model_object_id = $model_object_or_id;
-        if ($model_object_or_id instanceof EE_Base_Class) {
-            $model_object_id = $model_object_or_id->ID();
-        }
-        if (! $model_object_id) {
-            throw new EE_Error(sprintf(
-                esc_html__(
-                    "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
-                    "event_espresso"
-                ),
-                $this->get_other_model()->get_this_model_name(),
-                $this->get_this_model()->get_this_model_name()
-            ));
-        }
-        return $model_object_id;
-    }
-
-
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                other_model_primary_table.fk" etc
-     */
-    abstract public function get_join_statement($model_relation_chain);
-
-
-    /**
-     * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
-     * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
-     * relationship only allows this model to be related to a single other model of this type)
-     *
-     * @param       $this_obj_or_id
-     * @param       $other_obj_or_id
-     * @param array $extra_join_model_fields_n_values
-     * @return \EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
-     *                        $other_obj_or_id)
-     */
-    abstract public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        $extra_join_model_fields_n_values = array()
-    );
-
-
-    /**
-     * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
-     * model objects
-     *
-     * @param       $this_obj_or_id
-     * @param       $other_obj_or_id
-     * @param array $where_query
-     * @return bool
-     */
-    abstract public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array());
-
-
-    /**
-     * Removes ALL relation instances for this relation obj
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param array             $where_query_param @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function remove_relations($this_obj_or_id, $where_query_param = array())
-    {
-        $related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
-        $objs_removed   = array();
-        foreach ($related_things as $related_thing) {
-            $objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
-        }
-        return $objs_removed;
-    }
-
-
-    /**
-     * If you aren't allowed to delete this model when there are related models across this
-     * relation object, return true. Otherwise, if you can delete this model even though
-     * related objects exist, returns false.
-     *
-     * @return boolean
-     */
-    public function block_delete_if_related_models_exist()
-    {
-        return $this->_blocking_delete;
-    }
-
-
-    /**
-     * Gets the error message to show
-     *
-     * @return string
-     */
-    public function get_deletion_error_message()
-    {
-        if ($this->_blocking_delete_error_message) {
-            return $this->_blocking_delete_error_message;
-        } else {
+	/**
+	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private $_this_model_name;
+	/**
+	 * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private $_other_model_name;
+
+	/**
+	 * this is typically used when calling the relation models to make sure they inherit any set timezone from the
+	 * initiating model.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+	/**
+	 * If you try to delete "this_model", and there are related "other_models",
+	 * and this isn't null, then abandon the deletion and add this warning.
+	 * This effectively makes it impossible to delete "this_model" while there are
+	 * related "other_models" along this relation.
+	 *
+	 * @var string (internationalized)
+	 */
+	protected $_blocking_delete_error_message;
+
+	protected $_blocking_delete = false;
+
+	/**
+	 * Object representing the relationship between two models. This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param boolean $block_deletes                 if there are related models across this relation, block (prevent
+	 *                                               and add an error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($block_deletes, $blocking_delete_error_message)
+	{
+		$this->_blocking_delete               = $block_deletes;
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
+	}
+
+
+	/**
+	 * @param $this_model_name
+	 * @param $other_model_name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize_set_models($this_model_name, $other_model_name)
+	{
+		$this->_this_model_name  = $this_model_name;
+		$this->_other_model_name = $other_model_name;
+		if (is_string($this->_blocking_delete)) {
+			throw new EE_Error(sprintf(
+				esc_html__(
+					"When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)",
+					"event_espresso"
+				),
+				get_class($this),
+				$this_model_name,
+				$other_model_name,
+				$this->_blocking_delete
+			));
+		}
+	}
+
+
+	/**
+	 * Gets the model where this relation is defined.
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_this_model()
+	{
+		return $this->_get_model($this->_this_model_name);
+	}
+
+
+	/**
+	 * Gets the model which this relation establishes the relation TO (ie,
+	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_other_model()
+	{
+		return $this->_get_model($this->_other_model_name);
+	}
+
+
+	/**
+	 * Internally used by get_this_model() and get_other_model()
+	 *
+	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
+	 * @return EEM_Base
+	 */
+	protected function _get_model($model_name)
+	{
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		$modelInstance->set_timezone($this->_timezone);
+		return $modelInstance;
+	}
+
+
+	/**
+	 * entirely possible that relations may be called from a model and we need to make sure those relations have their
+	 * timezone set correctly.
+	 *
+	 * @param string $timezone timezone to set.
+	 */
+	public function set_timezone($timezone)
+	{
+		if ($timezone !== null) {
+			$this->_timezone = $timezone;
+		}
+	}
+
+
+	/**
+	 * @param        $other_table
+	 * @param        $other_table_alias
+	 * @param        $other_table_column
+	 * @param        $this_table_alias
+	 * @param        $this_table_join_column
+	 * @param string $extra_join_sql
+	 * @return string
+	 */
+	protected function _left_join(
+		$other_table,
+		$other_table_alias,
+		$other_table_column,
+		$this_table_alias,
+		$this_table_join_column,
+		$extra_join_sql = ''
+	) {
+		return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
+	}
+
+
+	/**
+	 * Gets all the model objects of type of other model related to $model_object,
+	 * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
+	 * For both of those child classes, $model_object must be saved so that it has an ID before querying,
+	 * otherwise an error will be thrown. Note: by default we disable default_where_conditions
+	 * EE_Belongs_To_Relation doesn't need to be saved before querying.
+	 *
+	 * @param EE_Base_Class|int $model_object_or_id                      or the primary key of this model
+	 * @param array             $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean           $values_already_prepared_by_model_object @deprecated since 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		$query_params = array(),
+		$values_already_prepared_by_model_object = false
+	) {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				esc_html__('The argument $values_already_prepared_by_model_object is no longer used.', 'event_espresso'),
+				'4.8.1'
+			);
+		}
+		$query_params                                      = $this->_disable_default_where_conditions_on_query_param($query_params);
+		$query_param_where_this_model_pk                   = $this->get_this_model()->get_this_model_name()
+															 . "."
+															 . $this->get_this_model()->get_primary_key_field()->get_name();
+		$model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
+		$query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+		return $this->get_other_model()->get_all($query_params);
+	}
+
+
+	/**
+	 * Alters the $query_params to disable default where conditions, unless otherwise specified
+	 *
+	 * @param string $query_params
+	 * @return array
+	 */
+	protected function _disable_default_where_conditions_on_query_param($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_all_related($model_object_or_id, $query_params = array())
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if (! $delete_is_blocked) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$related_model_object->delete();
+				$deleted_count++;
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws \EE_Error
+	 */
+	public function delete_related_permanently($model_object_or_id, $query_params = array())
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$deleted_count++;
+				if (! $delete_is_blocked) {
+					$related_model_object->delete_permanently();
+				} else {
+					// delete is blocked
+					// brent and darren, in this case, wanted to just soft delete it then
+					$related_model_object->delete();
+				}
+			} else {
+				// its not a soft-deletable thing anyways. do the normal logic.
+				if (! $delete_is_blocked) {
+					$this->remove_relation_to($model_object_or_id, $related_model_object);
+					$related_model_object->delete();
+					$deleted_count++;
+				}
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * this just returns a model_object_id for incoming item that could be an object or id.
+	 *
+	 * @param  EE_Base_Class|int $model_object_or_id model object or the primary key of this model
+	 * @throws EE_Error
+	 * @return int
+	 */
+	protected function _get_model_object_id($model_object_or_id)
+	{
+		$model_object_id = $model_object_or_id;
+		if ($model_object_or_id instanceof EE_Base_Class) {
+			$model_object_id = $model_object_or_id->ID();
+		}
+		if (! $model_object_id) {
+			throw new EE_Error(sprintf(
+				esc_html__(
+					"Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
+					"event_espresso"
+				),
+				$this->get_other_model()->get_this_model_name(),
+				$this->get_this_model()->get_this_model_name()
+			));
+		}
+		return $model_object_id;
+	}
+
+
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                other_model_primary_table.fk" etc
+	 */
+	abstract public function get_join_statement($model_relation_chain);
+
+
+	/**
+	 * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
+	 * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
+	 * relationship only allows this model to be related to a single other model of this type)
+	 *
+	 * @param       $this_obj_or_id
+	 * @param       $other_obj_or_id
+	 * @param array $extra_join_model_fields_n_values
+	 * @return \EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
+	 *                        $other_obj_or_id)
+	 */
+	abstract public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		$extra_join_model_fields_n_values = array()
+	);
+
+
+	/**
+	 * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
+	 * model objects
+	 *
+	 * @param       $this_obj_or_id
+	 * @param       $other_obj_or_id
+	 * @param array $where_query
+	 * @return bool
+	 */
+	abstract public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array());
+
+
+	/**
+	 * Removes ALL relation instances for this relation obj
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param array             $where_query_param @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function remove_relations($this_obj_or_id, $where_query_param = array())
+	{
+		$related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
+		$objs_removed   = array();
+		foreach ($related_things as $related_thing) {
+			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
+		}
+		return $objs_removed;
+	}
+
+
+	/**
+	 * If you aren't allowed to delete this model when there are related models across this
+	 * relation object, return true. Otherwise, if you can delete this model even though
+	 * related objects exist, returns false.
+	 *
+	 * @return boolean
+	 */
+	public function block_delete_if_related_models_exist()
+	{
+		return $this->_blocking_delete;
+	}
+
+
+	/**
+	 * Gets the error message to show
+	 *
+	 * @return string
+	 */
+	public function get_deletion_error_message()
+	{
+		if ($this->_blocking_delete_error_message) {
+			return $this->_blocking_delete_error_message;
+		} else {
 //          return sprintf(esc_html__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
-            return sprintf(
-                esc_html__(
-                    'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
-                    "event_espresso"
-                ),
-                $this->get_this_model()->item_name(1),
-                $this->get_other_model()->item_name(1),
-                $this->get_other_model()->item_name(2)
-            );
-        }
-    }
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     */
-    public function getSchemaDescription()
-    {
-        $description = $this instanceof EE_Belongs_To_Relation
-            ? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
-            : esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
-        return sprintf(
-            $description,
-            $this->get_other_model()->get_this_model_name(),
-            $this->get_this_model()->get_this_model_name()
-        );
-    }
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
-    }
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties()
-    {
-        return array();
-    }
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum()
-    {
-        return array();
-    }
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return string
-     */
-    public function getSchemaFormat()
-    {
-        return array();
-    }
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly()
-    {
-        return true;
-    }
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema()
-    {
-        $schema = array(
-            'description' => $this->getSchemaDescription(),
-            'type' => $this->getSchemaType(),
-            'relation' => true,
-            'relation_type' => get_class($this),
-            'readonly' => $this->getSchemaReadonly()
-        );
-
-        if ($this instanceof EE_HABTM_Relation) {
-            $schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
-        }
-
-        if ($this->getSchemaType() === 'array') {
-            $schema['items'] = array(
-                'type' => 'object'
-            );
-        }
-
-        return $schema;
-    }
+			return sprintf(
+				esc_html__(
+					'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
+					"event_espresso"
+				),
+				$this->get_this_model()->item_name(1),
+				$this->get_other_model()->item_name(1),
+				$this->get_other_model()->item_name(2)
+			);
+		}
+	}
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaDescription()
+	{
+		$description = $this instanceof EE_Belongs_To_Relation
+			? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
+			: esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
+		return sprintf(
+			$description,
+			$this->get_other_model()->get_this_model_name(),
+			$this->get_this_model()->get_this_model_name()
+		);
+	}
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
+	}
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties()
+	{
+		return array();
+	}
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum()
+	{
+		return array();
+	}
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaFormat()
+	{
+		return array();
+	}
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly()
+	{
+		return true;
+	}
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema()
+	{
+		$schema = array(
+			'description' => $this->getSchemaDescription(),
+			'type' => $this->getSchemaType(),
+			'relation' => true,
+			'relation_type' => get_class($this),
+			'readonly' => $this->getSchemaReadonly()
+		);
+
+		if ($this instanceof EE_HABTM_Relation) {
+			$schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
+		}
+
+		if ($this->getSchemaType() === 'array') {
+			$schema['items'] = array(
+				'type' => 'object'
+			);
+		}
+
+		return $schema;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -157,7 +157,7 @@ 
         $this_table_join_column,
         $extra_join_sql = ''
     ) {
-        return " LEFT JOIN " . $other_table . " AS " . $other_table_alias . " ON " . $other_table_alias . "." . $other_table_column . "=" . $this_table_alias . "." . $this_table_join_column . ($extra_join_sql ? " AND $extra_join_sql" : '');
+        return " LEFT JOIN ".$other_table." AS ".$other_table_alias." ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column.($extra_join_sql ? " AND $extra_join_sql" : '');
     }
 
 
@@ -191,7 +191,7 @@ 
                                                              . "."
                                                              . $this->get_this_model()->get_primary_key_field()->get_name();
         $model_object_id                                   = $this->_get_model_object_id($model_object_or_id);
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+        $query_params[0][$query_param_where_this_model_pk] = $model_object_id;
         return $this->get_other_model()->get_all($query_params);
     }
 
@@ -204,7 +204,7 @@ 
      */
     protected function _disable_default_where_conditions_on_query_param($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'none';
         }
         return $query_params;
@@ -234,7 +234,7 @@ 
                 $model_object_or_id
             );
             /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
+            if ( ! $delete_is_blocked) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $related_model_object->delete();
                 $deleted_count++;
@@ -270,7 +270,7 @@ 
             if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $deleted_count++;
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $related_model_object->delete_permanently();
                 } else {
                     // delete is blocked
@@ -279,7 +279,7 @@ 
                 }
             } else {
                 // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $this->remove_relation_to($model_object_or_id, $related_model_object);
                     $related_model_object->delete();
                     $deleted_count++;
@@ -303,7 +303,7 @@ 
         if ($model_object_or_id instanceof EE_Base_Class) {
             $model_object_id = $model_object_or_id->ID();
         }
-        if (! $model_object_id) {
+        if ( ! $model_object_id) {
             throw new EE_Error(sprintf(
                 esc_html__(
                     "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",

core/db_models/EEM_Price_Type.model.php

Spacing +5 added lines, -5 removed lines

@@ -42,7 +42,7 @@ 
      */
     public function get_base_type_name($base_type_int)
     {
-        return $this->base_types[ $base_type_int ];
+        return $this->base_types[$base_type_int];
     }
 
     /**
@@ -95,7 +95,7 @@ 
             '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] = new EE_Restriction_Generator_Public();
         // all price types are "default" in terms of capability names
         $this->_caps_slug = 'default_price_types';
         parent::__construct($timezone);
@@ -142,15 +142,15 @@ 
         $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
         $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+        $ID = $query_params[0][$this->get_primary_key_field()->get_name()];
 
         // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID' => array('IN',$would_be_deleted_price_type_ids)));
+        $prc_query_params = array(array('PRT_ID' => array('IN', $would_be_deleted_price_type_ids)));
         if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
             $prices_names_and_ids = array();
             foreach ($prices as $price) {
                 /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
+                $prices_names_and_ids[] = $price->name()."(".$price->ID().")";
             }
             $msg = sprintf(esc_html__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);

Indentation +124 added lines, -124 removed lines

@@ -11,142 +11,142 @@
  */
 class EEM_Price_Type extends EEM_Soft_Delete_Base
 {
-    // private instance of the Price Type object
-    protected static $_instance = null;
-    // An array of the price type objects
-    public $type = null;
+	// private instance of the Price Type object
+	protected static $_instance = null;
+	// An array of the price type objects
+	public $type = null;
 
-    /**
-    *   Price Base types
-    *
-    *   @access private
-    *   @var int
-    */
-    public $base_types = null;
+	/**
+	 *   Price Base types
+	 *
+	 *   @access private
+	 *   @var int
+	 */
+	public $base_types = null;
 
-    /**
-     * return an array of Base types. Keys are INTs which are used in the database,
-     * values are text-representations of the base type.
-     * @return array
-     */
-    public function get_base_types()
-    {
-        return $this->base_types;
-    }
+	/**
+	 * return an array of Base types. Keys are INTs which are used in the database,
+	 * values are text-representations of the base type.
+	 * @return array
+	 */
+	public function get_base_types()
+	{
+		return $this->base_types;
+	}
 
-    /**
-     * Gets the name of the base
-     * @param type $base_type_int
-     * @return type
-     */
-    public function get_base_type_name($base_type_int)
-    {
-        return $this->base_types[ $base_type_int ];
-    }
+	/**
+	 * Gets the name of the base
+	 * @param type $base_type_int
+	 * @return type
+	 */
+	public function get_base_type_name($base_type_int)
+	{
+		return $this->base_types[ $base_type_int ];
+	}
 
-    /**
-     * constants for price base types. In the DB, we decided to store the price base type
-     * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
-     * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
-     * So, as an example, to query for all price types that are a tax, we'd do
-     * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
-     * instead of
-     * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
-     * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
-     * change, we can continue to use the constant, by simply change its value.
-     */
-    const base_type_base_price = 1;
-    const base_type_discount = 2;
-    const base_type_surcharge = 3;
-    const base_type_tax = 4;
-    /**
-     *      private constructor to prevent direct creation
-     *      @Constructor
-     *      @access protected
-     *      @return void
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->base_types = array(
-            EEM_Price_Type::base_type_base_price => esc_html__('Price', 'event_espresso'),
-            EEM_Price_Type::base_type_discount => esc_html__('Discount', 'event_espresso'),
-            EEM_Price_Type::base_type_surcharge => esc_html__('Surcharge', 'event_espresso'),
-            EEM_Price_Type::base_type_tax => esc_html__('Tax', 'event_espresso') );
-        $this->singular_item = esc_html__('Price Type', 'event_espresso');
-        $this->plural_item = esc_html__('Price Types', 'event_espresso');
+	/**
+	 * constants for price base types. In the DB, we decided to store the price base type
+	 * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
+	 * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
+	 * So, as an example, to query for all price types that are a tax, we'd do
+	 * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
+	 * instead of
+	 * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
+	 * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
+	 * change, we can continue to use the constant, by simply change its value.
+	 */
+	const base_type_base_price = 1;
+	const base_type_discount = 2;
+	const base_type_surcharge = 3;
+	const base_type_tax = 4;
+	/**
+	 *      private constructor to prevent direct creation
+	 *      @Constructor
+	 *      @access protected
+	 *      @return void
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->base_types = array(
+			EEM_Price_Type::base_type_base_price => esc_html__('Price', 'event_espresso'),
+			EEM_Price_Type::base_type_discount => esc_html__('Discount', 'event_espresso'),
+			EEM_Price_Type::base_type_surcharge => esc_html__('Surcharge', 'event_espresso'),
+			EEM_Price_Type::base_type_tax => esc_html__('Tax', 'event_espresso') );
+		$this->singular_item = esc_html__('Price Type', 'event_espresso');
+		$this->plural_item = esc_html__('Price Types', 'event_espresso');
 
-        $this->_tables = array(
-            'Price_Type' => new EE_Primary_Table('esp_price_type', 'PRT_ID')
-        );
-        $this->_fields = array(
-            'Price_Type' => array(
-                'PRT_ID' => new EE_Primary_Key_Int_Field('PRT_ID', esc_html__('Price Type ID', 'event_espresso')),
-                'PRT_name' => new EE_Plain_Text_Field('PRT_name', esc_html__('Price Type Name', 'event_espresso'), false, ''),
-                'PBT_ID' => new EE_Enum_Integer_Field('PBT_ID', esc_html__('Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax', 'event_espresso'), false, EEM_Price_Type::base_type_base_price, $this->base_types),
-                'PRT_is_percent' => new EE_Boolean_Field('PRT_is_percent', esc_html__('Flag indicating price is a percentage', 'event_espresso'), false, false),
-                'PRT_order' => new EE_Integer_Field('PRT_order', esc_html__('Order in which price should be applied. ', 'event_espresso'), false, 0),
-                'PRT_deleted' => new EE_Trashed_Flag_Field('PRT_deleted', esc_html__('Flag indicating price type has been trashed', 'event_espresso'), false, false),
-                'PRT_wp_user' => new EE_WP_User_Field('PRT_wp_user', esc_html__('Price Type Creator ID', 'event_espresso'), false),
-            )
-        );
-        $this->_model_relations = array(
-            'Price' => 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();
-        // all price types are "default" in terms of capability names
-        $this->_caps_slug = 'default_price_types';
-        parent::__construct($timezone);
-    }
+		$this->_tables = array(
+			'Price_Type' => new EE_Primary_Table('esp_price_type', 'PRT_ID')
+		);
+		$this->_fields = array(
+			'Price_Type' => array(
+				'PRT_ID' => new EE_Primary_Key_Int_Field('PRT_ID', esc_html__('Price Type ID', 'event_espresso')),
+				'PRT_name' => new EE_Plain_Text_Field('PRT_name', esc_html__('Price Type Name', 'event_espresso'), false, ''),
+				'PBT_ID' => new EE_Enum_Integer_Field('PBT_ID', esc_html__('Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax', 'event_espresso'), false, EEM_Price_Type::base_type_base_price, $this->base_types),
+				'PRT_is_percent' => new EE_Boolean_Field('PRT_is_percent', esc_html__('Flag indicating price is a percentage', 'event_espresso'), false, false),
+				'PRT_order' => new EE_Integer_Field('PRT_order', esc_html__('Order in which price should be applied. ', 'event_espresso'), false, 0),
+				'PRT_deleted' => new EE_Trashed_Flag_Field('PRT_deleted', esc_html__('Flag indicating price type has been trashed', 'event_espresso'), false, false),
+				'PRT_wp_user' => new EE_WP_User_Field('PRT_wp_user', esc_html__('Price Type Creator ID', 'event_espresso'), false),
+			)
+		);
+		$this->_model_relations = array(
+			'Price' => 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();
+		// all price types are "default" in terms of capability names
+		$this->_caps_slug = 'default_price_types';
+		parent::__construct($timezone);
+	}
 
 
 
 
-    /**
-     *      instantiate a new price type object with blank/empty properties
-     *
-     *      @access     public
-     *      @return     mixed       array on success, FALSE on fail
-     */
-    public function get_new_price_type()
-    {
-        return EE_Price_Type::new_instance();
-    }
+	/**
+	 *      instantiate a new price type object with blank/empty properties
+	 *
+	 *      @access     public
+	 *      @return     mixed       array on success, FALSE on fail
+	 */
+	public function get_new_price_type()
+	{
+		return EE_Price_Type::new_instance();
+	}
 
 
-    /**
-     *
-     * @param array   $query_params
-     * @param bool    $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data);
-     *                                if false, deletes regardless of other objects which may depend on it.
-     *                                Its generally advisable to always leave this as TRUE,
-     *                                otherwise you could easily corrupt your DB
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
-        $would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
-        $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
+	/**
+	 *
+	 * @param array   $query_params
+	 * @param bool    $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data);
+	 *                                if false, deletes regardless of other objects which may depend on it.
+	 *                                Its generally advisable to always leave this as TRUE,
+	 *                                otherwise you could easily corrupt your DB
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
+		$would_be_deleted_price_types = $this->get_all_deleted_and_undeleted($query_params);
+		$would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+		$ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
 
-        // check if any prices use this price type
-        $prc_query_params = array(array('PRT_ID' => array('IN',$would_be_deleted_price_type_ids)));
-        if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
-            $prices_names_and_ids = array();
-            foreach ($prices as $price) {
-                /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
-            }
-            $msg = sprintf(esc_html__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
+		// check if any prices use this price type
+		$prc_query_params = array(array('PRT_ID' => array('IN',$would_be_deleted_price_type_ids)));
+		if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
+			$prices_names_and_ids = array();
+			foreach ($prices as $price) {
+				/* @var $price EE_Price */
+				$prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
+			}
+			$msg = sprintf(esc_html__('The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s', 'event_espresso'), implode(",", $prices_names_and_ids));
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
 
-        return parent::delete_permanently($query_params);
-    }
+		return parent::delete_permanently($query_params);
+	}
 }

core/db_models/EEM_Status.model.php

Spacing +9 added lines, -9 removed lines

@@ -35,7 +35,7 @@ 
                     false,
                     'event',
                     array(
-                        'event'        => esc_html__("Event", "event_espresso"),// deprecated
+                        'event'        => esc_html__("Event", "event_espresso"), // deprecated
                         'registration' => esc_html__("Registration", "event_espresso"),
                         'transaction'  => esc_html__("Transaction", "event_espresso"),
                         'payment'      => esc_html__("Payment", "event_espresso"),
@@ -54,7 +54,7 @@ 
             'Payment'      => 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();
 
         parent::__construct($timezone);
     }
@@ -267,7 +267,7 @@ 
 
         $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if (! is_array($statuses)) {
+        if ( ! is_array($statuses)) {
             throw new EE_Error(esc_html__(
                 'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
                 'event_espresso'
@@ -277,22 +277,22 @@ 
         $translation = array();
 
         foreach ($statuses as $id => $code) {
-            if (isset($translation_array[ $id ])) {
-                $translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
+            if (isset($translation_array[$id])) {
+                $translation[$id] = $plural ? $translation_array[$id][1] : $translation_array[$id][0];
             } else {
-                $translation[ $id ] = $code;
+                $translation[$id] = $code;
             }
 
             // schema
             switch ($schema) {
                 case 'lower':
-                    $translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
+                    $translation[$id] = strtolower($translation[$id]); // even though these start in lower case, this will catch any statuses added via filter.
                     break;
                 case 'sentence':
-                    $translation[ $id ] = ucwords($translation[ $id ]);
+                    $translation[$id] = ucwords($translation[$id]);
                     break;
                 case 'upper':
-                    $translation[ $id ] = strtoupper($translation[ $id ]);
+                    $translation[$id] = strtoupper($translation[$id]);
                     break;
             }
         }

Indentation +277 added lines, -277 removed lines

@@ -10,292 +10,292 @@
  */
 class EEM_Status extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @return EEM_Status
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item    = esc_html__('Status', 'event_espresso');
-        $this->plural_item      = esc_html__('Stati', 'event_espresso');
-        $this->_tables          = array(
-            'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
-        );
-        $this->_fields          = array(
-            'StatusTable' => array(
-                'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso')),
-                'STS_code'     => new EE_Plain_Text_Field('STS_code', esc_html__('Status Code', 'event_espresso'), false, ''),
-                'STS_type'     => new EE_Enum_Text_Field(
-                    'STS_type',
-                    esc_html__("Type", "event_espresso"),
-                    false,
-                    'event',
-                    array(
-                        'event'        => esc_html__("Event", "event_espresso"),// deprecated
-                        'registration' => esc_html__("Registration", "event_espresso"),
-                        'transaction'  => esc_html__("Transaction", "event_espresso"),
-                        'payment'      => esc_html__("Payment", "event_espresso"),
-                        'email'        => esc_html__("Email", "event_espresso"),
-                        'message'      => esc_html__("Message", "event_espresso"),
-                    )
-                ),
-                'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', esc_html__('Editable?', 'event_espresso'), false, false),
-                'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', esc_html__("Description", "event_espresso"), false, ''),
-                'STS_open'     => new EE_Boolean_Field('STS_open', esc_html__("Open?", "event_espresso"), false, false),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration' => new EE_Has_Many_Relation(),
-            'Transaction'  => new EE_Has_Many_Relation(),
-            'Payment'      => 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();
+	/**
+	 * @return EEM_Status
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item    = esc_html__('Status', 'event_espresso');
+		$this->plural_item      = esc_html__('Stati', 'event_espresso');
+		$this->_tables          = array(
+			'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
+		);
+		$this->_fields          = array(
+			'StatusTable' => array(
+				'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso')),
+				'STS_code'     => new EE_Plain_Text_Field('STS_code', esc_html__('Status Code', 'event_espresso'), false, ''),
+				'STS_type'     => new EE_Enum_Text_Field(
+					'STS_type',
+					esc_html__("Type", "event_espresso"),
+					false,
+					'event',
+					array(
+						'event'        => esc_html__("Event", "event_espresso"),// deprecated
+						'registration' => esc_html__("Registration", "event_espresso"),
+						'transaction'  => esc_html__("Transaction", "event_espresso"),
+						'payment'      => esc_html__("Payment", "event_espresso"),
+						'email'        => esc_html__("Email", "event_espresso"),
+						'message'      => esc_html__("Message", "event_espresso"),
+					)
+				),
+				'STS_can_edit' => new EE_Boolean_Field('STS_can_edit', esc_html__('Editable?', 'event_espresso'), false, false),
+				'STS_desc'     => new EE_Simple_HTML_Field('STS_desc', esc_html__("Description", "event_espresso"), false, ''),
+				'STS_open'     => new EE_Boolean_Field('STS_open', esc_html__("Open?", "event_espresso"), false, false),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration' => new EE_Has_Many_Relation(),
+			'Transaction'  => new EE_Has_Many_Relation(),
+			'Payment'      => 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();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * This method provides the localized singular or plural string for a given status id
-     *
-     * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
-     *                           That way if there isn't a translation in the index we'll return the default code.
-     * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
-     *                           same as the singular (in English), however, this may NOT be the case with other
-     *                           languages
-     * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
-     *                           the status string returned ( UPPER, lower, Sentence)
-     * @throws EE_Error
-     * @return array             an array of translated strings for the incoming status id.
-     */
-    public function localized_status($statuses, $plural = false, $schema = 'upper')
-    {
-        // note these are all in lower case because ucwords() on upper case will NOT convert.
-        $translation_array = array(
-            EEM_Registration::status_id_pending_payment => array(
-                esc_html__('pending payment', 'event_espresso'), // singular
-                esc_html__('pending payments', 'event_espresso') // plural
-            ),
-            EEM_Registration::status_id_approved        => array(
-                esc_html__('approved', 'event_espresso'), // singular
-                esc_html__('approved', 'event_espresso') // plural
-            ),
-            EEM_Registration::status_id_not_approved    => array(
-                esc_html__('not approved', 'event_espresso'),
-                esc_html__('not approved', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_cancelled       => array(
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_incomplete      => array(
-                esc_html__('incomplete', 'event_espresso'),
-                esc_html__('incomplete', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_declined        => array(
-                esc_html__('declined', 'event_espresso'),
-                esc_html__('declined', 'event_espresso'),
-            ),
-            EEM_Registration::status_id_wait_list       => array(
-                esc_html__('wait list', 'event_espresso'),
-                esc_html__('wait list', 'event_espresso'),
-            ),
-            EEM_Transaction::overpaid_status_code       => array(
-                esc_html__('overpaid', 'event_espresso'),
-                esc_html__('overpaid', 'event_espresso'),
-            ),
-            EEM_Transaction::complete_status_code       => array(
-                esc_html__('complete', 'event_espresso'),
-                esc_html__('complete', 'event_espresso'),
-            ),
-            EEM_Transaction::incomplete_status_code     => array(
-                esc_html__('incomplete', 'event_espresso'),
-                esc_html__('incomplete', 'event_espresso'),
-            ),
-            EEM_Transaction::failed_status_code         => array(
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ),
-            EEM_Transaction::abandoned_status_code      => array(
-                esc_html__('abandoned', 'event_espresso'),
-                esc_html__('abandoned', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_approved             => array(
-                esc_html__('accepted', 'event_espresso'),
-                esc_html__('accepted', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_pending              => array(
-                esc_html__('pending', 'event_espresso'),
-                esc_html__('pending', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_cancelled            => array(
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_declined             => array(
-                esc_html__('declined', 'event_espresso'),
-                esc_html__('declined', 'event_espresso'),
-            ),
-            EEM_Payment::status_id_failed               => array(
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ),
-            // following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
-            EEM_Event::sold_out                         => array(
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ),
-            EEM_Event::postponed                        => array(
-                esc_html__('postponed', 'event_espresso'),
-                esc_html__('Postponed', 'event_espresso'),
-            ),
-            EEM_Event::cancelled                        => array(
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ),
-            EE_Ticket::archived                         => array(
-                esc_html__('archived', 'event_espresso'),
-                esc_html__('archived', 'event_espresso'),
-            ),
-            EE_Ticket::expired                          => array(
-                esc_html__('expired', 'event_espresso'),
-                esc_html__('expired', 'event_espresso'),
-            ),
-            EE_Ticket::sold_out                         => array(
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ),
-            EE_Ticket::pending                          => array(
-                esc_html__('upcoming', 'event_espresso'),
-                esc_html__('upcoming', 'event_espresso'),
-            ),
-            EE_Ticket::onsale                           => array(
-                esc_html__('on sale', 'event_espresso'),
-                esc_html__('on sale', 'event_espresso'),
-            ),
-            EE_Datetime::cancelled                      => array(
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ),
-            EE_Datetime::sold_out                       => array(
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ),
-            EE_Datetime::expired                        => array(
-                esc_html__('expired', 'event_espresso'),
-                esc_html__('expired', 'event_espresso'),
-            ),
-            EE_Datetime::inactive                       => array(
-                esc_html__('inactive', 'event_espresso'),
-                esc_html__('inactive', 'event_espresso'),
-            ),
-            EE_Datetime::upcoming                       => array(
-                esc_html__('upcoming', 'event_espresso'),
-                esc_html__('upcoming', 'event_espresso'),
-            ),
-            EE_Datetime::active                         => array(
-                esc_html__('active', 'event_espresso'),
-                esc_html__('active', 'event_espresso'),
-            ),
-            EE_Datetime::postponed                      => array(
-                esc_html__('postponed', 'event_espresso'),
-                esc_html__('postponed', 'event_espresso'),
-            ),
-            // messages related
-            EEM_Message::status_sent                    => array(
-                esc_html__('sent', 'event_espresso'),
-                esc_html__('sent', 'event_espresso'),
-            ),
-            EEM_Message::status_idle                    => array(
-                esc_html__('queued for sending', 'event_espresso'),
-                esc_html__('queued for sending', 'event_espresso'),
-            ),
-            EEM_Message::status_failed                  => array(
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ),
-            EEM_Message::status_debug_only              => array(
-                esc_html__('debug only', 'event_espresso'),
-                esc_html__('debug only', 'event_espresso'),
-            ),
-            EEM_Message::status_messenger_executing     => array(
-                esc_html__('messenger is executing', 'event_espresso'),
-                esc_html__('messenger is executing', 'event_espresso'),
-            ),
-            EEM_Message::status_resend                  => array(
-                esc_html__('queued for resending', 'event_espresso'),
-                esc_html__('queued for resending', 'event_espresso'),
-            ),
-            EEM_Message::status_incomplete              => array(
-                esc_html__('queued for generating', 'event_espresso'),
-                esc_html__('queued for generating', 'event_espresso'),
-            ),
-            EEM_Message::status_retry                   => array(
-                esc_html__('failed sending, can be retried', 'event_espresso'),
-                esc_html__('failed sending, can be retried', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_publish           => array(
-                esc_html__('published', 'event_espresso'),
-                esc_html__('published', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_future            => array(
-                esc_html__('scheduled', 'event_espresso'),
-                esc_html__('scheduled', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_draft             => array(
-                esc_html__('draft', 'event_espresso'),
-                esc_html__('draft', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_pending           => array(
-                esc_html__('pending', 'event_espresso'),
-                esc_html__('pending', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_private           => array(
-                esc_html__('private', 'event_espresso'),
-                esc_html__('private', 'event_espresso'),
-            ),
-            EEM_CPT_Base::post_status_trashed           => array(
-                esc_html__('trashed', 'event_espresso'),
-                esc_html__('trashed', 'event_espresso'),
-            ),
-        );
+	/**
+	 * This method provides the localized singular or plural string for a given status id
+	 *
+	 * @param  array   $statuses This should be an array of statuses in the format array( $status_id, $status_code ).
+	 *                           That way if there isn't a translation in the index we'll return the default code.
+	 * @param  boolean $plural   Whether to return plural string or not. Note, nearly all of the plural strings are the
+	 *                           same as the singular (in English), however, this may NOT be the case with other
+	 *                           languages
+	 * @param  string  $schema   This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
+	 *                           the status string returned ( UPPER, lower, Sentence)
+	 * @throws EE_Error
+	 * @return array             an array of translated strings for the incoming status id.
+	 */
+	public function localized_status($statuses, $plural = false, $schema = 'upper')
+	{
+		// note these are all in lower case because ucwords() on upper case will NOT convert.
+		$translation_array = array(
+			EEM_Registration::status_id_pending_payment => array(
+				esc_html__('pending payment', 'event_espresso'), // singular
+				esc_html__('pending payments', 'event_espresso') // plural
+			),
+			EEM_Registration::status_id_approved        => array(
+				esc_html__('approved', 'event_espresso'), // singular
+				esc_html__('approved', 'event_espresso') // plural
+			),
+			EEM_Registration::status_id_not_approved    => array(
+				esc_html__('not approved', 'event_espresso'),
+				esc_html__('not approved', 'event_espresso'),
+			),
+			EEM_Registration::status_id_cancelled       => array(
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			),
+			EEM_Registration::status_id_incomplete      => array(
+				esc_html__('incomplete', 'event_espresso'),
+				esc_html__('incomplete', 'event_espresso'),
+			),
+			EEM_Registration::status_id_declined        => array(
+				esc_html__('declined', 'event_espresso'),
+				esc_html__('declined', 'event_espresso'),
+			),
+			EEM_Registration::status_id_wait_list       => array(
+				esc_html__('wait list', 'event_espresso'),
+				esc_html__('wait list', 'event_espresso'),
+			),
+			EEM_Transaction::overpaid_status_code       => array(
+				esc_html__('overpaid', 'event_espresso'),
+				esc_html__('overpaid', 'event_espresso'),
+			),
+			EEM_Transaction::complete_status_code       => array(
+				esc_html__('complete', 'event_espresso'),
+				esc_html__('complete', 'event_espresso'),
+			),
+			EEM_Transaction::incomplete_status_code     => array(
+				esc_html__('incomplete', 'event_espresso'),
+				esc_html__('incomplete', 'event_espresso'),
+			),
+			EEM_Transaction::failed_status_code         => array(
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			),
+			EEM_Transaction::abandoned_status_code      => array(
+				esc_html__('abandoned', 'event_espresso'),
+				esc_html__('abandoned', 'event_espresso'),
+			),
+			EEM_Payment::status_id_approved             => array(
+				esc_html__('accepted', 'event_espresso'),
+				esc_html__('accepted', 'event_espresso'),
+			),
+			EEM_Payment::status_id_pending              => array(
+				esc_html__('pending', 'event_espresso'),
+				esc_html__('pending', 'event_espresso'),
+			),
+			EEM_Payment::status_id_cancelled            => array(
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			),
+			EEM_Payment::status_id_declined             => array(
+				esc_html__('declined', 'event_espresso'),
+				esc_html__('declined', 'event_espresso'),
+			),
+			EEM_Payment::status_id_failed               => array(
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			),
+			// following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
+			EEM_Event::sold_out                         => array(
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			),
+			EEM_Event::postponed                        => array(
+				esc_html__('postponed', 'event_espresso'),
+				esc_html__('Postponed', 'event_espresso'),
+			),
+			EEM_Event::cancelled                        => array(
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			),
+			EE_Ticket::archived                         => array(
+				esc_html__('archived', 'event_espresso'),
+				esc_html__('archived', 'event_espresso'),
+			),
+			EE_Ticket::expired                          => array(
+				esc_html__('expired', 'event_espresso'),
+				esc_html__('expired', 'event_espresso'),
+			),
+			EE_Ticket::sold_out                         => array(
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			),
+			EE_Ticket::pending                          => array(
+				esc_html__('upcoming', 'event_espresso'),
+				esc_html__('upcoming', 'event_espresso'),
+			),
+			EE_Ticket::onsale                           => array(
+				esc_html__('on sale', 'event_espresso'),
+				esc_html__('on sale', 'event_espresso'),
+			),
+			EE_Datetime::cancelled                      => array(
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			),
+			EE_Datetime::sold_out                       => array(
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			),
+			EE_Datetime::expired                        => array(
+				esc_html__('expired', 'event_espresso'),
+				esc_html__('expired', 'event_espresso'),
+			),
+			EE_Datetime::inactive                       => array(
+				esc_html__('inactive', 'event_espresso'),
+				esc_html__('inactive', 'event_espresso'),
+			),
+			EE_Datetime::upcoming                       => array(
+				esc_html__('upcoming', 'event_espresso'),
+				esc_html__('upcoming', 'event_espresso'),
+			),
+			EE_Datetime::active                         => array(
+				esc_html__('active', 'event_espresso'),
+				esc_html__('active', 'event_espresso'),
+			),
+			EE_Datetime::postponed                      => array(
+				esc_html__('postponed', 'event_espresso'),
+				esc_html__('postponed', 'event_espresso'),
+			),
+			// messages related
+			EEM_Message::status_sent                    => array(
+				esc_html__('sent', 'event_espresso'),
+				esc_html__('sent', 'event_espresso'),
+			),
+			EEM_Message::status_idle                    => array(
+				esc_html__('queued for sending', 'event_espresso'),
+				esc_html__('queued for sending', 'event_espresso'),
+			),
+			EEM_Message::status_failed                  => array(
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			),
+			EEM_Message::status_debug_only              => array(
+				esc_html__('debug only', 'event_espresso'),
+				esc_html__('debug only', 'event_espresso'),
+			),
+			EEM_Message::status_messenger_executing     => array(
+				esc_html__('messenger is executing', 'event_espresso'),
+				esc_html__('messenger is executing', 'event_espresso'),
+			),
+			EEM_Message::status_resend                  => array(
+				esc_html__('queued for resending', 'event_espresso'),
+				esc_html__('queued for resending', 'event_espresso'),
+			),
+			EEM_Message::status_incomplete              => array(
+				esc_html__('queued for generating', 'event_espresso'),
+				esc_html__('queued for generating', 'event_espresso'),
+			),
+			EEM_Message::status_retry                   => array(
+				esc_html__('failed sending, can be retried', 'event_espresso'),
+				esc_html__('failed sending, can be retried', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_publish           => array(
+				esc_html__('published', 'event_espresso'),
+				esc_html__('published', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_future            => array(
+				esc_html__('scheduled', 'event_espresso'),
+				esc_html__('scheduled', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_draft             => array(
+				esc_html__('draft', 'event_espresso'),
+				esc_html__('draft', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_pending           => array(
+				esc_html__('pending', 'event_espresso'),
+				esc_html__('pending', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_private           => array(
+				esc_html__('private', 'event_espresso'),
+				esc_html__('private', 'event_espresso'),
+			),
+			EEM_CPT_Base::post_status_trashed           => array(
+				esc_html__('trashed', 'event_espresso'),
+				esc_html__('trashed', 'event_espresso'),
+			),
+		);
 
-        $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
+		$translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if (! is_array($statuses)) {
-            throw new EE_Error(esc_html__(
-                'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
-                'event_espresso'
-            ));
-        }
+		if (! is_array($statuses)) {
+			throw new EE_Error(esc_html__(
+				'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
+				'event_espresso'
+			));
+		}
 
-        $translation = array();
+		$translation = array();
 
-        foreach ($statuses as $id => $code) {
-            if (isset($translation_array[ $id ])) {
-                $translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
-            } else {
-                $translation[ $id ] = $code;
-            }
+		foreach ($statuses as $id => $code) {
+			if (isset($translation_array[ $id ])) {
+				$translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
+			} else {
+				$translation[ $id ] = $code;
+			}
 
-            // schema
-            switch ($schema) {
-                case 'lower':
-                    $translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
-                    break;
-                case 'sentence':
-                    $translation[ $id ] = ucwords($translation[ $id ]);
-                    break;
-                case 'upper':
-                    $translation[ $id ] = strtoupper($translation[ $id ]);
-                    break;
-            }
-        }
+			// schema
+			switch ($schema) {
+				case 'lower':
+					$translation[ $id ] = strtolower($translation[ $id ]); // even though these start in lower case, this will catch any statuses added via filter.
+					break;
+				case 'sentence':
+					$translation[ $id ] = ucwords($translation[ $id ]);
+					break;
+				case 'upper':
+					$translation[ $id ] = strtoupper($translation[ $id ]);
+					break;
+			}
+		}
 
-        return $translation;
-    }
+		return $translation;
+	}
 }

core/db_models/EEM_Message_Template_Group.model.php

Spacing +22 added lines, -22 removed lines

@@ -48,7 +48,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation()
         );
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_Global('MTP_is_global');
         }
         $this->_caps_slug = 'messages';
 
@@ -75,7 +75,7 @@ 
         $limit = null,
         $count = false
     ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit);
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
 
@@ -93,7 +93,7 @@ 
     public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
     {
         return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+            array(array('MTP_messenger' => $messenger), 'order_by' => array($orderby => $order))
         );
     }
 
@@ -145,7 +145,7 @@ 
         $global = true,
         $user_check = false
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
@@ -160,7 +160,7 @@ 
             $_where['MTP_user_id'] = get_current_user_id();
         }
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -181,7 +181,7 @@ 
     {
         $_where = $this->_maybe_mtp_filters();
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         $r_templates = $count
             ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
@@ -201,9 +201,9 @@ 
      */
     public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
     {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+        $where = array_merge($query_params, array('Event.EVT_ID' => $EVT_ID));
         return $this->get_all(
-            array( $where )
+            array($where)
         );
     }
 
@@ -228,11 +228,11 @@ 
         $count = false,
         $global = true
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
@@ -270,7 +270,7 @@ 
             'MTP_is_active' => $active
         );
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -310,7 +310,7 @@ 
             $_where['MTP_is_active'] = $active;
         }
 
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -368,19 +368,19 @@ 
             // first let's figure out if the value['content'] in the current index is an array.
             //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
             if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
+                $assembled_fields[$value['name']] = $value['content']['main'];
                 // loop through the content and get the other fields.
                 foreach ($value['content'] as $name => $val) {
                     if ($name == 'main') {
                         continue;
                     }
-                    $assembled_fields[ $name ] = $val;
+                    $assembled_fields[$name] = $val;
                 }
                 continue;
             }
 
             // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
+            $assembled_fields[$value['name']] = $value['content'];
         }
 
         // now we've got the assembled_fields.
@@ -390,9 +390,9 @@ 
         $mt_ref = ucwords(str_replace('_', ' ', $message_type));
         $mt_ref = str_replace(' ', '_', $mt_ref);
 
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+        $classname = 'EE_Messages_'.$m_ref.'_'.$mt_ref.'_Validator';
 
-        if (!class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 esc_html__(
@@ -430,12 +430,12 @@ 
         if (empty($messenger_names) && empty($message_type_names)) {
             return 0;
         }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+        if ( ! empty($messenger_names)) {
+            $query_args[0]['MTP_messenger'] = array('IN', (array) $messenger_names);
         }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+        if ( ! empty($message_type_names)) {
+            $query_args[0]['MTP_message_type'] = array('IN', (array) $message_type_names);
         }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
+        return $this->update(array('MTP_is_active' => false), $query_args);
     }
 }

Indentation +423 added lines, -423 removed lines

@@ -14,427 +14,427 @@
  */
 class EEM_Message_Template_Group extends EEM_Soft_Delete_Base
 {
-    // private instance of the EEM_Message_Template_Group object
-    protected static $_instance = null;
-
-
-
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Message Template Group', 'event_espresso');
-        $this->plural_item = esc_html__('Message Template Groups', 'event_espresso');
-        $this->_tables = array(
-            'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID')
-        );
-        $this->_fields = array(
-            'Message_Template_Group' => array(
-                'GRP_ID' => new EE_Primary_Key_Int_Field('GRP_ID', esc_html__('Message Template Group ID', 'event_espresso')),
-                'MTP_name' => new EE_Plain_Text_Field('MTP_name', esc_html__('The name of the template group', 'event_espresso'), false, ''),
-                'MTP_description' => new EE_Simple_HTML_Field('MTP_description', esc_html__('A brief description about this template.', 'event_espresso'), false, ''),
-                'MTP_user_id' => new EE_WP_User_Field('MTP_user_id', esc_html__('Template Creator ID', 'event_espresso'), false, get_current_user_id()),
-                'MTP_messenger' => new EE_Plain_Text_Field('MTP_messenger', esc_html__('Messenger Used for Template', 'event_espresso'), false, 'email'),
-                'MTP_message_type' => new EE_Plain_Text_Field('MTP_message_type', esc_html__('Message Type', 'event_espresso'), false, 'registration'),
-                'MTP_is_global' => new EE_Boolean_Field('MTP_is_global', esc_html__('Flag indicating if Template Group is Global', 'event_espresso'), false, true),
-                'MTP_is_override' => new EE_Boolean_Field('MTP_is_override', esc_html__('Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination', 'event_espresso'), false, false),
-                'MTP_deleted' => new EE_Trashed_Flag_Field('MTP_deleted', esc_html__('Flag indicating whether this has been trashed', 'event_espresso'), false, false),
-                'MTP_is_active' => new EE_Boolean_Field('MTP_is_active', esc_html__('Flag indicating whether template group is active', 'event_espresso'), false, true)
-            )
-        );
-        $this->_model_relations = array(
-            'Message_Template' => new EE_Has_Many_Relation(),
-            'Message' => new EE_Has_Many_Relation(),
-            'Event' => new EE_HABTM_Relation('Event_Message_Template'),
-            'WP_User' => new EE_Belongs_To_Relation()
-        );
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
-        }
-        $this->_caps_slug = 'messages';
-
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * get_all_trashed_message_templates_by_event
-     *
-     * @access public
-     * @param int    $EVT_ID specific event id
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return array message template objects that are attached to a specific event.
-     */
-    public function get_all_trashed_message_templates_by_event(
-        $EVT_ID,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false
-    ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-
-    /**
-     * get_all_message_templates_by_messenger
-     *
-     * @access public
-     * @param        $messenger
-     * @param string $orderby
-     * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
-     */
-    public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
-    {
-        return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
-        );
-    }
-
-
-    /**
-     * This simply adds on any messenger/message type filters that may be present in the request
-     *
-     * @param array $_where any existing where conditions to append these to.
-     * @return array          original where conditions or original with additional filters.
-     */
-    protected function _maybe_mtp_filters($_where = array())
-    {
-        /** @var RequestInterface $request */
-        $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $messenger = $request->getRequestParam('ee_messenger_filter_by');
-        // account for messenger or message type filters
-        if ($messenger !== '' && $messenger !== 'none_selected' && $messenger !== 'all') {
-            $_where['MTP_messenger'] = $messenger;
-        }
-        $message_type = $request->getRequestParam('ee_message_type_filter_by');
-        if (
-            $message_type !== '' && $message_type !== 'none_selected'
-        ) {
-            $_where['MTP_message_type'] = $message_type;
-        }
-
-        return $_where;
-    }
-
-
-
-    /**
-     * get_all_active_message_templates groups
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @param bool   $user_check
-     * @return array all active (non_trashed, active) message template objects
-     */
-    public function get_all_active_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true,
-        $user_check = false
-    ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
-        $_where['MTP_is_active'] = true;
-        $_where = $this->_maybe_mtp_filters($_where);
-
-        if (
-            $user_check
-            && ! $global
-            && ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_messages',
-                'get_all_active_message_templates'
-            )
-        ) {
-            $_where['MTP_user_id'] = get_current_user_id();
-        }
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     *    retrieve ALL message_template groups from db regardless of wht
-     *
-     * @access    public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return mixed array on success, FALSE on fail
-     */
-    public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
-    {
-        $_where = $this->_maybe_mtp_filters();
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        $r_templates = $count
-            ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted_and_undeleted($query_params);
-
-        return $r_templates;
-    }
-
-
-
-
-    /**
-     * This gets all the custom templates attached to a specific event
-     * @param  int      $EVT_ID         event id
-     * @param  array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return  EE_Message_Template_Group[]
-     */
-    public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
-    {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
-        return $this->get_all(
-            array( $where )
-        );
-    }
-
-
-
-    /**
-     * get_all_trashed_grouped_message_templates
-     * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @return \EE_Message_Template_Group[] message template groups.
-     */
-    public function get_all_trashed_grouped_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true
-    ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
-        $_where['MTP_is_active'] = true;
-        $_where = $this->_maybe_mtp_filters($_where);
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-
-    /**
-     * this returns the message template group(s) for a given event, messenger, and message template
-     *
-     * @param  string             $messenger
-     * @param  string             $message_type
-     * @param                     $evt_id
-     * @param  string             $orderby pointless at this point but still included
-     * @param  string             $order
-     * @param  mixed (array|null) $limit   array($offset, $num)
-     * @param  bool               $count   true = just return count, false = objects
-     * @param  bool               $active  ignore "active" or not. (default only return active)
-     * @return \mixed[]) depending on $count.
-     */
-    public function get_event_message_templates_by_m_and_mt_and_evt(
-        $messenger,
-        $message_type,
-        $evt_id,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = array(
-            'MTP_messenger' => $messenger,
-            'MTP_message_type' => $message_type,
-            'Event.EVT_ID' => $evt_id,
-            'MTP_is_global' => true,
-            'MTP_is_active' => $active
-        );
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-
-    /**
-     * get all GLOBAL message template groups for the given messenger and message type
-     *
-     * @param  string $messenger    slug for messenger
-     * @param  string $message_type slug for message type
-     * @param  string $orderby      what column to orderby
-     * @param  string $order        ASC or DESC
-     * @param  mixed (array|null) $limit array($offset, $num)
-     * @param  bool   $count        true = just return count, false = objects
-     * @param  bool   $active       ignore "active" or not. (default only return active) -
-     *                              'all' means return both inactive AND inactive.
-     * @return array               message template objects that are global (i.e. non-event)
-     */
-    public function get_global_message_template_by_m_and_mt(
-        $messenger,
-        $message_type,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = array(
-            'MTP_messenger' => $messenger,
-            'MTP_message_type' => $message_type,
-            'MTP_is_global' => true,
-        );
-
-        if ($active != 'all') {
-            $_where['MTP_is_active'] = $active;
-        }
-
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-
-    /**
-     * get all custom message template groups for the given messenger and message type
-     * @param  string $messenger    messenger
-     * @param  string $message_type messagetype
-     * @param  array  $query_params same as EEM_Base->get_all()
-     * @return EE_Message_Template_Group[]
-     */
-    public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = array())
-    {
-        return $this->get_all(
-            array_merge(
-                $query_params,
-                array(
-                    array(
-                        'MTP_is_global'    => false,
-                        'MTP_messenger'    => $messenger,
-                        'MTP_message_type' => $message_type
-                    )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * This sends things to the validator for the given messenger and message type.
-     *
-     * @param  array $fields the incoming fields to check.
-     *                       Note this array is in the formatted fields from the form fields setup.
-     *                       So we need to reformat this into an array of expected field refs by the validator.
-     *                       Note also that this is not only the fields for the Message Template Group
-     *                       but ALSO for Message Template.
-     * @param string $context      The context the fields were obtained from.
-     * @param string $messenger    The messenger we are validating
-     * @param string $message_type The message type we are validating.
-     * @return mixed If the fields all check out then we return true otherwise error messages are returned
-     *                       (indexed by field name);
-     * @throws \EE_Error
-     */
-    public function validate($fields, $context, $messenger, $message_type)
-    {
-
-        $assembled_fields = array();
-
-        // let's loop through all the fields and set them up in the right format
-        foreach ($fields as $index => $value) {
-            // first let's figure out if the value['content'] in the current index is an array.
-            //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
-            if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
-                // loop through the content and get the other fields.
-                foreach ($value['content'] as $name => $val) {
-                    if ($name == 'main') {
-                        continue;
-                    }
-                    $assembled_fields[ $name ] = $val;
-                }
-                continue;
-            }
-
-            // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
-        }
-
-        // now we've got the assembled_fields.
-        // We need to setup the string for the appropriate validator class and call that.
-        $m_ref = ucwords(str_replace('_', ' ', $messenger));
-        $m_ref = str_replace(' ', '_', $m_ref);
-        $mt_ref = ucwords(str_replace('_', ' ', $message_type));
-        $mt_ref = str_replace(' ', '_', $mt_ref);
-
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
-
-        if (!class_exists($classname)) {
-            $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__(
-                    'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
-                    'event_espresso'
-                ),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        $a = new ReflectionClass($classname);
-        $_VLD = $a->newInstance($assembled_fields, $context);
-        $result = $_VLD->validate();
-        return $result;
-    }
-
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @param array $messenger_names    The messenger slugs.
-     *                              If empty then all templates matching the message types are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names     The message type slugs.
-     *                              If empty then all templates matching the messengers are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     */
-    public function deactivate_message_template_groups_for($messenger_names = array(), $message_type_names = array())
-    {
-        $query_args = array();
-        if (empty($messenger_names) && empty($message_type_names)) {
-            return 0;
-        }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
-        }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
-        }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
-    }
+	// private instance of the EEM_Message_Template_Group object
+	protected static $_instance = null;
+
+
+
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Message Template Group', 'event_espresso');
+		$this->plural_item = esc_html__('Message Template Groups', 'event_espresso');
+		$this->_tables = array(
+			'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID')
+		);
+		$this->_fields = array(
+			'Message_Template_Group' => array(
+				'GRP_ID' => new EE_Primary_Key_Int_Field('GRP_ID', esc_html__('Message Template Group ID', 'event_espresso')),
+				'MTP_name' => new EE_Plain_Text_Field('MTP_name', esc_html__('The name of the template group', 'event_espresso'), false, ''),
+				'MTP_description' => new EE_Simple_HTML_Field('MTP_description', esc_html__('A brief description about this template.', 'event_espresso'), false, ''),
+				'MTP_user_id' => new EE_WP_User_Field('MTP_user_id', esc_html__('Template Creator ID', 'event_espresso'), false, get_current_user_id()),
+				'MTP_messenger' => new EE_Plain_Text_Field('MTP_messenger', esc_html__('Messenger Used for Template', 'event_espresso'), false, 'email'),
+				'MTP_message_type' => new EE_Plain_Text_Field('MTP_message_type', esc_html__('Message Type', 'event_espresso'), false, 'registration'),
+				'MTP_is_global' => new EE_Boolean_Field('MTP_is_global', esc_html__('Flag indicating if Template Group is Global', 'event_espresso'), false, true),
+				'MTP_is_override' => new EE_Boolean_Field('MTP_is_override', esc_html__('Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination', 'event_espresso'), false, false),
+				'MTP_deleted' => new EE_Trashed_Flag_Field('MTP_deleted', esc_html__('Flag indicating whether this has been trashed', 'event_espresso'), false, false),
+				'MTP_is_active' => new EE_Boolean_Field('MTP_is_active', esc_html__('Flag indicating whether template group is active', 'event_espresso'), false, true)
+			)
+		);
+		$this->_model_relations = array(
+			'Message_Template' => new EE_Has_Many_Relation(),
+			'Message' => new EE_Has_Many_Relation(),
+			'Event' => new EE_HABTM_Relation('Event_Message_Template'),
+			'WP_User' => new EE_Belongs_To_Relation()
+		);
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+		}
+		$this->_caps_slug = 'messages';
+
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * get_all_trashed_message_templates_by_event
+	 *
+	 * @access public
+	 * @param int    $EVT_ID specific event id
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return array message template objects that are attached to a specific event.
+	 */
+	public function get_all_trashed_message_templates_by_event(
+		$EVT_ID,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false
+	) {
+		$query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+
+	/**
+	 * get_all_message_templates_by_messenger
+	 *
+	 * @access public
+	 * @param        $messenger
+	 * @param string $orderby
+	 * @param string $order
+	 * @return array all (including trashed or inactive) message template group objects for the given messenger
+	 */
+	public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
+	{
+		return $this->get_all_deleted_and_undeleted(
+			array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+		);
+	}
+
+
+	/**
+	 * This simply adds on any messenger/message type filters that may be present in the request
+	 *
+	 * @param array $_where any existing where conditions to append these to.
+	 * @return array          original where conditions or original with additional filters.
+	 */
+	protected function _maybe_mtp_filters($_where = array())
+	{
+		/** @var RequestInterface $request */
+		$request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$messenger = $request->getRequestParam('ee_messenger_filter_by');
+		// account for messenger or message type filters
+		if ($messenger !== '' && $messenger !== 'none_selected' && $messenger !== 'all') {
+			$_where['MTP_messenger'] = $messenger;
+		}
+		$message_type = $request->getRequestParam('ee_message_type_filter_by');
+		if (
+			$message_type !== '' && $message_type !== 'none_selected'
+		) {
+			$_where['MTP_message_type'] = $message_type;
+		}
+
+		return $_where;
+	}
+
+
+
+	/**
+	 * get_all_active_message_templates groups
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @param bool   $user_check
+	 * @return array all active (non_trashed, active) message template objects
+	 */
+	public function get_all_active_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true,
+		$user_check = false
+	) {
+		$_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+		$_where['MTP_is_active'] = true;
+		$_where = $this->_maybe_mtp_filters($_where);
+
+		if (
+			$user_check
+			&& ! $global
+			&& ! EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_messages',
+				'get_all_active_message_templates'
+			)
+		) {
+			$_where['MTP_user_id'] = get_current_user_id();
+		}
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 *    retrieve ALL message_template groups from db regardless of wht
+	 *
+	 * @access    public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return mixed array on success, FALSE on fail
+	 */
+	public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
+	{
+		$_where = $this->_maybe_mtp_filters();
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		$r_templates = $count
+			? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted_and_undeleted($query_params);
+
+		return $r_templates;
+	}
+
+
+
+
+	/**
+	 * This gets all the custom templates attached to a specific event
+	 * @param  int      $EVT_ID         event id
+	 * @param  array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return  EE_Message_Template_Group[]
+	 */
+	public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
+	{
+		$where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+		return $this->get_all(
+			array( $where )
+		);
+	}
+
+
+
+	/**
+	 * get_all_trashed_grouped_message_templates
+	 * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @return \EE_Message_Template_Group[] message template groups.
+	 */
+	public function get_all_trashed_grouped_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true
+	) {
+		$_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+		$_where['MTP_is_active'] = true;
+		$_where = $this->_maybe_mtp_filters($_where);
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+
+	/**
+	 * this returns the message template group(s) for a given event, messenger, and message template
+	 *
+	 * @param  string             $messenger
+	 * @param  string             $message_type
+	 * @param                     $evt_id
+	 * @param  string             $orderby pointless at this point but still included
+	 * @param  string             $order
+	 * @param  mixed (array|null) $limit   array($offset, $num)
+	 * @param  bool               $count   true = just return count, false = objects
+	 * @param  bool               $active  ignore "active" or not. (default only return active)
+	 * @return \mixed[]) depending on $count.
+	 */
+	public function get_event_message_templates_by_m_and_mt_and_evt(
+		$messenger,
+		$message_type,
+		$evt_id,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = array(
+			'MTP_messenger' => $messenger,
+			'MTP_message_type' => $message_type,
+			'Event.EVT_ID' => $evt_id,
+			'MTP_is_global' => true,
+			'MTP_is_active' => $active
+		);
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+
+	/**
+	 * get all GLOBAL message template groups for the given messenger and message type
+	 *
+	 * @param  string $messenger    slug for messenger
+	 * @param  string $message_type slug for message type
+	 * @param  string $orderby      what column to orderby
+	 * @param  string $order        ASC or DESC
+	 * @param  mixed (array|null) $limit array($offset, $num)
+	 * @param  bool   $count        true = just return count, false = objects
+	 * @param  bool   $active       ignore "active" or not. (default only return active) -
+	 *                              'all' means return both inactive AND inactive.
+	 * @return array               message template objects that are global (i.e. non-event)
+	 */
+	public function get_global_message_template_by_m_and_mt(
+		$messenger,
+		$message_type,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = array(
+			'MTP_messenger' => $messenger,
+			'MTP_message_type' => $message_type,
+			'MTP_is_global' => true,
+		);
+
+		if ($active != 'all') {
+			$_where['MTP_is_active'] = $active;
+		}
+
+		$query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+
+	/**
+	 * get all custom message template groups for the given messenger and message type
+	 * @param  string $messenger    messenger
+	 * @param  string $message_type messagetype
+	 * @param  array  $query_params same as EEM_Base->get_all()
+	 * @return EE_Message_Template_Group[]
+	 */
+	public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = array())
+	{
+		return $this->get_all(
+			array_merge(
+				$query_params,
+				array(
+					array(
+						'MTP_is_global'    => false,
+						'MTP_messenger'    => $messenger,
+						'MTP_message_type' => $message_type
+					)
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * This sends things to the validator for the given messenger and message type.
+	 *
+	 * @param  array $fields the incoming fields to check.
+	 *                       Note this array is in the formatted fields from the form fields setup.
+	 *                       So we need to reformat this into an array of expected field refs by the validator.
+	 *                       Note also that this is not only the fields for the Message Template Group
+	 *                       but ALSO for Message Template.
+	 * @param string $context      The context the fields were obtained from.
+	 * @param string $messenger    The messenger we are validating
+	 * @param string $message_type The message type we are validating.
+	 * @return mixed If the fields all check out then we return true otherwise error messages are returned
+	 *                       (indexed by field name);
+	 * @throws \EE_Error
+	 */
+	public function validate($fields, $context, $messenger, $message_type)
+	{
+
+		$assembled_fields = array();
+
+		// let's loop through all the fields and set them up in the right format
+		foreach ($fields as $index => $value) {
+			// first let's figure out if the value['content'] in the current index is an array.
+			//  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
+			if (is_array($value['content'])) {
+				$assembled_fields[ $value['name'] ] = $value['content']['main'];
+				// loop through the content and get the other fields.
+				foreach ($value['content'] as $name => $val) {
+					if ($name == 'main') {
+						continue;
+					}
+					$assembled_fields[ $name ] = $val;
+				}
+				continue;
+			}
+
+			// okay if we're here then this is just a straight field=>$value arrangement
+			$assembled_fields[ $value['name'] ] = $value['content'];
+		}
+
+		// now we've got the assembled_fields.
+		// We need to setup the string for the appropriate validator class and call that.
+		$m_ref = ucwords(str_replace('_', ' ', $messenger));
+		$m_ref = str_replace(' ', '_', $m_ref);
+		$mt_ref = ucwords(str_replace('_', ' ', $message_type));
+		$mt_ref = str_replace(' ', '_', $mt_ref);
+
+		$classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+
+		if (!class_exists($classname)) {
+			$msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__(
+					'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
+					'event_espresso'
+				),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		$a = new ReflectionClass($classname);
+		$_VLD = $a->newInstance($assembled_fields, $context);
+		$result = $_VLD->validate();
+		return $result;
+	}
+
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @param array $messenger_names    The messenger slugs.
+	 *                              If empty then all templates matching the message types are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names     The message type slugs.
+	 *                              If empty then all templates matching the messengers are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 */
+	public function deactivate_message_template_groups_for($messenger_names = array(), $message_type_names = array())
+	{
+		$query_args = array();
+		if (empty($messenger_names) && empty($message_type_names)) {
+			return 0;
+		}
+		if (! empty($messenger_names)) {
+			$query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+		}
+		if (! empty($message_type_names)) {
+			$query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+		}
+		return $this->update(array( 'MTP_is_active' => false ), $query_args);
+	}
 }

core/db_models/fields/EE_Foreign_Key_Int_Field.php

Indentation +29 added lines, -29 removed lines

@@ -3,36 +3,36 @@
 class EE_Foreign_Key_Int_Field extends EE_Foreign_Key_Field_Base
 {
 
-    /**
-     * @param string  $table_column  name fo column for field
-     * @param string  $nicename      should eb internationalized with esc_html__('blah','event_espresso')
-     * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
-     *                               dbe a string
-     * @param string|string[]  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
-     *                               "EEM_"
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
-        $this->setSchemaType('integer');
-    }
+	/**
+	 * @param string  $table_column  name fo column for field
+	 * @param string  $nicename      should eb internationalized with esc_html__('blah','event_espresso')
+	 * @param boolean $nullable
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+	 *                               dbe a string
+	 * @param string|string[]  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
+	 *                               "EEM_"
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
+		$this->setSchemaType('integer');
+	}
 
 
-    /**
-     * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
-     * @return int
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return absint($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
+	 * @return int
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return absint($value_inputted_for_field_on_model_object);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return intval($value_found_in_db_for_model_object);
-    }
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return intval($value_found_in_db_for_model_object);
+	}
 }

core/db_models/fields/EE_WP_User_Field.php

Indentation +34 added lines, -34 removed lines

@@ -13,39 +13,39 @@
  */
 class EE_WP_User_Field extends EE_Foreign_Key_Int_Field
 {
-    /**
-     * No need to provide a default or the model pointed to- the default is
-     * always get_current_user_id() and the model pointed to is always WP_User
-     *
-     * @param string  $table_column name fo column for field
-     * @param string  $nicename     should eb internationalized with esc_html__('blah','event_espresso')
-     * @param boolean $nullable
-     */
-    public function __construct($table_column, $nicename, $nullable)
-    {
-        parent::__construct($table_column, $nicename, $nullable, null, 'WP_User');
-    }
+	/**
+	 * No need to provide a default or the model pointed to- the default is
+	 * always get_current_user_id() and the model pointed to is always WP_User
+	 *
+	 * @param string  $table_column name fo column for field
+	 * @param string  $nicename     should eb internationalized with esc_html__('blah','event_espresso')
+	 * @param boolean $nullable
+	 */
+	public function __construct($table_column, $nicename, $nullable)
+	{
+		parent::__construct($table_column, $nicename, $nullable, null, 'WP_User');
+	}
 
-    /**
-     * Gets the default which is always the current user. This can't be set when initially
-     * constructing the model field because that's done before $current_user is set
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        if (did_action('init')) {
-            return get_current_user_id();
-        } else {
-            EE_Error::doing_it_wrong(
-                'EE_WP_User_Field::get_default_value',
-                esc_html__(
-                    'You cant get a default value for a wp_User_Field because the "init" action is called, because current_user global hasnt yet been setup. Consider doing your business logic on the "init" hook or later.',
-                    'event_espresso'
-                ),
-                '4.6.20'
-            );
-            return 1;
-        }
-    }
+	/**
+	 * Gets the default which is always the current user. This can't be set when initially
+	 * constructing the model field because that's done before $current_user is set
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		if (did_action('init')) {
+			return get_current_user_id();
+		} else {
+			EE_Error::doing_it_wrong(
+				'EE_WP_User_Field::get_default_value',
+				esc_html__(
+					'You cant get a default value for a wp_User_Field because the "init" action is called, because current_user global hasnt yet been setup. Consider doing your business logic on the "init" hook or later.',
+					'event_espresso'
+				),
+				'4.6.20'
+			);
+			return 1;
+		}
+	}
 }