Completed
Branch FET-3467-waitlists (4406f2)
by
unknown
46:31 queued 34:26
created
core/db_models/EEM_Base.model.php 3 patches
Doc Comments   +19 added lines, -17 removed lines patch added patch discarded remove patch
@@ -961,7 +961,7 @@  discard block
 block discarded – undo
961 961
      *  on this model (or follows the _model_chain_to_wp_user and uses that model's
962 962
      * foreign key to the WP_User table)
963 963
      *
964
-     * @return string|boolean string on success, boolean false when there is no
964
+     * @return string|false string on success, boolean false when there is no
965 965
      * foreign key to the WP_User table
966 966
      */
967 967
     public function wp_user_field_name()
@@ -1067,7 +1067,7 @@  discard block
 block discarded – undo
1067 1067
      *
1068 1068
      * @param array  $query_params      like EEM_Base::get_all's $query_params
1069 1069
      * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1070
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1070
+     * @param string  $columns_to_select , What columns to select. By default, we select all columns specified by the
1071 1071
      *                                  fields on the model, and the models we joined to in the query. However, you can
1072 1072
      *                                  override this and set the select to "*", or a specific column name, like
1073 1073
      *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
@@ -1459,7 +1459,7 @@  discard block
 block discarded – undo
1459 1459
      * @param string $field_name The name of the field the formats are being retrieved for.
1460 1460
      * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1461 1461
      * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1462
-     * @return array formats in an array with the date format first, and the time format last.
1462
+     * @return string[] formats in an array with the date format first, and the time format last.
1463 1463
      */
1464 1464
     public function get_formats_for($field_name, $pretty = false)
1465 1465
     {
@@ -1492,7 +1492,7 @@  discard block
 block discarded – undo
1492 1492
      *                                 be returned.
1493 1493
      * @param string $what             Whether to return the string in just the time format, the date format, or both.
1494 1494
      * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1495
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1495
+     * @return string|null  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1496 1496
      *                                 exception is triggered.
1497 1497
      */
1498 1498
     public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
@@ -1532,7 +1532,7 @@  discard block
 block discarded – undo
1532 1532
      *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1533 1533
      *                                format is
1534 1534
      *                                'U', this is ignored.
1535
-     * @return DateTime
1535
+     * @return string
1536 1536
      * @throws \EE_Error
1537 1537
      */
1538 1538
     public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
@@ -1830,7 +1830,7 @@  discard block
 block discarded – undo
1830 1830
      * Wrapper for EEM_Base::delete_permanently()
1831 1831
      *
1832 1832
      * @param mixed $id
1833
-     * @return boolean whether the row got deleted or not
1833
+     * @return integer whether the row got deleted or not
1834 1834
      * @throws \EE_Error
1835 1835
      */
1836 1836
     public function delete_permanently_by_ID($id)
@@ -1850,7 +1850,7 @@  discard block
 block discarded – undo
1850 1850
      * Wrapper for EEM_Base::delete()
1851 1851
      *
1852 1852
      * @param mixed $id
1853
-     * @return boolean whether the row got deleted or not
1853
+     * @return integer whether the row got deleted or not
1854 1854
      * @throws \EE_Error
1855 1855
      */
1856 1856
     public function delete_by_ID($id)
@@ -2300,7 +2300,7 @@  discard block
 block discarded – undo
2300 2300
      * Verifies the EE addons' database is up-to-date and records that we've done it on
2301 2301
      * EEM_Base::$_db_verification_level
2302 2302
      *
2303
-     * @param $wpdb_method
2303
+     * @param string $wpdb_method
2304 2304
      * @param $arguments_to_provide
2305 2305
      * @return string
2306 2306
      */
@@ -2424,6 +2424,7 @@  discard block
 block discarded – undo
2424 2424
      *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2425 2425
      *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2426 2426
      *                             because these will be inserted in any new rows created as well.
2427
+     * @param EE_Base_Class $id_or_obj
2427 2428
      */
2428 2429
     public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2429 2430
     {
@@ -2434,7 +2435,7 @@  discard block
 block discarded – undo
2434 2435
 
2435 2436
 
2436 2437
     /**
2437
-     * @param mixed           $id_or_obj
2438
+     * @param EE_Base_Class           $id_or_obj
2438 2439
      * @param string          $relationName
2439 2440
      * @param array           $where_query_params
2440 2441
      * @param EE_Base_Class[] objects to which relations were removed
@@ -2475,7 +2476,7 @@  discard block
 block discarded – undo
2475 2476
      * However, if the model objects can't be deleted because of blocking related model objects, then
2476 2477
      * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2477 2478
      *
2478
-     * @param EE_Base_Class|int|string $id_or_obj
2479
+     * @param EE_Base_Class $id_or_obj
2479 2480
      * @param string                   $model_name
2480 2481
      * @param array                    $query_params
2481 2482
      * @return int how many deleted
@@ -2496,7 +2497,7 @@  discard block
 block discarded – undo
2496 2497
      * the model objects can't be hard deleted because of blocking related model objects,
2497 2498
      * just does a soft-delete on them instead.
2498 2499
      *
2499
-     * @param EE_Base_Class|int|string $id_or_obj
2500
+     * @param EE_Base_Class $id_or_obj
2500 2501
      * @param string                   $model_name
2501 2502
      * @param array                    $query_params
2502 2503
      * @return int how many deleted
@@ -2553,6 +2554,7 @@  discard block
 block discarded – undo
2553 2554
      * @param string $model_name   like 'Event', or 'Registration'
2554 2555
      * @param array  $query_params like EEM_Base::get_all's
2555 2556
      * @param string $field_to_sum name of field to count by. By default, uses primary key
2557
+     * @param EE_Base_Class $id_or_obj
2556 2558
      * @return float
2557 2559
      * @throws \EE_Error
2558 2560
      */
@@ -3023,7 +3025,7 @@  discard block
 block discarded – undo
3023 3025
      * Finds all the fields that correspond to the given table
3024 3026
      *
3025 3027
      * @param string $table_alias , array key in EEM_Base::_tables
3026
-     * @return EE_Model_Field_Base[]
3028
+     * @return EE_Model_Field_Base
3027 3029
      */
3028 3030
     public function _get_fields_for_table($table_alias)
3029 3031
     {
@@ -3508,7 +3510,7 @@  discard block
 block discarded – undo
3508 3510
      * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3509 3511
      * We should use default where conditions on related models when they requested to use default where conditions
3510 3512
      * on all models, or specifically just on other related models
3511
-     * @param      $default_where_conditions_value
3513
+     * @param      string $default_where_conditions_value
3512 3514
      * @param bool $for_this_model false means this is for OTHER related models
3513 3515
      * @return bool
3514 3516
      */
@@ -3546,7 +3548,7 @@  discard block
 block discarded – undo
3546 3548
      * where conditions.
3547 3549
      * We should use minimum where conditions on related models if they requested to use minimum where conditions
3548 3550
      * on this model or others
3549
-     * @param      $default_where_conditions_value
3551
+     * @param      string $default_where_conditions_value
3550 3552
      * @param bool $for_this_model false means this is for OTHER related models
3551 3553
      * @return bool
3552 3554
      */
@@ -4536,7 +4538,7 @@  discard block
 block discarded – undo
4536 4538
      * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4537 4539
      * Eg, on EE_Answer that would be ANS_ID field object
4538 4540
      *
4539
-     * @param $field_obj
4541
+     * @param EE_Model_Field_Base $field_obj
4540 4542
      * @return boolean
4541 4543
      */
4542 4544
     public function is_primary_key_field($field_obj)
@@ -4647,7 +4649,7 @@  discard block
 block discarded – undo
4647 4649
      * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4648 4650
      *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4649 4651
      *                            Either one works
4650
-     * @return EE_Table_Base
4652
+     * @return string
4651 4653
      */
4652 4654
     public function get_table_for_alias($table_alias)
4653 4655
     {
@@ -5258,7 +5260,7 @@  discard block
 block discarded – undo
5258 5260
     /**
5259 5261
      * Read comments for assume_values_already_prepared_by_model_object()
5260 5262
      *
5261
-     * @return int
5263
+     * @return boolean
5262 5264
      */
5263 5265
     public function get_assumption_concerning_values_already_prepared_by_model_object()
5264 5266
     {
Please login to merge, or discard this patch.
Spacing   +155 added lines, -155 removed lines patch added patch discarded remove patch
@@ -516,8 +516,8 @@  discard block
 block discarded – undo
516 516
     protected function __construct($timezone = null)
517 517
     {
518 518
         // check that the model has not been loaded too soon
519
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
520
-            throw new EE_Error (
519
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
520
+            throw new EE_Error(
521 521
                 sprintf(
522 522
                     __('The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
523 523
                         'event_espresso'),
@@ -537,7 +537,7 @@  discard block
 block discarded – undo
537 537
          *
538 538
          * @var EE_Table_Base[] $_tables
539 539
          */
540
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
540
+        $this->_tables = apply_filters('FHEE__'.get_class($this).'__construct__tables', $this->_tables);
541 541
         foreach ($this->_tables as $table_alias => $table_obj) {
542 542
             /** @var $table_obj EE_Table_Base */
543 543
             $table_obj->_construct_finalize_with_alias($table_alias);
@@ -552,10 +552,10 @@  discard block
 block discarded – undo
552 552
          *
553 553
          * @param EE_Model_Field_Base[] $_fields
554 554
          */
555
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
555
+        $this->_fields = apply_filters('FHEE__'.get_class($this).'__construct__fields', $this->_fields);
556 556
         $this->_invalidate_field_caches();
557 557
         foreach ($this->_fields as $table_alias => $fields_for_table) {
558
-            if (! array_key_exists($table_alias, $this->_tables)) {
558
+            if ( ! array_key_exists($table_alias, $this->_tables)) {
559 559
                 throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
560 560
                     'event_espresso'), $table_alias, implode(",", $this->_fields)));
561 561
             }
@@ -583,7 +583,7 @@  discard block
 block discarded – undo
583 583
          *
584 584
          * @param EE_Model_Relation_Base[] $_model_relations
585 585
          */
586
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
586
+        $this->_model_relations = apply_filters('FHEE__'.get_class($this).'__construct__model_relations',
587 587
             $this->_model_relations);
588 588
         foreach ($this->_model_relations as $model_name => $relation_obj) {
589 589
             /** @var $relation_obj EE_Model_Relation_Base */
@@ -595,12 +595,12 @@  discard block
 block discarded – undo
595 595
         }
596 596
         $this->set_timezone($timezone);
597 597
         //finalize default where condition strategy, or set default
598
-        if (! $this->_default_where_conditions_strategy) {
598
+        if ( ! $this->_default_where_conditions_strategy) {
599 599
             //nothing was set during child constructor, so set default
600 600
             $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
601 601
         }
602 602
         $this->_default_where_conditions_strategy->_finalize_construct($this);
603
-        if (! $this->_minimum_where_conditions_strategy) {
603
+        if ( ! $this->_minimum_where_conditions_strategy) {
604 604
             //nothing was set during child constructor, so set default
605 605
             $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
606 606
         }
@@ -613,7 +613,7 @@  discard block
 block discarded – undo
613 613
         //initialize the standard cap restriction generators if none were specified by the child constructor
614 614
         if ($this->_cap_restriction_generators !== false) {
615 615
             foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
616
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
616
+                if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
617 617
                     $this->_cap_restriction_generators[$cap_context] = apply_filters(
618 618
                         'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
619 619
                         new EE_Restriction_Generator_Protected(),
@@ -626,10 +626,10 @@  discard block
 block discarded – undo
626 626
         //if there are cap restriction generators, use them to make the default cap restrictions
627 627
         if ($this->_cap_restriction_generators !== false) {
628 628
             foreach ($this->_cap_restriction_generators as $context => $generator_object) {
629
-                if (! $generator_object) {
629
+                if ( ! $generator_object) {
630 630
                     continue;
631 631
                 }
632
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
632
+                if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
633 633
                     throw new EE_Error(
634 634
                         sprintf(
635 635
                             __('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
@@ -640,12 +640,12 @@  discard block
 block discarded – undo
640 640
                     );
641 641
                 }
642 642
                 $action = $this->cap_action_for_context($context);
643
-                if (! $generator_object->construction_finalized()) {
643
+                if ( ! $generator_object->construction_finalized()) {
644 644
                     $generator_object->_construct_finalize($this, $action);
645 645
                 }
646 646
             }
647 647
         }
648
-        do_action('AHEE__' . get_class($this) . '__construct__end');
648
+        do_action('AHEE__'.get_class($this).'__construct__end');
649 649
     }
650 650
 
651 651
 
@@ -680,7 +680,7 @@  discard block
 block discarded – undo
680 680
      */
681 681
     public static function set_model_query_blog_id($blog_id = 0)
682 682
     {
683
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
683
+        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int) $blog_id : get_current_blog_id();
684 684
     }
685 685
 
686 686
 
@@ -710,7 +710,7 @@  discard block
 block discarded – undo
710 710
     public static function instance($timezone = null)
711 711
     {
712 712
         // check if instance of Espresso_model already exists
713
-        if (! static::$_instance instanceof static) {
713
+        if ( ! static::$_instance instanceof static) {
714 714
             // instantiate Espresso_model
715 715
             static::$_instance = new static($timezone);
716 716
         }
@@ -741,7 +741,7 @@  discard block
 block discarded – undo
741 741
             foreach ($r->getDefaultProperties() as $property => $value) {
742 742
                 //don't set instance to null like it was originally,
743 743
                 //but it's static anyways, and we're ignoring static properties (for now at least)
744
-                if (! isset($static_properties[$property])) {
744
+                if ( ! isset($static_properties[$property])) {
745 745
                     static::$_instance->{$property} = $value;
746 746
                 }
747 747
             }
@@ -764,7 +764,7 @@  discard block
 block discarded – undo
764 764
      */
765 765
     public function status_array($translated = false)
766 766
     {
767
-        if (! array_key_exists('Status', $this->_model_relations)) {
767
+        if ( ! array_key_exists('Status', $this->_model_relations)) {
768 768
             return array();
769 769
         }
770 770
         $model_name = $this->get_this_model_name();
@@ -967,17 +967,17 @@  discard block
 block discarded – undo
967 967
     public function wp_user_field_name()
968 968
     {
969 969
         try {
970
-            if (! empty($this->_model_chain_to_wp_user)) {
970
+            if ( ! empty($this->_model_chain_to_wp_user)) {
971 971
                 $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
972 972
                 $last_model_name = end($models_to_follow_to_wp_users);
973 973
                 $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
974
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
974
+                $model_chain_to_wp_user = $this->_model_chain_to_wp_user.'.';
975 975
             } else {
976 976
                 $model_with_fk_to_wp_users = $this;
977 977
                 $model_chain_to_wp_user = '';
978 978
             }
979 979
             $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
980
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
980
+            return $model_chain_to_wp_user.$wp_user_field->get_name();
981 981
         } catch (EE_Error $e) {
982 982
             return false;
983 983
         }
@@ -1049,12 +1049,12 @@  discard block
 block discarded – undo
1049 1049
         // remember the custom selections, if any, and type cast as array
1050 1050
         // (unless $columns_to_select is an object, then just set as an empty array)
1051 1051
         // Note: (array) 'some string' === array( 'some string' )
1052
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1052
+        $this->_custom_selections = ! is_object($columns_to_select) ? (array) $columns_to_select : array();
1053 1053
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1054 1054
         $select_expressions = $columns_to_select !== null
1055 1055
             ? $this->_construct_select_from_input($columns_to_select)
1056 1056
             : $this->_construct_default_select_sql($model_query_info);
1057
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1057
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1058 1058
         return $this->_do_wpdb_query('get_results', array($SQL, $output));
1059 1059
     }
1060 1060
 
@@ -1099,7 +1099,7 @@  discard block
 block discarded – undo
1099 1099
         if (is_array($columns_to_select)) {
1100 1100
             $select_sql_array = array();
1101 1101
             foreach ($columns_to_select as $alias => $selection_and_datatype) {
1102
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1102
+                if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1103 1103
                     throw new EE_Error(
1104 1104
                         sprintf(
1105 1105
                             __(
@@ -1111,7 +1111,7 @@  discard block
 block discarded – undo
1111 1111
                         )
1112 1112
                     );
1113 1113
                 }
1114
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1114
+                if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1115 1115
                     throw new EE_Error(
1116 1116
                         sprintf(
1117 1117
                             __(
@@ -1183,7 +1183,7 @@  discard block
 block discarded – undo
1183 1183
      */
1184 1184
     public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1185 1185
     {
1186
-        if (! isset($query_params[0])) {
1186
+        if ( ! isset($query_params[0])) {
1187 1187
             $query_params[0] = array();
1188 1188
         }
1189 1189
         $conditions_from_id = $this->parse_index_primary_key_string($id);
@@ -1208,7 +1208,7 @@  discard block
 block discarded – undo
1208 1208
      */
1209 1209
     public function get_one($query_params = array())
1210 1210
     {
1211
-        if (! is_array($query_params)) {
1211
+        if ( ! is_array($query_params)) {
1212 1212
             EE_Error::doing_it_wrong('EEM_Base::get_one',
1213 1213
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1214 1214
                     gettype($query_params)), '4.6.0');
@@ -1376,7 +1376,7 @@  discard block
 block discarded – undo
1376 1376
                 return array();
1377 1377
             }
1378 1378
         }
1379
-        if (! is_array($query_params)) {
1379
+        if ( ! is_array($query_params)) {
1380 1380
             EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1381 1381
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1382 1382
                     gettype($query_params)), '4.6.0');
@@ -1386,7 +1386,7 @@  discard block
 block discarded – undo
1386 1386
         $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1387 1387
         $query_params['limit'] = $limit;
1388 1388
         //set direction
1389
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1389
+        $incoming_orderby = isset($query_params['order_by']) ? (array) $query_params['order_by'] : array();
1390 1390
         $query_params['order_by'] = $operand === '>'
1391 1391
             ? array($field_to_order_by => 'ASC') + $incoming_orderby
1392 1392
             : array($field_to_order_by => 'DESC') + $incoming_orderby;
@@ -1465,7 +1465,7 @@  discard block
 block discarded – undo
1465 1465
     {
1466 1466
         $field_settings = $this->field_settings_for($field_name);
1467 1467
         //if not a valid EE_Datetime_Field then throw error
1468
-        if (! $field_settings instanceof EE_Datetime_Field) {
1468
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
1469 1469
             throw new EE_Error(sprintf(__('The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
1470 1470
                 'event_espresso'), $field_name));
1471 1471
         }
@@ -1542,7 +1542,7 @@  discard block
 block discarded – undo
1542 1542
         //load EEH_DTT_Helper
1543 1543
         $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1544 1544
         $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1545
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1545
+        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime($incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)));
1546 1546
     }
1547 1547
 
1548 1548
 
@@ -1610,7 +1610,7 @@  discard block
 block discarded – undo
1610 1610
      */
1611 1611
     public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1612 1612
     {
1613
-        if (! is_array($query_params)) {
1613
+        if ( ! is_array($query_params)) {
1614 1614
             EE_Error::doing_it_wrong('EEM_Base::update',
1615 1615
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1616 1616
                     gettype($query_params)), '4.6.0');
@@ -1632,7 +1632,7 @@  discard block
 block discarded – undo
1632 1632
          * @param EEM_Base $model           the model being queried
1633 1633
          * @param array    $query_params    see EEM_Base::get_all()
1634 1634
          */
1635
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1635
+        $fields_n_values = (array) apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1636 1636
             $query_params);
1637 1637
         //need to verify that, for any entry we want to update, there are entries in each secondary table.
1638 1638
         //to do that, for each table, verify that it's PK isn't null.
@@ -1646,7 +1646,7 @@  discard block
 block discarded – undo
1646 1646
         $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1647 1647
         foreach ($wpdb_select_results as $wpdb_result) {
1648 1648
             // type cast stdClass as array
1649
-            $wpdb_result = (array)$wpdb_result;
1649
+            $wpdb_result = (array) $wpdb_result;
1650 1650
             //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1651 1651
             if ($this->has_primary_key_field()) {
1652 1652
                 $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
@@ -1663,13 +1663,13 @@  discard block
 block discarded – undo
1663 1663
                     $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1664 1664
                     //if there is no private key for this table on the results, it means there's no entry
1665 1665
                     //in this table, right? so insert a row in the current table, using any fields available
1666
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1666
+                    if ( ! (array_key_exists($this_table_pk_column, $wpdb_result)
1667 1667
                            && $wpdb_result[$this_table_pk_column])
1668 1668
                     ) {
1669 1669
                         $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1670 1670
                             $main_table_pk_value);
1671 1671
                         //if we died here, report the error
1672
-                        if (! $success) {
1672
+                        if ( ! $success) {
1673 1673
                             return false;
1674 1674
                         }
1675 1675
                     }
@@ -1700,7 +1700,7 @@  discard block
 block discarded – undo
1700 1700
                     $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1701 1701
                 }
1702 1702
             }
1703
-            if (! $model_objs_affected_ids) {
1703
+            if ( ! $model_objs_affected_ids) {
1704 1704
                 //wait wait wait- if nothing was affected let's stop here
1705 1705
                 return 0;
1706 1706
             }
@@ -1727,7 +1727,7 @@  discard block
 block discarded – undo
1727 1727
                . $model_query_info->get_full_join_sql()
1728 1728
                . " SET "
1729 1729
                . $this->_construct_update_sql($fields_n_values)
1730
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1730
+               . $model_query_info->get_where_sql(); //note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1731 1731
         $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1732 1732
         /**
1733 1733
          * Action called after a model update call has been made.
@@ -1738,7 +1738,7 @@  discard block
 block discarded – undo
1738 1738
          * @param int      $rows_affected
1739 1739
          */
1740 1740
         do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1741
-        return $rows_affected;//how many supposedly got updated
1741
+        return $rows_affected; //how many supposedly got updated
1742 1742
     }
1743 1743
 
1744 1744
 
@@ -1766,7 +1766,7 @@  discard block
 block discarded – undo
1766 1766
         }
1767 1767
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1768 1768
         $select_expressions = $field->get_qualified_column();
1769
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1769
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1770 1770
         return $this->_do_wpdb_query('get_col', array($SQL));
1771 1771
     }
1772 1772
 
@@ -1784,7 +1784,7 @@  discard block
 block discarded – undo
1784 1784
     {
1785 1785
         $query_params['limit'] = 1;
1786 1786
         $col = $this->get_col($query_params, $field_to_select);
1787
-        if (! empty($col)) {
1787
+        if ( ! empty($col)) {
1788 1788
             return reset($col);
1789 1789
         } else {
1790 1790
             return null;
@@ -1816,7 +1816,7 @@  discard block
 block discarded – undo
1816 1816
             $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1817 1817
             $value_sql = $prepared_value === null ? 'NULL'
1818 1818
                 : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1819
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1819
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
1820 1820
         }
1821 1821
         return implode(",", $cols_n_values);
1822 1822
     }
@@ -1948,7 +1948,7 @@  discard block
 block discarded – undo
1948 1948
          * @param int      $rows_deleted
1949 1949
          */
1950 1950
         do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1951
-        return $rows_deleted;//how many supposedly got deleted
1951
+        return $rows_deleted; //how many supposedly got deleted
1952 1952
     }
1953 1953
 
1954 1954
 
@@ -2041,7 +2041,7 @@  discard block
 block discarded – undo
2041 2041
                     $deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2042 2042
                 }
2043 2043
                 //other tables
2044
-                if (! empty($other_tables)) {
2044
+                if ( ! empty($other_tables)) {
2045 2045
                     foreach ($other_tables as $ot) {
2046 2046
                         //first check if we've got the foreign key column here.
2047 2047
                         if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
@@ -2064,7 +2064,7 @@  discard block
 block discarded – undo
2064 2064
             foreach ($deletes as $column => $values) {
2065 2065
                 //make sure we have unique $values;
2066 2066
                 $values = array_unique($values);
2067
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
2067
+                $query[] = $column.' IN('.implode(",", $values).')';
2068 2068
             }
2069 2069
             return ! empty($query) ? implode(' AND ', $query) : '';
2070 2070
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2080,7 +2080,7 @@  discard block
 block discarded – undo
2080 2080
                                                            . $delete_object[$cpk_field->get_qualified_column()];
2081 2081
                     }
2082 2082
                 }
2083
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2083
+                $ways_to_identify_a_row[] = "(".implode(" AND ", $values_for_each_cpk_for_a_row).")";
2084 2084
             }
2085 2085
             return implode(" OR ", $ways_to_identify_a_row);
2086 2086
         } else {
@@ -2129,9 +2129,9 @@  discard block
 block discarded – undo
2129 2129
                 $column_to_count = '*';
2130 2130
             }
2131 2131
         }
2132
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2133
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2134
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2132
+        $column_to_count = $distinct ? "DISTINCT ".$column_to_count : $column_to_count;
2133
+        $SQL = "SELECT COUNT(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2134
+        return (int) $this->_do_wpdb_query('get_var', array($SQL));
2135 2135
     }
2136 2136
 
2137 2137
 
@@ -2153,13 +2153,13 @@  discard block
 block discarded – undo
2153 2153
             $field_obj = $this->get_primary_key_field();
2154 2154
         }
2155 2155
         $column_to_count = $field_obj->get_qualified_column();
2156
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2156
+        $SQL = "SELECT SUM(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2157 2157
         $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2158 2158
         $data_type = $field_obj->get_wpdb_data_type();
2159 2159
         if ($data_type === '%d' || $data_type === '%s') {
2160
-            return (float)$return_value;
2160
+            return (float) $return_value;
2161 2161
         } else {//must be %f
2162
-            return (float)$return_value;
2162
+            return (float) $return_value;
2163 2163
         }
2164 2164
     }
2165 2165
 
@@ -2180,13 +2180,13 @@  discard block
 block discarded – undo
2180 2180
         //if we're in maintenance mode level 2, DON'T run any queries
2181 2181
         //because level 2 indicates the database needs updating and
2182 2182
         //is probably out of sync with the code
2183
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2183
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
2184 2184
             throw new EE_Error(sprintf(__("Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
2185 2185
                 "event_espresso")));
2186 2186
         }
2187 2187
         /** @type WPDB $wpdb */
2188 2188
         global $wpdb;
2189
-        if (! method_exists($wpdb, $wpdb_method)) {
2189
+        if ( ! method_exists($wpdb, $wpdb_method)) {
2190 2190
             throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2191 2191
                 'event_espresso'), $wpdb_method));
2192 2192
         }
@@ -2198,7 +2198,7 @@  discard block
 block discarded – undo
2198 2198
         $this->show_db_query_if_previously_requested($wpdb->last_query);
2199 2199
         if (WP_DEBUG) {
2200 2200
             $wpdb->show_errors($old_show_errors_value);
2201
-            if (! empty($wpdb->last_error)) {
2201
+            if ( ! empty($wpdb->last_error)) {
2202 2202
                 throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2203 2203
             } elseif ($result === false) {
2204 2204
                 throw new EE_Error(sprintf(__('WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
@@ -2258,7 +2258,7 @@  discard block
 block discarded – undo
2258 2258
                     return $result;
2259 2259
                     break;
2260 2260
             }
2261
-            if (! empty($error_message)) {
2261
+            if ( ! empty($error_message)) {
2262 2262
                 EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2263 2263
                 trigger_error($error_message);
2264 2264
             }
@@ -2334,11 +2334,11 @@  discard block
 block discarded – undo
2334 2334
      */
2335 2335
     private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2336 2336
     {
2337
-        return " FROM " . $model_query_info->get_full_join_sql() .
2338
-               $model_query_info->get_where_sql() .
2339
-               $model_query_info->get_group_by_sql() .
2340
-               $model_query_info->get_having_sql() .
2341
-               $model_query_info->get_order_by_sql() .
2337
+        return " FROM ".$model_query_info->get_full_join_sql().
2338
+               $model_query_info->get_where_sql().
2339
+               $model_query_info->get_group_by_sql().
2340
+               $model_query_info->get_having_sql().
2341
+               $model_query_info->get_order_by_sql().
2342 2342
                $model_query_info->get_limit_sql();
2343 2343
     }
2344 2344
 
@@ -2534,12 +2534,12 @@  discard block
 block discarded – undo
2534 2534
         $related_model = $this->get_related_model_obj($model_name);
2535 2535
         //we're just going to use the query params on the related model's normal get_all query,
2536 2536
         //except add a condition to say to match the current mod
2537
-        if (! isset($query_params['default_where_conditions'])) {
2537
+        if ( ! isset($query_params['default_where_conditions'])) {
2538 2538
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2539 2539
         }
2540 2540
         $this_model_name = $this->get_this_model_name();
2541 2541
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2542
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2542
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2543 2543
         return $related_model->count($query_params, $field_to_count, $distinct);
2544 2544
     }
2545 2545
 
@@ -2559,7 +2559,7 @@  discard block
 block discarded – undo
2559 2559
     public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2560 2560
     {
2561 2561
         $related_model = $this->get_related_model_obj($model_name);
2562
-        if (! is_array($query_params)) {
2562
+        if ( ! is_array($query_params)) {
2563 2563
             EE_Error::doing_it_wrong('EEM_Base::sum_related',
2564 2564
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2565 2565
                     gettype($query_params)), '4.6.0');
@@ -2567,12 +2567,12 @@  discard block
 block discarded – undo
2567 2567
         }
2568 2568
         //we're just going to use the query params on the related model's normal get_all query,
2569 2569
         //except add a condition to say to match the current mod
2570
-        if (! isset($query_params['default_where_conditions'])) {
2570
+        if ( ! isset($query_params['default_where_conditions'])) {
2571 2571
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2572 2572
         }
2573 2573
         $this_model_name = $this->get_this_model_name();
2574 2574
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2575
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2575
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2576 2576
         return $related_model->sum($query_params, $field_to_sum);
2577 2577
     }
2578 2578
 
@@ -2626,7 +2626,7 @@  discard block
 block discarded – undo
2626 2626
                 $field_with_model_name = $field;
2627 2627
             }
2628 2628
         }
2629
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2629
+        if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
2630 2630
             throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2631 2631
                 $this->get_this_model_name()));
2632 2632
         }
@@ -2659,7 +2659,7 @@  discard block
 block discarded – undo
2659 2659
          * @param array    $fields_n_values keys are the fields and values are their new values
2660 2660
          * @param EEM_Base $model           the model used
2661 2661
          */
2662
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2662
+        $field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2663 2663
         if ($this->_satisfies_unique_indexes($field_n_values)) {
2664 2664
             $main_table = $this->_get_main_table();
2665 2665
             $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
@@ -2767,7 +2767,7 @@  discard block
 block discarded – undo
2767 2767
         }
2768 2768
         foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2769 2769
             $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2770
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2770
+            $query_params[0]['OR']['AND*'.$unique_index_name] = $uniqueness_where_params;
2771 2771
         }
2772 2772
         //if there is nothing to base this search on, then we shouldn't find anything
2773 2773
         if (empty($query_params)) {
@@ -2854,7 +2854,7 @@  discard block
 block discarded – undo
2854 2854
             //its not the main table, so we should have already saved the main table's PK which we just inserted
2855 2855
             //so add the fk to the main table as a column
2856 2856
             $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2857
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2857
+            $format_for_insertion[] = '%d'; //yes right now we're only allowing these foreign keys to be INTs
2858 2858
         }
2859 2859
         //insert the new entry
2860 2860
         $result = $this->_do_wpdb_query('insert',
@@ -3060,7 +3060,7 @@  discard block
 block discarded – undo
3060 3060
                     $query_info_carrier,
3061 3061
                     'group_by'
3062 3062
                 );
3063
-            } elseif (! empty ($query_params['group_by'])) {
3063
+            } elseif ( ! empty ($query_params['group_by'])) {
3064 3064
                 $this->_extract_related_model_info_from_query_param(
3065 3065
                     $query_params['group_by'],
3066 3066
                     $query_info_carrier,
@@ -3082,7 +3082,7 @@  discard block
 block discarded – undo
3082 3082
                     $query_info_carrier,
3083 3083
                     'order_by'
3084 3084
                 );
3085
-            } elseif (! empty($query_params['order_by'])) {
3085
+            } elseif ( ! empty($query_params['order_by'])) {
3086 3086
                 $this->_extract_related_model_info_from_query_param(
3087 3087
                     $query_params['order_by'],
3088 3088
                     $query_info_carrier,
@@ -3117,8 +3117,8 @@  discard block
 block discarded – undo
3117 3117
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3118 3118
         $query_param_type
3119 3119
     ) {
3120
-        if (! empty($sub_query_params)) {
3121
-            $sub_query_params = (array)$sub_query_params;
3120
+        if ( ! empty($sub_query_params)) {
3121
+            $sub_query_params = (array) $sub_query_params;
3122 3122
             foreach ($sub_query_params as $param => $possibly_array_of_params) {
3123 3123
                 //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3124 3124
                 $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
@@ -3129,7 +3129,7 @@  discard block
 block discarded – undo
3129 3129
                 //of array('Registration.TXN_ID'=>23)
3130 3130
                 $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3131 3131
                 if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3132
-                    if (! is_array($possibly_array_of_params)) {
3132
+                    if ( ! is_array($possibly_array_of_params)) {
3133 3133
                         throw new EE_Error(sprintf(__("You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
3134 3134
                             "event_espresso"),
3135 3135
                             $param, $possibly_array_of_params));
@@ -3145,7 +3145,7 @@  discard block
 block discarded – undo
3145 3145
                     //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3146 3146
                     //indicating that $possible_array_of_params[1] is actually a field name,
3147 3147
                     //from which we should extract query parameters!
3148
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3148
+                    if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3149 3149
                         throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3150 3150
                             "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3151 3151
                     }
@@ -3175,8 +3175,8 @@  discard block
 block discarded – undo
3175 3175
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3176 3176
         $query_param_type
3177 3177
     ) {
3178
-        if (! empty($sub_query_params)) {
3179
-            if (! is_array($sub_query_params)) {
3178
+        if ( ! empty($sub_query_params)) {
3179
+            if ( ! is_array($sub_query_params)) {
3180 3180
                 throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3181 3181
                     $sub_query_params));
3182 3182
             }
@@ -3205,7 +3205,7 @@  discard block
 block discarded – undo
3205 3205
      */
3206 3206
     public function _create_model_query_info_carrier($query_params)
3207 3207
     {
3208
-        if (! is_array($query_params)) {
3208
+        if ( ! is_array($query_params)) {
3209 3209
             EE_Error::doing_it_wrong(
3210 3210
                 'EEM_Base::_create_model_query_info_carrier',
3211 3211
                 sprintf(
@@ -3281,7 +3281,7 @@  discard block
 block discarded – undo
3281 3281
         //set limit
3282 3282
         if (array_key_exists('limit', $query_params)) {
3283 3283
             if (is_array($query_params['limit'])) {
3284
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3284
+                if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
3285 3285
                     $e = sprintf(
3286 3286
                         __(
3287 3287
                             "Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
@@ -3289,12 +3289,12 @@  discard block
 block discarded – undo
3289 3289
                         ),
3290 3290
                         http_build_query($query_params['limit'])
3291 3291
                     );
3292
-                    throw new EE_Error($e . "|" . $e);
3292
+                    throw new EE_Error($e."|".$e);
3293 3293
                 }
3294 3294
                 //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3295
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3296
-            } elseif (! empty ($query_params['limit'])) {
3297
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3295
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit'][0].",".$query_params['limit'][1]);
3296
+            } elseif ( ! empty ($query_params['limit'])) {
3297
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit']);
3298 3298
             }
3299 3299
         }
3300 3300
         //set order by
@@ -3326,10 +3326,10 @@  discard block
 block discarded – undo
3326 3326
                 $order_array = array();
3327 3327
                 foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3328 3328
                     $order = $this->_extract_order($order);
3329
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3329
+                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by).SP.$order;
3330 3330
                 }
3331
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3332
-            } elseif (! empty ($query_params['order_by'])) {
3331
+                $query_object->set_order_by_sql(" ORDER BY ".implode(",", $order_array));
3332
+            } elseif ( ! empty ($query_params['order_by'])) {
3333 3333
                 $this->_extract_related_model_info_from_query_param(
3334 3334
                     $query_params['order_by'],
3335 3335
                     $query_object,
@@ -3340,18 +3340,18 @@  discard block
 block discarded – undo
3340 3340
                     ? $this->_extract_order($query_params['order'])
3341 3341
                     : 'DESC';
3342 3342
                 $query_object->set_order_by_sql(
3343
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3343
+                    " ORDER BY ".$this->_deduce_column_name_from_query_param($query_params['order_by']).SP.$order
3344 3344
                 );
3345 3345
             }
3346 3346
         }
3347 3347
         //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3348
-        if (! array_key_exists('order_by', $query_params)
3348
+        if ( ! array_key_exists('order_by', $query_params)
3349 3349
             && array_key_exists('order', $query_params)
3350 3350
             && ! empty($query_params['order'])
3351 3351
         ) {
3352 3352
             $pk_field = $this->get_primary_key_field();
3353 3353
             $order = $this->_extract_order($query_params['order']);
3354
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3354
+            $query_object->set_order_by_sql(" ORDER BY ".$pk_field->get_qualified_column().SP.$order);
3355 3355
         }
3356 3356
         //set group by
3357 3357
         if (array_key_exists('group_by', $query_params)) {
@@ -3361,10 +3361,10 @@  discard block
 block discarded – undo
3361 3361
                 foreach ($query_params['group_by'] as $field_name_to_group_by) {
3362 3362
                     $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3363 3363
                 }
3364
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3365
-            } elseif (! empty ($query_params['group_by'])) {
3364
+                $query_object->set_group_by_sql(" GROUP BY ".implode(", ", $group_by_array));
3365
+            } elseif ( ! empty ($query_params['group_by'])) {
3366 3366
                 $query_object->set_group_by_sql(
3367
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3367
+                    " GROUP BY ".$this->_deduce_column_name_from_query_param($query_params['group_by'])
3368 3368
                 );
3369 3369
             }
3370 3370
         }
@@ -3374,7 +3374,7 @@  discard block
 block discarded – undo
3374 3374
         }
3375 3375
         //now, just verify they didn't pass anything wack
3376 3376
         foreach ($query_params as $query_key => $query_value) {
3377
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3377
+            if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
3378 3378
                 throw new EE_Error(
3379 3379
                     sprintf(
3380 3380
                         __(
@@ -3468,22 +3468,22 @@  discard block
 block discarded – undo
3468 3468
         $where_query_params = array()
3469 3469
     ) {
3470 3470
         $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3471
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3471
+        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3472 3472
             throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3473 3473
                 "event_espresso"), $use_default_where_conditions,
3474 3474
                 implode(", ", $allowed_used_default_where_conditions_values)));
3475 3475
         }
3476 3476
         $universal_query_params = array();
3477
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3477
+        if ($this->_should_use_default_where_conditions($use_default_where_conditions, true)) {
3478 3478
             $universal_query_params = $this->_get_default_where_conditions();
3479
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3479
+        } else if ($this->_should_use_minimum_where_conditions($use_default_where_conditions, true)) {
3480 3480
             $universal_query_params = $this->_get_minimum_where_conditions();
3481 3481
         }
3482 3482
         foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3483 3483
             $related_model = $this->get_related_model_obj($model_name);
3484
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3484
+            if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
3485 3485
                 $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3486
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3486
+            } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
3487 3487
                 $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3488 3488
             } else {
3489 3489
                 //we don't want to add full or even minimum default where conditions from this model, so just continue
@@ -3516,7 +3516,7 @@  discard block
 block discarded – undo
3516 3516
      * @param bool $for_this_model false means this is for OTHER related models
3517 3517
      * @return bool
3518 3518
      */
3519
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3519
+    private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
3520 3520
     {
3521 3521
         return (
3522 3522
                    $for_this_model
@@ -3595,7 +3595,7 @@  discard block
 block discarded – undo
3595 3595
     ) {
3596 3596
         $null_friendly_where_conditions = array();
3597 3597
         $none_overridden = true;
3598
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3598
+        $or_condition_key_for_defaults = 'OR*'.get_class($model);
3599 3599
         foreach ($default_where_conditions as $key => $val) {
3600 3600
             if (isset($provided_where_conditions[$key])) {
3601 3601
                 $none_overridden = false;
@@ -3713,7 +3713,7 @@  discard block
 block discarded – undo
3713 3713
             foreach ($tables as $table_obj) {
3714 3714
                 $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3715 3715
                                        . $table_obj->get_fully_qualified_pk_column();
3716
-                if (! in_array($qualified_pk_column, $selects)) {
3716
+                if ( ! in_array($qualified_pk_column, $selects)) {
3717 3717
                     $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3718 3718
                 }
3719 3719
             }
@@ -3799,9 +3799,9 @@  discard block
 block discarded – undo
3799 3799
         //and
3800 3800
         //check if it's a field on a related model
3801 3801
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3802
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3802
+            if (strpos($query_param, $valid_related_model_name.".") === 0) {
3803 3803
                 $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3804
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3804
+                $query_param = substr($query_param, strlen($valid_related_model_name."."));
3805 3805
                 if ($query_param === '') {
3806 3806
                     //nothing left to $query_param
3807 3807
                     //we should actually end in a field name, not a model like this!
@@ -3887,7 +3887,7 @@  discard block
 block discarded – undo
3887 3887
     {
3888 3888
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3889 3889
         if ($SQL) {
3890
-            return " WHERE " . $SQL;
3890
+            return " WHERE ".$SQL;
3891 3891
         } else {
3892 3892
             return '';
3893 3893
         }
@@ -3907,7 +3907,7 @@  discard block
 block discarded – undo
3907 3907
     {
3908 3908
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3909 3909
         if ($SQL) {
3910
-            return " HAVING " . $SQL;
3910
+            return " HAVING ".$SQL;
3911 3911
         } else {
3912 3912
             return '';
3913 3913
         }
@@ -3927,11 +3927,11 @@  discard block
 block discarded – undo
3927 3927
      */
3928 3928
     protected function _get_field_on_model($field_name, $model_name)
3929 3929
     {
3930
-        $model_class = 'EEM_' . $model_name;
3931
-        $model_filepath = $model_class . ".model.php";
3930
+        $model_class = 'EEM_'.$model_name;
3931
+        $model_filepath = $model_class.".model.php";
3932 3932
         if (is_readable($model_filepath)) {
3933 3933
             require_once($model_filepath);
3934
-            $model_instance = call_user_func($model_name . "::instance");
3934
+            $model_instance = call_user_func($model_name."::instance");
3935 3935
             /* @var $model_instance EEM_Base */
3936 3936
             return $model_instance->field_settings_for($field_name);
3937 3937
         } else {
@@ -3955,7 +3955,7 @@  discard block
 block discarded – undo
3955 3955
     {
3956 3956
         $where_clauses = array();
3957 3957
         foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3958
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3958
+            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param); //str_replace("*",'',$query_param);
3959 3959
             if (in_array($query_param, $this->_logic_query_param_keys)) {
3960 3960
                 switch ($query_param) {
3961 3961
                     case 'not':
@@ -3983,7 +3983,7 @@  discard block
 block discarded – undo
3983 3983
             } else {
3984 3984
                 $field_obj = $this->_deduce_field_from_query_param($query_param);
3985 3985
                 //if it's not a normal field, maybe it's a custom selection?
3986
-                if (! $field_obj) {
3986
+                if ( ! $field_obj) {
3987 3987
                     if (isset($this->_custom_selections[$query_param][1])) {
3988 3988
                         $field_obj = $this->_custom_selections[$query_param][1];
3989 3989
                     } else {
@@ -3992,7 +3992,7 @@  discard block
 block discarded – undo
3992 3992
                     }
3993 3993
                 }
3994 3994
                 $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3995
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3995
+                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param).SP.$op_and_value_sql;
3996 3996
             }
3997 3997
         }
3998 3998
         return $where_clauses ? implode($glue, $where_clauses) : '';
@@ -4013,7 +4013,7 @@  discard block
 block discarded – undo
4013 4013
         if ($field) {
4014 4014
             $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4015 4015
                 $query_param);
4016
-            return $table_alias_prefix . $field->get_qualified_column();
4016
+            return $table_alias_prefix.$field->get_qualified_column();
4017 4017
         } elseif (array_key_exists($query_param, $this->_custom_selections)) {
4018 4018
             //maybe it's custom selection item?
4019 4019
             //if so, just use it as the "column name"
@@ -4060,7 +4060,7 @@  discard block
 block discarded – undo
4060 4060
     {
4061 4061
         if (is_array($op_and_value)) {
4062 4062
             $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4063
-            if (! $operator) {
4063
+            if ( ! $operator) {
4064 4064
                 $php_array_like_string = array();
4065 4065
                 foreach ($op_and_value as $key => $value) {
4066 4066
                     $php_array_like_string[] = "$key=>$value";
@@ -4082,13 +4082,13 @@  discard block
 block discarded – undo
4082 4082
         }
4083 4083
         //check to see if the value is actually another field
4084 4084
         if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4085
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4085
+            return $operator.SP.$this->_deduce_column_name_from_query_param($value);
4086 4086
         } elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4087 4087
             //in this case, the value should be an array, or at least a comma-separated list
4088 4088
             //it will need to handle a little differently
4089 4089
             $cleaned_value = $this->_construct_in_value($value, $field_obj);
4090 4090
             //note: $cleaned_value has already been run through $wpdb->prepare()
4091
-            return $operator . SP . $cleaned_value;
4091
+            return $operator.SP.$cleaned_value;
4092 4092
         } elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4093 4093
             //the value should be an array with count of two.
4094 4094
             if (count($value) !== 2) {
@@ -4103,7 +4103,7 @@  discard block
 block discarded – undo
4103 4103
                 );
4104 4104
             }
4105 4105
             $cleaned_value = $this->_construct_between_value($value, $field_obj);
4106
-            return $operator . SP . $cleaned_value;
4106
+            return $operator.SP.$cleaned_value;
4107 4107
         } elseif (in_array($operator, $this->_null_style_operators)) {
4108 4108
             if ($value !== null) {
4109 4109
                 throw new EE_Error(
@@ -4121,9 +4121,9 @@  discard block
 block discarded – undo
4121 4121
         } elseif ($operator === 'LIKE' && ! is_array($value)) {
4122 4122
             //if the operator is 'LIKE', we want to allow percent signs (%) and not
4123 4123
             //remove other junk. So just treat it as a string.
4124
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4125
-        } elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4126
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4124
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, '%s');
4125
+        } elseif ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4126
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, $field_obj);
4127 4127
         } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4128 4128
             throw new EE_Error(
4129 4129
                 sprintf(
@@ -4135,7 +4135,7 @@  discard block
 block discarded – undo
4135 4135
                     $operator
4136 4136
                 )
4137 4137
             );
4138
-        } elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4138
+        } elseif ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4139 4139
             throw new EE_Error(
4140 4140
                 sprintf(
4141 4141
                     __(
@@ -4176,7 +4176,7 @@  discard block
 block discarded – undo
4176 4176
         foreach ($values as $value) {
4177 4177
             $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4178 4178
         }
4179
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4179
+        return $cleaned_values[0]." AND ".$cleaned_values[1];
4180 4180
     }
4181 4181
 
4182 4182
 
@@ -4217,7 +4217,7 @@  discard block
 block discarded – undo
4217 4217
                                 . $main_table->get_table_name()
4218 4218
                                 . " WHERE FALSE";
4219 4219
         }
4220
-        return "(" . implode(",", $cleaned_values) . ")";
4220
+        return "(".implode(",", $cleaned_values).")";
4221 4221
     }
4222 4222
 
4223 4223
 
@@ -4236,7 +4236,7 @@  discard block
 block discarded – undo
4236 4236
             return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4237 4237
                 $this->_prepare_value_for_use_in_db($value, $field_obj));
4238 4238
         } else {//$field_obj should really just be a data type
4239
-            if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4239
+            if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4240 4240
                 throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4241 4241
                     $field_obj, implode(",", $this->_valid_wpdb_data_types)));
4242 4242
             }
@@ -4356,10 +4356,10 @@  discard block
 block discarded – undo
4356 4356
      */
4357 4357
     public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4358 4358
     {
4359
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4359
+        $table_prefix = str_replace('.', '__', $model_relation_chain).(empty($model_relation_chain) ? '' : '__');
4360 4360
         $qualified_columns = array();
4361 4361
         foreach ($this->field_settings() as $field_name => $field) {
4362
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4362
+            $qualified_columns[] = $table_prefix.$field->get_qualified_column();
4363 4363
         }
4364 4364
         return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4365 4365
     }
@@ -4383,11 +4383,11 @@  discard block
 block discarded – undo
4383 4383
             if ($table_obj instanceof EE_Primary_Table) {
4384 4384
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4385 4385
                     ? $table_obj->get_select_join_limit($limit)
4386
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4386
+                    : SP.$table_obj->get_table_name()." AS ".$table_obj->get_table_alias().SP;
4387 4387
             } elseif ($table_obj instanceof EE_Secondary_Table) {
4388 4388
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4389 4389
                     ? $table_obj->get_select_join_limit_join($limit)
4390
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4390
+                    : SP.$table_obj->get_join_sql($table_alias).SP;
4391 4391
             }
4392 4392
         }
4393 4393
         return $SQL;
@@ -4475,12 +4475,12 @@  discard block
 block discarded – undo
4475 4475
      */
4476 4476
     public function get_related_model_obj($model_name)
4477 4477
     {
4478
-        $model_classname = "EEM_" . $model_name;
4479
-        if (! class_exists($model_classname)) {
4478
+        $model_classname = "EEM_".$model_name;
4479
+        if ( ! class_exists($model_classname)) {
4480 4480
             throw new EE_Error(sprintf(__("You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
4481 4481
                 'event_espresso'), $model_name, $model_classname));
4482 4482
         }
4483
-        return call_user_func($model_classname . "::instance");
4483
+        return call_user_func($model_classname."::instance");
4484 4484
     }
4485 4485
 
4486 4486
 
@@ -4527,7 +4527,7 @@  discard block
 block discarded – undo
4527 4527
     public function related_settings_for($relation_name)
4528 4528
     {
4529 4529
         $relatedModels = $this->relation_settings();
4530
-        if (! array_key_exists($relation_name, $relatedModels)) {
4530
+        if ( ! array_key_exists($relation_name, $relatedModels)) {
4531 4531
             throw new EE_Error(
4532 4532
                 sprintf(
4533 4533
                     __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
@@ -4554,7 +4554,7 @@  discard block
 block discarded – undo
4554 4554
     public function field_settings_for($fieldName)
4555 4555
     {
4556 4556
         $fieldSettings = $this->field_settings(true);
4557
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4557
+        if ( ! array_key_exists($fieldName, $fieldSettings)) {
4558 4558
             throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4559 4559
                 get_class($this)));
4560 4560
         }
@@ -4629,7 +4629,7 @@  discard block
 block discarded – undo
4629 4629
                     break;
4630 4630
                 }
4631 4631
             }
4632
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4632
+            if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4633 4633
                 throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4634 4634
                     get_class($this)));
4635 4635
             }
@@ -4688,7 +4688,7 @@  discard block
 block discarded – undo
4688 4688
      */
4689 4689
     public function get_foreign_key_to($model_name)
4690 4690
     {
4691
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4691
+        if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4692 4692
             foreach ($this->field_settings() as $field) {
4693 4693
                 if (
4694 4694
                     $field instanceof EE_Foreign_Key_Field_Base
@@ -4698,7 +4698,7 @@  discard block
 block discarded – undo
4698 4698
                     break;
4699 4699
                 }
4700 4700
             }
4701
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4701
+            if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4702 4702
                 throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4703 4703
                     'event_espresso'), $model_name, get_class($this)));
4704 4704
             }
@@ -4749,7 +4749,7 @@  discard block
 block discarded – undo
4749 4749
                 foreach ($this->_fields as $fields_corresponding_to_table) {
4750 4750
                     foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4751 4751
                         /** @var $field_obj EE_Model_Field_Base */
4752
-                        if (! $field_obj->is_db_only_field()) {
4752
+                        if ( ! $field_obj->is_db_only_field()) {
4753 4753
                             $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4754 4754
                         }
4755 4755
                     }
@@ -4779,7 +4779,7 @@  discard block
 block discarded – undo
4779 4779
         $count_if_model_has_no_primary_key = 0;
4780 4780
         $has_primary_key = $this->has_primary_key_field();
4781 4781
         $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4782
-        foreach ((array)$rows as $row) {
4782
+        foreach ((array) $rows as $row) {
4783 4783
             if (empty($row)) {
4784 4784
                 //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4785 4785
                 return array();
@@ -4797,7 +4797,7 @@  discard block
 block discarded – undo
4797 4797
                 }
4798 4798
             }
4799 4799
             $classInstance = $this->instantiate_class_from_array_or_object($row);
4800
-            if (! $classInstance) {
4800
+            if ( ! $classInstance) {
4801 4801
                 throw new EE_Error(
4802 4802
                     sprintf(
4803 4803
                         __('Could not create instance of class %s from row %s', 'event_espresso'),
@@ -4866,7 +4866,7 @@  discard block
 block discarded – undo
4866 4866
      */
4867 4867
     public function instantiate_class_from_array_or_object($cols_n_values)
4868 4868
     {
4869
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4869
+        if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
4870 4870
             $cols_n_values = get_object_vars($cols_n_values);
4871 4871
         }
4872 4872
         $primary_key = null;
@@ -4891,7 +4891,7 @@  discard block
 block discarded – undo
4891 4891
         // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4892 4892
         if ($primary_key) {
4893 4893
             $classInstance = $this->get_from_entity_map($primary_key);
4894
-            if (! $classInstance) {
4894
+            if ( ! $classInstance) {
4895 4895
                 $classInstance = EE_Registry::instance()
4896 4896
                                             ->load_class($className,
4897 4897
                                                 array($this_model_fields_n_values, $this->_timezone), true, false);
@@ -4942,12 +4942,12 @@  discard block
 block discarded – undo
4942 4942
     public function add_to_entity_map(EE_Base_Class $object)
4943 4943
     {
4944 4944
         $className = $this->_get_class_name();
4945
-        if (! $object instanceof $className) {
4945
+        if ( ! $object instanceof $className) {
4946 4946
             throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4947 4947
                 is_object($object) ? get_class($object) : $object, $className));
4948 4948
         }
4949 4949
         /** @var $object EE_Base_Class */
4950
-        if (! $object->ID()) {
4950
+        if ( ! $object->ID()) {
4951 4951
             throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4952 4952
                 "event_espresso"), get_class($this)));
4953 4953
         }
@@ -5017,7 +5017,7 @@  discard block
 block discarded – undo
5017 5017
             //there is a primary key on this table and its not set. Use defaults for all its columns
5018 5018
             if ($table_pk_value === null && $table_obj->get_pk_column()) {
5019 5019
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5020
-                    if (! $field_obj->is_db_only_field()) {
5020
+                    if ( ! $field_obj->is_db_only_field()) {
5021 5021
                         //prepare field as if its coming from db
5022 5022
                         $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5023 5023
                         $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
@@ -5026,7 +5026,7 @@  discard block
 block discarded – undo
5026 5026
             } else {
5027 5027
                 //the table's rows existed. Use their values
5028 5028
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5029
-                    if (! $field_obj->is_db_only_field()) {
5029
+                    if ( ! $field_obj->is_db_only_field()) {
5030 5030
                         $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5031 5031
                             $cols_n_values, $field_obj->get_qualified_column(),
5032 5032
                             $field_obj->get_table_column()
@@ -5143,7 +5143,7 @@  discard block
 block discarded – undo
5143 5143
      */
5144 5144
     private function _get_class_name()
5145 5145
     {
5146
-        return "EE_" . $this->get_this_model_name();
5146
+        return "EE_".$this->get_this_model_name();
5147 5147
     }
5148 5148
 
5149 5149
 
@@ -5158,7 +5158,7 @@  discard block
 block discarded – undo
5158 5158
      */
5159 5159
     public function item_name($quantity = 1)
5160 5160
     {
5161
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5161
+        return (int) $quantity === 1 ? $this->singular_item : $this->plural_item;
5162 5162
     }
5163 5163
 
5164 5164
 
@@ -5191,7 +5191,7 @@  discard block
 block discarded – undo
5191 5191
     {
5192 5192
         $className = get_class($this);
5193 5193
         $tagName = "FHEE__{$className}__{$methodName}";
5194
-        if (! has_filter($tagName)) {
5194
+        if ( ! has_filter($tagName)) {
5195 5195
             throw new EE_Error(
5196 5196
                 sprintf(
5197 5197
                     __('Method %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
@@ -5417,7 +5417,7 @@  discard block
 block discarded – undo
5417 5417
         $key_vals_in_combined_pk = array();
5418 5418
         parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5419 5419
         foreach ($key_fields as $key_field_name => $field_obj) {
5420
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5420
+            if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
5421 5421
                 return null;
5422 5422
             }
5423 5423
         }
@@ -5438,7 +5438,7 @@  discard block
 block discarded – undo
5438 5438
     {
5439 5439
         $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5440 5440
         foreach ($keys_it_should_have as $key) {
5441
-            if (! isset($key_vals[$key])) {
5441
+            if ( ! isset($key_vals[$key])) {
5442 5442
                 return false;
5443 5443
             }
5444 5444
         }
@@ -5492,7 +5492,7 @@  discard block
 block discarded – undo
5492 5492
      */
5493 5493
     public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5494 5494
     {
5495
-        if (! is_array($query_params)) {
5495
+        if ( ! is_array($query_params)) {
5496 5496
             EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5497 5497
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5498 5498
                     gettype($query_params)), '4.6.0');
@@ -5584,7 +5584,7 @@  discard block
 block discarded – undo
5584 5584
      */
5585 5585
     public function get_IDs($model_objects, $filter_out_empty_ids = false)
5586 5586
     {
5587
-        if (! $this->has_primary_key_field()) {
5587
+        if ( ! $this->has_primary_key_field()) {
5588 5588
             if (WP_DEBUG) {
5589 5589
                 EE_Error::add_error(
5590 5590
                     __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
@@ -5597,7 +5597,7 @@  discard block
 block discarded – undo
5597 5597
         $IDs = array();
5598 5598
         foreach ($model_objects as $model_object) {
5599 5599
             $id = $model_object->ID();
5600
-            if (! $id) {
5600
+            if ( ! $id) {
5601 5601
                 if ($filter_out_empty_ids) {
5602 5602
                     continue;
5603 5603
                 }
@@ -5693,8 +5693,8 @@  discard block
 block discarded – undo
5693 5693
         $missing_caps = array();
5694 5694
         $cap_restrictions = $this->cap_restrictions($context);
5695 5695
         foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5696
-            if (! EE_Capabilities::instance()
5697
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5696
+            if ( ! EE_Capabilities::instance()
5697
+                                 ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
5698 5698
             ) {
5699 5699
                 $missing_caps[$cap] = $restriction_if_no_cap;
5700 5700
             }
@@ -5845,7 +5845,7 @@  discard block
 block discarded – undo
5845 5845
     {
5846 5846
         foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
5847 5847
             if ($query_param_key === $logic_query_param_key
5848
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
5848
+                || strpos($query_param_key, $logic_query_param_key.'*') === 0
5849 5849
             ) {
5850 5850
                 return true;
5851 5851
             }
Please login to merge, or discard this patch.
Indentation   +5821 added lines, -5821 removed lines patch added patch discarded remove patch
@@ -28,5829 +28,5829 @@
 block discarded – undo
28 28
 abstract class EEM_Base extends EE_Base implements EventEspresso\core\interfaces\ResettableInterface
29 29
 {
30 30
 
31
-    //admin posty
32
-    //basic -> grants access to mine -> if they don't have it, select none
33
-    //*_others -> grants access to others that aren't private, and all mine -> if they don't have it, select mine
34
-    //*_private -> grants full access -> if dont have it, select all mine and others' non-private
35
-    //*_published -> grants access to published -> if they dont have it, select non-published
36
-    //*_global/default/system -> grants access to global items -> if they don't have it, select non-global
37
-    //publish_{thing} -> can change status TO publish; SPECIAL CASE
38
-    //frontend posty
39
-    //by default has access to published
40
-    //basic -> grants access to mine that aren't published, and all published
41
-    //*_others ->grants access to others that aren't private, all mine
42
-    //*_private -> grants full access
43
-    //frontend non-posty
44
-    //like admin posty
45
-    //category-y
46
-    //assign -> grants access to join-table
47
-    //(delete, edit)
48
-    //payment-method-y
49
-    //for each registered payment method,
50
-    //ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
51
-    /**
52
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
53
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
54
-     * They almost always WILL NOT, but it's not necessarily a requirement.
55
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
56
-     *
57
-     * @var boolean
58
-     */
59
-    private $_values_already_prepared_by_model_object = 0;
60
-
61
-    /**
62
-     * when $_values_already_prepared_by_model_object equals this, we assume
63
-     * the data is just like form input that needs to have the model fields'
64
-     * prepare_for_set and prepare_for_use_in_db called on it
65
-     */
66
-    const not_prepared_by_model_object = 0;
67
-
68
-    /**
69
-     * when $_values_already_prepared_by_model_object equals this, we
70
-     * assume this value is coming from a model object and doesn't need to have
71
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
72
-     */
73
-    const prepared_by_model_object = 1;
74
-
75
-    /**
76
-     * when $_values_already_prepared_by_model_object equals this, we assume
77
-     * the values are already to be used in the database (ie no processing is done
78
-     * on them by the model's fields)
79
-     */
80
-    const prepared_for_use_in_db = 2;
81
-
82
-
83
-    protected $singular_item = 'Item';
84
-
85
-    protected $plural_item   = 'Items';
86
-
87
-    /**
88
-     * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
89
-     */
90
-    protected $_tables;
91
-
92
-    /**
93
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
94
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
95
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
96
-     *
97
-     * @var \EE_Model_Field_Base[] $_fields
98
-     */
99
-    protected $_fields;
100
-
101
-    /**
102
-     * array of different kinds of relations
103
-     *
104
-     * @var \EE_Model_Relation_Base[] $_model_relations
105
-     */
106
-    protected $_model_relations;
107
-
108
-    /**
109
-     * @var \EE_Index[] $_indexes
110
-     */
111
-    protected $_indexes = array();
112
-
113
-    /**
114
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
115
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
116
-     * by setting the same columns as used in these queries in the query yourself.
117
-     *
118
-     * @var EE_Default_Where_Conditions
119
-     */
120
-    protected $_default_where_conditions_strategy;
121
-
122
-    /**
123
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
124
-     * This is particularly useful when you want something between 'none' and 'default'
125
-     *
126
-     * @var EE_Default_Where_Conditions
127
-     */
128
-    protected $_minimum_where_conditions_strategy;
129
-
130
-    /**
131
-     * String describing how to find the "owner" of this model's objects.
132
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
133
-     * But when there isn't, this indicates which related model, or transiently-related model,
134
-     * has the foreign key to the wp_users table.
135
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
136
-     * related to events, and events have a foreign key to wp_users.
137
-     * On EEM_Transaction, this would be 'Transaction.Event'
138
-     *
139
-     * @var string
140
-     */
141
-    protected $_model_chain_to_wp_user = '';
142
-
143
-    /**
144
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
145
-     * don't need it (particularly CPT models)
146
-     *
147
-     * @var bool
148
-     */
149
-    protected $_ignore_where_strategy = false;
150
-
151
-    /**
152
-     * String used in caps relating to this model. Eg, if the caps relating to this
153
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
154
-     *
155
-     * @var string. If null it hasn't been initialized yet. If false then we
156
-     * have indicated capabilities don't apply to this
157
-     */
158
-    protected $_caps_slug = null;
159
-
160
-    /**
161
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
162
-     * and next-level keys are capability names, and each's value is a
163
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
164
-     * they specify which context to use (ie, frontend, backend, edit or delete)
165
-     * and then each capability in the corresponding sub-array that they're missing
166
-     * adds the where conditions onto the query.
167
-     *
168
-     * @var array
169
-     */
170
-    protected $_cap_restrictions = array(
171
-        self::caps_read       => array(),
172
-        self::caps_read_admin => array(),
173
-        self::caps_edit       => array(),
174
-        self::caps_delete     => array(),
175
-    );
176
-
177
-    /**
178
-     * Array defining which cap restriction generators to use to create default
179
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
180
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
181
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
182
-     * automatically set this to false (not just null).
183
-     *
184
-     * @var EE_Restriction_Generator_Base[]
185
-     */
186
-    protected $_cap_restriction_generators = array();
187
-
188
-    /**
189
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
190
-     */
191
-    const caps_read       = 'read';
192
-
193
-    const caps_read_admin = 'read_admin';
194
-
195
-    const caps_edit       = 'edit';
196
-
197
-    const caps_delete     = 'delete';
198
-
199
-    /**
200
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
201
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
202
-     * maps to 'read' because when looking for relevant permissions we're going to use
203
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
204
-     *
205
-     * @var array
206
-     */
207
-    protected $_cap_contexts_to_cap_action_map = array(
208
-        self::caps_read       => 'read',
209
-        self::caps_read_admin => 'read',
210
-        self::caps_edit       => 'edit',
211
-        self::caps_delete     => 'delete',
212
-    );
213
-
214
-    /**
215
-     * Timezone
216
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
217
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
218
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
219
-     * EE_Datetime_Field data type will have access to it.
220
-     *
221
-     * @var string
222
-     */
223
-    protected $_timezone;
224
-
225
-
226
-    /**
227
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
228
-     * multisite.
229
-     *
230
-     * @var int
231
-     */
232
-    protected static $_model_query_blog_id;
233
-
234
-    /**
235
-     * A copy of _fields, except the array keys are the model names pointed to by
236
-     * the field
237
-     *
238
-     * @var EE_Model_Field_Base[]
239
-     */
240
-    private $_cache_foreign_key_to_fields = array();
241
-
242
-    /**
243
-     * Cached list of all the fields on the model, indexed by their name
244
-     *
245
-     * @var EE_Model_Field_Base[]
246
-     */
247
-    private $_cached_fields = null;
248
-
249
-    /**
250
-     * Cached list of all the fields on the model, except those that are
251
-     * marked as only pertinent to the database
252
-     *
253
-     * @var EE_Model_Field_Base[]
254
-     */
255
-    private $_cached_fields_non_db_only = null;
256
-
257
-    /**
258
-     * A cached reference to the primary key for quick lookup
259
-     *
260
-     * @var EE_Model_Field_Base
261
-     */
262
-    private $_primary_key_field = null;
263
-
264
-    /**
265
-     * Flag indicating whether this model has a primary key or not
266
-     *
267
-     * @var boolean
268
-     */
269
-    protected $_has_primary_key_field = null;
270
-
271
-    /**
272
-     * Whether or not this model is based off a table in WP core only (CPTs should set
273
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
274
-     *
275
-     * @var boolean
276
-     */
277
-    protected $_wp_core_model = false;
278
-
279
-    /**
280
-     *    List of valid operators that can be used for querying.
281
-     * The keys are all operators we'll accept, the values are the real SQL
282
-     * operators used
283
-     *
284
-     * @var array
285
-     */
286
-    protected $_valid_operators = array(
287
-        '='           => '=',
288
-        '<='          => '<=',
289
-        '<'           => '<',
290
-        '>='          => '>=',
291
-        '>'           => '>',
292
-        '!='          => '!=',
293
-        'LIKE'        => 'LIKE',
294
-        'like'        => 'LIKE',
295
-        'NOT_LIKE'    => 'NOT LIKE',
296
-        'not_like'    => 'NOT LIKE',
297
-        'NOT LIKE'    => 'NOT LIKE',
298
-        'not like'    => 'NOT LIKE',
299
-        'IN'          => 'IN',
300
-        'in'          => 'IN',
301
-        'NOT_IN'      => 'NOT IN',
302
-        'not_in'      => 'NOT IN',
303
-        'NOT IN'      => 'NOT IN',
304
-        'not in'      => 'NOT IN',
305
-        'between'     => 'BETWEEN',
306
-        'BETWEEN'     => 'BETWEEN',
307
-        'IS_NOT_NULL' => 'IS NOT NULL',
308
-        'is_not_null' => 'IS NOT NULL',
309
-        'IS NOT NULL' => 'IS NOT NULL',
310
-        'is not null' => 'IS NOT NULL',
311
-        'IS_NULL'     => 'IS NULL',
312
-        'is_null'     => 'IS NULL',
313
-        'IS NULL'     => 'IS NULL',
314
-        'is null'     => 'IS NULL',
315
-        'REGEXP'      => 'REGEXP',
316
-        'regexp'      => 'REGEXP',
317
-        'NOT_REGEXP'  => 'NOT REGEXP',
318
-        'not_regexp'  => 'NOT REGEXP',
319
-        'NOT REGEXP'  => 'NOT REGEXP',
320
-        'not regexp'  => 'NOT REGEXP',
321
-    );
322
-
323
-    /**
324
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
325
-     *
326
-     * @var array
327
-     */
328
-    protected $_in_style_operators = array('IN', 'NOT IN');
329
-
330
-    /**
331
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
332
-     * '12-31-2012'"
333
-     *
334
-     * @var array
335
-     */
336
-    protected $_between_style_operators = array('BETWEEN');
337
-
338
-    /**
339
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
340
-     * on a join table.
341
-     *
342
-     * @var array
343
-     */
344
-    protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
345
-
346
-    /**
347
-     * Allowed values for $query_params['order'] for ordering in queries
348
-     *
349
-     * @var array
350
-     */
351
-    protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
352
-
353
-    /**
354
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
355
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
356
-     *
357
-     * @var array
358
-     */
359
-    private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
360
-
361
-    /**
362
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
363
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
364
-     *
365
-     * @var array
366
-     */
367
-    private $_allowed_query_params = array(
368
-        0,
369
-        'limit',
370
-        'order_by',
371
-        'group_by',
372
-        'having',
373
-        'force_join',
374
-        'order',
375
-        'on_join_limit',
376
-        'default_where_conditions',
377
-        'caps',
378
-    );
379
-
380
-    /**
381
-     * All the data types that can be used in $wpdb->prepare statements.
382
-     *
383
-     * @var array
384
-     */
385
-    private $_valid_wpdb_data_types = array('%d', '%s', '%f');
386
-
387
-    /**
388
-     *    EE_Registry Object
389
-     *
390
-     * @var    object
391
-     * @access    protected
392
-     */
393
-    protected $EE = null;
394
-
395
-
396
-    /**
397
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
398
-     *
399
-     * @var int
400
-     */
401
-    protected $_show_next_x_db_queries = 0;
402
-
403
-    /**
404
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
405
-     * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
406
-     *
407
-     * @var array
408
-     */
409
-    protected $_custom_selections = array();
410
-
411
-    /**
412
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
413
-     * caches every model object we've fetched from the DB on this request
414
-     *
415
-     * @var array
416
-     */
417
-    protected $_entity_map;
418
-
419
-    /**
420
-     * constant used to show EEM_Base has not yet verified the db on this http request
421
-     */
422
-    const db_verified_none = 0;
423
-
424
-    /**
425
-     * constant used to show EEM_Base has verified the EE core db on this http request,
426
-     * but not the addons' dbs
427
-     */
428
-    const db_verified_core = 1;
429
-
430
-    /**
431
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
432
-     * the EE core db too)
433
-     */
434
-    const db_verified_addons = 2;
435
-
436
-    /**
437
-     * indicates whether an EEM_Base child has already re-verified the DB
438
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
439
-     * looking like EEM_Base::db_verified_*
440
-     *
441
-     * @var int - 0 = none, 1 = core, 2 = addons
442
-     */
443
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
444
-
445
-    /**
446
-     * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
447
-     *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
448
-     *        registrations for non-trashed tickets for non-trashed datetimes)
449
-     */
450
-    const default_where_conditions_all = 'all';
451
-
452
-    /**
453
-     * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
454
-     *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
455
-     *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
456
-     *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
457
-     *        models which share tables with other models, this can return data for the wrong model.
458
-     */
459
-    const default_where_conditions_this_only = 'this_model_only';
460
-
461
-    /**
462
-     * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
463
-     *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
464
-     *        return all registrations related to non-trashed tickets and non-trashed datetimes)
465
-     */
466
-    const default_where_conditions_others_only = 'other_models_only';
467
-
468
-    /**
469
-     * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
470
-     *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
471
-     *        their table with other models, like the Event and Venue models. For example, when querying for events
472
-     *        ordered by their venues' name, this will be sure to only return real events with associated real venues
473
-     *        (regardless of whether those events and venues are trashed)
474
-     *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
475
-     *        events.
476
-     */
477
-    const default_where_conditions_minimum_all = 'minimum';
478
-
479
-    /**
480
-     * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
481
-     *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
482
-     *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
483
-     *        not)
484
-     */
485
-    const default_where_conditions_minimum_others = 'full_this_minimum_others';
486
-
487
-    /**
488
-     * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
489
-     *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
490
-     *        it's possible it will return table entries for other models. You should use
491
-     *        EEM_Base::default_where_conditions_minimum_all instead.
492
-     */
493
-    const default_where_conditions_none = 'none';
494
-
495
-
496
-
497
-    /**
498
-     * About all child constructors:
499
-     * they should define the _tables, _fields and _model_relations arrays.
500
-     * Should ALWAYS be called after child constructor.
501
-     * In order to make the child constructors to be as simple as possible, this parent constructor
502
-     * finalizes constructing all the object's attributes.
503
-     * Generally, rather than requiring a child to code
504
-     * $this->_tables = array(
505
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
506
-     *        ...);
507
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
508
-     * each EE_Table has a function to set the table's alias after the constructor, using
509
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
510
-     * do something similar.
511
-     *
512
-     * @param null $timezone
513
-     * @throws \EE_Error
514
-     */
515
-    protected function __construct($timezone = null)
516
-    {
517
-        // check that the model has not been loaded too soon
518
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
519
-            throw new EE_Error (
520
-                sprintf(
521
-                    __('The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
522
-                        'event_espresso'),
523
-                    get_class($this)
524
-                )
525
-            );
526
-        }
527
-        /**
528
-         * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
529
-         */
530
-        if (empty(EEM_Base::$_model_query_blog_id)) {
531
-            EEM_Base::set_model_query_blog_id();
532
-        }
533
-        /**
534
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
535
-         * just use EE_Register_Model_Extension
536
-         *
537
-         * @var EE_Table_Base[] $_tables
538
-         */
539
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
540
-        foreach ($this->_tables as $table_alias => $table_obj) {
541
-            /** @var $table_obj EE_Table_Base */
542
-            $table_obj->_construct_finalize_with_alias($table_alias);
543
-            if ($table_obj instanceof EE_Secondary_Table) {
544
-                /** @var $table_obj EE_Secondary_Table */
545
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
546
-            }
547
-        }
548
-        /**
549
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
550
-         * EE_Register_Model_Extension
551
-         *
552
-         * @param EE_Model_Field_Base[] $_fields
553
-         */
554
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
555
-        $this->_invalidate_field_caches();
556
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
557
-            if (! array_key_exists($table_alias, $this->_tables)) {
558
-                throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
559
-                    'event_espresso'), $table_alias, implode(",", $this->_fields)));
560
-            }
561
-            foreach ($fields_for_table as $field_name => $field_obj) {
562
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
563
-                //primary key field base has a slightly different _construct_finalize
564
-                /** @var $field_obj EE_Model_Field_Base */
565
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
566
-            }
567
-        }
568
-        // everything is related to Extra_Meta
569
-        if (get_class($this) !== 'EEM_Extra_Meta') {
570
-            //make extra meta related to everything, but don't block deleting things just
571
-            //because they have related extra meta info. For now just orphan those extra meta
572
-            //in the future we should automatically delete them
573
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
574
-        }
575
-        //and change logs
576
-        if (get_class($this) !== 'EEM_Change_Log') {
577
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
578
-        }
579
-        /**
580
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
581
-         * EE_Register_Model_Extension
582
-         *
583
-         * @param EE_Model_Relation_Base[] $_model_relations
584
-         */
585
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
586
-            $this->_model_relations);
587
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
588
-            /** @var $relation_obj EE_Model_Relation_Base */
589
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
590
-        }
591
-        foreach ($this->_indexes as $index_name => $index_obj) {
592
-            /** @var $index_obj EE_Index */
593
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
594
-        }
595
-        $this->set_timezone($timezone);
596
-        //finalize default where condition strategy, or set default
597
-        if (! $this->_default_where_conditions_strategy) {
598
-            //nothing was set during child constructor, so set default
599
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
600
-        }
601
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
602
-        if (! $this->_minimum_where_conditions_strategy) {
603
-            //nothing was set during child constructor, so set default
604
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
605
-        }
606
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
607
-        //if the cap slug hasn't been set, and we haven't set it to false on purpose
608
-        //to indicate to NOT set it, set it to the logical default
609
-        if ($this->_caps_slug === null) {
610
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
611
-        }
612
-        //initialize the standard cap restriction generators if none were specified by the child constructor
613
-        if ($this->_cap_restriction_generators !== false) {
614
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
615
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
616
-                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
617
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
618
-                        new EE_Restriction_Generator_Protected(),
619
-                        $cap_context,
620
-                        $this
621
-                    );
622
-                }
623
-            }
624
-        }
625
-        //if there are cap restriction generators, use them to make the default cap restrictions
626
-        if ($this->_cap_restriction_generators !== false) {
627
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
628
-                if (! $generator_object) {
629
-                    continue;
630
-                }
631
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
632
-                    throw new EE_Error(
633
-                        sprintf(
634
-                            __('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
635
-                                'event_espresso'),
636
-                            $context,
637
-                            $this->get_this_model_name()
638
-                        )
639
-                    );
640
-                }
641
-                $action = $this->cap_action_for_context($context);
642
-                if (! $generator_object->construction_finalized()) {
643
-                    $generator_object->_construct_finalize($this, $action);
644
-                }
645
-            }
646
-        }
647
-        do_action('AHEE__' . get_class($this) . '__construct__end');
648
-    }
649
-
650
-
651
-
652
-    /**
653
-     * Generates the cap restrictions for the given context, or if they were
654
-     * already generated just gets what's cached
655
-     *
656
-     * @param string $context one of EEM_Base::valid_cap_contexts()
657
-     * @return EE_Default_Where_Conditions[]
658
-     */
659
-    protected function _generate_cap_restrictions($context)
660
-    {
661
-        if (isset($this->_cap_restriction_generators[$context])
662
-            && $this->_cap_restriction_generators[$context]
663
-               instanceof
664
-               EE_Restriction_Generator_Base
665
-        ) {
666
-            return $this->_cap_restriction_generators[$context]->generate_restrictions();
667
-        } else {
668
-            return array();
669
-        }
670
-    }
671
-
672
-
673
-
674
-    /**
675
-     * Used to set the $_model_query_blog_id static property.
676
-     *
677
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
678
-     *                      value for get_current_blog_id() will be used.
679
-     */
680
-    public static function set_model_query_blog_id($blog_id = 0)
681
-    {
682
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
683
-    }
684
-
685
-
686
-
687
-    /**
688
-     * Returns whatever is set as the internal $model_query_blog_id.
689
-     *
690
-     * @return int
691
-     */
692
-    public static function get_model_query_blog_id()
693
-    {
694
-        return EEM_Base::$_model_query_blog_id;
695
-    }
696
-
697
-
698
-
699
-    /**
700
-     *        This function is a singleton method used to instantiate the Espresso_model object
701
-     *
702
-     * @access public
703
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
704
-     *                         incoming timezone data that gets saved).  Note this just sends the timezone info to the
705
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
706
-     *                         timezone in the 'timezone_string' wp option)
707
-     * @return static (as in the concrete child class)
708
-     */
709
-    public static function instance($timezone = null)
710
-    {
711
-        // check if instance of Espresso_model already exists
712
-        if (! static::$_instance instanceof static) {
713
-            // instantiate Espresso_model
714
-            static::$_instance = new static($timezone);
715
-        }
716
-        //we might have a timezone set, let set_timezone decide what to do with it
717
-        static::$_instance->set_timezone($timezone);
718
-        // Espresso_model object
719
-        return static::$_instance;
720
-    }
721
-
722
-
723
-
724
-    /**
725
-     * resets the model and returns it
726
-     *
727
-     * @param null | string $timezone
728
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
729
-     * all its properties reset; if it wasn't instantiated, returns null)
730
-     */
731
-    public static function reset($timezone = null)
732
-    {
733
-        if (static::$_instance instanceof EEM_Base) {
734
-            //let's try to NOT swap out the current instance for a new one
735
-            //because if someone has a reference to it, we can't remove their reference
736
-            //so it's best to keep using the same reference, but change the original object
737
-            //reset all its properties to their original values as defined in the class
738
-            $r = new ReflectionClass(get_class(static::$_instance));
739
-            $static_properties = $r->getStaticProperties();
740
-            foreach ($r->getDefaultProperties() as $property => $value) {
741
-                //don't set instance to null like it was originally,
742
-                //but it's static anyways, and we're ignoring static properties (for now at least)
743
-                if (! isset($static_properties[$property])) {
744
-                    static::$_instance->{$property} = $value;
745
-                }
746
-            }
747
-            //and then directly call its constructor again, like we would if we
748
-            //were creating a new one
749
-            static::$_instance->__construct($timezone);
750
-            return self::instance();
751
-        }
752
-        return null;
753
-    }
754
-
755
-
756
-
757
-    /**
758
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
759
-     *
760
-     * @param  boolean $translated return localized strings or JUST the array.
761
-     * @return array
762
-     * @throws \EE_Error
763
-     */
764
-    public function status_array($translated = false)
765
-    {
766
-        if (! array_key_exists('Status', $this->_model_relations)) {
767
-            return array();
768
-        }
769
-        $model_name = $this->get_this_model_name();
770
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
771
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
772
-        $status_array = array();
773
-        foreach ($stati as $status) {
774
-            $status_array[$status->ID()] = $status->get('STS_code');
775
-        }
776
-        return $translated
777
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
778
-            : $status_array;
779
-    }
780
-
781
-
782
-
783
-    /**
784
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
785
-     *
786
-     * @param array $query_params             {
787
-     * @var array $0 (where) array {
788
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
789
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
790
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
791
-     *                                        conditions based on related models (and even
792
-     *                                        models-related-to-related-models) prepend the model's name onto the field
793
-     *                                        name. Eg,
794
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
795
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
796
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
797
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
798
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
799
-     *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
800
-     *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
801
-     *                                        to Venues (even when each of those models actually consisted of two
802
-     *                                        tables). Also, you may chain the model relations together. Eg instead of
803
-     *                                        just having
804
-     *                                        "Venue.VNU_ID", you could have
805
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
806
-     *                                        events are related to Registrations, which are related to Attendees). You
807
-     *                                        can take it even further with
808
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
809
-     *                                        (from the default of '='), change the value to an numerically-indexed
810
-     *                                        array, where the first item in the list is the operator. eg: array(
811
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
812
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
813
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
814
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
815
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
816
-     *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
817
-     *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
818
-     *                                        the operator is IN. Also, values can actually be field names. To indicate
819
-     *                                        the value is a field, simply provide a third array item (true) to the
820
-     *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
821
-     *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
822
-     *                                        Note: you can also use related model field names like you would any other
823
-     *                                        field name. eg:
824
-     *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
825
-     *                                        be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' =>
826
-     *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
827
-     *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
828
-     *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
829
-     *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
830
-     *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
831
-     *                                        to be what you last specified. IE, "AND"s by default, but if you had
832
-     *                                        previously specified to use ORs to join, ORs will continue to be used.
833
-     *                                        So, if you specify to use an "OR" to join conditions, it will continue to
834
-     *                                        "stick" until you specify an AND. eg
835
-     *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
836
-     *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
837
-     *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
838
-     *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
839
-     *                                        array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to place two or more where conditions applying to the same field. eg: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*' character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >>
840
-     *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
841
-     *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
842
-     *                                        too, eg:
843
-     *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
844
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
845
-     *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
846
-     *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
847
-     *                                        Remember when you provide two numbers for the limit, the 1st number is
848
-     *                                        the OFFSET, the 2nd is the LIMIT
849
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
850
-     *                                        can do paging on one-to-many multi-table-joins. Send an array in the
851
-     *                                        following format array('on_join_limit'
852
-     *                                        => array( 'table_alias', array(1,2) ) ).
853
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
854
-     *                                        values are either 'ASC' or 'DESC'.
855
-     *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
856
-     *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
857
-     *                                        DESC..." respectively. Like the
858
-     *                                        'where' conditions, these fields can be on related models. Eg
859
-     *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
860
-     *                                        perfectly valid from any model related to 'Registration' (like Event,
861
-     *                                        Attendee, Price, Datetime, etc.)
862
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
863
-     *                                        'order' specifies whether to order the field specified in 'order_by' in
864
-     *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
865
-     *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
866
-     *                                        order by the primary key. Eg,
867
-     *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
868
-     *                                        //(will join with the Datetime model's table(s) and order by its field
869
-     *                                        DTT_EVT_start) or
870
-     *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
871
-     *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
872
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
873
-     *                                        'group_by'=>'VNU_ID', or
874
-     *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
875
-     *                                        if no
876
-     *                                        $group_by is specified, and a limit is set, automatically groups by the
877
-     *                                        model's primary key (or combined primary keys). This avoids some
878
-     *                                        weirdness that results when using limits, tons of joins, and no group by,
879
-     *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
880
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
881
-     *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
882
-     *                                        results)
883
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
884
-     *                                        array where values are models to be joined in the query.Eg
885
-     *                                        array('Attendee','Payment','Datetime'). You may join with transient
886
-     *                                        models using period, eg "Registration.Transaction.Payment". You will
887
-     *                                        probably only want to do this in hopes of increasing efficiency, as
888
-     *                                        related models which belongs to the current model
889
-     *                                        (ie, the current model has a foreign key to them, like how Registration
890
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
891
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
892
-     *                                        set this to 'none' to disable all default where conditions. Eg, usually
893
-     *                                        soft-deleted objects are filtered-out if you want to include them, set
894
-     *                                        this query param to 'none'. If you want to ONLY disable THIS model's
895
-     *                                        default where conditions set it to 'other_models_only'. If you only want
896
-     *                                        this model's default where conditions added to the query, use
897
-     *                                        'this_model_only'. If you want to use all default where conditions
898
-     *                                        (default), set to 'all'.
899
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
900
-     *                                        we just NOT apply any capabilities/permissions/restrictions and return
901
-     *                                        everything? Or should we only show the current user items they should be
902
-     *                                        able to view on the frontend, backend, edit, or delete? can be set to
903
-     *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
904
-     *                                        }
905
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
906
-     *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
907
-     *                                        again. Array keys are object IDs (if there is a primary key on the model.
908
-     *                                        if not, numerically indexed) Some full examples: get 10 transactions
909
-     *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
910
-     *                                        array( array(
911
-     *                                        'OR'=>array(
912
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
913
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
914
-     *                                        )
915
-     *                                        ),
916
-     *                                        'limit'=>10,
917
-     *                                        'group_by'=>'TXN_ID'
918
-     *                                        ));
919
-     *                                        get all the answers to the question titled "shirt size" for event with id
920
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
921
-     *                                        'Question.QST_display_text'=>'shirt size',
922
-     *                                        'Registration.Event.EVT_ID'=>12
923
-     *                                        ),
924
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
925
-     *                                        ));
926
-     * @throws \EE_Error
927
-     */
928
-    public function get_all($query_params = array())
929
-    {
930
-        if (isset($query_params['limit'])
931
-            && ! isset($query_params['group_by'])
932
-        ) {
933
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
934
-        }
935
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
936
-    }
937
-
938
-
939
-
940
-    /**
941
-     * Modifies the query parameters so we only get back model objects
942
-     * that "belong" to the current user
943
-     *
944
-     * @param array $query_params @see EEM_Base::get_all()
945
-     * @return array like EEM_Base::get_all
946
-     */
947
-    public function alter_query_params_to_only_include_mine($query_params = array())
948
-    {
949
-        $wp_user_field_name = $this->wp_user_field_name();
950
-        if ($wp_user_field_name) {
951
-            $query_params[0][$wp_user_field_name] = get_current_user_id();
952
-        }
953
-        return $query_params;
954
-    }
955
-
956
-
957
-
958
-    /**
959
-     * Returns the name of the field's name that points to the WP_User table
960
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
961
-     * foreign key to the WP_User table)
962
-     *
963
-     * @return string|boolean string on success, boolean false when there is no
964
-     * foreign key to the WP_User table
965
-     */
966
-    public function wp_user_field_name()
967
-    {
968
-        try {
969
-            if (! empty($this->_model_chain_to_wp_user)) {
970
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
971
-                $last_model_name = end($models_to_follow_to_wp_users);
972
-                $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
973
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
974
-            } else {
975
-                $model_with_fk_to_wp_users = $this;
976
-                $model_chain_to_wp_user = '';
977
-            }
978
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
979
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
980
-        } catch (EE_Error $e) {
981
-            return false;
982
-        }
983
-    }
984
-
985
-
986
-
987
-    /**
988
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
989
-     * (or transiently-related model) has a foreign key to the wp_users table;
990
-     * useful for finding if model objects of this type are 'owned' by the current user.
991
-     * This is an empty string when the foreign key is on this model and when it isn't,
992
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
993
-     * (or transiently-related model)
994
-     *
995
-     * @return string
996
-     */
997
-    public function model_chain_to_wp_user()
998
-    {
999
-        return $this->_model_chain_to_wp_user;
1000
-    }
1001
-
1002
-
1003
-
1004
-    /**
1005
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1006
-     * like how registrations don't have a foreign key to wp_users, but the
1007
-     * events they are for are), or is unrelated to wp users.
1008
-     * generally available
1009
-     *
1010
-     * @return boolean
1011
-     */
1012
-    public function is_owned()
1013
-    {
1014
-        if ($this->model_chain_to_wp_user()) {
1015
-            return true;
1016
-        } else {
1017
-            try {
1018
-                $this->get_foreign_key_to('WP_User');
1019
-                return true;
1020
-            } catch (EE_Error $e) {
1021
-                return false;
1022
-            }
1023
-        }
1024
-    }
1025
-
1026
-
1027
-
1028
-    /**
1029
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1030
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1031
-     * the model)
1032
-     *
1033
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1034
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1035
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1036
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1037
-     *                                  override this and set the select to "*", or a specific column name, like
1038
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1039
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1040
-     *                                  the aliases used to refer to this selection, and values are to be
1041
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1042
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1043
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1044
-     * @throws \EE_Error
1045
-     */
1046
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1047
-    {
1048
-        // remember the custom selections, if any, and type cast as array
1049
-        // (unless $columns_to_select is an object, then just set as an empty array)
1050
-        // Note: (array) 'some string' === array( 'some string' )
1051
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1052
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1053
-        $select_expressions = $columns_to_select !== null
1054
-            ? $this->_construct_select_from_input($columns_to_select)
1055
-            : $this->_construct_default_select_sql($model_query_info);
1056
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1057
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
1058
-    }
1059
-
1060
-
1061
-
1062
-    /**
1063
-     * Gets an array of rows from the database just like $wpdb->get_results would,
1064
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
1065
-     * take care of joins, field preparation etc.
1066
-     *
1067
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1068
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1069
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1070
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1071
-     *                                  override this and set the select to "*", or a specific column name, like
1072
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1073
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1074
-     *                                  the aliases used to refer to this selection, and values are to be
1075
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1076
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1077
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1078
-     * @throws \EE_Error
1079
-     */
1080
-    public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1081
-    {
1082
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1083
-    }
1084
-
1085
-
1086
-
1087
-    /**
1088
-     * For creating a custom select statement
1089
-     *
1090
-     * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1091
-     *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1092
-     *                                 SQL, and 1=>is the datatype
1093
-     * @throws EE_Error
1094
-     * @return string
1095
-     */
1096
-    private function _construct_select_from_input($columns_to_select)
1097
-    {
1098
-        if (is_array($columns_to_select)) {
1099
-            $select_sql_array = array();
1100
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
1101
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1102
-                    throw new EE_Error(
1103
-                        sprintf(
1104
-                            __(
1105
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1106
-                                "event_espresso"
1107
-                            ),
1108
-                            $selection_and_datatype,
1109
-                            $alias
1110
-                        )
1111
-                    );
1112
-                }
1113
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1114
-                    throw new EE_Error(
1115
-                        sprintf(
1116
-                            __(
1117
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1118
-                                "event_espresso"
1119
-                            ),
1120
-                            $selection_and_datatype[1],
1121
-                            $selection_and_datatype[0],
1122
-                            $alias,
1123
-                            implode(",", $this->_valid_wpdb_data_types)
1124
-                        )
1125
-                    );
1126
-                }
1127
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1128
-            }
1129
-            $columns_to_select_string = implode(", ", $select_sql_array);
1130
-        } else {
1131
-            $columns_to_select_string = $columns_to_select;
1132
-        }
1133
-        return $columns_to_select_string;
1134
-    }
1135
-
1136
-
1137
-
1138
-    /**
1139
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1140
-     *
1141
-     * @return string
1142
-     * @throws \EE_Error
1143
-     */
1144
-    public function primary_key_name()
1145
-    {
1146
-        return $this->get_primary_key_field()->get_name();
1147
-    }
1148
-
1149
-
1150
-
1151
-    /**
1152
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1153
-     * If there is no primary key on this model, $id is treated as primary key string
1154
-     *
1155
-     * @param mixed $id int or string, depending on the type of the model's primary key
1156
-     * @return EE_Base_Class
1157
-     */
1158
-    public function get_one_by_ID($id)
1159
-    {
1160
-        if ($this->get_from_entity_map($id)) {
1161
-            return $this->get_from_entity_map($id);
1162
-        }
1163
-        return $this->get_one(
1164
-            $this->alter_query_params_to_restrict_by_ID(
1165
-                $id,
1166
-                array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1167
-            )
1168
-        );
1169
-    }
1170
-
1171
-
1172
-
1173
-    /**
1174
-     * Alters query parameters to only get items with this ID are returned.
1175
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1176
-     * or could just be a simple primary key ID
1177
-     *
1178
-     * @param int   $id
1179
-     * @param array $query_params
1180
-     * @return array of normal query params, @see EEM_Base::get_all
1181
-     * @throws \EE_Error
1182
-     */
1183
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1184
-    {
1185
-        if (! isset($query_params[0])) {
1186
-            $query_params[0] = array();
1187
-        }
1188
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
1189
-        if ($conditions_from_id === null) {
1190
-            $query_params[0][$this->primary_key_name()] = $id;
1191
-        } else {
1192
-            //no primary key, so the $id must be from the get_index_primary_key_string()
1193
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1194
-        }
1195
-        return $query_params;
1196
-    }
1197
-
1198
-
1199
-
1200
-    /**
1201
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1202
-     * array. If no item is found, null is returned.
1203
-     *
1204
-     * @param array $query_params like EEM_Base's $query_params variable.
1205
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1206
-     * @throws \EE_Error
1207
-     */
1208
-    public function get_one($query_params = array())
1209
-    {
1210
-        if (! is_array($query_params)) {
1211
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
1212
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1213
-                    gettype($query_params)), '4.6.0');
1214
-            $query_params = array();
1215
-        }
1216
-        $query_params['limit'] = 1;
1217
-        $items = $this->get_all($query_params);
1218
-        if (empty($items)) {
1219
-            return null;
1220
-        } else {
1221
-            return array_shift($items);
1222
-        }
1223
-    }
1224
-
1225
-
1226
-
1227
-    /**
1228
-     * Returns the next x number of items in sequence from the given value as
1229
-     * found in the database matching the given query conditions.
1230
-     *
1231
-     * @param mixed $current_field_value    Value used for the reference point.
1232
-     * @param null  $field_to_order_by      What field is used for the
1233
-     *                                      reference point.
1234
-     * @param int   $limit                  How many to return.
1235
-     * @param array $query_params           Extra conditions on the query.
1236
-     * @param null  $columns_to_select      If left null, then an array of
1237
-     *                                      EE_Base_Class objects is returned,
1238
-     *                                      otherwise you can indicate just the
1239
-     *                                      columns you want returned.
1240
-     * @return EE_Base_Class[]|array
1241
-     * @throws \EE_Error
1242
-     */
1243
-    public function next_x(
1244
-        $current_field_value,
1245
-        $field_to_order_by = null,
1246
-        $limit = 1,
1247
-        $query_params = array(),
1248
-        $columns_to_select = null
1249
-    ) {
1250
-        return $this->_get_consecutive($current_field_value, '>', $field_to_order_by, $limit, $query_params,
1251
-            $columns_to_select);
1252
-    }
1253
-
1254
-
1255
-
1256
-    /**
1257
-     * Returns the previous x number of items in sequence from the given value
1258
-     * as found in the database matching the given query conditions.
1259
-     *
1260
-     * @param mixed $current_field_value    Value used for the reference point.
1261
-     * @param null  $field_to_order_by      What field is used for the
1262
-     *                                      reference point.
1263
-     * @param int   $limit                  How many to return.
1264
-     * @param array $query_params           Extra conditions on the query.
1265
-     * @param null  $columns_to_select      If left null, then an array of
1266
-     *                                      EE_Base_Class objects is returned,
1267
-     *                                      otherwise you can indicate just the
1268
-     *                                      columns you want returned.
1269
-     * @return EE_Base_Class[]|array
1270
-     * @throws \EE_Error
1271
-     */
1272
-    public function previous_x(
1273
-        $current_field_value,
1274
-        $field_to_order_by = null,
1275
-        $limit = 1,
1276
-        $query_params = array(),
1277
-        $columns_to_select = null
1278
-    ) {
1279
-        return $this->_get_consecutive($current_field_value, '<', $field_to_order_by, $limit, $query_params,
1280
-            $columns_to_select);
1281
-    }
1282
-
1283
-
1284
-
1285
-    /**
1286
-     * Returns the next item in sequence from the given value as found in the
1287
-     * database matching the given query conditions.
1288
-     *
1289
-     * @param mixed $current_field_value    Value used for the reference point.
1290
-     * @param null  $field_to_order_by      What field is used for the
1291
-     *                                      reference point.
1292
-     * @param array $query_params           Extra conditions on the query.
1293
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1294
-     *                                      object is returned, otherwise you
1295
-     *                                      can indicate just the columns you
1296
-     *                                      want and a single array indexed by
1297
-     *                                      the columns will be returned.
1298
-     * @return EE_Base_Class|null|array()
1299
-     * @throws \EE_Error
1300
-     */
1301
-    public function next(
1302
-        $current_field_value,
1303
-        $field_to_order_by = null,
1304
-        $query_params = array(),
1305
-        $columns_to_select = null
1306
-    ) {
1307
-        $results = $this->_get_consecutive($current_field_value, '>', $field_to_order_by, 1, $query_params,
1308
-            $columns_to_select);
1309
-        return empty($results) ? null : reset($results);
1310
-    }
1311
-
1312
-
1313
-
1314
-    /**
1315
-     * Returns the previous item in sequence from the given value as found in
1316
-     * the database matching the given query conditions.
1317
-     *
1318
-     * @param mixed $current_field_value    Value used for the reference point.
1319
-     * @param null  $field_to_order_by      What field is used for the
1320
-     *                                      reference point.
1321
-     * @param array $query_params           Extra conditions on the query.
1322
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1323
-     *                                      object is returned, otherwise you
1324
-     *                                      can indicate just the columns you
1325
-     *                                      want and a single array indexed by
1326
-     *                                      the columns will be returned.
1327
-     * @return EE_Base_Class|null|array()
1328
-     * @throws EE_Error
1329
-     */
1330
-    public function previous(
1331
-        $current_field_value,
1332
-        $field_to_order_by = null,
1333
-        $query_params = array(),
1334
-        $columns_to_select = null
1335
-    ) {
1336
-        $results = $this->_get_consecutive($current_field_value, '<', $field_to_order_by, 1, $query_params,
1337
-            $columns_to_select);
1338
-        return empty($results) ? null : reset($results);
1339
-    }
1340
-
1341
-
1342
-
1343
-    /**
1344
-     * Returns the a consecutive number of items in sequence from the given
1345
-     * value as found in the database matching the given query conditions.
1346
-     *
1347
-     * @param mixed  $current_field_value   Value used for the reference point.
1348
-     * @param string $operand               What operand is used for the sequence.
1349
-     * @param string $field_to_order_by     What field is used for the reference point.
1350
-     * @param int    $limit                 How many to return.
1351
-     * @param array  $query_params          Extra conditions on the query.
1352
-     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1353
-     *                                      otherwise you can indicate just the columns you want returned.
1354
-     * @return EE_Base_Class[]|array
1355
-     * @throws EE_Error
1356
-     */
1357
-    protected function _get_consecutive(
1358
-        $current_field_value,
1359
-        $operand = '>',
1360
-        $field_to_order_by = null,
1361
-        $limit = 1,
1362
-        $query_params = array(),
1363
-        $columns_to_select = null
1364
-    ) {
1365
-        //if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1366
-        if (empty($field_to_order_by)) {
1367
-            if ($this->has_primary_key_field()) {
1368
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
1369
-            } else {
1370
-                if (WP_DEBUG) {
1371
-                    throw new EE_Error(__('EEM_Base::_get_consecutive() has been called with no $field_to_order_by argument and there is no primary key on the field.  Please provide the field you would like to use as the base for retrieving the next item(s).',
1372
-                        'event_espresso'));
1373
-                }
1374
-                EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1375
-                return array();
1376
-            }
1377
-        }
1378
-        if (! is_array($query_params)) {
1379
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1380
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1381
-                    gettype($query_params)), '4.6.0');
1382
-            $query_params = array();
1383
-        }
1384
-        //let's add the where query param for consecutive look up.
1385
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1386
-        $query_params['limit'] = $limit;
1387
-        //set direction
1388
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1389
-        $query_params['order_by'] = $operand === '>'
1390
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
1391
-            : array($field_to_order_by => 'DESC') + $incoming_orderby;
1392
-        //if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1393
-        if (empty($columns_to_select)) {
1394
-            return $this->get_all($query_params);
1395
-        } else {
1396
-            //getting just the fields
1397
-            return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1398
-        }
1399
-    }
1400
-
1401
-
1402
-
1403
-    /**
1404
-     * This sets the _timezone property after model object has been instantiated.
1405
-     *
1406
-     * @param null | string $timezone valid PHP DateTimeZone timezone string
1407
-     */
1408
-    public function set_timezone($timezone)
1409
-    {
1410
-        if ($timezone !== null) {
1411
-            $this->_timezone = $timezone;
1412
-        }
1413
-        //note we need to loop through relations and set the timezone on those objects as well.
1414
-        foreach ($this->_model_relations as $relation) {
1415
-            $relation->set_timezone($timezone);
1416
-        }
1417
-        //and finally we do the same for any datetime fields
1418
-        foreach ($this->_fields as $field) {
1419
-            if ($field instanceof EE_Datetime_Field) {
1420
-                $field->set_timezone($timezone);
1421
-            }
1422
-        }
1423
-    }
1424
-
1425
-
1426
-
1427
-    /**
1428
-     * This just returns whatever is set for the current timezone.
1429
-     *
1430
-     * @access public
1431
-     * @return string
1432
-     */
1433
-    public function get_timezone()
1434
-    {
1435
-        //first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1436
-        if (empty($this->_timezone)) {
1437
-            foreach ($this->_fields as $field) {
1438
-                if ($field instanceof EE_Datetime_Field) {
1439
-                    $this->set_timezone($field->get_timezone());
1440
-                    break;
1441
-                }
1442
-            }
1443
-        }
1444
-        //if timezone STILL empty then return the default timezone for the site.
1445
-        if (empty($this->_timezone)) {
1446
-            $this->set_timezone(EEH_DTT_Helper::get_timezone());
1447
-        }
1448
-        return $this->_timezone;
1449
-    }
1450
-
1451
-
1452
-
1453
-    /**
1454
-     * This returns the date formats set for the given field name and also ensures that
1455
-     * $this->_timezone property is set correctly.
1456
-     *
1457
-     * @since 4.6.x
1458
-     * @param string $field_name The name of the field the formats are being retrieved for.
1459
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1460
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1461
-     * @return array formats in an array with the date format first, and the time format last.
1462
-     */
1463
-    public function get_formats_for($field_name, $pretty = false)
1464
-    {
1465
-        $field_settings = $this->field_settings_for($field_name);
1466
-        //if not a valid EE_Datetime_Field then throw error
1467
-        if (! $field_settings instanceof EE_Datetime_Field) {
1468
-            throw new EE_Error(sprintf(__('The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
1469
-                'event_espresso'), $field_name));
1470
-        }
1471
-        //while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1472
-        //the field.
1473
-        $this->_timezone = $field_settings->get_timezone();
1474
-        return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1475
-    }
1476
-
1477
-
1478
-
1479
-    /**
1480
-     * This returns the current time in a format setup for a query on this model.
1481
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1482
-     * it will return:
1483
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1484
-     *  NOW
1485
-     *  - or a unix timestamp (equivalent to time())
1486
-     *
1487
-     * @since 4.6.x
1488
-     * @param string $field_name       The field the current time is needed for.
1489
-     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1490
-     *                                 formatted string matching the set format for the field in the set timezone will
1491
-     *                                 be returned.
1492
-     * @param string $what             Whether to return the string in just the time format, the date format, or both.
1493
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1494
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1495
-     *                                 exception is triggered.
1496
-     */
1497
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1498
-    {
1499
-        $formats = $this->get_formats_for($field_name);
1500
-        $DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1501
-        if ($timestamp) {
1502
-            return $DateTime->format('U');
1503
-        }
1504
-        //not returning timestamp, so return formatted string in timezone.
1505
-        switch ($what) {
1506
-            case 'time' :
1507
-                return $DateTime->format($formats[1]);
1508
-                break;
1509
-            case 'date' :
1510
-                return $DateTime->format($formats[0]);
1511
-                break;
1512
-            default :
1513
-                return $DateTime->format(implode(' ', $formats));
1514
-                break;
1515
-        }
1516
-    }
1517
-
1518
-
1519
-
1520
-    /**
1521
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1522
-     * for the model are.  Returns a DateTime object.
1523
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1524
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1525
-     * ignored.
1526
-     *
1527
-     * @param string $field_name      The field being setup.
1528
-     * @param string $timestring      The date time string being used.
1529
-     * @param string $incoming_format The format for the time string.
1530
-     * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1531
-     *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1532
-     *                                format is
1533
-     *                                'U', this is ignored.
1534
-     * @return DateTime
1535
-     * @throws \EE_Error
1536
-     */
1537
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1538
-    {
1539
-        //just using this to ensure the timezone is set correctly internally
1540
-        $this->get_formats_for($field_name);
1541
-        //load EEH_DTT_Helper
1542
-        $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1543
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1544
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1545
-    }
1546
-
1547
-
1548
-
1549
-    /**
1550
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1551
-     *
1552
-     * @return EE_Table_Base[]
1553
-     */
1554
-    public function get_tables()
1555
-    {
1556
-        return $this->_tables;
1557
-    }
1558
-
1559
-
1560
-
1561
-    /**
1562
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1563
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
1564
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1565
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1566
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1567
-     * model object with EVT_ID = 1
1568
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1569
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1570
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1571
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1572
-     * are not specified)
1573
-     *
1574
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1575
-     *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1576
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
1577
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
1578
-     *                                         we wanted to update only the TXN_details on any Transactions where its
1579
-     *                                         ID=34, we'd use this method as follows:
1580
-     *                                         EEM_Transaction::instance()->update(
1581
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1582
-     *                                         array(array('TXN_ID'=>34)));
1583
-     * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1584
-     *                                         in client code into what's expected to be stored on each field. Eg,
1585
-     *                                         consider updating Question's QST_admin_label field is of type
1586
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
1587
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
1588
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
1589
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1590
-     *                                         TRUE, it is assumed that you've already called
1591
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1592
-     *                                         malicious javascript. However, if
1593
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
1594
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1595
-     *                                         and every other field, before insertion. We provide this parameter
1596
-     *                                         because model objects perform their prepare_for_set function on all
1597
-     *                                         their values, and so don't need to be called again (and in many cases,
1598
-     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1599
-     *                                         prepare_for_set method...)
1600
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1601
-     *                                         in this model's entity map according to $fields_n_values that match
1602
-     *                                         $query_params. This obviously has some overhead, so you can disable it
1603
-     *                                         by setting this to FALSE, but be aware that model objects being used
1604
-     *                                         could get out-of-sync with the database
1605
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1606
-     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1607
-     *                                         bad)
1608
-     * @throws \EE_Error
1609
-     */
1610
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1611
-    {
1612
-        if (! is_array($query_params)) {
1613
-            EE_Error::doing_it_wrong('EEM_Base::update',
1614
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1615
-                    gettype($query_params)), '4.6.0');
1616
-            $query_params = array();
1617
-        }
1618
-        /**
1619
-         * Action called before a model update call has been made.
1620
-         *
1621
-         * @param EEM_Base $model
1622
-         * @param array    $fields_n_values the updated fields and their new values
1623
-         * @param array    $query_params    @see EEM_Base::get_all()
1624
-         */
1625
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1626
-        /**
1627
-         * Filters the fields about to be updated given the query parameters. You can provide the
1628
-         * $query_params to $this->get_all() to find exactly which records will be updated
1629
-         *
1630
-         * @param array    $fields_n_values fields and their new values
1631
-         * @param EEM_Base $model           the model being queried
1632
-         * @param array    $query_params    see EEM_Base::get_all()
1633
-         */
1634
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1635
-            $query_params);
1636
-        //need to verify that, for any entry we want to update, there are entries in each secondary table.
1637
-        //to do that, for each table, verify that it's PK isn't null.
1638
-        $tables = $this->get_tables();
1639
-        //and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
1640
-        //NOTE: we should make this code more efficient by NOT querying twice
1641
-        //before the real update, but that needs to first go through ALPHA testing
1642
-        //as it's dangerous. says Mike August 8 2014
1643
-        //we want to make sure the default_where strategy is ignored
1644
-        $this->_ignore_where_strategy = true;
1645
-        $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1646
-        foreach ($wpdb_select_results as $wpdb_result) {
1647
-            // type cast stdClass as array
1648
-            $wpdb_result = (array)$wpdb_result;
1649
-            //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1650
-            if ($this->has_primary_key_field()) {
1651
-                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1652
-            } else {
1653
-                //if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
1654
-                $main_table_pk_value = null;
1655
-            }
1656
-            //if there are more than 1 tables, we'll want to verify that each table for this model has an entry in the other tables
1657
-            //and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
1658
-            if (count($tables) > 1) {
1659
-                //foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1660
-                //in that table, and so we'll want to insert one
1661
-                foreach ($tables as $table_obj) {
1662
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1663
-                    //if there is no private key for this table on the results, it means there's no entry
1664
-                    //in this table, right? so insert a row in the current table, using any fields available
1665
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1666
-                           && $wpdb_result[$this_table_pk_column])
1667
-                    ) {
1668
-                        $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1669
-                            $main_table_pk_value);
1670
-                        //if we died here, report the error
1671
-                        if (! $success) {
1672
-                            return false;
1673
-                        }
1674
-                    }
1675
-                }
1676
-            }
1677
-            //				//and now check that if we have cached any models by that ID on the model, that
1678
-            //				//they also get updated properly
1679
-            //				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1680
-            //				if( $model_object ){
1681
-            //					foreach( $fields_n_values as $field => $value ){
1682
-            //						$model_object->set($field, $value);
1683
-            //let's make sure default_where strategy is followed now
1684
-            $this->_ignore_where_strategy = false;
1685
-        }
1686
-        //if we want to keep model objects in sync, AND
1687
-        //if this wasn't called from a model object (to update itself)
1688
-        //then we want to make sure we keep all the existing
1689
-        //model objects in sync with the db
1690
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1691
-            if ($this->has_primary_key_field()) {
1692
-                $model_objs_affected_ids = $this->get_col($query_params);
1693
-            } else {
1694
-                //we need to select a bunch of columns and then combine them into the the "index primary key string"s
1695
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1696
-                $model_objs_affected_ids = array();
1697
-                foreach ($models_affected_key_columns as $row) {
1698
-                    $combined_index_key = $this->get_index_primary_key_string($row);
1699
-                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1700
-                }
1701
-            }
1702
-            if (! $model_objs_affected_ids) {
1703
-                //wait wait wait- if nothing was affected let's stop here
1704
-                return 0;
1705
-            }
1706
-            foreach ($model_objs_affected_ids as $id) {
1707
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
1708
-                if ($model_obj_in_entity_map) {
1709
-                    foreach ($fields_n_values as $field => $new_value) {
1710
-                        $model_obj_in_entity_map->set($field, $new_value);
1711
-                    }
1712
-                }
1713
-            }
1714
-            //if there is a primary key on this model, we can now do a slight optimization
1715
-            if ($this->has_primary_key_field()) {
1716
-                //we already know what we want to update. So let's make the query simpler so it's a little more efficient
1717
-                $query_params = array(
1718
-                    array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1719
-                    'limit'                    => count($model_objs_affected_ids),
1720
-                    'default_where_conditions' => EEM_Base::default_where_conditions_none,
1721
-                );
1722
-            }
1723
-        }
1724
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1725
-        $SQL = "UPDATE "
1726
-               . $model_query_info->get_full_join_sql()
1727
-               . " SET "
1728
-               . $this->_construct_update_sql($fields_n_values)
1729
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1730
-        $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1731
-        /**
1732
-         * Action called after a model update call has been made.
1733
-         *
1734
-         * @param EEM_Base $model
1735
-         * @param array    $fields_n_values the updated fields and their new values
1736
-         * @param array    $query_params    @see EEM_Base::get_all()
1737
-         * @param int      $rows_affected
1738
-         */
1739
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1740
-        return $rows_affected;//how many supposedly got updated
1741
-    }
1742
-
1743
-
1744
-
1745
-    /**
1746
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1747
-     * are teh values of the field specified (or by default the primary key field)
1748
-     * that matched the query params. Note that you should pass the name of the
1749
-     * model FIELD, not the database table's column name.
1750
-     *
1751
-     * @param array  $query_params @see EEM_Base::get_all()
1752
-     * @param string $field_to_select
1753
-     * @return array just like $wpdb->get_col()
1754
-     * @throws \EE_Error
1755
-     */
1756
-    public function get_col($query_params = array(), $field_to_select = null)
1757
-    {
1758
-        if ($field_to_select) {
1759
-            $field = $this->field_settings_for($field_to_select);
1760
-        } elseif ($this->has_primary_key_field()) {
1761
-            $field = $this->get_primary_key_field();
1762
-        } else {
1763
-            //no primary key, just grab the first column
1764
-            $field = reset($this->field_settings());
1765
-        }
1766
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1767
-        $select_expressions = $field->get_qualified_column();
1768
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1769
-        return $this->_do_wpdb_query('get_col', array($SQL));
1770
-    }
1771
-
1772
-
1773
-
1774
-    /**
1775
-     * Returns a single column value for a single row from the database
1776
-     *
1777
-     * @param array  $query_params    @see EEM_Base::get_all()
1778
-     * @param string $field_to_select @see EEM_Base::get_col()
1779
-     * @return string
1780
-     * @throws \EE_Error
1781
-     */
1782
-    public function get_var($query_params = array(), $field_to_select = null)
1783
-    {
1784
-        $query_params['limit'] = 1;
1785
-        $col = $this->get_col($query_params, $field_to_select);
1786
-        if (! empty($col)) {
1787
-            return reset($col);
1788
-        } else {
1789
-            return null;
1790
-        }
1791
-    }
1792
-
1793
-
1794
-
1795
-    /**
1796
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1797
-     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1798
-     * injection, but currently no further filtering is done
1799
-     *
1800
-     * @global      $wpdb
1801
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1802
-     *                               be updated to in the DB
1803
-     * @return string of SQL
1804
-     * @throws \EE_Error
1805
-     */
1806
-    public function _construct_update_sql($fields_n_values)
1807
-    {
1808
-        /** @type WPDB $wpdb */
1809
-        global $wpdb;
1810
-        $cols_n_values = array();
1811
-        foreach ($fields_n_values as $field_name => $value) {
1812
-            $field_obj = $this->field_settings_for($field_name);
1813
-            //if the value is NULL, we want to assign the value to that.
1814
-            //wpdb->prepare doesn't really handle that properly
1815
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1816
-            $value_sql = $prepared_value === null ? 'NULL'
1817
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1818
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1819
-        }
1820
-        return implode(",", $cols_n_values);
1821
-    }
1822
-
1823
-
1824
-
1825
-    /**
1826
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1827
-     * Performs a HARD delete, meaning the database row should always be removed,
1828
-     * not just have a flag field on it switched
1829
-     * Wrapper for EEM_Base::delete_permanently()
1830
-     *
1831
-     * @param mixed $id
1832
-     * @return boolean whether the row got deleted or not
1833
-     * @throws \EE_Error
1834
-     */
1835
-    public function delete_permanently_by_ID($id)
1836
-    {
1837
-        return $this->delete_permanently(
1838
-            array(
1839
-                array($this->get_primary_key_field()->get_name() => $id),
1840
-                'limit' => 1,
1841
-            )
1842
-        );
1843
-    }
1844
-
1845
-
1846
-
1847
-    /**
1848
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1849
-     * Wrapper for EEM_Base::delete()
1850
-     *
1851
-     * @param mixed $id
1852
-     * @return boolean whether the row got deleted or not
1853
-     * @throws \EE_Error
1854
-     */
1855
-    public function delete_by_ID($id)
1856
-    {
1857
-        return $this->delete(
1858
-            array(
1859
-                array($this->get_primary_key_field()->get_name() => $id),
1860
-                'limit' => 1,
1861
-            )
1862
-        );
1863
-    }
1864
-
1865
-
1866
-
1867
-    /**
1868
-     * Identical to delete_permanently, but does a "soft" delete if possible,
1869
-     * meaning if the model has a field that indicates its been "trashed" or
1870
-     * "soft deleted", we will just set that instead of actually deleting the rows.
1871
-     *
1872
-     * @see EEM_Base::delete_permanently
1873
-     * @param array   $query_params
1874
-     * @param boolean $allow_blocking
1875
-     * @return int how many rows got deleted
1876
-     * @throws \EE_Error
1877
-     */
1878
-    public function delete($query_params, $allow_blocking = true)
1879
-    {
1880
-        return $this->delete_permanently($query_params, $allow_blocking);
1881
-    }
1882
-
1883
-
1884
-
1885
-    /**
1886
-     * Deletes the model objects that meet the query params. Note: this method is overridden
1887
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1888
-     * as archived, not actually deleted
1889
-     *
1890
-     * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1891
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1892
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1893
-     *                                deletes regardless of other objects which may depend on it. Its generally
1894
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1895
-     *                                DB
1896
-     * @return int how many rows got deleted
1897
-     * @throws \EE_Error
1898
-     */
1899
-    public function delete_permanently($query_params, $allow_blocking = true)
1900
-    {
1901
-        /**
1902
-         * Action called just before performing a real deletion query. You can use the
1903
-         * model and its $query_params to find exactly which items will be deleted
1904
-         *
1905
-         * @param EEM_Base $model
1906
-         * @param array    $query_params   @see EEM_Base::get_all()
1907
-         * @param boolean  $allow_blocking whether or not to allow related model objects
1908
-         *                                 to block (prevent) this deletion
1909
-         */
1910
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1911
-        //some MySQL databases may be running safe mode, which may restrict
1912
-        //deletion if there is no KEY column used in the WHERE statement of a deletion.
1913
-        //to get around this, we first do a SELECT, get all the IDs, and then run another query
1914
-        //to delete them
1915
-        $items_for_deletion = $this->_get_all_wpdb_results($query_params);
1916
-        $deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
1917
-        if ($deletion_where) {
1918
-            //echo "objects for deletion:";var_dump($objects_for_deletion);
1919
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
1920
-            $table_aliases = array_keys($this->_tables);
1921
-            $SQL = "DELETE "
1922
-                   . implode(", ", $table_aliases)
1923
-                   . " FROM "
1924
-                   . $model_query_info->get_full_join_sql()
1925
-                   . " WHERE "
1926
-                   . $deletion_where;
1927
-            //		/echo "delete sql:$SQL";
1928
-            $rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1929
-        } else {
1930
-            $rows_deleted = 0;
1931
-        }
1932
-        //and lastly make sure those items are removed from the entity map; if they could be put into it at all
1933
-        if ($this->has_primary_key_field()) {
1934
-            foreach ($items_for_deletion as $item_for_deletion_row) {
1935
-                $pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
1936
-                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
1937
-                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
1938
-                }
1939
-            }
1940
-        }
1941
-        /**
1942
-         * Action called just after performing a real deletion query. Although at this point the
1943
-         * items should have been deleted
1944
-         *
1945
-         * @param EEM_Base $model
1946
-         * @param array    $query_params @see EEM_Base::get_all()
1947
-         * @param int      $rows_deleted
1948
-         */
1949
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1950
-        return $rows_deleted;//how many supposedly got deleted
1951
-    }
1952
-
1953
-
1954
-
1955
-    /**
1956
-     * Checks all the relations that throw error messages when there are blocking related objects
1957
-     * for related model objects. If there are any related model objects on those relations,
1958
-     * adds an EE_Error, and return true
1959
-     *
1960
-     * @param EE_Base_Class|int $this_model_obj_or_id
1961
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
1962
-     *                                                 should be ignored when determining whether there are related
1963
-     *                                                 model objects which block this model object's deletion. Useful
1964
-     *                                                 if you know A is related to B and are considering deleting A,
1965
-     *                                                 but want to see if A has any other objects blocking its deletion
1966
-     *                                                 before removing the relation between A and B
1967
-     * @return boolean
1968
-     * @throws \EE_Error
1969
-     */
1970
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
1971
-    {
1972
-        //first, if $ignore_this_model_obj was supplied, get its model
1973
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
1974
-            $ignored_model = $ignore_this_model_obj->get_model();
1975
-        } else {
1976
-            $ignored_model = null;
1977
-        }
1978
-        //now check all the relations of $this_model_obj_or_id and see if there
1979
-        //are any related model objects blocking it?
1980
-        $is_blocked = false;
1981
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
1982
-            if ($relation_obj->block_delete_if_related_models_exist()) {
1983
-                //if $ignore_this_model_obj was supplied, then for the query
1984
-                //on that model needs to be told to ignore $ignore_this_model_obj
1985
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
1986
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
1987
-                        array(
1988
-                            $ignored_model->get_primary_key_field()->get_name() => array(
1989
-                                '!=',
1990
-                                $ignore_this_model_obj->ID(),
1991
-                            ),
1992
-                        ),
1993
-                    ));
1994
-                } else {
1995
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
1996
-                }
1997
-                if ($related_model_objects) {
1998
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
1999
-                    $is_blocked = true;
2000
-                }
2001
-            }
2002
-        }
2003
-        return $is_blocked;
2004
-    }
2005
-
2006
-
2007
-
2008
-    /**
2009
-     * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
2010
-     * well.
2011
-     *
2012
-     * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
2013
-     * @param boolean $allow_blocking       if TRUE, matched objects will only be deleted if there is no related model
2014
-     *                                      info that blocks it (ie, there' sno other data that depends on this data);
2015
-     *                                      if false, deletes regardless of other objects which may depend on it. Its
2016
-     *                                      generally advisable to always leave this as TRUE, otherwise you could
2017
-     *                                      easily corrupt your DB
2018
-     * @throws EE_Error
2019
-     * @return string    everything that comes after the WHERE statement.
2020
-     */
2021
-    protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
2022
-    {
2023
-        if ($this->has_primary_key_field()) {
2024
-            $primary_table = $this->_get_main_table();
2025
-            $other_tables = $this->_get_other_tables();
2026
-            $deletes = $query = array();
2027
-            foreach ($objects_for_deletion as $delete_object) {
2028
-                //before we mark this object for deletion,
2029
-                //make sure there's no related objects blocking its deletion (if we're checking)
2030
-                if (
2031
-                    $allow_blocking
2032
-                    && $this->delete_is_blocked_by_related_models(
2033
-                        $delete_object[$primary_table->get_fully_qualified_pk_column()]
2034
-                    )
2035
-                ) {
2036
-                    continue;
2037
-                }
2038
-                //primary table deletes
2039
-                if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
2040
-                    $deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2041
-                }
2042
-                //other tables
2043
-                if (! empty($other_tables)) {
2044
-                    foreach ($other_tables as $ot) {
2045
-                        //first check if we've got the foreign key column here.
2046
-                        if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
2047
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
2048
-                        }
2049
-                        // wait! it's entirely possible that we'll have a the primary key
2050
-                        // for this table in here, if it's a foreign key for one of the other secondary tables
2051
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
2052
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2053
-                        }
2054
-                        // finally, it is possible that the fk for this table is found
2055
-                        // in the fully qualified pk column for the fk table, so let's see if that's there!
2056
-                        if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
2057
-                            $deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2058
-                        }
2059
-                    }
2060
-                }
2061
-            }
2062
-            //we should have deletes now, so let's just go through and setup the where statement
2063
-            foreach ($deletes as $column => $values) {
2064
-                //make sure we have unique $values;
2065
-                $values = array_unique($values);
2066
-                $query[] = $column . ' IN(' . implode(",", $values) . ')';
2067
-            }
2068
-            return ! empty($query) ? implode(' AND ', $query) : '';
2069
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2070
-            $ways_to_identify_a_row = array();
2071
-            $fields = $this->get_combined_primary_key_fields();
2072
-            //note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
2073
-            foreach ($objects_for_deletion as $delete_object) {
2074
-                $values_for_each_cpk_for_a_row = array();
2075
-                foreach ($fields as $cpk_field) {
2076
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
2077
-                        $values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
2078
-                                                           . "="
2079
-                                                           . $delete_object[$cpk_field->get_qualified_column()];
2080
-                    }
2081
-                }
2082
-                $ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2083
-            }
2084
-            return implode(" OR ", $ways_to_identify_a_row);
2085
-        } else {
2086
-            //so there's no primary key and no combined key...
2087
-            //sorry, can't help you
2088
-            throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
2089
-                "event_espresso"), get_class($this)));
2090
-        }
2091
-    }
2092
-
2093
-
2094
-
2095
-    /**
2096
-     * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2097
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2098
-     * column
2099
-     *
2100
-     * @param array  $query_params   like EEM_Base::get_all's
2101
-     * @param string $field_to_count field on model to count by (not column name)
2102
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2103
-     *                               that by the setting $distinct to TRUE;
2104
-     * @return int
2105
-     * @throws \EE_Error
2106
-     */
2107
-    public function count($query_params = array(), $field_to_count = null, $distinct = false)
2108
-    {
2109
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2110
-        if ($field_to_count) {
2111
-            $field_obj = $this->field_settings_for($field_to_count);
2112
-            $column_to_count = $field_obj->get_qualified_column();
2113
-        } elseif ($this->has_primary_key_field()) {
2114
-            $pk_field_obj = $this->get_primary_key_field();
2115
-            $column_to_count = $pk_field_obj->get_qualified_column();
2116
-        } else {
2117
-            //there's no primary key
2118
-            //if we're counting distinct items, and there's no primary key,
2119
-            //we need to list out the columns for distinction;
2120
-            //otherwise we can just use star
2121
-            if ($distinct) {
2122
-                $columns_to_use = array();
2123
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2124
-                    $columns_to_use[] = $field_obj->get_qualified_column();
2125
-                }
2126
-                $column_to_count = implode(',', $columns_to_use);
2127
-            } else {
2128
-                $column_to_count = '*';
2129
-            }
2130
-        }
2131
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2132
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2133
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2134
-    }
2135
-
2136
-
2137
-
2138
-    /**
2139
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2140
-     *
2141
-     * @param array  $query_params like EEM_Base::get_all
2142
-     * @param string $field_to_sum name of field (array key in $_fields array)
2143
-     * @return float
2144
-     * @throws \EE_Error
2145
-     */
2146
-    public function sum($query_params, $field_to_sum = null)
2147
-    {
2148
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2149
-        if ($field_to_sum) {
2150
-            $field_obj = $this->field_settings_for($field_to_sum);
2151
-        } else {
2152
-            $field_obj = $this->get_primary_key_field();
2153
-        }
2154
-        $column_to_count = $field_obj->get_qualified_column();
2155
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2156
-        $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2157
-        $data_type = $field_obj->get_wpdb_data_type();
2158
-        if ($data_type === '%d' || $data_type === '%s') {
2159
-            return (float)$return_value;
2160
-        } else {//must be %f
2161
-            return (float)$return_value;
2162
-        }
2163
-    }
2164
-
2165
-
2166
-
2167
-    /**
2168
-     * Just calls the specified method on $wpdb with the given arguments
2169
-     * Consolidates a little extra error handling code
2170
-     *
2171
-     * @param string $wpdb_method
2172
-     * @param array  $arguments_to_provide
2173
-     * @throws EE_Error
2174
-     * @global wpdb  $wpdb
2175
-     * @return mixed
2176
-     */
2177
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2178
-    {
2179
-        //if we're in maintenance mode level 2, DON'T run any queries
2180
-        //because level 2 indicates the database needs updating and
2181
-        //is probably out of sync with the code
2182
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2183
-            throw new EE_Error(sprintf(__("Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
2184
-                "event_espresso")));
2185
-        }
2186
-        /** @type WPDB $wpdb */
2187
-        global $wpdb;
2188
-        if (! method_exists($wpdb, $wpdb_method)) {
2189
-            throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2190
-                'event_espresso'), $wpdb_method));
2191
-        }
2192
-        if (WP_DEBUG) {
2193
-            $old_show_errors_value = $wpdb->show_errors;
2194
-            $wpdb->show_errors(false);
2195
-        }
2196
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2197
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
2198
-        if (WP_DEBUG) {
2199
-            $wpdb->show_errors($old_show_errors_value);
2200
-            if (! empty($wpdb->last_error)) {
2201
-                throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2202
-            } elseif ($result === false) {
2203
-                throw new EE_Error(sprintf(__('WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
2204
-                    'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2205
-            }
2206
-        } elseif ($result === false) {
2207
-            EE_Error::add_error(
2208
-                sprintf(
2209
-                    __('A database error has occurred. Turn on WP_DEBUG for more information.||A database error occurred doing wpdb method "%1$s", with arguments "%2$s". The error was "%3$s"',
2210
-                        'event_espresso'),
2211
-                    $wpdb_method,
2212
-                    var_export($arguments_to_provide, true),
2213
-                    $wpdb->last_error
2214
-                ),
2215
-                __FILE__,
2216
-                __FUNCTION__,
2217
-                __LINE__
2218
-            );
2219
-        }
2220
-        return $result;
2221
-    }
2222
-
2223
-
2224
-
2225
-    /**
2226
-     * Attempts to run the indicated WPDB method with the provided arguments,
2227
-     * and if there's an error tries to verify the DB is correct. Uses
2228
-     * the static property EEM_Base::$_db_verification_level to determine whether
2229
-     * we should try to fix the EE core db, the addons, or just give up
2230
-     *
2231
-     * @param string $wpdb_method
2232
-     * @param array  $arguments_to_provide
2233
-     * @return mixed
2234
-     */
2235
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2236
-    {
2237
-        /** @type WPDB $wpdb */
2238
-        global $wpdb;
2239
-        $wpdb->last_error = null;
2240
-        $result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2241
-        // was there an error running the query? but we don't care on new activations
2242
-        // (we're going to setup the DB anyway on new activations)
2243
-        if (($result === false || ! empty($wpdb->last_error))
2244
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2245
-        ) {
2246
-            switch (EEM_Base::$_db_verification_level) {
2247
-                case EEM_Base::db_verified_none :
2248
-                    // let's double-check core's DB
2249
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2250
-                    break;
2251
-                case EEM_Base::db_verified_core :
2252
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2253
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2254
-                    break;
2255
-                case EEM_Base::db_verified_addons :
2256
-                    // ummmm... you in trouble
2257
-                    return $result;
2258
-                    break;
2259
-            }
2260
-            if (! empty($error_message)) {
2261
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2262
-                trigger_error($error_message);
2263
-            }
2264
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2265
-        }
2266
-        return $result;
2267
-    }
2268
-
2269
-
2270
-
2271
-    /**
2272
-     * Verifies the EE core database is up-to-date and records that we've done it on
2273
-     * EEM_Base::$_db_verification_level
2274
-     *
2275
-     * @param string $wpdb_method
2276
-     * @param array  $arguments_to_provide
2277
-     * @return string
2278
-     */
2279
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
2280
-    {
2281
-        /** @type WPDB $wpdb */
2282
-        global $wpdb;
2283
-        //ok remember that we've already attempted fixing the core db, in case the problem persists
2284
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2285
-        $error_message = sprintf(
2286
-            __('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2287
-                'event_espresso'),
2288
-            $wpdb->last_error,
2289
-            $wpdb_method,
2290
-            wp_json_encode($arguments_to_provide)
2291
-        );
2292
-        EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2293
-        return $error_message;
2294
-    }
2295
-
2296
-
2297
-
2298
-    /**
2299
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
2300
-     * EEM_Base::$_db_verification_level
2301
-     *
2302
-     * @param $wpdb_method
2303
-     * @param $arguments_to_provide
2304
-     * @return string
2305
-     */
2306
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2307
-    {
2308
-        /** @type WPDB $wpdb */
2309
-        global $wpdb;
2310
-        //ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2311
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2312
-        $error_message = sprintf(
2313
-            __('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2314
-                'event_espresso'),
2315
-            $wpdb->last_error,
2316
-            $wpdb_method,
2317
-            wp_json_encode($arguments_to_provide)
2318
-        );
2319
-        EE_System::instance()->initialize_addons();
2320
-        return $error_message;
2321
-    }
2322
-
2323
-
2324
-
2325
-    /**
2326
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2327
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2328
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2329
-     * ..."
2330
-     *
2331
-     * @param EE_Model_Query_Info_Carrier $model_query_info
2332
-     * @return string
2333
-     */
2334
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2335
-    {
2336
-        return " FROM " . $model_query_info->get_full_join_sql() .
2337
-               $model_query_info->get_where_sql() .
2338
-               $model_query_info->get_group_by_sql() .
2339
-               $model_query_info->get_having_sql() .
2340
-               $model_query_info->get_order_by_sql() .
2341
-               $model_query_info->get_limit_sql();
2342
-    }
2343
-
2344
-
2345
-
2346
-    /**
2347
-     * Set to easily debug the next X queries ran from this model.
2348
-     *
2349
-     * @param int $count
2350
-     */
2351
-    public function show_next_x_db_queries($count = 1)
2352
-    {
2353
-        $this->_show_next_x_db_queries = $count;
2354
-    }
2355
-
2356
-
2357
-
2358
-    /**
2359
-     * @param $sql_query
2360
-     */
2361
-    public function show_db_query_if_previously_requested($sql_query)
2362
-    {
2363
-        if ($this->_show_next_x_db_queries > 0) {
2364
-            echo $sql_query;
2365
-            $this->_show_next_x_db_queries--;
2366
-        }
2367
-    }
2368
-
2369
-
2370
-
2371
-    /**
2372
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2373
-     * There are the 3 cases:
2374
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2375
-     * $otherModelObject has no ID, it is first saved.
2376
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2377
-     * has no ID, it is first saved.
2378
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2379
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2380
-     * join table
2381
-     *
2382
-     * @param        EE_Base_Class                     /int $thisModelObject
2383
-     * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2384
-     * @param string $relationName                     , key in EEM_Base::_relations
2385
-     *                                                 an attendee to a group, you also want to specify which role they
2386
-     *                                                 will have in that group. So you would use this parameter to
2387
-     *                                                 specify array('role-column-name'=>'role-id')
2388
-     * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2389
-     *                                                 to for relation to methods that allow you to further specify
2390
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2391
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
2392
-     *                                                 because these will be inserted in any new rows created as well.
2393
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2394
-     * @throws \EE_Error
2395
-     */
2396
-    public function add_relationship_to(
2397
-        $id_or_obj,
2398
-        $other_model_id_or_obj,
2399
-        $relationName,
2400
-        $extra_join_model_fields_n_values = array()
2401
-    ) {
2402
-        $relation_obj = $this->related_settings_for($relationName);
2403
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2404
-    }
2405
-
2406
-
2407
-
2408
-    /**
2409
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2410
-     * There are the 3 cases:
2411
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2412
-     * error
2413
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2414
-     * an error
2415
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2416
-     *
2417
-     * @param        EE_Base_Class /int $id_or_obj
2418
-     * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2419
-     * @param string $relationName key in EEM_Base::_relations
2420
-     * @return boolean of success
2421
-     * @throws \EE_Error
2422
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2423
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2424
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2425
-     *                             because these will be inserted in any new rows created as well.
2426
-     */
2427
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2428
-    {
2429
-        $relation_obj = $this->related_settings_for($relationName);
2430
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2431
-    }
2432
-
2433
-
2434
-
2435
-    /**
2436
-     * @param mixed           $id_or_obj
2437
-     * @param string          $relationName
2438
-     * @param array           $where_query_params
2439
-     * @param EE_Base_Class[] objects to which relations were removed
2440
-     * @return \EE_Base_Class[]
2441
-     * @throws \EE_Error
2442
-     */
2443
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2444
-    {
2445
-        $relation_obj = $this->related_settings_for($relationName);
2446
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2447
-    }
2448
-
2449
-
2450
-
2451
-    /**
2452
-     * Gets all the related items of the specified $model_name, using $query_params.
2453
-     * Note: by default, we remove the "default query params"
2454
-     * because we want to get even deleted items etc.
2455
-     *
2456
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2457
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
2458
-     * @param array  $query_params like EEM_Base::get_all
2459
-     * @return EE_Base_Class[]
2460
-     * @throws \EE_Error
2461
-     */
2462
-    public function get_all_related($id_or_obj, $model_name, $query_params = null)
2463
-    {
2464
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2465
-        $relation_settings = $this->related_settings_for($model_name);
2466
-        return $relation_settings->get_all_related($model_obj, $query_params);
2467
-    }
2468
-
2469
-
2470
-
2471
-    /**
2472
-     * Deletes all the model objects across the relation indicated by $model_name
2473
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
2474
-     * However, if the model objects can't be deleted because of blocking related model objects, then
2475
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2476
-     *
2477
-     * @param EE_Base_Class|int|string $id_or_obj
2478
-     * @param string                   $model_name
2479
-     * @param array                    $query_params
2480
-     * @return int how many deleted
2481
-     * @throws \EE_Error
2482
-     */
2483
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
2484
-    {
2485
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2486
-        $relation_settings = $this->related_settings_for($model_name);
2487
-        return $relation_settings->delete_all_related($model_obj, $query_params);
2488
-    }
2489
-
2490
-
2491
-
2492
-    /**
2493
-     * Hard deletes all the model objects across the relation indicated by $model_name
2494
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
2495
-     * the model objects can't be hard deleted because of blocking related model objects,
2496
-     * just does a soft-delete on them instead.
2497
-     *
2498
-     * @param EE_Base_Class|int|string $id_or_obj
2499
-     * @param string                   $model_name
2500
-     * @param array                    $query_params
2501
-     * @return int how many deleted
2502
-     * @throws \EE_Error
2503
-     */
2504
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2505
-    {
2506
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2507
-        $relation_settings = $this->related_settings_for($model_name);
2508
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
2509
-    }
2510
-
2511
-
2512
-
2513
-    /**
2514
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2515
-     * unless otherwise specified in the $query_params
2516
-     *
2517
-     * @param        int             /EE_Base_Class $id_or_obj
2518
-     * @param string $model_name     like 'Event', or 'Registration'
2519
-     * @param array  $query_params   like EEM_Base::get_all's
2520
-     * @param string $field_to_count name of field to count by. By default, uses primary key
2521
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2522
-     *                               that by the setting $distinct to TRUE;
2523
-     * @return int
2524
-     * @throws \EE_Error
2525
-     */
2526
-    public function count_related(
2527
-        $id_or_obj,
2528
-        $model_name,
2529
-        $query_params = array(),
2530
-        $field_to_count = null,
2531
-        $distinct = false
2532
-    ) {
2533
-        $related_model = $this->get_related_model_obj($model_name);
2534
-        //we're just going to use the query params on the related model's normal get_all query,
2535
-        //except add a condition to say to match the current mod
2536
-        if (! isset($query_params['default_where_conditions'])) {
2537
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2538
-        }
2539
-        $this_model_name = $this->get_this_model_name();
2540
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2541
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2542
-        return $related_model->count($query_params, $field_to_count, $distinct);
2543
-    }
2544
-
2545
-
2546
-
2547
-    /**
2548
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
2549
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2550
-     *
2551
-     * @param        int           /EE_Base_Class $id_or_obj
2552
-     * @param string $model_name   like 'Event', or 'Registration'
2553
-     * @param array  $query_params like EEM_Base::get_all's
2554
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
2555
-     * @return float
2556
-     * @throws \EE_Error
2557
-     */
2558
-    public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2559
-    {
2560
-        $related_model = $this->get_related_model_obj($model_name);
2561
-        if (! is_array($query_params)) {
2562
-            EE_Error::doing_it_wrong('EEM_Base::sum_related',
2563
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2564
-                    gettype($query_params)), '4.6.0');
2565
-            $query_params = array();
2566
-        }
2567
-        //we're just going to use the query params on the related model's normal get_all query,
2568
-        //except add a condition to say to match the current mod
2569
-        if (! isset($query_params['default_where_conditions'])) {
2570
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2571
-        }
2572
-        $this_model_name = $this->get_this_model_name();
2573
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2574
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2575
-        return $related_model->sum($query_params, $field_to_sum);
2576
-    }
2577
-
2578
-
2579
-
2580
-    /**
2581
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2582
-     * $modelObject
2583
-     *
2584
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2585
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2586
-     * @param array               $query_params     like EEM_Base::get_all's
2587
-     * @return EE_Base_Class
2588
-     * @throws \EE_Error
2589
-     */
2590
-    public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2591
-    {
2592
-        $query_params['limit'] = 1;
2593
-        $results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2594
-        if ($results) {
2595
-            return array_shift($results);
2596
-        } else {
2597
-            return null;
2598
-        }
2599
-    }
2600
-
2601
-
2602
-
2603
-    /**
2604
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2605
-     *
2606
-     * @return string
2607
-     */
2608
-    public function get_this_model_name()
2609
-    {
2610
-        return str_replace("EEM_", "", get_class($this));
2611
-    }
2612
-
2613
-
2614
-
2615
-    /**
2616
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2617
-     *
2618
-     * @return EE_Any_Foreign_Model_Name_Field
2619
-     * @throws EE_Error
2620
-     */
2621
-    public function get_field_containing_related_model_name()
2622
-    {
2623
-        foreach ($this->field_settings(true) as $field) {
2624
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2625
-                $field_with_model_name = $field;
2626
-            }
2627
-        }
2628
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2629
-            throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2630
-                $this->get_this_model_name()));
2631
-        }
2632
-        return $field_with_model_name;
2633
-    }
2634
-
2635
-
2636
-
2637
-    /**
2638
-     * Inserts a new entry into the database, for each table.
2639
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2640
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2641
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
2642
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
2643
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2644
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2645
-     *
2646
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2647
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2648
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2649
-     *                              of EEM_Base)
2650
-     * @return int new primary key on main table that got inserted
2651
-     * @throws EE_Error
2652
-     */
2653
-    public function insert($field_n_values)
2654
-    {
2655
-        /**
2656
-         * Filters the fields and their values before inserting an item using the models
2657
-         *
2658
-         * @param array    $fields_n_values keys are the fields and values are their new values
2659
-         * @param EEM_Base $model           the model used
2660
-         */
2661
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2662
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
2663
-            $main_table = $this->_get_main_table();
2664
-            $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2665
-            if ($new_id !== false) {
2666
-                foreach ($this->_get_other_tables() as $other_table) {
2667
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2668
-                }
2669
-            }
2670
-            /**
2671
-             * Done just after attempting to insert a new model object
2672
-             *
2673
-             * @param EEM_Base   $model           used
2674
-             * @param array      $fields_n_values fields and their values
2675
-             * @param int|string the              ID of the newly-inserted model object
2676
-             */
2677
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2678
-            return $new_id;
2679
-        } else {
2680
-            return false;
2681
-        }
2682
-    }
2683
-
2684
-
2685
-
2686
-    /**
2687
-     * Checks that the result would satisfy the unique indexes on this model
2688
-     *
2689
-     * @param array  $field_n_values
2690
-     * @param string $action
2691
-     * @return boolean
2692
-     * @throws \EE_Error
2693
-     */
2694
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2695
-    {
2696
-        foreach ($this->unique_indexes() as $index_name => $index) {
2697
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2698
-            if ($this->exists(array($uniqueness_where_params))) {
2699
-                EE_Error::add_error(
2700
-                    sprintf(
2701
-                        __(
2702
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2703
-                            "event_espresso"
2704
-                        ),
2705
-                        $action,
2706
-                        $this->_get_class_name(),
2707
-                        $index_name,
2708
-                        implode(",", $index->field_names()),
2709
-                        http_build_query($uniqueness_where_params)
2710
-                    ),
2711
-                    __FILE__,
2712
-                    __FUNCTION__,
2713
-                    __LINE__
2714
-                );
2715
-                return false;
2716
-            }
2717
-        }
2718
-        return true;
2719
-    }
2720
-
2721
-
2722
-
2723
-    /**
2724
-     * Checks the database for an item that conflicts (ie, if this item were
2725
-     * saved to the DB would break some uniqueness requirement, like a primary key
2726
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
2727
-     * can be either an EE_Base_Class or an array of fields n values
2728
-     *
2729
-     * @param EE_Base_Class|array $obj_or_fields_array
2730
-     * @param boolean             $include_primary_key whether to use the model object's primary key
2731
-     *                                                 when looking for conflicts
2732
-     *                                                 (ie, if false, we ignore the model object's primary key
2733
-     *                                                 when finding "conflicts". If true, it's also considered).
2734
-     *                                                 Only works for INT primary key,
2735
-     *                                                 STRING primary keys cannot be ignored
2736
-     * @throws EE_Error
2737
-     * @return EE_Base_Class|array
2738
-     */
2739
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2740
-    {
2741
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
2742
-            $fields_n_values = $obj_or_fields_array->model_field_array();
2743
-        } elseif (is_array($obj_or_fields_array)) {
2744
-            $fields_n_values = $obj_or_fields_array;
2745
-        } else {
2746
-            throw new EE_Error(
2747
-                sprintf(
2748
-                    __(
2749
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2750
-                        "event_espresso"
2751
-                    ),
2752
-                    get_class($this),
2753
-                    $obj_or_fields_array
2754
-                )
2755
-            );
2756
-        }
2757
-        $query_params = array();
2758
-        if ($this->has_primary_key_field()
2759
-            && ($include_primary_key
2760
-                || $this->get_primary_key_field()
2761
-                   instanceof
2762
-                   EE_Primary_Key_String_Field)
2763
-            && isset($fields_n_values[$this->primary_key_name()])
2764
-        ) {
2765
-            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2766
-        }
2767
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2768
-            $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2769
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2770
-        }
2771
-        //if there is nothing to base this search on, then we shouldn't find anything
2772
-        if (empty($query_params)) {
2773
-            return array();
2774
-        } else {
2775
-            return $this->get_one($query_params);
2776
-        }
2777
-    }
2778
-
2779
-
2780
-
2781
-    /**
2782
-     * Like count, but is optimized and returns a boolean instead of an int
2783
-     *
2784
-     * @param array $query_params
2785
-     * @return boolean
2786
-     * @throws \EE_Error
2787
-     */
2788
-    public function exists($query_params)
2789
-    {
2790
-        $query_params['limit'] = 1;
2791
-        return $this->count($query_params) > 0;
2792
-    }
2793
-
2794
-
2795
-
2796
-    /**
2797
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
2798
-     *
2799
-     * @param int|string $id
2800
-     * @return boolean
2801
-     * @throws \EE_Error
2802
-     */
2803
-    public function exists_by_ID($id)
2804
-    {
2805
-        return $this->exists(
2806
-            array(
2807
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
2808
-                array(
2809
-                    $this->primary_key_name() => $id,
2810
-                ),
2811
-            )
2812
-        );
2813
-    }
2814
-
2815
-
2816
-
2817
-    /**
2818
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2819
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2820
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2821
-     * on the main table)
2822
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
2823
-     * cases where we want to call it directly rather than via insert().
2824
-     *
2825
-     * @access   protected
2826
-     * @param EE_Table_Base $table
2827
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2828
-     *                                       float
2829
-     * @param int           $new_id          for now we assume only int keys
2830
-     * @throws EE_Error
2831
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2832
-     * @return int ID of new row inserted, or FALSE on failure
2833
-     */
2834
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2835
-    {
2836
-        global $wpdb;
2837
-        $insertion_col_n_values = array();
2838
-        $format_for_insertion = array();
2839
-        $fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2840
-        foreach ($fields_on_table as $field_name => $field_obj) {
2841
-            //check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2842
-            if ($field_obj->is_auto_increment()) {
2843
-                continue;
2844
-            }
2845
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2846
-            //if the value we want to assign it to is NULL, just don't mention it for the insertion
2847
-            if ($prepared_value !== null) {
2848
-                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2849
-                $format_for_insertion[] = $field_obj->get_wpdb_data_type();
2850
-            }
2851
-        }
2852
-        if ($table instanceof EE_Secondary_Table && $new_id) {
2853
-            //its not the main table, so we should have already saved the main table's PK which we just inserted
2854
-            //so add the fk to the main table as a column
2855
-            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2856
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2857
-        }
2858
-        //insert the new entry
2859
-        $result = $this->_do_wpdb_query('insert',
2860
-            array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2861
-        if ($result === false) {
2862
-            return false;
2863
-        }
2864
-        //ok, now what do we return for the ID of the newly-inserted thing?
2865
-        if ($this->has_primary_key_field()) {
2866
-            if ($this->get_primary_key_field()->is_auto_increment()) {
2867
-                return $wpdb->insert_id;
2868
-            } else {
2869
-                //it's not an auto-increment primary key, so
2870
-                //it must have been supplied
2871
-                return $fields_n_values[$this->get_primary_key_field()->get_name()];
2872
-            }
2873
-        } else {
2874
-            //we can't return a  primary key because there is none. instead return
2875
-            //a unique string indicating this model
2876
-            return $this->get_index_primary_key_string($fields_n_values);
2877
-        }
2878
-    }
2879
-
2880
-
2881
-
2882
-    /**
2883
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2884
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2885
-     * and there is no default, we pass it along. WPDB will take care of it)
2886
-     *
2887
-     * @param EE_Model_Field_Base $field_obj
2888
-     * @param array               $fields_n_values
2889
-     * @return mixed string|int|float depending on what the table column will be expecting
2890
-     * @throws \EE_Error
2891
-     */
2892
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2893
-    {
2894
-        //if this field doesn't allow nullable, don't allow it
2895
-        if (
2896
-            ! $field_obj->is_nullable()
2897
-            && (
2898
-                ! isset($fields_n_values[$field_obj->get_name()])
2899
-                || $fields_n_values[$field_obj->get_name()] === null
2900
-            )
2901
-        ) {
2902
-            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
2903
-        }
2904
-        $unprepared_value = isset($fields_n_values[$field_obj->get_name()])
2905
-            ? $fields_n_values[$field_obj->get_name()]
2906
-            : null;
2907
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
2908
-    }
2909
-
2910
-
2911
-
2912
-    /**
2913
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
2914
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
2915
-     * the field's prepare_for_set() method.
2916
-     *
2917
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
2918
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
2919
-     *                                   top of file)
2920
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
2921
-     *                                   $value is a custom selection
2922
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
2923
-     */
2924
-    private function _prepare_value_for_use_in_db($value, $field)
2925
-    {
2926
-        if ($field && $field instanceof EE_Model_Field_Base) {
2927
-            switch ($this->_values_already_prepared_by_model_object) {
2928
-                /** @noinspection PhpMissingBreakStatementInspection */
2929
-                case self::not_prepared_by_model_object:
2930
-                    $value = $field->prepare_for_set($value);
2931
-                //purposefully left out "return"
2932
-                case self::prepared_by_model_object:
2933
-                    $value = $field->prepare_for_use_in_db($value);
2934
-                case self::prepared_for_use_in_db:
2935
-                    //leave the value alone
2936
-            }
2937
-            return $value;
2938
-        } else {
2939
-            return $value;
2940
-        }
2941
-    }
2942
-
2943
-
2944
-
2945
-    /**
2946
-     * Returns the main table on this model
2947
-     *
2948
-     * @return EE_Primary_Table
2949
-     * @throws EE_Error
2950
-     */
2951
-    protected function _get_main_table()
2952
-    {
2953
-        foreach ($this->_tables as $table) {
2954
-            if ($table instanceof EE_Primary_Table) {
2955
-                return $table;
2956
-            }
2957
-        }
2958
-        throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
2959
-            'event_espresso'), get_class($this)));
2960
-    }
2961
-
2962
-
2963
-
2964
-    /**
2965
-     * table
2966
-     * returns EE_Primary_Table table name
2967
-     *
2968
-     * @return string
2969
-     * @throws \EE_Error
2970
-     */
2971
-    public function table()
2972
-    {
2973
-        return $this->_get_main_table()->get_table_name();
2974
-    }
2975
-
2976
-
2977
-
2978
-    /**
2979
-     * table
2980
-     * returns first EE_Secondary_Table table name
2981
-     *
2982
-     * @return string
2983
-     */
2984
-    public function second_table()
2985
-    {
2986
-        // grab second table from tables array
2987
-        $second_table = end($this->_tables);
2988
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
2989
-    }
2990
-
2991
-
2992
-
2993
-    /**
2994
-     * get_table_obj_by_alias
2995
-     * returns table name given it's alias
2996
-     *
2997
-     * @param string $table_alias
2998
-     * @return EE_Primary_Table | EE_Secondary_Table
2999
-     */
3000
-    public function get_table_obj_by_alias($table_alias = '')
3001
-    {
3002
-        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3003
-    }
3004
-
3005
-
3006
-
3007
-    /**
3008
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3009
-     *
3010
-     * @return EE_Secondary_Table[]
3011
-     */
3012
-    protected function _get_other_tables()
3013
-    {
3014
-        $other_tables = array();
3015
-        foreach ($this->_tables as $table_alias => $table) {
3016
-            if ($table instanceof EE_Secondary_Table) {
3017
-                $other_tables[$table_alias] = $table;
3018
-            }
3019
-        }
3020
-        return $other_tables;
3021
-    }
3022
-
3023
-
3024
-
3025
-    /**
3026
-     * Finds all the fields that correspond to the given table
3027
-     *
3028
-     * @param string $table_alias , array key in EEM_Base::_tables
3029
-     * @return EE_Model_Field_Base[]
3030
-     */
3031
-    public function _get_fields_for_table($table_alias)
3032
-    {
3033
-        return $this->_fields[$table_alias];
3034
-    }
3035
-
3036
-
3037
-
3038
-    /**
3039
-     * Recurses through all the where parameters, and finds all the related models we'll need
3040
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3041
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3042
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3043
-     * related Registration, Transaction, and Payment models.
3044
-     *
3045
-     * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3046
-     * @return EE_Model_Query_Info_Carrier
3047
-     * @throws \EE_Error
3048
-     */
3049
-    public function _extract_related_models_from_query($query_params)
3050
-    {
3051
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
3052
-        if (array_key_exists(0, $query_params)) {
3053
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3054
-        }
3055
-        if (array_key_exists('group_by', $query_params)) {
3056
-            if (is_array($query_params['group_by'])) {
3057
-                $this->_extract_related_models_from_sub_params_array_values(
3058
-                    $query_params['group_by'],
3059
-                    $query_info_carrier,
3060
-                    'group_by'
3061
-                );
3062
-            } elseif (! empty ($query_params['group_by'])) {
3063
-                $this->_extract_related_model_info_from_query_param(
3064
-                    $query_params['group_by'],
3065
-                    $query_info_carrier,
3066
-                    'group_by'
3067
-                );
3068
-            }
3069
-        }
3070
-        if (array_key_exists('having', $query_params)) {
3071
-            $this->_extract_related_models_from_sub_params_array_keys(
3072
-                $query_params[0],
3073
-                $query_info_carrier,
3074
-                'having'
3075
-            );
3076
-        }
3077
-        if (array_key_exists('order_by', $query_params)) {
3078
-            if (is_array($query_params['order_by'])) {
3079
-                $this->_extract_related_models_from_sub_params_array_keys(
3080
-                    $query_params['order_by'],
3081
-                    $query_info_carrier,
3082
-                    'order_by'
3083
-                );
3084
-            } elseif (! empty($query_params['order_by'])) {
3085
-                $this->_extract_related_model_info_from_query_param(
3086
-                    $query_params['order_by'],
3087
-                    $query_info_carrier,
3088
-                    'order_by'
3089
-                );
3090
-            }
3091
-        }
3092
-        if (array_key_exists('force_join', $query_params)) {
3093
-            $this->_extract_related_models_from_sub_params_array_values(
3094
-                $query_params['force_join'],
3095
-                $query_info_carrier,
3096
-                'force_join'
3097
-            );
3098
-        }
3099
-        return $query_info_carrier;
3100
-    }
3101
-
3102
-
3103
-
3104
-    /**
3105
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3106
-     *
3107
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3108
-     *                                                      $query_params['having']
3109
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3110
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3111
-     * @throws EE_Error
3112
-     * @return \EE_Model_Query_Info_Carrier
3113
-     */
3114
-    private function _extract_related_models_from_sub_params_array_keys(
3115
-        $sub_query_params,
3116
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3117
-        $query_param_type
3118
-    ) {
3119
-        if (! empty($sub_query_params)) {
3120
-            $sub_query_params = (array)$sub_query_params;
3121
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
3122
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3123
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3124
-                    $query_param_type);
3125
-                //if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3126
-                //indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3127
-                //extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3128
-                //of array('Registration.TXN_ID'=>23)
3129
-                $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3130
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3131
-                    if (! is_array($possibly_array_of_params)) {
3132
-                        throw new EE_Error(sprintf(__("You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
3133
-                            "event_espresso"),
3134
-                            $param, $possibly_array_of_params));
3135
-                    } else {
3136
-                        $this->_extract_related_models_from_sub_params_array_keys($possibly_array_of_params,
3137
-                            $model_query_info_carrier, $query_param_type);
3138
-                    }
3139
-                } elseif ($query_param_type === 0 //ie WHERE
3140
-                          && is_array($possibly_array_of_params)
3141
-                          && isset($possibly_array_of_params[2])
3142
-                          && $possibly_array_of_params[2] == true
3143
-                ) {
3144
-                    //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3145
-                    //indicating that $possible_array_of_params[1] is actually a field name,
3146
-                    //from which we should extract query parameters!
3147
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3148
-                        throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3149
-                            "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3150
-                    }
3151
-                    $this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3152
-                        $model_query_info_carrier, $query_param_type);
3153
-                }
3154
-            }
3155
-        }
3156
-        return $model_query_info_carrier;
3157
-    }
3158
-
3159
-
3160
-
3161
-    /**
3162
-     * For extracting related models from forced_joins, where the array values contain the info about what
3163
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3164
-     *
3165
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3166
-     *                                                      $query_params['having']
3167
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3168
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3169
-     * @throws EE_Error
3170
-     * @return \EE_Model_Query_Info_Carrier
3171
-     */
3172
-    private function _extract_related_models_from_sub_params_array_values(
3173
-        $sub_query_params,
3174
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3175
-        $query_param_type
3176
-    ) {
3177
-        if (! empty($sub_query_params)) {
3178
-            if (! is_array($sub_query_params)) {
3179
-                throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3180
-                    $sub_query_params));
3181
-            }
3182
-            foreach ($sub_query_params as $param) {
3183
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3184
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3185
-                    $query_param_type);
3186
-            }
3187
-        }
3188
-        return $model_query_info_carrier;
3189
-    }
3190
-
3191
-
3192
-
3193
-    /**
3194
-     * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3195
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3196
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
3197
-     * but use them in a different order. Eg, we need to know what models we are querying
3198
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3199
-     * other models before we can finalize the where clause SQL.
3200
-     *
3201
-     * @param array $query_params
3202
-     * @throws EE_Error
3203
-     * @return EE_Model_Query_Info_Carrier
3204
-     */
3205
-    public function _create_model_query_info_carrier($query_params)
3206
-    {
3207
-        if (! is_array($query_params)) {
3208
-            EE_Error::doing_it_wrong(
3209
-                'EEM_Base::_create_model_query_info_carrier',
3210
-                sprintf(
3211
-                    __(
3212
-                        '$query_params should be an array, you passed a variable of type %s',
3213
-                        'event_espresso'
3214
-                    ),
3215
-                    gettype($query_params)
3216
-                ),
3217
-                '4.6.0'
3218
-            );
3219
-            $query_params = array();
3220
-        }
3221
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3222
-        //first check if we should alter the query to account for caps or not
3223
-        //because the caps might require us to do extra joins
3224
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3225
-            $query_params[0] = $where_query_params = array_replace_recursive(
3226
-                $where_query_params,
3227
-                $this->caps_where_conditions(
3228
-                    $query_params['caps']
3229
-                )
3230
-            );
3231
-        }
3232
-        $query_object = $this->_extract_related_models_from_query($query_params);
3233
-        //verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3234
-        foreach ($where_query_params as $key => $value) {
3235
-            if (is_int($key)) {
3236
-                throw new EE_Error(
3237
-                    sprintf(
3238
-                        __(
3239
-                            "WHERE query params must NOT be numerically-indexed. You provided the array key '%s' for value '%s' while querying model %s. All the query params provided were '%s' Please read documentation on EEM_Base::get_all.",
3240
-                            "event_espresso"
3241
-                        ),
3242
-                        $key,
3243
-                        var_export($value, true),
3244
-                        var_export($query_params, true),
3245
-                        get_class($this)
3246
-                    )
3247
-                );
3248
-            }
3249
-        }
3250
-        if (
3251
-            array_key_exists('default_where_conditions', $query_params)
3252
-            && ! empty($query_params['default_where_conditions'])
3253
-        ) {
3254
-            $use_default_where_conditions = $query_params['default_where_conditions'];
3255
-        } else {
3256
-            $use_default_where_conditions = EEM_Base::default_where_conditions_all;
3257
-        }
3258
-        $where_query_params = array_merge(
3259
-            $this->_get_default_where_conditions_for_models_in_query(
3260
-                $query_object,
3261
-                $use_default_where_conditions,
3262
-                $where_query_params
3263
-            ),
3264
-            $where_query_params
3265
-        );
3266
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3267
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3268
-        // So we need to setup a subquery and use that for the main join.
3269
-        // Note for now this only works on the primary table for the model.
3270
-        // So for instance, you could set the limit array like this:
3271
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3272
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3273
-            $query_object->set_main_model_join_sql(
3274
-                $this->_construct_limit_join_select(
3275
-                    $query_params['on_join_limit'][0],
3276
-                    $query_params['on_join_limit'][1]
3277
-                )
3278
-            );
3279
-        }
3280
-        //set limit
3281
-        if (array_key_exists('limit', $query_params)) {
3282
-            if (is_array($query_params['limit'])) {
3283
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3284
-                    $e = sprintf(
3285
-                        __(
3286
-                            "Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
3287
-                            "event_espresso"
3288
-                        ),
3289
-                        http_build_query($query_params['limit'])
3290
-                    );
3291
-                    throw new EE_Error($e . "|" . $e);
3292
-                }
3293
-                //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3294
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3295
-            } elseif (! empty ($query_params['limit'])) {
3296
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3297
-            }
3298
-        }
3299
-        //set order by
3300
-        if (array_key_exists('order_by', $query_params)) {
3301
-            if (is_array($query_params['order_by'])) {
3302
-                //if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3303
-                //specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3304
-                //including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3305
-                if (array_key_exists('order', $query_params)) {
3306
-                    throw new EE_Error(
3307
-                        sprintf(
3308
-                            __(
3309
-                                "In querying %s, we are using query parameter 'order_by' as an array (keys:%s,values:%s), and so we can't use query parameter 'order' (value %s). You should just use the 'order_by' parameter ",
3310
-                                "event_espresso"
3311
-                            ),
3312
-                            get_class($this),
3313
-                            implode(", ", array_keys($query_params['order_by'])),
3314
-                            implode(", ", $query_params['order_by']),
3315
-                            $query_params['order']
3316
-                        )
3317
-                    );
3318
-                }
3319
-                $this->_extract_related_models_from_sub_params_array_keys(
3320
-                    $query_params['order_by'],
3321
-                    $query_object,
3322
-                    'order_by'
3323
-                );
3324
-                //assume it's an array of fields to order by
3325
-                $order_array = array();
3326
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3327
-                    $order = $this->_extract_order($order);
3328
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3329
-                }
3330
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3331
-            } elseif (! empty ($query_params['order_by'])) {
3332
-                $this->_extract_related_model_info_from_query_param(
3333
-                    $query_params['order_by'],
3334
-                    $query_object,
3335
-                    'order',
3336
-                    $query_params['order_by']
3337
-                );
3338
-                $order = isset($query_params['order'])
3339
-                    ? $this->_extract_order($query_params['order'])
3340
-                    : 'DESC';
3341
-                $query_object->set_order_by_sql(
3342
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3343
-                );
3344
-            }
3345
-        }
3346
-        //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3347
-        if (! array_key_exists('order_by', $query_params)
3348
-            && array_key_exists('order', $query_params)
3349
-            && ! empty($query_params['order'])
3350
-        ) {
3351
-            $pk_field = $this->get_primary_key_field();
3352
-            $order = $this->_extract_order($query_params['order']);
3353
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3354
-        }
3355
-        //set group by
3356
-        if (array_key_exists('group_by', $query_params)) {
3357
-            if (is_array($query_params['group_by'])) {
3358
-                //it's an array, so assume we'll be grouping by a bunch of stuff
3359
-                $group_by_array = array();
3360
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
3361
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3362
-                }
3363
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3364
-            } elseif (! empty ($query_params['group_by'])) {
3365
-                $query_object->set_group_by_sql(
3366
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3367
-                );
3368
-            }
3369
-        }
3370
-        //set having
3371
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
3372
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3373
-        }
3374
-        //now, just verify they didn't pass anything wack
3375
-        foreach ($query_params as $query_key => $query_value) {
3376
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3377
-                throw new EE_Error(
3378
-                    sprintf(
3379
-                        __(
3380
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3381
-                            'event_espresso'
3382
-                        ),
3383
-                        $query_key,
3384
-                        get_class($this),
3385
-                        //						print_r( $this->_allowed_query_params, TRUE )
3386
-                        implode(',', $this->_allowed_query_params)
3387
-                    )
3388
-                );
3389
-            }
3390
-        }
3391
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
3392
-        if (empty($main_model_join_sql)) {
3393
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
3394
-        }
3395
-        return $query_object;
3396
-    }
3397
-
3398
-
3399
-
3400
-    /**
3401
-     * Gets the where conditions that should be imposed on the query based on the
3402
-     * context (eg reading frontend, backend, edit or delete).
3403
-     *
3404
-     * @param string $context one of EEM_Base::valid_cap_contexts()
3405
-     * @return array like EEM_Base::get_all() 's $query_params[0]
3406
-     * @throws \EE_Error
3407
-     */
3408
-    public function caps_where_conditions($context = self::caps_read)
3409
-    {
3410
-        EEM_Base::verify_is_valid_cap_context($context);
3411
-        $cap_where_conditions = array();
3412
-        $cap_restrictions = $this->caps_missing($context);
3413
-        /**
3414
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
3415
-         */
3416
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3417
-            $cap_where_conditions = array_replace_recursive($cap_where_conditions,
3418
-                $restriction_if_no_cap->get_default_where_conditions());
3419
-        }
3420
-        return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3421
-            $cap_restrictions);
3422
-    }
3423
-
3424
-
3425
-
3426
-    /**
3427
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3428
-     * otherwise throws an exception
3429
-     *
3430
-     * @param string $should_be_order_string
3431
-     * @return string either ASC, asc, DESC or desc
3432
-     * @throws EE_Error
3433
-     */
3434
-    private function _extract_order($should_be_order_string)
3435
-    {
3436
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3437
-            return $should_be_order_string;
3438
-        } else {
3439
-            throw new EE_Error(sprintf(__("While performing a query on '%s', tried to use '%s' as an order parameter. ",
3440
-                "event_espresso"), get_class($this), $should_be_order_string));
3441
-        }
3442
-    }
3443
-
3444
-
3445
-
3446
-    /**
3447
-     * Looks at all the models which are included in this query, and asks each
3448
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3449
-     * so they can be merged
3450
-     *
3451
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
3452
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3453
-     *                                                                  'none' means NO default where conditions will
3454
-     *                                                                  be used AT ALL during this query.
3455
-     *                                                                  'other_models_only' means default where
3456
-     *                                                                  conditions from other models will be used, but
3457
-     *                                                                  not for this primary model. 'all', the default,
3458
-     *                                                                  means default where conditions will apply as
3459
-     *                                                                  normal
3460
-     * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3461
-     * @throws EE_Error
3462
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
3463
-     */
3464
-    private function _get_default_where_conditions_for_models_in_query(
3465
-        EE_Model_Query_Info_Carrier $query_info_carrier,
3466
-        $use_default_where_conditions = EEM_Base::default_where_conditions_all,
3467
-        $where_query_params = array()
3468
-    ) {
3469
-        $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3470
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3471
-            throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3472
-                "event_espresso"), $use_default_where_conditions,
3473
-                implode(", ", $allowed_used_default_where_conditions_values)));
3474
-        }
3475
-        $universal_query_params = array();
3476
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3477
-            $universal_query_params = $this->_get_default_where_conditions();
3478
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3479
-            $universal_query_params = $this->_get_minimum_where_conditions();
3480
-        }
3481
-        foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3482
-            $related_model = $this->get_related_model_obj($model_name);
3483
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3484
-                $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3485
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3486
-                $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3487
-            } else {
3488
-                //we don't want to add full or even minimum default where conditions from this model, so just continue
3489
-                continue;
3490
-            }
3491
-            $overrides = $this->_override_defaults_or_make_null_friendly(
3492
-                $related_model_universal_where_params,
3493
-                $where_query_params,
3494
-                $related_model,
3495
-                $model_relation_path
3496
-            );
3497
-            $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3498
-                $universal_query_params,
3499
-                $overrides
3500
-            );
3501
-        }
3502
-        return $universal_query_params;
3503
-    }
3504
-
3505
-
3506
-
3507
-    /**
3508
-     * Determines whether or not we should use default where conditions for the model in question
3509
-     * (this model, or other related models).
3510
-     * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3511
-     * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3512
-     * We should use default where conditions on related models when they requested to use default where conditions
3513
-     * on all models, or specifically just on other related models
3514
-     * @param      $default_where_conditions_value
3515
-     * @param bool $for_this_model false means this is for OTHER related models
3516
-     * @return bool
3517
-     */
3518
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3519
-    {
3520
-        return (
3521
-                   $for_this_model
3522
-                   && in_array(
3523
-                       $default_where_conditions_value,
3524
-                       array(
3525
-                           EEM_Base::default_where_conditions_all,
3526
-                           EEM_Base::default_where_conditions_this_only,
3527
-                           EEM_Base::default_where_conditions_minimum_others,
3528
-                       ),
3529
-                       true
3530
-                   )
3531
-               )
3532
-               || (
3533
-                   ! $for_this_model
3534
-                   && in_array(
3535
-                       $default_where_conditions_value,
3536
-                       array(
3537
-                           EEM_Base::default_where_conditions_all,
3538
-                           EEM_Base::default_where_conditions_others_only,
3539
-                       ),
3540
-                       true
3541
-                   )
3542
-               );
3543
-    }
3544
-
3545
-    /**
3546
-     * Determines whether or not we should use default minimum conditions for the model in question
3547
-     * (this model, or other related models).
3548
-     * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3549
-     * where conditions.
3550
-     * We should use minimum where conditions on related models if they requested to use minimum where conditions
3551
-     * on this model or others
3552
-     * @param      $default_where_conditions_value
3553
-     * @param bool $for_this_model false means this is for OTHER related models
3554
-     * @return bool
3555
-     */
3556
-    private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3557
-    {
3558
-        return (
3559
-                   $for_this_model
3560
-                   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3561
-               )
3562
-               || (
3563
-                   ! $for_this_model
3564
-                   && in_array(
3565
-                       $default_where_conditions_value,
3566
-                       array(
3567
-                           EEM_Base::default_where_conditions_minimum_others,
3568
-                           EEM_Base::default_where_conditions_minimum_all,
3569
-                       ),
3570
-                       true
3571
-                   )
3572
-               );
3573
-    }
3574
-
3575
-
3576
-    /**
3577
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3578
-     * then we also add a special where condition which allows for that model's primary key
3579
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3580
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3581
-     *
3582
-     * @param array    $default_where_conditions
3583
-     * @param array    $provided_where_conditions
3584
-     * @param EEM_Base $model
3585
-     * @param string   $model_relation_path like 'Transaction.Payment.'
3586
-     * @return array like EEM_Base::get_all's $query_params[0]
3587
-     * @throws \EE_Error
3588
-     */
3589
-    private function _override_defaults_or_make_null_friendly(
3590
-        $default_where_conditions,
3591
-        $provided_where_conditions,
3592
-        $model,
3593
-        $model_relation_path
3594
-    ) {
3595
-        $null_friendly_where_conditions = array();
3596
-        $none_overridden = true;
3597
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3598
-        foreach ($default_where_conditions as $key => $val) {
3599
-            if (isset($provided_where_conditions[$key])) {
3600
-                $none_overridden = false;
3601
-            } else {
3602
-                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3603
-            }
3604
-        }
3605
-        if ($none_overridden && $default_where_conditions) {
3606
-            if ($model->has_primary_key_field()) {
3607
-                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3608
-                                                                                . "."
3609
-                                                                                . $model->primary_key_name()] = array('IS NULL');
3610
-            }/*else{
31
+	//admin posty
32
+	//basic -> grants access to mine -> if they don't have it, select none
33
+	//*_others -> grants access to others that aren't private, and all mine -> if they don't have it, select mine
34
+	//*_private -> grants full access -> if dont have it, select all mine and others' non-private
35
+	//*_published -> grants access to published -> if they dont have it, select non-published
36
+	//*_global/default/system -> grants access to global items -> if they don't have it, select non-global
37
+	//publish_{thing} -> can change status TO publish; SPECIAL CASE
38
+	//frontend posty
39
+	//by default has access to published
40
+	//basic -> grants access to mine that aren't published, and all published
41
+	//*_others ->grants access to others that aren't private, all mine
42
+	//*_private -> grants full access
43
+	//frontend non-posty
44
+	//like admin posty
45
+	//category-y
46
+	//assign -> grants access to join-table
47
+	//(delete, edit)
48
+	//payment-method-y
49
+	//for each registered payment method,
50
+	//ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
51
+	/**
52
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
53
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
54
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
55
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
56
+	 *
57
+	 * @var boolean
58
+	 */
59
+	private $_values_already_prepared_by_model_object = 0;
60
+
61
+	/**
62
+	 * when $_values_already_prepared_by_model_object equals this, we assume
63
+	 * the data is just like form input that needs to have the model fields'
64
+	 * prepare_for_set and prepare_for_use_in_db called on it
65
+	 */
66
+	const not_prepared_by_model_object = 0;
67
+
68
+	/**
69
+	 * when $_values_already_prepared_by_model_object equals this, we
70
+	 * assume this value is coming from a model object and doesn't need to have
71
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
72
+	 */
73
+	const prepared_by_model_object = 1;
74
+
75
+	/**
76
+	 * when $_values_already_prepared_by_model_object equals this, we assume
77
+	 * the values are already to be used in the database (ie no processing is done
78
+	 * on them by the model's fields)
79
+	 */
80
+	const prepared_for_use_in_db = 2;
81
+
82
+
83
+	protected $singular_item = 'Item';
84
+
85
+	protected $plural_item   = 'Items';
86
+
87
+	/**
88
+	 * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
89
+	 */
90
+	protected $_tables;
91
+
92
+	/**
93
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
94
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
95
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
96
+	 *
97
+	 * @var \EE_Model_Field_Base[] $_fields
98
+	 */
99
+	protected $_fields;
100
+
101
+	/**
102
+	 * array of different kinds of relations
103
+	 *
104
+	 * @var \EE_Model_Relation_Base[] $_model_relations
105
+	 */
106
+	protected $_model_relations;
107
+
108
+	/**
109
+	 * @var \EE_Index[] $_indexes
110
+	 */
111
+	protected $_indexes = array();
112
+
113
+	/**
114
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
115
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
116
+	 * by setting the same columns as used in these queries in the query yourself.
117
+	 *
118
+	 * @var EE_Default_Where_Conditions
119
+	 */
120
+	protected $_default_where_conditions_strategy;
121
+
122
+	/**
123
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
124
+	 * This is particularly useful when you want something between 'none' and 'default'
125
+	 *
126
+	 * @var EE_Default_Where_Conditions
127
+	 */
128
+	protected $_minimum_where_conditions_strategy;
129
+
130
+	/**
131
+	 * String describing how to find the "owner" of this model's objects.
132
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
133
+	 * But when there isn't, this indicates which related model, or transiently-related model,
134
+	 * has the foreign key to the wp_users table.
135
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
136
+	 * related to events, and events have a foreign key to wp_users.
137
+	 * On EEM_Transaction, this would be 'Transaction.Event'
138
+	 *
139
+	 * @var string
140
+	 */
141
+	protected $_model_chain_to_wp_user = '';
142
+
143
+	/**
144
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
145
+	 * don't need it (particularly CPT models)
146
+	 *
147
+	 * @var bool
148
+	 */
149
+	protected $_ignore_where_strategy = false;
150
+
151
+	/**
152
+	 * String used in caps relating to this model. Eg, if the caps relating to this
153
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
154
+	 *
155
+	 * @var string. If null it hasn't been initialized yet. If false then we
156
+	 * have indicated capabilities don't apply to this
157
+	 */
158
+	protected $_caps_slug = null;
159
+
160
+	/**
161
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
162
+	 * and next-level keys are capability names, and each's value is a
163
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
164
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
165
+	 * and then each capability in the corresponding sub-array that they're missing
166
+	 * adds the where conditions onto the query.
167
+	 *
168
+	 * @var array
169
+	 */
170
+	protected $_cap_restrictions = array(
171
+		self::caps_read       => array(),
172
+		self::caps_read_admin => array(),
173
+		self::caps_edit       => array(),
174
+		self::caps_delete     => array(),
175
+	);
176
+
177
+	/**
178
+	 * Array defining which cap restriction generators to use to create default
179
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
180
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
181
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
182
+	 * automatically set this to false (not just null).
183
+	 *
184
+	 * @var EE_Restriction_Generator_Base[]
185
+	 */
186
+	protected $_cap_restriction_generators = array();
187
+
188
+	/**
189
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
190
+	 */
191
+	const caps_read       = 'read';
192
+
193
+	const caps_read_admin = 'read_admin';
194
+
195
+	const caps_edit       = 'edit';
196
+
197
+	const caps_delete     = 'delete';
198
+
199
+	/**
200
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
201
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
202
+	 * maps to 'read' because when looking for relevant permissions we're going to use
203
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
204
+	 *
205
+	 * @var array
206
+	 */
207
+	protected $_cap_contexts_to_cap_action_map = array(
208
+		self::caps_read       => 'read',
209
+		self::caps_read_admin => 'read',
210
+		self::caps_edit       => 'edit',
211
+		self::caps_delete     => 'delete',
212
+	);
213
+
214
+	/**
215
+	 * Timezone
216
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
217
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
218
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
219
+	 * EE_Datetime_Field data type will have access to it.
220
+	 *
221
+	 * @var string
222
+	 */
223
+	protected $_timezone;
224
+
225
+
226
+	/**
227
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
228
+	 * multisite.
229
+	 *
230
+	 * @var int
231
+	 */
232
+	protected static $_model_query_blog_id;
233
+
234
+	/**
235
+	 * A copy of _fields, except the array keys are the model names pointed to by
236
+	 * the field
237
+	 *
238
+	 * @var EE_Model_Field_Base[]
239
+	 */
240
+	private $_cache_foreign_key_to_fields = array();
241
+
242
+	/**
243
+	 * Cached list of all the fields on the model, indexed by their name
244
+	 *
245
+	 * @var EE_Model_Field_Base[]
246
+	 */
247
+	private $_cached_fields = null;
248
+
249
+	/**
250
+	 * Cached list of all the fields on the model, except those that are
251
+	 * marked as only pertinent to the database
252
+	 *
253
+	 * @var EE_Model_Field_Base[]
254
+	 */
255
+	private $_cached_fields_non_db_only = null;
256
+
257
+	/**
258
+	 * A cached reference to the primary key for quick lookup
259
+	 *
260
+	 * @var EE_Model_Field_Base
261
+	 */
262
+	private $_primary_key_field = null;
263
+
264
+	/**
265
+	 * Flag indicating whether this model has a primary key or not
266
+	 *
267
+	 * @var boolean
268
+	 */
269
+	protected $_has_primary_key_field = null;
270
+
271
+	/**
272
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
273
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
274
+	 *
275
+	 * @var boolean
276
+	 */
277
+	protected $_wp_core_model = false;
278
+
279
+	/**
280
+	 *    List of valid operators that can be used for querying.
281
+	 * The keys are all operators we'll accept, the values are the real SQL
282
+	 * operators used
283
+	 *
284
+	 * @var array
285
+	 */
286
+	protected $_valid_operators = array(
287
+		'='           => '=',
288
+		'<='          => '<=',
289
+		'<'           => '<',
290
+		'>='          => '>=',
291
+		'>'           => '>',
292
+		'!='          => '!=',
293
+		'LIKE'        => 'LIKE',
294
+		'like'        => 'LIKE',
295
+		'NOT_LIKE'    => 'NOT LIKE',
296
+		'not_like'    => 'NOT LIKE',
297
+		'NOT LIKE'    => 'NOT LIKE',
298
+		'not like'    => 'NOT LIKE',
299
+		'IN'          => 'IN',
300
+		'in'          => 'IN',
301
+		'NOT_IN'      => 'NOT IN',
302
+		'not_in'      => 'NOT IN',
303
+		'NOT IN'      => 'NOT IN',
304
+		'not in'      => 'NOT IN',
305
+		'between'     => 'BETWEEN',
306
+		'BETWEEN'     => 'BETWEEN',
307
+		'IS_NOT_NULL' => 'IS NOT NULL',
308
+		'is_not_null' => 'IS NOT NULL',
309
+		'IS NOT NULL' => 'IS NOT NULL',
310
+		'is not null' => 'IS NOT NULL',
311
+		'IS_NULL'     => 'IS NULL',
312
+		'is_null'     => 'IS NULL',
313
+		'IS NULL'     => 'IS NULL',
314
+		'is null'     => 'IS NULL',
315
+		'REGEXP'      => 'REGEXP',
316
+		'regexp'      => 'REGEXP',
317
+		'NOT_REGEXP'  => 'NOT REGEXP',
318
+		'not_regexp'  => 'NOT REGEXP',
319
+		'NOT REGEXP'  => 'NOT REGEXP',
320
+		'not regexp'  => 'NOT REGEXP',
321
+	);
322
+
323
+	/**
324
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
325
+	 *
326
+	 * @var array
327
+	 */
328
+	protected $_in_style_operators = array('IN', 'NOT IN');
329
+
330
+	/**
331
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
332
+	 * '12-31-2012'"
333
+	 *
334
+	 * @var array
335
+	 */
336
+	protected $_between_style_operators = array('BETWEEN');
337
+
338
+	/**
339
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
340
+	 * on a join table.
341
+	 *
342
+	 * @var array
343
+	 */
344
+	protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
345
+
346
+	/**
347
+	 * Allowed values for $query_params['order'] for ordering in queries
348
+	 *
349
+	 * @var array
350
+	 */
351
+	protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
352
+
353
+	/**
354
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
355
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
356
+	 *
357
+	 * @var array
358
+	 */
359
+	private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
360
+
361
+	/**
362
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
363
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
364
+	 *
365
+	 * @var array
366
+	 */
367
+	private $_allowed_query_params = array(
368
+		0,
369
+		'limit',
370
+		'order_by',
371
+		'group_by',
372
+		'having',
373
+		'force_join',
374
+		'order',
375
+		'on_join_limit',
376
+		'default_where_conditions',
377
+		'caps',
378
+	);
379
+
380
+	/**
381
+	 * All the data types that can be used in $wpdb->prepare statements.
382
+	 *
383
+	 * @var array
384
+	 */
385
+	private $_valid_wpdb_data_types = array('%d', '%s', '%f');
386
+
387
+	/**
388
+	 *    EE_Registry Object
389
+	 *
390
+	 * @var    object
391
+	 * @access    protected
392
+	 */
393
+	protected $EE = null;
394
+
395
+
396
+	/**
397
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
398
+	 *
399
+	 * @var int
400
+	 */
401
+	protected $_show_next_x_db_queries = 0;
402
+
403
+	/**
404
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
405
+	 * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
406
+	 *
407
+	 * @var array
408
+	 */
409
+	protected $_custom_selections = array();
410
+
411
+	/**
412
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
413
+	 * caches every model object we've fetched from the DB on this request
414
+	 *
415
+	 * @var array
416
+	 */
417
+	protected $_entity_map;
418
+
419
+	/**
420
+	 * constant used to show EEM_Base has not yet verified the db on this http request
421
+	 */
422
+	const db_verified_none = 0;
423
+
424
+	/**
425
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
426
+	 * but not the addons' dbs
427
+	 */
428
+	const db_verified_core = 1;
429
+
430
+	/**
431
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
432
+	 * the EE core db too)
433
+	 */
434
+	const db_verified_addons = 2;
435
+
436
+	/**
437
+	 * indicates whether an EEM_Base child has already re-verified the DB
438
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
439
+	 * looking like EEM_Base::db_verified_*
440
+	 *
441
+	 * @var int - 0 = none, 1 = core, 2 = addons
442
+	 */
443
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
444
+
445
+	/**
446
+	 * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
447
+	 *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
448
+	 *        registrations for non-trashed tickets for non-trashed datetimes)
449
+	 */
450
+	const default_where_conditions_all = 'all';
451
+
452
+	/**
453
+	 * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
454
+	 *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
455
+	 *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
456
+	 *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
457
+	 *        models which share tables with other models, this can return data for the wrong model.
458
+	 */
459
+	const default_where_conditions_this_only = 'this_model_only';
460
+
461
+	/**
462
+	 * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
463
+	 *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
464
+	 *        return all registrations related to non-trashed tickets and non-trashed datetimes)
465
+	 */
466
+	const default_where_conditions_others_only = 'other_models_only';
467
+
468
+	/**
469
+	 * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
470
+	 *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
471
+	 *        their table with other models, like the Event and Venue models. For example, when querying for events
472
+	 *        ordered by their venues' name, this will be sure to only return real events with associated real venues
473
+	 *        (regardless of whether those events and venues are trashed)
474
+	 *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
475
+	 *        events.
476
+	 */
477
+	const default_where_conditions_minimum_all = 'minimum';
478
+
479
+	/**
480
+	 * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
481
+	 *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
482
+	 *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
483
+	 *        not)
484
+	 */
485
+	const default_where_conditions_minimum_others = 'full_this_minimum_others';
486
+
487
+	/**
488
+	 * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
489
+	 *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
490
+	 *        it's possible it will return table entries for other models. You should use
491
+	 *        EEM_Base::default_where_conditions_minimum_all instead.
492
+	 */
493
+	const default_where_conditions_none = 'none';
494
+
495
+
496
+
497
+	/**
498
+	 * About all child constructors:
499
+	 * they should define the _tables, _fields and _model_relations arrays.
500
+	 * Should ALWAYS be called after child constructor.
501
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
502
+	 * finalizes constructing all the object's attributes.
503
+	 * Generally, rather than requiring a child to code
504
+	 * $this->_tables = array(
505
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
506
+	 *        ...);
507
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
508
+	 * each EE_Table has a function to set the table's alias after the constructor, using
509
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
510
+	 * do something similar.
511
+	 *
512
+	 * @param null $timezone
513
+	 * @throws \EE_Error
514
+	 */
515
+	protected function __construct($timezone = null)
516
+	{
517
+		// check that the model has not been loaded too soon
518
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
519
+			throw new EE_Error (
520
+				sprintf(
521
+					__('The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
522
+						'event_espresso'),
523
+					get_class($this)
524
+				)
525
+			);
526
+		}
527
+		/**
528
+		 * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
529
+		 */
530
+		if (empty(EEM_Base::$_model_query_blog_id)) {
531
+			EEM_Base::set_model_query_blog_id();
532
+		}
533
+		/**
534
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
535
+		 * just use EE_Register_Model_Extension
536
+		 *
537
+		 * @var EE_Table_Base[] $_tables
538
+		 */
539
+		$this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
540
+		foreach ($this->_tables as $table_alias => $table_obj) {
541
+			/** @var $table_obj EE_Table_Base */
542
+			$table_obj->_construct_finalize_with_alias($table_alias);
543
+			if ($table_obj instanceof EE_Secondary_Table) {
544
+				/** @var $table_obj EE_Secondary_Table */
545
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
546
+			}
547
+		}
548
+		/**
549
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
550
+		 * EE_Register_Model_Extension
551
+		 *
552
+		 * @param EE_Model_Field_Base[] $_fields
553
+		 */
554
+		$this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
555
+		$this->_invalidate_field_caches();
556
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
557
+			if (! array_key_exists($table_alias, $this->_tables)) {
558
+				throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
559
+					'event_espresso'), $table_alias, implode(",", $this->_fields)));
560
+			}
561
+			foreach ($fields_for_table as $field_name => $field_obj) {
562
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
563
+				//primary key field base has a slightly different _construct_finalize
564
+				/** @var $field_obj EE_Model_Field_Base */
565
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
566
+			}
567
+		}
568
+		// everything is related to Extra_Meta
569
+		if (get_class($this) !== 'EEM_Extra_Meta') {
570
+			//make extra meta related to everything, but don't block deleting things just
571
+			//because they have related extra meta info. For now just orphan those extra meta
572
+			//in the future we should automatically delete them
573
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
574
+		}
575
+		//and change logs
576
+		if (get_class($this) !== 'EEM_Change_Log') {
577
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
578
+		}
579
+		/**
580
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
581
+		 * EE_Register_Model_Extension
582
+		 *
583
+		 * @param EE_Model_Relation_Base[] $_model_relations
584
+		 */
585
+		$this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
586
+			$this->_model_relations);
587
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
588
+			/** @var $relation_obj EE_Model_Relation_Base */
589
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
590
+		}
591
+		foreach ($this->_indexes as $index_name => $index_obj) {
592
+			/** @var $index_obj EE_Index */
593
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
594
+		}
595
+		$this->set_timezone($timezone);
596
+		//finalize default where condition strategy, or set default
597
+		if (! $this->_default_where_conditions_strategy) {
598
+			//nothing was set during child constructor, so set default
599
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
600
+		}
601
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
602
+		if (! $this->_minimum_where_conditions_strategy) {
603
+			//nothing was set during child constructor, so set default
604
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
605
+		}
606
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
607
+		//if the cap slug hasn't been set, and we haven't set it to false on purpose
608
+		//to indicate to NOT set it, set it to the logical default
609
+		if ($this->_caps_slug === null) {
610
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
611
+		}
612
+		//initialize the standard cap restriction generators if none were specified by the child constructor
613
+		if ($this->_cap_restriction_generators !== false) {
614
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
615
+				if (! isset($this->_cap_restriction_generators[$cap_context])) {
616
+					$this->_cap_restriction_generators[$cap_context] = apply_filters(
617
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
618
+						new EE_Restriction_Generator_Protected(),
619
+						$cap_context,
620
+						$this
621
+					);
622
+				}
623
+			}
624
+		}
625
+		//if there are cap restriction generators, use them to make the default cap restrictions
626
+		if ($this->_cap_restriction_generators !== false) {
627
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
628
+				if (! $generator_object) {
629
+					continue;
630
+				}
631
+				if (! $generator_object instanceof EE_Restriction_Generator_Base) {
632
+					throw new EE_Error(
633
+						sprintf(
634
+							__('Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
635
+								'event_espresso'),
636
+							$context,
637
+							$this->get_this_model_name()
638
+						)
639
+					);
640
+				}
641
+				$action = $this->cap_action_for_context($context);
642
+				if (! $generator_object->construction_finalized()) {
643
+					$generator_object->_construct_finalize($this, $action);
644
+				}
645
+			}
646
+		}
647
+		do_action('AHEE__' . get_class($this) . '__construct__end');
648
+	}
649
+
650
+
651
+
652
+	/**
653
+	 * Generates the cap restrictions for the given context, or if they were
654
+	 * already generated just gets what's cached
655
+	 *
656
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
657
+	 * @return EE_Default_Where_Conditions[]
658
+	 */
659
+	protected function _generate_cap_restrictions($context)
660
+	{
661
+		if (isset($this->_cap_restriction_generators[$context])
662
+			&& $this->_cap_restriction_generators[$context]
663
+			   instanceof
664
+			   EE_Restriction_Generator_Base
665
+		) {
666
+			return $this->_cap_restriction_generators[$context]->generate_restrictions();
667
+		} else {
668
+			return array();
669
+		}
670
+	}
671
+
672
+
673
+
674
+	/**
675
+	 * Used to set the $_model_query_blog_id static property.
676
+	 *
677
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
678
+	 *                      value for get_current_blog_id() will be used.
679
+	 */
680
+	public static function set_model_query_blog_id($blog_id = 0)
681
+	{
682
+		EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
683
+	}
684
+
685
+
686
+
687
+	/**
688
+	 * Returns whatever is set as the internal $model_query_blog_id.
689
+	 *
690
+	 * @return int
691
+	 */
692
+	public static function get_model_query_blog_id()
693
+	{
694
+		return EEM_Base::$_model_query_blog_id;
695
+	}
696
+
697
+
698
+
699
+	/**
700
+	 *        This function is a singleton method used to instantiate the Espresso_model object
701
+	 *
702
+	 * @access public
703
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
704
+	 *                         incoming timezone data that gets saved).  Note this just sends the timezone info to the
705
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
706
+	 *                         timezone in the 'timezone_string' wp option)
707
+	 * @return static (as in the concrete child class)
708
+	 */
709
+	public static function instance($timezone = null)
710
+	{
711
+		// check if instance of Espresso_model already exists
712
+		if (! static::$_instance instanceof static) {
713
+			// instantiate Espresso_model
714
+			static::$_instance = new static($timezone);
715
+		}
716
+		//we might have a timezone set, let set_timezone decide what to do with it
717
+		static::$_instance->set_timezone($timezone);
718
+		// Espresso_model object
719
+		return static::$_instance;
720
+	}
721
+
722
+
723
+
724
+	/**
725
+	 * resets the model and returns it
726
+	 *
727
+	 * @param null | string $timezone
728
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
729
+	 * all its properties reset; if it wasn't instantiated, returns null)
730
+	 */
731
+	public static function reset($timezone = null)
732
+	{
733
+		if (static::$_instance instanceof EEM_Base) {
734
+			//let's try to NOT swap out the current instance for a new one
735
+			//because if someone has a reference to it, we can't remove their reference
736
+			//so it's best to keep using the same reference, but change the original object
737
+			//reset all its properties to their original values as defined in the class
738
+			$r = new ReflectionClass(get_class(static::$_instance));
739
+			$static_properties = $r->getStaticProperties();
740
+			foreach ($r->getDefaultProperties() as $property => $value) {
741
+				//don't set instance to null like it was originally,
742
+				//but it's static anyways, and we're ignoring static properties (for now at least)
743
+				if (! isset($static_properties[$property])) {
744
+					static::$_instance->{$property} = $value;
745
+				}
746
+			}
747
+			//and then directly call its constructor again, like we would if we
748
+			//were creating a new one
749
+			static::$_instance->__construct($timezone);
750
+			return self::instance();
751
+		}
752
+		return null;
753
+	}
754
+
755
+
756
+
757
+	/**
758
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
759
+	 *
760
+	 * @param  boolean $translated return localized strings or JUST the array.
761
+	 * @return array
762
+	 * @throws \EE_Error
763
+	 */
764
+	public function status_array($translated = false)
765
+	{
766
+		if (! array_key_exists('Status', $this->_model_relations)) {
767
+			return array();
768
+		}
769
+		$model_name = $this->get_this_model_name();
770
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
771
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
772
+		$status_array = array();
773
+		foreach ($stati as $status) {
774
+			$status_array[$status->ID()] = $status->get('STS_code');
775
+		}
776
+		return $translated
777
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
778
+			: $status_array;
779
+	}
780
+
781
+
782
+
783
+	/**
784
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
785
+	 *
786
+	 * @param array $query_params             {
787
+	 * @var array $0 (where) array {
788
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
789
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
790
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
791
+	 *                                        conditions based on related models (and even
792
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
793
+	 *                                        name. Eg,
794
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
795
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
796
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
797
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
798
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
799
+	 *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
800
+	 *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
801
+	 *                                        to Venues (even when each of those models actually consisted of two
802
+	 *                                        tables). Also, you may chain the model relations together. Eg instead of
803
+	 *                                        just having
804
+	 *                                        "Venue.VNU_ID", you could have
805
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
806
+	 *                                        events are related to Registrations, which are related to Attendees). You
807
+	 *                                        can take it even further with
808
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
809
+	 *                                        (from the default of '='), change the value to an numerically-indexed
810
+	 *                                        array, where the first item in the list is the operator. eg: array(
811
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
812
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
813
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
814
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
815
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
816
+	 *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
817
+	 *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
818
+	 *                                        the operator is IN. Also, values can actually be field names. To indicate
819
+	 *                                        the value is a field, simply provide a third array item (true) to the
820
+	 *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
821
+	 *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
822
+	 *                                        Note: you can also use related model field names like you would any other
823
+	 *                                        field name. eg:
824
+	 *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
825
+	 *                                        be used if you were querying EEM_Tickets (because Datetime is directly related to tickets) Also, by default all the where conditions are AND'd together. To override this, add an array key 'OR' (or 'AND') and the array to be OR'd together eg: array('OR'=>array('TXN_ID' => 23 , 'TXN_timestamp__>' =>
826
+	 *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
827
+	 *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
828
+	 *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
829
+	 *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
830
+	 *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
831
+	 *                                        to be what you last specified. IE, "AND"s by default, but if you had
832
+	 *                                        previously specified to use ORs to join, ORs will continue to be used.
833
+	 *                                        So, if you specify to use an "OR" to join conditions, it will continue to
834
+	 *                                        "stick" until you specify an AND. eg
835
+	 *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
836
+	 *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
837
+	 *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
838
+	 *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
839
+	 *                                        array('OR'=>array('TXN_total' => 23, 'NOT'=> array( 'TXN_timestamp'=> 345678912, 'AND'=>array('TXN_paid' => 53, 'STS_ID' => 'TIN')))) becomes SQL >> "...WHERE TXN_total = 23 OR ! (TXN_timestamp = 345678912 OR (TXN_paid = 53 AND STS_ID = 'TIN'))..." GOTCHA: because this is an array, array keys must be unique, making it impossible to place two or more where conditions applying to the same field. eg: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp'=>array('<',$end_date),'PAY_timestamp'=>array('!=',$special_date)), as PHP enforces that the array keys must be unique, thus removing the first two array entries with key 'PAY_timestamp'. becomes SQL >> "PAY_timestamp !=  4234232", ignoring the first two PAY_timestamp conditions). To overcome this, you can add a '*' character to the end of the field's name, followed by anything. These will be removed when generating the SQL string, but allow for the array keys to be unique. eg: you could rewrite the previous query as: array('PAY_timestamp'=>array('>',$start_date),'PAY_timestamp*1st'=>array('<',$end_date),'PAY_timestamp*2nd'=>array('!=',$special_date)) which correctly becomes SQL >>
840
+	 *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
841
+	 *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
842
+	 *                                        too, eg:
843
+	 *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
844
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
845
+	 *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
846
+	 *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
847
+	 *                                        Remember when you provide two numbers for the limit, the 1st number is
848
+	 *                                        the OFFSET, the 2nd is the LIMIT
849
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
850
+	 *                                        can do paging on one-to-many multi-table-joins. Send an array in the
851
+	 *                                        following format array('on_join_limit'
852
+	 *                                        => array( 'table_alias', array(1,2) ) ).
853
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
854
+	 *                                        values are either 'ASC' or 'DESC'.
855
+	 *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
856
+	 *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
857
+	 *                                        DESC..." respectively. Like the
858
+	 *                                        'where' conditions, these fields can be on related models. Eg
859
+	 *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
860
+	 *                                        perfectly valid from any model related to 'Registration' (like Event,
861
+	 *                                        Attendee, Price, Datetime, etc.)
862
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
863
+	 *                                        'order' specifies whether to order the field specified in 'order_by' in
864
+	 *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
865
+	 *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
866
+	 *                                        order by the primary key. Eg,
867
+	 *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
868
+	 *                                        //(will join with the Datetime model's table(s) and order by its field
869
+	 *                                        DTT_EVT_start) or
870
+	 *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
871
+	 *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
872
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
873
+	 *                                        'group_by'=>'VNU_ID', or
874
+	 *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
875
+	 *                                        if no
876
+	 *                                        $group_by is specified, and a limit is set, automatically groups by the
877
+	 *                                        model's primary key (or combined primary keys). This avoids some
878
+	 *                                        weirdness that results when using limits, tons of joins, and no group by,
879
+	 *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
880
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
881
+	 *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
882
+	 *                                        results)
883
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
884
+	 *                                        array where values are models to be joined in the query.Eg
885
+	 *                                        array('Attendee','Payment','Datetime'). You may join with transient
886
+	 *                                        models using period, eg "Registration.Transaction.Payment". You will
887
+	 *                                        probably only want to do this in hopes of increasing efficiency, as
888
+	 *                                        related models which belongs to the current model
889
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
890
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
891
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
892
+	 *                                        set this to 'none' to disable all default where conditions. Eg, usually
893
+	 *                                        soft-deleted objects are filtered-out if you want to include them, set
894
+	 *                                        this query param to 'none'. If you want to ONLY disable THIS model's
895
+	 *                                        default where conditions set it to 'other_models_only'. If you only want
896
+	 *                                        this model's default where conditions added to the query, use
897
+	 *                                        'this_model_only'. If you want to use all default where conditions
898
+	 *                                        (default), set to 'all'.
899
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
900
+	 *                                        we just NOT apply any capabilities/permissions/restrictions and return
901
+	 *                                        everything? Or should we only show the current user items they should be
902
+	 *                                        able to view on the frontend, backend, edit, or delete? can be set to
903
+	 *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
904
+	 *                                        }
905
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
906
+	 *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
907
+	 *                                        again. Array keys are object IDs (if there is a primary key on the model.
908
+	 *                                        if not, numerically indexed) Some full examples: get 10 transactions
909
+	 *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
910
+	 *                                        array( array(
911
+	 *                                        'OR'=>array(
912
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
913
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
914
+	 *                                        )
915
+	 *                                        ),
916
+	 *                                        'limit'=>10,
917
+	 *                                        'group_by'=>'TXN_ID'
918
+	 *                                        ));
919
+	 *                                        get all the answers to the question titled "shirt size" for event with id
920
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
921
+	 *                                        'Question.QST_display_text'=>'shirt size',
922
+	 *                                        'Registration.Event.EVT_ID'=>12
923
+	 *                                        ),
924
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
925
+	 *                                        ));
926
+	 * @throws \EE_Error
927
+	 */
928
+	public function get_all($query_params = array())
929
+	{
930
+		if (isset($query_params['limit'])
931
+			&& ! isset($query_params['group_by'])
932
+		) {
933
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
934
+		}
935
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
936
+	}
937
+
938
+
939
+
940
+	/**
941
+	 * Modifies the query parameters so we only get back model objects
942
+	 * that "belong" to the current user
943
+	 *
944
+	 * @param array $query_params @see EEM_Base::get_all()
945
+	 * @return array like EEM_Base::get_all
946
+	 */
947
+	public function alter_query_params_to_only_include_mine($query_params = array())
948
+	{
949
+		$wp_user_field_name = $this->wp_user_field_name();
950
+		if ($wp_user_field_name) {
951
+			$query_params[0][$wp_user_field_name] = get_current_user_id();
952
+		}
953
+		return $query_params;
954
+	}
955
+
956
+
957
+
958
+	/**
959
+	 * Returns the name of the field's name that points to the WP_User table
960
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
961
+	 * foreign key to the WP_User table)
962
+	 *
963
+	 * @return string|boolean string on success, boolean false when there is no
964
+	 * foreign key to the WP_User table
965
+	 */
966
+	public function wp_user_field_name()
967
+	{
968
+		try {
969
+			if (! empty($this->_model_chain_to_wp_user)) {
970
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
971
+				$last_model_name = end($models_to_follow_to_wp_users);
972
+				$model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
973
+				$model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
974
+			} else {
975
+				$model_with_fk_to_wp_users = $this;
976
+				$model_chain_to_wp_user = '';
977
+			}
978
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
979
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
980
+		} catch (EE_Error $e) {
981
+			return false;
982
+		}
983
+	}
984
+
985
+
986
+
987
+	/**
988
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
989
+	 * (or transiently-related model) has a foreign key to the wp_users table;
990
+	 * useful for finding if model objects of this type are 'owned' by the current user.
991
+	 * This is an empty string when the foreign key is on this model and when it isn't,
992
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
993
+	 * (or transiently-related model)
994
+	 *
995
+	 * @return string
996
+	 */
997
+	public function model_chain_to_wp_user()
998
+	{
999
+		return $this->_model_chain_to_wp_user;
1000
+	}
1001
+
1002
+
1003
+
1004
+	/**
1005
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1006
+	 * like how registrations don't have a foreign key to wp_users, but the
1007
+	 * events they are for are), or is unrelated to wp users.
1008
+	 * generally available
1009
+	 *
1010
+	 * @return boolean
1011
+	 */
1012
+	public function is_owned()
1013
+	{
1014
+		if ($this->model_chain_to_wp_user()) {
1015
+			return true;
1016
+		} else {
1017
+			try {
1018
+				$this->get_foreign_key_to('WP_User');
1019
+				return true;
1020
+			} catch (EE_Error $e) {
1021
+				return false;
1022
+			}
1023
+		}
1024
+	}
1025
+
1026
+
1027
+
1028
+	/**
1029
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1030
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1031
+	 * the model)
1032
+	 *
1033
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1034
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1035
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1036
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1037
+	 *                                  override this and set the select to "*", or a specific column name, like
1038
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1039
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1040
+	 *                                  the aliases used to refer to this selection, and values are to be
1041
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1042
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1043
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1044
+	 * @throws \EE_Error
1045
+	 */
1046
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1047
+	{
1048
+		// remember the custom selections, if any, and type cast as array
1049
+		// (unless $columns_to_select is an object, then just set as an empty array)
1050
+		// Note: (array) 'some string' === array( 'some string' )
1051
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1052
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1053
+		$select_expressions = $columns_to_select !== null
1054
+			? $this->_construct_select_from_input($columns_to_select)
1055
+			: $this->_construct_default_select_sql($model_query_info);
1056
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1057
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
1058
+	}
1059
+
1060
+
1061
+
1062
+	/**
1063
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
1064
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
1065
+	 * take care of joins, field preparation etc.
1066
+	 *
1067
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1068
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1069
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1070
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1071
+	 *                                  override this and set the select to "*", or a specific column name, like
1072
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1073
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1074
+	 *                                  the aliases used to refer to this selection, and values are to be
1075
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1076
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1077
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1078
+	 * @throws \EE_Error
1079
+	 */
1080
+	public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1081
+	{
1082
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1083
+	}
1084
+
1085
+
1086
+
1087
+	/**
1088
+	 * For creating a custom select statement
1089
+	 *
1090
+	 * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1091
+	 *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1092
+	 *                                 SQL, and 1=>is the datatype
1093
+	 * @throws EE_Error
1094
+	 * @return string
1095
+	 */
1096
+	private function _construct_select_from_input($columns_to_select)
1097
+	{
1098
+		if (is_array($columns_to_select)) {
1099
+			$select_sql_array = array();
1100
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
1101
+				if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1102
+					throw new EE_Error(
1103
+						sprintf(
1104
+							__(
1105
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1106
+								"event_espresso"
1107
+							),
1108
+							$selection_and_datatype,
1109
+							$alias
1110
+						)
1111
+					);
1112
+				}
1113
+				if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1114
+					throw new EE_Error(
1115
+						sprintf(
1116
+							__(
1117
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1118
+								"event_espresso"
1119
+							),
1120
+							$selection_and_datatype[1],
1121
+							$selection_and_datatype[0],
1122
+							$alias,
1123
+							implode(",", $this->_valid_wpdb_data_types)
1124
+						)
1125
+					);
1126
+				}
1127
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1128
+			}
1129
+			$columns_to_select_string = implode(", ", $select_sql_array);
1130
+		} else {
1131
+			$columns_to_select_string = $columns_to_select;
1132
+		}
1133
+		return $columns_to_select_string;
1134
+	}
1135
+
1136
+
1137
+
1138
+	/**
1139
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1140
+	 *
1141
+	 * @return string
1142
+	 * @throws \EE_Error
1143
+	 */
1144
+	public function primary_key_name()
1145
+	{
1146
+		return $this->get_primary_key_field()->get_name();
1147
+	}
1148
+
1149
+
1150
+
1151
+	/**
1152
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1153
+	 * If there is no primary key on this model, $id is treated as primary key string
1154
+	 *
1155
+	 * @param mixed $id int or string, depending on the type of the model's primary key
1156
+	 * @return EE_Base_Class
1157
+	 */
1158
+	public function get_one_by_ID($id)
1159
+	{
1160
+		if ($this->get_from_entity_map($id)) {
1161
+			return $this->get_from_entity_map($id);
1162
+		}
1163
+		return $this->get_one(
1164
+			$this->alter_query_params_to_restrict_by_ID(
1165
+				$id,
1166
+				array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1167
+			)
1168
+		);
1169
+	}
1170
+
1171
+
1172
+
1173
+	/**
1174
+	 * Alters query parameters to only get items with this ID are returned.
1175
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1176
+	 * or could just be a simple primary key ID
1177
+	 *
1178
+	 * @param int   $id
1179
+	 * @param array $query_params
1180
+	 * @return array of normal query params, @see EEM_Base::get_all
1181
+	 * @throws \EE_Error
1182
+	 */
1183
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1184
+	{
1185
+		if (! isset($query_params[0])) {
1186
+			$query_params[0] = array();
1187
+		}
1188
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
1189
+		if ($conditions_from_id === null) {
1190
+			$query_params[0][$this->primary_key_name()] = $id;
1191
+		} else {
1192
+			//no primary key, so the $id must be from the get_index_primary_key_string()
1193
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1194
+		}
1195
+		return $query_params;
1196
+	}
1197
+
1198
+
1199
+
1200
+	/**
1201
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1202
+	 * array. If no item is found, null is returned.
1203
+	 *
1204
+	 * @param array $query_params like EEM_Base's $query_params variable.
1205
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1206
+	 * @throws \EE_Error
1207
+	 */
1208
+	public function get_one($query_params = array())
1209
+	{
1210
+		if (! is_array($query_params)) {
1211
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
1212
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1213
+					gettype($query_params)), '4.6.0');
1214
+			$query_params = array();
1215
+		}
1216
+		$query_params['limit'] = 1;
1217
+		$items = $this->get_all($query_params);
1218
+		if (empty($items)) {
1219
+			return null;
1220
+		} else {
1221
+			return array_shift($items);
1222
+		}
1223
+	}
1224
+
1225
+
1226
+
1227
+	/**
1228
+	 * Returns the next x number of items in sequence from the given value as
1229
+	 * found in the database matching the given query conditions.
1230
+	 *
1231
+	 * @param mixed $current_field_value    Value used for the reference point.
1232
+	 * @param null  $field_to_order_by      What field is used for the
1233
+	 *                                      reference point.
1234
+	 * @param int   $limit                  How many to return.
1235
+	 * @param array $query_params           Extra conditions on the query.
1236
+	 * @param null  $columns_to_select      If left null, then an array of
1237
+	 *                                      EE_Base_Class objects is returned,
1238
+	 *                                      otherwise you can indicate just the
1239
+	 *                                      columns you want returned.
1240
+	 * @return EE_Base_Class[]|array
1241
+	 * @throws \EE_Error
1242
+	 */
1243
+	public function next_x(
1244
+		$current_field_value,
1245
+		$field_to_order_by = null,
1246
+		$limit = 1,
1247
+		$query_params = array(),
1248
+		$columns_to_select = null
1249
+	) {
1250
+		return $this->_get_consecutive($current_field_value, '>', $field_to_order_by, $limit, $query_params,
1251
+			$columns_to_select);
1252
+	}
1253
+
1254
+
1255
+
1256
+	/**
1257
+	 * Returns the previous x number of items in sequence from the given value
1258
+	 * as found in the database matching the given query conditions.
1259
+	 *
1260
+	 * @param mixed $current_field_value    Value used for the reference point.
1261
+	 * @param null  $field_to_order_by      What field is used for the
1262
+	 *                                      reference point.
1263
+	 * @param int   $limit                  How many to return.
1264
+	 * @param array $query_params           Extra conditions on the query.
1265
+	 * @param null  $columns_to_select      If left null, then an array of
1266
+	 *                                      EE_Base_Class objects is returned,
1267
+	 *                                      otherwise you can indicate just the
1268
+	 *                                      columns you want returned.
1269
+	 * @return EE_Base_Class[]|array
1270
+	 * @throws \EE_Error
1271
+	 */
1272
+	public function previous_x(
1273
+		$current_field_value,
1274
+		$field_to_order_by = null,
1275
+		$limit = 1,
1276
+		$query_params = array(),
1277
+		$columns_to_select = null
1278
+	) {
1279
+		return $this->_get_consecutive($current_field_value, '<', $field_to_order_by, $limit, $query_params,
1280
+			$columns_to_select);
1281
+	}
1282
+
1283
+
1284
+
1285
+	/**
1286
+	 * Returns the next item in sequence from the given value as found in the
1287
+	 * database matching the given query conditions.
1288
+	 *
1289
+	 * @param mixed $current_field_value    Value used for the reference point.
1290
+	 * @param null  $field_to_order_by      What field is used for the
1291
+	 *                                      reference point.
1292
+	 * @param array $query_params           Extra conditions on the query.
1293
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1294
+	 *                                      object is returned, otherwise you
1295
+	 *                                      can indicate just the columns you
1296
+	 *                                      want and a single array indexed by
1297
+	 *                                      the columns will be returned.
1298
+	 * @return EE_Base_Class|null|array()
1299
+	 * @throws \EE_Error
1300
+	 */
1301
+	public function next(
1302
+		$current_field_value,
1303
+		$field_to_order_by = null,
1304
+		$query_params = array(),
1305
+		$columns_to_select = null
1306
+	) {
1307
+		$results = $this->_get_consecutive($current_field_value, '>', $field_to_order_by, 1, $query_params,
1308
+			$columns_to_select);
1309
+		return empty($results) ? null : reset($results);
1310
+	}
1311
+
1312
+
1313
+
1314
+	/**
1315
+	 * Returns the previous item in sequence from the given value as found in
1316
+	 * the database matching the given query conditions.
1317
+	 *
1318
+	 * @param mixed $current_field_value    Value used for the reference point.
1319
+	 * @param null  $field_to_order_by      What field is used for the
1320
+	 *                                      reference point.
1321
+	 * @param array $query_params           Extra conditions on the query.
1322
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1323
+	 *                                      object is returned, otherwise you
1324
+	 *                                      can indicate just the columns you
1325
+	 *                                      want and a single array indexed by
1326
+	 *                                      the columns will be returned.
1327
+	 * @return EE_Base_Class|null|array()
1328
+	 * @throws EE_Error
1329
+	 */
1330
+	public function previous(
1331
+		$current_field_value,
1332
+		$field_to_order_by = null,
1333
+		$query_params = array(),
1334
+		$columns_to_select = null
1335
+	) {
1336
+		$results = $this->_get_consecutive($current_field_value, '<', $field_to_order_by, 1, $query_params,
1337
+			$columns_to_select);
1338
+		return empty($results) ? null : reset($results);
1339
+	}
1340
+
1341
+
1342
+
1343
+	/**
1344
+	 * Returns the a consecutive number of items in sequence from the given
1345
+	 * value as found in the database matching the given query conditions.
1346
+	 *
1347
+	 * @param mixed  $current_field_value   Value used for the reference point.
1348
+	 * @param string $operand               What operand is used for the sequence.
1349
+	 * @param string $field_to_order_by     What field is used for the reference point.
1350
+	 * @param int    $limit                 How many to return.
1351
+	 * @param array  $query_params          Extra conditions on the query.
1352
+	 * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1353
+	 *                                      otherwise you can indicate just the columns you want returned.
1354
+	 * @return EE_Base_Class[]|array
1355
+	 * @throws EE_Error
1356
+	 */
1357
+	protected function _get_consecutive(
1358
+		$current_field_value,
1359
+		$operand = '>',
1360
+		$field_to_order_by = null,
1361
+		$limit = 1,
1362
+		$query_params = array(),
1363
+		$columns_to_select = null
1364
+	) {
1365
+		//if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1366
+		if (empty($field_to_order_by)) {
1367
+			if ($this->has_primary_key_field()) {
1368
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
1369
+			} else {
1370
+				if (WP_DEBUG) {
1371
+					throw new EE_Error(__('EEM_Base::_get_consecutive() has been called with no $field_to_order_by argument and there is no primary key on the field.  Please provide the field you would like to use as the base for retrieving the next item(s).',
1372
+						'event_espresso'));
1373
+				}
1374
+				EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1375
+				return array();
1376
+			}
1377
+		}
1378
+		if (! is_array($query_params)) {
1379
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1380
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1381
+					gettype($query_params)), '4.6.0');
1382
+			$query_params = array();
1383
+		}
1384
+		//let's add the where query param for consecutive look up.
1385
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1386
+		$query_params['limit'] = $limit;
1387
+		//set direction
1388
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1389
+		$query_params['order_by'] = $operand === '>'
1390
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
1391
+			: array($field_to_order_by => 'DESC') + $incoming_orderby;
1392
+		//if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1393
+		if (empty($columns_to_select)) {
1394
+			return $this->get_all($query_params);
1395
+		} else {
1396
+			//getting just the fields
1397
+			return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1398
+		}
1399
+	}
1400
+
1401
+
1402
+
1403
+	/**
1404
+	 * This sets the _timezone property after model object has been instantiated.
1405
+	 *
1406
+	 * @param null | string $timezone valid PHP DateTimeZone timezone string
1407
+	 */
1408
+	public function set_timezone($timezone)
1409
+	{
1410
+		if ($timezone !== null) {
1411
+			$this->_timezone = $timezone;
1412
+		}
1413
+		//note we need to loop through relations and set the timezone on those objects as well.
1414
+		foreach ($this->_model_relations as $relation) {
1415
+			$relation->set_timezone($timezone);
1416
+		}
1417
+		//and finally we do the same for any datetime fields
1418
+		foreach ($this->_fields as $field) {
1419
+			if ($field instanceof EE_Datetime_Field) {
1420
+				$field->set_timezone($timezone);
1421
+			}
1422
+		}
1423
+	}
1424
+
1425
+
1426
+
1427
+	/**
1428
+	 * This just returns whatever is set for the current timezone.
1429
+	 *
1430
+	 * @access public
1431
+	 * @return string
1432
+	 */
1433
+	public function get_timezone()
1434
+	{
1435
+		//first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1436
+		if (empty($this->_timezone)) {
1437
+			foreach ($this->_fields as $field) {
1438
+				if ($field instanceof EE_Datetime_Field) {
1439
+					$this->set_timezone($field->get_timezone());
1440
+					break;
1441
+				}
1442
+			}
1443
+		}
1444
+		//if timezone STILL empty then return the default timezone for the site.
1445
+		if (empty($this->_timezone)) {
1446
+			$this->set_timezone(EEH_DTT_Helper::get_timezone());
1447
+		}
1448
+		return $this->_timezone;
1449
+	}
1450
+
1451
+
1452
+
1453
+	/**
1454
+	 * This returns the date formats set for the given field name and also ensures that
1455
+	 * $this->_timezone property is set correctly.
1456
+	 *
1457
+	 * @since 4.6.x
1458
+	 * @param string $field_name The name of the field the formats are being retrieved for.
1459
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1460
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1461
+	 * @return array formats in an array with the date format first, and the time format last.
1462
+	 */
1463
+	public function get_formats_for($field_name, $pretty = false)
1464
+	{
1465
+		$field_settings = $this->field_settings_for($field_name);
1466
+		//if not a valid EE_Datetime_Field then throw error
1467
+		if (! $field_settings instanceof EE_Datetime_Field) {
1468
+			throw new EE_Error(sprintf(__('The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
1469
+				'event_espresso'), $field_name));
1470
+		}
1471
+		//while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1472
+		//the field.
1473
+		$this->_timezone = $field_settings->get_timezone();
1474
+		return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1475
+	}
1476
+
1477
+
1478
+
1479
+	/**
1480
+	 * This returns the current time in a format setup for a query on this model.
1481
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1482
+	 * it will return:
1483
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1484
+	 *  NOW
1485
+	 *  - or a unix timestamp (equivalent to time())
1486
+	 *
1487
+	 * @since 4.6.x
1488
+	 * @param string $field_name       The field the current time is needed for.
1489
+	 * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1490
+	 *                                 formatted string matching the set format for the field in the set timezone will
1491
+	 *                                 be returned.
1492
+	 * @param string $what             Whether to return the string in just the time format, the date format, or both.
1493
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1494
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1495
+	 *                                 exception is triggered.
1496
+	 */
1497
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1498
+	{
1499
+		$formats = $this->get_formats_for($field_name);
1500
+		$DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1501
+		if ($timestamp) {
1502
+			return $DateTime->format('U');
1503
+		}
1504
+		//not returning timestamp, so return formatted string in timezone.
1505
+		switch ($what) {
1506
+			case 'time' :
1507
+				return $DateTime->format($formats[1]);
1508
+				break;
1509
+			case 'date' :
1510
+				return $DateTime->format($formats[0]);
1511
+				break;
1512
+			default :
1513
+				return $DateTime->format(implode(' ', $formats));
1514
+				break;
1515
+		}
1516
+	}
1517
+
1518
+
1519
+
1520
+	/**
1521
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1522
+	 * for the model are.  Returns a DateTime object.
1523
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1524
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1525
+	 * ignored.
1526
+	 *
1527
+	 * @param string $field_name      The field being setup.
1528
+	 * @param string $timestring      The date time string being used.
1529
+	 * @param string $incoming_format The format for the time string.
1530
+	 * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1531
+	 *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1532
+	 *                                format is
1533
+	 *                                'U', this is ignored.
1534
+	 * @return DateTime
1535
+	 * @throws \EE_Error
1536
+	 */
1537
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1538
+	{
1539
+		//just using this to ensure the timezone is set correctly internally
1540
+		$this->get_formats_for($field_name);
1541
+		//load EEH_DTT_Helper
1542
+		$set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1543
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1544
+		return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1545
+	}
1546
+
1547
+
1548
+
1549
+	/**
1550
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1551
+	 *
1552
+	 * @return EE_Table_Base[]
1553
+	 */
1554
+	public function get_tables()
1555
+	{
1556
+		return $this->_tables;
1557
+	}
1558
+
1559
+
1560
+
1561
+	/**
1562
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1563
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
1564
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1565
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1566
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1567
+	 * model object with EVT_ID = 1
1568
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1569
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1570
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1571
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1572
+	 * are not specified)
1573
+	 *
1574
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1575
+	 *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1576
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
1577
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
1578
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
1579
+	 *                                         ID=34, we'd use this method as follows:
1580
+	 *                                         EEM_Transaction::instance()->update(
1581
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1582
+	 *                                         array(array('TXN_ID'=>34)));
1583
+	 * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1584
+	 *                                         in client code into what's expected to be stored on each field. Eg,
1585
+	 *                                         consider updating Question's QST_admin_label field is of type
1586
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
1587
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
1588
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
1589
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1590
+	 *                                         TRUE, it is assumed that you've already called
1591
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1592
+	 *                                         malicious javascript. However, if
1593
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
1594
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1595
+	 *                                         and every other field, before insertion. We provide this parameter
1596
+	 *                                         because model objects perform their prepare_for_set function on all
1597
+	 *                                         their values, and so don't need to be called again (and in many cases,
1598
+	 *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1599
+	 *                                         prepare_for_set method...)
1600
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1601
+	 *                                         in this model's entity map according to $fields_n_values that match
1602
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
1603
+	 *                                         by setting this to FALSE, but be aware that model objects being used
1604
+	 *                                         could get out-of-sync with the database
1605
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1606
+	 *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1607
+	 *                                         bad)
1608
+	 * @throws \EE_Error
1609
+	 */
1610
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1611
+	{
1612
+		if (! is_array($query_params)) {
1613
+			EE_Error::doing_it_wrong('EEM_Base::update',
1614
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1615
+					gettype($query_params)), '4.6.0');
1616
+			$query_params = array();
1617
+		}
1618
+		/**
1619
+		 * Action called before a model update call has been made.
1620
+		 *
1621
+		 * @param EEM_Base $model
1622
+		 * @param array    $fields_n_values the updated fields and their new values
1623
+		 * @param array    $query_params    @see EEM_Base::get_all()
1624
+		 */
1625
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1626
+		/**
1627
+		 * Filters the fields about to be updated given the query parameters. You can provide the
1628
+		 * $query_params to $this->get_all() to find exactly which records will be updated
1629
+		 *
1630
+		 * @param array    $fields_n_values fields and their new values
1631
+		 * @param EEM_Base $model           the model being queried
1632
+		 * @param array    $query_params    see EEM_Base::get_all()
1633
+		 */
1634
+		$fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1635
+			$query_params);
1636
+		//need to verify that, for any entry we want to update, there are entries in each secondary table.
1637
+		//to do that, for each table, verify that it's PK isn't null.
1638
+		$tables = $this->get_tables();
1639
+		//and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
1640
+		//NOTE: we should make this code more efficient by NOT querying twice
1641
+		//before the real update, but that needs to first go through ALPHA testing
1642
+		//as it's dangerous. says Mike August 8 2014
1643
+		//we want to make sure the default_where strategy is ignored
1644
+		$this->_ignore_where_strategy = true;
1645
+		$wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1646
+		foreach ($wpdb_select_results as $wpdb_result) {
1647
+			// type cast stdClass as array
1648
+			$wpdb_result = (array)$wpdb_result;
1649
+			//get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1650
+			if ($this->has_primary_key_field()) {
1651
+				$main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1652
+			} else {
1653
+				//if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
1654
+				$main_table_pk_value = null;
1655
+			}
1656
+			//if there are more than 1 tables, we'll want to verify that each table for this model has an entry in the other tables
1657
+			//and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
1658
+			if (count($tables) > 1) {
1659
+				//foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1660
+				//in that table, and so we'll want to insert one
1661
+				foreach ($tables as $table_obj) {
1662
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1663
+					//if there is no private key for this table on the results, it means there's no entry
1664
+					//in this table, right? so insert a row in the current table, using any fields available
1665
+					if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1666
+						   && $wpdb_result[$this_table_pk_column])
1667
+					) {
1668
+						$success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1669
+							$main_table_pk_value);
1670
+						//if we died here, report the error
1671
+						if (! $success) {
1672
+							return false;
1673
+						}
1674
+					}
1675
+				}
1676
+			}
1677
+			//				//and now check that if we have cached any models by that ID on the model, that
1678
+			//				//they also get updated properly
1679
+			//				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1680
+			//				if( $model_object ){
1681
+			//					foreach( $fields_n_values as $field => $value ){
1682
+			//						$model_object->set($field, $value);
1683
+			//let's make sure default_where strategy is followed now
1684
+			$this->_ignore_where_strategy = false;
1685
+		}
1686
+		//if we want to keep model objects in sync, AND
1687
+		//if this wasn't called from a model object (to update itself)
1688
+		//then we want to make sure we keep all the existing
1689
+		//model objects in sync with the db
1690
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1691
+			if ($this->has_primary_key_field()) {
1692
+				$model_objs_affected_ids = $this->get_col($query_params);
1693
+			} else {
1694
+				//we need to select a bunch of columns and then combine them into the the "index primary key string"s
1695
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1696
+				$model_objs_affected_ids = array();
1697
+				foreach ($models_affected_key_columns as $row) {
1698
+					$combined_index_key = $this->get_index_primary_key_string($row);
1699
+					$model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1700
+				}
1701
+			}
1702
+			if (! $model_objs_affected_ids) {
1703
+				//wait wait wait- if nothing was affected let's stop here
1704
+				return 0;
1705
+			}
1706
+			foreach ($model_objs_affected_ids as $id) {
1707
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
1708
+				if ($model_obj_in_entity_map) {
1709
+					foreach ($fields_n_values as $field => $new_value) {
1710
+						$model_obj_in_entity_map->set($field, $new_value);
1711
+					}
1712
+				}
1713
+			}
1714
+			//if there is a primary key on this model, we can now do a slight optimization
1715
+			if ($this->has_primary_key_field()) {
1716
+				//we already know what we want to update. So let's make the query simpler so it's a little more efficient
1717
+				$query_params = array(
1718
+					array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1719
+					'limit'                    => count($model_objs_affected_ids),
1720
+					'default_where_conditions' => EEM_Base::default_where_conditions_none,
1721
+				);
1722
+			}
1723
+		}
1724
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1725
+		$SQL = "UPDATE "
1726
+			   . $model_query_info->get_full_join_sql()
1727
+			   . " SET "
1728
+			   . $this->_construct_update_sql($fields_n_values)
1729
+			   . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1730
+		$rows_affected = $this->_do_wpdb_query('query', array($SQL));
1731
+		/**
1732
+		 * Action called after a model update call has been made.
1733
+		 *
1734
+		 * @param EEM_Base $model
1735
+		 * @param array    $fields_n_values the updated fields and their new values
1736
+		 * @param array    $query_params    @see EEM_Base::get_all()
1737
+		 * @param int      $rows_affected
1738
+		 */
1739
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1740
+		return $rows_affected;//how many supposedly got updated
1741
+	}
1742
+
1743
+
1744
+
1745
+	/**
1746
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1747
+	 * are teh values of the field specified (or by default the primary key field)
1748
+	 * that matched the query params. Note that you should pass the name of the
1749
+	 * model FIELD, not the database table's column name.
1750
+	 *
1751
+	 * @param array  $query_params @see EEM_Base::get_all()
1752
+	 * @param string $field_to_select
1753
+	 * @return array just like $wpdb->get_col()
1754
+	 * @throws \EE_Error
1755
+	 */
1756
+	public function get_col($query_params = array(), $field_to_select = null)
1757
+	{
1758
+		if ($field_to_select) {
1759
+			$field = $this->field_settings_for($field_to_select);
1760
+		} elseif ($this->has_primary_key_field()) {
1761
+			$field = $this->get_primary_key_field();
1762
+		} else {
1763
+			//no primary key, just grab the first column
1764
+			$field = reset($this->field_settings());
1765
+		}
1766
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1767
+		$select_expressions = $field->get_qualified_column();
1768
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1769
+		return $this->_do_wpdb_query('get_col', array($SQL));
1770
+	}
1771
+
1772
+
1773
+
1774
+	/**
1775
+	 * Returns a single column value for a single row from the database
1776
+	 *
1777
+	 * @param array  $query_params    @see EEM_Base::get_all()
1778
+	 * @param string $field_to_select @see EEM_Base::get_col()
1779
+	 * @return string
1780
+	 * @throws \EE_Error
1781
+	 */
1782
+	public function get_var($query_params = array(), $field_to_select = null)
1783
+	{
1784
+		$query_params['limit'] = 1;
1785
+		$col = $this->get_col($query_params, $field_to_select);
1786
+		if (! empty($col)) {
1787
+			return reset($col);
1788
+		} else {
1789
+			return null;
1790
+		}
1791
+	}
1792
+
1793
+
1794
+
1795
+	/**
1796
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1797
+	 * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1798
+	 * injection, but currently no further filtering is done
1799
+	 *
1800
+	 * @global      $wpdb
1801
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1802
+	 *                               be updated to in the DB
1803
+	 * @return string of SQL
1804
+	 * @throws \EE_Error
1805
+	 */
1806
+	public function _construct_update_sql($fields_n_values)
1807
+	{
1808
+		/** @type WPDB $wpdb */
1809
+		global $wpdb;
1810
+		$cols_n_values = array();
1811
+		foreach ($fields_n_values as $field_name => $value) {
1812
+			$field_obj = $this->field_settings_for($field_name);
1813
+			//if the value is NULL, we want to assign the value to that.
1814
+			//wpdb->prepare doesn't really handle that properly
1815
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1816
+			$value_sql = $prepared_value === null ? 'NULL'
1817
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1818
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1819
+		}
1820
+		return implode(",", $cols_n_values);
1821
+	}
1822
+
1823
+
1824
+
1825
+	/**
1826
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1827
+	 * Performs a HARD delete, meaning the database row should always be removed,
1828
+	 * not just have a flag field on it switched
1829
+	 * Wrapper for EEM_Base::delete_permanently()
1830
+	 *
1831
+	 * @param mixed $id
1832
+	 * @return boolean whether the row got deleted or not
1833
+	 * @throws \EE_Error
1834
+	 */
1835
+	public function delete_permanently_by_ID($id)
1836
+	{
1837
+		return $this->delete_permanently(
1838
+			array(
1839
+				array($this->get_primary_key_field()->get_name() => $id),
1840
+				'limit' => 1,
1841
+			)
1842
+		);
1843
+	}
1844
+
1845
+
1846
+
1847
+	/**
1848
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1849
+	 * Wrapper for EEM_Base::delete()
1850
+	 *
1851
+	 * @param mixed $id
1852
+	 * @return boolean whether the row got deleted or not
1853
+	 * @throws \EE_Error
1854
+	 */
1855
+	public function delete_by_ID($id)
1856
+	{
1857
+		return $this->delete(
1858
+			array(
1859
+				array($this->get_primary_key_field()->get_name() => $id),
1860
+				'limit' => 1,
1861
+			)
1862
+		);
1863
+	}
1864
+
1865
+
1866
+
1867
+	/**
1868
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
1869
+	 * meaning if the model has a field that indicates its been "trashed" or
1870
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
1871
+	 *
1872
+	 * @see EEM_Base::delete_permanently
1873
+	 * @param array   $query_params
1874
+	 * @param boolean $allow_blocking
1875
+	 * @return int how many rows got deleted
1876
+	 * @throws \EE_Error
1877
+	 */
1878
+	public function delete($query_params, $allow_blocking = true)
1879
+	{
1880
+		return $this->delete_permanently($query_params, $allow_blocking);
1881
+	}
1882
+
1883
+
1884
+
1885
+	/**
1886
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
1887
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1888
+	 * as archived, not actually deleted
1889
+	 *
1890
+	 * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1891
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1892
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1893
+	 *                                deletes regardless of other objects which may depend on it. Its generally
1894
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1895
+	 *                                DB
1896
+	 * @return int how many rows got deleted
1897
+	 * @throws \EE_Error
1898
+	 */
1899
+	public function delete_permanently($query_params, $allow_blocking = true)
1900
+	{
1901
+		/**
1902
+		 * Action called just before performing a real deletion query. You can use the
1903
+		 * model and its $query_params to find exactly which items will be deleted
1904
+		 *
1905
+		 * @param EEM_Base $model
1906
+		 * @param array    $query_params   @see EEM_Base::get_all()
1907
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
1908
+		 *                                 to block (prevent) this deletion
1909
+		 */
1910
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1911
+		//some MySQL databases may be running safe mode, which may restrict
1912
+		//deletion if there is no KEY column used in the WHERE statement of a deletion.
1913
+		//to get around this, we first do a SELECT, get all the IDs, and then run another query
1914
+		//to delete them
1915
+		$items_for_deletion = $this->_get_all_wpdb_results($query_params);
1916
+		$deletion_where = $this->_setup_ids_for_delete($items_for_deletion, $allow_blocking);
1917
+		if ($deletion_where) {
1918
+			//echo "objects for deletion:";var_dump($objects_for_deletion);
1919
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
1920
+			$table_aliases = array_keys($this->_tables);
1921
+			$SQL = "DELETE "
1922
+				   . implode(", ", $table_aliases)
1923
+				   . " FROM "
1924
+				   . $model_query_info->get_full_join_sql()
1925
+				   . " WHERE "
1926
+				   . $deletion_where;
1927
+			//		/echo "delete sql:$SQL";
1928
+			$rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1929
+		} else {
1930
+			$rows_deleted = 0;
1931
+		}
1932
+		//and lastly make sure those items are removed from the entity map; if they could be put into it at all
1933
+		if ($this->has_primary_key_field()) {
1934
+			foreach ($items_for_deletion as $item_for_deletion_row) {
1935
+				$pk_value = $item_for_deletion_row[$this->get_primary_key_field()->get_qualified_column()];
1936
+				if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value])) {
1937
+					unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$pk_value]);
1938
+				}
1939
+			}
1940
+		}
1941
+		/**
1942
+		 * Action called just after performing a real deletion query. Although at this point the
1943
+		 * items should have been deleted
1944
+		 *
1945
+		 * @param EEM_Base $model
1946
+		 * @param array    $query_params @see EEM_Base::get_all()
1947
+		 * @param int      $rows_deleted
1948
+		 */
1949
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted);
1950
+		return $rows_deleted;//how many supposedly got deleted
1951
+	}
1952
+
1953
+
1954
+
1955
+	/**
1956
+	 * Checks all the relations that throw error messages when there are blocking related objects
1957
+	 * for related model objects. If there are any related model objects on those relations,
1958
+	 * adds an EE_Error, and return true
1959
+	 *
1960
+	 * @param EE_Base_Class|int $this_model_obj_or_id
1961
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
1962
+	 *                                                 should be ignored when determining whether there are related
1963
+	 *                                                 model objects which block this model object's deletion. Useful
1964
+	 *                                                 if you know A is related to B and are considering deleting A,
1965
+	 *                                                 but want to see if A has any other objects blocking its deletion
1966
+	 *                                                 before removing the relation between A and B
1967
+	 * @return boolean
1968
+	 * @throws \EE_Error
1969
+	 */
1970
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
1971
+	{
1972
+		//first, if $ignore_this_model_obj was supplied, get its model
1973
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
1974
+			$ignored_model = $ignore_this_model_obj->get_model();
1975
+		} else {
1976
+			$ignored_model = null;
1977
+		}
1978
+		//now check all the relations of $this_model_obj_or_id and see if there
1979
+		//are any related model objects blocking it?
1980
+		$is_blocked = false;
1981
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
1982
+			if ($relation_obj->block_delete_if_related_models_exist()) {
1983
+				//if $ignore_this_model_obj was supplied, then for the query
1984
+				//on that model needs to be told to ignore $ignore_this_model_obj
1985
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
1986
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
1987
+						array(
1988
+							$ignored_model->get_primary_key_field()->get_name() => array(
1989
+								'!=',
1990
+								$ignore_this_model_obj->ID(),
1991
+							),
1992
+						),
1993
+					));
1994
+				} else {
1995
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
1996
+				}
1997
+				if ($related_model_objects) {
1998
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
1999
+					$is_blocked = true;
2000
+				}
2001
+			}
2002
+		}
2003
+		return $is_blocked;
2004
+	}
2005
+
2006
+
2007
+
2008
+	/**
2009
+	 * This sets up our delete where sql and accounts for if we have secondary tables that will have rows deleted as
2010
+	 * well.
2011
+	 *
2012
+	 * @param  array  $objects_for_deletion This should be the values returned by $this->_get_all_wpdb_results()
2013
+	 * @param boolean $allow_blocking       if TRUE, matched objects will only be deleted if there is no related model
2014
+	 *                                      info that blocks it (ie, there' sno other data that depends on this data);
2015
+	 *                                      if false, deletes regardless of other objects which may depend on it. Its
2016
+	 *                                      generally advisable to always leave this as TRUE, otherwise you could
2017
+	 *                                      easily corrupt your DB
2018
+	 * @throws EE_Error
2019
+	 * @return string    everything that comes after the WHERE statement.
2020
+	 */
2021
+	protected function _setup_ids_for_delete($objects_for_deletion, $allow_blocking = true)
2022
+	{
2023
+		if ($this->has_primary_key_field()) {
2024
+			$primary_table = $this->_get_main_table();
2025
+			$other_tables = $this->_get_other_tables();
2026
+			$deletes = $query = array();
2027
+			foreach ($objects_for_deletion as $delete_object) {
2028
+				//before we mark this object for deletion,
2029
+				//make sure there's no related objects blocking its deletion (if we're checking)
2030
+				if (
2031
+					$allow_blocking
2032
+					&& $this->delete_is_blocked_by_related_models(
2033
+						$delete_object[$primary_table->get_fully_qualified_pk_column()]
2034
+					)
2035
+				) {
2036
+					continue;
2037
+				}
2038
+				//primary table deletes
2039
+				if (isset($delete_object[$primary_table->get_fully_qualified_pk_column()])) {
2040
+					$deletes[$primary_table->get_fully_qualified_pk_column()][] = $delete_object[$primary_table->get_fully_qualified_pk_column()];
2041
+				}
2042
+				//other tables
2043
+				if (! empty($other_tables)) {
2044
+					foreach ($other_tables as $ot) {
2045
+						//first check if we've got the foreign key column here.
2046
+						if (isset($delete_object[$ot->get_fully_qualified_fk_column()])) {
2047
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_fk_column()];
2048
+						}
2049
+						// wait! it's entirely possible that we'll have a the primary key
2050
+						// for this table in here, if it's a foreign key for one of the other secondary tables
2051
+						if (isset($delete_object[$ot->get_fully_qualified_pk_column()])) {
2052
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2053
+						}
2054
+						// finally, it is possible that the fk for this table is found
2055
+						// in the fully qualified pk column for the fk table, so let's see if that's there!
2056
+						if (isset($delete_object[$ot->get_fully_qualified_pk_on_fk_table()])) {
2057
+							$deletes[$ot->get_fully_qualified_pk_column()][] = $delete_object[$ot->get_fully_qualified_pk_column()];
2058
+						}
2059
+					}
2060
+				}
2061
+			}
2062
+			//we should have deletes now, so let's just go through and setup the where statement
2063
+			foreach ($deletes as $column => $values) {
2064
+				//make sure we have unique $values;
2065
+				$values = array_unique($values);
2066
+				$query[] = $column . ' IN(' . implode(",", $values) . ')';
2067
+			}
2068
+			return ! empty($query) ? implode(' AND ', $query) : '';
2069
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2070
+			$ways_to_identify_a_row = array();
2071
+			$fields = $this->get_combined_primary_key_fields();
2072
+			//note: because there' sno primary key, that means nothing else  can be pointing to this model, right?
2073
+			foreach ($objects_for_deletion as $delete_object) {
2074
+				$values_for_each_cpk_for_a_row = array();
2075
+				foreach ($fields as $cpk_field) {
2076
+					if ($cpk_field instanceof EE_Model_Field_Base) {
2077
+						$values_for_each_cpk_for_a_row[] = $cpk_field->get_qualified_column()
2078
+														   . "="
2079
+														   . $delete_object[$cpk_field->get_qualified_column()];
2080
+					}
2081
+				}
2082
+				$ways_to_identify_a_row[] = "(" . implode(" AND ", $values_for_each_cpk_for_a_row) . ")";
2083
+			}
2084
+			return implode(" OR ", $ways_to_identify_a_row);
2085
+		} else {
2086
+			//so there's no primary key and no combined key...
2087
+			//sorry, can't help you
2088
+			throw new EE_Error(sprintf(__("Cannot delete objects of type %s because there is no primary key NOR combined key",
2089
+				"event_espresso"), get_class($this)));
2090
+		}
2091
+	}
2092
+
2093
+
2094
+
2095
+	/**
2096
+	 * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2097
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2098
+	 * column
2099
+	 *
2100
+	 * @param array  $query_params   like EEM_Base::get_all's
2101
+	 * @param string $field_to_count field on model to count by (not column name)
2102
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2103
+	 *                               that by the setting $distinct to TRUE;
2104
+	 * @return int
2105
+	 * @throws \EE_Error
2106
+	 */
2107
+	public function count($query_params = array(), $field_to_count = null, $distinct = false)
2108
+	{
2109
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2110
+		if ($field_to_count) {
2111
+			$field_obj = $this->field_settings_for($field_to_count);
2112
+			$column_to_count = $field_obj->get_qualified_column();
2113
+		} elseif ($this->has_primary_key_field()) {
2114
+			$pk_field_obj = $this->get_primary_key_field();
2115
+			$column_to_count = $pk_field_obj->get_qualified_column();
2116
+		} else {
2117
+			//there's no primary key
2118
+			//if we're counting distinct items, and there's no primary key,
2119
+			//we need to list out the columns for distinction;
2120
+			//otherwise we can just use star
2121
+			if ($distinct) {
2122
+				$columns_to_use = array();
2123
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2124
+					$columns_to_use[] = $field_obj->get_qualified_column();
2125
+				}
2126
+				$column_to_count = implode(',', $columns_to_use);
2127
+			} else {
2128
+				$column_to_count = '*';
2129
+			}
2130
+		}
2131
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2132
+		$SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2133
+		return (int)$this->_do_wpdb_query('get_var', array($SQL));
2134
+	}
2135
+
2136
+
2137
+
2138
+	/**
2139
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2140
+	 *
2141
+	 * @param array  $query_params like EEM_Base::get_all
2142
+	 * @param string $field_to_sum name of field (array key in $_fields array)
2143
+	 * @return float
2144
+	 * @throws \EE_Error
2145
+	 */
2146
+	public function sum($query_params, $field_to_sum = null)
2147
+	{
2148
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2149
+		if ($field_to_sum) {
2150
+			$field_obj = $this->field_settings_for($field_to_sum);
2151
+		} else {
2152
+			$field_obj = $this->get_primary_key_field();
2153
+		}
2154
+		$column_to_count = $field_obj->get_qualified_column();
2155
+		$SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2156
+		$return_value = $this->_do_wpdb_query('get_var', array($SQL));
2157
+		$data_type = $field_obj->get_wpdb_data_type();
2158
+		if ($data_type === '%d' || $data_type === '%s') {
2159
+			return (float)$return_value;
2160
+		} else {//must be %f
2161
+			return (float)$return_value;
2162
+		}
2163
+	}
2164
+
2165
+
2166
+
2167
+	/**
2168
+	 * Just calls the specified method on $wpdb with the given arguments
2169
+	 * Consolidates a little extra error handling code
2170
+	 *
2171
+	 * @param string $wpdb_method
2172
+	 * @param array  $arguments_to_provide
2173
+	 * @throws EE_Error
2174
+	 * @global wpdb  $wpdb
2175
+	 * @return mixed
2176
+	 */
2177
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2178
+	{
2179
+		//if we're in maintenance mode level 2, DON'T run any queries
2180
+		//because level 2 indicates the database needs updating and
2181
+		//is probably out of sync with the code
2182
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2183
+			throw new EE_Error(sprintf(__("Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
2184
+				"event_espresso")));
2185
+		}
2186
+		/** @type WPDB $wpdb */
2187
+		global $wpdb;
2188
+		if (! method_exists($wpdb, $wpdb_method)) {
2189
+			throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2190
+				'event_espresso'), $wpdb_method));
2191
+		}
2192
+		if (WP_DEBUG) {
2193
+			$old_show_errors_value = $wpdb->show_errors;
2194
+			$wpdb->show_errors(false);
2195
+		}
2196
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2197
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
2198
+		if (WP_DEBUG) {
2199
+			$wpdb->show_errors($old_show_errors_value);
2200
+			if (! empty($wpdb->last_error)) {
2201
+				throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2202
+			} elseif ($result === false) {
2203
+				throw new EE_Error(sprintf(__('WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
2204
+					'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2205
+			}
2206
+		} elseif ($result === false) {
2207
+			EE_Error::add_error(
2208
+				sprintf(
2209
+					__('A database error has occurred. Turn on WP_DEBUG for more information.||A database error occurred doing wpdb method "%1$s", with arguments "%2$s". The error was "%3$s"',
2210
+						'event_espresso'),
2211
+					$wpdb_method,
2212
+					var_export($arguments_to_provide, true),
2213
+					$wpdb->last_error
2214
+				),
2215
+				__FILE__,
2216
+				__FUNCTION__,
2217
+				__LINE__
2218
+			);
2219
+		}
2220
+		return $result;
2221
+	}
2222
+
2223
+
2224
+
2225
+	/**
2226
+	 * Attempts to run the indicated WPDB method with the provided arguments,
2227
+	 * and if there's an error tries to verify the DB is correct. Uses
2228
+	 * the static property EEM_Base::$_db_verification_level to determine whether
2229
+	 * we should try to fix the EE core db, the addons, or just give up
2230
+	 *
2231
+	 * @param string $wpdb_method
2232
+	 * @param array  $arguments_to_provide
2233
+	 * @return mixed
2234
+	 */
2235
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2236
+	{
2237
+		/** @type WPDB $wpdb */
2238
+		global $wpdb;
2239
+		$wpdb->last_error = null;
2240
+		$result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2241
+		// was there an error running the query? but we don't care on new activations
2242
+		// (we're going to setup the DB anyway on new activations)
2243
+		if (($result === false || ! empty($wpdb->last_error))
2244
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2245
+		) {
2246
+			switch (EEM_Base::$_db_verification_level) {
2247
+				case EEM_Base::db_verified_none :
2248
+					// let's double-check core's DB
2249
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2250
+					break;
2251
+				case EEM_Base::db_verified_core :
2252
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2253
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2254
+					break;
2255
+				case EEM_Base::db_verified_addons :
2256
+					// ummmm... you in trouble
2257
+					return $result;
2258
+					break;
2259
+			}
2260
+			if (! empty($error_message)) {
2261
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2262
+				trigger_error($error_message);
2263
+			}
2264
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2265
+		}
2266
+		return $result;
2267
+	}
2268
+
2269
+
2270
+
2271
+	/**
2272
+	 * Verifies the EE core database is up-to-date and records that we've done it on
2273
+	 * EEM_Base::$_db_verification_level
2274
+	 *
2275
+	 * @param string $wpdb_method
2276
+	 * @param array  $arguments_to_provide
2277
+	 * @return string
2278
+	 */
2279
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
2280
+	{
2281
+		/** @type WPDB $wpdb */
2282
+		global $wpdb;
2283
+		//ok remember that we've already attempted fixing the core db, in case the problem persists
2284
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2285
+		$error_message = sprintf(
2286
+			__('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2287
+				'event_espresso'),
2288
+			$wpdb->last_error,
2289
+			$wpdb_method,
2290
+			wp_json_encode($arguments_to_provide)
2291
+		);
2292
+		EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2293
+		return $error_message;
2294
+	}
2295
+
2296
+
2297
+
2298
+	/**
2299
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
2300
+	 * EEM_Base::$_db_verification_level
2301
+	 *
2302
+	 * @param $wpdb_method
2303
+	 * @param $arguments_to_provide
2304
+	 * @return string
2305
+	 */
2306
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2307
+	{
2308
+		/** @type WPDB $wpdb */
2309
+		global $wpdb;
2310
+		//ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2311
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2312
+		$error_message = sprintf(
2313
+			__('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2314
+				'event_espresso'),
2315
+			$wpdb->last_error,
2316
+			$wpdb_method,
2317
+			wp_json_encode($arguments_to_provide)
2318
+		);
2319
+		EE_System::instance()->initialize_addons();
2320
+		return $error_message;
2321
+	}
2322
+
2323
+
2324
+
2325
+	/**
2326
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2327
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2328
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2329
+	 * ..."
2330
+	 *
2331
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
2332
+	 * @return string
2333
+	 */
2334
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2335
+	{
2336
+		return " FROM " . $model_query_info->get_full_join_sql() .
2337
+			   $model_query_info->get_where_sql() .
2338
+			   $model_query_info->get_group_by_sql() .
2339
+			   $model_query_info->get_having_sql() .
2340
+			   $model_query_info->get_order_by_sql() .
2341
+			   $model_query_info->get_limit_sql();
2342
+	}
2343
+
2344
+
2345
+
2346
+	/**
2347
+	 * Set to easily debug the next X queries ran from this model.
2348
+	 *
2349
+	 * @param int $count
2350
+	 */
2351
+	public function show_next_x_db_queries($count = 1)
2352
+	{
2353
+		$this->_show_next_x_db_queries = $count;
2354
+	}
2355
+
2356
+
2357
+
2358
+	/**
2359
+	 * @param $sql_query
2360
+	 */
2361
+	public function show_db_query_if_previously_requested($sql_query)
2362
+	{
2363
+		if ($this->_show_next_x_db_queries > 0) {
2364
+			echo $sql_query;
2365
+			$this->_show_next_x_db_queries--;
2366
+		}
2367
+	}
2368
+
2369
+
2370
+
2371
+	/**
2372
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2373
+	 * There are the 3 cases:
2374
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2375
+	 * $otherModelObject has no ID, it is first saved.
2376
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2377
+	 * has no ID, it is first saved.
2378
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2379
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2380
+	 * join table
2381
+	 *
2382
+	 * @param        EE_Base_Class                     /int $thisModelObject
2383
+	 * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2384
+	 * @param string $relationName                     , key in EEM_Base::_relations
2385
+	 *                                                 an attendee to a group, you also want to specify which role they
2386
+	 *                                                 will have in that group. So you would use this parameter to
2387
+	 *                                                 specify array('role-column-name'=>'role-id')
2388
+	 * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2389
+	 *                                                 to for relation to methods that allow you to further specify
2390
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2391
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
2392
+	 *                                                 because these will be inserted in any new rows created as well.
2393
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2394
+	 * @throws \EE_Error
2395
+	 */
2396
+	public function add_relationship_to(
2397
+		$id_or_obj,
2398
+		$other_model_id_or_obj,
2399
+		$relationName,
2400
+		$extra_join_model_fields_n_values = array()
2401
+	) {
2402
+		$relation_obj = $this->related_settings_for($relationName);
2403
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2404
+	}
2405
+
2406
+
2407
+
2408
+	/**
2409
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2410
+	 * There are the 3 cases:
2411
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2412
+	 * error
2413
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2414
+	 * an error
2415
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2416
+	 *
2417
+	 * @param        EE_Base_Class /int $id_or_obj
2418
+	 * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2419
+	 * @param string $relationName key in EEM_Base::_relations
2420
+	 * @return boolean of success
2421
+	 * @throws \EE_Error
2422
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2423
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2424
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2425
+	 *                             because these will be inserted in any new rows created as well.
2426
+	 */
2427
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2428
+	{
2429
+		$relation_obj = $this->related_settings_for($relationName);
2430
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2431
+	}
2432
+
2433
+
2434
+
2435
+	/**
2436
+	 * @param mixed           $id_or_obj
2437
+	 * @param string          $relationName
2438
+	 * @param array           $where_query_params
2439
+	 * @param EE_Base_Class[] objects to which relations were removed
2440
+	 * @return \EE_Base_Class[]
2441
+	 * @throws \EE_Error
2442
+	 */
2443
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2444
+	{
2445
+		$relation_obj = $this->related_settings_for($relationName);
2446
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2447
+	}
2448
+
2449
+
2450
+
2451
+	/**
2452
+	 * Gets all the related items of the specified $model_name, using $query_params.
2453
+	 * Note: by default, we remove the "default query params"
2454
+	 * because we want to get even deleted items etc.
2455
+	 *
2456
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2457
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
2458
+	 * @param array  $query_params like EEM_Base::get_all
2459
+	 * @return EE_Base_Class[]
2460
+	 * @throws \EE_Error
2461
+	 */
2462
+	public function get_all_related($id_or_obj, $model_name, $query_params = null)
2463
+	{
2464
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2465
+		$relation_settings = $this->related_settings_for($model_name);
2466
+		return $relation_settings->get_all_related($model_obj, $query_params);
2467
+	}
2468
+
2469
+
2470
+
2471
+	/**
2472
+	 * Deletes all the model objects across the relation indicated by $model_name
2473
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
2474
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
2475
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2476
+	 *
2477
+	 * @param EE_Base_Class|int|string $id_or_obj
2478
+	 * @param string                   $model_name
2479
+	 * @param array                    $query_params
2480
+	 * @return int how many deleted
2481
+	 * @throws \EE_Error
2482
+	 */
2483
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
2484
+	{
2485
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2486
+		$relation_settings = $this->related_settings_for($model_name);
2487
+		return $relation_settings->delete_all_related($model_obj, $query_params);
2488
+	}
2489
+
2490
+
2491
+
2492
+	/**
2493
+	 * Hard deletes all the model objects across the relation indicated by $model_name
2494
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
2495
+	 * the model objects can't be hard deleted because of blocking related model objects,
2496
+	 * just does a soft-delete on them instead.
2497
+	 *
2498
+	 * @param EE_Base_Class|int|string $id_or_obj
2499
+	 * @param string                   $model_name
2500
+	 * @param array                    $query_params
2501
+	 * @return int how many deleted
2502
+	 * @throws \EE_Error
2503
+	 */
2504
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2505
+	{
2506
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2507
+		$relation_settings = $this->related_settings_for($model_name);
2508
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
2509
+	}
2510
+
2511
+
2512
+
2513
+	/**
2514
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2515
+	 * unless otherwise specified in the $query_params
2516
+	 *
2517
+	 * @param        int             /EE_Base_Class $id_or_obj
2518
+	 * @param string $model_name     like 'Event', or 'Registration'
2519
+	 * @param array  $query_params   like EEM_Base::get_all's
2520
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
2521
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2522
+	 *                               that by the setting $distinct to TRUE;
2523
+	 * @return int
2524
+	 * @throws \EE_Error
2525
+	 */
2526
+	public function count_related(
2527
+		$id_or_obj,
2528
+		$model_name,
2529
+		$query_params = array(),
2530
+		$field_to_count = null,
2531
+		$distinct = false
2532
+	) {
2533
+		$related_model = $this->get_related_model_obj($model_name);
2534
+		//we're just going to use the query params on the related model's normal get_all query,
2535
+		//except add a condition to say to match the current mod
2536
+		if (! isset($query_params['default_where_conditions'])) {
2537
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2538
+		}
2539
+		$this_model_name = $this->get_this_model_name();
2540
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2541
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2542
+		return $related_model->count($query_params, $field_to_count, $distinct);
2543
+	}
2544
+
2545
+
2546
+
2547
+	/**
2548
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
2549
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2550
+	 *
2551
+	 * @param        int           /EE_Base_Class $id_or_obj
2552
+	 * @param string $model_name   like 'Event', or 'Registration'
2553
+	 * @param array  $query_params like EEM_Base::get_all's
2554
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
2555
+	 * @return float
2556
+	 * @throws \EE_Error
2557
+	 */
2558
+	public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2559
+	{
2560
+		$related_model = $this->get_related_model_obj($model_name);
2561
+		if (! is_array($query_params)) {
2562
+			EE_Error::doing_it_wrong('EEM_Base::sum_related',
2563
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2564
+					gettype($query_params)), '4.6.0');
2565
+			$query_params = array();
2566
+		}
2567
+		//we're just going to use the query params on the related model's normal get_all query,
2568
+		//except add a condition to say to match the current mod
2569
+		if (! isset($query_params['default_where_conditions'])) {
2570
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2571
+		}
2572
+		$this_model_name = $this->get_this_model_name();
2573
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2574
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2575
+		return $related_model->sum($query_params, $field_to_sum);
2576
+	}
2577
+
2578
+
2579
+
2580
+	/**
2581
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2582
+	 * $modelObject
2583
+	 *
2584
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2585
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2586
+	 * @param array               $query_params     like EEM_Base::get_all's
2587
+	 * @return EE_Base_Class
2588
+	 * @throws \EE_Error
2589
+	 */
2590
+	public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2591
+	{
2592
+		$query_params['limit'] = 1;
2593
+		$results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2594
+		if ($results) {
2595
+			return array_shift($results);
2596
+		} else {
2597
+			return null;
2598
+		}
2599
+	}
2600
+
2601
+
2602
+
2603
+	/**
2604
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2605
+	 *
2606
+	 * @return string
2607
+	 */
2608
+	public function get_this_model_name()
2609
+	{
2610
+		return str_replace("EEM_", "", get_class($this));
2611
+	}
2612
+
2613
+
2614
+
2615
+	/**
2616
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2617
+	 *
2618
+	 * @return EE_Any_Foreign_Model_Name_Field
2619
+	 * @throws EE_Error
2620
+	 */
2621
+	public function get_field_containing_related_model_name()
2622
+	{
2623
+		foreach ($this->field_settings(true) as $field) {
2624
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2625
+				$field_with_model_name = $field;
2626
+			}
2627
+		}
2628
+		if (! isset($field_with_model_name) || ! $field_with_model_name) {
2629
+			throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2630
+				$this->get_this_model_name()));
2631
+		}
2632
+		return $field_with_model_name;
2633
+	}
2634
+
2635
+
2636
+
2637
+	/**
2638
+	 * Inserts a new entry into the database, for each table.
2639
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2640
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2641
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
2642
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
2643
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2644
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2645
+	 *
2646
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2647
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2648
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2649
+	 *                              of EEM_Base)
2650
+	 * @return int new primary key on main table that got inserted
2651
+	 * @throws EE_Error
2652
+	 */
2653
+	public function insert($field_n_values)
2654
+	{
2655
+		/**
2656
+		 * Filters the fields and their values before inserting an item using the models
2657
+		 *
2658
+		 * @param array    $fields_n_values keys are the fields and values are their new values
2659
+		 * @param EEM_Base $model           the model used
2660
+		 */
2661
+		$field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2662
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
2663
+			$main_table = $this->_get_main_table();
2664
+			$new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2665
+			if ($new_id !== false) {
2666
+				foreach ($this->_get_other_tables() as $other_table) {
2667
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2668
+				}
2669
+			}
2670
+			/**
2671
+			 * Done just after attempting to insert a new model object
2672
+			 *
2673
+			 * @param EEM_Base   $model           used
2674
+			 * @param array      $fields_n_values fields and their values
2675
+			 * @param int|string the              ID of the newly-inserted model object
2676
+			 */
2677
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2678
+			return $new_id;
2679
+		} else {
2680
+			return false;
2681
+		}
2682
+	}
2683
+
2684
+
2685
+
2686
+	/**
2687
+	 * Checks that the result would satisfy the unique indexes on this model
2688
+	 *
2689
+	 * @param array  $field_n_values
2690
+	 * @param string $action
2691
+	 * @return boolean
2692
+	 * @throws \EE_Error
2693
+	 */
2694
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2695
+	{
2696
+		foreach ($this->unique_indexes() as $index_name => $index) {
2697
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2698
+			if ($this->exists(array($uniqueness_where_params))) {
2699
+				EE_Error::add_error(
2700
+					sprintf(
2701
+						__(
2702
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2703
+							"event_espresso"
2704
+						),
2705
+						$action,
2706
+						$this->_get_class_name(),
2707
+						$index_name,
2708
+						implode(",", $index->field_names()),
2709
+						http_build_query($uniqueness_where_params)
2710
+					),
2711
+					__FILE__,
2712
+					__FUNCTION__,
2713
+					__LINE__
2714
+				);
2715
+				return false;
2716
+			}
2717
+		}
2718
+		return true;
2719
+	}
2720
+
2721
+
2722
+
2723
+	/**
2724
+	 * Checks the database for an item that conflicts (ie, if this item were
2725
+	 * saved to the DB would break some uniqueness requirement, like a primary key
2726
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
2727
+	 * can be either an EE_Base_Class or an array of fields n values
2728
+	 *
2729
+	 * @param EE_Base_Class|array $obj_or_fields_array
2730
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
2731
+	 *                                                 when looking for conflicts
2732
+	 *                                                 (ie, if false, we ignore the model object's primary key
2733
+	 *                                                 when finding "conflicts". If true, it's also considered).
2734
+	 *                                                 Only works for INT primary key,
2735
+	 *                                                 STRING primary keys cannot be ignored
2736
+	 * @throws EE_Error
2737
+	 * @return EE_Base_Class|array
2738
+	 */
2739
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2740
+	{
2741
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
2742
+			$fields_n_values = $obj_or_fields_array->model_field_array();
2743
+		} elseif (is_array($obj_or_fields_array)) {
2744
+			$fields_n_values = $obj_or_fields_array;
2745
+		} else {
2746
+			throw new EE_Error(
2747
+				sprintf(
2748
+					__(
2749
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2750
+						"event_espresso"
2751
+					),
2752
+					get_class($this),
2753
+					$obj_or_fields_array
2754
+				)
2755
+			);
2756
+		}
2757
+		$query_params = array();
2758
+		if ($this->has_primary_key_field()
2759
+			&& ($include_primary_key
2760
+				|| $this->get_primary_key_field()
2761
+				   instanceof
2762
+				   EE_Primary_Key_String_Field)
2763
+			&& isset($fields_n_values[$this->primary_key_name()])
2764
+		) {
2765
+			$query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2766
+		}
2767
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2768
+			$uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2769
+			$query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2770
+		}
2771
+		//if there is nothing to base this search on, then we shouldn't find anything
2772
+		if (empty($query_params)) {
2773
+			return array();
2774
+		} else {
2775
+			return $this->get_one($query_params);
2776
+		}
2777
+	}
2778
+
2779
+
2780
+
2781
+	/**
2782
+	 * Like count, but is optimized and returns a boolean instead of an int
2783
+	 *
2784
+	 * @param array $query_params
2785
+	 * @return boolean
2786
+	 * @throws \EE_Error
2787
+	 */
2788
+	public function exists($query_params)
2789
+	{
2790
+		$query_params['limit'] = 1;
2791
+		return $this->count($query_params) > 0;
2792
+	}
2793
+
2794
+
2795
+
2796
+	/**
2797
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
2798
+	 *
2799
+	 * @param int|string $id
2800
+	 * @return boolean
2801
+	 * @throws \EE_Error
2802
+	 */
2803
+	public function exists_by_ID($id)
2804
+	{
2805
+		return $this->exists(
2806
+			array(
2807
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
2808
+				array(
2809
+					$this->primary_key_name() => $id,
2810
+				),
2811
+			)
2812
+		);
2813
+	}
2814
+
2815
+
2816
+
2817
+	/**
2818
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2819
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2820
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2821
+	 * on the main table)
2822
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
2823
+	 * cases where we want to call it directly rather than via insert().
2824
+	 *
2825
+	 * @access   protected
2826
+	 * @param EE_Table_Base $table
2827
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2828
+	 *                                       float
2829
+	 * @param int           $new_id          for now we assume only int keys
2830
+	 * @throws EE_Error
2831
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2832
+	 * @return int ID of new row inserted, or FALSE on failure
2833
+	 */
2834
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2835
+	{
2836
+		global $wpdb;
2837
+		$insertion_col_n_values = array();
2838
+		$format_for_insertion = array();
2839
+		$fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2840
+		foreach ($fields_on_table as $field_name => $field_obj) {
2841
+			//check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2842
+			if ($field_obj->is_auto_increment()) {
2843
+				continue;
2844
+			}
2845
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2846
+			//if the value we want to assign it to is NULL, just don't mention it for the insertion
2847
+			if ($prepared_value !== null) {
2848
+				$insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2849
+				$format_for_insertion[] = $field_obj->get_wpdb_data_type();
2850
+			}
2851
+		}
2852
+		if ($table instanceof EE_Secondary_Table && $new_id) {
2853
+			//its not the main table, so we should have already saved the main table's PK which we just inserted
2854
+			//so add the fk to the main table as a column
2855
+			$insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2856
+			$format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2857
+		}
2858
+		//insert the new entry
2859
+		$result = $this->_do_wpdb_query('insert',
2860
+			array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2861
+		if ($result === false) {
2862
+			return false;
2863
+		}
2864
+		//ok, now what do we return for the ID of the newly-inserted thing?
2865
+		if ($this->has_primary_key_field()) {
2866
+			if ($this->get_primary_key_field()->is_auto_increment()) {
2867
+				return $wpdb->insert_id;
2868
+			} else {
2869
+				//it's not an auto-increment primary key, so
2870
+				//it must have been supplied
2871
+				return $fields_n_values[$this->get_primary_key_field()->get_name()];
2872
+			}
2873
+		} else {
2874
+			//we can't return a  primary key because there is none. instead return
2875
+			//a unique string indicating this model
2876
+			return $this->get_index_primary_key_string($fields_n_values);
2877
+		}
2878
+	}
2879
+
2880
+
2881
+
2882
+	/**
2883
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2884
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2885
+	 * and there is no default, we pass it along. WPDB will take care of it)
2886
+	 *
2887
+	 * @param EE_Model_Field_Base $field_obj
2888
+	 * @param array               $fields_n_values
2889
+	 * @return mixed string|int|float depending on what the table column will be expecting
2890
+	 * @throws \EE_Error
2891
+	 */
2892
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2893
+	{
2894
+		//if this field doesn't allow nullable, don't allow it
2895
+		if (
2896
+			! $field_obj->is_nullable()
2897
+			&& (
2898
+				! isset($fields_n_values[$field_obj->get_name()])
2899
+				|| $fields_n_values[$field_obj->get_name()] === null
2900
+			)
2901
+		) {
2902
+			$fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
2903
+		}
2904
+		$unprepared_value = isset($fields_n_values[$field_obj->get_name()])
2905
+			? $fields_n_values[$field_obj->get_name()]
2906
+			: null;
2907
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
2908
+	}
2909
+
2910
+
2911
+
2912
+	/**
2913
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
2914
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
2915
+	 * the field's prepare_for_set() method.
2916
+	 *
2917
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
2918
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
2919
+	 *                                   top of file)
2920
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
2921
+	 *                                   $value is a custom selection
2922
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
2923
+	 */
2924
+	private function _prepare_value_for_use_in_db($value, $field)
2925
+	{
2926
+		if ($field && $field instanceof EE_Model_Field_Base) {
2927
+			switch ($this->_values_already_prepared_by_model_object) {
2928
+				/** @noinspection PhpMissingBreakStatementInspection */
2929
+				case self::not_prepared_by_model_object:
2930
+					$value = $field->prepare_for_set($value);
2931
+				//purposefully left out "return"
2932
+				case self::prepared_by_model_object:
2933
+					$value = $field->prepare_for_use_in_db($value);
2934
+				case self::prepared_for_use_in_db:
2935
+					//leave the value alone
2936
+			}
2937
+			return $value;
2938
+		} else {
2939
+			return $value;
2940
+		}
2941
+	}
2942
+
2943
+
2944
+
2945
+	/**
2946
+	 * Returns the main table on this model
2947
+	 *
2948
+	 * @return EE_Primary_Table
2949
+	 * @throws EE_Error
2950
+	 */
2951
+	protected function _get_main_table()
2952
+	{
2953
+		foreach ($this->_tables as $table) {
2954
+			if ($table instanceof EE_Primary_Table) {
2955
+				return $table;
2956
+			}
2957
+		}
2958
+		throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
2959
+			'event_espresso'), get_class($this)));
2960
+	}
2961
+
2962
+
2963
+
2964
+	/**
2965
+	 * table
2966
+	 * returns EE_Primary_Table table name
2967
+	 *
2968
+	 * @return string
2969
+	 * @throws \EE_Error
2970
+	 */
2971
+	public function table()
2972
+	{
2973
+		return $this->_get_main_table()->get_table_name();
2974
+	}
2975
+
2976
+
2977
+
2978
+	/**
2979
+	 * table
2980
+	 * returns first EE_Secondary_Table table name
2981
+	 *
2982
+	 * @return string
2983
+	 */
2984
+	public function second_table()
2985
+	{
2986
+		// grab second table from tables array
2987
+		$second_table = end($this->_tables);
2988
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
2989
+	}
2990
+
2991
+
2992
+
2993
+	/**
2994
+	 * get_table_obj_by_alias
2995
+	 * returns table name given it's alias
2996
+	 *
2997
+	 * @param string $table_alias
2998
+	 * @return EE_Primary_Table | EE_Secondary_Table
2999
+	 */
3000
+	public function get_table_obj_by_alias($table_alias = '')
3001
+	{
3002
+		return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3003
+	}
3004
+
3005
+
3006
+
3007
+	/**
3008
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3009
+	 *
3010
+	 * @return EE_Secondary_Table[]
3011
+	 */
3012
+	protected function _get_other_tables()
3013
+	{
3014
+		$other_tables = array();
3015
+		foreach ($this->_tables as $table_alias => $table) {
3016
+			if ($table instanceof EE_Secondary_Table) {
3017
+				$other_tables[$table_alias] = $table;
3018
+			}
3019
+		}
3020
+		return $other_tables;
3021
+	}
3022
+
3023
+
3024
+
3025
+	/**
3026
+	 * Finds all the fields that correspond to the given table
3027
+	 *
3028
+	 * @param string $table_alias , array key in EEM_Base::_tables
3029
+	 * @return EE_Model_Field_Base[]
3030
+	 */
3031
+	public function _get_fields_for_table($table_alias)
3032
+	{
3033
+		return $this->_fields[$table_alias];
3034
+	}
3035
+
3036
+
3037
+
3038
+	/**
3039
+	 * Recurses through all the where parameters, and finds all the related models we'll need
3040
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3041
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3042
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3043
+	 * related Registration, Transaction, and Payment models.
3044
+	 *
3045
+	 * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3046
+	 * @return EE_Model_Query_Info_Carrier
3047
+	 * @throws \EE_Error
3048
+	 */
3049
+	public function _extract_related_models_from_query($query_params)
3050
+	{
3051
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
3052
+		if (array_key_exists(0, $query_params)) {
3053
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3054
+		}
3055
+		if (array_key_exists('group_by', $query_params)) {
3056
+			if (is_array($query_params['group_by'])) {
3057
+				$this->_extract_related_models_from_sub_params_array_values(
3058
+					$query_params['group_by'],
3059
+					$query_info_carrier,
3060
+					'group_by'
3061
+				);
3062
+			} elseif (! empty ($query_params['group_by'])) {
3063
+				$this->_extract_related_model_info_from_query_param(
3064
+					$query_params['group_by'],
3065
+					$query_info_carrier,
3066
+					'group_by'
3067
+				);
3068
+			}
3069
+		}
3070
+		if (array_key_exists('having', $query_params)) {
3071
+			$this->_extract_related_models_from_sub_params_array_keys(
3072
+				$query_params[0],
3073
+				$query_info_carrier,
3074
+				'having'
3075
+			);
3076
+		}
3077
+		if (array_key_exists('order_by', $query_params)) {
3078
+			if (is_array($query_params['order_by'])) {
3079
+				$this->_extract_related_models_from_sub_params_array_keys(
3080
+					$query_params['order_by'],
3081
+					$query_info_carrier,
3082
+					'order_by'
3083
+				);
3084
+			} elseif (! empty($query_params['order_by'])) {
3085
+				$this->_extract_related_model_info_from_query_param(
3086
+					$query_params['order_by'],
3087
+					$query_info_carrier,
3088
+					'order_by'
3089
+				);
3090
+			}
3091
+		}
3092
+		if (array_key_exists('force_join', $query_params)) {
3093
+			$this->_extract_related_models_from_sub_params_array_values(
3094
+				$query_params['force_join'],
3095
+				$query_info_carrier,
3096
+				'force_join'
3097
+			);
3098
+		}
3099
+		return $query_info_carrier;
3100
+	}
3101
+
3102
+
3103
+
3104
+	/**
3105
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3106
+	 *
3107
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3108
+	 *                                                      $query_params['having']
3109
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3110
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3111
+	 * @throws EE_Error
3112
+	 * @return \EE_Model_Query_Info_Carrier
3113
+	 */
3114
+	private function _extract_related_models_from_sub_params_array_keys(
3115
+		$sub_query_params,
3116
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3117
+		$query_param_type
3118
+	) {
3119
+		if (! empty($sub_query_params)) {
3120
+			$sub_query_params = (array)$sub_query_params;
3121
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
3122
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3123
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3124
+					$query_param_type);
3125
+				//if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3126
+				//indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3127
+				//extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3128
+				//of array('Registration.TXN_ID'=>23)
3129
+				$query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3130
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3131
+					if (! is_array($possibly_array_of_params)) {
3132
+						throw new EE_Error(sprintf(__("You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
3133
+							"event_espresso"),
3134
+							$param, $possibly_array_of_params));
3135
+					} else {
3136
+						$this->_extract_related_models_from_sub_params_array_keys($possibly_array_of_params,
3137
+							$model_query_info_carrier, $query_param_type);
3138
+					}
3139
+				} elseif ($query_param_type === 0 //ie WHERE
3140
+						  && is_array($possibly_array_of_params)
3141
+						  && isset($possibly_array_of_params[2])
3142
+						  && $possibly_array_of_params[2] == true
3143
+				) {
3144
+					//then $possible_array_of_params looks something like array('<','DTT_sold',true)
3145
+					//indicating that $possible_array_of_params[1] is actually a field name,
3146
+					//from which we should extract query parameters!
3147
+					if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3148
+						throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3149
+							"event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3150
+					}
3151
+					$this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3152
+						$model_query_info_carrier, $query_param_type);
3153
+				}
3154
+			}
3155
+		}
3156
+		return $model_query_info_carrier;
3157
+	}
3158
+
3159
+
3160
+
3161
+	/**
3162
+	 * For extracting related models from forced_joins, where the array values contain the info about what
3163
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3164
+	 *
3165
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3166
+	 *                                                      $query_params['having']
3167
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3168
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3169
+	 * @throws EE_Error
3170
+	 * @return \EE_Model_Query_Info_Carrier
3171
+	 */
3172
+	private function _extract_related_models_from_sub_params_array_values(
3173
+		$sub_query_params,
3174
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3175
+		$query_param_type
3176
+	) {
3177
+		if (! empty($sub_query_params)) {
3178
+			if (! is_array($sub_query_params)) {
3179
+				throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3180
+					$sub_query_params));
3181
+			}
3182
+			foreach ($sub_query_params as $param) {
3183
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3184
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3185
+					$query_param_type);
3186
+			}
3187
+		}
3188
+		return $model_query_info_carrier;
3189
+	}
3190
+
3191
+
3192
+
3193
+	/**
3194
+	 * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3195
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3196
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
3197
+	 * but use them in a different order. Eg, we need to know what models we are querying
3198
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3199
+	 * other models before we can finalize the where clause SQL.
3200
+	 *
3201
+	 * @param array $query_params
3202
+	 * @throws EE_Error
3203
+	 * @return EE_Model_Query_Info_Carrier
3204
+	 */
3205
+	public function _create_model_query_info_carrier($query_params)
3206
+	{
3207
+		if (! is_array($query_params)) {
3208
+			EE_Error::doing_it_wrong(
3209
+				'EEM_Base::_create_model_query_info_carrier',
3210
+				sprintf(
3211
+					__(
3212
+						'$query_params should be an array, you passed a variable of type %s',
3213
+						'event_espresso'
3214
+					),
3215
+					gettype($query_params)
3216
+				),
3217
+				'4.6.0'
3218
+			);
3219
+			$query_params = array();
3220
+		}
3221
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3222
+		//first check if we should alter the query to account for caps or not
3223
+		//because the caps might require us to do extra joins
3224
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3225
+			$query_params[0] = $where_query_params = array_replace_recursive(
3226
+				$where_query_params,
3227
+				$this->caps_where_conditions(
3228
+					$query_params['caps']
3229
+				)
3230
+			);
3231
+		}
3232
+		$query_object = $this->_extract_related_models_from_query($query_params);
3233
+		//verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3234
+		foreach ($where_query_params as $key => $value) {
3235
+			if (is_int($key)) {
3236
+				throw new EE_Error(
3237
+					sprintf(
3238
+						__(
3239
+							"WHERE query params must NOT be numerically-indexed. You provided the array key '%s' for value '%s' while querying model %s. All the query params provided were '%s' Please read documentation on EEM_Base::get_all.",
3240
+							"event_espresso"
3241
+						),
3242
+						$key,
3243
+						var_export($value, true),
3244
+						var_export($query_params, true),
3245
+						get_class($this)
3246
+					)
3247
+				);
3248
+			}
3249
+		}
3250
+		if (
3251
+			array_key_exists('default_where_conditions', $query_params)
3252
+			&& ! empty($query_params['default_where_conditions'])
3253
+		) {
3254
+			$use_default_where_conditions = $query_params['default_where_conditions'];
3255
+		} else {
3256
+			$use_default_where_conditions = EEM_Base::default_where_conditions_all;
3257
+		}
3258
+		$where_query_params = array_merge(
3259
+			$this->_get_default_where_conditions_for_models_in_query(
3260
+				$query_object,
3261
+				$use_default_where_conditions,
3262
+				$where_query_params
3263
+			),
3264
+			$where_query_params
3265
+		);
3266
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3267
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3268
+		// So we need to setup a subquery and use that for the main join.
3269
+		// Note for now this only works on the primary table for the model.
3270
+		// So for instance, you could set the limit array like this:
3271
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3272
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3273
+			$query_object->set_main_model_join_sql(
3274
+				$this->_construct_limit_join_select(
3275
+					$query_params['on_join_limit'][0],
3276
+					$query_params['on_join_limit'][1]
3277
+				)
3278
+			);
3279
+		}
3280
+		//set limit
3281
+		if (array_key_exists('limit', $query_params)) {
3282
+			if (is_array($query_params['limit'])) {
3283
+				if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3284
+					$e = sprintf(
3285
+						__(
3286
+							"Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
3287
+							"event_espresso"
3288
+						),
3289
+						http_build_query($query_params['limit'])
3290
+					);
3291
+					throw new EE_Error($e . "|" . $e);
3292
+				}
3293
+				//they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3294
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3295
+			} elseif (! empty ($query_params['limit'])) {
3296
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3297
+			}
3298
+		}
3299
+		//set order by
3300
+		if (array_key_exists('order_by', $query_params)) {
3301
+			if (is_array($query_params['order_by'])) {
3302
+				//if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3303
+				//specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3304
+				//including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3305
+				if (array_key_exists('order', $query_params)) {
3306
+					throw new EE_Error(
3307
+						sprintf(
3308
+							__(
3309
+								"In querying %s, we are using query parameter 'order_by' as an array (keys:%s,values:%s), and so we can't use query parameter 'order' (value %s). You should just use the 'order_by' parameter ",
3310
+								"event_espresso"
3311
+							),
3312
+							get_class($this),
3313
+							implode(", ", array_keys($query_params['order_by'])),
3314
+							implode(", ", $query_params['order_by']),
3315
+							$query_params['order']
3316
+						)
3317
+					);
3318
+				}
3319
+				$this->_extract_related_models_from_sub_params_array_keys(
3320
+					$query_params['order_by'],
3321
+					$query_object,
3322
+					'order_by'
3323
+				);
3324
+				//assume it's an array of fields to order by
3325
+				$order_array = array();
3326
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3327
+					$order = $this->_extract_order($order);
3328
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3329
+				}
3330
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3331
+			} elseif (! empty ($query_params['order_by'])) {
3332
+				$this->_extract_related_model_info_from_query_param(
3333
+					$query_params['order_by'],
3334
+					$query_object,
3335
+					'order',
3336
+					$query_params['order_by']
3337
+				);
3338
+				$order = isset($query_params['order'])
3339
+					? $this->_extract_order($query_params['order'])
3340
+					: 'DESC';
3341
+				$query_object->set_order_by_sql(
3342
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3343
+				);
3344
+			}
3345
+		}
3346
+		//if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3347
+		if (! array_key_exists('order_by', $query_params)
3348
+			&& array_key_exists('order', $query_params)
3349
+			&& ! empty($query_params['order'])
3350
+		) {
3351
+			$pk_field = $this->get_primary_key_field();
3352
+			$order = $this->_extract_order($query_params['order']);
3353
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3354
+		}
3355
+		//set group by
3356
+		if (array_key_exists('group_by', $query_params)) {
3357
+			if (is_array($query_params['group_by'])) {
3358
+				//it's an array, so assume we'll be grouping by a bunch of stuff
3359
+				$group_by_array = array();
3360
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
3361
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3362
+				}
3363
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3364
+			} elseif (! empty ($query_params['group_by'])) {
3365
+				$query_object->set_group_by_sql(
3366
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3367
+				);
3368
+			}
3369
+		}
3370
+		//set having
3371
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
3372
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3373
+		}
3374
+		//now, just verify they didn't pass anything wack
3375
+		foreach ($query_params as $query_key => $query_value) {
3376
+			if (! in_array($query_key, $this->_allowed_query_params, true)) {
3377
+				throw new EE_Error(
3378
+					sprintf(
3379
+						__(
3380
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3381
+							'event_espresso'
3382
+						),
3383
+						$query_key,
3384
+						get_class($this),
3385
+						//						print_r( $this->_allowed_query_params, TRUE )
3386
+						implode(',', $this->_allowed_query_params)
3387
+					)
3388
+				);
3389
+			}
3390
+		}
3391
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
3392
+		if (empty($main_model_join_sql)) {
3393
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
3394
+		}
3395
+		return $query_object;
3396
+	}
3397
+
3398
+
3399
+
3400
+	/**
3401
+	 * Gets the where conditions that should be imposed on the query based on the
3402
+	 * context (eg reading frontend, backend, edit or delete).
3403
+	 *
3404
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
3405
+	 * @return array like EEM_Base::get_all() 's $query_params[0]
3406
+	 * @throws \EE_Error
3407
+	 */
3408
+	public function caps_where_conditions($context = self::caps_read)
3409
+	{
3410
+		EEM_Base::verify_is_valid_cap_context($context);
3411
+		$cap_where_conditions = array();
3412
+		$cap_restrictions = $this->caps_missing($context);
3413
+		/**
3414
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
3415
+		 */
3416
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3417
+			$cap_where_conditions = array_replace_recursive($cap_where_conditions,
3418
+				$restriction_if_no_cap->get_default_where_conditions());
3419
+		}
3420
+		return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3421
+			$cap_restrictions);
3422
+	}
3423
+
3424
+
3425
+
3426
+	/**
3427
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3428
+	 * otherwise throws an exception
3429
+	 *
3430
+	 * @param string $should_be_order_string
3431
+	 * @return string either ASC, asc, DESC or desc
3432
+	 * @throws EE_Error
3433
+	 */
3434
+	private function _extract_order($should_be_order_string)
3435
+	{
3436
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3437
+			return $should_be_order_string;
3438
+		} else {
3439
+			throw new EE_Error(sprintf(__("While performing a query on '%s', tried to use '%s' as an order parameter. ",
3440
+				"event_espresso"), get_class($this), $should_be_order_string));
3441
+		}
3442
+	}
3443
+
3444
+
3445
+
3446
+	/**
3447
+	 * Looks at all the models which are included in this query, and asks each
3448
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3449
+	 * so they can be merged
3450
+	 *
3451
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
3452
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3453
+	 *                                                                  'none' means NO default where conditions will
3454
+	 *                                                                  be used AT ALL during this query.
3455
+	 *                                                                  'other_models_only' means default where
3456
+	 *                                                                  conditions from other models will be used, but
3457
+	 *                                                                  not for this primary model. 'all', the default,
3458
+	 *                                                                  means default where conditions will apply as
3459
+	 *                                                                  normal
3460
+	 * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3461
+	 * @throws EE_Error
3462
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
3463
+	 */
3464
+	private function _get_default_where_conditions_for_models_in_query(
3465
+		EE_Model_Query_Info_Carrier $query_info_carrier,
3466
+		$use_default_where_conditions = EEM_Base::default_where_conditions_all,
3467
+		$where_query_params = array()
3468
+	) {
3469
+		$allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3470
+		if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3471
+			throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3472
+				"event_espresso"), $use_default_where_conditions,
3473
+				implode(", ", $allowed_used_default_where_conditions_values)));
3474
+		}
3475
+		$universal_query_params = array();
3476
+		if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3477
+			$universal_query_params = $this->_get_default_where_conditions();
3478
+		} else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3479
+			$universal_query_params = $this->_get_minimum_where_conditions();
3480
+		}
3481
+		foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3482
+			$related_model = $this->get_related_model_obj($model_name);
3483
+			if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3484
+				$related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3485
+			} elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3486
+				$related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3487
+			} else {
3488
+				//we don't want to add full or even minimum default where conditions from this model, so just continue
3489
+				continue;
3490
+			}
3491
+			$overrides = $this->_override_defaults_or_make_null_friendly(
3492
+				$related_model_universal_where_params,
3493
+				$where_query_params,
3494
+				$related_model,
3495
+				$model_relation_path
3496
+			);
3497
+			$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3498
+				$universal_query_params,
3499
+				$overrides
3500
+			);
3501
+		}
3502
+		return $universal_query_params;
3503
+	}
3504
+
3505
+
3506
+
3507
+	/**
3508
+	 * Determines whether or not we should use default where conditions for the model in question
3509
+	 * (this model, or other related models).
3510
+	 * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3511
+	 * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3512
+	 * We should use default where conditions on related models when they requested to use default where conditions
3513
+	 * on all models, or specifically just on other related models
3514
+	 * @param      $default_where_conditions_value
3515
+	 * @param bool $for_this_model false means this is for OTHER related models
3516
+	 * @return bool
3517
+	 */
3518
+	private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3519
+	{
3520
+		return (
3521
+				   $for_this_model
3522
+				   && in_array(
3523
+					   $default_where_conditions_value,
3524
+					   array(
3525
+						   EEM_Base::default_where_conditions_all,
3526
+						   EEM_Base::default_where_conditions_this_only,
3527
+						   EEM_Base::default_where_conditions_minimum_others,
3528
+					   ),
3529
+					   true
3530
+				   )
3531
+			   )
3532
+			   || (
3533
+				   ! $for_this_model
3534
+				   && in_array(
3535
+					   $default_where_conditions_value,
3536
+					   array(
3537
+						   EEM_Base::default_where_conditions_all,
3538
+						   EEM_Base::default_where_conditions_others_only,
3539
+					   ),
3540
+					   true
3541
+				   )
3542
+			   );
3543
+	}
3544
+
3545
+	/**
3546
+	 * Determines whether or not we should use default minimum conditions for the model in question
3547
+	 * (this model, or other related models).
3548
+	 * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3549
+	 * where conditions.
3550
+	 * We should use minimum where conditions on related models if they requested to use minimum where conditions
3551
+	 * on this model or others
3552
+	 * @param      $default_where_conditions_value
3553
+	 * @param bool $for_this_model false means this is for OTHER related models
3554
+	 * @return bool
3555
+	 */
3556
+	private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3557
+	{
3558
+		return (
3559
+				   $for_this_model
3560
+				   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3561
+			   )
3562
+			   || (
3563
+				   ! $for_this_model
3564
+				   && in_array(
3565
+					   $default_where_conditions_value,
3566
+					   array(
3567
+						   EEM_Base::default_where_conditions_minimum_others,
3568
+						   EEM_Base::default_where_conditions_minimum_all,
3569
+					   ),
3570
+					   true
3571
+				   )
3572
+			   );
3573
+	}
3574
+
3575
+
3576
+	/**
3577
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3578
+	 * then we also add a special where condition which allows for that model's primary key
3579
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3580
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3581
+	 *
3582
+	 * @param array    $default_where_conditions
3583
+	 * @param array    $provided_where_conditions
3584
+	 * @param EEM_Base $model
3585
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
3586
+	 * @return array like EEM_Base::get_all's $query_params[0]
3587
+	 * @throws \EE_Error
3588
+	 */
3589
+	private function _override_defaults_or_make_null_friendly(
3590
+		$default_where_conditions,
3591
+		$provided_where_conditions,
3592
+		$model,
3593
+		$model_relation_path
3594
+	) {
3595
+		$null_friendly_where_conditions = array();
3596
+		$none_overridden = true;
3597
+		$or_condition_key_for_defaults = 'OR*' . get_class($model);
3598
+		foreach ($default_where_conditions as $key => $val) {
3599
+			if (isset($provided_where_conditions[$key])) {
3600
+				$none_overridden = false;
3601
+			} else {
3602
+				$null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3603
+			}
3604
+		}
3605
+		if ($none_overridden && $default_where_conditions) {
3606
+			if ($model->has_primary_key_field()) {
3607
+				$null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3608
+																				. "."
3609
+																				. $model->primary_key_name()] = array('IS NULL');
3610
+			}/*else{
3611 3611
 				//@todo NO PK, use other defaults
3612 3612
 			}*/
3613
-        }
3614
-        return $null_friendly_where_conditions;
3615
-    }
3616
-
3617
-
3618
-
3619
-    /**
3620
-     * Uses the _default_where_conditions_strategy set during __construct() to get
3621
-     * default where conditions on all get_all, update, and delete queries done by this model.
3622
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3623
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3624
-     *
3625
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3626
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3627
-     */
3628
-    private function _get_default_where_conditions($model_relation_path = null)
3629
-    {
3630
-        if ($this->_ignore_where_strategy) {
3631
-            return array();
3632
-        }
3633
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3634
-    }
3635
-
3636
-
3637
-
3638
-    /**
3639
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
3640
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
3641
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3642
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3643
-     * Similar to _get_default_where_conditions
3644
-     *
3645
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3646
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3647
-     */
3648
-    protected function _get_minimum_where_conditions($model_relation_path = null)
3649
-    {
3650
-        if ($this->_ignore_where_strategy) {
3651
-            return array();
3652
-        }
3653
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3654
-    }
3655
-
3656
-
3657
-
3658
-    /**
3659
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3660
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3661
-     *
3662
-     * @param EE_Model_Query_Info_Carrier $model_query_info
3663
-     * @return string
3664
-     * @throws \EE_Error
3665
-     */
3666
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3667
-    {
3668
-        $selects = $this->_get_columns_to_select_for_this_model();
3669
-        foreach (
3670
-            $model_query_info->get_model_names_included() as $model_relation_chain =>
3671
-            $name_of_other_model_included
3672
-        ) {
3673
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3674
-            $other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3675
-            foreach ($other_model_selects as $key => $value) {
3676
-                $selects[] = $value;
3677
-            }
3678
-        }
3679
-        return implode(", ", $selects);
3680
-    }
3681
-
3682
-
3683
-
3684
-    /**
3685
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3686
-     * So that's going to be the columns for all the fields on the model
3687
-     *
3688
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
3689
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3690
-     */
3691
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3692
-    {
3693
-        $fields = $this->field_settings();
3694
-        $selects = array();
3695
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3696
-            $this->get_this_model_name());
3697
-        foreach ($fields as $field_obj) {
3698
-            $selects[] = $table_alias_with_model_relation_chain_prefix
3699
-                         . $field_obj->get_table_alias()
3700
-                         . "."
3701
-                         . $field_obj->get_table_column()
3702
-                         . " AS '"
3703
-                         . $table_alias_with_model_relation_chain_prefix
3704
-                         . $field_obj->get_table_alias()
3705
-                         . "."
3706
-                         . $field_obj->get_table_column()
3707
-                         . "'";
3708
-        }
3709
-        //make sure we are also getting the PKs of each table
3710
-        $tables = $this->get_tables();
3711
-        if (count($tables) > 1) {
3712
-            foreach ($tables as $table_obj) {
3713
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3714
-                                       . $table_obj->get_fully_qualified_pk_column();
3715
-                if (! in_array($qualified_pk_column, $selects)) {
3716
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3717
-                }
3718
-            }
3719
-        }
3720
-        return $selects;
3721
-    }
3722
-
3723
-
3724
-
3725
-    /**
3726
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3727
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3728
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3729
-     * SQL for joining, and the data types
3730
-     *
3731
-     * @param null|string                 $original_query_param
3732
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
3733
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3734
-     * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3735
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3736
-     *                                                          column name. We only want model names, eg 'Event.Venue'
3737
-     *                                                          or 'Registration's
3738
-     * @param string                      $original_query_param what it originally was (eg
3739
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3740
-     *                                                          matches $query_param
3741
-     * @throws EE_Error
3742
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3743
-     */
3744
-    private function _extract_related_model_info_from_query_param(
3745
-        $query_param,
3746
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3747
-        $query_param_type,
3748
-        $original_query_param = null
3749
-    ) {
3750
-        if ($original_query_param === null) {
3751
-            $original_query_param = $query_param;
3752
-        }
3753
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3754
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3755
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3756
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3757
-        //check to see if we have a field on this model
3758
-        $this_model_fields = $this->field_settings(true);
3759
-        if (array_key_exists($query_param, $this_model_fields)) {
3760
-            if ($allow_fields) {
3761
-                return;
3762
-            } else {
3763
-                throw new EE_Error(sprintf(__("Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3764
-                    "event_espresso"),
3765
-                    $query_param, get_class($this), $query_param_type, $original_query_param));
3766
-            }
3767
-        } //check if this is a special logic query param
3768
-        elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
3769
-            if ($allow_logic_query_params) {
3770
-                return;
3771
-            } else {
3772
-                throw new EE_Error(
3773
-                    sprintf(
3774
-                        __('Logic query params ("%1$s") are being used incorrectly with the following query param ("%2$s") on model %3$s. %4$sAdditional Info:%4$s%5$s',
3775
-                            'event_espresso'),
3776
-                        implode('", "', $this->_logic_query_param_keys),
3777
-                        $query_param,
3778
-                        get_class($this),
3779
-                        '<br />',
3780
-                        "\t"
3781
-                        . ' $passed_in_query_info = <pre>'
3782
-                        . print_r($passed_in_query_info, true)
3783
-                        . '</pre>'
3784
-                        . "\n\t"
3785
-                        . ' $query_param_type = '
3786
-                        . $query_param_type
3787
-                        . "\n\t"
3788
-                        . ' $original_query_param = '
3789
-                        . $original_query_param
3790
-                    )
3791
-                );
3792
-            }
3793
-        } //check if it's a custom selection
3794
-        elseif (array_key_exists($query_param, $this->_custom_selections)) {
3795
-            return;
3796
-        }
3797
-        //check if has a model name at the beginning
3798
-        //and
3799
-        //check if it's a field on a related model
3800
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3801
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3802
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3803
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3804
-                if ($query_param === '') {
3805
-                    //nothing left to $query_param
3806
-                    //we should actually end in a field name, not a model like this!
3807
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3808
-                        "event_espresso"),
3809
-                        $query_param, $query_param_type, get_class($this), $valid_related_model_name));
3810
-                } else {
3811
-                    $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3812
-                    $related_model_obj->_extract_related_model_info_from_query_param($query_param,
3813
-                        $passed_in_query_info, $query_param_type, $original_query_param);
3814
-                    return;
3815
-                }
3816
-            } elseif ($query_param === $valid_related_model_name) {
3817
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3818
-                return;
3819
-            }
3820
-        }
3821
-        //ok so $query_param didn't start with a model name
3822
-        //and we previously confirmed it wasn't a logic query param or field on the current model
3823
-        //it's wack, that's what it is
3824
-        throw new EE_Error(sprintf(__("There is no model named '%s' related to %s. Query param type is %s and original query param is %s",
3825
-            "event_espresso"),
3826
-            $query_param, get_class($this), $query_param_type, $original_query_param));
3827
-    }
3828
-
3829
-
3830
-
3831
-    /**
3832
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3833
-     * and store it on $passed_in_query_info
3834
-     *
3835
-     * @param string                      $model_name
3836
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3837
-     * @param string                      $original_query_param used to extract the relation chain between the queried
3838
-     *                                                          model and $model_name. Eg, if we are querying Event,
3839
-     *                                                          and are adding a join to 'Payment' with the original
3840
-     *                                                          query param key
3841
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3842
-     *                                                          to extract 'Registration.Transaction.Payment', in case
3843
-     *                                                          Payment wants to add default query params so that it
3844
-     *                                                          will know what models to prepend onto its default query
3845
-     *                                                          params or in case it wants to rename tables (in case
3846
-     *                                                          there are multiple joins to the same table)
3847
-     * @return void
3848
-     * @throws \EE_Error
3849
-     */
3850
-    private function _add_join_to_model(
3851
-        $model_name,
3852
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3853
-        $original_query_param
3854
-    ) {
3855
-        $relation_obj = $this->related_settings_for($model_name);
3856
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3857
-        //check if the relation is HABTM, because then we're essentially doing two joins
3858
-        //If so, join first to the JOIN table, and add its data types, and then continue as normal
3859
-        if ($relation_obj instanceof EE_HABTM_Relation) {
3860
-            $join_model_obj = $relation_obj->get_join_model();
3861
-            //replace the model specified with the join model for this relation chain, whi
3862
-            $relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3863
-                $join_model_obj->get_this_model_name(), $model_relation_chain);
3864
-            $new_query_info = new EE_Model_Query_Info_Carrier(
3865
-                array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3866
-                $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3867
-            $passed_in_query_info->merge($new_query_info);
3868
-        }
3869
-        //now just join to the other table pointed to by the relation object, and add its data types
3870
-        $new_query_info = new EE_Model_Query_Info_Carrier(
3871
-            array($model_relation_chain => $model_name),
3872
-            $relation_obj->get_join_statement($model_relation_chain));
3873
-        $passed_in_query_info->merge($new_query_info);
3874
-    }
3875
-
3876
-
3877
-
3878
-    /**
3879
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
3880
-     *
3881
-     * @param array $where_params like EEM_Base::get_all
3882
-     * @return string of SQL
3883
-     * @throws \EE_Error
3884
-     */
3885
-    private function _construct_where_clause($where_params)
3886
-    {
3887
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3888
-        if ($SQL) {
3889
-            return " WHERE " . $SQL;
3890
-        } else {
3891
-            return '';
3892
-        }
3893
-    }
3894
-
3895
-
3896
-
3897
-    /**
3898
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
3899
-     * and should be passed HAVING parameters, not WHERE parameters
3900
-     *
3901
-     * @param array $having_params
3902
-     * @return string
3903
-     * @throws \EE_Error
3904
-     */
3905
-    private function _construct_having_clause($having_params)
3906
-    {
3907
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3908
-        if ($SQL) {
3909
-            return " HAVING " . $SQL;
3910
-        } else {
3911
-            return '';
3912
-        }
3913
-    }
3914
-
3915
-
3916
-
3917
-    /**
3918
-     * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
3919
-     * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
3920
-     * EEM_Attendee.
3921
-     *
3922
-     * @param string $field_name
3923
-     * @param string $model_name
3924
-     * @return EE_Model_Field_Base
3925
-     * @throws EE_Error
3926
-     */
3927
-    protected function _get_field_on_model($field_name, $model_name)
3928
-    {
3929
-        $model_class = 'EEM_' . $model_name;
3930
-        $model_filepath = $model_class . ".model.php";
3931
-        if (is_readable($model_filepath)) {
3932
-            require_once($model_filepath);
3933
-            $model_instance = call_user_func($model_name . "::instance");
3934
-            /* @var $model_instance EEM_Base */
3935
-            return $model_instance->field_settings_for($field_name);
3936
-        } else {
3937
-            throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
3938
-                'event_espresso'), $model_name, $model_class, $model_filepath));
3939
-        }
3940
-    }
3941
-
3942
-
3943
-
3944
-    /**
3945
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
3946
-     * Event_Meta.meta_value = 'foo'))"
3947
-     *
3948
-     * @param array  $where_params see EEM_Base::get_all for documentation
3949
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
3950
-     * @throws EE_Error
3951
-     * @return string of SQL
3952
-     */
3953
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
3954
-    {
3955
-        $where_clauses = array();
3956
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3957
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3958
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
3959
-                switch ($query_param) {
3960
-                    case 'not':
3961
-                    case 'NOT':
3962
-                        $where_clauses[] = "! ("
3963
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3964
-                                $glue)
3965
-                                           . ")";
3966
-                        break;
3967
-                    case 'and':
3968
-                    case 'AND':
3969
-                        $where_clauses[] = " ("
3970
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3971
-                                ' AND ')
3972
-                                           . ")";
3973
-                        break;
3974
-                    case 'or':
3975
-                    case 'OR':
3976
-                        $where_clauses[] = " ("
3977
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3978
-                                ' OR ')
3979
-                                           . ")";
3980
-                        break;
3981
-                }
3982
-            } else {
3983
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
3984
-                //if it's not a normal field, maybe it's a custom selection?
3985
-                if (! $field_obj) {
3986
-                    if (isset($this->_custom_selections[$query_param][1])) {
3987
-                        $field_obj = $this->_custom_selections[$query_param][1];
3988
-                    } else {
3989
-                        throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
3990
-                            "event_espresso"), $query_param));
3991
-                    }
3992
-                }
3993
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3994
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3995
-            }
3996
-        }
3997
-        return $where_clauses ? implode($glue, $where_clauses) : '';
3998
-    }
3999
-
4000
-
4001
-
4002
-    /**
4003
-     * Takes the input parameter and extract the table name (alias) and column name
4004
-     *
4005
-     * @param array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4006
-     * @throws EE_Error
4007
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4008
-     */
4009
-    private function _deduce_column_name_from_query_param($query_param)
4010
-    {
4011
-        $field = $this->_deduce_field_from_query_param($query_param);
4012
-        if ($field) {
4013
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4014
-                $query_param);
4015
-            return $table_alias_prefix . $field->get_qualified_column();
4016
-        } elseif (array_key_exists($query_param, $this->_custom_selections)) {
4017
-            //maybe it's custom selection item?
4018
-            //if so, just use it as the "column name"
4019
-            return $query_param;
4020
-        } else {
4021
-            throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
4022
-                "event_espresso"), $query_param, implode(",", $this->_custom_selections)));
4023
-        }
4024
-    }
4025
-
4026
-
4027
-
4028
-    /**
4029
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4030
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4031
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4032
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4033
-     *
4034
-     * @param string $condition_query_param_key
4035
-     * @return string
4036
-     */
4037
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4038
-    {
4039
-        $pos_of_star = strpos($condition_query_param_key, '*');
4040
-        if ($pos_of_star === false) {
4041
-            return $condition_query_param_key;
4042
-        } else {
4043
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4044
-            return $condition_query_param_sans_star;
4045
-        }
4046
-    }
4047
-
4048
-
4049
-
4050
-    /**
4051
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4052
-     *
4053
-     * @param                            mixed      array | string    $op_and_value
4054
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4055
-     * @throws EE_Error
4056
-     * @return string
4057
-     */
4058
-    private function _construct_op_and_value($op_and_value, $field_obj)
4059
-    {
4060
-        if (is_array($op_and_value)) {
4061
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4062
-            if (! $operator) {
4063
-                $php_array_like_string = array();
4064
-                foreach ($op_and_value as $key => $value) {
4065
-                    $php_array_like_string[] = "$key=>$value";
4066
-                }
4067
-                throw new EE_Error(
4068
-                    sprintf(
4069
-                        __(
4070
-                            "You setup a query parameter like you were going to specify an operator, but didn't. You provided '(%s)', but the operator should be at array key index 0 (eg array('>',32))",
4071
-                            "event_espresso"
4072
-                        ),
4073
-                        implode(",", $php_array_like_string)
4074
-                    )
4075
-                );
4076
-            }
4077
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4078
-        } else {
4079
-            $operator = '=';
4080
-            $value = $op_and_value;
4081
-        }
4082
-        //check to see if the value is actually another field
4083
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4084
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4085
-        } elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4086
-            //in this case, the value should be an array, or at least a comma-separated list
4087
-            //it will need to handle a little differently
4088
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
4089
-            //note: $cleaned_value has already been run through $wpdb->prepare()
4090
-            return $operator . SP . $cleaned_value;
4091
-        } elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4092
-            //the value should be an array with count of two.
4093
-            if (count($value) !== 2) {
4094
-                throw new EE_Error(
4095
-                    sprintf(
4096
-                        __(
4097
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4098
-                            'event_espresso'
4099
-                        ),
4100
-                        "BETWEEN"
4101
-                    )
4102
-                );
4103
-            }
4104
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
4105
-            return $operator . SP . $cleaned_value;
4106
-        } elseif (in_array($operator, $this->_null_style_operators)) {
4107
-            if ($value !== null) {
4108
-                throw new EE_Error(
4109
-                    sprintf(
4110
-                        __(
4111
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4112
-                            "event_espresso"
4113
-                        ),
4114
-                        $value,
4115
-                        $operator
4116
-                    )
4117
-                );
4118
-            }
4119
-            return $operator;
4120
-        } elseif ($operator === 'LIKE' && ! is_array($value)) {
4121
-            //if the operator is 'LIKE', we want to allow percent signs (%) and not
4122
-            //remove other junk. So just treat it as a string.
4123
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4124
-        } elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4125
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4126
-        } elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4127
-            throw new EE_Error(
4128
-                sprintf(
4129
-                    __(
4130
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4131
-                        'event_espresso'
4132
-                    ),
4133
-                    $operator,
4134
-                    $operator
4135
-                )
4136
-            );
4137
-        } elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4138
-            throw new EE_Error(
4139
-                sprintf(
4140
-                    __(
4141
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4142
-                        'event_espresso'
4143
-                    ),
4144
-                    $operator,
4145
-                    $operator
4146
-                )
4147
-            );
4148
-        } else {
4149
-            throw new EE_Error(
4150
-                sprintf(
4151
-                    __(
4152
-                        "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4153
-                        "event_espresso"
4154
-                    ),
4155
-                    http_build_query($op_and_value)
4156
-                )
4157
-            );
4158
-        }
4159
-    }
4160
-
4161
-
4162
-
4163
-    /**
4164
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4165
-     *
4166
-     * @param array                      $values
4167
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4168
-     *                                              '%s'
4169
-     * @return string
4170
-     * @throws \EE_Error
4171
-     */
4172
-    public function _construct_between_value($values, $field_obj)
4173
-    {
4174
-        $cleaned_values = array();
4175
-        foreach ($values as $value) {
4176
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4177
-        }
4178
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4179
-    }
4180
-
4181
-
4182
-
4183
-    /**
4184
-     * Takes an array or a comma-separated list of $values and cleans them
4185
-     * according to $data_type using $wpdb->prepare, and then makes the list a
4186
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4187
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4188
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4189
-     *
4190
-     * @param mixed                      $values    array or comma-separated string
4191
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4192
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4193
-     * @throws \EE_Error
4194
-     */
4195
-    public function _construct_in_value($values, $field_obj)
4196
-    {
4197
-        //check if the value is a CSV list
4198
-        if (is_string($values)) {
4199
-            //in which case, turn it into an array
4200
-            $values = explode(",", $values);
4201
-        }
4202
-        $cleaned_values = array();
4203
-        foreach ($values as $value) {
4204
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4205
-        }
4206
-        //we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4207
-        //but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4208
-        //which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4209
-        if (empty($cleaned_values)) {
4210
-            $all_fields = $this->field_settings();
4211
-            $a_field = array_shift($all_fields);
4212
-            $main_table = $this->_get_main_table();
4213
-            $cleaned_values[] = "SELECT "
4214
-                                . $a_field->get_table_column()
4215
-                                . " FROM "
4216
-                                . $main_table->get_table_name()
4217
-                                . " WHERE FALSE";
4218
-        }
4219
-        return "(" . implode(",", $cleaned_values) . ")";
4220
-    }
4221
-
4222
-
4223
-
4224
-    /**
4225
-     * @param mixed                      $value
4226
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4227
-     * @throws EE_Error
4228
-     * @return false|null|string
4229
-     */
4230
-    private function _wpdb_prepare_using_field($value, $field_obj)
4231
-    {
4232
-        /** @type WPDB $wpdb */
4233
-        global $wpdb;
4234
-        if ($field_obj instanceof EE_Model_Field_Base) {
4235
-            return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4236
-                $this->_prepare_value_for_use_in_db($value, $field_obj));
4237
-        } else {//$field_obj should really just be a data type
4238
-            if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4239
-                throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4240
-                    $field_obj, implode(",", $this->_valid_wpdb_data_types)));
4241
-            }
4242
-            return $wpdb->prepare($field_obj, $value);
4243
-        }
4244
-    }
4245
-
4246
-
4247
-
4248
-    /**
4249
-     * Takes the input parameter and finds the model field that it indicates.
4250
-     *
4251
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4252
-     * @throws EE_Error
4253
-     * @return EE_Model_Field_Base
4254
-     */
4255
-    protected function _deduce_field_from_query_param($query_param_name)
4256
-    {
4257
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
4258
-        //which will help us find the database table and column
4259
-        $query_param_parts = explode(".", $query_param_name);
4260
-        if (empty($query_param_parts)) {
4261
-            throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4262
-                'event_espresso'), $query_param_name));
4263
-        }
4264
-        $number_of_parts = count($query_param_parts);
4265
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4266
-        if ($number_of_parts === 1) {
4267
-            $field_name = $last_query_param_part;
4268
-            $model_obj = $this;
4269
-        } else {// $number_of_parts >= 2
4270
-            //the last part is the column name, and there are only 2parts. therefore...
4271
-            $field_name = $last_query_param_part;
4272
-            $model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4273
-        }
4274
-        try {
4275
-            return $model_obj->field_settings_for($field_name);
4276
-        } catch (EE_Error $e) {
4277
-            return null;
4278
-        }
4279
-    }
4280
-
4281
-
4282
-
4283
-    /**
4284
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4285
-     * alias and column which corresponds to it
4286
-     *
4287
-     * @param string $field_name
4288
-     * @throws EE_Error
4289
-     * @return string
4290
-     */
4291
-    public function _get_qualified_column_for_field($field_name)
4292
-    {
4293
-        $all_fields = $this->field_settings();
4294
-        $field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4295
-        if ($field) {
4296
-            return $field->get_qualified_column();
4297
-        } else {
4298
-            throw new EE_Error(sprintf(__("There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
4299
-                'event_espresso'), $field_name, get_class($this)));
4300
-        }
4301
-    }
4302
-
4303
-
4304
-
4305
-    /**
4306
-     * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4307
-     * Example usage:
4308
-     * EEM_Ticket::instance()->get_all_wpdb_results(
4309
-     *      array(),
4310
-     *      ARRAY_A,
4311
-     *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4312
-     *  );
4313
-     * is equivalent to
4314
-     *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4315
-     * and
4316
-     *  EEM_Event::instance()->get_all_wpdb_results(
4317
-     *      array(
4318
-     *          array(
4319
-     *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4320
-     *          ),
4321
-     *          ARRAY_A,
4322
-     *          implode(
4323
-     *              ', ',
4324
-     *              array_merge(
4325
-     *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4326
-     *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4327
-     *              )
4328
-     *          )
4329
-     *      )
4330
-     *  );
4331
-     * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4332
-     *
4333
-     * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4334
-     *                                            and the one whose fields you are selecting for example: when querying
4335
-     *                                            tickets model and selecting fields from the tickets model you would
4336
-     *                                            leave this parameter empty, because no models are needed to join
4337
-     *                                            between the queried model and the selected one. Likewise when
4338
-     *                                            querying the datetime model and selecting fields from the tickets
4339
-     *                                            model, it would also be left empty, because there is a direct
4340
-     *                                            relation from datetimes to tickets, so no model is needed to join
4341
-     *                                            them together. However, when querying from the event model and
4342
-     *                                            selecting fields from the ticket model, you should provide the string
4343
-     *                                            'Datetime', indicating that the event model must first join to the
4344
-     *                                            datetime model in order to find its relation to ticket model.
4345
-     *                                            Also, when querying from the venue model and selecting fields from
4346
-     *                                            the ticket model, you should provide the string 'Event.Datetime',
4347
-     *                                            indicating you need to join the venue model to the event model,
4348
-     *                                            to the datetime model, in order to find its relation to the ticket model.
4349
-     *                                            This string is used to deduce the prefix that gets added onto the
4350
-     *                                            models' tables qualified columns
4351
-     * @param bool   $return_string               if true, will return a string with qualified column names separated
4352
-     *                                            by ', ' if false, will simply return a numerically indexed array of
4353
-     *                                            qualified column names
4354
-     * @return array|string
4355
-     */
4356
-    public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4357
-    {
4358
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4359
-        $qualified_columns = array();
4360
-        foreach ($this->field_settings() as $field_name => $field) {
4361
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4362
-        }
4363
-        return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4364
-    }
4365
-
4366
-
4367
-
4368
-    /**
4369
-     * constructs the select use on special limit joins
4370
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4371
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
4372
-     * (as that is typically where the limits would be set).
4373
-     *
4374
-     * @param  string       $table_alias The table the select is being built for
4375
-     * @param  mixed|string $limit       The limit for this select
4376
-     * @return string                The final select join element for the query.
4377
-     */
4378
-    public function _construct_limit_join_select($table_alias, $limit)
4379
-    {
4380
-        $SQL = '';
4381
-        foreach ($this->_tables as $table_obj) {
4382
-            if ($table_obj instanceof EE_Primary_Table) {
4383
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4384
-                    ? $table_obj->get_select_join_limit($limit)
4385
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4386
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
4387
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4388
-                    ? $table_obj->get_select_join_limit_join($limit)
4389
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4390
-            }
4391
-        }
4392
-        return $SQL;
4393
-    }
4394
-
4395
-
4396
-
4397
-    /**
4398
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4399
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4400
-     *
4401
-     * @return string SQL
4402
-     * @throws \EE_Error
4403
-     */
4404
-    public function _construct_internal_join()
4405
-    {
4406
-        $SQL = $this->_get_main_table()->get_table_sql();
4407
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4408
-        return $SQL;
4409
-    }
4410
-
4411
-
4412
-
4413
-    /**
4414
-     * Constructs the SQL for joining all the tables on this model.
4415
-     * Normally $alias should be the primary table's alias, but in cases where
4416
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4417
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4418
-     * alias, this will construct SQL like:
4419
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4420
-     * With $alias being a secondary table's alias, this will construct SQL like:
4421
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4422
-     *
4423
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4424
-     * @return string
4425
-     */
4426
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4427
-    {
4428
-        $SQL = '';
4429
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4430
-        foreach ($this->_tables as $table_obj) {
4431
-            if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4432
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4433
-                    //so we're joining to this table, meaning the table is already in
4434
-                    //the FROM statement, BUT the primary table isn't. So we want
4435
-                    //to add the inverse join sql
4436
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4437
-                } else {
4438
-                    //just add a regular JOIN to this table from the primary table
4439
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
4440
-                }
4441
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4442
-        }
4443
-        return $SQL;
4444
-    }
4445
-
4446
-
4447
-
4448
-    /**
4449
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
4450
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4451
-     * their data type (eg, '%s', '%d', etc)
4452
-     *
4453
-     * @return array
4454
-     */
4455
-    public function _get_data_types()
4456
-    {
4457
-        $data_types = array();
4458
-        foreach ($this->field_settings() as $field_obj) {
4459
-            //$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4460
-            /** @var $field_obj EE_Model_Field_Base */
4461
-            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4462
-        }
4463
-        return $data_types;
4464
-    }
4465
-
4466
-
4467
-
4468
-    /**
4469
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4470
-     *
4471
-     * @param string $model_name
4472
-     * @throws EE_Error
4473
-     * @return EEM_Base
4474
-     */
4475
-    public function get_related_model_obj($model_name)
4476
-    {
4477
-        $model_classname = "EEM_" . $model_name;
4478
-        if (! class_exists($model_classname)) {
4479
-            throw new EE_Error(sprintf(__("You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
4480
-                'event_espresso'), $model_name, $model_classname));
4481
-        }
4482
-        return call_user_func($model_classname . "::instance");
4483
-    }
4484
-
4485
-
4486
-
4487
-    /**
4488
-     * Returns the array of EE_ModelRelations for this model.
4489
-     *
4490
-     * @return EE_Model_Relation_Base[]
4491
-     */
4492
-    public function relation_settings()
4493
-    {
4494
-        return $this->_model_relations;
4495
-    }
4496
-
4497
-
4498
-
4499
-    /**
4500
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
4501
-     * because without THOSE models, this model probably doesn't have much purpose.
4502
-     * (Eg, without an event, datetimes have little purpose.)
4503
-     *
4504
-     * @return EE_Belongs_To_Relation[]
4505
-     */
4506
-    public function belongs_to_relations()
4507
-    {
4508
-        $belongs_to_relations = array();
4509
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
4510
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
4511
-                $belongs_to_relations[$model_name] = $relation_obj;
4512
-            }
4513
-        }
4514
-        return $belongs_to_relations;
4515
-    }
4516
-
4517
-
4518
-
4519
-    /**
4520
-     * Returns the specified EE_Model_Relation, or throws an exception
4521
-     *
4522
-     * @param string $relation_name name of relation, key in $this->_relatedModels
4523
-     * @throws EE_Error
4524
-     * @return EE_Model_Relation_Base
4525
-     */
4526
-    public function related_settings_for($relation_name)
4527
-    {
4528
-        $relatedModels = $this->relation_settings();
4529
-        if (! array_key_exists($relation_name, $relatedModels)) {
4530
-            throw new EE_Error(
4531
-                sprintf(
4532
-                    __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4533
-                        'event_espresso'),
4534
-                    $relation_name,
4535
-                    $this->_get_class_name(),
4536
-                    implode(', ', array_keys($relatedModels))
4537
-                )
4538
-            );
4539
-        }
4540
-        return $relatedModels[$relation_name];
4541
-    }
4542
-
4543
-
4544
-
4545
-    /**
4546
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4547
-     * fields
4548
-     *
4549
-     * @param string $fieldName
4550
-     * @throws EE_Error
4551
-     * @return EE_Model_Field_Base
4552
-     */
4553
-    public function field_settings_for($fieldName)
4554
-    {
4555
-        $fieldSettings = $this->field_settings(true);
4556
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4557
-            throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4558
-                get_class($this)));
4559
-        }
4560
-        return $fieldSettings[$fieldName];
4561
-    }
4562
-
4563
-
4564
-
4565
-    /**
4566
-     * Checks if this field exists on this model
4567
-     *
4568
-     * @param string $fieldName a key in the model's _field_settings array
4569
-     * @return boolean
4570
-     */
4571
-    public function has_field($fieldName)
4572
-    {
4573
-        $fieldSettings = $this->field_settings(true);
4574
-        if (isset($fieldSettings[$fieldName])) {
4575
-            return true;
4576
-        } else {
4577
-            return false;
4578
-        }
4579
-    }
4580
-
4581
-
4582
-
4583
-    /**
4584
-     * Returns whether or not this model has a relation to the specified model
4585
-     *
4586
-     * @param string $relation_name possibly one of the keys in the relation_settings array
4587
-     * @return boolean
4588
-     */
4589
-    public function has_relation($relation_name)
4590
-    {
4591
-        $relations = $this->relation_settings();
4592
-        if (isset($relations[$relation_name])) {
4593
-            return true;
4594
-        } else {
4595
-            return false;
4596
-        }
4597
-    }
4598
-
4599
-
4600
-
4601
-    /**
4602
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4603
-     * Eg, on EE_Answer that would be ANS_ID field object
4604
-     *
4605
-     * @param $field_obj
4606
-     * @return boolean
4607
-     */
4608
-    public function is_primary_key_field($field_obj)
4609
-    {
4610
-        return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4611
-    }
4612
-
4613
-
4614
-
4615
-    /**
4616
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4617
-     * Eg, on EE_Answer that would be ANS_ID field object
4618
-     *
4619
-     * @return EE_Model_Field_Base
4620
-     * @throws EE_Error
4621
-     */
4622
-    public function get_primary_key_field()
4623
-    {
4624
-        if ($this->_primary_key_field === null) {
4625
-            foreach ($this->field_settings(true) as $field_obj) {
4626
-                if ($this->is_primary_key_field($field_obj)) {
4627
-                    $this->_primary_key_field = $field_obj;
4628
-                    break;
4629
-                }
4630
-            }
4631
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4632
-                throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4633
-                    get_class($this)));
4634
-            }
4635
-        }
4636
-        return $this->_primary_key_field;
4637
-    }
4638
-
4639
-
4640
-
4641
-    /**
4642
-     * Returns whether or not not there is a primary key on this model.
4643
-     * Internally does some caching.
4644
-     *
4645
-     * @return boolean
4646
-     */
4647
-    public function has_primary_key_field()
4648
-    {
4649
-        if ($this->_has_primary_key_field === null) {
4650
-            try {
4651
-                $this->get_primary_key_field();
4652
-                $this->_has_primary_key_field = true;
4653
-            } catch (EE_Error $e) {
4654
-                $this->_has_primary_key_field = false;
4655
-            }
4656
-        }
4657
-        return $this->_has_primary_key_field;
4658
-    }
4659
-
4660
-
4661
-
4662
-    /**
4663
-     * Finds the first field of type $field_class_name.
4664
-     *
4665
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4666
-     *                                 EE_Foreign_Key_Field, etc
4667
-     * @return EE_Model_Field_Base or null if none is found
4668
-     */
4669
-    public function get_a_field_of_type($field_class_name)
4670
-    {
4671
-        foreach ($this->field_settings() as $field) {
4672
-            if ($field instanceof $field_class_name) {
4673
-                return $field;
4674
-            }
4675
-        }
4676
-        return null;
4677
-    }
4678
-
4679
-
4680
-
4681
-    /**
4682
-     * Gets a foreign key field pointing to model.
4683
-     *
4684
-     * @param string $model_name eg Event, Registration, not EEM_Event
4685
-     * @return EE_Foreign_Key_Field_Base
4686
-     * @throws EE_Error
4687
-     */
4688
-    public function get_foreign_key_to($model_name)
4689
-    {
4690
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4691
-            foreach ($this->field_settings() as $field) {
4692
-                if (
4693
-                    $field instanceof EE_Foreign_Key_Field_Base
4694
-                    && in_array($model_name, $field->get_model_names_pointed_to())
4695
-                ) {
4696
-                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
4697
-                    break;
4698
-                }
4699
-            }
4700
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4701
-                throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4702
-                    'event_espresso'), $model_name, get_class($this)));
4703
-            }
4704
-        }
4705
-        return $this->_cache_foreign_key_to_fields[$model_name];
4706
-    }
4707
-
4708
-
4709
-
4710
-    /**
4711
-     * Gets the actual table for the table alias
4712
-     *
4713
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4714
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4715
-     *                            Either one works
4716
-     * @return EE_Table_Base
4717
-     */
4718
-    public function get_table_for_alias($table_alias)
4719
-    {
4720
-        $table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4721
-        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4722
-    }
4723
-
4724
-
4725
-
4726
-    /**
4727
-     * Returns a flat array of all field son this model, instead of organizing them
4728
-     * by table_alias as they are in the constructor.
4729
-     *
4730
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4731
-     * @return EE_Model_Field_Base[] where the keys are the field's name
4732
-     */
4733
-    public function field_settings($include_db_only_fields = false)
4734
-    {
4735
-        if ($include_db_only_fields) {
4736
-            if ($this->_cached_fields === null) {
4737
-                $this->_cached_fields = array();
4738
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4739
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4740
-                        $this->_cached_fields[$field_name] = $field_obj;
4741
-                    }
4742
-                }
4743
-            }
4744
-            return $this->_cached_fields;
4745
-        } else {
4746
-            if ($this->_cached_fields_non_db_only === null) {
4747
-                $this->_cached_fields_non_db_only = array();
4748
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4749
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4750
-                        /** @var $field_obj EE_Model_Field_Base */
4751
-                        if (! $field_obj->is_db_only_field()) {
4752
-                            $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4753
-                        }
4754
-                    }
4755
-                }
4756
-            }
4757
-            return $this->_cached_fields_non_db_only;
4758
-        }
4759
-    }
4760
-
4761
-
4762
-
4763
-    /**
4764
-     *        cycle though array of attendees and create objects out of each item
4765
-     *
4766
-     * @access        private
4767
-     * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4768
-     * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4769
-     *                           numerically indexed)
4770
-     * @throws \EE_Error
4771
-     */
4772
-    protected function _create_objects($rows = array())
4773
-    {
4774
-        $array_of_objects = array();
4775
-        if (empty($rows)) {
4776
-            return array();
4777
-        }
4778
-        $count_if_model_has_no_primary_key = 0;
4779
-        $has_primary_key = $this->has_primary_key_field();
4780
-        $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4781
-        foreach ((array)$rows as $row) {
4782
-            if (empty($row)) {
4783
-                //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4784
-                return array();
4785
-            }
4786
-            //check if we've already set this object in the results array,
4787
-            //in which case there's no need to process it further (again)
4788
-            if ($has_primary_key) {
4789
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4790
-                    $row,
4791
-                    $primary_key_field->get_qualified_column(),
4792
-                    $primary_key_field->get_table_column()
4793
-                );
4794
-                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4795
-                    continue;
4796
-                }
4797
-            }
4798
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
4799
-            if (! $classInstance) {
4800
-                throw new EE_Error(
4801
-                    sprintf(
4802
-                        __('Could not create instance of class %s from row %s', 'event_espresso'),
4803
-                        $this->get_this_model_name(),
4804
-                        http_build_query($row)
4805
-                    )
4806
-                );
4807
-            }
4808
-            //set the timezone on the instantiated objects
4809
-            $classInstance->set_timezone($this->_timezone);
4810
-            //make sure if there is any timezone setting present that we set the timezone for the object
4811
-            $key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4812
-            $array_of_objects[$key] = $classInstance;
4813
-            //also, for all the relations of type BelongsTo, see if we can cache
4814
-            //those related models
4815
-            //(we could do this for other relations too, but if there are conditions
4816
-            //that filtered out some fo the results, then we'd be caching an incomplete set
4817
-            //so it requires a little more thought than just caching them immediately...)
4818
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
4819
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
4820
-                    //check if this model's INFO is present. If so, cache it on the model
4821
-                    $other_model = $relation_obj->get_other_model();
4822
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4823
-                    //if we managed to make a model object from the results, cache it on the main model object
4824
-                    if ($other_model_obj_maybe) {
4825
-                        //set timezone on these other model objects if they are present
4826
-                        $other_model_obj_maybe->set_timezone($this->_timezone);
4827
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
4828
-                    }
4829
-                }
4830
-            }
4831
-        }
4832
-        return $array_of_objects;
4833
-    }
4834
-
4835
-
4836
-
4837
-    /**
4838
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4839
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4840
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4841
-     * object (as set in the model_field!).
4842
-     *
4843
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4844
-     */
4845
-    public function create_default_object()
4846
-    {
4847
-        $this_model_fields_and_values = array();
4848
-        //setup the row using default values;
4849
-        foreach ($this->field_settings() as $field_name => $field_obj) {
4850
-            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4851
-        }
4852
-        $className = $this->_get_class_name();
4853
-        $classInstance = EE_Registry::instance()
4854
-                                    ->load_class($className, array($this_model_fields_and_values), false, false);
4855
-        return $classInstance;
4856
-    }
4857
-
4858
-
4859
-
4860
-    /**
4861
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4862
-     *                             or an stdClass where each property is the name of a column,
4863
-     * @return EE_Base_Class
4864
-     * @throws \EE_Error
4865
-     */
4866
-    public function instantiate_class_from_array_or_object($cols_n_values)
4867
-    {
4868
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4869
-            $cols_n_values = get_object_vars($cols_n_values);
4870
-        }
4871
-        $primary_key = null;
4872
-        //make sure the array only has keys that are fields/columns on this model
4873
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4874
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
4875
-            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
4876
-        }
4877
-        $className = $this->_get_class_name();
4878
-        //check we actually found results that we can use to build our model object
4879
-        //if not, return null
4880
-        if ($this->has_primary_key_field()) {
4881
-            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
4882
-                return null;
4883
-            }
4884
-        } else if ($this->unique_indexes()) {
4885
-            $first_column = reset($this_model_fields_n_values);
4886
-            if (empty($first_column)) {
4887
-                return null;
4888
-            }
4889
-        }
4890
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4891
-        if ($primary_key) {
4892
-            $classInstance = $this->get_from_entity_map($primary_key);
4893
-            if (! $classInstance) {
4894
-                $classInstance = EE_Registry::instance()
4895
-                                            ->load_class($className,
4896
-                                                array($this_model_fields_n_values, $this->_timezone), true, false);
4897
-                // add this new object to the entity map
4898
-                $classInstance = $this->add_to_entity_map($classInstance);
4899
-            }
4900
-        } else {
4901
-            $classInstance = EE_Registry::instance()
4902
-                                        ->load_class($className, array($this_model_fields_n_values, $this->_timezone),
4903
-                                            true, false);
4904
-        }
4905
-        //it is entirely possible that the instantiated class object has a set timezone_string db field and has set it's internal _timezone property accordingly (see new_instance_from_db in model objects particularly EE_Event for example).  In this case, we want to make sure the model object doesn't have its timezone string overwritten by any timezone property currently set here on the model so, we intentionally override the model _timezone property with the model_object timezone property.
4906
-        $this->set_timezone($classInstance->get_timezone());
4907
-        return $classInstance;
4908
-    }
4909
-
4910
-
4911
-
4912
-    /**
4913
-     * Gets the model object from the  entity map if it exists
4914
-     *
4915
-     * @param int|string $id the ID of the model object
4916
-     * @return EE_Base_Class
4917
-     */
4918
-    public function get_from_entity_map($id)
4919
-    {
4920
-        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
4921
-            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
4922
-    }
4923
-
4924
-
4925
-
4926
-    /**
4927
-     * add_to_entity_map
4928
-     * Adds the object to the model's entity mappings
4929
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
4930
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
4931
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
4932
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
4933
-     *        then this method should be called immediately after the update query
4934
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
4935
-     * so on multisite, the entity map is specific to the query being done for a specific site.
4936
-     *
4937
-     * @param    EE_Base_Class $object
4938
-     * @throws EE_Error
4939
-     * @return \EE_Base_Class
4940
-     */
4941
-    public function add_to_entity_map(EE_Base_Class $object)
4942
-    {
4943
-        $className = $this->_get_class_name();
4944
-        if (! $object instanceof $className) {
4945
-            throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4946
-                is_object($object) ? get_class($object) : $object, $className));
4947
-        }
4948
-        /** @var $object EE_Base_Class */
4949
-        if (! $object->ID()) {
4950
-            throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4951
-                "event_espresso"), get_class($this)));
4952
-        }
4953
-        // double check it's not already there
4954
-        $classInstance = $this->get_from_entity_map($object->ID());
4955
-        if ($classInstance) {
4956
-            return $classInstance;
4957
-        } else {
4958
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
4959
-            return $object;
4960
-        }
4961
-    }
4962
-
4963
-
4964
-
4965
-    /**
4966
-     * if a valid identifier is provided, then that entity is unset from the entity map,
4967
-     * if no identifier is provided, then the entire entity map is emptied
4968
-     *
4969
-     * @param int|string $id the ID of the model object
4970
-     * @return boolean
4971
-     */
4972
-    public function clear_entity_map($id = null)
4973
-    {
4974
-        if (empty($id)) {
4975
-            $this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
4976
-            return true;
4977
-        }
4978
-        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
4979
-            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
4980
-            return true;
4981
-        }
4982
-        return false;
4983
-    }
4984
-
4985
-
4986
-
4987
-    /**
4988
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
4989
-     * Given an array where keys are column (or column alias) names and values,
4990
-     * returns an array of their corresponding field names and database values
4991
-     *
4992
-     * @param array $cols_n_values
4993
-     * @return array
4994
-     */
4995
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
4996
-    {
4997
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4998
-    }
4999
-
5000
-
5001
-
5002
-    /**
5003
-     * _deduce_fields_n_values_from_cols_n_values
5004
-     * Given an array where keys are column (or column alias) names and values,
5005
-     * returns an array of their corresponding field names and database values
5006
-     *
5007
-     * @param string $cols_n_values
5008
-     * @return array
5009
-     */
5010
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5011
-    {
5012
-        $this_model_fields_n_values = array();
5013
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
5014
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5015
-                $table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5016
-            //there is a primary key on this table and its not set. Use defaults for all its columns
5017
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
5018
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5019
-                    if (! $field_obj->is_db_only_field()) {
5020
-                        //prepare field as if its coming from db
5021
-                        $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5022
-                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5023
-                    }
5024
-                }
5025
-            } else {
5026
-                //the table's rows existed. Use their values
5027
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5028
-                    if (! $field_obj->is_db_only_field()) {
5029
-                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5030
-                            $cols_n_values, $field_obj->get_qualified_column(),
5031
-                            $field_obj->get_table_column()
5032
-                        );
5033
-                    }
5034
-                }
5035
-            }
5036
-        }
5037
-        return $this_model_fields_n_values;
5038
-    }
5039
-
5040
-
5041
-
5042
-    /**
5043
-     * @param $cols_n_values
5044
-     * @param $qualified_column
5045
-     * @param $regular_column
5046
-     * @return null
5047
-     */
5048
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5049
-    {
5050
-        $value = null;
5051
-        //ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5052
-        //does the field on the model relate to this column retrieved from the db?
5053
-        //or is it a db-only field? (not relating to the model)
5054
-        if (isset($cols_n_values[$qualified_column])) {
5055
-            $value = $cols_n_values[$qualified_column];
5056
-        } elseif (isset($cols_n_values[$regular_column])) {
5057
-            $value = $cols_n_values[$regular_column];
5058
-        }
5059
-        return $value;
5060
-    }
5061
-
5062
-
5063
-
5064
-    /**
5065
-     * refresh_entity_map_from_db
5066
-     * Makes sure the model object in the entity map at $id assumes the values
5067
-     * of the database (opposite of EE_base_Class::save())
5068
-     *
5069
-     * @param int|string $id
5070
-     * @return EE_Base_Class
5071
-     * @throws \EE_Error
5072
-     */
5073
-    public function refresh_entity_map_from_db($id)
5074
-    {
5075
-        $obj_in_map = $this->get_from_entity_map($id);
5076
-        if ($obj_in_map) {
5077
-            $wpdb_results = $this->_get_all_wpdb_results(
5078
-                array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5079
-            );
5080
-            if ($wpdb_results && is_array($wpdb_results)) {
5081
-                $one_row = reset($wpdb_results);
5082
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5083
-                    $obj_in_map->set_from_db($field_name, $db_value);
5084
-                }
5085
-                //clear the cache of related model objects
5086
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5087
-                    $obj_in_map->clear_cache($relation_name, null, true);
5088
-                }
5089
-            }
5090
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5091
-            return $obj_in_map;
5092
-        } else {
5093
-            return $this->get_one_by_ID($id);
5094
-        }
5095
-    }
5096
-
5097
-
5098
-
5099
-    /**
5100
-     * refresh_entity_map_with
5101
-     * Leaves the entry in the entity map alone, but updates it to match the provided
5102
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5103
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5104
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5105
-     *
5106
-     * @param int|string    $id
5107
-     * @param EE_Base_Class $replacing_model_obj
5108
-     * @return \EE_Base_Class
5109
-     * @throws \EE_Error
5110
-     */
5111
-    public function refresh_entity_map_with($id, $replacing_model_obj)
5112
-    {
5113
-        $obj_in_map = $this->get_from_entity_map($id);
5114
-        if ($obj_in_map) {
5115
-            if ($replacing_model_obj instanceof EE_Base_Class) {
5116
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5117
-                    $obj_in_map->set($field_name, $value);
5118
-                }
5119
-                //make the model object in the entity map's cache match the $replacing_model_obj
5120
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5121
-                    $obj_in_map->clear_cache($relation_name, null, true);
5122
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5123
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5124
-                    }
5125
-                }
5126
-            }
5127
-            return $obj_in_map;
5128
-        } else {
5129
-            $this->add_to_entity_map($replacing_model_obj);
5130
-            return $replacing_model_obj;
5131
-        }
5132
-    }
5133
-
5134
-
5135
-
5136
-    /**
5137
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5138
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5139
-     * require_once($this->_getClassName().".class.php");
5140
-     *
5141
-     * @return string
5142
-     */
5143
-    private function _get_class_name()
5144
-    {
5145
-        return "EE_" . $this->get_this_model_name();
5146
-    }
5147
-
5148
-
5149
-
5150
-    /**
5151
-     * Get the name of the items this model represents, for the quantity specified. Eg,
5152
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5153
-     * it would be 'Events'.
5154
-     *
5155
-     * @param int $quantity
5156
-     * @return string
5157
-     */
5158
-    public function item_name($quantity = 1)
5159
-    {
5160
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5161
-    }
5162
-
5163
-
5164
-
5165
-    /**
5166
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5167
-     * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5168
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5169
-     * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5170
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5171
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5172
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
5173
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
5174
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5175
-     * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5176
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5177
-     *        return $previousReturnValue.$returnString;
5178
-     * }
5179
-     * require('EEM_Answer.model.php');
5180
-     * $answer=EEM_Answer::instance();
5181
-     * echo $answer->my_callback('monkeys',100);
5182
-     * //will output "you called my_callback! and passed args:monkeys,100"
5183
-     *
5184
-     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5185
-     * @param array  $args       array of original arguments passed to the function
5186
-     * @throws EE_Error
5187
-     * @return mixed whatever the plugin which calls add_filter decides
5188
-     */
5189
-    public function __call($methodName, $args)
5190
-    {
5191
-        $className = get_class($this);
5192
-        $tagName = "FHEE__{$className}__{$methodName}";
5193
-        if (! has_filter($tagName)) {
5194
-            throw new EE_Error(
5195
-                sprintf(
5196
-                    __('Method %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
5197
-                        'event_espresso'),
5198
-                    $methodName,
5199
-                    $className,
5200
-                    $tagName,
5201
-                    '<br />'
5202
-                )
5203
-            );
5204
-        }
5205
-        return apply_filters($tagName, null, $this, $args);
5206
-    }
5207
-
5208
-
5209
-
5210
-    /**
5211
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5212
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5213
-     *
5214
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5215
-     *                                                       the EE_Base_Class object that corresponds to this Model,
5216
-     *                                                       the object's class name
5217
-     *                                                       or object's ID
5218
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5219
-     *                                                       exists in the database. If it does not, we add it
5220
-     * @throws EE_Error
5221
-     * @return EE_Base_Class
5222
-     */
5223
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5224
-    {
5225
-        $className = $this->_get_class_name();
5226
-        if ($base_class_obj_or_id instanceof $className) {
5227
-            $model_object = $base_class_obj_or_id;
5228
-        } else {
5229
-            $primary_key_field = $this->get_primary_key_field();
5230
-            if (
5231
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
5232
-                && (
5233
-                    is_int($base_class_obj_or_id)
5234
-                    || is_string($base_class_obj_or_id)
5235
-                )
5236
-            ) {
5237
-                // assume it's an ID.
5238
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
5239
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5240
-            } else if (
5241
-                $primary_key_field instanceof EE_Primary_Key_String_Field
5242
-                && is_string($base_class_obj_or_id)
5243
-            ) {
5244
-                // assume its a string representation of the object
5245
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5246
-            } else {
5247
-                throw new EE_Error(
5248
-                    sprintf(
5249
-                        __(
5250
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5251
-                            'event_espresso'
5252
-                        ),
5253
-                        $base_class_obj_or_id,
5254
-                        $this->_get_class_name(),
5255
-                        print_r($base_class_obj_or_id, true)
5256
-                    )
5257
-                );
5258
-            }
5259
-        }
5260
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
5261
-            $model_object->save();
5262
-        }
5263
-        return $model_object;
5264
-    }
5265
-
5266
-
5267
-
5268
-    /**
5269
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5270
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
5271
-     * returns it ID.
5272
-     *
5273
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
5274
-     * @return int|string depending on the type of this model object's ID
5275
-     * @throws EE_Error
5276
-     */
5277
-    public function ensure_is_ID($base_class_obj_or_id)
5278
-    {
5279
-        $className = $this->_get_class_name();
5280
-        if ($base_class_obj_or_id instanceof $className) {
5281
-            /** @var $base_class_obj_or_id EE_Base_Class */
5282
-            $id = $base_class_obj_or_id->ID();
5283
-        } elseif (is_int($base_class_obj_or_id)) {
5284
-            //assume it's an ID
5285
-            $id = $base_class_obj_or_id;
5286
-        } elseif (is_string($base_class_obj_or_id)) {
5287
-            //assume its a string representation of the object
5288
-            $id = $base_class_obj_or_id;
5289
-        } else {
5290
-            throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5291
-                'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5292
-                print_r($base_class_obj_or_id, true)));
5293
-        }
5294
-        return $id;
5295
-    }
5296
-
5297
-
5298
-
5299
-    /**
5300
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5301
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5302
-     * been sanitized and converted into the appropriate domain.
5303
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5304
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5305
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5306
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5307
-     * $EVT = EEM_Event::instance(); $old_setting =
5308
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5309
-     * $EVT->assume_values_already_prepared_by_model_object(true);
5310
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5311
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5312
-     *
5313
-     * @param int $values_already_prepared like one of the constants on EEM_Base
5314
-     * @return void
5315
-     */
5316
-    public function assume_values_already_prepared_by_model_object(
5317
-        $values_already_prepared = self::not_prepared_by_model_object
5318
-    ) {
5319
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
5320
-    }
5321
-
5322
-
5323
-
5324
-    /**
5325
-     * Read comments for assume_values_already_prepared_by_model_object()
5326
-     *
5327
-     * @return int
5328
-     */
5329
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
5330
-    {
5331
-        return $this->_values_already_prepared_by_model_object;
5332
-    }
5333
-
5334
-
5335
-
5336
-    /**
5337
-     * Gets all the indexes on this model
5338
-     *
5339
-     * @return EE_Index[]
5340
-     */
5341
-    public function indexes()
5342
-    {
5343
-        return $this->_indexes;
5344
-    }
5345
-
5346
-
5347
-
5348
-    /**
5349
-     * Gets all the Unique Indexes on this model
5350
-     *
5351
-     * @return EE_Unique_Index[]
5352
-     */
5353
-    public function unique_indexes()
5354
-    {
5355
-        $unique_indexes = array();
5356
-        foreach ($this->_indexes as $name => $index) {
5357
-            if ($index instanceof EE_Unique_Index) {
5358
-                $unique_indexes [$name] = $index;
5359
-            }
5360
-        }
5361
-        return $unique_indexes;
5362
-    }
5363
-
5364
-
5365
-
5366
-    /**
5367
-     * Gets all the fields which, when combined, make the primary key.
5368
-     * This is usually just an array with 1 element (the primary key), but in cases
5369
-     * where there is no primary key, it's a combination of fields as defined
5370
-     * on a primary index
5371
-     *
5372
-     * @return EE_Model_Field_Base[] indexed by the field's name
5373
-     * @throws \EE_Error
5374
-     */
5375
-    public function get_combined_primary_key_fields()
5376
-    {
5377
-        foreach ($this->indexes() as $index) {
5378
-            if ($index instanceof EE_Primary_Key_Index) {
5379
-                return $index->fields();
5380
-            }
5381
-        }
5382
-        return array($this->primary_key_name() => $this->get_primary_key_field());
5383
-    }
5384
-
5385
-
5386
-
5387
-    /**
5388
-     * Used to build a primary key string (when the model has no primary key),
5389
-     * which can be used a unique string to identify this model object.
5390
-     *
5391
-     * @param array $cols_n_values keys are field names, values are their values
5392
-     * @return string
5393
-     * @throws \EE_Error
5394
-     */
5395
-    public function get_index_primary_key_string($cols_n_values)
5396
-    {
5397
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5398
-            $this->get_combined_primary_key_fields());
5399
-        return http_build_query($cols_n_values_for_primary_key_index);
5400
-    }
5401
-
5402
-
5403
-
5404
-    /**
5405
-     * Gets the field values from the primary key string
5406
-     *
5407
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5408
-     * @param string $index_primary_key_string
5409
-     * @return null|array
5410
-     * @throws \EE_Error
5411
-     */
5412
-    public function parse_index_primary_key_string($index_primary_key_string)
5413
-    {
5414
-        $key_fields = $this->get_combined_primary_key_fields();
5415
-        //check all of them are in the $id
5416
-        $key_vals_in_combined_pk = array();
5417
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5418
-        foreach ($key_fields as $key_field_name => $field_obj) {
5419
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5420
-                return null;
5421
-            }
5422
-        }
5423
-        return $key_vals_in_combined_pk;
5424
-    }
5425
-
5426
-
5427
-
5428
-    /**
5429
-     * verifies that an array of key-value pairs for model fields has a key
5430
-     * for each field comprising the primary key index
5431
-     *
5432
-     * @param array $key_vals
5433
-     * @return boolean
5434
-     * @throws \EE_Error
5435
-     */
5436
-    public function has_all_combined_primary_key_fields($key_vals)
5437
-    {
5438
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5439
-        foreach ($keys_it_should_have as $key) {
5440
-            if (! isset($key_vals[$key])) {
5441
-                return false;
5442
-            }
5443
-        }
5444
-        return true;
5445
-    }
5446
-
5447
-
5448
-
5449
-    /**
5450
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5451
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
5452
-     *
5453
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5454
-     * @param array               $query_params                     like EEM_Base::get_all's query_params.
5455
-     * @throws EE_Error
5456
-     * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5457
-     *                                                              indexed)
5458
-     */
5459
-    public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5460
-    {
5461
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5462
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
5463
-        } elseif (is_array($model_object_or_attributes_array)) {
5464
-            $attributes_array = $model_object_or_attributes_array;
5465
-        } else {
5466
-            throw new EE_Error(sprintf(__("get_all_copies should be provided with either a model object or an array of field-value-pairs, but was given %s",
5467
-                "event_espresso"), $model_object_or_attributes_array));
5468
-        }
5469
-        //even copies obviously won't have the same ID, so remove the primary key
5470
-        //from the WHERE conditions for finding copies (if there is a primary key, of course)
5471
-        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5472
-            unset($attributes_array[$this->primary_key_name()]);
5473
-        }
5474
-        if (isset($query_params[0])) {
5475
-            $query_params[0] = array_merge($attributes_array, $query_params);
5476
-        } else {
5477
-            $query_params[0] = $attributes_array;
5478
-        }
5479
-        return $this->get_all($query_params);
5480
-    }
5481
-
5482
-
5483
-
5484
-    /**
5485
-     * Gets the first copy we find. See get_all_copies for more details
5486
-     *
5487
-     * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5488
-     * @param array $query_params
5489
-     * @return EE_Base_Class
5490
-     * @throws \EE_Error
5491
-     */
5492
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5493
-    {
5494
-        if (! is_array($query_params)) {
5495
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5496
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5497
-                    gettype($query_params)), '4.6.0');
5498
-            $query_params = array();
5499
-        }
5500
-        $query_params['limit'] = 1;
5501
-        $copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5502
-        if (is_array($copies)) {
5503
-            return array_shift($copies);
5504
-        } else {
5505
-            return null;
5506
-        }
5507
-    }
5508
-
5509
-
5510
-
5511
-    /**
5512
-     * Updates the item with the specified id. Ignores default query parameters because
5513
-     * we have specified the ID, and its assumed we KNOW what we're doing
5514
-     *
5515
-     * @param array      $fields_n_values keys are field names, values are their new values
5516
-     * @param int|string $id              the value of the primary key to update
5517
-     * @return int number of rows updated
5518
-     * @throws \EE_Error
5519
-     */
5520
-    public function update_by_ID($fields_n_values, $id)
5521
-    {
5522
-        $query_params = array(
5523
-            0                          => array($this->get_primary_key_field()->get_name() => $id),
5524
-            'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5525
-        );
5526
-        return $this->update($fields_n_values, $query_params);
5527
-    }
5528
-
5529
-
5530
-
5531
-    /**
5532
-     * Changes an operator which was supplied to the models into one usable in SQL
5533
-     *
5534
-     * @param string $operator_supplied
5535
-     * @return string an operator which can be used in SQL
5536
-     * @throws EE_Error
5537
-     */
5538
-    private function _prepare_operator_for_sql($operator_supplied)
5539
-    {
5540
-        $sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5541
-            : null;
5542
-        if ($sql_operator) {
5543
-            return $sql_operator;
5544
-        } else {
5545
-            throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
5546
-                "event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_operators))));
5547
-        }
5548
-    }
5549
-
5550
-
5551
-
5552
-    /**
5553
-     * Gets an array where keys are the primary keys and values are their 'names'
5554
-     * (as determined by the model object's name() function, which is often overridden)
5555
-     *
5556
-     * @param array $query_params like get_all's
5557
-     * @return string[]
5558
-     * @throws \EE_Error
5559
-     */
5560
-    public function get_all_names($query_params = array())
5561
-    {
5562
-        $objs = $this->get_all($query_params);
5563
-        $names = array();
5564
-        foreach ($objs as $obj) {
5565
-            $names[$obj->ID()] = $obj->name();
5566
-        }
5567
-        return $names;
5568
-    }
5569
-
5570
-
5571
-
5572
-    /**
5573
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
5574
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5575
-     * this is duplicated effort and reduces efficiency) you would be better to use
5576
-     * array_keys() on $model_objects.
5577
-     *
5578
-     * @param \EE_Base_Class[] $model_objects
5579
-     * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5580
-     *                                               in the returned array
5581
-     * @return array
5582
-     * @throws \EE_Error
5583
-     */
5584
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
5585
-    {
5586
-        if (! $this->has_primary_key_field()) {
5587
-            if (WP_DEBUG) {
5588
-                EE_Error::add_error(
5589
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5590
-                    __FILE__,
5591
-                    __FUNCTION__,
5592
-                    __LINE__
5593
-                );
5594
-            }
5595
-        }
5596
-        $IDs = array();
5597
-        foreach ($model_objects as $model_object) {
5598
-            $id = $model_object->ID();
5599
-            if (! $id) {
5600
-                if ($filter_out_empty_ids) {
5601
-                    continue;
5602
-                }
5603
-                if (WP_DEBUG) {
5604
-                    EE_Error::add_error(
5605
-                        __(
5606
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5607
-                            'event_espresso'
5608
-                        ),
5609
-                        __FILE__,
5610
-                        __FUNCTION__,
5611
-                        __LINE__
5612
-                    );
5613
-                }
5614
-            }
5615
-            $IDs[] = $id;
5616
-        }
5617
-        return $IDs;
5618
-    }
5619
-
5620
-
5621
-
5622
-    /**
5623
-     * Returns the string used in capabilities relating to this model. If there
5624
-     * are no capabilities that relate to this model returns false
5625
-     *
5626
-     * @return string|false
5627
-     */
5628
-    public function cap_slug()
5629
-    {
5630
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5631
-    }
5632
-
5633
-
5634
-
5635
-    /**
5636
-     * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5637
-     * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5638
-     * only returns the cap restrictions array in that context (ie, the array
5639
-     * at that key)
5640
-     *
5641
-     * @param string $context
5642
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
5643
-     * @throws \EE_Error
5644
-     */
5645
-    public function cap_restrictions($context = EEM_Base::caps_read)
5646
-    {
5647
-        EEM_Base::verify_is_valid_cap_context($context);
5648
-        //check if we ought to run the restriction generator first
5649
-        if (
5650
-            isset($this->_cap_restriction_generators[$context])
5651
-            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5652
-            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5653
-        ) {
5654
-            $this->_cap_restrictions[$context] = array_merge(
5655
-                $this->_cap_restrictions[$context],
5656
-                $this->_cap_restriction_generators[$context]->generate_restrictions()
5657
-            );
5658
-        }
5659
-        //and make sure we've finalized the construction of each restriction
5660
-        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5661
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5662
-                $where_conditions_obj->_finalize_construct($this);
5663
-            }
5664
-        }
5665
-        return $this->_cap_restrictions[$context];
5666
-    }
5667
-
5668
-
5669
-
5670
-    /**
5671
-     * Indicating whether or not this model thinks its a wp core model
5672
-     *
5673
-     * @return boolean
5674
-     */
5675
-    public function is_wp_core_model()
5676
-    {
5677
-        return $this->_wp_core_model;
5678
-    }
5679
-
5680
-
5681
-
5682
-    /**
5683
-     * Gets all the caps that are missing which impose a restriction on
5684
-     * queries made in this context
5685
-     *
5686
-     * @param string $context one of EEM_Base::caps_ constants
5687
-     * @return EE_Default_Where_Conditions[] indexed by capability name
5688
-     * @throws \EE_Error
5689
-     */
5690
-    public function caps_missing($context = EEM_Base::caps_read)
5691
-    {
5692
-        $missing_caps = array();
5693
-        $cap_restrictions = $this->cap_restrictions($context);
5694
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5695
-            if (! EE_Capabilities::instance()
5696
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5697
-            ) {
5698
-                $missing_caps[$cap] = $restriction_if_no_cap;
5699
-            }
5700
-        }
5701
-        return $missing_caps;
5702
-    }
5703
-
5704
-
5705
-
5706
-    /**
5707
-     * Gets the mapping from capability contexts to action strings used in capability names
5708
-     *
5709
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5710
-     * one of 'read', 'edit', or 'delete'
5711
-     */
5712
-    public function cap_contexts_to_cap_action_map()
5713
-    {
5714
-        return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5715
-            $this);
5716
-    }
5717
-
5718
-
5719
-
5720
-    /**
5721
-     * Gets the action string for the specified capability context
5722
-     *
5723
-     * @param string $context
5724
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5725
-     * @throws \EE_Error
5726
-     */
5727
-    public function cap_action_for_context($context)
5728
-    {
5729
-        $mapping = $this->cap_contexts_to_cap_action_map();
5730
-        if (isset($mapping[$context])) {
5731
-            return $mapping[$context];
5732
-        }
5733
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5734
-            return $action;
5735
-        }
5736
-        throw new EE_Error(
5737
-            sprintf(
5738
-                __('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5739
-                $context,
5740
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5741
-            )
5742
-        );
5743
-    }
5744
-
5745
-
5746
-
5747
-    /**
5748
-     * Returns all the capability contexts which are valid when querying models
5749
-     *
5750
-     * @return array
5751
-     */
5752
-    public static function valid_cap_contexts()
5753
-    {
5754
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5755
-            self::caps_read,
5756
-            self::caps_read_admin,
5757
-            self::caps_edit,
5758
-            self::caps_delete,
5759
-        ));
5760
-    }
5761
-
5762
-
5763
-
5764
-    /**
5765
-     * Returns all valid options for 'default_where_conditions'
5766
-     *
5767
-     * @return array
5768
-     */
5769
-    public static function valid_default_where_conditions()
5770
-    {
5771
-        return array(
5772
-            EEM_Base::default_where_conditions_all,
5773
-            EEM_Base::default_where_conditions_this_only,
5774
-            EEM_Base::default_where_conditions_others_only,
5775
-            EEM_Base::default_where_conditions_minimum_all,
5776
-            EEM_Base::default_where_conditions_minimum_others,
5777
-            EEM_Base::default_where_conditions_none
5778
-        );
5779
-    }
5780
-
5781
-    // public static function default_where_conditions_full
5782
-    /**
5783
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5784
-     *
5785
-     * @param string $context
5786
-     * @return bool
5787
-     * @throws \EE_Error
5788
-     */
5789
-    static public function verify_is_valid_cap_context($context)
5790
-    {
5791
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
5792
-        if (in_array($context, $valid_cap_contexts)) {
5793
-            return true;
5794
-        } else {
5795
-            throw new EE_Error(
5796
-                sprintf(
5797
-                    __('Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5798
-                        'event_espresso'),
5799
-                    $context,
5800
-                    'EEM_Base',
5801
-                    implode(',', $valid_cap_contexts)
5802
-                )
5803
-            );
5804
-        }
5805
-    }
5806
-
5807
-
5808
-
5809
-    /**
5810
-     * Clears all the models field caches. This is only useful when a sub-class
5811
-     * might have added a field or something and these caches might be invalidated
5812
-     */
5813
-    protected function _invalidate_field_caches()
5814
-    {
5815
-        $this->_cache_foreign_key_to_fields = array();
5816
-        $this->_cached_fields = null;
5817
-        $this->_cached_fields_non_db_only = null;
5818
-    }
5819
-
5820
-
5821
-
5822
-    /**
5823
-     * Gets the list of all the where query param keys that relate to logic instead of field names
5824
-     * (eg "and", "or", "not").
5825
-     *
5826
-     * @return array
5827
-     */
5828
-    public function logic_query_param_keys()
5829
-    {
5830
-        return $this->_logic_query_param_keys;
5831
-    }
5832
-
5833
-
5834
-
5835
-    /**
5836
-     * Determines whether or not the where query param array key is for a logic query param.
5837
-     * Eg 'OR', 'not*', and 'and*because-i-say-so' shoudl all return true, whereas
5838
-     * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
5839
-     *
5840
-     * @param $query_param_key
5841
-     * @return bool
5842
-     */
5843
-    public function is_logic_query_param_key($query_param_key)
5844
-    {
5845
-        foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
5846
-            if ($query_param_key === $logic_query_param_key
5847
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
5848
-            ) {
5849
-                return true;
5850
-            }
5851
-        }
5852
-        return false;
5853
-    }
3613
+		}
3614
+		return $null_friendly_where_conditions;
3615
+	}
3616
+
3617
+
3618
+
3619
+	/**
3620
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
3621
+	 * default where conditions on all get_all, update, and delete queries done by this model.
3622
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3623
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3624
+	 *
3625
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3626
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3627
+	 */
3628
+	private function _get_default_where_conditions($model_relation_path = null)
3629
+	{
3630
+		if ($this->_ignore_where_strategy) {
3631
+			return array();
3632
+		}
3633
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3634
+	}
3635
+
3636
+
3637
+
3638
+	/**
3639
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
3640
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
3641
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3642
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3643
+	 * Similar to _get_default_where_conditions
3644
+	 *
3645
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3646
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3647
+	 */
3648
+	protected function _get_minimum_where_conditions($model_relation_path = null)
3649
+	{
3650
+		if ($this->_ignore_where_strategy) {
3651
+			return array();
3652
+		}
3653
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3654
+	}
3655
+
3656
+
3657
+
3658
+	/**
3659
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3660
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3661
+	 *
3662
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
3663
+	 * @return string
3664
+	 * @throws \EE_Error
3665
+	 */
3666
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3667
+	{
3668
+		$selects = $this->_get_columns_to_select_for_this_model();
3669
+		foreach (
3670
+			$model_query_info->get_model_names_included() as $model_relation_chain =>
3671
+			$name_of_other_model_included
3672
+		) {
3673
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3674
+			$other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3675
+			foreach ($other_model_selects as $key => $value) {
3676
+				$selects[] = $value;
3677
+			}
3678
+		}
3679
+		return implode(", ", $selects);
3680
+	}
3681
+
3682
+
3683
+
3684
+	/**
3685
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3686
+	 * So that's going to be the columns for all the fields on the model
3687
+	 *
3688
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
3689
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3690
+	 */
3691
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3692
+	{
3693
+		$fields = $this->field_settings();
3694
+		$selects = array();
3695
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3696
+			$this->get_this_model_name());
3697
+		foreach ($fields as $field_obj) {
3698
+			$selects[] = $table_alias_with_model_relation_chain_prefix
3699
+						 . $field_obj->get_table_alias()
3700
+						 . "."
3701
+						 . $field_obj->get_table_column()
3702
+						 . " AS '"
3703
+						 . $table_alias_with_model_relation_chain_prefix
3704
+						 . $field_obj->get_table_alias()
3705
+						 . "."
3706
+						 . $field_obj->get_table_column()
3707
+						 . "'";
3708
+		}
3709
+		//make sure we are also getting the PKs of each table
3710
+		$tables = $this->get_tables();
3711
+		if (count($tables) > 1) {
3712
+			foreach ($tables as $table_obj) {
3713
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3714
+									   . $table_obj->get_fully_qualified_pk_column();
3715
+				if (! in_array($qualified_pk_column, $selects)) {
3716
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3717
+				}
3718
+			}
3719
+		}
3720
+		return $selects;
3721
+	}
3722
+
3723
+
3724
+
3725
+	/**
3726
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3727
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3728
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3729
+	 * SQL for joining, and the data types
3730
+	 *
3731
+	 * @param null|string                 $original_query_param
3732
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
3733
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3734
+	 * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3735
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3736
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
3737
+	 *                                                          or 'Registration's
3738
+	 * @param string                      $original_query_param what it originally was (eg
3739
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3740
+	 *                                                          matches $query_param
3741
+	 * @throws EE_Error
3742
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3743
+	 */
3744
+	private function _extract_related_model_info_from_query_param(
3745
+		$query_param,
3746
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3747
+		$query_param_type,
3748
+		$original_query_param = null
3749
+	) {
3750
+		if ($original_query_param === null) {
3751
+			$original_query_param = $query_param;
3752
+		}
3753
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3754
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3755
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3756
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3757
+		//check to see if we have a field on this model
3758
+		$this_model_fields = $this->field_settings(true);
3759
+		if (array_key_exists($query_param, $this_model_fields)) {
3760
+			if ($allow_fields) {
3761
+				return;
3762
+			} else {
3763
+				throw new EE_Error(sprintf(__("Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3764
+					"event_espresso"),
3765
+					$query_param, get_class($this), $query_param_type, $original_query_param));
3766
+			}
3767
+		} //check if this is a special logic query param
3768
+		elseif (in_array($query_param, $this->_logic_query_param_keys, true)) {
3769
+			if ($allow_logic_query_params) {
3770
+				return;
3771
+			} else {
3772
+				throw new EE_Error(
3773
+					sprintf(
3774
+						__('Logic query params ("%1$s") are being used incorrectly with the following query param ("%2$s") on model %3$s. %4$sAdditional Info:%4$s%5$s',
3775
+							'event_espresso'),
3776
+						implode('", "', $this->_logic_query_param_keys),
3777
+						$query_param,
3778
+						get_class($this),
3779
+						'<br />',
3780
+						"\t"
3781
+						. ' $passed_in_query_info = <pre>'
3782
+						. print_r($passed_in_query_info, true)
3783
+						. '</pre>'
3784
+						. "\n\t"
3785
+						. ' $query_param_type = '
3786
+						. $query_param_type
3787
+						. "\n\t"
3788
+						. ' $original_query_param = '
3789
+						. $original_query_param
3790
+					)
3791
+				);
3792
+			}
3793
+		} //check if it's a custom selection
3794
+		elseif (array_key_exists($query_param, $this->_custom_selections)) {
3795
+			return;
3796
+		}
3797
+		//check if has a model name at the beginning
3798
+		//and
3799
+		//check if it's a field on a related model
3800
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3801
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3802
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3803
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
3804
+				if ($query_param === '') {
3805
+					//nothing left to $query_param
3806
+					//we should actually end in a field name, not a model like this!
3807
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3808
+						"event_espresso"),
3809
+						$query_param, $query_param_type, get_class($this), $valid_related_model_name));
3810
+				} else {
3811
+					$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3812
+					$related_model_obj->_extract_related_model_info_from_query_param($query_param,
3813
+						$passed_in_query_info, $query_param_type, $original_query_param);
3814
+					return;
3815
+				}
3816
+			} elseif ($query_param === $valid_related_model_name) {
3817
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3818
+				return;
3819
+			}
3820
+		}
3821
+		//ok so $query_param didn't start with a model name
3822
+		//and we previously confirmed it wasn't a logic query param or field on the current model
3823
+		//it's wack, that's what it is
3824
+		throw new EE_Error(sprintf(__("There is no model named '%s' related to %s. Query param type is %s and original query param is %s",
3825
+			"event_espresso"),
3826
+			$query_param, get_class($this), $query_param_type, $original_query_param));
3827
+	}
3828
+
3829
+
3830
+
3831
+	/**
3832
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3833
+	 * and store it on $passed_in_query_info
3834
+	 *
3835
+	 * @param string                      $model_name
3836
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3837
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
3838
+	 *                                                          model and $model_name. Eg, if we are querying Event,
3839
+	 *                                                          and are adding a join to 'Payment' with the original
3840
+	 *                                                          query param key
3841
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3842
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
3843
+	 *                                                          Payment wants to add default query params so that it
3844
+	 *                                                          will know what models to prepend onto its default query
3845
+	 *                                                          params or in case it wants to rename tables (in case
3846
+	 *                                                          there are multiple joins to the same table)
3847
+	 * @return void
3848
+	 * @throws \EE_Error
3849
+	 */
3850
+	private function _add_join_to_model(
3851
+		$model_name,
3852
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3853
+		$original_query_param
3854
+	) {
3855
+		$relation_obj = $this->related_settings_for($model_name);
3856
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3857
+		//check if the relation is HABTM, because then we're essentially doing two joins
3858
+		//If so, join first to the JOIN table, and add its data types, and then continue as normal
3859
+		if ($relation_obj instanceof EE_HABTM_Relation) {
3860
+			$join_model_obj = $relation_obj->get_join_model();
3861
+			//replace the model specified with the join model for this relation chain, whi
3862
+			$relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3863
+				$join_model_obj->get_this_model_name(), $model_relation_chain);
3864
+			$new_query_info = new EE_Model_Query_Info_Carrier(
3865
+				array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3866
+				$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3867
+			$passed_in_query_info->merge($new_query_info);
3868
+		}
3869
+		//now just join to the other table pointed to by the relation object, and add its data types
3870
+		$new_query_info = new EE_Model_Query_Info_Carrier(
3871
+			array($model_relation_chain => $model_name),
3872
+			$relation_obj->get_join_statement($model_relation_chain));
3873
+		$passed_in_query_info->merge($new_query_info);
3874
+	}
3875
+
3876
+
3877
+
3878
+	/**
3879
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
3880
+	 *
3881
+	 * @param array $where_params like EEM_Base::get_all
3882
+	 * @return string of SQL
3883
+	 * @throws \EE_Error
3884
+	 */
3885
+	private function _construct_where_clause($where_params)
3886
+	{
3887
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
3888
+		if ($SQL) {
3889
+			return " WHERE " . $SQL;
3890
+		} else {
3891
+			return '';
3892
+		}
3893
+	}
3894
+
3895
+
3896
+
3897
+	/**
3898
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
3899
+	 * and should be passed HAVING parameters, not WHERE parameters
3900
+	 *
3901
+	 * @param array $having_params
3902
+	 * @return string
3903
+	 * @throws \EE_Error
3904
+	 */
3905
+	private function _construct_having_clause($having_params)
3906
+	{
3907
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
3908
+		if ($SQL) {
3909
+			return " HAVING " . $SQL;
3910
+		} else {
3911
+			return '';
3912
+		}
3913
+	}
3914
+
3915
+
3916
+
3917
+	/**
3918
+	 * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
3919
+	 * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
3920
+	 * EEM_Attendee.
3921
+	 *
3922
+	 * @param string $field_name
3923
+	 * @param string $model_name
3924
+	 * @return EE_Model_Field_Base
3925
+	 * @throws EE_Error
3926
+	 */
3927
+	protected function _get_field_on_model($field_name, $model_name)
3928
+	{
3929
+		$model_class = 'EEM_' . $model_name;
3930
+		$model_filepath = $model_class . ".model.php";
3931
+		if (is_readable($model_filepath)) {
3932
+			require_once($model_filepath);
3933
+			$model_instance = call_user_func($model_name . "::instance");
3934
+			/* @var $model_instance EEM_Base */
3935
+			return $model_instance->field_settings_for($field_name);
3936
+		} else {
3937
+			throw new EE_Error(sprintf(__('No model named %s exists, with classname %s and filepath %s',
3938
+				'event_espresso'), $model_name, $model_class, $model_filepath));
3939
+		}
3940
+	}
3941
+
3942
+
3943
+
3944
+	/**
3945
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
3946
+	 * Event_Meta.meta_value = 'foo'))"
3947
+	 *
3948
+	 * @param array  $where_params see EEM_Base::get_all for documentation
3949
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
3950
+	 * @throws EE_Error
3951
+	 * @return string of SQL
3952
+	 */
3953
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
3954
+	{
3955
+		$where_clauses = array();
3956
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
3957
+			$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
3958
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
3959
+				switch ($query_param) {
3960
+					case 'not':
3961
+					case 'NOT':
3962
+						$where_clauses[] = "! ("
3963
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3964
+								$glue)
3965
+										   . ")";
3966
+						break;
3967
+					case 'and':
3968
+					case 'AND':
3969
+						$where_clauses[] = " ("
3970
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3971
+								' AND ')
3972
+										   . ")";
3973
+						break;
3974
+					case 'or':
3975
+					case 'OR':
3976
+						$where_clauses[] = " ("
3977
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
3978
+								' OR ')
3979
+										   . ")";
3980
+						break;
3981
+				}
3982
+			} else {
3983
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
3984
+				//if it's not a normal field, maybe it's a custom selection?
3985
+				if (! $field_obj) {
3986
+					if (isset($this->_custom_selections[$query_param][1])) {
3987
+						$field_obj = $this->_custom_selections[$query_param][1];
3988
+					} else {
3989
+						throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
3990
+							"event_espresso"), $query_param));
3991
+					}
3992
+				}
3993
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
3994
+				$where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
3995
+			}
3996
+		}
3997
+		return $where_clauses ? implode($glue, $where_clauses) : '';
3998
+	}
3999
+
4000
+
4001
+
4002
+	/**
4003
+	 * Takes the input parameter and extract the table name (alias) and column name
4004
+	 *
4005
+	 * @param array $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4006
+	 * @throws EE_Error
4007
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4008
+	 */
4009
+	private function _deduce_column_name_from_query_param($query_param)
4010
+	{
4011
+		$field = $this->_deduce_field_from_query_param($query_param);
4012
+		if ($field) {
4013
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4014
+				$query_param);
4015
+			return $table_alias_prefix . $field->get_qualified_column();
4016
+		} elseif (array_key_exists($query_param, $this->_custom_selections)) {
4017
+			//maybe it's custom selection item?
4018
+			//if so, just use it as the "column name"
4019
+			return $query_param;
4020
+		} else {
4021
+			throw new EE_Error(sprintf(__("%s is not a valid field on this model, nor a custom selection (%s)",
4022
+				"event_espresso"), $query_param, implode(",", $this->_custom_selections)));
4023
+		}
4024
+	}
4025
+
4026
+
4027
+
4028
+	/**
4029
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4030
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4031
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4032
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4033
+	 *
4034
+	 * @param string $condition_query_param_key
4035
+	 * @return string
4036
+	 */
4037
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4038
+	{
4039
+		$pos_of_star = strpos($condition_query_param_key, '*');
4040
+		if ($pos_of_star === false) {
4041
+			return $condition_query_param_key;
4042
+		} else {
4043
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4044
+			return $condition_query_param_sans_star;
4045
+		}
4046
+	}
4047
+
4048
+
4049
+
4050
+	/**
4051
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4052
+	 *
4053
+	 * @param                            mixed      array | string    $op_and_value
4054
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4055
+	 * @throws EE_Error
4056
+	 * @return string
4057
+	 */
4058
+	private function _construct_op_and_value($op_and_value, $field_obj)
4059
+	{
4060
+		if (is_array($op_and_value)) {
4061
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4062
+			if (! $operator) {
4063
+				$php_array_like_string = array();
4064
+				foreach ($op_and_value as $key => $value) {
4065
+					$php_array_like_string[] = "$key=>$value";
4066
+				}
4067
+				throw new EE_Error(
4068
+					sprintf(
4069
+						__(
4070
+							"You setup a query parameter like you were going to specify an operator, but didn't. You provided '(%s)', but the operator should be at array key index 0 (eg array('>',32))",
4071
+							"event_espresso"
4072
+						),
4073
+						implode(",", $php_array_like_string)
4074
+					)
4075
+				);
4076
+			}
4077
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4078
+		} else {
4079
+			$operator = '=';
4080
+			$value = $op_and_value;
4081
+		}
4082
+		//check to see if the value is actually another field
4083
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4084
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4085
+		} elseif (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4086
+			//in this case, the value should be an array, or at least a comma-separated list
4087
+			//it will need to handle a little differently
4088
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
4089
+			//note: $cleaned_value has already been run through $wpdb->prepare()
4090
+			return $operator . SP . $cleaned_value;
4091
+		} elseif (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4092
+			//the value should be an array with count of two.
4093
+			if (count($value) !== 2) {
4094
+				throw new EE_Error(
4095
+					sprintf(
4096
+						__(
4097
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4098
+							'event_espresso'
4099
+						),
4100
+						"BETWEEN"
4101
+					)
4102
+				);
4103
+			}
4104
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
4105
+			return $operator . SP . $cleaned_value;
4106
+		} elseif (in_array($operator, $this->_null_style_operators)) {
4107
+			if ($value !== null) {
4108
+				throw new EE_Error(
4109
+					sprintf(
4110
+						__(
4111
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4112
+							"event_espresso"
4113
+						),
4114
+						$value,
4115
+						$operator
4116
+					)
4117
+				);
4118
+			}
4119
+			return $operator;
4120
+		} elseif ($operator === 'LIKE' && ! is_array($value)) {
4121
+			//if the operator is 'LIKE', we want to allow percent signs (%) and not
4122
+			//remove other junk. So just treat it as a string.
4123
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4124
+		} elseif (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4125
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4126
+		} elseif (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4127
+			throw new EE_Error(
4128
+				sprintf(
4129
+					__(
4130
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4131
+						'event_espresso'
4132
+					),
4133
+					$operator,
4134
+					$operator
4135
+				)
4136
+			);
4137
+		} elseif (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4138
+			throw new EE_Error(
4139
+				sprintf(
4140
+					__(
4141
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4142
+						'event_espresso'
4143
+					),
4144
+					$operator,
4145
+					$operator
4146
+				)
4147
+			);
4148
+		} else {
4149
+			throw new EE_Error(
4150
+				sprintf(
4151
+					__(
4152
+						"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4153
+						"event_espresso"
4154
+					),
4155
+					http_build_query($op_and_value)
4156
+				)
4157
+			);
4158
+		}
4159
+	}
4160
+
4161
+
4162
+
4163
+	/**
4164
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4165
+	 *
4166
+	 * @param array                      $values
4167
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4168
+	 *                                              '%s'
4169
+	 * @return string
4170
+	 * @throws \EE_Error
4171
+	 */
4172
+	public function _construct_between_value($values, $field_obj)
4173
+	{
4174
+		$cleaned_values = array();
4175
+		foreach ($values as $value) {
4176
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4177
+		}
4178
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
4179
+	}
4180
+
4181
+
4182
+
4183
+	/**
4184
+	 * Takes an array or a comma-separated list of $values and cleans them
4185
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
4186
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4187
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4188
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4189
+	 *
4190
+	 * @param mixed                      $values    array or comma-separated string
4191
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4192
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4193
+	 * @throws \EE_Error
4194
+	 */
4195
+	public function _construct_in_value($values, $field_obj)
4196
+	{
4197
+		//check if the value is a CSV list
4198
+		if (is_string($values)) {
4199
+			//in which case, turn it into an array
4200
+			$values = explode(",", $values);
4201
+		}
4202
+		$cleaned_values = array();
4203
+		foreach ($values as $value) {
4204
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4205
+		}
4206
+		//we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4207
+		//but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4208
+		//which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4209
+		if (empty($cleaned_values)) {
4210
+			$all_fields = $this->field_settings();
4211
+			$a_field = array_shift($all_fields);
4212
+			$main_table = $this->_get_main_table();
4213
+			$cleaned_values[] = "SELECT "
4214
+								. $a_field->get_table_column()
4215
+								. " FROM "
4216
+								. $main_table->get_table_name()
4217
+								. " WHERE FALSE";
4218
+		}
4219
+		return "(" . implode(",", $cleaned_values) . ")";
4220
+	}
4221
+
4222
+
4223
+
4224
+	/**
4225
+	 * @param mixed                      $value
4226
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4227
+	 * @throws EE_Error
4228
+	 * @return false|null|string
4229
+	 */
4230
+	private function _wpdb_prepare_using_field($value, $field_obj)
4231
+	{
4232
+		/** @type WPDB $wpdb */
4233
+		global $wpdb;
4234
+		if ($field_obj instanceof EE_Model_Field_Base) {
4235
+			return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4236
+				$this->_prepare_value_for_use_in_db($value, $field_obj));
4237
+		} else {//$field_obj should really just be a data type
4238
+			if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4239
+				throw new EE_Error(sprintf(__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4240
+					$field_obj, implode(",", $this->_valid_wpdb_data_types)));
4241
+			}
4242
+			return $wpdb->prepare($field_obj, $value);
4243
+		}
4244
+	}
4245
+
4246
+
4247
+
4248
+	/**
4249
+	 * Takes the input parameter and finds the model field that it indicates.
4250
+	 *
4251
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4252
+	 * @throws EE_Error
4253
+	 * @return EE_Model_Field_Base
4254
+	 */
4255
+	protected function _deduce_field_from_query_param($query_param_name)
4256
+	{
4257
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
4258
+		//which will help us find the database table and column
4259
+		$query_param_parts = explode(".", $query_param_name);
4260
+		if (empty($query_param_parts)) {
4261
+			throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4262
+				'event_espresso'), $query_param_name));
4263
+		}
4264
+		$number_of_parts = count($query_param_parts);
4265
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4266
+		if ($number_of_parts === 1) {
4267
+			$field_name = $last_query_param_part;
4268
+			$model_obj = $this;
4269
+		} else {// $number_of_parts >= 2
4270
+			//the last part is the column name, and there are only 2parts. therefore...
4271
+			$field_name = $last_query_param_part;
4272
+			$model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4273
+		}
4274
+		try {
4275
+			return $model_obj->field_settings_for($field_name);
4276
+		} catch (EE_Error $e) {
4277
+			return null;
4278
+		}
4279
+	}
4280
+
4281
+
4282
+
4283
+	/**
4284
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4285
+	 * alias and column which corresponds to it
4286
+	 *
4287
+	 * @param string $field_name
4288
+	 * @throws EE_Error
4289
+	 * @return string
4290
+	 */
4291
+	public function _get_qualified_column_for_field($field_name)
4292
+	{
4293
+		$all_fields = $this->field_settings();
4294
+		$field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4295
+		if ($field) {
4296
+			return $field->get_qualified_column();
4297
+		} else {
4298
+			throw new EE_Error(sprintf(__("There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
4299
+				'event_espresso'), $field_name, get_class($this)));
4300
+		}
4301
+	}
4302
+
4303
+
4304
+
4305
+	/**
4306
+	 * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4307
+	 * Example usage:
4308
+	 * EEM_Ticket::instance()->get_all_wpdb_results(
4309
+	 *      array(),
4310
+	 *      ARRAY_A,
4311
+	 *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4312
+	 *  );
4313
+	 * is equivalent to
4314
+	 *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4315
+	 * and
4316
+	 *  EEM_Event::instance()->get_all_wpdb_results(
4317
+	 *      array(
4318
+	 *          array(
4319
+	 *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4320
+	 *          ),
4321
+	 *          ARRAY_A,
4322
+	 *          implode(
4323
+	 *              ', ',
4324
+	 *              array_merge(
4325
+	 *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4326
+	 *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4327
+	 *              )
4328
+	 *          )
4329
+	 *      )
4330
+	 *  );
4331
+	 * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4332
+	 *
4333
+	 * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4334
+	 *                                            and the one whose fields you are selecting for example: when querying
4335
+	 *                                            tickets model and selecting fields from the tickets model you would
4336
+	 *                                            leave this parameter empty, because no models are needed to join
4337
+	 *                                            between the queried model and the selected one. Likewise when
4338
+	 *                                            querying the datetime model and selecting fields from the tickets
4339
+	 *                                            model, it would also be left empty, because there is a direct
4340
+	 *                                            relation from datetimes to tickets, so no model is needed to join
4341
+	 *                                            them together. However, when querying from the event model and
4342
+	 *                                            selecting fields from the ticket model, you should provide the string
4343
+	 *                                            'Datetime', indicating that the event model must first join to the
4344
+	 *                                            datetime model in order to find its relation to ticket model.
4345
+	 *                                            Also, when querying from the venue model and selecting fields from
4346
+	 *                                            the ticket model, you should provide the string 'Event.Datetime',
4347
+	 *                                            indicating you need to join the venue model to the event model,
4348
+	 *                                            to the datetime model, in order to find its relation to the ticket model.
4349
+	 *                                            This string is used to deduce the prefix that gets added onto the
4350
+	 *                                            models' tables qualified columns
4351
+	 * @param bool   $return_string               if true, will return a string with qualified column names separated
4352
+	 *                                            by ', ' if false, will simply return a numerically indexed array of
4353
+	 *                                            qualified column names
4354
+	 * @return array|string
4355
+	 */
4356
+	public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4357
+	{
4358
+		$table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4359
+		$qualified_columns = array();
4360
+		foreach ($this->field_settings() as $field_name => $field) {
4361
+			$qualified_columns[] = $table_prefix . $field->get_qualified_column();
4362
+		}
4363
+		return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4364
+	}
4365
+
4366
+
4367
+
4368
+	/**
4369
+	 * constructs the select use on special limit joins
4370
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4371
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
4372
+	 * (as that is typically where the limits would be set).
4373
+	 *
4374
+	 * @param  string       $table_alias The table the select is being built for
4375
+	 * @param  mixed|string $limit       The limit for this select
4376
+	 * @return string                The final select join element for the query.
4377
+	 */
4378
+	public function _construct_limit_join_select($table_alias, $limit)
4379
+	{
4380
+		$SQL = '';
4381
+		foreach ($this->_tables as $table_obj) {
4382
+			if ($table_obj instanceof EE_Primary_Table) {
4383
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4384
+					? $table_obj->get_select_join_limit($limit)
4385
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4386
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
4387
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4388
+					? $table_obj->get_select_join_limit_join($limit)
4389
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
4390
+			}
4391
+		}
4392
+		return $SQL;
4393
+	}
4394
+
4395
+
4396
+
4397
+	/**
4398
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4399
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4400
+	 *
4401
+	 * @return string SQL
4402
+	 * @throws \EE_Error
4403
+	 */
4404
+	public function _construct_internal_join()
4405
+	{
4406
+		$SQL = $this->_get_main_table()->get_table_sql();
4407
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4408
+		return $SQL;
4409
+	}
4410
+
4411
+
4412
+
4413
+	/**
4414
+	 * Constructs the SQL for joining all the tables on this model.
4415
+	 * Normally $alias should be the primary table's alias, but in cases where
4416
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4417
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4418
+	 * alias, this will construct SQL like:
4419
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4420
+	 * With $alias being a secondary table's alias, this will construct SQL like:
4421
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4422
+	 *
4423
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4424
+	 * @return string
4425
+	 */
4426
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4427
+	{
4428
+		$SQL = '';
4429
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4430
+		foreach ($this->_tables as $table_obj) {
4431
+			if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4432
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4433
+					//so we're joining to this table, meaning the table is already in
4434
+					//the FROM statement, BUT the primary table isn't. So we want
4435
+					//to add the inverse join sql
4436
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4437
+				} else {
4438
+					//just add a regular JOIN to this table from the primary table
4439
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
4440
+				}
4441
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4442
+		}
4443
+		return $SQL;
4444
+	}
4445
+
4446
+
4447
+
4448
+	/**
4449
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
4450
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4451
+	 * their data type (eg, '%s', '%d', etc)
4452
+	 *
4453
+	 * @return array
4454
+	 */
4455
+	public function _get_data_types()
4456
+	{
4457
+		$data_types = array();
4458
+		foreach ($this->field_settings() as $field_obj) {
4459
+			//$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4460
+			/** @var $field_obj EE_Model_Field_Base */
4461
+			$data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4462
+		}
4463
+		return $data_types;
4464
+	}
4465
+
4466
+
4467
+
4468
+	/**
4469
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4470
+	 *
4471
+	 * @param string $model_name
4472
+	 * @throws EE_Error
4473
+	 * @return EEM_Base
4474
+	 */
4475
+	public function get_related_model_obj($model_name)
4476
+	{
4477
+		$model_classname = "EEM_" . $model_name;
4478
+		if (! class_exists($model_classname)) {
4479
+			throw new EE_Error(sprintf(__("You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
4480
+				'event_espresso'), $model_name, $model_classname));
4481
+		}
4482
+		return call_user_func($model_classname . "::instance");
4483
+	}
4484
+
4485
+
4486
+
4487
+	/**
4488
+	 * Returns the array of EE_ModelRelations for this model.
4489
+	 *
4490
+	 * @return EE_Model_Relation_Base[]
4491
+	 */
4492
+	public function relation_settings()
4493
+	{
4494
+		return $this->_model_relations;
4495
+	}
4496
+
4497
+
4498
+
4499
+	/**
4500
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
4501
+	 * because without THOSE models, this model probably doesn't have much purpose.
4502
+	 * (Eg, without an event, datetimes have little purpose.)
4503
+	 *
4504
+	 * @return EE_Belongs_To_Relation[]
4505
+	 */
4506
+	public function belongs_to_relations()
4507
+	{
4508
+		$belongs_to_relations = array();
4509
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
4510
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
4511
+				$belongs_to_relations[$model_name] = $relation_obj;
4512
+			}
4513
+		}
4514
+		return $belongs_to_relations;
4515
+	}
4516
+
4517
+
4518
+
4519
+	/**
4520
+	 * Returns the specified EE_Model_Relation, or throws an exception
4521
+	 *
4522
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
4523
+	 * @throws EE_Error
4524
+	 * @return EE_Model_Relation_Base
4525
+	 */
4526
+	public function related_settings_for($relation_name)
4527
+	{
4528
+		$relatedModels = $this->relation_settings();
4529
+		if (! array_key_exists($relation_name, $relatedModels)) {
4530
+			throw new EE_Error(
4531
+				sprintf(
4532
+					__('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4533
+						'event_espresso'),
4534
+					$relation_name,
4535
+					$this->_get_class_name(),
4536
+					implode(', ', array_keys($relatedModels))
4537
+				)
4538
+			);
4539
+		}
4540
+		return $relatedModels[$relation_name];
4541
+	}
4542
+
4543
+
4544
+
4545
+	/**
4546
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4547
+	 * fields
4548
+	 *
4549
+	 * @param string $fieldName
4550
+	 * @throws EE_Error
4551
+	 * @return EE_Model_Field_Base
4552
+	 */
4553
+	public function field_settings_for($fieldName)
4554
+	{
4555
+		$fieldSettings = $this->field_settings(true);
4556
+		if (! array_key_exists($fieldName, $fieldSettings)) {
4557
+			throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4558
+				get_class($this)));
4559
+		}
4560
+		return $fieldSettings[$fieldName];
4561
+	}
4562
+
4563
+
4564
+
4565
+	/**
4566
+	 * Checks if this field exists on this model
4567
+	 *
4568
+	 * @param string $fieldName a key in the model's _field_settings array
4569
+	 * @return boolean
4570
+	 */
4571
+	public function has_field($fieldName)
4572
+	{
4573
+		$fieldSettings = $this->field_settings(true);
4574
+		if (isset($fieldSettings[$fieldName])) {
4575
+			return true;
4576
+		} else {
4577
+			return false;
4578
+		}
4579
+	}
4580
+
4581
+
4582
+
4583
+	/**
4584
+	 * Returns whether or not this model has a relation to the specified model
4585
+	 *
4586
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
4587
+	 * @return boolean
4588
+	 */
4589
+	public function has_relation($relation_name)
4590
+	{
4591
+		$relations = $this->relation_settings();
4592
+		if (isset($relations[$relation_name])) {
4593
+			return true;
4594
+		} else {
4595
+			return false;
4596
+		}
4597
+	}
4598
+
4599
+
4600
+
4601
+	/**
4602
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4603
+	 * Eg, on EE_Answer that would be ANS_ID field object
4604
+	 *
4605
+	 * @param $field_obj
4606
+	 * @return boolean
4607
+	 */
4608
+	public function is_primary_key_field($field_obj)
4609
+	{
4610
+		return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4611
+	}
4612
+
4613
+
4614
+
4615
+	/**
4616
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4617
+	 * Eg, on EE_Answer that would be ANS_ID field object
4618
+	 *
4619
+	 * @return EE_Model_Field_Base
4620
+	 * @throws EE_Error
4621
+	 */
4622
+	public function get_primary_key_field()
4623
+	{
4624
+		if ($this->_primary_key_field === null) {
4625
+			foreach ($this->field_settings(true) as $field_obj) {
4626
+				if ($this->is_primary_key_field($field_obj)) {
4627
+					$this->_primary_key_field = $field_obj;
4628
+					break;
4629
+				}
4630
+			}
4631
+			if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4632
+				throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4633
+					get_class($this)));
4634
+			}
4635
+		}
4636
+		return $this->_primary_key_field;
4637
+	}
4638
+
4639
+
4640
+
4641
+	/**
4642
+	 * Returns whether or not not there is a primary key on this model.
4643
+	 * Internally does some caching.
4644
+	 *
4645
+	 * @return boolean
4646
+	 */
4647
+	public function has_primary_key_field()
4648
+	{
4649
+		if ($this->_has_primary_key_field === null) {
4650
+			try {
4651
+				$this->get_primary_key_field();
4652
+				$this->_has_primary_key_field = true;
4653
+			} catch (EE_Error $e) {
4654
+				$this->_has_primary_key_field = false;
4655
+			}
4656
+		}
4657
+		return $this->_has_primary_key_field;
4658
+	}
4659
+
4660
+
4661
+
4662
+	/**
4663
+	 * Finds the first field of type $field_class_name.
4664
+	 *
4665
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4666
+	 *                                 EE_Foreign_Key_Field, etc
4667
+	 * @return EE_Model_Field_Base or null if none is found
4668
+	 */
4669
+	public function get_a_field_of_type($field_class_name)
4670
+	{
4671
+		foreach ($this->field_settings() as $field) {
4672
+			if ($field instanceof $field_class_name) {
4673
+				return $field;
4674
+			}
4675
+		}
4676
+		return null;
4677
+	}
4678
+
4679
+
4680
+
4681
+	/**
4682
+	 * Gets a foreign key field pointing to model.
4683
+	 *
4684
+	 * @param string $model_name eg Event, Registration, not EEM_Event
4685
+	 * @return EE_Foreign_Key_Field_Base
4686
+	 * @throws EE_Error
4687
+	 */
4688
+	public function get_foreign_key_to($model_name)
4689
+	{
4690
+		if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4691
+			foreach ($this->field_settings() as $field) {
4692
+				if (
4693
+					$field instanceof EE_Foreign_Key_Field_Base
4694
+					&& in_array($model_name, $field->get_model_names_pointed_to())
4695
+				) {
4696
+					$this->_cache_foreign_key_to_fields[$model_name] = $field;
4697
+					break;
4698
+				}
4699
+			}
4700
+			if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4701
+				throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4702
+					'event_espresso'), $model_name, get_class($this)));
4703
+			}
4704
+		}
4705
+		return $this->_cache_foreign_key_to_fields[$model_name];
4706
+	}
4707
+
4708
+
4709
+
4710
+	/**
4711
+	 * Gets the actual table for the table alias
4712
+	 *
4713
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4714
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4715
+	 *                            Either one works
4716
+	 * @return EE_Table_Base
4717
+	 */
4718
+	public function get_table_for_alias($table_alias)
4719
+	{
4720
+		$table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4721
+		return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4722
+	}
4723
+
4724
+
4725
+
4726
+	/**
4727
+	 * Returns a flat array of all field son this model, instead of organizing them
4728
+	 * by table_alias as they are in the constructor.
4729
+	 *
4730
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4731
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
4732
+	 */
4733
+	public function field_settings($include_db_only_fields = false)
4734
+	{
4735
+		if ($include_db_only_fields) {
4736
+			if ($this->_cached_fields === null) {
4737
+				$this->_cached_fields = array();
4738
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4739
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4740
+						$this->_cached_fields[$field_name] = $field_obj;
4741
+					}
4742
+				}
4743
+			}
4744
+			return $this->_cached_fields;
4745
+		} else {
4746
+			if ($this->_cached_fields_non_db_only === null) {
4747
+				$this->_cached_fields_non_db_only = array();
4748
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4749
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4750
+						/** @var $field_obj EE_Model_Field_Base */
4751
+						if (! $field_obj->is_db_only_field()) {
4752
+							$this->_cached_fields_non_db_only[$field_name] = $field_obj;
4753
+						}
4754
+					}
4755
+				}
4756
+			}
4757
+			return $this->_cached_fields_non_db_only;
4758
+		}
4759
+	}
4760
+
4761
+
4762
+
4763
+	/**
4764
+	 *        cycle though array of attendees and create objects out of each item
4765
+	 *
4766
+	 * @access        private
4767
+	 * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4768
+	 * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4769
+	 *                           numerically indexed)
4770
+	 * @throws \EE_Error
4771
+	 */
4772
+	protected function _create_objects($rows = array())
4773
+	{
4774
+		$array_of_objects = array();
4775
+		if (empty($rows)) {
4776
+			return array();
4777
+		}
4778
+		$count_if_model_has_no_primary_key = 0;
4779
+		$has_primary_key = $this->has_primary_key_field();
4780
+		$primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4781
+		foreach ((array)$rows as $row) {
4782
+			if (empty($row)) {
4783
+				//wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4784
+				return array();
4785
+			}
4786
+			//check if we've already set this object in the results array,
4787
+			//in which case there's no need to process it further (again)
4788
+			if ($has_primary_key) {
4789
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4790
+					$row,
4791
+					$primary_key_field->get_qualified_column(),
4792
+					$primary_key_field->get_table_column()
4793
+				);
4794
+				if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4795
+					continue;
4796
+				}
4797
+			}
4798
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
4799
+			if (! $classInstance) {
4800
+				throw new EE_Error(
4801
+					sprintf(
4802
+						__('Could not create instance of class %s from row %s', 'event_espresso'),
4803
+						$this->get_this_model_name(),
4804
+						http_build_query($row)
4805
+					)
4806
+				);
4807
+			}
4808
+			//set the timezone on the instantiated objects
4809
+			$classInstance->set_timezone($this->_timezone);
4810
+			//make sure if there is any timezone setting present that we set the timezone for the object
4811
+			$key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4812
+			$array_of_objects[$key] = $classInstance;
4813
+			//also, for all the relations of type BelongsTo, see if we can cache
4814
+			//those related models
4815
+			//(we could do this for other relations too, but if there are conditions
4816
+			//that filtered out some fo the results, then we'd be caching an incomplete set
4817
+			//so it requires a little more thought than just caching them immediately...)
4818
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
4819
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
4820
+					//check if this model's INFO is present. If so, cache it on the model
4821
+					$other_model = $relation_obj->get_other_model();
4822
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4823
+					//if we managed to make a model object from the results, cache it on the main model object
4824
+					if ($other_model_obj_maybe) {
4825
+						//set timezone on these other model objects if they are present
4826
+						$other_model_obj_maybe->set_timezone($this->_timezone);
4827
+						$classInstance->cache($modelName, $other_model_obj_maybe);
4828
+					}
4829
+				}
4830
+			}
4831
+		}
4832
+		return $array_of_objects;
4833
+	}
4834
+
4835
+
4836
+
4837
+	/**
4838
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4839
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4840
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4841
+	 * object (as set in the model_field!).
4842
+	 *
4843
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4844
+	 */
4845
+	public function create_default_object()
4846
+	{
4847
+		$this_model_fields_and_values = array();
4848
+		//setup the row using default values;
4849
+		foreach ($this->field_settings() as $field_name => $field_obj) {
4850
+			$this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4851
+		}
4852
+		$className = $this->_get_class_name();
4853
+		$classInstance = EE_Registry::instance()
4854
+									->load_class($className, array($this_model_fields_and_values), false, false);
4855
+		return $classInstance;
4856
+	}
4857
+
4858
+
4859
+
4860
+	/**
4861
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4862
+	 *                             or an stdClass where each property is the name of a column,
4863
+	 * @return EE_Base_Class
4864
+	 * @throws \EE_Error
4865
+	 */
4866
+	public function instantiate_class_from_array_or_object($cols_n_values)
4867
+	{
4868
+		if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4869
+			$cols_n_values = get_object_vars($cols_n_values);
4870
+		}
4871
+		$primary_key = null;
4872
+		//make sure the array only has keys that are fields/columns on this model
4873
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4874
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
4875
+			$primary_key = $this_model_fields_n_values[$this->primary_key_name()];
4876
+		}
4877
+		$className = $this->_get_class_name();
4878
+		//check we actually found results that we can use to build our model object
4879
+		//if not, return null
4880
+		if ($this->has_primary_key_field()) {
4881
+			if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
4882
+				return null;
4883
+			}
4884
+		} else if ($this->unique_indexes()) {
4885
+			$first_column = reset($this_model_fields_n_values);
4886
+			if (empty($first_column)) {
4887
+				return null;
4888
+			}
4889
+		}
4890
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
4891
+		if ($primary_key) {
4892
+			$classInstance = $this->get_from_entity_map($primary_key);
4893
+			if (! $classInstance) {
4894
+				$classInstance = EE_Registry::instance()
4895
+											->load_class($className,
4896
+												array($this_model_fields_n_values, $this->_timezone), true, false);
4897
+				// add this new object to the entity map
4898
+				$classInstance = $this->add_to_entity_map($classInstance);
4899
+			}
4900
+		} else {
4901
+			$classInstance = EE_Registry::instance()
4902
+										->load_class($className, array($this_model_fields_n_values, $this->_timezone),
4903
+											true, false);
4904
+		}
4905
+		//it is entirely possible that the instantiated class object has a set timezone_string db field and has set it's internal _timezone property accordingly (see new_instance_from_db in model objects particularly EE_Event for example).  In this case, we want to make sure the model object doesn't have its timezone string overwritten by any timezone property currently set here on the model so, we intentionally override the model _timezone property with the model_object timezone property.
4906
+		$this->set_timezone($classInstance->get_timezone());
4907
+		return $classInstance;
4908
+	}
4909
+
4910
+
4911
+
4912
+	/**
4913
+	 * Gets the model object from the  entity map if it exists
4914
+	 *
4915
+	 * @param int|string $id the ID of the model object
4916
+	 * @return EE_Base_Class
4917
+	 */
4918
+	public function get_from_entity_map($id)
4919
+	{
4920
+		return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
4921
+			? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
4922
+	}
4923
+
4924
+
4925
+
4926
+	/**
4927
+	 * add_to_entity_map
4928
+	 * Adds the object to the model's entity mappings
4929
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
4930
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
4931
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
4932
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
4933
+	 *        then this method should be called immediately after the update query
4934
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
4935
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
4936
+	 *
4937
+	 * @param    EE_Base_Class $object
4938
+	 * @throws EE_Error
4939
+	 * @return \EE_Base_Class
4940
+	 */
4941
+	public function add_to_entity_map(EE_Base_Class $object)
4942
+	{
4943
+		$className = $this->_get_class_name();
4944
+		if (! $object instanceof $className) {
4945
+			throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
4946
+				is_object($object) ? get_class($object) : $object, $className));
4947
+		}
4948
+		/** @var $object EE_Base_Class */
4949
+		if (! $object->ID()) {
4950
+			throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
4951
+				"event_espresso"), get_class($this)));
4952
+		}
4953
+		// double check it's not already there
4954
+		$classInstance = $this->get_from_entity_map($object->ID());
4955
+		if ($classInstance) {
4956
+			return $classInstance;
4957
+		} else {
4958
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
4959
+			return $object;
4960
+		}
4961
+	}
4962
+
4963
+
4964
+
4965
+	/**
4966
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
4967
+	 * if no identifier is provided, then the entire entity map is emptied
4968
+	 *
4969
+	 * @param int|string $id the ID of the model object
4970
+	 * @return boolean
4971
+	 */
4972
+	public function clear_entity_map($id = null)
4973
+	{
4974
+		if (empty($id)) {
4975
+			$this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
4976
+			return true;
4977
+		}
4978
+		if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
4979
+			unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
4980
+			return true;
4981
+		}
4982
+		return false;
4983
+	}
4984
+
4985
+
4986
+
4987
+	/**
4988
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
4989
+	 * Given an array where keys are column (or column alias) names and values,
4990
+	 * returns an array of their corresponding field names and database values
4991
+	 *
4992
+	 * @param array $cols_n_values
4993
+	 * @return array
4994
+	 */
4995
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
4996
+	{
4997
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
4998
+	}
4999
+
5000
+
5001
+
5002
+	/**
5003
+	 * _deduce_fields_n_values_from_cols_n_values
5004
+	 * Given an array where keys are column (or column alias) names and values,
5005
+	 * returns an array of their corresponding field names and database values
5006
+	 *
5007
+	 * @param string $cols_n_values
5008
+	 * @return array
5009
+	 */
5010
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5011
+	{
5012
+		$this_model_fields_n_values = array();
5013
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
5014
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5015
+				$table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5016
+			//there is a primary key on this table and its not set. Use defaults for all its columns
5017
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
5018
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5019
+					if (! $field_obj->is_db_only_field()) {
5020
+						//prepare field as if its coming from db
5021
+						$prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5022
+						$this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5023
+					}
5024
+				}
5025
+			} else {
5026
+				//the table's rows existed. Use their values
5027
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5028
+					if (! $field_obj->is_db_only_field()) {
5029
+						$this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5030
+							$cols_n_values, $field_obj->get_qualified_column(),
5031
+							$field_obj->get_table_column()
5032
+						);
5033
+					}
5034
+				}
5035
+			}
5036
+		}
5037
+		return $this_model_fields_n_values;
5038
+	}
5039
+
5040
+
5041
+
5042
+	/**
5043
+	 * @param $cols_n_values
5044
+	 * @param $qualified_column
5045
+	 * @param $regular_column
5046
+	 * @return null
5047
+	 */
5048
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5049
+	{
5050
+		$value = null;
5051
+		//ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5052
+		//does the field on the model relate to this column retrieved from the db?
5053
+		//or is it a db-only field? (not relating to the model)
5054
+		if (isset($cols_n_values[$qualified_column])) {
5055
+			$value = $cols_n_values[$qualified_column];
5056
+		} elseif (isset($cols_n_values[$regular_column])) {
5057
+			$value = $cols_n_values[$regular_column];
5058
+		}
5059
+		return $value;
5060
+	}
5061
+
5062
+
5063
+
5064
+	/**
5065
+	 * refresh_entity_map_from_db
5066
+	 * Makes sure the model object in the entity map at $id assumes the values
5067
+	 * of the database (opposite of EE_base_Class::save())
5068
+	 *
5069
+	 * @param int|string $id
5070
+	 * @return EE_Base_Class
5071
+	 * @throws \EE_Error
5072
+	 */
5073
+	public function refresh_entity_map_from_db($id)
5074
+	{
5075
+		$obj_in_map = $this->get_from_entity_map($id);
5076
+		if ($obj_in_map) {
5077
+			$wpdb_results = $this->_get_all_wpdb_results(
5078
+				array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5079
+			);
5080
+			if ($wpdb_results && is_array($wpdb_results)) {
5081
+				$one_row = reset($wpdb_results);
5082
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5083
+					$obj_in_map->set_from_db($field_name, $db_value);
5084
+				}
5085
+				//clear the cache of related model objects
5086
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5087
+					$obj_in_map->clear_cache($relation_name, null, true);
5088
+				}
5089
+			}
5090
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5091
+			return $obj_in_map;
5092
+		} else {
5093
+			return $this->get_one_by_ID($id);
5094
+		}
5095
+	}
5096
+
5097
+
5098
+
5099
+	/**
5100
+	 * refresh_entity_map_with
5101
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
5102
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5103
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5104
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5105
+	 *
5106
+	 * @param int|string    $id
5107
+	 * @param EE_Base_Class $replacing_model_obj
5108
+	 * @return \EE_Base_Class
5109
+	 * @throws \EE_Error
5110
+	 */
5111
+	public function refresh_entity_map_with($id, $replacing_model_obj)
5112
+	{
5113
+		$obj_in_map = $this->get_from_entity_map($id);
5114
+		if ($obj_in_map) {
5115
+			if ($replacing_model_obj instanceof EE_Base_Class) {
5116
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5117
+					$obj_in_map->set($field_name, $value);
5118
+				}
5119
+				//make the model object in the entity map's cache match the $replacing_model_obj
5120
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5121
+					$obj_in_map->clear_cache($relation_name, null, true);
5122
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5123
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5124
+					}
5125
+				}
5126
+			}
5127
+			return $obj_in_map;
5128
+		} else {
5129
+			$this->add_to_entity_map($replacing_model_obj);
5130
+			return $replacing_model_obj;
5131
+		}
5132
+	}
5133
+
5134
+
5135
+
5136
+	/**
5137
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5138
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5139
+	 * require_once($this->_getClassName().".class.php");
5140
+	 *
5141
+	 * @return string
5142
+	 */
5143
+	private function _get_class_name()
5144
+	{
5145
+		return "EE_" . $this->get_this_model_name();
5146
+	}
5147
+
5148
+
5149
+
5150
+	/**
5151
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
5152
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5153
+	 * it would be 'Events'.
5154
+	 *
5155
+	 * @param int $quantity
5156
+	 * @return string
5157
+	 */
5158
+	public function item_name($quantity = 1)
5159
+	{
5160
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5161
+	}
5162
+
5163
+
5164
+
5165
+	/**
5166
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5167
+	 * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5168
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5169
+	 * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5170
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5171
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5172
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
5173
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
5174
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5175
+	 * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5176
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5177
+	 *        return $previousReturnValue.$returnString;
5178
+	 * }
5179
+	 * require('EEM_Answer.model.php');
5180
+	 * $answer=EEM_Answer::instance();
5181
+	 * echo $answer->my_callback('monkeys',100);
5182
+	 * //will output "you called my_callback! and passed args:monkeys,100"
5183
+	 *
5184
+	 * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5185
+	 * @param array  $args       array of original arguments passed to the function
5186
+	 * @throws EE_Error
5187
+	 * @return mixed whatever the plugin which calls add_filter decides
5188
+	 */
5189
+	public function __call($methodName, $args)
5190
+	{
5191
+		$className = get_class($this);
5192
+		$tagName = "FHEE__{$className}__{$methodName}";
5193
+		if (! has_filter($tagName)) {
5194
+			throw new EE_Error(
5195
+				sprintf(
5196
+					__('Method %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
5197
+						'event_espresso'),
5198
+					$methodName,
5199
+					$className,
5200
+					$tagName,
5201
+					'<br />'
5202
+				)
5203
+			);
5204
+		}
5205
+		return apply_filters($tagName, null, $this, $args);
5206
+	}
5207
+
5208
+
5209
+
5210
+	/**
5211
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5212
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5213
+	 *
5214
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5215
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
5216
+	 *                                                       the object's class name
5217
+	 *                                                       or object's ID
5218
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5219
+	 *                                                       exists in the database. If it does not, we add it
5220
+	 * @throws EE_Error
5221
+	 * @return EE_Base_Class
5222
+	 */
5223
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5224
+	{
5225
+		$className = $this->_get_class_name();
5226
+		if ($base_class_obj_or_id instanceof $className) {
5227
+			$model_object = $base_class_obj_or_id;
5228
+		} else {
5229
+			$primary_key_field = $this->get_primary_key_field();
5230
+			if (
5231
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
5232
+				&& (
5233
+					is_int($base_class_obj_or_id)
5234
+					|| is_string($base_class_obj_or_id)
5235
+				)
5236
+			) {
5237
+				// assume it's an ID.
5238
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
5239
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5240
+			} else if (
5241
+				$primary_key_field instanceof EE_Primary_Key_String_Field
5242
+				&& is_string($base_class_obj_or_id)
5243
+			) {
5244
+				// assume its a string representation of the object
5245
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5246
+			} else {
5247
+				throw new EE_Error(
5248
+					sprintf(
5249
+						__(
5250
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5251
+							'event_espresso'
5252
+						),
5253
+						$base_class_obj_or_id,
5254
+						$this->_get_class_name(),
5255
+						print_r($base_class_obj_or_id, true)
5256
+					)
5257
+				);
5258
+			}
5259
+		}
5260
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
5261
+			$model_object->save();
5262
+		}
5263
+		return $model_object;
5264
+	}
5265
+
5266
+
5267
+
5268
+	/**
5269
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5270
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
5271
+	 * returns it ID.
5272
+	 *
5273
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
5274
+	 * @return int|string depending on the type of this model object's ID
5275
+	 * @throws EE_Error
5276
+	 */
5277
+	public function ensure_is_ID($base_class_obj_or_id)
5278
+	{
5279
+		$className = $this->_get_class_name();
5280
+		if ($base_class_obj_or_id instanceof $className) {
5281
+			/** @var $base_class_obj_or_id EE_Base_Class */
5282
+			$id = $base_class_obj_or_id->ID();
5283
+		} elseif (is_int($base_class_obj_or_id)) {
5284
+			//assume it's an ID
5285
+			$id = $base_class_obj_or_id;
5286
+		} elseif (is_string($base_class_obj_or_id)) {
5287
+			//assume its a string representation of the object
5288
+			$id = $base_class_obj_or_id;
5289
+		} else {
5290
+			throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5291
+				'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5292
+				print_r($base_class_obj_or_id, true)));
5293
+		}
5294
+		return $id;
5295
+	}
5296
+
5297
+
5298
+
5299
+	/**
5300
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5301
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5302
+	 * been sanitized and converted into the appropriate domain.
5303
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5304
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5305
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5306
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5307
+	 * $EVT = EEM_Event::instance(); $old_setting =
5308
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5309
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
5310
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5311
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5312
+	 *
5313
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
5314
+	 * @return void
5315
+	 */
5316
+	public function assume_values_already_prepared_by_model_object(
5317
+		$values_already_prepared = self::not_prepared_by_model_object
5318
+	) {
5319
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
5320
+	}
5321
+
5322
+
5323
+
5324
+	/**
5325
+	 * Read comments for assume_values_already_prepared_by_model_object()
5326
+	 *
5327
+	 * @return int
5328
+	 */
5329
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
5330
+	{
5331
+		return $this->_values_already_prepared_by_model_object;
5332
+	}
5333
+
5334
+
5335
+
5336
+	/**
5337
+	 * Gets all the indexes on this model
5338
+	 *
5339
+	 * @return EE_Index[]
5340
+	 */
5341
+	public function indexes()
5342
+	{
5343
+		return $this->_indexes;
5344
+	}
5345
+
5346
+
5347
+
5348
+	/**
5349
+	 * Gets all the Unique Indexes on this model
5350
+	 *
5351
+	 * @return EE_Unique_Index[]
5352
+	 */
5353
+	public function unique_indexes()
5354
+	{
5355
+		$unique_indexes = array();
5356
+		foreach ($this->_indexes as $name => $index) {
5357
+			if ($index instanceof EE_Unique_Index) {
5358
+				$unique_indexes [$name] = $index;
5359
+			}
5360
+		}
5361
+		return $unique_indexes;
5362
+	}
5363
+
5364
+
5365
+
5366
+	/**
5367
+	 * Gets all the fields which, when combined, make the primary key.
5368
+	 * This is usually just an array with 1 element (the primary key), but in cases
5369
+	 * where there is no primary key, it's a combination of fields as defined
5370
+	 * on a primary index
5371
+	 *
5372
+	 * @return EE_Model_Field_Base[] indexed by the field's name
5373
+	 * @throws \EE_Error
5374
+	 */
5375
+	public function get_combined_primary_key_fields()
5376
+	{
5377
+		foreach ($this->indexes() as $index) {
5378
+			if ($index instanceof EE_Primary_Key_Index) {
5379
+				return $index->fields();
5380
+			}
5381
+		}
5382
+		return array($this->primary_key_name() => $this->get_primary_key_field());
5383
+	}
5384
+
5385
+
5386
+
5387
+	/**
5388
+	 * Used to build a primary key string (when the model has no primary key),
5389
+	 * which can be used a unique string to identify this model object.
5390
+	 *
5391
+	 * @param array $cols_n_values keys are field names, values are their values
5392
+	 * @return string
5393
+	 * @throws \EE_Error
5394
+	 */
5395
+	public function get_index_primary_key_string($cols_n_values)
5396
+	{
5397
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5398
+			$this->get_combined_primary_key_fields());
5399
+		return http_build_query($cols_n_values_for_primary_key_index);
5400
+	}
5401
+
5402
+
5403
+
5404
+	/**
5405
+	 * Gets the field values from the primary key string
5406
+	 *
5407
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5408
+	 * @param string $index_primary_key_string
5409
+	 * @return null|array
5410
+	 * @throws \EE_Error
5411
+	 */
5412
+	public function parse_index_primary_key_string($index_primary_key_string)
5413
+	{
5414
+		$key_fields = $this->get_combined_primary_key_fields();
5415
+		//check all of them are in the $id
5416
+		$key_vals_in_combined_pk = array();
5417
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5418
+		foreach ($key_fields as $key_field_name => $field_obj) {
5419
+			if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5420
+				return null;
5421
+			}
5422
+		}
5423
+		return $key_vals_in_combined_pk;
5424
+	}
5425
+
5426
+
5427
+
5428
+	/**
5429
+	 * verifies that an array of key-value pairs for model fields has a key
5430
+	 * for each field comprising the primary key index
5431
+	 *
5432
+	 * @param array $key_vals
5433
+	 * @return boolean
5434
+	 * @throws \EE_Error
5435
+	 */
5436
+	public function has_all_combined_primary_key_fields($key_vals)
5437
+	{
5438
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5439
+		foreach ($keys_it_should_have as $key) {
5440
+			if (! isset($key_vals[$key])) {
5441
+				return false;
5442
+			}
5443
+		}
5444
+		return true;
5445
+	}
5446
+
5447
+
5448
+
5449
+	/**
5450
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5451
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
5452
+	 *
5453
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5454
+	 * @param array               $query_params                     like EEM_Base::get_all's query_params.
5455
+	 * @throws EE_Error
5456
+	 * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5457
+	 *                                                              indexed)
5458
+	 */
5459
+	public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5460
+	{
5461
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5462
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
5463
+		} elseif (is_array($model_object_or_attributes_array)) {
5464
+			$attributes_array = $model_object_or_attributes_array;
5465
+		} else {
5466
+			throw new EE_Error(sprintf(__("get_all_copies should be provided with either a model object or an array of field-value-pairs, but was given %s",
5467
+				"event_espresso"), $model_object_or_attributes_array));
5468
+		}
5469
+		//even copies obviously won't have the same ID, so remove the primary key
5470
+		//from the WHERE conditions for finding copies (if there is a primary key, of course)
5471
+		if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5472
+			unset($attributes_array[$this->primary_key_name()]);
5473
+		}
5474
+		if (isset($query_params[0])) {
5475
+			$query_params[0] = array_merge($attributes_array, $query_params);
5476
+		} else {
5477
+			$query_params[0] = $attributes_array;
5478
+		}
5479
+		return $this->get_all($query_params);
5480
+	}
5481
+
5482
+
5483
+
5484
+	/**
5485
+	 * Gets the first copy we find. See get_all_copies for more details
5486
+	 *
5487
+	 * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5488
+	 * @param array $query_params
5489
+	 * @return EE_Base_Class
5490
+	 * @throws \EE_Error
5491
+	 */
5492
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5493
+	{
5494
+		if (! is_array($query_params)) {
5495
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5496
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5497
+					gettype($query_params)), '4.6.0');
5498
+			$query_params = array();
5499
+		}
5500
+		$query_params['limit'] = 1;
5501
+		$copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5502
+		if (is_array($copies)) {
5503
+			return array_shift($copies);
5504
+		} else {
5505
+			return null;
5506
+		}
5507
+	}
5508
+
5509
+
5510
+
5511
+	/**
5512
+	 * Updates the item with the specified id. Ignores default query parameters because
5513
+	 * we have specified the ID, and its assumed we KNOW what we're doing
5514
+	 *
5515
+	 * @param array      $fields_n_values keys are field names, values are their new values
5516
+	 * @param int|string $id              the value of the primary key to update
5517
+	 * @return int number of rows updated
5518
+	 * @throws \EE_Error
5519
+	 */
5520
+	public function update_by_ID($fields_n_values, $id)
5521
+	{
5522
+		$query_params = array(
5523
+			0                          => array($this->get_primary_key_field()->get_name() => $id),
5524
+			'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5525
+		);
5526
+		return $this->update($fields_n_values, $query_params);
5527
+	}
5528
+
5529
+
5530
+
5531
+	/**
5532
+	 * Changes an operator which was supplied to the models into one usable in SQL
5533
+	 *
5534
+	 * @param string $operator_supplied
5535
+	 * @return string an operator which can be used in SQL
5536
+	 * @throws EE_Error
5537
+	 */
5538
+	private function _prepare_operator_for_sql($operator_supplied)
5539
+	{
5540
+		$sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5541
+			: null;
5542
+		if ($sql_operator) {
5543
+			return $sql_operator;
5544
+		} else {
5545
+			throw new EE_Error(sprintf(__("The operator '%s' is not in the list of valid operators: %s",
5546
+				"event_espresso"), $operator_supplied, implode(",", array_keys($this->_valid_operators))));
5547
+		}
5548
+	}
5549
+
5550
+
5551
+
5552
+	/**
5553
+	 * Gets an array where keys are the primary keys and values are their 'names'
5554
+	 * (as determined by the model object's name() function, which is often overridden)
5555
+	 *
5556
+	 * @param array $query_params like get_all's
5557
+	 * @return string[]
5558
+	 * @throws \EE_Error
5559
+	 */
5560
+	public function get_all_names($query_params = array())
5561
+	{
5562
+		$objs = $this->get_all($query_params);
5563
+		$names = array();
5564
+		foreach ($objs as $obj) {
5565
+			$names[$obj->ID()] = $obj->name();
5566
+		}
5567
+		return $names;
5568
+	}
5569
+
5570
+
5571
+
5572
+	/**
5573
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
5574
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5575
+	 * this is duplicated effort and reduces efficiency) you would be better to use
5576
+	 * array_keys() on $model_objects.
5577
+	 *
5578
+	 * @param \EE_Base_Class[] $model_objects
5579
+	 * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5580
+	 *                                               in the returned array
5581
+	 * @return array
5582
+	 * @throws \EE_Error
5583
+	 */
5584
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
5585
+	{
5586
+		if (! $this->has_primary_key_field()) {
5587
+			if (WP_DEBUG) {
5588
+				EE_Error::add_error(
5589
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5590
+					__FILE__,
5591
+					__FUNCTION__,
5592
+					__LINE__
5593
+				);
5594
+			}
5595
+		}
5596
+		$IDs = array();
5597
+		foreach ($model_objects as $model_object) {
5598
+			$id = $model_object->ID();
5599
+			if (! $id) {
5600
+				if ($filter_out_empty_ids) {
5601
+					continue;
5602
+				}
5603
+				if (WP_DEBUG) {
5604
+					EE_Error::add_error(
5605
+						__(
5606
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5607
+							'event_espresso'
5608
+						),
5609
+						__FILE__,
5610
+						__FUNCTION__,
5611
+						__LINE__
5612
+					);
5613
+				}
5614
+			}
5615
+			$IDs[] = $id;
5616
+		}
5617
+		return $IDs;
5618
+	}
5619
+
5620
+
5621
+
5622
+	/**
5623
+	 * Returns the string used in capabilities relating to this model. If there
5624
+	 * are no capabilities that relate to this model returns false
5625
+	 *
5626
+	 * @return string|false
5627
+	 */
5628
+	public function cap_slug()
5629
+	{
5630
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5631
+	}
5632
+
5633
+
5634
+
5635
+	/**
5636
+	 * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5637
+	 * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5638
+	 * only returns the cap restrictions array in that context (ie, the array
5639
+	 * at that key)
5640
+	 *
5641
+	 * @param string $context
5642
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
5643
+	 * @throws \EE_Error
5644
+	 */
5645
+	public function cap_restrictions($context = EEM_Base::caps_read)
5646
+	{
5647
+		EEM_Base::verify_is_valid_cap_context($context);
5648
+		//check if we ought to run the restriction generator first
5649
+		if (
5650
+			isset($this->_cap_restriction_generators[$context])
5651
+			&& $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5652
+			&& ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5653
+		) {
5654
+			$this->_cap_restrictions[$context] = array_merge(
5655
+				$this->_cap_restrictions[$context],
5656
+				$this->_cap_restriction_generators[$context]->generate_restrictions()
5657
+			);
5658
+		}
5659
+		//and make sure we've finalized the construction of each restriction
5660
+		foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5661
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5662
+				$where_conditions_obj->_finalize_construct($this);
5663
+			}
5664
+		}
5665
+		return $this->_cap_restrictions[$context];
5666
+	}
5667
+
5668
+
5669
+
5670
+	/**
5671
+	 * Indicating whether or not this model thinks its a wp core model
5672
+	 *
5673
+	 * @return boolean
5674
+	 */
5675
+	public function is_wp_core_model()
5676
+	{
5677
+		return $this->_wp_core_model;
5678
+	}
5679
+
5680
+
5681
+
5682
+	/**
5683
+	 * Gets all the caps that are missing which impose a restriction on
5684
+	 * queries made in this context
5685
+	 *
5686
+	 * @param string $context one of EEM_Base::caps_ constants
5687
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
5688
+	 * @throws \EE_Error
5689
+	 */
5690
+	public function caps_missing($context = EEM_Base::caps_read)
5691
+	{
5692
+		$missing_caps = array();
5693
+		$cap_restrictions = $this->cap_restrictions($context);
5694
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5695
+			if (! EE_Capabilities::instance()
5696
+								 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5697
+			) {
5698
+				$missing_caps[$cap] = $restriction_if_no_cap;
5699
+			}
5700
+		}
5701
+		return $missing_caps;
5702
+	}
5703
+
5704
+
5705
+
5706
+	/**
5707
+	 * Gets the mapping from capability contexts to action strings used in capability names
5708
+	 *
5709
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5710
+	 * one of 'read', 'edit', or 'delete'
5711
+	 */
5712
+	public function cap_contexts_to_cap_action_map()
5713
+	{
5714
+		return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5715
+			$this);
5716
+	}
5717
+
5718
+
5719
+
5720
+	/**
5721
+	 * Gets the action string for the specified capability context
5722
+	 *
5723
+	 * @param string $context
5724
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5725
+	 * @throws \EE_Error
5726
+	 */
5727
+	public function cap_action_for_context($context)
5728
+	{
5729
+		$mapping = $this->cap_contexts_to_cap_action_map();
5730
+		if (isset($mapping[$context])) {
5731
+			return $mapping[$context];
5732
+		}
5733
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5734
+			return $action;
5735
+		}
5736
+		throw new EE_Error(
5737
+			sprintf(
5738
+				__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5739
+				$context,
5740
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5741
+			)
5742
+		);
5743
+	}
5744
+
5745
+
5746
+
5747
+	/**
5748
+	 * Returns all the capability contexts which are valid when querying models
5749
+	 *
5750
+	 * @return array
5751
+	 */
5752
+	public static function valid_cap_contexts()
5753
+	{
5754
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5755
+			self::caps_read,
5756
+			self::caps_read_admin,
5757
+			self::caps_edit,
5758
+			self::caps_delete,
5759
+		));
5760
+	}
5761
+
5762
+
5763
+
5764
+	/**
5765
+	 * Returns all valid options for 'default_where_conditions'
5766
+	 *
5767
+	 * @return array
5768
+	 */
5769
+	public static function valid_default_where_conditions()
5770
+	{
5771
+		return array(
5772
+			EEM_Base::default_where_conditions_all,
5773
+			EEM_Base::default_where_conditions_this_only,
5774
+			EEM_Base::default_where_conditions_others_only,
5775
+			EEM_Base::default_where_conditions_minimum_all,
5776
+			EEM_Base::default_where_conditions_minimum_others,
5777
+			EEM_Base::default_where_conditions_none
5778
+		);
5779
+	}
5780
+
5781
+	// public static function default_where_conditions_full
5782
+	/**
5783
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5784
+	 *
5785
+	 * @param string $context
5786
+	 * @return bool
5787
+	 * @throws \EE_Error
5788
+	 */
5789
+	static public function verify_is_valid_cap_context($context)
5790
+	{
5791
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
5792
+		if (in_array($context, $valid_cap_contexts)) {
5793
+			return true;
5794
+		} else {
5795
+			throw new EE_Error(
5796
+				sprintf(
5797
+					__('Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5798
+						'event_espresso'),
5799
+					$context,
5800
+					'EEM_Base',
5801
+					implode(',', $valid_cap_contexts)
5802
+				)
5803
+			);
5804
+		}
5805
+	}
5806
+
5807
+
5808
+
5809
+	/**
5810
+	 * Clears all the models field caches. This is only useful when a sub-class
5811
+	 * might have added a field or something and these caches might be invalidated
5812
+	 */
5813
+	protected function _invalidate_field_caches()
5814
+	{
5815
+		$this->_cache_foreign_key_to_fields = array();
5816
+		$this->_cached_fields = null;
5817
+		$this->_cached_fields_non_db_only = null;
5818
+	}
5819
+
5820
+
5821
+
5822
+	/**
5823
+	 * Gets the list of all the where query param keys that relate to logic instead of field names
5824
+	 * (eg "and", "or", "not").
5825
+	 *
5826
+	 * @return array
5827
+	 */
5828
+	public function logic_query_param_keys()
5829
+	{
5830
+		return $this->_logic_query_param_keys;
5831
+	}
5832
+
5833
+
5834
+
5835
+	/**
5836
+	 * Determines whether or not the where query param array key is for a logic query param.
5837
+	 * Eg 'OR', 'not*', and 'and*because-i-say-so' shoudl all return true, whereas
5838
+	 * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
5839
+	 *
5840
+	 * @param $query_param_key
5841
+	 * @return bool
5842
+	 */
5843
+	public function is_logic_query_param_key($query_param_key)
5844
+	{
5845
+		foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
5846
+			if ($query_param_key === $logic_query_param_key
5847
+				|| strpos($query_param_key, $logic_query_param_key . '*') === 0
5848
+			) {
5849
+				return true;
5850
+			}
5851
+		}
5852
+		return false;
5853
+	}
5854 5854
 
5855 5855
 
5856 5856
 
Please login to merge, or discard this patch.
core/wordpress-shims.php 2 patches
Indentation   +40 added lines, -40 removed lines patch added patch discarded remove patch
@@ -5,51 +5,51 @@
 block discarded – undo
5 5
  * it does not override any existing definition of the function in WP.
6 6
  */
7 7
 if ( ! function_exists( 'get_preview_post_link' ) ) {
8
-    /**
9
-     * Function was added in WordPress 4.4.0
10
-     * @param null   $post
11
-     * @param array  $query_args
12
-     * @param string $preview_link
13
-     * @return mixed
14
-     */
15
-    function get_preview_post_link($post = null, $query_args = array(), $preview_link = '')
16
-    {
17
-        $post = get_post($post);
18
-        if (! $post) {
19
-            return '';
20
-        }
8
+	/**
9
+	 * Function was added in WordPress 4.4.0
10
+	 * @param null   $post
11
+	 * @param array  $query_args
12
+	 * @param string $preview_link
13
+	 * @return mixed
14
+	 */
15
+	function get_preview_post_link($post = null, $query_args = array(), $preview_link = '')
16
+	{
17
+		$post = get_post($post);
18
+		if (! $post) {
19
+			return '';
20
+		}
21 21
 
22
-        $post_type_object = get_post_type_object($post->post_type);
23
-        if (is_post_type_viewable($post_type_object)) {
24
-            if (! $preview_link) {
25
-                $preview_link = set_url_scheme(get_permalink($post));
26
-            }
22
+		$post_type_object = get_post_type_object($post->post_type);
23
+		if (is_post_type_viewable($post_type_object)) {
24
+			if (! $preview_link) {
25
+				$preview_link = set_url_scheme(get_permalink($post));
26
+			}
27 27
 
28
-            $query_args['preview'] = 'true';
29
-            $preview_link          = add_query_arg($query_args, $preview_link);
30
-        }
28
+			$query_args['preview'] = 'true';
29
+			$preview_link          = add_query_arg($query_args, $preview_link);
30
+		}
31 31
 
32
-        /**
33
-         * Filters the URL used for a post preview.
34
-         *
35
-         * @since 2.0.5
36
-         * @since 4.0.0 Added the `$post` parameter.
37
-         * @param string  $preview_link URL used for the post preview.
38
-         * @param WP_Post $post         Post object.
39
-         */
40
-        return apply_filters('preview_post_link', $preview_link, $post);
41
-    }
32
+		/**
33
+		 * Filters the URL used for a post preview.
34
+		 *
35
+		 * @since 2.0.5
36
+		 * @since 4.0.0 Added the `$post` parameter.
37
+		 * @param string  $preview_link URL used for the post preview.
38
+		 * @param WP_Post $post         Post object.
39
+		 */
40
+		return apply_filters('preview_post_link', $preview_link, $post);
41
+	}
42 42
 }
43 43
 
44 44
 if ( ! function_exists( 'is_post_type_viewable' ) ) {
45
-    function is_post_type_viewable( $post_type ) {
46
-        if ( is_scalar( $post_type ) ) {
47
-            $post_type = get_post_type_object( $post_type );
48
-            if ( ! $post_type ) {
49
-                return false;
50
-            }
51
-        }
45
+	function is_post_type_viewable( $post_type ) {
46
+		if ( is_scalar( $post_type ) ) {
47
+			$post_type = get_post_type_object( $post_type );
48
+			if ( ! $post_type ) {
49
+				return false;
50
+			}
51
+		}
52 52
      
53
-        return $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
54
-    }
53
+		return $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
54
+	}
55 55
 }
56 56
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -4,7 +4,7 @@  discard block
 block discarded – undo
4 4
  * Note: this file should only be required right before calling the function the shim is for.  This is to ensure that
5 5
  * it does not override any existing definition of the function in WP.
6 6
  */
7
-if ( ! function_exists( 'get_preview_post_link' ) ) {
7
+if ( ! function_exists('get_preview_post_link')) {
8 8
     /**
9 9
      * Function was added in WordPress 4.4.0
10 10
      * @param null   $post
@@ -15,13 +15,13 @@  discard block
 block discarded – undo
15 15
     function get_preview_post_link($post = null, $query_args = array(), $preview_link = '')
16 16
     {
17 17
         $post = get_post($post);
18
-        if (! $post) {
18
+        if ( ! $post) {
19 19
             return '';
20 20
         }
21 21
 
22 22
         $post_type_object = get_post_type_object($post->post_type);
23 23
         if (is_post_type_viewable($post_type_object)) {
24
-            if (! $preview_link) {
24
+            if ( ! $preview_link) {
25 25
                 $preview_link = set_url_scheme(get_permalink($post));
26 26
             }
27 27
 
@@ -41,15 +41,15 @@  discard block
 block discarded – undo
41 41
     }
42 42
 }
43 43
 
44
-if ( ! function_exists( 'is_post_type_viewable' ) ) {
45
-    function is_post_type_viewable( $post_type ) {
46
-        if ( is_scalar( $post_type ) ) {
47
-            $post_type = get_post_type_object( $post_type );
48
-            if ( ! $post_type ) {
44
+if ( ! function_exists('is_post_type_viewable')) {
45
+    function is_post_type_viewable($post_type) {
46
+        if (is_scalar($post_type)) {
47
+            $post_type = get_post_type_object($post_type);
48
+            if ( ! $post_type) {
49 49
                 return false;
50 50
             }
51 51
         }
52 52
      
53
-        return $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
53
+        return $post_type->publicly_queryable || ($post_type->_builtin && $post_type->public);
54 54
     }
55 55
 }
56 56
\ No newline at end of file
Please login to merge, or discard this patch.
core/helpers/EEH_File.helper.php 4 patches
Indentation   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -325,8 +325,8 @@
 block discarded – undo
325 325
 		//eg if given "/var/something/somewhere/", we want to get "somewhere"'s
326 326
 		//parent folder, "/var/something/"
327 327
 		$ds = strlen($file_or_folder_path) > 1
328
-            ? strrpos($file_or_folder_path, DS, -2)
329
-            : strlen($file_or_folder_path);
328
+			? strrpos($file_or_folder_path, DS, -2)
329
+			: strlen($file_or_folder_path);
330 330
 		return substr($file_or_folder_path, 0, $ds + 1);
331 331
 	}
332 332
 
Please login to merge, or discard this patch.
Spacing   +176 added lines, -176 removed lines patch added patch discarded remove patch
@@ -12,8 +12,8 @@  discard block
 block discarded – undo
12 12
  * @ version		 	4.0
13 13
  *
14 14
  */
15
-require_once( EE_HELPERS . 'EEH_Base.helper.php' );
16
-require_once( EE_INTERFACES . 'EEI_Interfaces.php' );
15
+require_once(EE_HELPERS.'EEH_Base.helper.php');
16
+require_once(EE_INTERFACES.'EEI_Interfaces.php');
17 17
 /**
18 18
  *
19 19
  * Class EEH_File
@@ -52,30 +52,30 @@  discard block
 block discarded – undo
52 52
 	 * @throws EE_Error if filesystem credentials are required
53 53
 	 * @return WP_Filesystem_Base
54 54
 	 */
55
-	private static function _get_wp_filesystem( $filepath = null) {
56
-		if( apply_filters(
55
+	private static function _get_wp_filesystem($filepath = null) {
56
+		if (apply_filters(
57 57
 				'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
58
-				$filepath && EEH_File::is_in_uploads_folder( $filepath ),
59
-				$filepath ) ) {
60
-			if( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct ) {
61
-				require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
58
+				$filepath && EEH_File::is_in_uploads_folder($filepath),
59
+				$filepath )) {
60
+			if ( ! EEH_File::$_wp_filesystem_direct instanceof WP_Filesystem_Direct) {
61
+				require_once(ABSPATH.'wp-admin/includes/class-wp-filesystem-base.php');
62 62
 				$method = 'direct';
63
-				$wp_filesystem_direct_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method );
63
+				$wp_filesystem_direct_file = apply_filters('filesystem_method_file', ABSPATH.'wp-admin/includes/class-wp-filesystem-'.$method.'.php', $method);
64 64
 				//check constants defined, just like in wp-admin/includes/file.php's WP_Filesystem()
65
-				if ( ! defined('FS_CHMOD_DIR') ) {
66
-					define('FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
65
+				if ( ! defined('FS_CHMOD_DIR')) {
66
+					define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0777 | 0755));
67 67
 				}
68
-				if ( ! defined('FS_CHMOD_FILE') ) {
69
-					define('FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
68
+				if ( ! defined('FS_CHMOD_FILE')) {
69
+					define('FS_CHMOD_FILE', (fileperms(ABSPATH.'index.php') & 0777 | 0644));
70 70
 				}
71
-				require_once( $wp_filesystem_direct_file );
72
-				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct( array() );
71
+				require_once($wp_filesystem_direct_file);
72
+				EEH_File::$_wp_filesystem_direct = new WP_Filesystem_Direct(array());
73 73
 			}
74 74
 			return EEH_File::$_wp_filesystem_direct;
75 75
 		}
76 76
 		global $wp_filesystem;
77 77
 		// no filesystem setup ???
78
-		if ( ! $wp_filesystem instanceof WP_Filesystem_Base ) {
78
+		if ( ! $wp_filesystem instanceof WP_Filesystem_Base) {
79 79
 			// if some eager beaver's just trying to get in there too early...
80 80
 			// let them do it, because we are one of those eager beavers! :P
81 81
 			/**
@@ -88,34 +88,34 @@  discard block
 block discarded – undo
88 88
 			 * and there may be troubles if the WP files are owned by a different user
89 89
 			 * than the server user. But both of these issues should exist in 4.4 and earlier too
90 90
 			 */
91
-			if ( FALSE && ! did_action( 'wp_loaded' )) {
91
+			if (FALSE && ! did_action('wp_loaded')) {
92 92
 				$msg = __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso');
93
-				if ( WP_DEBUG ) {
94
-					$msg .= '<br />' .  __('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
93
+				if (WP_DEBUG) {
94
+					$msg .= '<br />'.__('The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.', 'event_espresso');
95 95
 				}
96
-				throw new EE_Error( $msg );
96
+				throw new EE_Error($msg);
97 97
 			} else {
98 98
 				// should be loaded if we are past the wp_loaded hook...
99
-				if ( ! function_exists( 'WP_Filesystem' )) {
100
-					require_once( ABSPATH . 'wp-admin/includes/file.php' );
101
-					require_once( ABSPATH . 'wp-admin/includes/template.php' );
99
+				if ( ! function_exists('WP_Filesystem')) {
100
+					require_once(ABSPATH.'wp-admin/includes/file.php');
101
+					require_once(ABSPATH.'wp-admin/includes/template.php');
102 102
 				}
103 103
 				// turn on output buffering so that we can capture the credentials form
104 104
 				ob_start();
105
-				$credentials = request_filesystem_credentials( '' );
105
+				$credentials = request_filesystem_credentials('');
106 106
 				// store credentials form for the time being
107 107
 				EEH_File::$_credentials_form = ob_get_clean();
108 108
 				// basically check for direct or previously configured access
109
-				if ( ! WP_Filesystem( $credentials ) ) {
109
+				if ( ! WP_Filesystem($credentials)) {
110 110
 					// if credentials do NOT exist
111
-					if ( $credentials === FALSE ) {
112
-						add_action( 'admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999 );
113
-						throw new EE_Error( __('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
114
-					} elseif( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->get_error_code() ) {
115
-						add_action( 'admin_notices', array( 'EEH_File', 'display_request_filesystem_credentials_form' ), 999 );
111
+					if ($credentials === FALSE) {
112
+						add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
113
+						throw new EE_Error(__('An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.', 'event_espresso'));
114
+					} elseif (is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code()) {
115
+						add_action('admin_notices', array('EEH_File', 'display_request_filesystem_credentials_form'), 999);
116 116
 						throw new EE_Error(
117 117
 								sprintf(
118
-										__( 'WP Filesystem Error: $1%s', 'event_espresso' ),
118
+										__('WP Filesystem Error: $1%s', 'event_espresso'),
119 119
 										$wp_filesystem->errors->get_error_message() ) );
120 120
 					}
121 121
 				}
@@ -128,8 +128,8 @@  discard block
 block discarded – undo
128 128
 	 * display_request_filesystem_credentials_form
129 129
 	 */
130 130
 	public static function display_request_filesystem_credentials_form() {
131
-		if ( ! empty( EEH_File::$_credentials_form )) {
132
-			echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
131
+		if ( ! empty(EEH_File::$_credentials_form)) {
132
+			echo '<div class="updated espresso-notices-attention"><p>'.EEH_File::$_credentials_form.'</p></div>';
133 133
 		}
134 134
 	}
135 135
 
@@ -147,29 +147,29 @@  discard block
 block discarded – undo
147 147
 	 * @throws EE_Error if filesystem credentials are required
148 148
 	 * @return bool
149 149
 	 */
150
-	public static function verify_filepath_and_permissions( $full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '' ) {
150
+	public static function verify_filepath_and_permissions($full_file_path = '', $file_name = '', $file_ext = '', $type_of_file = '') {
151 151
 		// load WP_Filesystem and set file permissions
152
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
153
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
154
-		if ( ! $wp_filesystem->is_readable( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) )) {
155
-			$file_name = ! empty( $type_of_file ) ? $file_name . ' ' . $type_of_file : $file_name;
156
-			$file_name .= ! empty( $file_ext ) ? ' file' : ' folder';
152
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
153
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
154
+		if ( ! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
155
+			$file_name = ! empty($type_of_file) ? $file_name.' '.$type_of_file : $file_name;
156
+			$file_name .= ! empty($file_ext) ? ' file' : ' folder';
157 157
 			$msg = sprintf(
158
-				__( 'The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso' ),
158
+				__('The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s', 'event_espresso'),
159 159
 				$file_name,
160 160
 				'<br />'
161 161
 			);
162
-			if ( EEH_File::exists( $full_file_path )) {
163
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path, $type_of_file );
162
+			if (EEH_File::exists($full_file_path)) {
163
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
164 164
 			} else {
165 165
 				// no file permissions means the file was not found
166 166
 				$msg .= sprintf(
167
-					__( 'Please ensure the following path is correct: "%s".', 'event_espresso' ),
167
+					__('Please ensure the following path is correct: "%s".', 'event_espresso'),
168 168
 					$full_file_path
169 169
 				);
170 170
 			}
171
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
172
-				throw new EE_Error( $msg . '||' . $msg );
171
+			if (defined('WP_DEBUG') && WP_DEBUG) {
172
+				throw new EE_Error($msg.'||'.$msg);
173 173
 			}
174 174
 			return FALSE;
175 175
 		}
@@ -187,24 +187,24 @@  discard block
 block discarded – undo
187 187
 	 * @throws EE_Error if filesystem credentials are required
188 188
 	 * @return string
189 189
 	 */
190
-	private static function _permissions_error_for_unreadable_filepath( $full_file_path = '', $type_of_file = '' ){
190
+	private static function _permissions_error_for_unreadable_filepath($full_file_path = '', $type_of_file = '') {
191 191
 		// load WP_Filesystem and set file permissions
192
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
192
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
193 193
 		// check file permissions
194
-		$perms = $wp_filesystem->getchmod( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) );
195
-		if ( $perms ) {
194
+		$perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
195
+		if ($perms) {
196 196
 			// file permissions exist, but way be set incorrectly
197
-			$type_of_file = ! empty( $type_of_file ) ? $type_of_file . ' ' : '';
198
-			$type_of_file .= ! empty( $type_of_file ) ? 'file' : 'folder';
197
+			$type_of_file = ! empty($type_of_file) ? $type_of_file.' ' : '';
198
+			$type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
199 199
 			return sprintf(
200
-				__( 'File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso' ),
200
+				__('File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.', 'event_espresso'),
201 201
 				$type_of_file,
202 202
 				$perms
203 203
 			);
204 204
 		} else {
205 205
 			// file exists but file permissions could not be read ?!?!
206 206
 			return sprintf(
207
-				__( 'Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso' ),
207
+				__('Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".', 'event_espresso'),
208 208
 				$full_file_path
209 209
 			);
210 210
 		}
@@ -222,35 +222,35 @@  discard block
 block discarded – undo
222 222
 	 * can't write to it
223 223
 	 * @return bool false if folder isn't writable; true if it exists and is writeable,
224 224
 	 */
225
-	public static function ensure_folder_exists_and_is_writable( $folder = '' ){
226
-		if ( empty( $folder )) {
225
+	public static function ensure_folder_exists_and_is_writable($folder = '') {
226
+		if (empty($folder)) {
227 227
 			return false;
228 228
 		}
229 229
 		// remove ending DS
230
-		$folder = EEH_File::standardise_directory_separators( rtrim( $folder, '/\\' ));
231
-		$parent_folder = EEH_File::get_parent_folder( $folder );
230
+		$folder = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
231
+		$parent_folder = EEH_File::get_parent_folder($folder);
232 232
 		// add DS to folder
233
-		$folder = EEH_File::end_with_directory_separator( $folder );
234
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $folder );
235
-		if ( ! $wp_filesystem->is_dir( EEH_File::convert_local_filepath_to_remote_filepath( $folder ) ) ) {
233
+		$folder = EEH_File::end_with_directory_separator($folder);
234
+		$wp_filesystem = EEH_File::_get_wp_filesystem($folder);
235
+		if ( ! $wp_filesystem->is_dir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
236 236
 			//ok so it doesn't exist. Does its parent? Can we write to it?
237
-			if(	! EEH_File::ensure_folder_exists_and_is_writable( $parent_folder ) ) {
237
+			if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
238 238
 				return false;
239 239
 			}
240
-			if ( ! EEH_File::verify_is_writable( $parent_folder, 'folder' )) {
240
+			if ( ! EEH_File::verify_is_writable($parent_folder, 'folder')) {
241 241
 				return false;
242 242
 			} else {
243
-				if ( ! $wp_filesystem->mkdir( EEH_File::convert_local_filepath_to_remote_filepath(  $folder ) ) ) {
244
-					if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
245
-						$msg = sprintf( __( '"%s" could not be created.', 'event_espresso' ), $folder );
246
-						$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $folder );
247
-						throw new EE_Error( $msg );
243
+				if ( ! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
244
+					if (defined('WP_DEBUG') && WP_DEBUG) {
245
+						$msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
246
+						$msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
247
+						throw new EE_Error($msg);
248 248
 					}
249 249
 					return false;
250 250
 				}
251
-				EEH_File::add_index_file( $folder );
251
+				EEH_File::add_index_file($folder);
252 252
 			}
253
-		} elseif ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
253
+		} elseif ( ! EEH_File::verify_is_writable($folder, 'folder')) {
254 254
 			return false;
255 255
 		}
256 256
 		return true;
@@ -265,15 +265,15 @@  discard block
 block discarded – undo
265 265
 	 * @throws EE_Error if filesystem credentials are required
266 266
 	 * @return bool
267 267
 	 */
268
-	public static function verify_is_writable( $full_path = '', $file_or_folder = 'folder' ){
268
+	public static function verify_is_writable($full_path = '', $file_or_folder = 'folder') {
269 269
 		// load WP_Filesystem and set file permissions
270
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_path );
271
-		$full_path = EEH_File::standardise_directory_separators( $full_path );
272
-		if ( ! $wp_filesystem->is_writable( EEH_File::convert_local_filepath_to_remote_filepath( $full_path ) ) ) {
273
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
274
-				$msg = sprintf( __( 'The "%1$s" %2$s is not writable.', 'event_espresso' ), $full_path, $file_or_folder );
275
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_path );
276
-				throw new EE_Error( $msg );
270
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
271
+		$full_path = EEH_File::standardise_directory_separators($full_path);
272
+		if ( ! $wp_filesystem->is_writable(EEH_File::convert_local_filepath_to_remote_filepath($full_path))) {
273
+			if (defined('WP_DEBUG') && WP_DEBUG) {
274
+				$msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
275
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
276
+				throw new EE_Error($msg);
277 277
 			}
278 278
 			return FALSE;
279 279
 		}
@@ -290,25 +290,25 @@  discard block
 block discarded – undo
290 290
 	 * @throws EE_Error if filesystem credentials are required
291 291
 	 * @return bool
292 292
 	 */
293
-	public static function ensure_file_exists_and_is_writable( $full_file_path = '' ) {
293
+	public static function ensure_file_exists_and_is_writable($full_file_path = '') {
294 294
 		// load WP_Filesystem and set file permissions
295
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
296
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
297
-		$parent_folder = EEH_File::get_parent_folder( $full_file_path );
298
-		if ( ! EEH_File::exists( $full_file_path )) {
299
-			if( ! EEH_File::ensure_folder_exists_and_is_writable( $parent_folder ) ) {
295
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
296
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
297
+		$parent_folder = EEH_File::get_parent_folder($full_file_path);
298
+		if ( ! EEH_File::exists($full_file_path)) {
299
+			if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
300 300
 				return false;
301 301
 			}
302
-			if ( ! $wp_filesystem->touch( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) ) ) {
303
-				if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
304
-					$msg = sprintf( __( 'The "%s" file could not be created.', 'event_espresso' ), $full_file_path );
305
-					$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path );
306
-					throw new EE_Error( $msg );
302
+			if ( ! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
303
+				if (defined('WP_DEBUG') && WP_DEBUG) {
304
+					$msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
305
+					$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
306
+					throw new EE_Error($msg);
307 307
 				}
308 308
 				return false;
309 309
 			}
310 310
 		}
311
-		if ( ! EEH_File::verify_is_writable( $full_file_path, 'file' )) {
311
+		if ( ! EEH_File::verify_is_writable($full_file_path, 'file')) {
312 312
 			return false;
313 313
 		}
314 314
 		return true;
@@ -320,7 +320,7 @@  discard block
 block discarded – undo
320 320
 	 * @param string $file_or_folder_path
321 321
 	 * @return string parent folder, ENDING with a directory separator
322 322
 	 */
323
-	public static function get_parent_folder( $file_or_folder_path ) {
323
+	public static function get_parent_folder($file_or_folder_path) {
324 324
 		//find the last DS, ignoring a DS on the very end
325 325
 		//eg if given "/var/something/somewhere/", we want to get "somewhere"'s
326 326
 		//parent folder, "/var/something/"
@@ -342,12 +342,12 @@  discard block
 block discarded – undo
342 342
 	 * @throws EE_Error if filesystem credentials are required
343 343
 	 * @return string
344 344
 	 */
345
-	public static function get_file_contents( $full_file_path = '' ){
346
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
347
-		if ( EEH_File::verify_filepath_and_permissions( $full_file_path, EEH_File::get_filename_from_filepath( $full_file_path ) , EEH_File::get_file_extension( $full_file_path ))) {
345
+	public static function get_file_contents($full_file_path = '') {
346
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
347
+		if (EEH_File::verify_filepath_and_permissions($full_file_path, EEH_File::get_filename_from_filepath($full_file_path), EEH_File::get_file_extension($full_file_path))) {
348 348
 			// load WP_Filesystem and set file permissions
349
-			$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
350
-			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) );
349
+			$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
350
+			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
351 351
 		}
352 352
 		return '';
353 353
 	}
@@ -362,26 +362,26 @@  discard block
 block discarded – undo
362 362
 	 * @throws EE_Error if filesystem credentials are required
363 363
 	 * @return bool
364 364
 	 */
365
-	public static function write_to_file( $full_file_path = '', $file_contents = '', $file_type = '' ){
366
-		$full_file_path = EEH_File::standardise_directory_separators( $full_file_path );
367
-		$file_type = ! empty( $file_type ) ? rtrim( $file_type, ' ' ) . ' ' : '';
368
-		$folder = EEH_File::remove_filename_from_filepath( $full_file_path );
369
-		if ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
370
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
371
-				$msg = sprintf( __( 'The %1$sfile located at "%2$s" is not writable.', 'event_espresso' ), $file_type, $full_file_path );
372
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path );
373
-				throw new EE_Error( $msg );
365
+	public static function write_to_file($full_file_path = '', $file_contents = '', $file_type = '') {
366
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
367
+		$file_type = ! empty($file_type) ? rtrim($file_type, ' ').' ' : '';
368
+		$folder = EEH_File::remove_filename_from_filepath($full_file_path);
369
+		if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
370
+			if (defined('WP_DEBUG') && WP_DEBUG) {
371
+				$msg = sprintf(__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'), $file_type, $full_file_path);
372
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
373
+				throw new EE_Error($msg);
374 374
 			}
375 375
 			return FALSE;
376 376
 		}
377 377
 		// load WP_Filesystem and set file permissions
378
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
378
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
379 379
 		// write the file
380
-		if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ), $file_contents )) {
381
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
382
-				$msg = sprintf( __( 'The %1$sfile located at "%2$s" could not be written to.', 'event_espresso' ), $file_type, $full_file_path );
383
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_file_path, 'f' );
384
-				throw new EE_Error( $msg );
380
+		if ( ! $wp_filesystem->put_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path), $file_contents)) {
381
+			if (defined('WP_DEBUG') && WP_DEBUG) {
382
+				$msg = sprintf(__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'), $file_type, $full_file_path);
383
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
384
+				throw new EE_Error($msg);
385 385
 			}
386 386
 			return FALSE;
387 387
 		}
@@ -397,9 +397,9 @@  discard block
 block discarded – undo
397 397
 	 * @throws EE_Error if filesystem credentials are required
398 398
 	 * @return boolean
399 399
 	 */
400
-	public static function delete( $filepath, $recursive = false, $type = false ) {
400
+	public static function delete($filepath, $recursive = false, $type = false) {
401 401
 		$wp_filesystem = EEH_File::_get_wp_filesystem();
402
-		return $wp_filesystem->delete( $filepath, $recursive, $type ) ? TRUE : FALSE;
402
+		return $wp_filesystem->delete($filepath, $recursive, $type) ? TRUE : FALSE;
403 403
 	}
404 404
 
405 405
 
@@ -411,9 +411,9 @@  discard block
 block discarded – undo
411 411
 	 * @throws EE_Error if filesystem credentials are required
412 412
 	 * @return bool
413 413
 	 */
414
-	public static function exists( $full_file_path = '' ) {
415
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
416
-		return $wp_filesystem->exists( EEH_File::convert_local_filepath_to_remote_filepath( $full_file_path ) ) ? TRUE : FALSE;
414
+	public static function exists($full_file_path = '') {
415
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
416
+		return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path)) ? TRUE : FALSE;
417 417
 	}
418 418
 
419 419
 
@@ -426,9 +426,9 @@  discard block
 block discarded – undo
426 426
 	 * @throws EE_Error if filesystem credentials are required
427 427
 	 * @return bool
428 428
 	 */
429
-	public static function is_readable( $full_file_path = '' ) {
430
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $full_file_path );
431
-		if( $wp_filesystem->is_readable( EEH_File::convert_local_filepath_to_remote_filepath(  $full_file_path ) ) ) {
429
+	public static function is_readable($full_file_path = '') {
430
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
431
+		if ($wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
432 432
 			return true;
433 433
 		} else {
434 434
 			return false;
@@ -444,8 +444,8 @@  discard block
 block discarded – undo
444 444
 	 * @param string $full_file_path
445 445
 	 * @return string
446 446
 	 */
447
-	public static function remove_filename_from_filepath( $full_file_path = '' ) {
448
-		return pathinfo( $full_file_path, PATHINFO_DIRNAME );
447
+	public static function remove_filename_from_filepath($full_file_path = '') {
448
+		return pathinfo($full_file_path, PATHINFO_DIRNAME);
449 449
 	}
450 450
 
451 451
 
@@ -455,8 +455,8 @@  discard block
 block discarded – undo
455 455
 	 * @param string $full_file_path
456 456
 	 * @return string
457 457
 	 */
458
-	public static function get_filename_from_filepath( $full_file_path = '' ) {
459
-		return pathinfo( $full_file_path, PATHINFO_BASENAME );
458
+	public static function get_filename_from_filepath($full_file_path = '') {
459
+		return pathinfo($full_file_path, PATHINFO_BASENAME);
460 460
 	}
461 461
 
462 462
 
@@ -466,8 +466,8 @@  discard block
 block discarded – undo
466 466
 	 * @param string $full_file_path
467 467
 	 * @return string
468 468
 	 */
469
-	public static function get_file_extension( $full_file_path = '' ) {
470
-		return pathinfo( $full_file_path, PATHINFO_EXTENSION );
469
+	public static function get_file_extension($full_file_path = '') {
470
+		return pathinfo($full_file_path, PATHINFO_EXTENSION);
471 471
 	}
472 472
 
473 473
 
@@ -478,10 +478,10 @@  discard block
 block discarded – undo
478 478
 	 * @throws EE_Error if filesystem credentials are required
479 479
 	 * @return bool
480 480
 	 */
481
-	public static function add_htaccess_deny_from_all( $folder = '' ) {
482
-		$folder = EEH_File::standardise_and_end_with_directory_separator( $folder );
483
-		if ( ! EEH_File::exists( $folder . '.htaccess' ) ) {
484
-			if ( ! EEH_File::write_to_file( $folder . '.htaccess', 'deny from all', '.htaccess' )) {
481
+	public static function add_htaccess_deny_from_all($folder = '') {
482
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
483
+		if ( ! EEH_File::exists($folder.'.htaccess')) {
484
+			if ( ! EEH_File::write_to_file($folder.'.htaccess', 'deny from all', '.htaccess')) {
485 485
 				return FALSE;
486 486
 			}
487 487
 		}
@@ -495,10 +495,10 @@  discard block
 block discarded – undo
495 495
 	 * @throws EE_Error if filesystem credentials are required
496 496
 	 * @return boolean
497 497
 	 */
498
-	public static function add_index_file( $folder ) {
499
-		$folder = EEH_File::standardise_and_end_with_directory_separator( $folder );
500
-		if ( ! EEH_File::exists( $folder . 'index.php' ) ) {
501
-			if ( ! EEH_File::write_to_file( $folder . 'index.php', 'You are not permitted to read from this folder', '.php' )) {
498
+	public static function add_index_file($folder) {
499
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
500
+		if ( ! EEH_File::exists($folder.'index.php')) {
501
+			if ( ! EEH_File::write_to_file($folder.'index.php', 'You are not permitted to read from this folder', '.php')) {
502 502
 				return false;
503 503
 			}
504 504
 		}
@@ -513,11 +513,11 @@  discard block
 block discarded – undo
513 513
 	 * @param string $file_path
514 514
 	 * @return string
515 515
 	 */
516
-	public static function get_classname_from_filepath_with_standard_filename( $file_path ){
516
+	public static function get_classname_from_filepath_with_standard_filename($file_path) {
517 517
 		//extract file from path
518
-		$filename = basename( $file_path );
518
+		$filename = basename($file_path);
519 519
 		//now remove the first period and everything after
520
-		$pos_of_first_period = strpos( $filename,'.' );
520
+		$pos_of_first_period = strpos($filename, '.');
521 521
 		return substr($filename, 0, $pos_of_first_period);
522 522
 	}
523 523
 
@@ -529,8 +529,8 @@  discard block
 block discarded – undo
529 529
 	 * @param string $file_path
530 530
 	 * @return string
531 531
 	 */
532
-	public static function standardise_directory_separators( $file_path ){
533
-		return str_replace( array( '\\', '/' ), DS, $file_path );
532
+	public static function standardise_directory_separators($file_path) {
533
+		return str_replace(array('\\', '/'), DS, $file_path);
534 534
 	}
535 535
 
536 536
 
@@ -541,8 +541,8 @@  discard block
 block discarded – undo
541 541
 	 * @param string $file_path
542 542
 	 * @return string
543 543
 	 */
544
-	public static function end_with_directory_separator( $file_path ){
545
-		return rtrim( $file_path, '/\\' ) . DS;
544
+	public static function end_with_directory_separator($file_path) {
545
+		return rtrim($file_path, '/\\').DS;
546 546
 	}
547 547
 
548 548
 
@@ -552,8 +552,8 @@  discard block
 block discarded – undo
552 552
 	 * @param $file_path
553 553
 	 * @return string
554 554
 	 */
555
-	public static function standardise_and_end_with_directory_separator( $file_path ){
556
-		return self::end_with_directory_separator( self::standardise_directory_separators( $file_path ));
555
+	public static function standardise_and_end_with_directory_separator($file_path) {
556
+		return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
557 557
 	}
558 558
 
559 559
 
@@ -570,21 +570,21 @@  discard block
 block discarded – undo
570 570
 	 *		if $index_numerically == FALSE (Default) keys are what the class names SHOULD be;
571 571
 	 *		 and values are their filepaths
572 572
 	 */
573
-	public static function get_contents_of_folders( $folder_paths = array(), $index_numerically = FALSE ){
573
+	public static function get_contents_of_folders($folder_paths = array(), $index_numerically = FALSE) {
574 574
 		$class_to_folder_path = array();
575
-		foreach( $folder_paths as $folder_path ){
576
-			$folder_path = self::standardise_and_end_with_directory_separator( $folder_path );
575
+		foreach ($folder_paths as $folder_path) {
576
+			$folder_path = self::standardise_and_end_with_directory_separator($folder_path);
577 577
 			// load WP_Filesystem and set file permissions
578
-			$files_in_folder = glob( $folder_path . '*' );
578
+			$files_in_folder = glob($folder_path.'*');
579 579
 			$class_to_folder_path = array();
580
-			if ( $files_in_folder ) {
581
-				foreach( $files_in_folder as $file_path ){
580
+			if ($files_in_folder) {
581
+				foreach ($files_in_folder as $file_path) {
582 582
 					//only add files, not folders
583
-					if ( ! is_dir( $file_path )) {
584
-						if ( $index_numerically ) {
583
+					if ( ! is_dir($file_path)) {
584
+						if ($index_numerically) {
585 585
 							$class_to_folder_path[] = $file_path;
586 586
 						} else {
587
-							$classname = self::get_classname_from_filepath_with_standard_filename( $file_path );
587
+							$classname = self::get_classname_from_filepath_with_standard_filename($file_path);
588 588
 							$class_to_folder_path[$classname] = $file_path;
589 589
 						}
590 590
 					}
@@ -604,39 +604,39 @@  discard block
 block discarded – undo
604 604
 	 * @throws EE_Error if filesystem credentials are required
605 605
 	 * @return boolean success
606 606
 	 */
607
-	public static function copy( $source_file, $destination_file, $overwrite = FALSE ){
608
-		$full_source_path = EEH_File::standardise_directory_separators( $source_file );
609
-		if( ! EEH_File::exists( $full_source_path ) ){
610
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
611
-				$msg = sprintf( __( 'The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso' ), $full_source_path );
612
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_source_path );
613
-				throw new EE_Error( $msg );
607
+	public static function copy($source_file, $destination_file, $overwrite = FALSE) {
608
+		$full_source_path = EEH_File::standardise_directory_separators($source_file);
609
+		if ( ! EEH_File::exists($full_source_path)) {
610
+			if (defined('WP_DEBUG') && WP_DEBUG) {
611
+				$msg = sprintf(__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'), $full_source_path);
612
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
613
+				throw new EE_Error($msg);
614 614
 			}
615 615
 			return FALSE;
616 616
 		}
617 617
 
618
-		$full_dest_path = EEH_File::standardise_directory_separators( $destination_file );
619
-		$folder = EEH_File::remove_filename_from_filepath( $full_dest_path );
620
-		if ( ! EEH_File::verify_is_writable( $folder, 'folder' )) {
621
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
622
-				$msg = sprintf( __( 'The file located at "%2$s" is not writable.', 'event_espresso' ), $full_dest_path );
623
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_dest_path );
624
-				throw new EE_Error( $msg );
618
+		$full_dest_path = EEH_File::standardise_directory_separators($destination_file);
619
+		$folder = EEH_File::remove_filename_from_filepath($full_dest_path);
620
+		if ( ! EEH_File::verify_is_writable($folder, 'folder')) {
621
+			if (defined('WP_DEBUG') && WP_DEBUG) {
622
+				$msg = sprintf(__('The file located at "%2$s" is not writable.', 'event_espresso'), $full_dest_path);
623
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
624
+				throw new EE_Error($msg);
625 625
 			}
626 626
 			return FALSE;
627 627
 		}
628 628
 
629 629
 		// load WP_Filesystem and set file permissions
630
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $destination_file );
630
+		$wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
631 631
 		// write the file
632 632
 		if ( ! $wp_filesystem->copy(
633
-						EEH_File::convert_local_filepath_to_remote_filepath( $full_source_path ),
634
-						EEH_File::convert_local_filepath_to_remote_filepath( $full_dest_path ),
633
+						EEH_File::convert_local_filepath_to_remote_filepath($full_source_path),
634
+						EEH_File::convert_local_filepath_to_remote_filepath($full_dest_path),
635 635
 						$overwrite )) {
636
-			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
637
-				$msg = sprintf( __( 'Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso' ), $full_source_path );
638
-				$msg .= EEH_File::_permissions_error_for_unreadable_filepath( $full_source_path, 'f' );
639
-				throw new EE_Error( $msg );
636
+			if (defined('WP_DEBUG') && WP_DEBUG) {
637
+				$msg = sprintf(__('Attempted writing to file %1$s, but could not, probably because of permissions issues', 'event_espresso'), $full_source_path);
638
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path, 'f');
639
+				throw new EE_Error($msg);
640 640
 			}
641 641
 			return FALSE;
642 642
 		}
@@ -648,9 +648,9 @@  discard block
 block discarded – undo
648 648
 	 * @param string $filepath
649 649
 	 * @return boolean
650 650
 	 */
651
-	public static function is_in_uploads_folder( $filepath ) {
651
+	public static function is_in_uploads_folder($filepath) {
652 652
 		$uploads = wp_upload_dir();
653
-		return strpos( $filepath, $uploads[ 'basedir' ] ) === 0 ? true : false;
653
+		return strpos($filepath, $uploads['basedir']) === 0 ? true : false;
654 654
 	}
655 655
 
656 656
 	/**
@@ -665,9 +665,9 @@  discard block
 block discarded – undo
665 665
 	 * @return string the remote filepath (eg the filepath the filesystem method, eg
666 666
 	 * ftp or ssh, will use to access the folder
667 667
 	 */
668
-	public static function convert_local_filepath_to_remote_filepath( $local_filepath ) {
669
-		$wp_filesystem = EEH_File::_get_wp_filesystem( $local_filepath );
670
-		return str_replace( WP_CONTENT_DIR . DS, $wp_filesystem->wp_content_dir(), $local_filepath );
668
+	public static function convert_local_filepath_to_remote_filepath($local_filepath) {
669
+		$wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
670
+		return str_replace(WP_CONTENT_DIR.DS, $wp_filesystem->wp_content_dir(), $local_filepath);
671 671
 	}
672 672
 }
673 673
 // End of file EEH_File.helper.php
Please login to merge, or discard this patch.
Doc Comments   -2 removed lines patch added patch discarded remove patch
@@ -658,8 +658,6 @@
 block discarded – undo
658 658
 	 * converts it into a "remote" filepath (the filepath the currently-in-use
659 659
 	 * $wp_filesystem needs to use access the folder or file).
660 660
 	 * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
661
-	 * @param WP_Filesystem_Base $wp_filesystem we aren't initially sure which one
662
-	 * is in use, so you need to provide it
663 661
 	 * @param string $local_filepath the filepath to the folder/file locally
664 662
 	 * @throws EE_Error if filesystem credentials are required
665 663
 	 * @return string the remote filepath (eg the filepath the filesystem method, eg
Please login to merge, or discard this patch.
Braces   +3 added lines, -1 removed lines patch added patch discarded remove patch
@@ -1,4 +1,6 @@
 block discarded – undo
1
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
1
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
+	exit('No direct script access allowed');
3
+}
2 4
 /**
3 5
  * Event Espresso
4 6
  *
Please login to merge, or discard this patch.
help_tours/Registration_Form_Questions_Overview_Help_Tour.class.php 2 patches
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php
2
-if (!defined('EVENT_ESPRESSO_VERSION') )
2
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
3 3
 	exit('NO direct script access allowed');
4 4
 
5 5
 /**
@@ -116,42 +116,42 @@  discard block
 block discarded – undo
116 116
 
117 117
 
118 118
 	protected function _start() {
119
-		$content = '<h3>' . __('Questions Overview', 'event_espresso') . '</h3>';
120
-		$content .= '<p>' . __('This tour of the Questions Overview page will go over different areas of the screen to help you understand what they are used for.', 'event_espresso') . '</p>';
119
+		$content = '<h3>'.__('Questions Overview', 'event_espresso').'</h3>';
120
+		$content .= '<p>'.__('This tour of the Questions Overview page will go over different areas of the screen to help you understand what they are used for.', 'event_espresso').'</p>';
121 121
 
122 122
 		return $content;
123 123
 	}
124 124
 
125 125
 	protected function _display_text_stop() {
126
-		return '<p>' . __('View available questions.', 'event_espresso') . '</p>';
126
+		return '<p>'.__('View available questions.', 'event_espresso').'</p>';
127 127
 	}
128 128
 
129 129
 	protected function _admin_label_stop() {
130
-		return '<p>' . __('View the admin label for your questions.', 'event_espresso') . '</p>';
130
+		return '<p>'.__('View the admin label for your questions.', 'event_espresso').'</p>';
131 131
 	}
132 132
 
133 133
 	protected function _type_stop() {
134
-		return '<p>' . __('View the type of question. Available options are Text, Textarea, Checkboxes, Radio Buttons, Dropdown, State/Province Dropdown, Country Dropdown, and Date Picker.', 'event_espresso') . '</p>';
134
+		return '<p>'.__('View the type of question. Available options are Text, Textarea, Checkboxes, Radio Buttons, Dropdown, State/Province Dropdown, Country Dropdown, and Date Picker.', 'event_espresso').'</p>';
135 135
 	}
136 136
 
137 137
 	protected function _values_stop() {
138
-		return '<p>' . __('View stored values for checkboxes, radio buttons, and select boxes.', 'event_espresso') . '</p>';
138
+		return '<p>'.__('View stored values for checkboxes, radio buttons, and select boxes.', 'event_espresso').'</p>';
139 139
 	}
140 140
 
141 141
 	protected function _required_stop() {
142
-		return '<p>' . __('View if a question is required.', 'event_espresso') . '</p>';
142
+		return '<p>'.__('View if a question is required.', 'event_espresso').'</p>';
143 143
 	}
144 144
 
145 145
 	protected function _bulk_actions_stop() {
146
-		return '<p>' . __('Perform bulk actions to multiple questions.', 'event_espresso') . '</p>';
146
+		return '<p>'.__('Perform bulk actions to multiple questions.', 'event_espresso').'</p>';
147 147
 	}
148 148
 
149 149
 	protected function _search_stop() {
150
-		return '<p>' . __('Search through questions. The following sources will be searched: Name of Question (display text).', 'event_espresso') . '</p>';
150
+		return '<p>'.__('Search through questions. The following sources will be searched: Name of Question (display text).', 'event_espresso').'</p>';
151 151
 	}
152 152
 
153 153
 	protected function _add_new_question_stop() {
154
-		return '<p>' . __('Click here to add a new question.', 'event_espresso') . '</p>';
154
+		return '<p>'.__('Click here to add a new question.', 'event_espresso').'</p>';
155 155
 	}
156 156
 
157 157
 }
158 158
\ No newline at end of file
Please login to merge, or discard this patch.
Braces   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -1,6 +1,7 @@
 block discarded – undo
1 1
 <?php
2
-if (!defined('EVENT_ESPRESSO_VERSION') )
2
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
3 3
 	exit('NO direct script access allowed');
4
+}
4 5
 
5 6
 /**
6 7
  * Event Espresso
Please login to merge, or discard this patch.
help_tours/Registration_Form_Questions_Overview_Help_Tour.class.php 2 patches
Indentation   +117 added lines, -117 removed lines patch added patch discarded remove patch
@@ -1,6 +1,6 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
3
-    exit('NO direct script access allowed');
3
+	exit('NO direct script access allowed');
4 4
 }
5 5
 
6 6
 /**
@@ -18,64 +18,64 @@  discard block
 block discarded – undo
18 18
 class Registration_Form_Questions_Overview_Help_Tour extends EE_Help_Tour
19 19
 {
20 20
     
21
-    protected function _set_tour_properties()
22
-    {
23
-        $this->_label = __('Questions Overview Tour', 'event_espresso');
24
-        $this->_slug  = $this->_is_caf ? 'questions-overview-caf-joyride' : 'questions-overview-joyride';
25
-    }
21
+	protected function _set_tour_properties()
22
+	{
23
+		$this->_label = __('Questions Overview Tour', 'event_espresso');
24
+		$this->_slug  = $this->_is_caf ? 'questions-overview-caf-joyride' : 'questions-overview-joyride';
25
+	}
26 26
     
27
-    protected function _set_tour_stops()
28
-    {
29
-        $this->_stops = array(
30
-            10  => array(
31
-                'content' => $this->_start(),
32
-            ),
33
-            30  => array(
34
-                'id'      => 'display_text',
35
-                'content' => $this->_display_text_stop(),
36
-                'options' => array(
37
-                    'tipLocation'    => 'top',
38
-                    'tipAdjustmentX' => -5,
39
-                    'tipAdjustmentY' => -25
40
-                )
41
-            ),
42
-            40  => array(
43
-                'id'      => 'admin_label',
44
-                'content' => $this->_admin_label_stop(),
45
-                'options' => array(
46
-                    'tipLocation'    => 'top',
47
-                    'tipAdjustmentX' => 20,
48
-                    'tipAdjustmentY' => -25
49
-                )
50
-            ),
51
-            50  => array(
52
-                'id'      => 'type',
53
-                'content' => $this->_type_stop(),
54
-                'options' => array(
55
-                    'tipLocation'    => 'top',
56
-                    'tipAdjustmentX' => -5,
57
-                    'tipAdjustmentY' => -25
58
-                )
59
-            ),
60
-            60  => array(
61
-                'id'      => 'values',
62
-                'content' => $this->_values_stop(),
63
-                'options' => array(
64
-                    'tipLocation'    => 'top',
65
-                    'tipAdjustmentX' => -5,
66
-                    'tipAdjustmentY' => -25
67
-                )
68
-            ),
69
-            70  => array(
70
-                'id'      => 'required',
71
-                'content' => $this->_required_stop(),
72
-                'options' => array(
73
-                    'tipLocation'    => 'top',
74
-                    'tipAdjustmentY' => -20,
75
-                    'tipAdjustmentX' => -15
76
-                )
77
-            ),
78
-            /*80 => array(
27
+	protected function _set_tour_stops()
28
+	{
29
+		$this->_stops = array(
30
+			10  => array(
31
+				'content' => $this->_start(),
32
+			),
33
+			30  => array(
34
+				'id'      => 'display_text',
35
+				'content' => $this->_display_text_stop(),
36
+				'options' => array(
37
+					'tipLocation'    => 'top',
38
+					'tipAdjustmentX' => -5,
39
+					'tipAdjustmentY' => -25
40
+				)
41
+			),
42
+			40  => array(
43
+				'id'      => 'admin_label',
44
+				'content' => $this->_admin_label_stop(),
45
+				'options' => array(
46
+					'tipLocation'    => 'top',
47
+					'tipAdjustmentX' => 20,
48
+					'tipAdjustmentY' => -25
49
+				)
50
+			),
51
+			50  => array(
52
+				'id'      => 'type',
53
+				'content' => $this->_type_stop(),
54
+				'options' => array(
55
+					'tipLocation'    => 'top',
56
+					'tipAdjustmentX' => -5,
57
+					'tipAdjustmentY' => -25
58
+				)
59
+			),
60
+			60  => array(
61
+				'id'      => 'values',
62
+				'content' => $this->_values_stop(),
63
+				'options' => array(
64
+					'tipLocation'    => 'top',
65
+					'tipAdjustmentX' => -5,
66
+					'tipAdjustmentY' => -25
67
+				)
68
+			),
69
+			70  => array(
70
+				'id'      => 'required',
71
+				'content' => $this->_required_stop(),
72
+				'options' => array(
73
+					'tipLocation'    => 'top',
74
+					'tipAdjustmentY' => -20,
75
+					'tipAdjustmentX' => -15
76
+				)
77
+			),
78
+			/*80 => array(
79 79
                 'class' => 'bulkactions',
80 80
                 'content' => $this->_bulk_actions_stop(),
81 81
                 'options' => array(
@@ -84,77 +84,77 @@  discard block
 block discarded – undo
84 84
                     'tipAdjustmentX' => -15
85 85
                     )
86 86
                 ),*/
87
-            90  => array(
88
-                'id'      => 'event-espresso_page_espresso_registration_form-search-input',
89
-                'content' => $this->_search_stop(),
90
-                'options' => array(
91
-                    'tipLocation'    => 'left',
92
-                    'tipAdjustmentY' => -50,
93
-                    'tipAdjustmentX' => -15
94
-                )
95
-            ),
96
-            100 => array(
97
-                'id'      => 'add-new-question',
98
-                'content' => $this->_add_new_question_stop(),
99
-                'options' => array(
100
-                    'tipLocation'    => 'right',
101
-                    'tipAdjustmentY' => -50,
102
-                    'tipAdjustmentX' => 15
103
-                )
104
-            ),
105
-        );
106
-    }
87
+			90  => array(
88
+				'id'      => 'event-espresso_page_espresso_registration_form-search-input',
89
+				'content' => $this->_search_stop(),
90
+				'options' => array(
91
+					'tipLocation'    => 'left',
92
+					'tipAdjustmentY' => -50,
93
+					'tipAdjustmentX' => -15
94
+				)
95
+			),
96
+			100 => array(
97
+				'id'      => 'add-new-question',
98
+				'content' => $this->_add_new_question_stop(),
99
+				'options' => array(
100
+					'tipLocation'    => 'right',
101
+					'tipAdjustmentY' => -50,
102
+					'tipAdjustmentX' => 15
103
+				)
104
+			),
105
+		);
106
+	}
107 107
     
108 108
     
109
-    protected function _start()
110
-    {
111
-        $content = '<h3>' . __('Questions Overview', 'event_espresso') . '</h3>';
112
-        $content .= '<p>' . __('This tour of the Questions Overview page will go over different areas of the screen to help you understand what they are used for.',
113
-                'event_espresso') . '</p>';
109
+	protected function _start()
110
+	{
111
+		$content = '<h3>' . __('Questions Overview', 'event_espresso') . '</h3>';
112
+		$content .= '<p>' . __('This tour of the Questions Overview page will go over different areas of the screen to help you understand what they are used for.',
113
+				'event_espresso') . '</p>';
114 114
         
115
-        return $content;
116
-    }
115
+		return $content;
116
+	}
117 117
     
118
-    protected function _display_text_stop()
119
-    {
120
-        return '<p>' . __('View available questions.', 'event_espresso') . '</p>';
121
-    }
118
+	protected function _display_text_stop()
119
+	{
120
+		return '<p>' . __('View available questions.', 'event_espresso') . '</p>';
121
+	}
122 122
     
123
-    protected function _admin_label_stop()
124
-    {
125
-        return '<p>' . __('View the admin label for your questions.', 'event_espresso') . '</p>';
126
-    }
123
+	protected function _admin_label_stop()
124
+	{
125
+		return '<p>' . __('View the admin label for your questions.', 'event_espresso') . '</p>';
126
+	}
127 127
     
128
-    protected function _type_stop()
129
-    {
130
-        return '<p>' . __('View the type of question. Available options are Text, Textarea, Checkboxes, Radio Buttons, Dropdown, State/Province Dropdown, Country Dropdown, and Date Picker.',
131
-            'event_espresso') . '</p>';
132
-    }
128
+	protected function _type_stop()
129
+	{
130
+		return '<p>' . __('View the type of question. Available options are Text, Textarea, Checkboxes, Radio Buttons, Dropdown, State/Province Dropdown, Country Dropdown, and Date Picker.',
131
+			'event_espresso') . '</p>';
132
+	}
133 133
     
134
-    protected function _values_stop()
135
-    {
136
-        return '<p>' . __('View stored values for checkboxes, radio buttons, and select boxes.',
137
-            'event_espresso') . '</p>';
138
-    }
134
+	protected function _values_stop()
135
+	{
136
+		return '<p>' . __('View stored values for checkboxes, radio buttons, and select boxes.',
137
+			'event_espresso') . '</p>';
138
+	}
139 139
     
140
-    protected function _required_stop()
141
-    {
142
-        return '<p>' . __('View if a question is required.', 'event_espresso') . '</p>';
143
-    }
140
+	protected function _required_stop()
141
+	{
142
+		return '<p>' . __('View if a question is required.', 'event_espresso') . '</p>';
143
+	}
144 144
     
145
-    /* protected function _bulk_actions_stop() {
145
+	/* protected function _bulk_actions_stop() {
146 146
         return '<p>' . __('Perform bulk actions to multiple questions.', 'event_espresso') . '</p>';
147 147
     } */
148 148
     
149
-    protected function _search_stop()
150
-    {
151
-        return '<p>' . __('Search through questions. The following sources will be searched: Name of Question (display text).',
152
-            'event_espresso') . '</p>';
153
-    }
149
+	protected function _search_stop()
150
+	{
151
+		return '<p>' . __('Search through questions. The following sources will be searched: Name of Question (display text).',
152
+			'event_espresso') . '</p>';
153
+	}
154 154
     
155
-    protected function _add_new_question_stop()
156
-    {
157
-        return '<p>' . __('Click here to add a new question.', 'event_espresso') . '</p>';
158
-    }
155
+	protected function _add_new_question_stop()
156
+	{
157
+		return '<p>' . __('Click here to add a new question.', 'event_espresso') . '</p>';
158
+	}
159 159
     
160 160
 }
161 161
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -108,38 +108,38 @@  discard block
 block discarded – undo
108 108
     
109 109
     protected function _start()
110 110
     {
111
-        $content = '<h3>' . __('Questions Overview', 'event_espresso') . '</h3>';
112
-        $content .= '<p>' . __('This tour of the Questions Overview page will go over different areas of the screen to help you understand what they are used for.',
113
-                'event_espresso') . '</p>';
111
+        $content = '<h3>'.__('Questions Overview', 'event_espresso').'</h3>';
112
+        $content .= '<p>'.__('This tour of the Questions Overview page will go over different areas of the screen to help you understand what they are used for.',
113
+                'event_espresso').'</p>';
114 114
         
115 115
         return $content;
116 116
     }
117 117
     
118 118
     protected function _display_text_stop()
119 119
     {
120
-        return '<p>' . __('View available questions.', 'event_espresso') . '</p>';
120
+        return '<p>'.__('View available questions.', 'event_espresso').'</p>';
121 121
     }
122 122
     
123 123
     protected function _admin_label_stop()
124 124
     {
125
-        return '<p>' . __('View the admin label for your questions.', 'event_espresso') . '</p>';
125
+        return '<p>'.__('View the admin label for your questions.', 'event_espresso').'</p>';
126 126
     }
127 127
     
128 128
     protected function _type_stop()
129 129
     {
130
-        return '<p>' . __('View the type of question. Available options are Text, Textarea, Checkboxes, Radio Buttons, Dropdown, State/Province Dropdown, Country Dropdown, and Date Picker.',
131
-            'event_espresso') . '</p>';
130
+        return '<p>'.__('View the type of question. Available options are Text, Textarea, Checkboxes, Radio Buttons, Dropdown, State/Province Dropdown, Country Dropdown, and Date Picker.',
131
+            'event_espresso').'</p>';
132 132
     }
133 133
     
134 134
     protected function _values_stop()
135 135
     {
136
-        return '<p>' . __('View stored values for checkboxes, radio buttons, and select boxes.',
137
-            'event_espresso') . '</p>';
136
+        return '<p>'.__('View stored values for checkboxes, radio buttons, and select boxes.',
137
+            'event_espresso').'</p>';
138 138
     }
139 139
     
140 140
     protected function _required_stop()
141 141
     {
142
-        return '<p>' . __('View if a question is required.', 'event_espresso') . '</p>';
142
+        return '<p>'.__('View if a question is required.', 'event_espresso').'</p>';
143 143
     }
144 144
     
145 145
     /* protected function _bulk_actions_stop() {
@@ -148,13 +148,13 @@  discard block
 block discarded – undo
148 148
     
149 149
     protected function _search_stop()
150 150
     {
151
-        return '<p>' . __('Search through questions. The following sources will be searched: Name of Question (display text).',
152
-            'event_espresso') . '</p>';
151
+        return '<p>'.__('Search through questions. The following sources will be searched: Name of Question (display text).',
152
+            'event_espresso').'</p>';
153 153
     }
154 154
     
155 155
     protected function _add_new_question_stop()
156 156
     {
157
-        return '<p>' . __('Click here to add a new question.', 'event_espresso') . '</p>';
157
+        return '<p>'.__('Click here to add a new question.', 'event_espresso').'</p>';
158 158
     }
159 159
     
160 160
 }
161 161
\ No newline at end of file
Please login to merge, or discard this patch.
core/db_models/fields/EE_Field_With_Model_Name.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -35,7 +35,7 @@
 block discarded – undo
35 35
      * Returns the name of the model(s) pointed to
36 36
      *
37 37
      * @deprecated since version 4.6.7
38
-     * @return mixed string or array of strings
38
+     * @return string string or array of strings
39 39
      */
40 40
     function get_model_name_pointed_to()
41 41
     {
Please login to merge, or discard this patch.
Indentation   +74 added lines, -74 removed lines patch added patch discarded remove patch
@@ -8,83 +8,83 @@
 block discarded – undo
8 8
  */
9 9
 abstract class EE_Field_With_Model_Name extends EE_Model_Field_Base
10 10
 {
11
-    /**
12
-     * Usually the name of a single model. However, as in the case for custom post types,
13
-     * it can actually be an array of models
14
-     *
15
-     * @var string or array
16
-     */
17
-    protected $_model_name_pointed_to;
11
+	/**
12
+	 * Usually the name of a single model. However, as in the case for custom post types,
13
+	 * it can actually be an array of models
14
+	 *
15
+	 * @var string or array
16
+	 */
17
+	protected $_model_name_pointed_to;
18 18
 
19
-    /**
20
-     * @param string  $table_column  name fo column for field
21
-     * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
22
-     * @param boolean $nullable
23
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
24
-     *                               dbe a string
25
-     * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
26
-     *                               "EEM_"
27
-     */
28
-    function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
29
-    {
30
-        $this->_model_name_pointed_to = $model_name;
31
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
32
-    }
19
+	/**
20
+	 * @param string  $table_column  name fo column for field
21
+	 * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
22
+	 * @param boolean $nullable
23
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
24
+	 *                               dbe a string
25
+	 * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
26
+	 *                               "EEM_"
27
+	 */
28
+	function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
29
+	{
30
+		$this->_model_name_pointed_to = $model_name;
31
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
32
+	}
33 33
 
34
-    /**
35
-     * Returns the name of the model(s) pointed to
36
-     *
37
-     * @deprecated since version 4.6.7
38
-     * @return mixed string or array of strings
39
-     */
40
-    function get_model_name_pointed_to()
41
-    {
42
-        EE_Error::doing_it_wrong('get_model_name_pointed_to',
43
-            __('This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
44
-                'event_espresso'), '4.6.7');
45
-        return $this->_model_name_pointed_to;
46
-    }
34
+	/**
35
+	 * Returns the name of the model(s) pointed to
36
+	 *
37
+	 * @deprecated since version 4.6.7
38
+	 * @return mixed string or array of strings
39
+	 */
40
+	function get_model_name_pointed_to()
41
+	{
42
+		EE_Error::doing_it_wrong('get_model_name_pointed_to',
43
+			__('This method has been deprecated in favour of instead using get_model_names_pointed_to, which consistently returns an array',
44
+				'event_espresso'), '4.6.7');
45
+		return $this->_model_name_pointed_to;
46
+	}
47 47
 
48
-    /**
49
-     * Gets the model names pointed to by this field, always as an array
50
-     * (even if there's only one)
51
-     *
52
-     * @return array of model names pointed to by this field
53
-     */
54
-    function get_model_names_pointed_to()
55
-    {
56
-        if (is_array($this->_model_name_pointed_to)) {
57
-            return $this->_model_name_pointed_to;
58
-        } else {
59
-            return array($this->_model_name_pointed_to);
60
-        }
61
-    }
48
+	/**
49
+	 * Gets the model names pointed to by this field, always as an array
50
+	 * (even if there's only one)
51
+	 *
52
+	 * @return array of model names pointed to by this field
53
+	 */
54
+	function get_model_names_pointed_to()
55
+	{
56
+		if (is_array($this->_model_name_pointed_to)) {
57
+			return $this->_model_name_pointed_to;
58
+		} else {
59
+			return array($this->_model_name_pointed_to);
60
+		}
61
+	}
62 62
 
63
-    /**
64
-     * Returns the model's classname (eg EE_Event instead of just Event)
65
-     *
66
-     * @return array
67
-     */
68
-    function get_model_class_names_pointed_to()
69
-    {
70
-        $model_names = array();
71
-        if (is_array($this->_model_name_pointed_to)) {
72
-            foreach ($this->_model_name_pointed_to as $model_name) {
73
-                $model_names[] = "EE_" . $model_name;
74
-            }
75
-        } else {
76
-            $model_names = array("EE_" . $this->_model_name_pointed_to);
77
-        }
78
-        return $model_names;
79
-    }
63
+	/**
64
+	 * Returns the model's classname (eg EE_Event instead of just Event)
65
+	 *
66
+	 * @return array
67
+	 */
68
+	function get_model_class_names_pointed_to()
69
+	{
70
+		$model_names = array();
71
+		if (is_array($this->_model_name_pointed_to)) {
72
+			foreach ($this->_model_name_pointed_to as $model_name) {
73
+				$model_names[] = "EE_" . $model_name;
74
+			}
75
+		} else {
76
+			$model_names = array("EE_" . $this->_model_name_pointed_to);
77
+		}
78
+		return $model_names;
79
+	}
80 80
 
81
-    function is_model_obj_of_type_pointed_to($model_obj_or_ID)
82
-    {
83
-        foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
84
-            if ($model_obj_or_ID instanceof $model_obj_classname) {
85
-                return true;
86
-            }
87
-        }
88
-        return false;
89
-    }
81
+	function is_model_obj_of_type_pointed_to($model_obj_or_ID)
82
+	{
83
+		foreach ($this->get_model_class_names_pointed_to() as $model_obj_classname) {
84
+			if ($model_obj_or_ID instanceof $model_obj_classname) {
85
+				return true;
86
+			}
87
+		}
88
+		return false;
89
+	}
90 90
 }
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -70,10 +70,10 @@
 block discarded – undo
70 70
         $model_names = array();
71 71
         if (is_array($this->_model_name_pointed_to)) {
72 72
             foreach ($this->_model_name_pointed_to as $model_name) {
73
-                $model_names[] = "EE_" . $model_name;
73
+                $model_names[] = "EE_".$model_name;
74 74
             }
75 75
         } else {
76
-            $model_names = array("EE_" . $this->_model_name_pointed_to);
76
+            $model_names = array("EE_".$this->_model_name_pointed_to);
77 77
         }
78 78
         return $model_names;
79 79
     }
Please login to merge, or discard this patch.
core/db_models/fields/EE_Primary_Key_Field_Base.php 2 patches
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -7,6 +7,7 @@
 block discarded – undo
7 7
      *
8 8
      * @param string $table_column
9 9
      * @param string $nicename
10
+     * @param integer|null $default
10 11
      */
11 12
     public function __construct($table_column, $nicename, $default)
12 13
     {
Please login to merge, or discard this patch.
Indentation   +19 added lines, -19 removed lines patch added patch discarded remove patch
@@ -2,24 +2,24 @@
 block discarded – undo
2 2
 
3 3
 abstract class EE_Primary_Key_Field_Base extends EE_Field_With_Model_Name
4 4
 {
5
-    /**
6
-     * Overrides parent so it doesn't need to provide so many non-applicable fields
7
-     *
8
-     * @param string $table_column
9
-     * @param string $nicename
10
-     */
11
-    public function __construct($table_column, $nicename, $default)
12
-    {
13
-        parent::__construct($table_column, $nicename, false, $default, null);
14
-    }
5
+	/**
6
+	 * Overrides parent so it doesn't need to provide so many non-applicable fields
7
+	 *
8
+	 * @param string $table_column
9
+	 * @param string $nicename
10
+	 */
11
+	public function __construct($table_column, $nicename, $default)
12
+	{
13
+		parent::__construct($table_column, $nicename, false, $default, null);
14
+	}
15 15
 
16
-    /**
17
-     * @param $table_alias
18
-     * @param $name
19
-     */
20
-    function _construct_finalize($table_alias, $name, $model_name)
21
-    {
22
-        $this->_model_name_pointed_to = $model_name;
23
-        parent::_construct_finalize($table_alias, $name, $model_name);
24
-    }
16
+	/**
17
+	 * @param $table_alias
18
+	 * @param $name
19
+	 */
20
+	function _construct_finalize($table_alias, $name, $model_name)
21
+	{
22
+		$this->_model_name_pointed_to = $model_name;
23
+		parent::_construct_finalize($table_alias, $name, $model_name);
24
+	}
25 25
 }
Please login to merge, or discard this patch.
core/db_models/fields/EE_WP_Post_Status_Field.php 3 patches
Doc Comments   -2 removed lines patch added patch discarded remove patch
@@ -33,8 +33,6 @@
 block discarded – undo
33 33
      *                                    )
34 34
      *                                    )
35 35
      * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
36
-     * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
37
-     *                                    set to true, it will be stored as an INT
38 36
      */
39 37
     function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
40 38
     {
Please login to merge, or discard this patch.
Indentation   +112 added lines, -112 removed lines patch added patch discarded remove patch
@@ -4,116 +4,116 @@
 block discarded – undo
4 4
 class EE_WP_Post_Status_Field extends EE_Enum_Text_Field
5 5
 {
6 6
 
7
-    protected $_wp_post_stati;
8
-
9
-
10
-    /**
11
-     * constructor
12
-     *
13
-     * @param string  $table_column       column on table
14
-     * @param string  $nicename           nice name for column(field)
15
-     * @param bool    $nullable           is this field nullable
16
-     * @param string  $default_value      default status
17
-     * @param array   $new_stati          If additional stati are to be used other than the default WP statuses then
18
-     *                                    they can be registered via this property.  The format of the array should be
19
-     *                                    as follows: array(
20
-     *                                    'status_reference' => array(
21
-     *                                    'label' => __('Status Reference Label', 'event_espresso')
22
-     *                                    'public' => true, //'Whether posts of this status should be shown on the
23
-     *                                    frontend of the site'
24
-     *                                    'exclude_from_search' => false, //'Whether posts of this status should be
25
-     *                                    excluded from wp searches'
26
-     *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
27
-     *                                    in queries for the admin "all" view in list table views.
28
-     *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
29
-     *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
30
-     *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
31
-     *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
32
-     *                                    on the admin screen( or you won't see your status count ).
33
-     *                                    )
34
-     *                                    )
35
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
36
-     * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
37
-     *                                    set to true, it will be stored as an INT
38
-     */
39
-    function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
40
-    {
41
-        $this->_register_new_stati($new_stati);
42
-        $this->_set_allowed_enum_values();
43
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
44
-    }
45
-
46
-
47
-    /**
48
-     * This registers any new statuses sent via the $new_stati array on construct
49
-     *
50
-     * @access protected
51
-     * @param  array $new_stati statuses
52
-     * @return void
53
-     */
54
-    protected function _register_new_stati($new_stati)
55
-    {
56
-
57
-        foreach ((array)$new_stati as $status_key => $status_args) {
58
-            $args = array(
59
-                'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
60
-                'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
61
-                'exclude_from_search'       => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false,
62
-                'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false,
63
-                'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true,
64
-                'label_count'               => isset($status_args['label_count']) ? $status_args['label_count'] : '',
65
-            );
66
-            register_post_status($status_key, $status_args);
67
-        }
68
-
69
-    }
70
-
71
-
72
-    /**
73
-     * This sets the _allowed_enum_values property using the $wp_post_stati array
74
-     *
75
-     * @access protected
76
-     * @regurn void
77
-     */
78
-    protected function _set_allowed_enum_values()
79
-    {
80
-        //first let's get the post_statuses
81
-        global $wp_post_statuses;
82
-        $this->_wp_post_stati = $wp_post_statuses;
83
-
84
-        foreach ($this->_wp_post_stati as $post_status => $args_object) {
85
-            $this->_allowed_enum_values[$post_status] = $args_object->label;
86
-        }
87
-
88
-    }
89
-
90
-    /**
91
-     * Before calling parent, first double-checks our list of acceptable post
92
-     * types is up-to-date
93
-     *
94
-     * @param string $value_inputted_for_field_on_model_object
95
-     * @return string
96
-     */
97
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
98
-    {
99
-        $this->_set_allowed_enum_values();
100
-        return parent::prepare_for_set($value_inputted_for_field_on_model_object);
101
-    }
102
-
103
-
104
-
105
-    //helper methods for getting various $wp_post_statuses stuff.
106
-
107
-    /**
108
-     * This just returns the status object for the given status
109
-     *
110
-     * @access public
111
-     * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
112
-     * @param  string $status What status object you want
113
-     * @return std_object         the status object or FALSE if it doesn't exist.
114
-     */
115
-    public function get_status_object($status)
116
-    {
117
-        return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : false;
118
-    }
7
+	protected $_wp_post_stati;
8
+
9
+
10
+	/**
11
+	 * constructor
12
+	 *
13
+	 * @param string  $table_column       column on table
14
+	 * @param string  $nicename           nice name for column(field)
15
+	 * @param bool    $nullable           is this field nullable
16
+	 * @param string  $default_value      default status
17
+	 * @param array   $new_stati          If additional stati are to be used other than the default WP statuses then
18
+	 *                                    they can be registered via this property.  The format of the array should be
19
+	 *                                    as follows: array(
20
+	 *                                    'status_reference' => array(
21
+	 *                                    'label' => __('Status Reference Label', 'event_espresso')
22
+	 *                                    'public' => true, //'Whether posts of this status should be shown on the
23
+	 *                                    frontend of the site'
24
+	 *                                    'exclude_from_search' => false, //'Whether posts of this status should be
25
+	 *                                    excluded from wp searches'
26
+	 *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
27
+	 *                                    in queries for the admin "all" view in list table views.
28
+	 *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
29
+	 *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
30
+	 *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
31
+	 *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
32
+	 *                                    on the admin screen( or you won't see your status count ).
33
+	 *                                    )
34
+	 *                                    )
35
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
36
+	 * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is
37
+	 *                                    set to true, it will be stored as an INT
38
+	 */
39
+	function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array())
40
+	{
41
+		$this->_register_new_stati($new_stati);
42
+		$this->_set_allowed_enum_values();
43
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
44
+	}
45
+
46
+
47
+	/**
48
+	 * This registers any new statuses sent via the $new_stati array on construct
49
+	 *
50
+	 * @access protected
51
+	 * @param  array $new_stati statuses
52
+	 * @return void
53
+	 */
54
+	protected function _register_new_stati($new_stati)
55
+	{
56
+
57
+		foreach ((array)$new_stati as $status_key => $status_args) {
58
+			$args = array(
59
+				'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
60
+				'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
61
+				'exclude_from_search'       => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : false,
62
+				'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : false,
63
+				'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : true,
64
+				'label_count'               => isset($status_args['label_count']) ? $status_args['label_count'] : '',
65
+			);
66
+			register_post_status($status_key, $status_args);
67
+		}
68
+
69
+	}
70
+
71
+
72
+	/**
73
+	 * This sets the _allowed_enum_values property using the $wp_post_stati array
74
+	 *
75
+	 * @access protected
76
+	 * @regurn void
77
+	 */
78
+	protected function _set_allowed_enum_values()
79
+	{
80
+		//first let's get the post_statuses
81
+		global $wp_post_statuses;
82
+		$this->_wp_post_stati = $wp_post_statuses;
83
+
84
+		foreach ($this->_wp_post_stati as $post_status => $args_object) {
85
+			$this->_allowed_enum_values[$post_status] = $args_object->label;
86
+		}
87
+
88
+	}
89
+
90
+	/**
91
+	 * Before calling parent, first double-checks our list of acceptable post
92
+	 * types is up-to-date
93
+	 *
94
+	 * @param string $value_inputted_for_field_on_model_object
95
+	 * @return string
96
+	 */
97
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
98
+	{
99
+		$this->_set_allowed_enum_values();
100
+		return parent::prepare_for_set($value_inputted_for_field_on_model_object);
101
+	}
102
+
103
+
104
+
105
+	//helper methods for getting various $wp_post_statuses stuff.
106
+
107
+	/**
108
+	 * This just returns the status object for the given status
109
+	 *
110
+	 * @access public
111
+	 * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
112
+	 * @param  string $status What status object you want
113
+	 * @return std_object         the status object or FALSE if it doesn't exist.
114
+	 */
115
+	public function get_status_object($status)
116
+	{
117
+		return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : false;
118
+	}
119 119
 }
120 120
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php
2
-require_once(EE_MODELS . 'fields/EE_Enum_Text_Field.php');
2
+require_once(EE_MODELS.'fields/EE_Enum_Text_Field.php');
3 3
 
4 4
 class EE_WP_Post_Status_Field extends EE_Enum_Text_Field
5 5
 {
@@ -54,7 +54,7 @@  discard block
 block discarded – undo
54 54
     protected function _register_new_stati($new_stati)
55 55
     {
56 56
 
57
-        foreach ((array)$new_stati as $status_key => $status_args) {
57
+        foreach ((array) $new_stati as $status_key => $status_args) {
58 58
             $args = array(
59 59
                 'label'                     => isset($status_args['label']) ? $status_args['label'] : $status_key,
60 60
                 'public'                    => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : true,
Please login to merge, or discard this patch.
core/db_models/fields/EE_Foreign_Key_String_Field.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@
 block discarded – undo
1 1
 <?php
2
-require_once(EE_MODELS . 'fields/EE_Foreign_Key_Field_Base.php');
2
+require_once(EE_MODELS.'fields/EE_Foreign_Key_Field_Base.php');
3 3
 
4 4
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
5 5
 {
Please login to merge, or discard this patch.
Indentation   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -4,17 +4,17 @@
 block discarded – undo
4 4
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
5 5
 {
6 6
 
7
-    /**
8
-     * removes all tags when setting
9
-     *
10
-     * @param string $value_inputted_for_field_on_model_object
11
-     * @return string
12
-     */
13
-    function prepare_for_set($value_inputted_for_field_on_model_object)
14
-    {
15
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
16
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
17
-        }
18
-        return strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
19
-    }
7
+	/**
8
+	 * removes all tags when setting
9
+	 *
10
+	 * @param string $value_inputted_for_field_on_model_object
11
+	 * @return string
12
+	 */
13
+	function prepare_for_set($value_inputted_for_field_on_model_object)
14
+	{
15
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
16
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
17
+		}
18
+		return strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
19
+	}
20 20
 }
21 21
\ No newline at end of file
Please login to merge, or discard this patch.