Completed
Branch FET-Wait-List (0505e1)
by
unknown
115:44 queued 105:19
created
espresso.php 1 patch
Indentation   +219 added lines, -219 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('ABSPATH')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 /*
5 5
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@  discard block
 block discarded – undo
40 40
  * @since            4.0
41 41
  */
42 42
 if (function_exists('espresso_version')) {
43
-    /**
44
-     *    espresso_duplicate_plugin_error
45
-     *    displays if more than one version of EE is activated at the same time
46
-     */
47
-    function espresso_duplicate_plugin_error()
48
-    {
49
-        ?>
43
+	/**
44
+	 *    espresso_duplicate_plugin_error
45
+	 *    displays if more than one version of EE is activated at the same time
46
+	 */
47
+	function espresso_duplicate_plugin_error()
48
+	{
49
+		?>
50 50
         <div class="error">
51 51
             <p>
52 52
                 <?php echo esc_html__(
53
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
-                        'event_espresso'
55
-                ); ?>
53
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
+						'event_espresso'
55
+				); ?>
56 56
             </p>
57 57
         </div>
58 58
         <?php
59
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
60
-    }
59
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
60
+	}
61 61
 
62
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
62
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
63 63
 } else {
64
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
65
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
-        /**
67
-         * espresso_minimum_php_version_error
68
-         *
69
-         * @return void
70
-         */
71
-        function espresso_minimum_php_version_error()
72
-        {
73
-            ?>
64
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
65
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
+		/**
67
+		 * espresso_minimum_php_version_error
68
+		 *
69
+		 * @return void
70
+		 */
71
+		function espresso_minimum_php_version_error()
72
+		{
73
+			?>
74 74
             <div class="error">
75 75
                 <p>
76 76
                     <?php
77
-                    printf(
78
-                            esc_html__(
79
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
-                                    'event_espresso'
81
-                            ),
82
-                            EE_MIN_PHP_VER_REQUIRED,
83
-                            PHP_VERSION,
84
-                            '<br/>',
85
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
-                    );
87
-                    ?>
77
+					printf(
78
+							esc_html__(
79
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
+									'event_espresso'
81
+							),
82
+							EE_MIN_PHP_VER_REQUIRED,
83
+							PHP_VERSION,
84
+							'<br/>',
85
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
+					);
87
+					?>
88 88
                 </p>
89 89
             </div>
90 90
             <?php
91
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
92
-        }
91
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
92
+		}
93 93
 
94
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
-    } else {
96
-        /**
97
-         * espresso_version
98
-         * Returns the plugin version
99
-         *
100
-         * @return string
101
-         */
102
-        function espresso_version()
103
-        {
104
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.46.rc.067');
105
-        }
94
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
+	} else {
96
+		/**
97
+		 * espresso_version
98
+		 * Returns the plugin version
99
+		 *
100
+		 * @return string
101
+		 */
102
+		function espresso_version()
103
+		{
104
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.46.rc.067');
105
+		}
106 106
 
107
-        // define versions
108
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
109
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
110
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
111
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
112
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
113
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
114
-        if ( ! defined('DS')) {
115
-            define('DS', '/');
116
-        }
117
-        if ( ! defined('PS')) {
118
-            define('PS', PATH_SEPARATOR);
119
-        }
120
-        if ( ! defined('SP')) {
121
-            define('SP', ' ');
122
-        }
123
-        if ( ! defined('EENL')) {
124
-            define('EENL', "\n");
125
-        }
126
-        define('EE_SUPPORT_EMAIL', '[email protected]');
127
-        // define the plugin directory and URL
128
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
129
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
130
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
131
-        // main root folder paths
132
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
133
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
134
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
135
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
136
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
137
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
138
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
139
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
140
-        // core system paths
141
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
142
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
143
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
144
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
145
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
146
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
147
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
148
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
149
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
150
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
151
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
152
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
153
-        // gateways
154
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
155
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
156
-        // asset URL paths
157
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
158
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
159
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
160
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
161
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
162
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
163
-        // define upload paths
164
-        $uploads = wp_upload_dir();
165
-        // define the uploads directory and URL
166
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
167
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
168
-        // define the templates directory and URL
169
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
170
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
171
-        // define the gateway directory and URL
172
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
173
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
174
-        // languages folder/path
175
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
176
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
177
-        //check for dompdf fonts in uploads
178
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
179
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
180
-        }
181
-        //ajax constants
182
-        define(
183
-                'EE_FRONT_AJAX',
184
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
185
-        );
186
-        define(
187
-                'EE_ADMIN_AJAX',
188
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
189
-        );
190
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
191
-        //you're better to use this than its straight value (currently -1) in case you ever
192
-        //want to change its default value! or find when -1 means infinity
193
-        define('EE_INF_IN_DB', -1);
194
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
195
-        define('EE_DEBUG', false);
196
-        // for older WP versions
197
-        if ( ! defined('MONTH_IN_SECONDS')) {
198
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
199
-        }
200
-        /**
201
-         *    espresso_plugin_activation
202
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
203
-         */
204
-        function espresso_plugin_activation()
205
-        {
206
-            update_option('ee_espresso_activation', true);
207
-        }
107
+		// define versions
108
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
109
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
110
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
111
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
112
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
113
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
114
+		if ( ! defined('DS')) {
115
+			define('DS', '/');
116
+		}
117
+		if ( ! defined('PS')) {
118
+			define('PS', PATH_SEPARATOR);
119
+		}
120
+		if ( ! defined('SP')) {
121
+			define('SP', ' ');
122
+		}
123
+		if ( ! defined('EENL')) {
124
+			define('EENL', "\n");
125
+		}
126
+		define('EE_SUPPORT_EMAIL', '[email protected]');
127
+		// define the plugin directory and URL
128
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
129
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
130
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
131
+		// main root folder paths
132
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
133
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
134
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
135
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
136
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
137
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
138
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
139
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
140
+		// core system paths
141
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
142
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
143
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
144
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
145
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
146
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
147
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
148
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
149
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
150
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
151
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
152
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
153
+		// gateways
154
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
155
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
156
+		// asset URL paths
157
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
158
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
159
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
160
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
161
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
162
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
163
+		// define upload paths
164
+		$uploads = wp_upload_dir();
165
+		// define the uploads directory and URL
166
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
167
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
168
+		// define the templates directory and URL
169
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
170
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
171
+		// define the gateway directory and URL
172
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
173
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
174
+		// languages folder/path
175
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
176
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
177
+		//check for dompdf fonts in uploads
178
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
179
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
180
+		}
181
+		//ajax constants
182
+		define(
183
+				'EE_FRONT_AJAX',
184
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
185
+		);
186
+		define(
187
+				'EE_ADMIN_AJAX',
188
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
189
+		);
190
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
191
+		//you're better to use this than its straight value (currently -1) in case you ever
192
+		//want to change its default value! or find when -1 means infinity
193
+		define('EE_INF_IN_DB', -1);
194
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
195
+		define('EE_DEBUG', false);
196
+		// for older WP versions
197
+		if ( ! defined('MONTH_IN_SECONDS')) {
198
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
199
+		}
200
+		/**
201
+		 *    espresso_plugin_activation
202
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
203
+		 */
204
+		function espresso_plugin_activation()
205
+		{
206
+			update_option('ee_espresso_activation', true);
207
+		}
208 208
 
209
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
210
-        /**
211
-         *    espresso_load_error_handling
212
-         *    this function loads EE's class for handling exceptions and errors
213
-         */
214
-        function espresso_load_error_handling()
215
-        {
216
-            // load debugging tools
217
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
218
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
219
-                EEH_Debug_Tools::instance();
220
-            }
221
-            // load error handling
222
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
223
-                require_once(EE_CORE . 'EE_Error.core.php');
224
-            } else {
225
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
226
-            }
227
-        }
209
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
210
+		/**
211
+		 *    espresso_load_error_handling
212
+		 *    this function loads EE's class for handling exceptions and errors
213
+		 */
214
+		function espresso_load_error_handling()
215
+		{
216
+			// load debugging tools
217
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
218
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
219
+				EEH_Debug_Tools::instance();
220
+			}
221
+			// load error handling
222
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
223
+				require_once(EE_CORE . 'EE_Error.core.php');
224
+			} else {
225
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
226
+			}
227
+		}
228 228
 
229
-        /**
230
-         *    espresso_load_required
231
-         *    given a class name and path, this function will load that file or throw an exception
232
-         *
233
-         * @param    string $classname
234
-         * @param    string $full_path_to_file
235
-         * @throws    EE_Error
236
-         */
237
-        function espresso_load_required($classname, $full_path_to_file)
238
-        {
239
-            static $error_handling_loaded = false;
240
-            if ( ! $error_handling_loaded) {
241
-                espresso_load_error_handling();
242
-                $error_handling_loaded = true;
243
-            }
244
-            if (is_readable($full_path_to_file)) {
245
-                require_once($full_path_to_file);
246
-            } else {
247
-                throw new EE_Error (
248
-                        sprintf(
249
-                                esc_html__(
250
-                                        'The %s class file could not be located or is not readable due to file permissions.',
251
-                                        'event_espresso'
252
-                                ),
253
-                                $classname
254
-                        )
255
-                );
256
-            }
257
-        }
229
+		/**
230
+		 *    espresso_load_required
231
+		 *    given a class name and path, this function will load that file or throw an exception
232
+		 *
233
+		 * @param    string $classname
234
+		 * @param    string $full_path_to_file
235
+		 * @throws    EE_Error
236
+		 */
237
+		function espresso_load_required($classname, $full_path_to_file)
238
+		{
239
+			static $error_handling_loaded = false;
240
+			if ( ! $error_handling_loaded) {
241
+				espresso_load_error_handling();
242
+				$error_handling_loaded = true;
243
+			}
244
+			if (is_readable($full_path_to_file)) {
245
+				require_once($full_path_to_file);
246
+			} else {
247
+				throw new EE_Error (
248
+						sprintf(
249
+								esc_html__(
250
+										'The %s class file could not be located or is not readable due to file permissions.',
251
+										'event_espresso'
252
+								),
253
+								$classname
254
+						)
255
+				);
256
+			}
257
+		}
258 258
 
259
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
260
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
261
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
262
-        new EE_Bootstrap();
263
-    }
259
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
260
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
261
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
262
+		new EE_Bootstrap();
263
+	}
264 264
 }
265 265
 if ( ! function_exists('espresso_deactivate_plugin')) {
266
-    /**
267
-     *    deactivate_plugin
268
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
269
-     *
270
-     * @access public
271
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
272
-     * @return    void
273
-     */
274
-    function espresso_deactivate_plugin($plugin_basename = '')
275
-    {
276
-        if ( ! function_exists('deactivate_plugins')) {
277
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
278
-        }
279
-        unset($_GET['activate'], $_REQUEST['activate']);
280
-        deactivate_plugins($plugin_basename);
281
-    }
266
+	/**
267
+	 *    deactivate_plugin
268
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
269
+	 *
270
+	 * @access public
271
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
272
+	 * @return    void
273
+	 */
274
+	function espresso_deactivate_plugin($plugin_basename = '')
275
+	{
276
+		if ( ! function_exists('deactivate_plugins')) {
277
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
278
+		}
279
+		unset($_GET['activate'], $_REQUEST['activate']);
280
+		deactivate_plugins($plugin_basename);
281
+	}
282 282
 }
283 283
\ No newline at end of file
Please login to merge, or discard this patch.
core/db_models/EEM_Event.model.php 2 patches
Indentation   +784 added lines, -784 removed lines patch added patch discarded remove patch
@@ -1,7 +1,7 @@  discard block
 block discarded – undo
1 1
 <?php use EventEspresso\core\services\orm\ModelFieldFactory;
2 2
 
3 3
 if (! defined('EVENT_ESPRESSO_VERSION')) {
4
-    exit('No direct script access allowed');
4
+	exit('No direct script access allowed');
5 5
 }
6 6
 require_once(EE_MODELS . 'EEM_CPT_Base.model.php');
7 7
 
@@ -18,789 +18,789 @@  discard block
 block discarded – undo
18 18
 class EEM_Event extends EEM_CPT_Base
19 19
 {
20 20
 
21
-    /**
22
-     * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
23
-     * event
24
-     */
25
-    const sold_out = 'sold_out';
26
-
27
-    /**
28
-     * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
29
-     * date)
30
-     */
31
-    const postponed = 'postponed';
32
-
33
-    /**
34
-     * constant used by status(), indicating that the event will no longer occur
35
-     */
36
-    const cancelled = 'cancelled';
37
-
38
-
39
-    /**
40
-     * @var string
41
-     */
42
-    protected static $_default_reg_status;
43
-
44
-
45
-    /**
46
-     * This is the default for the additional limit field.
47
-     * @var int
48
-     */
49
-    protected static $_default_additional_limit = 10;
50
-
51
-
52
-    /**
53
-     * private instance of the Event object
54
-     *
55
-     * @var EEM_Event
56
-     */
57
-    protected static $_instance;
58
-
59
-
60
-
61
-
62
-    /**
63
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
64
-     *
65
-     * @param string $timezone
66
-     * @throws \EE_Error
67
-     */
68
-    protected function __construct($timezone = null)
69
-    {
70
-        EE_Registry::instance()->load_model('Registration');
71
-        $this->singular_item = esc_html__('Event', 'event_espresso');
72
-        $this->plural_item = esc_html__('Events', 'event_espresso');
73
-        // to remove Cancelled events from the frontend, copy the following filter to your functions.php file
74
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
75
-        // to remove Postponed events from the frontend, copy the following filter to your functions.php file
76
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
77
-        // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
78
-        //	add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
79
-        $this->_custom_stati = apply_filters(
80
-            'AFEE__EEM_Event__construct___custom_stati',
81
-            array(
82
-                EEM_Event::cancelled => array(
83
-                    'label'  => esc_html__('Cancelled', 'event_espresso'),
84
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
85
-                ),
86
-                EEM_Event::postponed => array(
87
-                    'label'  => esc_html__('Postponed', 'event_espresso'),
88
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
89
-                ),
90
-                EEM_Event::sold_out  => array(
91
-                    'label'  => esc_html__('Sold Out', 'event_espresso'),
92
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
93
-                ),
94
-            )
95
-        );
96
-        self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
97
-            : self::$_default_reg_status;
98
-        $this->_tables = array(
99
-            'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
100
-            'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
101
-        );
102
-        $this->_fields = array(
103
-            'Event_CPT'  => array(
104
-                'EVT_ID'         => new EE_Primary_Key_Int_Field('ID',
105
-                    esc_html__('Post ID for Event', 'event_espresso')),
106
-                'EVT_name'       => new EE_Plain_Text_Field('post_title', esc_html__('Event Name', 'event_espresso'),
107
-                    false,
108
-                    ''),
109
-                'EVT_desc'       => new EE_Post_Content_Field('post_content',
110
-                    esc_html__('Event Description', 'event_espresso'),
111
-                    false, ''),
112
-                'EVT_slug'       => new EE_Slug_Field('post_name', esc_html__('Event Slug', 'event_espresso'), false,
113
-                    ''),
114
-                'EVT_created'    => new EE_Datetime_Field('post_date',
115
-                    esc_html__('Date/Time Event Created', 'event_espresso'),
116
-                    false, EE_Datetime_Field::now),
117
-                'EVT_short_desc' => new EE_Simple_HTML_Field('post_excerpt',
118
-                    esc_html__('Event Short Description', 'event_espresso'), false, ''),
119
-                'EVT_modified'   => new EE_Datetime_Field('post_modified',
120
-                    esc_html__('Date/Time Event Modified', 'event_espresso'), false, EE_Datetime_Field::now),
121
-                'EVT_wp_user'    => new EE_WP_User_Field('post_author',
122
-                    esc_html__('Event Creator ID', 'event_espresso'),
123
-                    false),
124
-                'parent'         => new EE_Integer_Field('post_parent', esc_html__('Event Parent ID', 'event_espresso'),
125
-                    false,
126
-                    0),
127
-                'EVT_order'      => new EE_Integer_Field('menu_order', esc_html__('Event Menu Order', 'event_espresso'),
128
-                    false,
129
-                    1),
130
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
131
-                // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
132
-                'status'         => new EE_WP_Post_Status_Field('post_status',
133
-                    esc_html__('Event Status', 'event_espresso'),
134
-                    false, 'draft', $this->_custom_stati),
135
-            ),
136
-            'Event_Meta' => array(
137
-                'EVTM_ID'                         => new EE_DB_Only_Float_Field('EVTM_ID',
138
-                    esc_html__('Event Meta Row ID', 'event_espresso'), false),
139
-                'EVT_ID_fk'                       => new EE_DB_Only_Int_Field('EVT_ID',
140
-                    esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), false),
141
-                'EVT_display_desc'                => new EE_Boolean_Field('EVT_display_desc',
142
-                    esc_html__('Display Description Flag', 'event_espresso'), false, 1),
143
-                'EVT_display_ticket_selector'     => new EE_Boolean_Field('EVT_display_ticket_selector',
144
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso'), false, 1),
145
-                'EVT_visible_on'                  => new EE_Datetime_Field('EVT_visible_on',
146
-                    esc_html__('Event Visible Date', 'event_espresso'), true, EE_Datetime_Field::now),
147
-                'EVT_additional_limit'            => new EE_Integer_Field(
148
-                    'EVT_additional_limit',
149
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
150
-                    true,
151
-                    self::$_default_additional_limit
152
-                ),
153
-                'EVT_default_registration_status' => new EE_Enum_Text_Field(
154
-                    'EVT_default_registration_status',
155
-                    esc_html__('Default Registration Status on this Event', 'event_espresso'), false,
156
-                    EEM_Event::$_default_reg_status, EEM_Registration::reg_status_array()
157
-                ),
158
-                'EVT_member_only'                 => new EE_Boolean_Field('EVT_member_only',
159
-                    esc_html__('Member-Only Event Flag', 'event_espresso'), false, false),
160
-                'EVT_phone'                       => new EE_Plain_Text_Field('EVT_phone',
161
-                    esc_html__('Event Phone Number', 'event_espresso'), false,''),
162
-                'EVT_allow_overflow'              => new EE_Boolean_Field('EVT_allow_overflow',
163
-                    esc_html__('Allow Overflow on Event', 'event_espresso'), false, false),
164
-                'EVT_timezone_string'             => new EE_Plain_Text_Field('EVT_timezone_string',
165
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'), false,''),
166
-                'EVT_external_URL'                => new EE_Plain_Text_Field('EVT_external_URL',
167
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true),
168
-                'EVT_donations'                   => new EE_Boolean_Field('EVT_donations',
169
-                    esc_html__('Accept Donations?', 'event_espresso'), false, false),
170
-            ),
171
-        );
172
-        $this->_model_relations = array(
173
-            'Registration'           => new EE_Has_Many_Relation(),
174
-            'Datetime'               => new EE_Has_Many_Relation(),
175
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
176
-            'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
177
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
178
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
179
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
180
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
181
-            'WP_User'                => new EE_Belongs_To_Relation(),
182
-        );
183
-        //this model is generally available for reading
184
-        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
185
-        parent::__construct($timezone);
186
-    }
187
-
188
-
189
-
190
-    /**
191
-     * @param string $default_reg_status
192
-     */
193
-    public static function set_default_reg_status($default_reg_status)
194
-    {
195
-        self::$_default_reg_status = $default_reg_status;
196
-        // if EEM_Event has already been instantiated,
197
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
198
-        if (self::$_instance instanceof EEM_Event) {
199
-            $default_reg_status = new EE_Enum_Text_Field(
200
-                'EVT_default_registration_status',
201
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
202
-                false,
203
-                $default_reg_status,
204
-                EEM_Registration::reg_status_array()
205
-            );
206
-            $default_reg_status->_construct_finalize(
207
-                'Event_Meta',
208
-                'EVT_default_registration_status',
209
-                'EEM_Event'
210
-            );
211
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
212
-        }
213
-    }
214
-
215
-
216
-    /**
217
-     * Used to override the default for the additional limit field.
218
-     * @param $additional_limit
219
-     */
220
-    public static function set_default_additional_limit($additional_limit)
221
-    {
222
-        self::$_default_additional_limit = (int) $additional_limit;
223
-        if (self::$_instance instanceof EEM_Event) {
224
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
225
-                'EVT_additional_limit',
226
-                __('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
227
-                true,
228
-                self::$_default_additional_limit
229
-            );
230
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
231
-                'Event_Meta',
232
-                'EVT_additional_limit',
233
-                'EEM_Event'
234
-            );
235
-        }
236
-    }
237
-
238
-
239
-    /**
240
-     * Return what is currently set as the default additional limit for the event.
241
-     * @return int
242
-     */
243
-    public static function get_default_additional_limit()
244
-    {
245
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
246
-    }
247
-
248
-
249
-    /**
250
-     * get_question_groups
251
-     *
252
-     * @return array
253
-     * @throws \EE_Error
254
-     */
255
-    public function get_all_question_groups()
256
-    {
257
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
258
-            array(
259
-                array('QSG_deleted' => false),
260
-                'order_by' => array('QSG_order' => 'ASC'),
261
-            )
262
-        );
263
-    }
264
-
265
-
266
-
267
-    /**
268
-     * get_question_groups
269
-     *
270
-     * @param int $EVT_ID
271
-     * @return array|bool
272
-     * @throws \EE_Error
273
-     */
274
-    public function get_all_event_question_groups($EVT_ID = 0)
275
-    {
276
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
277
-            EE_Error::add_error(
278
-                esc_html__(
279
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
280
-                    'event_espresso'
281
-                ),
282
-                __FILE__, __FUNCTION__, __LINE__
283
-            );
284
-            return false;
285
-        }
286
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
287
-            array(
288
-                array('EVT_ID' => $EVT_ID),
289
-            )
290
-        );
291
-    }
292
-
293
-
294
-
295
-    /**
296
-     * get_question_groups
297
-     *
298
-     * @param int     $EVT_ID
299
-     * @param boolean $for_primary_attendee
300
-     * @return array|bool
301
-     * @throws \EE_Error
302
-     */
303
-    public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
304
-    {
305
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
306
-            EE_Error::add_error(
307
-                esc_html__(
308
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
309
-                    'event_espresso'
310
-                ),
311
-                __FILE__, __FUNCTION__, __LINE__
312
-            );
313
-            return false;
314
-        }
315
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
316
-            array(
317
-                array(
318
-                    'EVT_ID'      => $EVT_ID,
319
-                    'EQG_primary' => $for_primary_attendee,
320
-                ),
321
-            )
322
-        );
323
-    }
324
-
325
-
326
-
327
-    /**
328
-     * get_question_groups
329
-     *
330
-     * @param int             $EVT_ID
331
-     * @param EE_Registration $registration
332
-     * @return array|bool
333
-     * @throws \EE_Error
334
-     */
335
-    public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
336
-    {
337
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
338
-            EE_Error::add_error(
339
-                esc_html__(
340
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
341
-                    'event_espresso'
342
-                ),
343
-                __FILE__, __FUNCTION__, __LINE__
344
-            );
345
-            return false;
346
-        }
347
-        $where_params = array(
348
-            'Event_Question_Group.EVT_ID'      => $EVT_ID,
349
-            'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
350
-            'QSG_deleted'                      => false,
351
-        );
352
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
353
-            array(
354
-                $where_params,
355
-                'order_by' => array('QSG_order' => 'ASC'),
356
-            )
357
-        );
358
-    }
359
-
360
-
361
-
362
-    /**
363
-     * get_question_target_db_column
364
-     *
365
-     * @param string $QSG_IDs csv list of $QSG IDs
366
-     * @return array|bool
367
-     * @throws \EE_Error
368
-     */
369
-    public function get_questions_in_groups($QSG_IDs = '')
370
-    {
371
-        if (empty($QSG_IDs)) {
372
-            EE_Error::add_error(
373
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
374
-                __FILE__, __FUNCTION__, __LINE__
375
-            );
376
-            return false;
377
-        }
378
-        return EE_Registry::instance()->load_model('Question')->get_all(
379
-            array(
380
-                array(
381
-                    'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
382
-                    'QST_deleted'           => false,
383
-                    'QST_admin_only'        => is_admin(),
384
-                ),
385
-                'order_by' => 'QST_order',
386
-            )
387
-        );
388
-    }
389
-
390
-
391
-
392
-    /**
393
-     * get_options_for_question
394
-     *
395
-     * @param string $QST_IDs csv list of $QST IDs
396
-     * @return array|bool
397
-     * @throws \EE_Error
398
-     */
399
-    public function get_options_for_question($QST_IDs)
400
-    {
401
-        if (empty($QST_IDs)) {
402
-            EE_Error::add_error(
403
-                esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
404
-                __FILE__, __FUNCTION__, __LINE__
405
-            );
406
-            return false;
407
-        }
408
-        return EE_Registry::instance()->load_model('Question_Option')->get_all(
409
-            array(
410
-                array(
411
-                    'Question.QST_ID' => array('IN', $QST_IDs),
412
-                    'QSO_deleted'     => false,
413
-                ),
414
-                'order_by' => 'QSO_ID',
415
-            )
416
-        );
417
-    }
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-    /**
426
-     * Gets all events that are published
427
-     * and have event start time earlier than now and an event end time later than now
428
-     *
429
-     * @param  array $query_params An array of query params to further filter on
430
-     *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
431
-     * @param bool   $count        whether to return the count or not (default FALSE)
432
-     * @return EE_Event[]|int
433
-     * @throws \EE_Error
434
-     */
435
-    public function get_active_events($query_params, $count = false)
436
-    {
437
-        if (array_key_exists(0, $query_params)) {
438
-            $where_params = $query_params[0];
439
-            unset($query_params[0]);
440
-        } else {
441
-            $where_params = array();
442
-        }
443
-        // if we have count make sure we don't include group by
444
-        if ($count && isset($query_params['group_by'])) {
445
-            unset($query_params['group_by']);
446
-        }
447
-        // let's add specific query_params for active_events
448
-        // keep in mind this will override any sent status in the query AND any date queries.
449
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
450
-        //if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
451
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
452
-            $where_params['Datetime.DTT_EVT_start******'] = array(
453
-                '<',
454
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
455
-            );
456
-        } else {
457
-            $where_params['Datetime.DTT_EVT_start'] = array(
458
-                '<',
459
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
460
-            );
461
-        }
462
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
463
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
464
-                '>',
465
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
466
-            );
467
-        } else {
468
-            $where_params['Datetime.DTT_EVT_end'] = array(
469
-                '>',
470
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
471
-            );
472
-        }
473
-        $query_params[0] = $where_params;
474
-        // don't use $query_params with count()
475
-        // because we don't want to include additional query clauses like "GROUP BY"
476
-        return $count
477
-            ? $this->count(array($where_params), 'EVT_ID', true)
478
-            : $this->get_all($query_params);
479
-    }
480
-
481
-
482
-
483
-    /**
484
-     * get all events that are published and have an event start time later than now
485
-     *
486
-     * @param  array $query_params An array of query params to further filter on
487
-     *                             (Note that status and DTT_EVT_start will be overridden)
488
-     * @param bool   $count        whether to return the count or not (default FALSE)
489
-     * @return EE_Event[]|int
490
-     * @throws \EE_Error
491
-     */
492
-    public function get_upcoming_events($query_params, $count = false)
493
-    {
494
-        if (array_key_exists(0, $query_params)) {
495
-            $where_params = $query_params[0];
496
-            unset($query_params[0]);
497
-        } else {
498
-            $where_params = array();
499
-        }
500
-        // if we have count make sure we don't include group by
501
-        if ($count && isset($query_params['group_by'])) {
502
-            unset($query_params['group_by']);
503
-        }
504
-        // let's add specific query_params for active_events
505
-        // keep in mind this will override any sent status in the query AND any date queries.
506
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
507
-        // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
508
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
509
-            $where_params['Datetime.DTT_EVT_start*****'] = array(
510
-                '>',
511
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
512
-            );
513
-        } else {
514
-            $where_params['Datetime.DTT_EVT_start'] = array(
515
-                '>',
516
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
517
-            );
518
-        }
519
-        $query_params[0] = $where_params;
520
-        // don't use $query_params with count()
521
-        // because we don't want to include additional query clauses like "GROUP BY"
522
-        return $count
523
-            ? $this->count(array($where_params), 'EVT_ID', true)
524
-            : $this->get_all($query_params);
525
-    }
526
-
527
-
528
-
529
-    /**
530
-     * Gets all events that are published
531
-     * and have an event end time later than now
532
-     *
533
-     * @param  array $query_params An array of query params to further filter on
534
-     *                             (note that status and DTT_EVT_end will be overridden)
535
-     * @param bool   $count        whether to return the count or not (default FALSE)
536
-     * @return EE_Event[]|int
537
-     * @throws \EE_Error
538
-     */
539
-    public function get_active_and_upcoming_events($query_params, $count = false)
540
-    {
541
-        if (array_key_exists(0, $query_params)) {
542
-            $where_params = $query_params[0];
543
-            unset($query_params[0]);
544
-        } else {
545
-            $where_params = array();
546
-        }
547
-        // if we have count make sure we don't include group by
548
-        if ($count && isset($query_params['group_by'])) {
549
-            unset($query_params['group_by']);
550
-        }
551
-        // let's add specific query_params for active_events
552
-        // keep in mind this will override any sent status in the query AND any date queries.
553
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
554
-        // add where params for DTT_EVT_end
555
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
556
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
557
-                '>',
558
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
559
-            );
560
-        } else {
561
-            $where_params['Datetime.DTT_EVT_end'] = array(
562
-                '>',
563
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
564
-            );
565
-        }
566
-        $query_params[0] = $where_params;
567
-        // don't use $query_params with count()
568
-        // because we don't want to include additional query clauses like "GROUP BY"
569
-        return $count
570
-            ? $this->count(array($where_params), 'EVT_ID', true)
571
-            : $this->get_all($query_params);
572
-    }
573
-
574
-
575
-
576
-    /**
577
-     * This only returns events that are expired.
578
-     * They may still be published but all their datetimes have expired.
579
-     *
580
-     * @param  array $query_params An array of query params to further filter on
581
-     *                             (note that status and DTT_EVT_end will be overridden)
582
-     * @param bool   $count        whether to return the count or not (default FALSE)
583
-     * @return EE_Event[]|int
584
-     * @throws \EE_Error
585
-     */
586
-    public function get_expired_events($query_params, $count = false)
587
-    {
588
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
589
-        // if we have count make sure we don't include group by
590
-        if ($count && isset($query_params['group_by'])) {
591
-            unset($query_params['group_by']);
592
-        }
593
-        // let's add specific query_params for active_events
594
-        // keep in mind this will override any sent status in the query AND any date queries.
595
-        if (isset($where_params['status'])) {
596
-            unset($where_params['status']);
597
-        }
598
-        $exclude_query = $query_params;
599
-        if (isset($exclude_query[0])) {
600
-            unset($exclude_query[0]);
601
-        }
602
-        $exclude_query[0] = array(
603
-            'Datetime.DTT_EVT_end' => array(
604
-                '>',
605
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
606
-            ),
607
-        );
608
-        // first get all events that have datetimes where its not expired.
609
-        $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
610
-        $event_ids = array_keys($event_ids);
611
-        // if we have any additional query_params, let's add them to the 'AND' condition
612
-        $and_condition = array(
613
-            'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
614
-            'EVT_ID'               => array('NOT IN', $event_ids),
615
-        );
616
-        if (isset($where_params['OR'])) {
617
-            $and_condition['OR'] = $where_params['OR'];
618
-            unset($where_params['OR']);
619
-        }
620
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
621
-            $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
622
-            unset($where_params['Datetime.DTT_EVT_end']);
623
-        }
624
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
625
-            $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
626
-            unset($where_params['Datetime.DTT_EVT_start']);
627
-        }
628
-        // merge remaining $where params with the and conditions.
629
-        $where_params['AND'] = array_merge($and_condition, $where_params);
630
-        $query_params[0] = $where_params;
631
-        // don't use $query_params with count()
632
-        // because we don't want to include additional query clauses like "GROUP BY"
633
-        return $count
634
-            ? $this->count(array($where_params), 'EVT_ID', true)
635
-            : $this->get_all($query_params);
636
-    }
637
-
638
-
639
-
640
-    /**
641
-     * This basically just returns the events that do not have the publish status.
642
-     *
643
-     * @param  array   $query_params An array of query params to further filter on
644
-     *                               (note that status will be overwritten)
645
-     * @param  boolean $count        whether to return the count or not (default FALSE)
646
-     * @return EE_Event[]|int
647
-     * @throws \EE_Error
648
-     */
649
-    public function get_inactive_events($query_params, $count = false)
650
-    {
651
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
652
-        // let's add in specific query_params for inactive events.
653
-        if (isset($where_params['status'])) {
654
-            unset($where_params['status']);
655
-        }
656
-        // if we have count make sure we don't include group by
657
-        if ($count && isset($query_params['group_by'])) {
658
-            unset($query_params['group_by']);
659
-        }
660
-        // if we have any additional query_params, let's add them to the 'AND' condition
661
-        $where_params['AND']['status'] = array('!=', 'publish');
662
-        if (isset($where_params['OR'])) {
663
-            $where_params['AND']['OR'] = $where_params['OR'];
664
-            unset($where_params['OR']);
665
-        }
666
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
667
-            $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
668
-            unset($where_params['Datetime.DTT_EVT_end']);
669
-        }
670
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
671
-            $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
672
-            unset($where_params['Datetime.DTT_EVT_start']);
673
-        }
674
-        $query_params[0] = $where_params;
675
-        // don't use $query_params with count()
676
-        // because we don't want to include additional query clauses like "GROUP BY"
677
-        return $count
678
-            ? $this->count(array($where_params), 'EVT_ID', true)
679
-            : $this->get_all($query_params);
680
-    }
681
-
682
-
683
-
684
-    /**
685
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
686
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
687
-     * attached to the event. See parent for param descriptions
688
-     *
689
-     * @param        $id_or_obj
690
-     * @param        $other_model_id_or_obj
691
-     * @param string $relationName
692
-     * @param array  $where_query
693
-     * @return EE_Base_Class
694
-     * @throws EE_Error
695
-     */
696
-    public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
697
-    {
698
-        if ($relationName === 'Price') {
699
-            //let's get the PRC object for the given ID to make sure that we aren't dealing with a default
700
-            $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
701
-            //if EVT_ID = 0, then this is a default
702
-            if ((int) $prc_chk->get('EVT_ID') === 0) {
703
-                //let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
704
-                $prc_chk->set('PRC_ID', 0);
705
-            }
706
-            //run parent
707
-            return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
708
-        }
709
-        //otherwise carry on as normal
710
-        return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
711
-    }
712
-
713
-
714
-
715
-    /******************** DEPRECATED METHODS ********************/
716
-
717
-
718
-
719
-    /**
720
-     * _get_question_target_db_column
721
-     *
722
-     * @deprecated as of 4.8.32.rc.001. Instead consider using
723
-     *             EE_Registration_Custom_Questions_Form located in
724
-     *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
725
-     * @access     public
726
-     * @param    EE_Registration $registration (so existing answers for registration are included)
727
-     * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
728
-     *                                         registration).
729
-     * @throws EE_Error
730
-     * @return    array
731
-     */
732
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
733
-    {
734
-        if (empty($EVT_ID)) {
735
-            throw new EE_Error(__('An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
736
-                'event_espresso'));
737
-        }
738
-        $questions = array();
739
-        // get all question groups for event
740
-        $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
741
-        if (! empty($qgs)) {
742
-            foreach ($qgs as $qg) {
743
-                $qsts = $qg->questions();
744
-                $questions[$qg->ID()] = $qg->model_field_array();
745
-                $questions[$qg->ID()]['QSG_questions'] = array();
746
-                foreach ($qsts as $qst) {
747
-                    if ($qst->is_system_question()) {
748
-                        continue;
749
-                    }
750
-                    $answer = EEM_Answer::instance()->get_one(array(
751
-                        array(
752
-                            'QST_ID' => $qst->ID(),
753
-                            'REG_ID' => $registration->ID(),
754
-                        ),
755
-                    ));
756
-                    $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
757
-                    $qst_name = $qstn_id = $qst->ID();
758
-                    $ans_id = $answer->ID();
759
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
760
-                    $input_name = '';
761
-                    $input_id = sanitize_key($qst->display_text());
762
-                    $input_class = '';
763
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
764
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
765
-                                                                                           . $input_name
766
-                                                                                           . $qst_name;
767
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
768
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
769
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
770
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
771
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
772
-                    //leave responses as-is, don't convert stuff into html entities please!
773
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
774
-                    if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
775
-                        $QSOs = $qst->options(true, $answer->value());
776
-                        if (is_array($QSOs)) {
777
-                            foreach ($QSOs as $QSO_ID => $QSO) {
778
-                                $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
779
-                            }
780
-                        }
781
-                    }
782
-                }
783
-            }
784
-        }
785
-        return $questions;
786
-    }
787
-
788
-
789
-    /**
790
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
791
-     *                             or an stdClass where each property is the name of a column,
792
-     * @return EE_Base_Class
793
-     * @throws \EE_Error
794
-     */
795
-    public function instantiate_class_from_array_or_object($cols_n_values)
796
-    {
797
-        $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
798
-        if($classInstance instanceof EE_Event) {
799
-            //events have their timezone defined in the DB, so use it immediately
800
-            $this->set_timezone($classInstance->get_timezone());
801
-        }
802
-        return $classInstance;
803
-    }
21
+	/**
22
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
23
+	 * event
24
+	 */
25
+	const sold_out = 'sold_out';
26
+
27
+	/**
28
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
29
+	 * date)
30
+	 */
31
+	const postponed = 'postponed';
32
+
33
+	/**
34
+	 * constant used by status(), indicating that the event will no longer occur
35
+	 */
36
+	const cancelled = 'cancelled';
37
+
38
+
39
+	/**
40
+	 * @var string
41
+	 */
42
+	protected static $_default_reg_status;
43
+
44
+
45
+	/**
46
+	 * This is the default for the additional limit field.
47
+	 * @var int
48
+	 */
49
+	protected static $_default_additional_limit = 10;
50
+
51
+
52
+	/**
53
+	 * private instance of the Event object
54
+	 *
55
+	 * @var EEM_Event
56
+	 */
57
+	protected static $_instance;
58
+
59
+
60
+
61
+
62
+	/**
63
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
64
+	 *
65
+	 * @param string $timezone
66
+	 * @throws \EE_Error
67
+	 */
68
+	protected function __construct($timezone = null)
69
+	{
70
+		EE_Registry::instance()->load_model('Registration');
71
+		$this->singular_item = esc_html__('Event', 'event_espresso');
72
+		$this->plural_item = esc_html__('Events', 'event_espresso');
73
+		// to remove Cancelled events from the frontend, copy the following filter to your functions.php file
74
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
75
+		// to remove Postponed events from the frontend, copy the following filter to your functions.php file
76
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
77
+		// to remove Sold Out events from the frontend, copy the following filter to your functions.php file
78
+		//	add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
79
+		$this->_custom_stati = apply_filters(
80
+			'AFEE__EEM_Event__construct___custom_stati',
81
+			array(
82
+				EEM_Event::cancelled => array(
83
+					'label'  => esc_html__('Cancelled', 'event_espresso'),
84
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
85
+				),
86
+				EEM_Event::postponed => array(
87
+					'label'  => esc_html__('Postponed', 'event_espresso'),
88
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
89
+				),
90
+				EEM_Event::sold_out  => array(
91
+					'label'  => esc_html__('Sold Out', 'event_espresso'),
92
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
93
+				),
94
+			)
95
+		);
96
+		self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
97
+			: self::$_default_reg_status;
98
+		$this->_tables = array(
99
+			'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
100
+			'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
101
+		);
102
+		$this->_fields = array(
103
+			'Event_CPT'  => array(
104
+				'EVT_ID'         => new EE_Primary_Key_Int_Field('ID',
105
+					esc_html__('Post ID for Event', 'event_espresso')),
106
+				'EVT_name'       => new EE_Plain_Text_Field('post_title', esc_html__('Event Name', 'event_espresso'),
107
+					false,
108
+					''),
109
+				'EVT_desc'       => new EE_Post_Content_Field('post_content',
110
+					esc_html__('Event Description', 'event_espresso'),
111
+					false, ''),
112
+				'EVT_slug'       => new EE_Slug_Field('post_name', esc_html__('Event Slug', 'event_espresso'), false,
113
+					''),
114
+				'EVT_created'    => new EE_Datetime_Field('post_date',
115
+					esc_html__('Date/Time Event Created', 'event_espresso'),
116
+					false, EE_Datetime_Field::now),
117
+				'EVT_short_desc' => new EE_Simple_HTML_Field('post_excerpt',
118
+					esc_html__('Event Short Description', 'event_espresso'), false, ''),
119
+				'EVT_modified'   => new EE_Datetime_Field('post_modified',
120
+					esc_html__('Date/Time Event Modified', 'event_espresso'), false, EE_Datetime_Field::now),
121
+				'EVT_wp_user'    => new EE_WP_User_Field('post_author',
122
+					esc_html__('Event Creator ID', 'event_espresso'),
123
+					false),
124
+				'parent'         => new EE_Integer_Field('post_parent', esc_html__('Event Parent ID', 'event_espresso'),
125
+					false,
126
+					0),
127
+				'EVT_order'      => new EE_Integer_Field('menu_order', esc_html__('Event Menu Order', 'event_espresso'),
128
+					false,
129
+					1),
130
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
131
+				// EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
132
+				'status'         => new EE_WP_Post_Status_Field('post_status',
133
+					esc_html__('Event Status', 'event_espresso'),
134
+					false, 'draft', $this->_custom_stati),
135
+			),
136
+			'Event_Meta' => array(
137
+				'EVTM_ID'                         => new EE_DB_Only_Float_Field('EVTM_ID',
138
+					esc_html__('Event Meta Row ID', 'event_espresso'), false),
139
+				'EVT_ID_fk'                       => new EE_DB_Only_Int_Field('EVT_ID',
140
+					esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'), false),
141
+				'EVT_display_desc'                => new EE_Boolean_Field('EVT_display_desc',
142
+					esc_html__('Display Description Flag', 'event_espresso'), false, 1),
143
+				'EVT_display_ticket_selector'     => new EE_Boolean_Field('EVT_display_ticket_selector',
144
+					esc_html__('Display Ticket Selector Flag', 'event_espresso'), false, 1),
145
+				'EVT_visible_on'                  => new EE_Datetime_Field('EVT_visible_on',
146
+					esc_html__('Event Visible Date', 'event_espresso'), true, EE_Datetime_Field::now),
147
+				'EVT_additional_limit'            => new EE_Integer_Field(
148
+					'EVT_additional_limit',
149
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
150
+					true,
151
+					self::$_default_additional_limit
152
+				),
153
+				'EVT_default_registration_status' => new EE_Enum_Text_Field(
154
+					'EVT_default_registration_status',
155
+					esc_html__('Default Registration Status on this Event', 'event_espresso'), false,
156
+					EEM_Event::$_default_reg_status, EEM_Registration::reg_status_array()
157
+				),
158
+				'EVT_member_only'                 => new EE_Boolean_Field('EVT_member_only',
159
+					esc_html__('Member-Only Event Flag', 'event_espresso'), false, false),
160
+				'EVT_phone'                       => new EE_Plain_Text_Field('EVT_phone',
161
+					esc_html__('Event Phone Number', 'event_espresso'), false,''),
162
+				'EVT_allow_overflow'              => new EE_Boolean_Field('EVT_allow_overflow',
163
+					esc_html__('Allow Overflow on Event', 'event_espresso'), false, false),
164
+				'EVT_timezone_string'             => new EE_Plain_Text_Field('EVT_timezone_string',
165
+					esc_html__('Timezone (name) for Event times', 'event_espresso'), false,''),
166
+				'EVT_external_URL'                => new EE_Plain_Text_Field('EVT_external_URL',
167
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true),
168
+				'EVT_donations'                   => new EE_Boolean_Field('EVT_donations',
169
+					esc_html__('Accept Donations?', 'event_espresso'), false, false),
170
+			),
171
+		);
172
+		$this->_model_relations = array(
173
+			'Registration'           => new EE_Has_Many_Relation(),
174
+			'Datetime'               => new EE_Has_Many_Relation(),
175
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
176
+			'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
177
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
178
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
179
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
180
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
181
+			'WP_User'                => new EE_Belongs_To_Relation(),
182
+		);
183
+		//this model is generally available for reading
184
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
185
+		parent::__construct($timezone);
186
+	}
187
+
188
+
189
+
190
+	/**
191
+	 * @param string $default_reg_status
192
+	 */
193
+	public static function set_default_reg_status($default_reg_status)
194
+	{
195
+		self::$_default_reg_status = $default_reg_status;
196
+		// if EEM_Event has already been instantiated,
197
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
198
+		if (self::$_instance instanceof EEM_Event) {
199
+			$default_reg_status = new EE_Enum_Text_Field(
200
+				'EVT_default_registration_status',
201
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
202
+				false,
203
+				$default_reg_status,
204
+				EEM_Registration::reg_status_array()
205
+			);
206
+			$default_reg_status->_construct_finalize(
207
+				'Event_Meta',
208
+				'EVT_default_registration_status',
209
+				'EEM_Event'
210
+			);
211
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
212
+		}
213
+	}
214
+
215
+
216
+	/**
217
+	 * Used to override the default for the additional limit field.
218
+	 * @param $additional_limit
219
+	 */
220
+	public static function set_default_additional_limit($additional_limit)
221
+	{
222
+		self::$_default_additional_limit = (int) $additional_limit;
223
+		if (self::$_instance instanceof EEM_Event) {
224
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
225
+				'EVT_additional_limit',
226
+				__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
227
+				true,
228
+				self::$_default_additional_limit
229
+			);
230
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
231
+				'Event_Meta',
232
+				'EVT_additional_limit',
233
+				'EEM_Event'
234
+			);
235
+		}
236
+	}
237
+
238
+
239
+	/**
240
+	 * Return what is currently set as the default additional limit for the event.
241
+	 * @return int
242
+	 */
243
+	public static function get_default_additional_limit()
244
+	{
245
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
246
+	}
247
+
248
+
249
+	/**
250
+	 * get_question_groups
251
+	 *
252
+	 * @return array
253
+	 * @throws \EE_Error
254
+	 */
255
+	public function get_all_question_groups()
256
+	{
257
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
258
+			array(
259
+				array('QSG_deleted' => false),
260
+				'order_by' => array('QSG_order' => 'ASC'),
261
+			)
262
+		);
263
+	}
264
+
265
+
266
+
267
+	/**
268
+	 * get_question_groups
269
+	 *
270
+	 * @param int $EVT_ID
271
+	 * @return array|bool
272
+	 * @throws \EE_Error
273
+	 */
274
+	public function get_all_event_question_groups($EVT_ID = 0)
275
+	{
276
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
277
+			EE_Error::add_error(
278
+				esc_html__(
279
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
280
+					'event_espresso'
281
+				),
282
+				__FILE__, __FUNCTION__, __LINE__
283
+			);
284
+			return false;
285
+		}
286
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
287
+			array(
288
+				array('EVT_ID' => $EVT_ID),
289
+			)
290
+		);
291
+	}
292
+
293
+
294
+
295
+	/**
296
+	 * get_question_groups
297
+	 *
298
+	 * @param int     $EVT_ID
299
+	 * @param boolean $for_primary_attendee
300
+	 * @return array|bool
301
+	 * @throws \EE_Error
302
+	 */
303
+	public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
304
+	{
305
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
306
+			EE_Error::add_error(
307
+				esc_html__(
308
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
309
+					'event_espresso'
310
+				),
311
+				__FILE__, __FUNCTION__, __LINE__
312
+			);
313
+			return false;
314
+		}
315
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
316
+			array(
317
+				array(
318
+					'EVT_ID'      => $EVT_ID,
319
+					'EQG_primary' => $for_primary_attendee,
320
+				),
321
+			)
322
+		);
323
+	}
324
+
325
+
326
+
327
+	/**
328
+	 * get_question_groups
329
+	 *
330
+	 * @param int             $EVT_ID
331
+	 * @param EE_Registration $registration
332
+	 * @return array|bool
333
+	 * @throws \EE_Error
334
+	 */
335
+	public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
336
+	{
337
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
338
+			EE_Error::add_error(
339
+				esc_html__(
340
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
341
+					'event_espresso'
342
+				),
343
+				__FILE__, __FUNCTION__, __LINE__
344
+			);
345
+			return false;
346
+		}
347
+		$where_params = array(
348
+			'Event_Question_Group.EVT_ID'      => $EVT_ID,
349
+			'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
350
+			'QSG_deleted'                      => false,
351
+		);
352
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
353
+			array(
354
+				$where_params,
355
+				'order_by' => array('QSG_order' => 'ASC'),
356
+			)
357
+		);
358
+	}
359
+
360
+
361
+
362
+	/**
363
+	 * get_question_target_db_column
364
+	 *
365
+	 * @param string $QSG_IDs csv list of $QSG IDs
366
+	 * @return array|bool
367
+	 * @throws \EE_Error
368
+	 */
369
+	public function get_questions_in_groups($QSG_IDs = '')
370
+	{
371
+		if (empty($QSG_IDs)) {
372
+			EE_Error::add_error(
373
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
374
+				__FILE__, __FUNCTION__, __LINE__
375
+			);
376
+			return false;
377
+		}
378
+		return EE_Registry::instance()->load_model('Question')->get_all(
379
+			array(
380
+				array(
381
+					'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
382
+					'QST_deleted'           => false,
383
+					'QST_admin_only'        => is_admin(),
384
+				),
385
+				'order_by' => 'QST_order',
386
+			)
387
+		);
388
+	}
389
+
390
+
391
+
392
+	/**
393
+	 * get_options_for_question
394
+	 *
395
+	 * @param string $QST_IDs csv list of $QST IDs
396
+	 * @return array|bool
397
+	 * @throws \EE_Error
398
+	 */
399
+	public function get_options_for_question($QST_IDs)
400
+	{
401
+		if (empty($QST_IDs)) {
402
+			EE_Error::add_error(
403
+				esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
404
+				__FILE__, __FUNCTION__, __LINE__
405
+			);
406
+			return false;
407
+		}
408
+		return EE_Registry::instance()->load_model('Question_Option')->get_all(
409
+			array(
410
+				array(
411
+					'Question.QST_ID' => array('IN', $QST_IDs),
412
+					'QSO_deleted'     => false,
413
+				),
414
+				'order_by' => 'QSO_ID',
415
+			)
416
+		);
417
+	}
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+	/**
426
+	 * Gets all events that are published
427
+	 * and have event start time earlier than now and an event end time later than now
428
+	 *
429
+	 * @param  array $query_params An array of query params to further filter on
430
+	 *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
431
+	 * @param bool   $count        whether to return the count or not (default FALSE)
432
+	 * @return EE_Event[]|int
433
+	 * @throws \EE_Error
434
+	 */
435
+	public function get_active_events($query_params, $count = false)
436
+	{
437
+		if (array_key_exists(0, $query_params)) {
438
+			$where_params = $query_params[0];
439
+			unset($query_params[0]);
440
+		} else {
441
+			$where_params = array();
442
+		}
443
+		// if we have count make sure we don't include group by
444
+		if ($count && isset($query_params['group_by'])) {
445
+			unset($query_params['group_by']);
446
+		}
447
+		// let's add specific query_params for active_events
448
+		// keep in mind this will override any sent status in the query AND any date queries.
449
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
450
+		//if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
451
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
452
+			$where_params['Datetime.DTT_EVT_start******'] = array(
453
+				'<',
454
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
455
+			);
456
+		} else {
457
+			$where_params['Datetime.DTT_EVT_start'] = array(
458
+				'<',
459
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
460
+			);
461
+		}
462
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
463
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
464
+				'>',
465
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
466
+			);
467
+		} else {
468
+			$where_params['Datetime.DTT_EVT_end'] = array(
469
+				'>',
470
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
471
+			);
472
+		}
473
+		$query_params[0] = $where_params;
474
+		// don't use $query_params with count()
475
+		// because we don't want to include additional query clauses like "GROUP BY"
476
+		return $count
477
+			? $this->count(array($where_params), 'EVT_ID', true)
478
+			: $this->get_all($query_params);
479
+	}
480
+
481
+
482
+
483
+	/**
484
+	 * get all events that are published and have an event start time later than now
485
+	 *
486
+	 * @param  array $query_params An array of query params to further filter on
487
+	 *                             (Note that status and DTT_EVT_start will be overridden)
488
+	 * @param bool   $count        whether to return the count or not (default FALSE)
489
+	 * @return EE_Event[]|int
490
+	 * @throws \EE_Error
491
+	 */
492
+	public function get_upcoming_events($query_params, $count = false)
493
+	{
494
+		if (array_key_exists(0, $query_params)) {
495
+			$where_params = $query_params[0];
496
+			unset($query_params[0]);
497
+		} else {
498
+			$where_params = array();
499
+		}
500
+		// if we have count make sure we don't include group by
501
+		if ($count && isset($query_params['group_by'])) {
502
+			unset($query_params['group_by']);
503
+		}
504
+		// let's add specific query_params for active_events
505
+		// keep in mind this will override any sent status in the query AND any date queries.
506
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
507
+		// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
508
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
509
+			$where_params['Datetime.DTT_EVT_start*****'] = array(
510
+				'>',
511
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
512
+			);
513
+		} else {
514
+			$where_params['Datetime.DTT_EVT_start'] = array(
515
+				'>',
516
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
517
+			);
518
+		}
519
+		$query_params[0] = $where_params;
520
+		// don't use $query_params with count()
521
+		// because we don't want to include additional query clauses like "GROUP BY"
522
+		return $count
523
+			? $this->count(array($where_params), 'EVT_ID', true)
524
+			: $this->get_all($query_params);
525
+	}
526
+
527
+
528
+
529
+	/**
530
+	 * Gets all events that are published
531
+	 * and have an event end time later than now
532
+	 *
533
+	 * @param  array $query_params An array of query params to further filter on
534
+	 *                             (note that status and DTT_EVT_end will be overridden)
535
+	 * @param bool   $count        whether to return the count or not (default FALSE)
536
+	 * @return EE_Event[]|int
537
+	 * @throws \EE_Error
538
+	 */
539
+	public function get_active_and_upcoming_events($query_params, $count = false)
540
+	{
541
+		if (array_key_exists(0, $query_params)) {
542
+			$where_params = $query_params[0];
543
+			unset($query_params[0]);
544
+		} else {
545
+			$where_params = array();
546
+		}
547
+		// if we have count make sure we don't include group by
548
+		if ($count && isset($query_params['group_by'])) {
549
+			unset($query_params['group_by']);
550
+		}
551
+		// let's add specific query_params for active_events
552
+		// keep in mind this will override any sent status in the query AND any date queries.
553
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
554
+		// add where params for DTT_EVT_end
555
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
556
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
557
+				'>',
558
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
559
+			);
560
+		} else {
561
+			$where_params['Datetime.DTT_EVT_end'] = array(
562
+				'>',
563
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
564
+			);
565
+		}
566
+		$query_params[0] = $where_params;
567
+		// don't use $query_params with count()
568
+		// because we don't want to include additional query clauses like "GROUP BY"
569
+		return $count
570
+			? $this->count(array($where_params), 'EVT_ID', true)
571
+			: $this->get_all($query_params);
572
+	}
573
+
574
+
575
+
576
+	/**
577
+	 * This only returns events that are expired.
578
+	 * They may still be published but all their datetimes have expired.
579
+	 *
580
+	 * @param  array $query_params An array of query params to further filter on
581
+	 *                             (note that status and DTT_EVT_end will be overridden)
582
+	 * @param bool   $count        whether to return the count or not (default FALSE)
583
+	 * @return EE_Event[]|int
584
+	 * @throws \EE_Error
585
+	 */
586
+	public function get_expired_events($query_params, $count = false)
587
+	{
588
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
589
+		// if we have count make sure we don't include group by
590
+		if ($count && isset($query_params['group_by'])) {
591
+			unset($query_params['group_by']);
592
+		}
593
+		// let's add specific query_params for active_events
594
+		// keep in mind this will override any sent status in the query AND any date queries.
595
+		if (isset($where_params['status'])) {
596
+			unset($where_params['status']);
597
+		}
598
+		$exclude_query = $query_params;
599
+		if (isset($exclude_query[0])) {
600
+			unset($exclude_query[0]);
601
+		}
602
+		$exclude_query[0] = array(
603
+			'Datetime.DTT_EVT_end' => array(
604
+				'>',
605
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
606
+			),
607
+		);
608
+		// first get all events that have datetimes where its not expired.
609
+		$event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
610
+		$event_ids = array_keys($event_ids);
611
+		// if we have any additional query_params, let's add them to the 'AND' condition
612
+		$and_condition = array(
613
+			'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
614
+			'EVT_ID'               => array('NOT IN', $event_ids),
615
+		);
616
+		if (isset($where_params['OR'])) {
617
+			$and_condition['OR'] = $where_params['OR'];
618
+			unset($where_params['OR']);
619
+		}
620
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
621
+			$and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
622
+			unset($where_params['Datetime.DTT_EVT_end']);
623
+		}
624
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
625
+			$and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
626
+			unset($where_params['Datetime.DTT_EVT_start']);
627
+		}
628
+		// merge remaining $where params with the and conditions.
629
+		$where_params['AND'] = array_merge($and_condition, $where_params);
630
+		$query_params[0] = $where_params;
631
+		// don't use $query_params with count()
632
+		// because we don't want to include additional query clauses like "GROUP BY"
633
+		return $count
634
+			? $this->count(array($where_params), 'EVT_ID', true)
635
+			: $this->get_all($query_params);
636
+	}
637
+
638
+
639
+
640
+	/**
641
+	 * This basically just returns the events that do not have the publish status.
642
+	 *
643
+	 * @param  array   $query_params An array of query params to further filter on
644
+	 *                               (note that status will be overwritten)
645
+	 * @param  boolean $count        whether to return the count or not (default FALSE)
646
+	 * @return EE_Event[]|int
647
+	 * @throws \EE_Error
648
+	 */
649
+	public function get_inactive_events($query_params, $count = false)
650
+	{
651
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
652
+		// let's add in specific query_params for inactive events.
653
+		if (isset($where_params['status'])) {
654
+			unset($where_params['status']);
655
+		}
656
+		// if we have count make sure we don't include group by
657
+		if ($count && isset($query_params['group_by'])) {
658
+			unset($query_params['group_by']);
659
+		}
660
+		// if we have any additional query_params, let's add them to the 'AND' condition
661
+		$where_params['AND']['status'] = array('!=', 'publish');
662
+		if (isset($where_params['OR'])) {
663
+			$where_params['AND']['OR'] = $where_params['OR'];
664
+			unset($where_params['OR']);
665
+		}
666
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
667
+			$where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
668
+			unset($where_params['Datetime.DTT_EVT_end']);
669
+		}
670
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
671
+			$where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
672
+			unset($where_params['Datetime.DTT_EVT_start']);
673
+		}
674
+		$query_params[0] = $where_params;
675
+		// don't use $query_params with count()
676
+		// because we don't want to include additional query clauses like "GROUP BY"
677
+		return $count
678
+			? $this->count(array($where_params), 'EVT_ID', true)
679
+			: $this->get_all($query_params);
680
+	}
681
+
682
+
683
+
684
+	/**
685
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
686
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
687
+	 * attached to the event. See parent for param descriptions
688
+	 *
689
+	 * @param        $id_or_obj
690
+	 * @param        $other_model_id_or_obj
691
+	 * @param string $relationName
692
+	 * @param array  $where_query
693
+	 * @return EE_Base_Class
694
+	 * @throws EE_Error
695
+	 */
696
+	public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
697
+	{
698
+		if ($relationName === 'Price') {
699
+			//let's get the PRC object for the given ID to make sure that we aren't dealing with a default
700
+			$prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
701
+			//if EVT_ID = 0, then this is a default
702
+			if ((int) $prc_chk->get('EVT_ID') === 0) {
703
+				//let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
704
+				$prc_chk->set('PRC_ID', 0);
705
+			}
706
+			//run parent
707
+			return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
708
+		}
709
+		//otherwise carry on as normal
710
+		return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
711
+	}
712
+
713
+
714
+
715
+	/******************** DEPRECATED METHODS ********************/
716
+
717
+
718
+
719
+	/**
720
+	 * _get_question_target_db_column
721
+	 *
722
+	 * @deprecated as of 4.8.32.rc.001. Instead consider using
723
+	 *             EE_Registration_Custom_Questions_Form located in
724
+	 *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
725
+	 * @access     public
726
+	 * @param    EE_Registration $registration (so existing answers for registration are included)
727
+	 * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
728
+	 *                                         registration).
729
+	 * @throws EE_Error
730
+	 * @return    array
731
+	 */
732
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
733
+	{
734
+		if (empty($EVT_ID)) {
735
+			throw new EE_Error(__('An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
736
+				'event_espresso'));
737
+		}
738
+		$questions = array();
739
+		// get all question groups for event
740
+		$qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
741
+		if (! empty($qgs)) {
742
+			foreach ($qgs as $qg) {
743
+				$qsts = $qg->questions();
744
+				$questions[$qg->ID()] = $qg->model_field_array();
745
+				$questions[$qg->ID()]['QSG_questions'] = array();
746
+				foreach ($qsts as $qst) {
747
+					if ($qst->is_system_question()) {
748
+						continue;
749
+					}
750
+					$answer = EEM_Answer::instance()->get_one(array(
751
+						array(
752
+							'QST_ID' => $qst->ID(),
753
+							'REG_ID' => $registration->ID(),
754
+						),
755
+					));
756
+					$answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
757
+					$qst_name = $qstn_id = $qst->ID();
758
+					$ans_id = $answer->ID();
759
+					$qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
760
+					$input_name = '';
761
+					$input_id = sanitize_key($qst->display_text());
762
+					$input_class = '';
763
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
764
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
765
+																						   . $input_name
766
+																						   . $qst_name;
767
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
768
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
769
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
770
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
771
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
772
+					//leave responses as-is, don't convert stuff into html entities please!
773
+					$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
774
+					if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
775
+						$QSOs = $qst->options(true, $answer->value());
776
+						if (is_array($QSOs)) {
777
+							foreach ($QSOs as $QSO_ID => $QSO) {
778
+								$questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
779
+							}
780
+						}
781
+					}
782
+				}
783
+			}
784
+		}
785
+		return $questions;
786
+	}
787
+
788
+
789
+	/**
790
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
791
+	 *                             or an stdClass where each property is the name of a column,
792
+	 * @return EE_Base_Class
793
+	 * @throws \EE_Error
794
+	 */
795
+	public function instantiate_class_from_array_or_object($cols_n_values)
796
+	{
797
+		$classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
798
+		if($classInstance instanceof EE_Event) {
799
+			//events have their timezone defined in the DB, so use it immediately
800
+			$this->set_timezone($classInstance->get_timezone());
801
+		}
802
+		return $classInstance;
803
+	}
804 804
 }
805 805
 // End of file EEM_Event.model.php
806 806
 // Location: /includes/models/EEM_Event.model.php
Please login to merge, or discard this patch.
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -1,9 +1,9 @@  discard block
 block discarded – undo
1 1
 <?php use EventEspresso\core\services\orm\ModelFieldFactory;
2 2
 
3
-if (! defined('EVENT_ESPRESSO_VERSION')) {
3
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
4 4
     exit('No direct script access allowed');
5 5
 }
6
-require_once(EE_MODELS . 'EEM_CPT_Base.model.php');
6
+require_once(EE_MODELS.'EEM_CPT_Base.model.php');
7 7
 
8 8
 
9 9
 
@@ -158,11 +158,11 @@  discard block
 block discarded – undo
158 158
                 'EVT_member_only'                 => new EE_Boolean_Field('EVT_member_only',
159 159
                     esc_html__('Member-Only Event Flag', 'event_espresso'), false, false),
160 160
                 'EVT_phone'                       => new EE_Plain_Text_Field('EVT_phone',
161
-                    esc_html__('Event Phone Number', 'event_espresso'), false,''),
161
+                    esc_html__('Event Phone Number', 'event_espresso'), false, ''),
162 162
                 'EVT_allow_overflow'              => new EE_Boolean_Field('EVT_allow_overflow',
163 163
                     esc_html__('Allow Overflow on Event', 'event_espresso'), false, false),
164 164
                 'EVT_timezone_string'             => new EE_Plain_Text_Field('EVT_timezone_string',
165
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'), false,''),
165
+                    esc_html__('Timezone (name) for Event times', 'event_espresso'), false, ''),
166 166
                 'EVT_external_URL'                => new EE_Plain_Text_Field('EVT_external_URL',
167 167
                     esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'), true),
168 168
                 'EVT_donations'                   => new EE_Boolean_Field('EVT_donations',
@@ -273,7 +273,7 @@  discard block
 block discarded – undo
273 273
      */
274 274
     public function get_all_event_question_groups($EVT_ID = 0)
275 275
     {
276
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
276
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
277 277
             EE_Error::add_error(
278 278
                 esc_html__(
279 279
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -302,7 +302,7 @@  discard block
 block discarded – undo
302 302
      */
303 303
     public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
304 304
     {
305
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
305
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
306 306
             EE_Error::add_error(
307 307
                 esc_html__(
308 308
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -334,7 +334,7 @@  discard block
 block discarded – undo
334 334
      */
335 335
     public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
336 336
     {
337
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
337
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
338 338
             EE_Error::add_error(
339 339
                 esc_html__(
340 340
                     'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
@@ -738,7 +738,7 @@  discard block
 block discarded – undo
738 738
         $questions = array();
739 739
         // get all question groups for event
740 740
         $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
741
-        if (! empty($qgs)) {
741
+        if ( ! empty($qgs)) {
742 742
             foreach ($qgs as $qg) {
743 743
                 $qsts = $qg->questions();
744 744
                 $questions[$qg->ID()] = $qg->model_field_array();
@@ -756,7 +756,7 @@  discard block
 block discarded – undo
756 756
                     $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
757 757
                     $qst_name = $qstn_id = $qst->ID();
758 758
                     $ans_id = $answer->ID();
759
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
759
+                    $qst_name = ! empty($ans_id) ? '['.$qst_name.']['.$ans_id.']' : '['.$qst_name.']';
760 760
                     $input_name = '';
761 761
                     $input_id = sanitize_key($qst->display_text());
762 762
                     $input_class = '';
@@ -764,7 +764,7 @@  discard block
 block discarded – undo
764 764
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
765 765
                                                                                            . $input_name
766 766
                                                                                            . $qst_name;
767
-                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id . '-' . $qstn_id;
767
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id.'-'.$qstn_id;
768 768
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
769 769
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
770 770
                     $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
@@ -795,7 +795,7 @@  discard block
 block discarded – undo
795 795
     public function instantiate_class_from_array_or_object($cols_n_values)
796 796
     {
797 797
         $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
798
-        if($classInstance instanceof EE_Event) {
798
+        if ($classInstance instanceof EE_Event) {
799 799
             //events have their timezone defined in the DB, so use it immediately
800 800
             $this->set_timezone($classInstance->get_timezone());
801 801
         }
Please login to merge, or discard this patch.
core/db_models/EEM_Base.model.php 1 patch
Indentation   +6004 added lines, -6004 removed lines patch added patch discarded remove patch
@@ -32,6012 +32,6012 @@
 block discarded – undo
32 32
 abstract class EEM_Base extends EE_Base implements ResettableInterface
33 33
 {
34 34
 
35
-    /**
36
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
37
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
38
-     * They almost always WILL NOT, but it's not necessarily a requirement.
39
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
40
-     *
41
-     * @var boolean
42
-     */
43
-    private $_values_already_prepared_by_model_object = 0;
44
-
45
-    /**
46
-     * when $_values_already_prepared_by_model_object equals this, we assume
47
-     * the data is just like form input that needs to have the model fields'
48
-     * prepare_for_set and prepare_for_use_in_db called on it
49
-     */
50
-    const not_prepared_by_model_object = 0;
51
-
52
-    /**
53
-     * when $_values_already_prepared_by_model_object equals this, we
54
-     * assume this value is coming from a model object and doesn't need to have
55
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
56
-     */
57
-    const prepared_by_model_object = 1;
58
-
59
-    /**
60
-     * when $_values_already_prepared_by_model_object equals this, we assume
61
-     * the values are already to be used in the database (ie no processing is done
62
-     * on them by the model's fields)
63
-     */
64
-    const prepared_for_use_in_db = 2;
65
-
66
-
67
-    protected $singular_item = 'Item';
68
-
69
-    protected $plural_item   = 'Items';
70
-
71
-    /**
72
-     * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
73
-     */
74
-    protected $_tables;
75
-
76
-    /**
77
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
78
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
79
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
80
-     *
81
-     * @var \EE_Model_Field_Base[][] $_fields
82
-     */
83
-    protected $_fields;
84
-
85
-    /**
86
-     * array of different kinds of relations
87
-     *
88
-     * @var \EE_Model_Relation_Base[] $_model_relations
89
-     */
90
-    protected $_model_relations;
91
-
92
-    /**
93
-     * @var \EE_Index[] $_indexes
94
-     */
95
-    protected $_indexes = array();
96
-
97
-    /**
98
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
99
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
100
-     * by setting the same columns as used in these queries in the query yourself.
101
-     *
102
-     * @var EE_Default_Where_Conditions
103
-     */
104
-    protected $_default_where_conditions_strategy;
105
-
106
-    /**
107
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
108
-     * This is particularly useful when you want something between 'none' and 'default'
109
-     *
110
-     * @var EE_Default_Where_Conditions
111
-     */
112
-    protected $_minimum_where_conditions_strategy;
113
-
114
-    /**
115
-     * String describing how to find the "owner" of this model's objects.
116
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
117
-     * But when there isn't, this indicates which related model, or transiently-related model,
118
-     * has the foreign key to the wp_users table.
119
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
120
-     * related to events, and events have a foreign key to wp_users.
121
-     * On EEM_Transaction, this would be 'Transaction.Event'
122
-     *
123
-     * @var string
124
-     */
125
-    protected $_model_chain_to_wp_user = '';
126
-
127
-    /**
128
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
129
-     * don't need it (particularly CPT models)
130
-     *
131
-     * @var bool
132
-     */
133
-    protected $_ignore_where_strategy = false;
134
-
135
-    /**
136
-     * String used in caps relating to this model. Eg, if the caps relating to this
137
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
138
-     *
139
-     * @var string. If null it hasn't been initialized yet. If false then we
140
-     * have indicated capabilities don't apply to this
141
-     */
142
-    protected $_caps_slug = null;
143
-
144
-    /**
145
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
146
-     * and next-level keys are capability names, and each's value is a
147
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
148
-     * they specify which context to use (ie, frontend, backend, edit or delete)
149
-     * and then each capability in the corresponding sub-array that they're missing
150
-     * adds the where conditions onto the query.
151
-     *
152
-     * @var array
153
-     */
154
-    protected $_cap_restrictions = array(
155
-        self::caps_read       => array(),
156
-        self::caps_read_admin => array(),
157
-        self::caps_edit       => array(),
158
-        self::caps_delete     => array(),
159
-    );
160
-
161
-    /**
162
-     * Array defining which cap restriction generators to use to create default
163
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
164
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
165
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
166
-     * automatically set this to false (not just null).
167
-     *
168
-     * @var EE_Restriction_Generator_Base[]
169
-     */
170
-    protected $_cap_restriction_generators = array();
171
-
172
-    /**
173
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
174
-     */
175
-    const caps_read       = 'read';
176
-
177
-    const caps_read_admin = 'read_admin';
178
-
179
-    const caps_edit       = 'edit';
180
-
181
-    const caps_delete     = 'delete';
182
-
183
-    /**
184
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
185
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
186
-     * maps to 'read' because when looking for relevant permissions we're going to use
187
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
188
-     *
189
-     * @var array
190
-     */
191
-    protected $_cap_contexts_to_cap_action_map = array(
192
-        self::caps_read       => 'read',
193
-        self::caps_read_admin => 'read',
194
-        self::caps_edit       => 'edit',
195
-        self::caps_delete     => 'delete',
196
-    );
197
-
198
-    /**
199
-     * Timezone
200
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
201
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
202
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
203
-     * EE_Datetime_Field data type will have access to it.
204
-     *
205
-     * @var string
206
-     */
207
-    protected $_timezone;
208
-
209
-
210
-    /**
211
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
212
-     * multisite.
213
-     *
214
-     * @var int
215
-     */
216
-    protected static $_model_query_blog_id;
217
-
218
-    /**
219
-     * A copy of _fields, except the array keys are the model names pointed to by
220
-     * the field
221
-     *
222
-     * @var EE_Model_Field_Base[]
223
-     */
224
-    private $_cache_foreign_key_to_fields = array();
225
-
226
-    /**
227
-     * Cached list of all the fields on the model, indexed by their name
228
-     *
229
-     * @var EE_Model_Field_Base[]
230
-     */
231
-    private $_cached_fields = null;
232
-
233
-    /**
234
-     * Cached list of all the fields on the model, except those that are
235
-     * marked as only pertinent to the database
236
-     *
237
-     * @var EE_Model_Field_Base[]
238
-     */
239
-    private $_cached_fields_non_db_only = null;
240
-
241
-    /**
242
-     * A cached reference to the primary key for quick lookup
243
-     *
244
-     * @var EE_Model_Field_Base
245
-     */
246
-    private $_primary_key_field = null;
247
-
248
-    /**
249
-     * Flag indicating whether this model has a primary key or not
250
-     *
251
-     * @var boolean
252
-     */
253
-    protected $_has_primary_key_field = null;
254
-
255
-    /**
256
-     * Whether or not this model is based off a table in WP core only (CPTs should set
257
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
258
-     * This should be true for models that deal with data that should exist independent of EE.
259
-     * For example, if the model can read and insert data that isn't used by EE, this should be true.
260
-     * It would be false, however, if you could guarantee the model would only interact with EE data,
261
-     * even if it uses a WP core table (eg event and venue models set this to false for that reason:
262
-     * they can only read and insert events and venues custom post types, not arbitrary post types)
263
-     * @var boolean
264
-     */
265
-    protected $_wp_core_model = false;
266
-
267
-    /**
268
-     *    List of valid operators that can be used for querying.
269
-     * The keys are all operators we'll accept, the values are the real SQL
270
-     * operators used
271
-     *
272
-     * @var array
273
-     */
274
-    protected $_valid_operators = array(
275
-        '='           => '=',
276
-        '<='          => '<=',
277
-        '<'           => '<',
278
-        '>='          => '>=',
279
-        '>'           => '>',
280
-        '!='          => '!=',
281
-        'LIKE'        => 'LIKE',
282
-        'like'        => 'LIKE',
283
-        'NOT_LIKE'    => 'NOT LIKE',
284
-        'not_like'    => 'NOT LIKE',
285
-        'NOT LIKE'    => 'NOT LIKE',
286
-        'not like'    => 'NOT LIKE',
287
-        'IN'          => 'IN',
288
-        'in'          => 'IN',
289
-        'NOT_IN'      => 'NOT IN',
290
-        'not_in'      => 'NOT IN',
291
-        'NOT IN'      => 'NOT IN',
292
-        'not in'      => 'NOT IN',
293
-        'between'     => 'BETWEEN',
294
-        'BETWEEN'     => 'BETWEEN',
295
-        'IS_NOT_NULL' => 'IS NOT NULL',
296
-        'is_not_null' => 'IS NOT NULL',
297
-        'IS NOT NULL' => 'IS NOT NULL',
298
-        'is not null' => 'IS NOT NULL',
299
-        'IS_NULL'     => 'IS NULL',
300
-        'is_null'     => 'IS NULL',
301
-        'IS NULL'     => 'IS NULL',
302
-        'is null'     => 'IS NULL',
303
-        'REGEXP'      => 'REGEXP',
304
-        'regexp'      => 'REGEXP',
305
-        'NOT_REGEXP'  => 'NOT REGEXP',
306
-        'not_regexp'  => 'NOT REGEXP',
307
-        'NOT REGEXP'  => 'NOT REGEXP',
308
-        'not regexp'  => 'NOT REGEXP',
309
-    );
310
-
311
-    /**
312
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
313
-     *
314
-     * @var array
315
-     */
316
-    protected $_in_style_operators = array('IN', 'NOT IN');
317
-
318
-    /**
319
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
320
-     * '12-31-2012'"
321
-     *
322
-     * @var array
323
-     */
324
-    protected $_between_style_operators = array('BETWEEN');
325
-
326
-    /**
327
-     * Operators that work like SQL's like: input should be assumed to be a string, already prepared for a LIKE query.
328
-     * @var array
329
-     */
330
-    protected $_like_style_operators = array('LIKE', 'NOT LIKE');
331
-    /**
332
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
333
-     * on a join table.
334
-     *
335
-     * @var array
336
-     */
337
-    protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
338
-
339
-    /**
340
-     * Allowed values for $query_params['order'] for ordering in queries
341
-     *
342
-     * @var array
343
-     */
344
-    protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
345
-
346
-    /**
347
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
348
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
349
-     *
350
-     * @var array
351
-     */
352
-    private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
353
-
354
-    /**
355
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
356
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
357
-     *
358
-     * @var array
359
-     */
360
-    private $_allowed_query_params = array(
361
-        0,
362
-        'limit',
363
-        'order_by',
364
-        'group_by',
365
-        'having',
366
-        'force_join',
367
-        'order',
368
-        'on_join_limit',
369
-        'default_where_conditions',
370
-        'caps',
371
-    );
372
-
373
-    /**
374
-     * All the data types that can be used in $wpdb->prepare statements.
375
-     *
376
-     * @var array
377
-     */
378
-    private $_valid_wpdb_data_types = array('%d', '%s', '%f');
379
-
380
-    /**
381
-     * @var EE_Registry $EE
382
-     */
383
-    protected $EE = null;
384
-
385
-
386
-    /**
387
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
388
-     *
389
-     * @var int
390
-     */
391
-    protected $_show_next_x_db_queries = 0;
392
-
393
-    /**
394
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
395
-     * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
396
-     *
397
-     * @var array
398
-     */
399
-    protected $_custom_selections = array();
400
-
401
-    /**
402
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
403
-     * caches every model object we've fetched from the DB on this request
404
-     *
405
-     * @var array
406
-     */
407
-    protected $_entity_map;
408
-
409
-    /**
410
-     * @var LoaderInterface $loader
411
-     */
412
-    private static $loader;
413
-
414
-
415
-    /**
416
-     * constant used to show EEM_Base has not yet verified the db on this http request
417
-     */
418
-    const db_verified_none = 0;
419
-
420
-    /**
421
-     * constant used to show EEM_Base has verified the EE core db on this http request,
422
-     * but not the addons' dbs
423
-     */
424
-    const db_verified_core = 1;
425
-
426
-    /**
427
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
428
-     * the EE core db too)
429
-     */
430
-    const db_verified_addons = 2;
431
-
432
-    /**
433
-     * indicates whether an EEM_Base child has already re-verified the DB
434
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
435
-     * looking like EEM_Base::db_verified_*
436
-     *
437
-     * @var int - 0 = none, 1 = core, 2 = addons
438
-     */
439
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
440
-
441
-    /**
442
-     * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
443
-     *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
444
-     *        registrations for non-trashed tickets for non-trashed datetimes)
445
-     */
446
-    const default_where_conditions_all = 'all';
447
-
448
-    /**
449
-     * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
450
-     *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
451
-     *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
452
-     *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
453
-     *        models which share tables with other models, this can return data for the wrong model.
454
-     */
455
-    const default_where_conditions_this_only = 'this_model_only';
456
-
457
-    /**
458
-     * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
459
-     *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
460
-     *        return all registrations related to non-trashed tickets and non-trashed datetimes)
461
-     */
462
-    const default_where_conditions_others_only = 'other_models_only';
463
-
464
-    /**
465
-     * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
466
-     *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
467
-     *        their table with other models, like the Event and Venue models. For example, when querying for events
468
-     *        ordered by their venues' name, this will be sure to only return real events with associated real venues
469
-     *        (regardless of whether those events and venues are trashed)
470
-     *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
471
-     *        events.
472
-     */
473
-    const default_where_conditions_minimum_all = 'minimum';
474
-
475
-    /**
476
-     * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
477
-     *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
478
-     *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
479
-     *        not)
480
-     */
481
-    const default_where_conditions_minimum_others = 'full_this_minimum_others';
482
-
483
-    /**
484
-     * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
485
-     *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
486
-     *        it's possible it will return table entries for other models. You should use
487
-     *        EEM_Base::default_where_conditions_minimum_all instead.
488
-     */
489
-    const default_where_conditions_none = 'none';
490
-
491
-
492
-
493
-    /**
494
-     * About all child constructors:
495
-     * they should define the _tables, _fields and _model_relations arrays.
496
-     * Should ALWAYS be called after child constructor.
497
-     * In order to make the child constructors to be as simple as possible, this parent constructor
498
-     * finalizes constructing all the object's attributes.
499
-     * Generally, rather than requiring a child to code
500
-     * $this->_tables = array(
501
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
502
-     *        ...);
503
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
504
-     * each EE_Table has a function to set the table's alias after the constructor, using
505
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
506
-     * do something similar.
507
-     *
508
-     * @param null $timezone
509
-     * @throws EE_Error
510
-     */
511
-    protected function __construct($timezone = null)
512
-    {
513
-        // check that the model has not been loaded too soon
514
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
515
-            throw new EE_Error (
516
-                sprintf(
517
-                    __('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.',
518
-                        'event_espresso'),
519
-                    get_class($this)
520
-                )
521
-            );
522
-        }
523
-        /**
524
-         * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
525
-         */
526
-        if (empty(EEM_Base::$_model_query_blog_id)) {
527
-            EEM_Base::set_model_query_blog_id();
528
-        }
529
-        /**
530
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
531
-         * just use EE_Register_Model_Extension
532
-         *
533
-         * @var EE_Table_Base[] $_tables
534
-         */
535
-        $this->_tables = (array)apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
536
-        foreach ($this->_tables as $table_alias => $table_obj) {
537
-            /** @var $table_obj EE_Table_Base */
538
-            $table_obj->_construct_finalize_with_alias($table_alias);
539
-            if ($table_obj instanceof EE_Secondary_Table) {
540
-                /** @var $table_obj EE_Secondary_Table */
541
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
542
-            }
543
-        }
544
-        /**
545
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
546
-         * EE_Register_Model_Extension
547
-         *
548
-         * @param EE_Model_Field_Base[] $_fields
549
-         */
550
-        $this->_fields = (array)apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
551
-        $this->_invalidate_field_caches();
552
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
553
-            if (! array_key_exists($table_alias, $this->_tables)) {
554
-                throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
555
-                    'event_espresso'), $table_alias, implode(",", $this->_fields)));
556
-            }
557
-            foreach ($fields_for_table as $field_name => $field_obj) {
558
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
559
-                //primary key field base has a slightly different _construct_finalize
560
-                /** @var $field_obj EE_Model_Field_Base */
561
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
562
-            }
563
-        }
564
-        // everything is related to Extra_Meta
565
-        if (get_class($this) !== 'EEM_Extra_Meta') {
566
-            //make extra meta related to everything, but don't block deleting things just
567
-            //because they have related extra meta info. For now just orphan those extra meta
568
-            //in the future we should automatically delete them
569
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
570
-        }
571
-        //and change logs
572
-        if (get_class($this) !== 'EEM_Change_Log') {
573
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
574
-        }
575
-        /**
576
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
577
-         * EE_Register_Model_Extension
578
-         *
579
-         * @param EE_Model_Relation_Base[] $_model_relations
580
-         */
581
-        $this->_model_relations = (array)apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
582
-            $this->_model_relations);
583
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
584
-            /** @var $relation_obj EE_Model_Relation_Base */
585
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
586
-        }
587
-        foreach ($this->_indexes as $index_name => $index_obj) {
588
-            /** @var $index_obj EE_Index */
589
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
590
-        }
591
-        $this->set_timezone($timezone);
592
-        //finalize default where condition strategy, or set default
593
-        if (! $this->_default_where_conditions_strategy) {
594
-            //nothing was set during child constructor, so set default
595
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
596
-        }
597
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
598
-        if (! $this->_minimum_where_conditions_strategy) {
599
-            //nothing was set during child constructor, so set default
600
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
601
-        }
602
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
603
-        //if the cap slug hasn't been set, and we haven't set it to false on purpose
604
-        //to indicate to NOT set it, set it to the logical default
605
-        if ($this->_caps_slug === null) {
606
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
607
-        }
608
-        //initialize the standard cap restriction generators if none were specified by the child constructor
609
-        if ($this->_cap_restriction_generators !== false) {
610
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
611
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
612
-                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
613
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
614
-                        new EE_Restriction_Generator_Protected(),
615
-                        $cap_context,
616
-                        $this
617
-                    );
618
-                }
619
-            }
620
-        }
621
-        //if there are cap restriction generators, use them to make the default cap restrictions
622
-        if ($this->_cap_restriction_generators !== false) {
623
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
624
-                if (! $generator_object) {
625
-                    continue;
626
-                }
627
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
628
-                    throw new EE_Error(
629
-                        sprintf(
630
-                            __('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.',
631
-                                'event_espresso'),
632
-                            $context,
633
-                            $this->get_this_model_name()
634
-                        )
635
-                    );
636
-                }
637
-                $action = $this->cap_action_for_context($context);
638
-                if (! $generator_object->construction_finalized()) {
639
-                    $generator_object->_construct_finalize($this, $action);
640
-                }
641
-            }
642
-        }
643
-        do_action('AHEE__' . get_class($this) . '__construct__end');
644
-    }
645
-
646
-
647
-
648
-    /**
649
-     * Used to set the $_model_query_blog_id static property.
650
-     *
651
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
652
-     *                      value for get_current_blog_id() will be used.
653
-     */
654
-    public static function set_model_query_blog_id($blog_id = 0)
655
-    {
656
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
657
-    }
658
-
659
-
660
-
661
-    /**
662
-     * Returns whatever is set as the internal $model_query_blog_id.
663
-     *
664
-     * @return int
665
-     */
666
-    public static function get_model_query_blog_id()
667
-    {
668
-        return EEM_Base::$_model_query_blog_id;
669
-    }
670
-
671
-
672
-
673
-    /**
674
-     * This function is a singleton method used to instantiate the Espresso_model object
675
-     *
676
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
677
-     *                                (and any incoming timezone data that gets saved).
678
-     *                                Note this just sends the timezone info to the date time model field objects.
679
-     *                                Default is NULL
680
-     *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
681
-     * @return static (as in the concrete child class)
682
-     * @throws EE_Error
683
-     * @throws InvalidArgumentException
684
-     * @throws InvalidDataTypeException
685
-     * @throws InvalidInterfaceException
686
-     */
687
-    public static function instance($timezone = null)
688
-    {
689
-        // check if instance of Espresso_model already exists
690
-        if (! static::$_instance instanceof static) {
691
-            // instantiate Espresso_model
692
-            static::$_instance = new static(
693
-                $timezone,
694
-                LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
695
-            );
696
-        }
697
-        //we might have a timezone set, let set_timezone decide what to do with it
698
-        static::$_instance->set_timezone($timezone);
699
-        // Espresso_model object
700
-        return static::$_instance;
701
-    }
702
-
703
-
704
-
705
-    /**
706
-     * resets the model and returns it
707
-     *
708
-     * @param null | string $timezone
709
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
710
-     * all its properties reset; if it wasn't instantiated, returns null)
711
-     * @throws EE_Error
712
-     * @throws ReflectionException
713
-     * @throws InvalidArgumentException
714
-     * @throws InvalidDataTypeException
715
-     * @throws InvalidInterfaceException
716
-     */
717
-    public static function reset($timezone = null)
718
-    {
719
-        if (static::$_instance instanceof EEM_Base) {
720
-            //let's try to NOT swap out the current instance for a new one
721
-            //because if someone has a reference to it, we can't remove their reference
722
-            //so it's best to keep using the same reference, but change the original object
723
-            //reset all its properties to their original values as defined in the class
724
-            $r = new ReflectionClass(get_class(static::$_instance));
725
-            $static_properties = $r->getStaticProperties();
726
-            foreach ($r->getDefaultProperties() as $property => $value) {
727
-                //don't set instance to null like it was originally,
728
-                //but it's static anyways, and we're ignoring static properties (for now at least)
729
-                if (! isset($static_properties[$property])) {
730
-                    static::$_instance->{$property} = $value;
731
-                }
732
-            }
733
-            //and then directly call its constructor again, like we would if we were creating a new one
734
-            static::$_instance->__construct(
735
-                $timezone,
736
-                LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
737
-            );
738
-            return self::instance();
739
-        }
740
-        return null;
741
-    }
742
-
743
-
744
-
745
-    /**
746
-     * @return LoaderInterface
747
-     * @throws InvalidArgumentException
748
-     * @throws InvalidDataTypeException
749
-     * @throws InvalidInterfaceException
750
-     */
751
-    private static function getLoader()
752
-    {
753
-        if(! EEM_Base::$loader instanceof LoaderInterface) {
754
-            EEM_Base::$loader = LoaderFactory::getLoader();
755
-        }
756
-        return EEM_Base::$loader;
757
-    }
758
-
759
-
760
-
761
-    /**
762
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
763
-     *
764
-     * @param  boolean $translated return localized strings or JUST the array.
765
-     * @return array
766
-     * @throws EE_Error
767
-     * @throws InvalidArgumentException
768
-     * @throws InvalidDataTypeException
769
-     * @throws InvalidInterfaceException
770
-     */
771
-    public function status_array($translated = false)
772
-    {
773
-        if (! array_key_exists('Status', $this->_model_relations)) {
774
-            return array();
775
-        }
776
-        $model_name = $this->get_this_model_name();
777
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
778
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
779
-        $status_array = array();
780
-        foreach ($stati as $status) {
781
-            $status_array[$status->ID()] = $status->get('STS_code');
782
-        }
783
-        return $translated
784
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
785
-            : $status_array;
786
-    }
787
-
788
-
789
-
790
-    /**
791
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
792
-     *
793
-     * @param array $query_params             {
794
-     * @var array $0 (where) array {
795
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
796
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
797
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
798
-     *                                        conditions based on related models (and even
799
-     *                                        models-related-to-related-models) prepend the model's name onto the field
800
-     *                                        name. Eg,
801
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
802
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
803
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
804
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
805
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
806
-     *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
807
-     *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
808
-     *                                        to Venues (even when each of those models actually consisted of two
809
-     *                                        tables). Also, you may chain the model relations together. Eg instead of
810
-     *                                        just having
811
-     *                                        "Venue.VNU_ID", you could have
812
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
813
-     *                                        events are related to Registrations, which are related to Attendees). You
814
-     *                                        can take it even further with
815
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
816
-     *                                        (from the default of '='), change the value to an numerically-indexed
817
-     *                                        array, where the first item in the list is the operator. eg: array(
818
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
819
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
820
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
821
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
822
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
823
-     *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
824
-     *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
825
-     *                                        the operator is IN. Also, values can actually be field names. To indicate
826
-     *                                        the value is a field, simply provide a third array item (true) to the
827
-     *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
828
-     *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
829
-     *                                        Note: you can also use related model field names like you would any other
830
-     *                                        field name. eg:
831
-     *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
832
-     *                                        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__>' =>
833
-     *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
834
-     *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
835
-     *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
836
-     *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
837
-     *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
838
-     *                                        to be what you last specified. IE, "AND"s by default, but if you had
839
-     *                                        previously specified to use ORs to join, ORs will continue to be used.
840
-     *                                        So, if you specify to use an "OR" to join conditions, it will continue to
841
-     *                                        "stick" until you specify an AND. eg
842
-     *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
843
-     *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
844
-     *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
845
-     *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
846
-     *                                        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 >>
847
-     *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
848
-     *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
849
-     *                                        too, eg:
850
-     *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
851
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
852
-     *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
853
-     *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
854
-     *                                        Remember when you provide two numbers for the limit, the 1st number is
855
-     *                                        the OFFSET, the 2nd is the LIMIT
856
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
857
-     *                                        can do paging on one-to-many multi-table-joins. Send an array in the
858
-     *                                        following format array('on_join_limit'
859
-     *                                        => array( 'table_alias', array(1,2) ) ).
860
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
861
-     *                                        values are either 'ASC' or 'DESC'.
862
-     *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
863
-     *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
864
-     *                                        DESC..." respectively. Like the
865
-     *                                        'where' conditions, these fields can be on related models. Eg
866
-     *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
867
-     *                                        perfectly valid from any model related to 'Registration' (like Event,
868
-     *                                        Attendee, Price, Datetime, etc.)
869
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
870
-     *                                        'order' specifies whether to order the field specified in 'order_by' in
871
-     *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
872
-     *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
873
-     *                                        order by the primary key. Eg,
874
-     *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
875
-     *                                        //(will join with the Datetime model's table(s) and order by its field
876
-     *                                        DTT_EVT_start) or
877
-     *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
878
-     *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
879
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
880
-     *                                        'group_by'=>'VNU_ID', or
881
-     *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
882
-     *                                        if no
883
-     *                                        $group_by is specified, and a limit is set, automatically groups by the
884
-     *                                        model's primary key (or combined primary keys). This avoids some
885
-     *                                        weirdness that results when using limits, tons of joins, and no group by,
886
-     *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
887
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
888
-     *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
889
-     *                                        results)
890
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
891
-     *                                        array where values are models to be joined in the query.Eg
892
-     *                                        array('Attendee','Payment','Datetime'). You may join with transient
893
-     *                                        models using period, eg "Registration.Transaction.Payment". You will
894
-     *                                        probably only want to do this in hopes of increasing efficiency, as
895
-     *                                        related models which belongs to the current model
896
-     *                                        (ie, the current model has a foreign key to them, like how Registration
897
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
898
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
899
-     *                                        set this to 'none' to disable all default where conditions. Eg, usually
900
-     *                                        soft-deleted objects are filtered-out if you want to include them, set
901
-     *                                        this query param to 'none'. If you want to ONLY disable THIS model's
902
-     *                                        default where conditions set it to 'other_models_only'. If you only want
903
-     *                                        this model's default where conditions added to the query, use
904
-     *                                        'this_model_only'. If you want to use all default where conditions
905
-     *                                        (default), set to 'all'.
906
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
907
-     *                                        we just NOT apply any capabilities/permissions/restrictions and return
908
-     *                                        everything? Or should we only show the current user items they should be
909
-     *                                        able to view on the frontend, backend, edit, or delete? can be set to
910
-     *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
911
-     *                                        }
912
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
913
-     *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
914
-     *                                        again. Array keys are object IDs (if there is a primary key on the model.
915
-     *                                        if not, numerically indexed) Some full examples: get 10 transactions
916
-     *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
917
-     *                                        array( array(
918
-     *                                        'OR'=>array(
919
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
920
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
921
-     *                                        )
922
-     *                                        ),
923
-     *                                        'limit'=>10,
924
-     *                                        'group_by'=>'TXN_ID'
925
-     *                                        ));
926
-     *                                        get all the answers to the question titled "shirt size" for event with id
927
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
928
-     *                                        'Question.QST_display_text'=>'shirt size',
929
-     *                                        'Registration.Event.EVT_ID'=>12
930
-     *                                        ),
931
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
932
-     *                                        ));
933
-     * @throws EE_Error
934
-     */
935
-    public function get_all($query_params = array())
936
-    {
937
-        if (isset($query_params['limit'])
938
-            && ! isset($query_params['group_by'])
939
-        ) {
940
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
941
-        }
942
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
943
-    }
944
-
945
-
946
-
947
-    /**
948
-     * Modifies the query parameters so we only get back model objects
949
-     * that "belong" to the current user
950
-     *
951
-     * @param array $query_params @see EEM_Base::get_all()
952
-     * @return array like EEM_Base::get_all
953
-     */
954
-    public function alter_query_params_to_only_include_mine($query_params = array())
955
-    {
956
-        $wp_user_field_name = $this->wp_user_field_name();
957
-        if ($wp_user_field_name) {
958
-            $query_params[0][$wp_user_field_name] = get_current_user_id();
959
-        }
960
-        return $query_params;
961
-    }
962
-
963
-
964
-
965
-    /**
966
-     * Returns the name of the field's name that points to the WP_User table
967
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
968
-     * foreign key to the WP_User table)
969
-     *
970
-     * @return string|boolean string on success, boolean false when there is no
971
-     * foreign key to the WP_User table
972
-     */
973
-    public function wp_user_field_name()
974
-    {
975
-        try {
976
-            if (! empty($this->_model_chain_to_wp_user)) {
977
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
978
-                $last_model_name = end($models_to_follow_to_wp_users);
979
-                $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
980
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
981
-            } else {
982
-                $model_with_fk_to_wp_users = $this;
983
-                $model_chain_to_wp_user = '';
984
-            }
985
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
986
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
987
-        } catch (EE_Error $e) {
988
-            return false;
989
-        }
990
-    }
991
-
992
-
993
-
994
-    /**
995
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
996
-     * (or transiently-related model) has a foreign key to the wp_users table;
997
-     * useful for finding if model objects of this type are 'owned' by the current user.
998
-     * This is an empty string when the foreign key is on this model and when it isn't,
999
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
1000
-     * (or transiently-related model)
1001
-     *
1002
-     * @return string
1003
-     */
1004
-    public function model_chain_to_wp_user()
1005
-    {
1006
-        return $this->_model_chain_to_wp_user;
1007
-    }
1008
-
1009
-
1010
-
1011
-    /**
1012
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1013
-     * like how registrations don't have a foreign key to wp_users, but the
1014
-     * events they are for are), or is unrelated to wp users.
1015
-     * generally available
1016
-     *
1017
-     * @return boolean
1018
-     */
1019
-    public function is_owned()
1020
-    {
1021
-        if ($this->model_chain_to_wp_user()) {
1022
-            return true;
1023
-        }
1024
-        try {
1025
-            $this->get_foreign_key_to('WP_User');
1026
-            return true;
1027
-        } catch (EE_Error $e) {
1028
-            return false;
1029
-        }
1030
-    }
1031
-
1032
-
1033
-
1034
-    /**
1035
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1036
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1037
-     * the model)
1038
-     *
1039
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1040
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1041
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1042
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1043
-     *                                  override this and set the select to "*", or a specific column name, like
1044
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1045
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1046
-     *                                  the aliases used to refer to this selection, and values are to be
1047
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1048
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1049
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1050
-     * @throws EE_Error
1051
-     */
1052
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1053
-    {
1054
-        // remember the custom selections, if any, and type cast as array
1055
-        // (unless $columns_to_select is an object, then just set as an empty array)
1056
-        // Note: (array) 'some string' === array( 'some string' )
1057
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1058
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1059
-        $select_expressions = $columns_to_select !== null
1060
-            ? $this->_construct_select_from_input($columns_to_select)
1061
-            : $this->_construct_default_select_sql($model_query_info);
1062
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1063
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
1064
-    }
1065
-
1066
-
1067
-
1068
-    /**
1069
-     * Gets an array of rows from the database just like $wpdb->get_results would,
1070
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
1071
-     * take care of joins, field preparation etc.
1072
-     *
1073
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1074
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1075
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1076
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1077
-     *                                  override this and set the select to "*", or a specific column name, like
1078
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1079
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1080
-     *                                  the aliases used to refer to this selection, and values are to be
1081
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1082
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1083
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1084
-     * @throws EE_Error
1085
-     */
1086
-    public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1087
-    {
1088
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1089
-    }
1090
-
1091
-
1092
-
1093
-    /**
1094
-     * For creating a custom select statement
1095
-     *
1096
-     * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1097
-     *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1098
-     *                                 SQL, and 1=>is the datatype
1099
-     * @throws EE_Error
1100
-     * @return string
1101
-     */
1102
-    private function _construct_select_from_input($columns_to_select)
1103
-    {
1104
-        if (is_array($columns_to_select)) {
1105
-            $select_sql_array = array();
1106
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
1107
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1108
-                    throw new EE_Error(
1109
-                        sprintf(
1110
-                            __(
1111
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1112
-                                'event_espresso'
1113
-                            ),
1114
-                            $selection_and_datatype,
1115
-                            $alias
1116
-                        )
1117
-                    );
1118
-                }
1119
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
1120
-                    throw new EE_Error(
1121
-                        sprintf(
1122
-                            esc_html__(
1123
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1124
-                                'event_espresso'
1125
-                            ),
1126
-                            $selection_and_datatype[1],
1127
-                            $selection_and_datatype[0],
1128
-                            $alias,
1129
-                            implode(', ', $this->_valid_wpdb_data_types)
1130
-                        )
1131
-                    );
1132
-                }
1133
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1134
-            }
1135
-            $columns_to_select_string = implode(', ', $select_sql_array);
1136
-        } else {
1137
-            $columns_to_select_string = $columns_to_select;
1138
-        }
1139
-        return $columns_to_select_string;
1140
-    }
1141
-
1142
-
1143
-
1144
-    /**
1145
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1146
-     *
1147
-     * @return string
1148
-     * @throws EE_Error
1149
-     */
1150
-    public function primary_key_name()
1151
-    {
1152
-        return $this->get_primary_key_field()->get_name();
1153
-    }
1154
-
1155
-
1156
-
1157
-    /**
1158
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1159
-     * If there is no primary key on this model, $id is treated as primary key string
1160
-     *
1161
-     * @param mixed $id int or string, depending on the type of the model's primary key
1162
-     * @return EE_Base_Class
1163
-     */
1164
-    public function get_one_by_ID($id)
1165
-    {
1166
-        if ($this->get_from_entity_map($id)) {
1167
-            return $this->get_from_entity_map($id);
1168
-        }
1169
-        return $this->get_one(
1170
-            $this->alter_query_params_to_restrict_by_ID(
1171
-                $id,
1172
-                array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1173
-            )
1174
-        );
1175
-    }
1176
-
1177
-
1178
-
1179
-    /**
1180
-     * Alters query parameters to only get items with this ID are returned.
1181
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1182
-     * or could just be a simple primary key ID
1183
-     *
1184
-     * @param int   $id
1185
-     * @param array $query_params
1186
-     * @return array of normal query params, @see EEM_Base::get_all
1187
-     * @throws EE_Error
1188
-     */
1189
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1190
-    {
1191
-        if (! isset($query_params[0])) {
1192
-            $query_params[0] = array();
1193
-        }
1194
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
1195
-        if ($conditions_from_id === null) {
1196
-            $query_params[0][$this->primary_key_name()] = $id;
1197
-        } else {
1198
-            //no primary key, so the $id must be from the get_index_primary_key_string()
1199
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1200
-        }
1201
-        return $query_params;
1202
-    }
1203
-
1204
-
1205
-
1206
-    /**
1207
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1208
-     * array. If no item is found, null is returned.
1209
-     *
1210
-     * @param array $query_params like EEM_Base's $query_params variable.
1211
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1212
-     * @throws EE_Error
1213
-     */
1214
-    public function get_one($query_params = array())
1215
-    {
1216
-        if (! is_array($query_params)) {
1217
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
1218
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1219
-                    gettype($query_params)), '4.6.0');
1220
-            $query_params = array();
1221
-        }
1222
-        $query_params['limit'] = 1;
1223
-        $items = $this->get_all($query_params);
1224
-        if (empty($items)) {
1225
-            return null;
1226
-        }
1227
-        return array_shift($items);
1228
-    }
1229
-
1230
-
1231
-
1232
-    /**
1233
-     * Returns the next x number of items in sequence from the given value as
1234
-     * found in the database matching the given query conditions.
1235
-     *
1236
-     * @param mixed $current_field_value    Value used for the reference point.
1237
-     * @param null  $field_to_order_by      What field is used for the
1238
-     *                                      reference point.
1239
-     * @param int   $limit                  How many to return.
1240
-     * @param array $query_params           Extra conditions on the query.
1241
-     * @param null  $columns_to_select      If left null, then an array of
1242
-     *                                      EE_Base_Class objects is returned,
1243
-     *                                      otherwise you can indicate just the
1244
-     *                                      columns you want returned.
1245
-     * @return EE_Base_Class[]|array
1246
-     * @throws EE_Error
1247
-     */
1248
-    public function next_x(
1249
-        $current_field_value,
1250
-        $field_to_order_by = null,
1251
-        $limit = 1,
1252
-        $query_params = array(),
1253
-        $columns_to_select = null
1254
-    ) {
1255
-        return $this->_get_consecutive(
1256
-            $current_field_value,
1257
-            '>',
1258
-            $field_to_order_by,
1259
-            $limit,
1260
-            $query_params,
1261
-            $columns_to_select
1262
-        );
1263
-    }
1264
-
1265
-
1266
-
1267
-    /**
1268
-     * Returns the previous x number of items in sequence from the given value
1269
-     * as found in the database matching the given query conditions.
1270
-     *
1271
-     * @param mixed $current_field_value    Value used for the reference point.
1272
-     * @param null  $field_to_order_by      What field is used for the
1273
-     *                                      reference point.
1274
-     * @param int   $limit                  How many to return.
1275
-     * @param array $query_params           Extra conditions on the query.
1276
-     * @param null  $columns_to_select      If left null, then an array of
1277
-     *                                      EE_Base_Class objects is returned,
1278
-     *                                      otherwise you can indicate just the
1279
-     *                                      columns you want returned.
1280
-     * @return EE_Base_Class[]|array
1281
-     * @throws EE_Error
1282
-     */
1283
-    public function previous_x(
1284
-        $current_field_value,
1285
-        $field_to_order_by = null,
1286
-        $limit = 1,
1287
-        $query_params = array(),
1288
-        $columns_to_select = null
1289
-    ) {
1290
-        return $this->_get_consecutive(
1291
-            $current_field_value,
1292
-            '<',
1293
-            $field_to_order_by,
1294
-            $limit,
1295
-            $query_params,
1296
-            $columns_to_select
1297
-        );
1298
-    }
1299
-
1300
-
1301
-
1302
-    /**
1303
-     * Returns the next item in sequence from the given value as found in the
1304
-     * database matching the given query conditions.
1305
-     *
1306
-     * @param mixed $current_field_value    Value used for the reference point.
1307
-     * @param null  $field_to_order_by      What field is used for the
1308
-     *                                      reference point.
1309
-     * @param array $query_params           Extra conditions on the query.
1310
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1311
-     *                                      object is returned, otherwise you
1312
-     *                                      can indicate just the columns you
1313
-     *                                      want and a single array indexed by
1314
-     *                                      the columns will be returned.
1315
-     * @return EE_Base_Class|null|array()
1316
-     * @throws EE_Error
1317
-     */
1318
-    public function next(
1319
-        $current_field_value,
1320
-        $field_to_order_by = null,
1321
-        $query_params = array(),
1322
-        $columns_to_select = null
1323
-    ) {
1324
-        $results = $this->_get_consecutive(
1325
-            $current_field_value,
1326
-            '>',
1327
-            $field_to_order_by,
1328
-            1,
1329
-            $query_params,
1330
-            $columns_to_select
1331
-        );
1332
-        return empty($results) ? null : reset($results);
1333
-    }
1334
-
1335
-
1336
-
1337
-    /**
1338
-     * Returns the previous item in sequence from the given value as found in
1339
-     * the database matching the given query conditions.
1340
-     *
1341
-     * @param mixed $current_field_value    Value used for the reference point.
1342
-     * @param null  $field_to_order_by      What field is used for the
1343
-     *                                      reference point.
1344
-     * @param array $query_params           Extra conditions on the query.
1345
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1346
-     *                                      object is returned, otherwise you
1347
-     *                                      can indicate just the columns you
1348
-     *                                      want and a single array indexed by
1349
-     *                                      the columns will be returned.
1350
-     * @return EE_Base_Class|null|array()
1351
-     * @throws EE_Error
1352
-     */
1353
-    public function previous(
1354
-        $current_field_value,
1355
-        $field_to_order_by = null,
1356
-        $query_params = array(),
1357
-        $columns_to_select = null
1358
-    ) {
1359
-        $results = $this->_get_consecutive(
1360
-            $current_field_value,
1361
-            '<',
1362
-            $field_to_order_by,
1363
-            1,
1364
-            $query_params,
1365
-            $columns_to_select
1366
-        );
1367
-        return empty($results) ? null : reset($results);
1368
-    }
1369
-
1370
-
1371
-
1372
-    /**
1373
-     * Returns the a consecutive number of items in sequence from the given
1374
-     * value as found in the database matching the given query conditions.
1375
-     *
1376
-     * @param mixed  $current_field_value   Value used for the reference point.
1377
-     * @param string $operand               What operand is used for the sequence.
1378
-     * @param string $field_to_order_by     What field is used for the reference point.
1379
-     * @param int    $limit                 How many to return.
1380
-     * @param array  $query_params          Extra conditions on the query.
1381
-     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1382
-     *                                      otherwise you can indicate just the columns you want returned.
1383
-     * @return EE_Base_Class[]|array
1384
-     * @throws EE_Error
1385
-     */
1386
-    protected function _get_consecutive(
1387
-        $current_field_value,
1388
-        $operand = '>',
1389
-        $field_to_order_by = null,
1390
-        $limit = 1,
1391
-        $query_params = array(),
1392
-        $columns_to_select = null
1393
-    ) {
1394
-        //if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1395
-        if (empty($field_to_order_by)) {
1396
-            if ($this->has_primary_key_field()) {
1397
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
1398
-            } else {
1399
-                if (WP_DEBUG) {
1400
-                    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).',
1401
-                        'event_espresso'));
1402
-                }
1403
-                EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1404
-                return array();
1405
-            }
1406
-        }
1407
-        if (! is_array($query_params)) {
1408
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1409
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1410
-                    gettype($query_params)), '4.6.0');
1411
-            $query_params = array();
1412
-        }
1413
-        //let's add the where query param for consecutive look up.
1414
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1415
-        $query_params['limit'] = $limit;
1416
-        //set direction
1417
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1418
-        $query_params['order_by'] = $operand === '>'
1419
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
1420
-            : array($field_to_order_by => 'DESC') + $incoming_orderby;
1421
-        //if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1422
-        if (empty($columns_to_select)) {
1423
-            return $this->get_all($query_params);
1424
-        }
1425
-        //getting just the fields
1426
-        return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1427
-    }
1428
-
1429
-
1430
-
1431
-    /**
1432
-     * This sets the _timezone property after model object has been instantiated.
1433
-     *
1434
-     * @param null | string $timezone valid PHP DateTimeZone timezone string
1435
-     */
1436
-    public function set_timezone($timezone)
1437
-    {
1438
-        if ($timezone !== null) {
1439
-            $this->_timezone = $timezone;
1440
-        }
1441
-        //note we need to loop through relations and set the timezone on those objects as well.
1442
-        foreach ($this->_model_relations as $relation) {
1443
-            $relation->set_timezone($timezone);
1444
-        }
1445
-        //and finally we do the same for any datetime fields
1446
-        foreach ($this->_fields as $field) {
1447
-            if ($field instanceof EE_Datetime_Field) {
1448
-                $field->set_timezone($timezone);
1449
-            }
1450
-        }
1451
-    }
1452
-
1453
-
1454
-
1455
-    /**
1456
-     * This just returns whatever is set for the current timezone.
1457
-     *
1458
-     * @access public
1459
-     * @return string
1460
-     */
1461
-    public function get_timezone()
1462
-    {
1463
-        //first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1464
-        if (empty($this->_timezone)) {
1465
-            foreach ($this->_fields as $field) {
1466
-                if ($field instanceof EE_Datetime_Field) {
1467
-                    $this->set_timezone($field->get_timezone());
1468
-                    break;
1469
-                }
1470
-            }
1471
-        }
1472
-        //if timezone STILL empty then return the default timezone for the site.
1473
-        if (empty($this->_timezone)) {
1474
-            $this->set_timezone(EEH_DTT_Helper::get_timezone());
1475
-        }
1476
-        return $this->_timezone;
1477
-    }
1478
-
1479
-
1480
-
1481
-    /**
1482
-     * This returns the date formats set for the given field name and also ensures that
1483
-     * $this->_timezone property is set correctly.
1484
-     *
1485
-     * @since 4.6.x
1486
-     * @param string $field_name The name of the field the formats are being retrieved for.
1487
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1488
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1489
-     * @return array formats in an array with the date format first, and the time format last.
1490
-     */
1491
-    public function get_formats_for($field_name, $pretty = false)
1492
-    {
1493
-        $field_settings = $this->field_settings_for($field_name);
1494
-        //if not a valid EE_Datetime_Field then throw error
1495
-        if (! $field_settings instanceof EE_Datetime_Field) {
1496
-            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.',
1497
-                'event_espresso'), $field_name));
1498
-        }
1499
-        //while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1500
-        //the field.
1501
-        $this->_timezone = $field_settings->get_timezone();
1502
-        return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1503
-    }
1504
-
1505
-
1506
-
1507
-    /**
1508
-     * This returns the current time in a format setup for a query on this model.
1509
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1510
-     * it will return:
1511
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1512
-     *  NOW
1513
-     *  - or a unix timestamp (equivalent to time())
1514
-     * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
1515
-     * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
1516
-     * the time returned to be the current time down to the exact second, set $timestamp to true.
1517
-     * @since 4.6.x
1518
-     * @param string $field_name       The field the current time is needed for.
1519
-     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1520
-     *                                 formatted string matching the set format for the field in the set timezone will
1521
-     *                                 be returned.
1522
-     * @param string $what             Whether to return the string in just the time format, the date format, or both.
1523
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1524
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1525
-     *                                 exception is triggered.
1526
-     */
1527
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1528
-    {
1529
-        $formats = $this->get_formats_for($field_name);
1530
-        $DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1531
-        if ($timestamp) {
1532
-            return $DateTime->format('U');
1533
-        }
1534
-        //not returning timestamp, so return formatted string in timezone.
1535
-        switch ($what) {
1536
-            case 'time' :
1537
-                return $DateTime->format($formats[1]);
1538
-                break;
1539
-            case 'date' :
1540
-                return $DateTime->format($formats[0]);
1541
-                break;
1542
-            default :
1543
-                return $DateTime->format(implode(' ', $formats));
1544
-                break;
1545
-        }
1546
-    }
1547
-
1548
-
1549
-
1550
-    /**
1551
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1552
-     * for the model are.  Returns a DateTime object.
1553
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1554
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1555
-     * ignored.
1556
-     *
1557
-     * @param string $field_name      The field being setup.
1558
-     * @param string $timestring      The date time string being used.
1559
-     * @param string $incoming_format The format for the time string.
1560
-     * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1561
-     *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1562
-     *                                format is
1563
-     *                                'U', this is ignored.
1564
-     * @return DateTime
1565
-     * @throws EE_Error
1566
-     */
1567
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1568
-    {
1569
-        //just using this to ensure the timezone is set correctly internally
1570
-        $this->get_formats_for($field_name);
1571
-        //load EEH_DTT_Helper
1572
-        $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1573
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1574
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1575
-    }
1576
-
1577
-
1578
-
1579
-    /**
1580
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1581
-     *
1582
-     * @return EE_Table_Base[]
1583
-     */
1584
-    public function get_tables()
1585
-    {
1586
-        return $this->_tables;
1587
-    }
1588
-
1589
-
1590
-
1591
-    /**
1592
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1593
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
1594
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1595
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1596
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1597
-     * model object with EVT_ID = 1
1598
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1599
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1600
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1601
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1602
-     * are not specified)
1603
-     *
1604
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1605
-     *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1606
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
1607
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
1608
-     *                                         we wanted to update only the TXN_details on any Transactions where its
1609
-     *                                         ID=34, we'd use this method as follows:
1610
-     *                                         EEM_Transaction::instance()->update(
1611
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1612
-     *                                         array(array('TXN_ID'=>34)));
1613
-     * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1614
-     *                                         in client code into what's expected to be stored on each field. Eg,
1615
-     *                                         consider updating Question's QST_admin_label field is of type
1616
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
1617
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
1618
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
1619
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1620
-     *                                         TRUE, it is assumed that you've already called
1621
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1622
-     *                                         malicious javascript. However, if
1623
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
1624
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1625
-     *                                         and every other field, before insertion. We provide this parameter
1626
-     *                                         because model objects perform their prepare_for_set function on all
1627
-     *                                         their values, and so don't need to be called again (and in many cases,
1628
-     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1629
-     *                                         prepare_for_set method...)
1630
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1631
-     *                                         in this model's entity map according to $fields_n_values that match
1632
-     *                                         $query_params. This obviously has some overhead, so you can disable it
1633
-     *                                         by setting this to FALSE, but be aware that model objects being used
1634
-     *                                         could get out-of-sync with the database
1635
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1636
-     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1637
-     *                                         bad)
1638
-     * @throws EE_Error
1639
-     */
1640
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1641
-    {
1642
-        if (! is_array($query_params)) {
1643
-            EE_Error::doing_it_wrong('EEM_Base::update',
1644
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1645
-                    gettype($query_params)), '4.6.0');
1646
-            $query_params = array();
1647
-        }
1648
-        /**
1649
-         * Action called before a model update call has been made.
1650
-         *
1651
-         * @param EEM_Base $model
1652
-         * @param array    $fields_n_values the updated fields and their new values
1653
-         * @param array    $query_params    @see EEM_Base::get_all()
1654
-         */
1655
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1656
-        /**
1657
-         * Filters the fields about to be updated given the query parameters. You can provide the
1658
-         * $query_params to $this->get_all() to find exactly which records will be updated
1659
-         *
1660
-         * @param array    $fields_n_values fields and their new values
1661
-         * @param EEM_Base $model           the model being queried
1662
-         * @param array    $query_params    see EEM_Base::get_all()
1663
-         */
1664
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1665
-            $query_params);
1666
-        //need to verify that, for any entry we want to update, there are entries in each secondary table.
1667
-        //to do that, for each table, verify that it's PK isn't null.
1668
-        $tables = $this->get_tables();
1669
-        //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
1670
-        //NOTE: we should make this code more efficient by NOT querying twice
1671
-        //before the real update, but that needs to first go through ALPHA testing
1672
-        //as it's dangerous. says Mike August 8 2014
1673
-        //we want to make sure the default_where strategy is ignored
1674
-        $this->_ignore_where_strategy = true;
1675
-        $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1676
-        foreach ($wpdb_select_results as $wpdb_result) {
1677
-            // type cast stdClass as array
1678
-            $wpdb_result = (array)$wpdb_result;
1679
-            //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1680
-            if ($this->has_primary_key_field()) {
1681
-                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1682
-            } else {
1683
-                //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)
1684
-                $main_table_pk_value = null;
1685
-            }
1686
-            //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
1687
-            //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
1688
-            if (count($tables) > 1) {
1689
-                //foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1690
-                //in that table, and so we'll want to insert one
1691
-                foreach ($tables as $table_obj) {
1692
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1693
-                    //if there is no private key for this table on the results, it means there's no entry
1694
-                    //in this table, right? so insert a row in the current table, using any fields available
1695
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1696
-                           && $wpdb_result[$this_table_pk_column])
1697
-                    ) {
1698
-                        $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1699
-                            $main_table_pk_value);
1700
-                        //if we died here, report the error
1701
-                        if (! $success) {
1702
-                            return false;
1703
-                        }
1704
-                    }
1705
-                }
1706
-            }
1707
-            //				//and now check that if we have cached any models by that ID on the model, that
1708
-            //				//they also get updated properly
1709
-            //				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1710
-            //				if( $model_object ){
1711
-            //					foreach( $fields_n_values as $field => $value ){
1712
-            //						$model_object->set($field, $value);
1713
-            //let's make sure default_where strategy is followed now
1714
-            $this->_ignore_where_strategy = false;
1715
-        }
1716
-        //if we want to keep model objects in sync, AND
1717
-        //if this wasn't called from a model object (to update itself)
1718
-        //then we want to make sure we keep all the existing
1719
-        //model objects in sync with the db
1720
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1721
-            if ($this->has_primary_key_field()) {
1722
-                $model_objs_affected_ids = $this->get_col($query_params);
1723
-            } else {
1724
-                //we need to select a bunch of columns and then combine them into the the "index primary key string"s
1725
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1726
-                $model_objs_affected_ids = array();
1727
-                foreach ($models_affected_key_columns as $row) {
1728
-                    $combined_index_key = $this->get_index_primary_key_string($row);
1729
-                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1730
-                }
1731
-            }
1732
-            if (! $model_objs_affected_ids) {
1733
-                //wait wait wait- if nothing was affected let's stop here
1734
-                return 0;
1735
-            }
1736
-            foreach ($model_objs_affected_ids as $id) {
1737
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
1738
-                if ($model_obj_in_entity_map) {
1739
-                    foreach ($fields_n_values as $field => $new_value) {
1740
-                        $model_obj_in_entity_map->set($field, $new_value);
1741
-                    }
1742
-                }
1743
-            }
1744
-            //if there is a primary key on this model, we can now do a slight optimization
1745
-            if ($this->has_primary_key_field()) {
1746
-                //we already know what we want to update. So let's make the query simpler so it's a little more efficient
1747
-                $query_params = array(
1748
-                    array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1749
-                    'limit'                    => count($model_objs_affected_ids),
1750
-                    'default_where_conditions' => EEM_Base::default_where_conditions_none,
1751
-                );
1752
-            }
1753
-        }
1754
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1755
-        $SQL = "UPDATE "
1756
-               . $model_query_info->get_full_join_sql()
1757
-               . " SET "
1758
-               . $this->_construct_update_sql($fields_n_values)
1759
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1760
-        $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1761
-        /**
1762
-         * Action called after a model update call has been made.
1763
-         *
1764
-         * @param EEM_Base $model
1765
-         * @param array    $fields_n_values the updated fields and their new values
1766
-         * @param array    $query_params    @see EEM_Base::get_all()
1767
-         * @param int      $rows_affected
1768
-         */
1769
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1770
-        return $rows_affected;//how many supposedly got updated
1771
-    }
1772
-
1773
-
1774
-
1775
-    /**
1776
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1777
-     * are teh values of the field specified (or by default the primary key field)
1778
-     * that matched the query params. Note that you should pass the name of the
1779
-     * model FIELD, not the database table's column name.
1780
-     *
1781
-     * @param array  $query_params @see EEM_Base::get_all()
1782
-     * @param string $field_to_select
1783
-     * @return array just like $wpdb->get_col()
1784
-     * @throws EE_Error
1785
-     */
1786
-    public function get_col($query_params = array(), $field_to_select = null)
1787
-    {
1788
-        if ($field_to_select) {
1789
-            $field = $this->field_settings_for($field_to_select);
1790
-        } elseif ($this->has_primary_key_field()) {
1791
-            $field = $this->get_primary_key_field();
1792
-        } else {
1793
-            //no primary key, just grab the first column
1794
-            $field = reset($this->field_settings());
1795
-        }
1796
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1797
-        $select_expressions = $field->get_qualified_column();
1798
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1799
-        return $this->_do_wpdb_query('get_col', array($SQL));
1800
-    }
1801
-
1802
-
1803
-
1804
-    /**
1805
-     * Returns a single column value for a single row from the database
1806
-     *
1807
-     * @param array  $query_params    @see EEM_Base::get_all()
1808
-     * @param string $field_to_select @see EEM_Base::get_col()
1809
-     * @return string
1810
-     * @throws EE_Error
1811
-     */
1812
-    public function get_var($query_params = array(), $field_to_select = null)
1813
-    {
1814
-        $query_params['limit'] = 1;
1815
-        $col = $this->get_col($query_params, $field_to_select);
1816
-        if (! empty($col)) {
1817
-            return reset($col);
1818
-        }
1819
-        return null;
1820
-    }
1821
-
1822
-
1823
-
1824
-    /**
1825
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1826
-     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1827
-     * injection, but currently no further filtering is done
1828
-     *
1829
-     * @global      $wpdb
1830
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1831
-     *                               be updated to in the DB
1832
-     * @return string of SQL
1833
-     * @throws EE_Error
1834
-     */
1835
-    public function _construct_update_sql($fields_n_values)
1836
-    {
1837
-        /** @type WPDB $wpdb */
1838
-        global $wpdb;
1839
-        $cols_n_values = array();
1840
-        foreach ($fields_n_values as $field_name => $value) {
1841
-            $field_obj = $this->field_settings_for($field_name);
1842
-            //if the value is NULL, we want to assign the value to that.
1843
-            //wpdb->prepare doesn't really handle that properly
1844
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1845
-            $value_sql = $prepared_value === null ? 'NULL'
1846
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1847
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1848
-        }
1849
-        return implode(",", $cols_n_values);
1850
-    }
1851
-
1852
-
1853
-
1854
-    /**
1855
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1856
-     * Performs a HARD delete, meaning the database row should always be removed,
1857
-     * not just have a flag field on it switched
1858
-     * Wrapper for EEM_Base::delete_permanently()
1859
-     *
1860
-     * @param mixed $id
1861
-     * @param boolean $allow_blocking
1862
-     * @return int the number of rows deleted
1863
-     * @throws EE_Error
1864
-     */
1865
-    public function delete_permanently_by_ID($id, $allow_blocking = true)
1866
-    {
1867
-        return $this->delete_permanently(
1868
-            array(
1869
-                array($this->get_primary_key_field()->get_name() => $id),
1870
-                'limit' => 1,
1871
-            ),
1872
-            $allow_blocking
1873
-        );
1874
-    }
1875
-
1876
-
1877
-
1878
-    /**
1879
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1880
-     * Wrapper for EEM_Base::delete()
1881
-     *
1882
-     * @param mixed $id
1883
-     * @param boolean $allow_blocking
1884
-     * @return int the number of rows deleted
1885
-     * @throws EE_Error
1886
-     */
1887
-    public function delete_by_ID($id, $allow_blocking = true)
1888
-    {
1889
-        return $this->delete(
1890
-            array(
1891
-                array($this->get_primary_key_field()->get_name() => $id),
1892
-                'limit' => 1,
1893
-            ),
1894
-            $allow_blocking
1895
-        );
1896
-    }
1897
-
1898
-
1899
-
1900
-    /**
1901
-     * Identical to delete_permanently, but does a "soft" delete if possible,
1902
-     * meaning if the model has a field that indicates its been "trashed" or
1903
-     * "soft deleted", we will just set that instead of actually deleting the rows.
1904
-     *
1905
-     * @see EEM_Base::delete_permanently
1906
-     * @param array   $query_params
1907
-     * @param boolean $allow_blocking
1908
-     * @return int how many rows got deleted
1909
-     * @throws EE_Error
1910
-     */
1911
-    public function delete($query_params, $allow_blocking = true)
1912
-    {
1913
-        return $this->delete_permanently($query_params, $allow_blocking);
1914
-    }
1915
-
1916
-
1917
-
1918
-    /**
1919
-     * Deletes the model objects that meet the query params. Note: this method is overridden
1920
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1921
-     * as archived, not actually deleted
1922
-     *
1923
-     * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1924
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1925
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1926
-     *                                deletes regardless of other objects which may depend on it. Its generally
1927
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1928
-     *                                DB
1929
-     * @return int how many rows got deleted
1930
-     * @throws EE_Error
1931
-     */
1932
-    public function delete_permanently($query_params, $allow_blocking = true)
1933
-    {
1934
-        /**
1935
-         * Action called just before performing a real deletion query. You can use the
1936
-         * model and its $query_params to find exactly which items will be deleted
1937
-         *
1938
-         * @param EEM_Base $model
1939
-         * @param array    $query_params   @see EEM_Base::get_all()
1940
-         * @param boolean  $allow_blocking whether or not to allow related model objects
1941
-         *                                 to block (prevent) this deletion
1942
-         */
1943
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1944
-        //some MySQL databases may be running safe mode, which may restrict
1945
-        //deletion if there is no KEY column used in the WHERE statement of a deletion.
1946
-        //to get around this, we first do a SELECT, get all the IDs, and then run another query
1947
-        //to delete them
1948
-        $items_for_deletion = $this->_get_all_wpdb_results($query_params);
1949
-        $columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
1950
-        $deletion_where_query_part = $this->_build_query_part_for_deleting_from_columns_and_values(
1951
-            $columns_and_ids_for_deleting
1952
-        );
1953
-        /**
1954
-         * Allows client code to act on the items being deleted before the query is actually executed.
1955
-         *
1956
-         * @param EEM_Base $this  The model instance being acted on.
1957
-         * @param array    $query_params  The incoming array of query parameters influencing what gets deleted.
1958
-         * @param bool     $allow_blocking @see param description in method phpdoc block.
1959
-         * @param array $columns_and_ids_for_deleting       An array indicating what entities will get removed as
1960
-         *                                                  derived from the incoming query parameters.
1961
-         *                                                  @see details on the structure of this array in the phpdocs
1962
-         *                                                  for the `_get_ids_for_delete_method`
1963
-         *
1964
-         */
1965
-        do_action('AHEE__EEM_Base__delete__before_query',
1966
-            $this,
1967
-            $query_params,
1968
-            $allow_blocking,
1969
-            $columns_and_ids_for_deleting
1970
-        );
1971
-        if ($deletion_where_query_part) {
1972
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
1973
-            $table_aliases = array_keys($this->_tables);
1974
-            $SQL = "DELETE "
1975
-                   . implode(", ", $table_aliases)
1976
-                   . " FROM "
1977
-                   . $model_query_info->get_full_join_sql()
1978
-                   . " WHERE "
1979
-                   . $deletion_where_query_part;
1980
-            $rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1981
-        } else {
1982
-            $rows_deleted = 0;
1983
-        }
1984
-
1985
-        //Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
1986
-        //there was no error with the delete query.
1987
-        if ($this->has_primary_key_field()
1988
-            && $rows_deleted !== false
1989
-            && isset($columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()])
1990
-        ) {
1991
-            $ids_for_removal = $columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()];
1992
-            foreach ($ids_for_removal as $id) {
1993
-                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
1994
-                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
1995
-                }
1996
-            }
1997
-
1998
-            // delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
1999
-            //`EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
2000
-            //unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
2001
-            // (although it is possible).
2002
-            //Note this can be skipped by using the provided filter and returning false.
2003
-            if (apply_filters(
2004
-                'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
2005
-                ! $this instanceof EEM_Extra_Meta,
2006
-                $this
2007
-            )) {
2008
-                EEM_Extra_Meta::instance()->delete_permanently(array(
2009
-                    0 => array(
2010
-                        'EXM_type' => $this->get_this_model_name(),
2011
-                        'OBJ_ID'   => array(
2012
-                            'IN',
2013
-                            $ids_for_removal
2014
-                        )
2015
-                    )
2016
-                ));
2017
-            }
2018
-        }
2019
-
2020
-        /**
2021
-         * Action called just after performing a real deletion query. Although at this point the
2022
-         * items should have been deleted
2023
-         *
2024
-         * @param EEM_Base $model
2025
-         * @param array    $query_params @see EEM_Base::get_all()
2026
-         * @param int      $rows_deleted
2027
-         */
2028
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
2029
-        return $rows_deleted;//how many supposedly got deleted
2030
-    }
2031
-
2032
-
2033
-
2034
-    /**
2035
-     * Checks all the relations that throw error messages when there are blocking related objects
2036
-     * for related model objects. If there are any related model objects on those relations,
2037
-     * adds an EE_Error, and return true
2038
-     *
2039
-     * @param EE_Base_Class|int $this_model_obj_or_id
2040
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
2041
-     *                                                 should be ignored when determining whether there are related
2042
-     *                                                 model objects which block this model object's deletion. Useful
2043
-     *                                                 if you know A is related to B and are considering deleting A,
2044
-     *                                                 but want to see if A has any other objects blocking its deletion
2045
-     *                                                 before removing the relation between A and B
2046
-     * @return boolean
2047
-     * @throws EE_Error
2048
-     */
2049
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
2050
-    {
2051
-        //first, if $ignore_this_model_obj was supplied, get its model
2052
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
2053
-            $ignored_model = $ignore_this_model_obj->get_model();
2054
-        } else {
2055
-            $ignored_model = null;
2056
-        }
2057
-        //now check all the relations of $this_model_obj_or_id and see if there
2058
-        //are any related model objects blocking it?
2059
-        $is_blocked = false;
2060
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
2061
-            if ($relation_obj->block_delete_if_related_models_exist()) {
2062
-                //if $ignore_this_model_obj was supplied, then for the query
2063
-                //on that model needs to be told to ignore $ignore_this_model_obj
2064
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
2065
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
2066
-                        array(
2067
-                            $ignored_model->get_primary_key_field()->get_name() => array(
2068
-                                '!=',
2069
-                                $ignore_this_model_obj->ID(),
2070
-                            ),
2071
-                        ),
2072
-                    ));
2073
-                } else {
2074
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
2075
-                }
2076
-                if ($related_model_objects) {
2077
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2078
-                    $is_blocked = true;
2079
-                }
2080
-            }
2081
-        }
2082
-        return $is_blocked;
2083
-    }
2084
-
2085
-
2086
-    /**
2087
-     * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
2088
-     * @param array $row_results_for_deleting
2089
-     * @param bool  $allow_blocking
2090
-     * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
2091
-     *                 model DOES have a primary_key_field, then the array will be a simple single dimension array where
2092
-     *                 the key is the fully qualified primary key column and the value is an array of ids that will be
2093
-     *                 deleted. Example:
2094
-     *                      array('Event.EVT_ID' => array( 1,2,3))
2095
-     *                 If the model DOES NOT have a primary_key_field, then the array will be a two dimensional array
2096
-     *                 where each element is a group of columns and values that get deleted. Example:
2097
-     *                      array(
2098
-     *                          0 => array(
2099
-     *                              'Term_Relationship.object_id' => 1
2100
-     *                              'Term_Relationship.term_taxonomy_id' => 5
2101
-     *                          ),
2102
-     *                          1 => array(
2103
-     *                              'Term_Relationship.object_id' => 1
2104
-     *                              'Term_Relationship.term_taxonomy_id' => 6
2105
-     *                          )
2106
-     *                      )
2107
-     * @throws EE_Error
2108
-     */
2109
-    protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
2110
-    {
2111
-        $ids_to_delete_indexed_by_column = array();
2112
-        if ($this->has_primary_key_field()) {
2113
-            $primary_table = $this->_get_main_table();
2114
-            $primary_table_pk_field = $this->get_field_by_column($primary_table->get_fully_qualified_pk_column());
2115
-            $other_tables = $this->_get_other_tables();
2116
-            $ids_to_delete_indexed_by_column = $query = array();
2117
-            foreach ($row_results_for_deleting as $item_to_delete) {
2118
-                //before we mark this item for deletion,
2119
-                //make sure there's no related entities blocking its deletion (if we're checking)
2120
-                if (
2121
-                    $allow_blocking
2122
-                    && $this->delete_is_blocked_by_related_models(
2123
-                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()]
2124
-                    )
2125
-                ) {
2126
-                    continue;
2127
-                }
2128
-                //primary table deletes
2129
-                if (isset($item_to_delete[$primary_table->get_fully_qualified_pk_column()])) {
2130
-                    $ids_to_delete_indexed_by_column[$primary_table->get_fully_qualified_pk_column()][] =
2131
-                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()];
2132
-                }
2133
-            }
2134
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2135
-            $fields = $this->get_combined_primary_key_fields();
2136
-            foreach ($row_results_for_deleting as $item_to_delete) {
2137
-                $ids_to_delete_indexed_by_column_for_row = array();
2138
-                foreach ($fields as $cpk_field) {
2139
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
2140
-                        $ids_to_delete_indexed_by_column_for_row[$cpk_field->get_qualified_column()] =
2141
-                            $item_to_delete[$cpk_field->get_qualified_column()];
2142
-                    }
2143
-                }
2144
-                $ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
2145
-            }
2146
-        } else {
2147
-            //so there's no primary key and no combined key...
2148
-            //sorry, can't help you
2149
-            throw new EE_Error(
2150
-                sprintf(
2151
-                    __(
2152
-                        "Cannot delete objects of type %s because there is no primary key NOR combined key",
2153
-                        "event_espresso"
2154
-                    ), get_class($this)
2155
-                )
2156
-            );
2157
-        }
2158
-        return $ids_to_delete_indexed_by_column;
2159
-    }
2160
-
2161
-
2162
-    /**
2163
-     * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
2164
-     * the corresponding query_part for the query performing the delete.
2165
-     *
2166
-     * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
2167
-     * @return string
2168
-     * @throws EE_Error
2169
-     */
2170
-    protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column) {
2171
-        $query_part = '';
2172
-        if (empty($ids_to_delete_indexed_by_column)) {
2173
-            return $query_part;
2174
-        } elseif ($this->has_primary_key_field()) {
2175
-            $query = array();
2176
-            foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
2177
-                //make sure we have unique $ids
2178
-                $ids = array_unique($ids);
2179
-                $query[] = $column . ' IN(' . implode(',', $ids) . ')';
2180
-            }
2181
-            $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
2182
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2183
-            $ways_to_identify_a_row = array();
2184
-            foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
2185
-                $values_for_each_combined_primary_key_for_a_row = array();
2186
-                foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
2187
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
2188
-                }
2189
-                $ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2190
-            }
2191
-            $query_part = implode(' OR ', $ways_to_identify_a_row);
2192
-        }
2193
-        return $query_part;
2194
-    }
2195
-
2196
-
2197
-
2198
-    /**
2199
-     * Gets the model field by the fully qualified name
2200
-     * @param string $qualified_column_name eg 'Event_CPT.post_name' or $field_obj->get_qualified_column()
2201
-     * @return EE_Model_Field_Base
2202
-     */
2203
-    public function get_field_by_column($qualified_column_name)
2204
-    {
2205
-       foreach($this->field_settings(true) as $field_name => $field_obj){
2206
-           if($field_obj->get_qualified_column() === $qualified_column_name){
2207
-               return $field_obj;
2208
-           }
2209
-       }
2210
-        throw new EE_Error(
2211
-            sprintf(
2212
-                esc_html__('Could not find a field on the model "%1$s" for qualified column "%2$s"', 'event_espresso'),
2213
-                $this->get_this_model_name(),
2214
-                $qualified_column_name
2215
-            )
2216
-        );
2217
-    }
2218
-
2219
-
2220
-
2221
-    /**
2222
-     * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2223
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2224
-     * column
2225
-     *
2226
-     * @param array  $query_params   like EEM_Base::get_all's
2227
-     * @param string $field_to_count field on model to count by (not column name)
2228
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2229
-     *                               that by the setting $distinct to TRUE;
2230
-     * @return int
2231
-     * @throws EE_Error
2232
-     */
2233
-    public function count($query_params = array(), $field_to_count = null, $distinct = false)
2234
-    {
2235
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2236
-        if ($field_to_count) {
2237
-            $field_obj = $this->field_settings_for($field_to_count);
2238
-            $column_to_count = $field_obj->get_qualified_column();
2239
-        } elseif ($this->has_primary_key_field()) {
2240
-            $pk_field_obj = $this->get_primary_key_field();
2241
-            $column_to_count = $pk_field_obj->get_qualified_column();
2242
-        } else {
2243
-            //there's no primary key
2244
-            //if we're counting distinct items, and there's no primary key,
2245
-            //we need to list out the columns for distinction;
2246
-            //otherwise we can just use star
2247
-            if ($distinct) {
2248
-                $columns_to_use = array();
2249
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2250
-                    $columns_to_use[] = $field_obj->get_qualified_column();
2251
-                }
2252
-                $column_to_count = implode(',', $columns_to_use);
2253
-            } else {
2254
-                $column_to_count = '*';
2255
-            }
2256
-        }
2257
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2258
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2259
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2260
-    }
2261
-
2262
-
2263
-
2264
-    /**
2265
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2266
-     *
2267
-     * @param array  $query_params like EEM_Base::get_all
2268
-     * @param string $field_to_sum name of field (array key in $_fields array)
2269
-     * @return float
2270
-     * @throws EE_Error
2271
-     */
2272
-    public function sum($query_params, $field_to_sum = null)
2273
-    {
2274
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2275
-        if ($field_to_sum) {
2276
-            $field_obj = $this->field_settings_for($field_to_sum);
2277
-        } else {
2278
-            $field_obj = $this->get_primary_key_field();
2279
-        }
2280
-        $column_to_count = $field_obj->get_qualified_column();
2281
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2282
-        $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2283
-        $data_type = $field_obj->get_wpdb_data_type();
2284
-        if ($data_type === '%d' || $data_type === '%s') {
2285
-            return (float)$return_value;
2286
-        }
2287
-        //must be %f
2288
-        return (float)$return_value;
2289
-    }
2290
-
2291
-
2292
-
2293
-    /**
2294
-     * Just calls the specified method on $wpdb with the given arguments
2295
-     * Consolidates a little extra error handling code
2296
-     *
2297
-     * @param string $wpdb_method
2298
-     * @param array  $arguments_to_provide
2299
-     * @throws EE_Error
2300
-     * @global wpdb  $wpdb
2301
-     * @return mixed
2302
-     */
2303
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2304
-    {
2305
-        //if we're in maintenance mode level 2, DON'T run any queries
2306
-        //because level 2 indicates the database needs updating and
2307
-        //is probably out of sync with the code
2308
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2309
-            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.",
2310
-                "event_espresso")));
2311
-        }
2312
-        /** @type WPDB $wpdb */
2313
-        global $wpdb;
2314
-        if (! method_exists($wpdb, $wpdb_method)) {
2315
-            throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2316
-                'event_espresso'), $wpdb_method));
2317
-        }
2318
-        if (WP_DEBUG) {
2319
-            $old_show_errors_value = $wpdb->show_errors;
2320
-            $wpdb->show_errors(false);
2321
-        }
2322
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2323
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
2324
-        if (WP_DEBUG) {
2325
-            $wpdb->show_errors($old_show_errors_value);
2326
-            if (! empty($wpdb->last_error)) {
2327
-                throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2328
-            }
2329
-            if ($result === false) {
2330
-                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"',
2331
-                    'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2332
-            }
2333
-        } elseif ($result === false) {
2334
-            EE_Error::add_error(
2335
-                sprintf(
2336
-                    __('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"',
2337
-                        'event_espresso'),
2338
-                    $wpdb_method,
2339
-                    var_export($arguments_to_provide, true),
2340
-                    $wpdb->last_error
2341
-                ),
2342
-                __FILE__,
2343
-                __FUNCTION__,
2344
-                __LINE__
2345
-            );
2346
-        }
2347
-        return $result;
2348
-    }
2349
-
2350
-
2351
-
2352
-    /**
2353
-     * Attempts to run the indicated WPDB method with the provided arguments,
2354
-     * and if there's an error tries to verify the DB is correct. Uses
2355
-     * the static property EEM_Base::$_db_verification_level to determine whether
2356
-     * we should try to fix the EE core db, the addons, or just give up
2357
-     *
2358
-     * @param string $wpdb_method
2359
-     * @param array  $arguments_to_provide
2360
-     * @return mixed
2361
-     */
2362
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2363
-    {
2364
-        /** @type WPDB $wpdb */
2365
-        global $wpdb;
2366
-        $wpdb->last_error = null;
2367
-        $result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2368
-        // was there an error running the query? but we don't care on new activations
2369
-        // (we're going to setup the DB anyway on new activations)
2370
-        if (($result === false || ! empty($wpdb->last_error))
2371
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2372
-        ) {
2373
-            switch (EEM_Base::$_db_verification_level) {
2374
-                case EEM_Base::db_verified_none :
2375
-                    // let's double-check core's DB
2376
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2377
-                    break;
2378
-                case EEM_Base::db_verified_core :
2379
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2380
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2381
-                    break;
2382
-                case EEM_Base::db_verified_addons :
2383
-                    // ummmm... you in trouble
2384
-                    return $result;
2385
-                    break;
2386
-            }
2387
-            if (! empty($error_message)) {
2388
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2389
-                trigger_error($error_message);
2390
-            }
2391
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2392
-        }
2393
-        return $result;
2394
-    }
2395
-
2396
-
2397
-
2398
-    /**
2399
-     * Verifies the EE core database is up-to-date and records that we've done it on
2400
-     * EEM_Base::$_db_verification_level
2401
-     *
2402
-     * @param string $wpdb_method
2403
-     * @param array  $arguments_to_provide
2404
-     * @return string
2405
-     */
2406
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
2407
-    {
2408
-        /** @type WPDB $wpdb */
2409
-        global $wpdb;
2410
-        //ok remember that we've already attempted fixing the core db, in case the problem persists
2411
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2412
-        $error_message = sprintf(
2413
-            __('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2414
-                'event_espresso'),
2415
-            $wpdb->last_error,
2416
-            $wpdb_method,
2417
-            wp_json_encode($arguments_to_provide)
2418
-        );
2419
-        EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2420
-        return $error_message;
2421
-    }
2422
-
2423
-
2424
-
2425
-    /**
2426
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
2427
-     * EEM_Base::$_db_verification_level
2428
-     *
2429
-     * @param $wpdb_method
2430
-     * @param $arguments_to_provide
2431
-     * @return string
2432
-     */
2433
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2434
-    {
2435
-        /** @type WPDB $wpdb */
2436
-        global $wpdb;
2437
-        //ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2438
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2439
-        $error_message = sprintf(
2440
-            __('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2441
-                'event_espresso'),
2442
-            $wpdb->last_error,
2443
-            $wpdb_method,
2444
-            wp_json_encode($arguments_to_provide)
2445
-        );
2446
-        EE_System::instance()->initialize_addons();
2447
-        return $error_message;
2448
-    }
2449
-
2450
-
2451
-
2452
-    /**
2453
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2454
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2455
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2456
-     * ..."
2457
-     *
2458
-     * @param EE_Model_Query_Info_Carrier $model_query_info
2459
-     * @return string
2460
-     */
2461
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2462
-    {
2463
-        return " FROM " . $model_query_info->get_full_join_sql() .
2464
-               $model_query_info->get_where_sql() .
2465
-               $model_query_info->get_group_by_sql() .
2466
-               $model_query_info->get_having_sql() .
2467
-               $model_query_info->get_order_by_sql() .
2468
-               $model_query_info->get_limit_sql();
2469
-    }
2470
-
2471
-
2472
-
2473
-    /**
2474
-     * Set to easily debug the next X queries ran from this model.
2475
-     *
2476
-     * @param int $count
2477
-     */
2478
-    public function show_next_x_db_queries($count = 1)
2479
-    {
2480
-        $this->_show_next_x_db_queries = $count;
2481
-    }
2482
-
2483
-
2484
-
2485
-    /**
2486
-     * @param $sql_query
2487
-     */
2488
-    public function show_db_query_if_previously_requested($sql_query)
2489
-    {
2490
-        if ($this->_show_next_x_db_queries > 0) {
2491
-            echo $sql_query;
2492
-            $this->_show_next_x_db_queries--;
2493
-        }
2494
-    }
2495
-
2496
-
2497
-
2498
-    /**
2499
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2500
-     * There are the 3 cases:
2501
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2502
-     * $otherModelObject has no ID, it is first saved.
2503
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2504
-     * has no ID, it is first saved.
2505
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2506
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2507
-     * join table
2508
-     *
2509
-     * @param        EE_Base_Class                     /int $thisModelObject
2510
-     * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2511
-     * @param string $relationName                     , key in EEM_Base::_relations
2512
-     *                                                 an attendee to a group, you also want to specify which role they
2513
-     *                                                 will have in that group. So you would use this parameter to
2514
-     *                                                 specify array('role-column-name'=>'role-id')
2515
-     * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2516
-     *                                                 to for relation to methods that allow you to further specify
2517
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2518
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
2519
-     *                                                 because these will be inserted in any new rows created as well.
2520
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2521
-     * @throws EE_Error
2522
-     */
2523
-    public function add_relationship_to(
2524
-        $id_or_obj,
2525
-        $other_model_id_or_obj,
2526
-        $relationName,
2527
-        $extra_join_model_fields_n_values = array()
2528
-    ) {
2529
-        $relation_obj = $this->related_settings_for($relationName);
2530
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2531
-    }
2532
-
2533
-
2534
-
2535
-    /**
2536
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2537
-     * There are the 3 cases:
2538
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2539
-     * error
2540
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2541
-     * an error
2542
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2543
-     *
2544
-     * @param        EE_Base_Class /int $id_or_obj
2545
-     * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2546
-     * @param string $relationName key in EEM_Base::_relations
2547
-     * @return boolean of success
2548
-     * @throws EE_Error
2549
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2550
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2551
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2552
-     *                             because these will be inserted in any new rows created as well.
2553
-     */
2554
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2555
-    {
2556
-        $relation_obj = $this->related_settings_for($relationName);
2557
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2558
-    }
2559
-
2560
-
2561
-
2562
-    /**
2563
-     * @param mixed           $id_or_obj
2564
-     * @param string          $relationName
2565
-     * @param array           $where_query_params
2566
-     * @param EE_Base_Class[] objects to which relations were removed
2567
-     * @return \EE_Base_Class[]
2568
-     * @throws EE_Error
2569
-     */
2570
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2571
-    {
2572
-        $relation_obj = $this->related_settings_for($relationName);
2573
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2574
-    }
2575
-
2576
-
2577
-
2578
-    /**
2579
-     * Gets all the related items of the specified $model_name, using $query_params.
2580
-     * Note: by default, we remove the "default query params"
2581
-     * because we want to get even deleted items etc.
2582
-     *
2583
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2584
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
2585
-     * @param array  $query_params like EEM_Base::get_all
2586
-     * @return EE_Base_Class[]
2587
-     * @throws EE_Error
2588
-     */
2589
-    public function get_all_related($id_or_obj, $model_name, $query_params = null)
2590
-    {
2591
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2592
-        $relation_settings = $this->related_settings_for($model_name);
2593
-        return $relation_settings->get_all_related($model_obj, $query_params);
2594
-    }
2595
-
2596
-
2597
-
2598
-    /**
2599
-     * Deletes all the model objects across the relation indicated by $model_name
2600
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
2601
-     * However, if the model objects can't be deleted because of blocking related model objects, then
2602
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2603
-     *
2604
-     * @param EE_Base_Class|int|string $id_or_obj
2605
-     * @param string                   $model_name
2606
-     * @param array                    $query_params
2607
-     * @return int how many deleted
2608
-     * @throws EE_Error
2609
-     */
2610
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
2611
-    {
2612
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2613
-        $relation_settings = $this->related_settings_for($model_name);
2614
-        return $relation_settings->delete_all_related($model_obj, $query_params);
2615
-    }
2616
-
2617
-
2618
-
2619
-    /**
2620
-     * Hard deletes all the model objects across the relation indicated by $model_name
2621
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
2622
-     * the model objects can't be hard deleted because of blocking related model objects,
2623
-     * just does a soft-delete on them instead.
2624
-     *
2625
-     * @param EE_Base_Class|int|string $id_or_obj
2626
-     * @param string                   $model_name
2627
-     * @param array                    $query_params
2628
-     * @return int how many deleted
2629
-     * @throws EE_Error
2630
-     */
2631
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2632
-    {
2633
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2634
-        $relation_settings = $this->related_settings_for($model_name);
2635
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
2636
-    }
2637
-
2638
-
2639
-
2640
-    /**
2641
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2642
-     * unless otherwise specified in the $query_params
2643
-     *
2644
-     * @param        int             /EE_Base_Class $id_or_obj
2645
-     * @param string $model_name     like 'Event', or 'Registration'
2646
-     * @param array  $query_params   like EEM_Base::get_all's
2647
-     * @param string $field_to_count name of field to count by. By default, uses primary key
2648
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2649
-     *                               that by the setting $distinct to TRUE;
2650
-     * @return int
2651
-     * @throws EE_Error
2652
-     */
2653
-    public function count_related(
2654
-        $id_or_obj,
2655
-        $model_name,
2656
-        $query_params = array(),
2657
-        $field_to_count = null,
2658
-        $distinct = false
2659
-    ) {
2660
-        $related_model = $this->get_related_model_obj($model_name);
2661
-        //we're just going to use the query params on the related model's normal get_all query,
2662
-        //except add a condition to say to match the current mod
2663
-        if (! isset($query_params['default_where_conditions'])) {
2664
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2665
-        }
2666
-        $this_model_name = $this->get_this_model_name();
2667
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2668
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2669
-        return $related_model->count($query_params, $field_to_count, $distinct);
2670
-    }
2671
-
2672
-
2673
-
2674
-    /**
2675
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
2676
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2677
-     *
2678
-     * @param        int           /EE_Base_Class $id_or_obj
2679
-     * @param string $model_name   like 'Event', or 'Registration'
2680
-     * @param array  $query_params like EEM_Base::get_all's
2681
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
2682
-     * @return float
2683
-     * @throws EE_Error
2684
-     */
2685
-    public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2686
-    {
2687
-        $related_model = $this->get_related_model_obj($model_name);
2688
-        if (! is_array($query_params)) {
2689
-            EE_Error::doing_it_wrong('EEM_Base::sum_related',
2690
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2691
-                    gettype($query_params)), '4.6.0');
2692
-            $query_params = array();
2693
-        }
2694
-        //we're just going to use the query params on the related model's normal get_all query,
2695
-        //except add a condition to say to match the current mod
2696
-        if (! isset($query_params['default_where_conditions'])) {
2697
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2698
-        }
2699
-        $this_model_name = $this->get_this_model_name();
2700
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2701
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2702
-        return $related_model->sum($query_params, $field_to_sum);
2703
-    }
2704
-
2705
-
2706
-
2707
-    /**
2708
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2709
-     * $modelObject
2710
-     *
2711
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2712
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2713
-     * @param array               $query_params     like EEM_Base::get_all's
2714
-     * @return EE_Base_Class
2715
-     * @throws EE_Error
2716
-     */
2717
-    public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2718
-    {
2719
-        $query_params['limit'] = 1;
2720
-        $results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2721
-        if ($results) {
2722
-            return array_shift($results);
2723
-        }
2724
-        return null;
2725
-    }
2726
-
2727
-
2728
-
2729
-    /**
2730
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2731
-     *
2732
-     * @return string
2733
-     */
2734
-    public function get_this_model_name()
2735
-    {
2736
-        return str_replace("EEM_", "", get_class($this));
2737
-    }
2738
-
2739
-
2740
-
2741
-    /**
2742
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2743
-     *
2744
-     * @return EE_Any_Foreign_Model_Name_Field
2745
-     * @throws EE_Error
2746
-     */
2747
-    public function get_field_containing_related_model_name()
2748
-    {
2749
-        foreach ($this->field_settings(true) as $field) {
2750
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2751
-                $field_with_model_name = $field;
2752
-            }
2753
-        }
2754
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2755
-            throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2756
-                $this->get_this_model_name()));
2757
-        }
2758
-        return $field_with_model_name;
2759
-    }
2760
-
2761
-
2762
-
2763
-    /**
2764
-     * Inserts a new entry into the database, for each table.
2765
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2766
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2767
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
2768
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
2769
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2770
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2771
-     *
2772
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2773
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2774
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2775
-     *                              of EEM_Base)
2776
-     * @return int new primary key on main table that got inserted
2777
-     * @throws EE_Error
2778
-     */
2779
-    public function insert($field_n_values)
2780
-    {
2781
-        /**
2782
-         * Filters the fields and their values before inserting an item using the models
2783
-         *
2784
-         * @param array    $fields_n_values keys are the fields and values are their new values
2785
-         * @param EEM_Base $model           the model used
2786
-         */
2787
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2788
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
2789
-            $main_table = $this->_get_main_table();
2790
-            $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2791
-            if ($new_id !== false) {
2792
-                foreach ($this->_get_other_tables() as $other_table) {
2793
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2794
-                }
2795
-            }
2796
-            /**
2797
-             * Done just after attempting to insert a new model object
2798
-             *
2799
-             * @param EEM_Base   $model           used
2800
-             * @param array      $fields_n_values fields and their values
2801
-             * @param int|string the              ID of the newly-inserted model object
2802
-             */
2803
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2804
-            return $new_id;
2805
-        }
2806
-        return false;
2807
-    }
2808
-
2809
-
2810
-
2811
-    /**
2812
-     * Checks that the result would satisfy the unique indexes on this model
2813
-     *
2814
-     * @param array  $field_n_values
2815
-     * @param string $action
2816
-     * @return boolean
2817
-     * @throws EE_Error
2818
-     */
2819
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2820
-    {
2821
-        foreach ($this->unique_indexes() as $index_name => $index) {
2822
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2823
-            if ($this->exists(array($uniqueness_where_params))) {
2824
-                EE_Error::add_error(
2825
-                    sprintf(
2826
-                        __(
2827
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2828
-                            "event_espresso"
2829
-                        ),
2830
-                        $action,
2831
-                        $this->_get_class_name(),
2832
-                        $index_name,
2833
-                        implode(",", $index->field_names()),
2834
-                        http_build_query($uniqueness_where_params)
2835
-                    ),
2836
-                    __FILE__,
2837
-                    __FUNCTION__,
2838
-                    __LINE__
2839
-                );
2840
-                return false;
2841
-            }
2842
-        }
2843
-        return true;
2844
-    }
2845
-
2846
-
2847
-
2848
-    /**
2849
-     * Checks the database for an item that conflicts (ie, if this item were
2850
-     * saved to the DB would break some uniqueness requirement, like a primary key
2851
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
2852
-     * can be either an EE_Base_Class or an array of fields n values
2853
-     *
2854
-     * @param EE_Base_Class|array $obj_or_fields_array
2855
-     * @param boolean             $include_primary_key whether to use the model object's primary key
2856
-     *                                                 when looking for conflicts
2857
-     *                                                 (ie, if false, we ignore the model object's primary key
2858
-     *                                                 when finding "conflicts". If true, it's also considered).
2859
-     *                                                 Only works for INT primary key,
2860
-     *                                                 STRING primary keys cannot be ignored
2861
-     * @throws EE_Error
2862
-     * @return EE_Base_Class|array
2863
-     */
2864
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2865
-    {
2866
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
2867
-            $fields_n_values = $obj_or_fields_array->model_field_array();
2868
-        } elseif (is_array($obj_or_fields_array)) {
2869
-            $fields_n_values = $obj_or_fields_array;
2870
-        } else {
2871
-            throw new EE_Error(
2872
-                sprintf(
2873
-                    __(
2874
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2875
-                        "event_espresso"
2876
-                    ),
2877
-                    get_class($this),
2878
-                    $obj_or_fields_array
2879
-                )
2880
-            );
2881
-        }
2882
-        $query_params = array();
2883
-        if ($this->has_primary_key_field()
2884
-            && ($include_primary_key
2885
-                || $this->get_primary_key_field()
2886
-                   instanceof
2887
-                   EE_Primary_Key_String_Field)
2888
-            && isset($fields_n_values[$this->primary_key_name()])
2889
-        ) {
2890
-            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2891
-        }
2892
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2893
-            $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2894
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2895
-        }
2896
-        //if there is nothing to base this search on, then we shouldn't find anything
2897
-        if (empty($query_params)) {
2898
-            return array();
2899
-        }
2900
-        return $this->get_one($query_params);
2901
-    }
2902
-
2903
-
2904
-
2905
-    /**
2906
-     * Like count, but is optimized and returns a boolean instead of an int
2907
-     *
2908
-     * @param array $query_params
2909
-     * @return boolean
2910
-     * @throws EE_Error
2911
-     */
2912
-    public function exists($query_params)
2913
-    {
2914
-        $query_params['limit'] = 1;
2915
-        return $this->count($query_params) > 0;
2916
-    }
2917
-
2918
-
2919
-
2920
-    /**
2921
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
2922
-     *
2923
-     * @param int|string $id
2924
-     * @return boolean
2925
-     * @throws EE_Error
2926
-     */
2927
-    public function exists_by_ID($id)
2928
-    {
2929
-        return $this->exists(
2930
-            array(
2931
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
2932
-                array(
2933
-                    $this->primary_key_name() => $id,
2934
-                ),
2935
-            )
2936
-        );
2937
-    }
2938
-
2939
-
2940
-
2941
-    /**
2942
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2943
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2944
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2945
-     * on the main table)
2946
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
2947
-     * cases where we want to call it directly rather than via insert().
2948
-     *
2949
-     * @access   protected
2950
-     * @param EE_Table_Base $table
2951
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2952
-     *                                       float
2953
-     * @param int           $new_id          for now we assume only int keys
2954
-     * @throws EE_Error
2955
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2956
-     * @return int ID of new row inserted, or FALSE on failure
2957
-     */
2958
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2959
-    {
2960
-        global $wpdb;
2961
-        $insertion_col_n_values = array();
2962
-        $format_for_insertion = array();
2963
-        $fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2964
-        foreach ($fields_on_table as $field_name => $field_obj) {
2965
-            //check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2966
-            if ($field_obj->is_auto_increment()) {
2967
-                continue;
2968
-            }
2969
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2970
-            //if the value we want to assign it to is NULL, just don't mention it for the insertion
2971
-            if ($prepared_value !== null) {
2972
-                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2973
-                $format_for_insertion[] = $field_obj->get_wpdb_data_type();
2974
-            }
2975
-        }
2976
-        if ($table instanceof EE_Secondary_Table && $new_id) {
2977
-            //its not the main table, so we should have already saved the main table's PK which we just inserted
2978
-            //so add the fk to the main table as a column
2979
-            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2980
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2981
-        }
2982
-        //insert the new entry
2983
-        $result = $this->_do_wpdb_query('insert',
2984
-            array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2985
-        if ($result === false) {
2986
-            return false;
2987
-        }
2988
-        //ok, now what do we return for the ID of the newly-inserted thing?
2989
-        if ($this->has_primary_key_field()) {
2990
-            if ($this->get_primary_key_field()->is_auto_increment()) {
2991
-                return $wpdb->insert_id;
2992
-            }
2993
-            //it's not an auto-increment primary key, so
2994
-            //it must have been supplied
2995
-            return $fields_n_values[$this->get_primary_key_field()->get_name()];
2996
-        }
2997
-        //we can't return a  primary key because there is none. instead return
2998
-        //a unique string indicating this model
2999
-        return $this->get_index_primary_key_string($fields_n_values);
3000
-    }
3001
-
3002
-
3003
-
3004
-    /**
3005
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
3006
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
3007
-     * and there is no default, we pass it along. WPDB will take care of it)
3008
-     *
3009
-     * @param EE_Model_Field_Base $field_obj
3010
-     * @param array               $fields_n_values
3011
-     * @return mixed string|int|float depending on what the table column will be expecting
3012
-     * @throws EE_Error
3013
-     */
3014
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
3015
-    {
3016
-        //if this field doesn't allow nullable, don't allow it
3017
-        if (
3018
-            ! $field_obj->is_nullable()
3019
-            && (
3020
-                ! isset($fields_n_values[$field_obj->get_name()])
3021
-                || $fields_n_values[$field_obj->get_name()] === null
3022
-            )
3023
-        ) {
3024
-            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
3025
-        }
3026
-        $unprepared_value = isset($fields_n_values[$field_obj->get_name()])
3027
-            ? $fields_n_values[$field_obj->get_name()]
3028
-            : null;
3029
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
3030
-    }
3031
-
3032
-
3033
-
3034
-    /**
3035
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
3036
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
3037
-     * the field's prepare_for_set() method.
3038
-     *
3039
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
3040
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
3041
-     *                                   top of file)
3042
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
3043
-     *                                   $value is a custom selection
3044
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
3045
-     */
3046
-    private function _prepare_value_for_use_in_db($value, $field)
3047
-    {
3048
-        if ($field && $field instanceof EE_Model_Field_Base) {
3049
-            switch ($this->_values_already_prepared_by_model_object) {
3050
-                /** @noinspection PhpMissingBreakStatementInspection */
3051
-                case self::not_prepared_by_model_object:
3052
-                    $value = $field->prepare_for_set($value);
3053
-                //purposefully left out "return"
3054
-                case self::prepared_by_model_object:
3055
-                    /** @noinspection SuspiciousAssignmentsInspection */
3056
-                    $value = $field->prepare_for_use_in_db($value);
3057
-                case self::prepared_for_use_in_db:
3058
-                    //leave the value alone
3059
-            }
3060
-            return $value;
3061
-        }
3062
-        return $value;
3063
-    }
3064
-
3065
-
3066
-
3067
-    /**
3068
-     * Returns the main table on this model
3069
-     *
3070
-     * @return EE_Primary_Table
3071
-     * @throws EE_Error
3072
-     */
3073
-    protected function _get_main_table()
3074
-    {
3075
-        foreach ($this->_tables as $table) {
3076
-            if ($table instanceof EE_Primary_Table) {
3077
-                return $table;
3078
-            }
3079
-        }
3080
-        throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
3081
-            'event_espresso'), get_class($this)));
3082
-    }
3083
-
3084
-
3085
-
3086
-    /**
3087
-     * table
3088
-     * returns EE_Primary_Table table name
3089
-     *
3090
-     * @return string
3091
-     * @throws EE_Error
3092
-     */
3093
-    public function table()
3094
-    {
3095
-        return $this->_get_main_table()->get_table_name();
3096
-    }
3097
-
3098
-
3099
-
3100
-    /**
3101
-     * table
3102
-     * returns first EE_Secondary_Table table name
3103
-     *
3104
-     * @return string
3105
-     */
3106
-    public function second_table()
3107
-    {
3108
-        // grab second table from tables array
3109
-        $second_table = end($this->_tables);
3110
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
3111
-    }
3112
-
3113
-
3114
-
3115
-    /**
3116
-     * get_table_obj_by_alias
3117
-     * returns table name given it's alias
3118
-     *
3119
-     * @param string $table_alias
3120
-     * @return EE_Primary_Table | EE_Secondary_Table
3121
-     */
3122
-    public function get_table_obj_by_alias($table_alias = '')
3123
-    {
3124
-        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3125
-    }
3126
-
3127
-
3128
-
3129
-    /**
3130
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3131
-     *
3132
-     * @return EE_Secondary_Table[]
3133
-     */
3134
-    protected function _get_other_tables()
3135
-    {
3136
-        $other_tables = array();
3137
-        foreach ($this->_tables as $table_alias => $table) {
3138
-            if ($table instanceof EE_Secondary_Table) {
3139
-                $other_tables[$table_alias] = $table;
3140
-            }
3141
-        }
3142
-        return $other_tables;
3143
-    }
3144
-
3145
-
3146
-
3147
-    /**
3148
-     * Finds all the fields that correspond to the given table
3149
-     *
3150
-     * @param string $table_alias , array key in EEM_Base::_tables
3151
-     * @return EE_Model_Field_Base[]
3152
-     */
3153
-    public function _get_fields_for_table($table_alias)
3154
-    {
3155
-        return $this->_fields[$table_alias];
3156
-    }
3157
-
3158
-
3159
-
3160
-    /**
3161
-     * Recurses through all the where parameters, and finds all the related models we'll need
3162
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3163
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3164
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3165
-     * related Registration, Transaction, and Payment models.
3166
-     *
3167
-     * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3168
-     * @return EE_Model_Query_Info_Carrier
3169
-     * @throws EE_Error
3170
-     */
3171
-    public function _extract_related_models_from_query($query_params)
3172
-    {
3173
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
3174
-        if (array_key_exists(0, $query_params)) {
3175
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3176
-        }
3177
-        if (array_key_exists('group_by', $query_params)) {
3178
-            if (is_array($query_params['group_by'])) {
3179
-                $this->_extract_related_models_from_sub_params_array_values(
3180
-                    $query_params['group_by'],
3181
-                    $query_info_carrier,
3182
-                    'group_by'
3183
-                );
3184
-            } elseif (! empty ($query_params['group_by'])) {
3185
-                $this->_extract_related_model_info_from_query_param(
3186
-                    $query_params['group_by'],
3187
-                    $query_info_carrier,
3188
-                    'group_by'
3189
-                );
3190
-            }
3191
-        }
3192
-        if (array_key_exists('having', $query_params)) {
3193
-            $this->_extract_related_models_from_sub_params_array_keys(
3194
-                $query_params[0],
3195
-                $query_info_carrier,
3196
-                'having'
3197
-            );
3198
-        }
3199
-        if (array_key_exists('order_by', $query_params)) {
3200
-            if (is_array($query_params['order_by'])) {
3201
-                $this->_extract_related_models_from_sub_params_array_keys(
3202
-                    $query_params['order_by'],
3203
-                    $query_info_carrier,
3204
-                    'order_by'
3205
-                );
3206
-            } elseif (! empty($query_params['order_by'])) {
3207
-                $this->_extract_related_model_info_from_query_param(
3208
-                    $query_params['order_by'],
3209
-                    $query_info_carrier,
3210
-                    'order_by'
3211
-                );
3212
-            }
3213
-        }
3214
-        if (array_key_exists('force_join', $query_params)) {
3215
-            $this->_extract_related_models_from_sub_params_array_values(
3216
-                $query_params['force_join'],
3217
-                $query_info_carrier,
3218
-                'force_join'
3219
-            );
3220
-        }
3221
-        return $query_info_carrier;
3222
-    }
3223
-
3224
-
3225
-
3226
-    /**
3227
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3228
-     *
3229
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3230
-     *                                                      $query_params['having']
3231
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3232
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3233
-     * @throws EE_Error
3234
-     * @return \EE_Model_Query_Info_Carrier
3235
-     */
3236
-    private function _extract_related_models_from_sub_params_array_keys(
3237
-        $sub_query_params,
3238
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3239
-        $query_param_type
3240
-    ) {
3241
-        if (! empty($sub_query_params)) {
3242
-            $sub_query_params = (array)$sub_query_params;
3243
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
3244
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3245
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3246
-                    $query_param_type);
3247
-                //if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3248
-                //indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3249
-                //extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3250
-                //of array('Registration.TXN_ID'=>23)
3251
-                $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3252
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3253
-                    if (! is_array($possibly_array_of_params)) {
3254
-                        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'))",
3255
-                            "event_espresso"),
3256
-                            $param, $possibly_array_of_params));
3257
-                    }
3258
-                    $this->_extract_related_models_from_sub_params_array_keys(
3259
-                        $possibly_array_of_params,
3260
-                        $model_query_info_carrier, $query_param_type
3261
-                    );
3262
-                } elseif ($query_param_type === 0 //ie WHERE
3263
-                          && is_array($possibly_array_of_params)
3264
-                          && isset($possibly_array_of_params[2])
3265
-                          && $possibly_array_of_params[2] == true
3266
-                ) {
3267
-                    //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3268
-                    //indicating that $possible_array_of_params[1] is actually a field name,
3269
-                    //from which we should extract query parameters!
3270
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3271
-                        throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3272
-                            "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3273
-                    }
3274
-                    $this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3275
-                        $model_query_info_carrier, $query_param_type);
3276
-                }
3277
-            }
3278
-        }
3279
-        return $model_query_info_carrier;
3280
-    }
3281
-
3282
-
3283
-
3284
-    /**
3285
-     * For extracting related models from forced_joins, where the array values contain the info about what
3286
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3287
-     *
3288
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3289
-     *                                                      $query_params['having']
3290
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3291
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3292
-     * @throws EE_Error
3293
-     * @return \EE_Model_Query_Info_Carrier
3294
-     */
3295
-    private function _extract_related_models_from_sub_params_array_values(
3296
-        $sub_query_params,
3297
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3298
-        $query_param_type
3299
-    ) {
3300
-        if (! empty($sub_query_params)) {
3301
-            if (! is_array($sub_query_params)) {
3302
-                throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3303
-                    $sub_query_params));
3304
-            }
3305
-            foreach ($sub_query_params as $param) {
3306
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3307
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3308
-                    $query_param_type);
3309
-            }
3310
-        }
3311
-        return $model_query_info_carrier;
3312
-    }
3313
-
3314
-
3315
-
3316
-    /**
3317
-     * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3318
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3319
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
3320
-     * but use them in a different order. Eg, we need to know what models we are querying
3321
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3322
-     * other models before we can finalize the where clause SQL.
3323
-     *
3324
-     * @param array $query_params
3325
-     * @throws EE_Error
3326
-     * @return EE_Model_Query_Info_Carrier
3327
-     */
3328
-    public function _create_model_query_info_carrier($query_params)
3329
-    {
3330
-        if (! is_array($query_params)) {
3331
-            EE_Error::doing_it_wrong(
3332
-                'EEM_Base::_create_model_query_info_carrier',
3333
-                sprintf(
3334
-                    __(
3335
-                        '$query_params should be an array, you passed a variable of type %s',
3336
-                        'event_espresso'
3337
-                    ),
3338
-                    gettype($query_params)
3339
-                ),
3340
-                '4.6.0'
3341
-            );
3342
-            $query_params = array();
3343
-        }
3344
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3345
-        //first check if we should alter the query to account for caps or not
3346
-        //because the caps might require us to do extra joins
3347
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3348
-            $query_params[0] = $where_query_params = array_replace_recursive(
3349
-                $where_query_params,
3350
-                $this->caps_where_conditions(
3351
-                    $query_params['caps']
3352
-                )
3353
-            );
3354
-        }
3355
-        $query_object = $this->_extract_related_models_from_query($query_params);
3356
-        //verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3357
-        foreach ($where_query_params as $key => $value) {
3358
-            if (is_int($key)) {
3359
-                throw new EE_Error(
3360
-                    sprintf(
3361
-                        __(
3362
-                            "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.",
3363
-                            "event_espresso"
3364
-                        ),
3365
-                        $key,
3366
-                        var_export($value, true),
3367
-                        var_export($query_params, true),
3368
-                        get_class($this)
3369
-                    )
3370
-                );
3371
-            }
3372
-        }
3373
-        if (
3374
-            array_key_exists('default_where_conditions', $query_params)
3375
-            && ! empty($query_params['default_where_conditions'])
3376
-        ) {
3377
-            $use_default_where_conditions = $query_params['default_where_conditions'];
3378
-        } else {
3379
-            $use_default_where_conditions = EEM_Base::default_where_conditions_all;
3380
-        }
3381
-        $where_query_params = array_merge(
3382
-            $this->_get_default_where_conditions_for_models_in_query(
3383
-                $query_object,
3384
-                $use_default_where_conditions,
3385
-                $where_query_params
3386
-            ),
3387
-            $where_query_params
3388
-        );
3389
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3390
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3391
-        // So we need to setup a subquery and use that for the main join.
3392
-        // Note for now this only works on the primary table for the model.
3393
-        // So for instance, you could set the limit array like this:
3394
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3395
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3396
-            $query_object->set_main_model_join_sql(
3397
-                $this->_construct_limit_join_select(
3398
-                    $query_params['on_join_limit'][0],
3399
-                    $query_params['on_join_limit'][1]
3400
-                )
3401
-            );
3402
-        }
3403
-        //set limit
3404
-        if (array_key_exists('limit', $query_params)) {
3405
-            if (is_array($query_params['limit'])) {
3406
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3407
-                    $e = sprintf(
3408
-                        __(
3409
-                            "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)",
3410
-                            "event_espresso"
3411
-                        ),
3412
-                        http_build_query($query_params['limit'])
3413
-                    );
3414
-                    throw new EE_Error($e . "|" . $e);
3415
-                }
3416
-                //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3417
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3418
-            } elseif (! empty ($query_params['limit'])) {
3419
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3420
-            }
3421
-        }
3422
-        //set order by
3423
-        if (array_key_exists('order_by', $query_params)) {
3424
-            if (is_array($query_params['order_by'])) {
3425
-                //if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3426
-                //specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3427
-                //including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3428
-                if (array_key_exists('order', $query_params)) {
3429
-                    throw new EE_Error(
3430
-                        sprintf(
3431
-                            __(
3432
-                                "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 ",
3433
-                                "event_espresso"
3434
-                            ),
3435
-                            get_class($this),
3436
-                            implode(", ", array_keys($query_params['order_by'])),
3437
-                            implode(", ", $query_params['order_by']),
3438
-                            $query_params['order']
3439
-                        )
3440
-                    );
3441
-                }
3442
-                $this->_extract_related_models_from_sub_params_array_keys(
3443
-                    $query_params['order_by'],
3444
-                    $query_object,
3445
-                    'order_by'
3446
-                );
3447
-                //assume it's an array of fields to order by
3448
-                $order_array = array();
3449
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3450
-                    $order = $this->_extract_order($order);
3451
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3452
-                }
3453
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3454
-            } elseif (! empty ($query_params['order_by'])) {
3455
-                $this->_extract_related_model_info_from_query_param(
3456
-                    $query_params['order_by'],
3457
-                    $query_object,
3458
-                    'order',
3459
-                    $query_params['order_by']
3460
-                );
3461
-                $order = isset($query_params['order'])
3462
-                    ? $this->_extract_order($query_params['order'])
3463
-                    : 'DESC';
3464
-                $query_object->set_order_by_sql(
3465
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3466
-                );
3467
-            }
3468
-        }
3469
-        //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3470
-        if (! array_key_exists('order_by', $query_params)
3471
-            && array_key_exists('order', $query_params)
3472
-            && ! empty($query_params['order'])
3473
-        ) {
3474
-            $pk_field = $this->get_primary_key_field();
3475
-            $order = $this->_extract_order($query_params['order']);
3476
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3477
-        }
3478
-        //set group by
3479
-        if (array_key_exists('group_by', $query_params)) {
3480
-            if (is_array($query_params['group_by'])) {
3481
-                //it's an array, so assume we'll be grouping by a bunch of stuff
3482
-                $group_by_array = array();
3483
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
3484
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3485
-                }
3486
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3487
-            } elseif (! empty ($query_params['group_by'])) {
3488
-                $query_object->set_group_by_sql(
3489
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3490
-                );
3491
-            }
3492
-        }
3493
-        //set having
3494
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
3495
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3496
-        }
3497
-        //now, just verify they didn't pass anything wack
3498
-        foreach ($query_params as $query_key => $query_value) {
3499
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3500
-                throw new EE_Error(
3501
-                    sprintf(
3502
-                        __(
3503
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3504
-                            'event_espresso'
3505
-                        ),
3506
-                        $query_key,
3507
-                        get_class($this),
3508
-                        //						print_r( $this->_allowed_query_params, TRUE )
3509
-                        implode(',', $this->_allowed_query_params)
3510
-                    )
3511
-                );
3512
-            }
3513
-        }
3514
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
3515
-        if (empty($main_model_join_sql)) {
3516
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
3517
-        }
3518
-        return $query_object;
3519
-    }
3520
-
3521
-
3522
-
3523
-    /**
3524
-     * Gets the where conditions that should be imposed on the query based on the
3525
-     * context (eg reading frontend, backend, edit or delete).
3526
-     *
3527
-     * @param string $context one of EEM_Base::valid_cap_contexts()
3528
-     * @return array like EEM_Base::get_all() 's $query_params[0]
3529
-     * @throws EE_Error
3530
-     */
3531
-    public function caps_where_conditions($context = self::caps_read)
3532
-    {
3533
-        EEM_Base::verify_is_valid_cap_context($context);
3534
-        $cap_where_conditions = array();
3535
-        $cap_restrictions = $this->caps_missing($context);
3536
-        /**
3537
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
3538
-         */
3539
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3540
-            $cap_where_conditions = array_replace_recursive($cap_where_conditions,
3541
-                $restriction_if_no_cap->get_default_where_conditions());
3542
-        }
3543
-        return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3544
-            $cap_restrictions);
3545
-    }
3546
-
3547
-
3548
-
3549
-    /**
3550
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3551
-     * otherwise throws an exception
3552
-     *
3553
-     * @param string $should_be_order_string
3554
-     * @return string either ASC, asc, DESC or desc
3555
-     * @throws EE_Error
3556
-     */
3557
-    private function _extract_order($should_be_order_string)
3558
-    {
3559
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3560
-            return $should_be_order_string;
3561
-        }
3562
-        throw new EE_Error(
3563
-            sprintf(
3564
-                __(
3565
-                    "While performing a query on '%s', tried to use '%s' as an order parameter. ",
3566
-                    "event_espresso"
3567
-                ), get_class($this), $should_be_order_string
3568
-            )
3569
-        );
3570
-    }
3571
-
3572
-
3573
-
3574
-    /**
3575
-     * Looks at all the models which are included in this query, and asks each
3576
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3577
-     * so they can be merged
3578
-     *
3579
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
3580
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3581
-     *                                                                  'none' means NO default where conditions will
3582
-     *                                                                  be used AT ALL during this query.
3583
-     *                                                                  'other_models_only' means default where
3584
-     *                                                                  conditions from other models will be used, but
3585
-     *                                                                  not for this primary model. 'all', the default,
3586
-     *                                                                  means default where conditions will apply as
3587
-     *                                                                  normal
3588
-     * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3589
-     * @throws EE_Error
3590
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
3591
-     */
3592
-    private function _get_default_where_conditions_for_models_in_query(
3593
-        EE_Model_Query_Info_Carrier $query_info_carrier,
3594
-        $use_default_where_conditions = EEM_Base::default_where_conditions_all,
3595
-        $where_query_params = array()
3596
-    ) {
3597
-        $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3598
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3599
-            throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3600
-                "event_espresso"), $use_default_where_conditions,
3601
-                implode(", ", $allowed_used_default_where_conditions_values)));
3602
-        }
3603
-        $universal_query_params = array();
3604
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3605
-            $universal_query_params = $this->_get_default_where_conditions();
3606
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3607
-            $universal_query_params = $this->_get_minimum_where_conditions();
3608
-        }
3609
-        foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3610
-            $related_model = $this->get_related_model_obj($model_name);
3611
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3612
-                $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3613
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3614
-                $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3615
-            } else {
3616
-                //we don't want to add full or even minimum default where conditions from this model, so just continue
3617
-                continue;
3618
-            }
3619
-            $overrides = $this->_override_defaults_or_make_null_friendly(
3620
-                $related_model_universal_where_params,
3621
-                $where_query_params,
3622
-                $related_model,
3623
-                $model_relation_path
3624
-            );
3625
-            $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3626
-                $universal_query_params,
3627
-                $overrides
3628
-            );
3629
-        }
3630
-        return $universal_query_params;
3631
-    }
3632
-
3633
-
3634
-
3635
-    /**
3636
-     * Determines whether or not we should use default where conditions for the model in question
3637
-     * (this model, or other related models).
3638
-     * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3639
-     * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3640
-     * We should use default where conditions on related models when they requested to use default where conditions
3641
-     * on all models, or specifically just on other related models
3642
-     * @param      $default_where_conditions_value
3643
-     * @param bool $for_this_model false means this is for OTHER related models
3644
-     * @return bool
3645
-     */
3646
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3647
-    {
3648
-        return (
3649
-                   $for_this_model
3650
-                   && in_array(
3651
-                       $default_where_conditions_value,
3652
-                       array(
3653
-                           EEM_Base::default_where_conditions_all,
3654
-                           EEM_Base::default_where_conditions_this_only,
3655
-                           EEM_Base::default_where_conditions_minimum_others,
3656
-                       ),
3657
-                       true
3658
-                   )
3659
-               )
3660
-               || (
3661
-                   ! $for_this_model
3662
-                   && in_array(
3663
-                       $default_where_conditions_value,
3664
-                       array(
3665
-                           EEM_Base::default_where_conditions_all,
3666
-                           EEM_Base::default_where_conditions_others_only,
3667
-                       ),
3668
-                       true
3669
-                   )
3670
-               );
3671
-    }
3672
-
3673
-    /**
3674
-     * Determines whether or not we should use default minimum conditions for the model in question
3675
-     * (this model, or other related models).
3676
-     * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3677
-     * where conditions.
3678
-     * We should use minimum where conditions on related models if they requested to use minimum where conditions
3679
-     * on this model or others
3680
-     * @param      $default_where_conditions_value
3681
-     * @param bool $for_this_model false means this is for OTHER related models
3682
-     * @return bool
3683
-     */
3684
-    private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3685
-    {
3686
-        return (
3687
-                   $for_this_model
3688
-                   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3689
-               )
3690
-               || (
3691
-                   ! $for_this_model
3692
-                   && in_array(
3693
-                       $default_where_conditions_value,
3694
-                       array(
3695
-                           EEM_Base::default_where_conditions_minimum_others,
3696
-                           EEM_Base::default_where_conditions_minimum_all,
3697
-                       ),
3698
-                       true
3699
-                   )
3700
-               );
3701
-    }
3702
-
3703
-
3704
-    /**
3705
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3706
-     * then we also add a special where condition which allows for that model's primary key
3707
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3708
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3709
-     *
3710
-     * @param array    $default_where_conditions
3711
-     * @param array    $provided_where_conditions
3712
-     * @param EEM_Base $model
3713
-     * @param string   $model_relation_path like 'Transaction.Payment.'
3714
-     * @return array like EEM_Base::get_all's $query_params[0]
3715
-     * @throws EE_Error
3716
-     */
3717
-    private function _override_defaults_or_make_null_friendly(
3718
-        $default_where_conditions,
3719
-        $provided_where_conditions,
3720
-        $model,
3721
-        $model_relation_path
3722
-    ) {
3723
-        $null_friendly_where_conditions = array();
3724
-        $none_overridden = true;
3725
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3726
-        foreach ($default_where_conditions as $key => $val) {
3727
-            if (isset($provided_where_conditions[$key])) {
3728
-                $none_overridden = false;
3729
-            } else {
3730
-                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3731
-            }
3732
-        }
3733
-        if ($none_overridden && $default_where_conditions) {
3734
-            if ($model->has_primary_key_field()) {
3735
-                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3736
-                                                                                . "."
3737
-                                                                                . $model->primary_key_name()] = array('IS NULL');
3738
-            }/*else{
35
+	/**
36
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
37
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
38
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
39
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
40
+	 *
41
+	 * @var boolean
42
+	 */
43
+	private $_values_already_prepared_by_model_object = 0;
44
+
45
+	/**
46
+	 * when $_values_already_prepared_by_model_object equals this, we assume
47
+	 * the data is just like form input that needs to have the model fields'
48
+	 * prepare_for_set and prepare_for_use_in_db called on it
49
+	 */
50
+	const not_prepared_by_model_object = 0;
51
+
52
+	/**
53
+	 * when $_values_already_prepared_by_model_object equals this, we
54
+	 * assume this value is coming from a model object and doesn't need to have
55
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
56
+	 */
57
+	const prepared_by_model_object = 1;
58
+
59
+	/**
60
+	 * when $_values_already_prepared_by_model_object equals this, we assume
61
+	 * the values are already to be used in the database (ie no processing is done
62
+	 * on them by the model's fields)
63
+	 */
64
+	const prepared_for_use_in_db = 2;
65
+
66
+
67
+	protected $singular_item = 'Item';
68
+
69
+	protected $plural_item   = 'Items';
70
+
71
+	/**
72
+	 * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
73
+	 */
74
+	protected $_tables;
75
+
76
+	/**
77
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
78
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
79
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
80
+	 *
81
+	 * @var \EE_Model_Field_Base[][] $_fields
82
+	 */
83
+	protected $_fields;
84
+
85
+	/**
86
+	 * array of different kinds of relations
87
+	 *
88
+	 * @var \EE_Model_Relation_Base[] $_model_relations
89
+	 */
90
+	protected $_model_relations;
91
+
92
+	/**
93
+	 * @var \EE_Index[] $_indexes
94
+	 */
95
+	protected $_indexes = array();
96
+
97
+	/**
98
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
99
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
100
+	 * by setting the same columns as used in these queries in the query yourself.
101
+	 *
102
+	 * @var EE_Default_Where_Conditions
103
+	 */
104
+	protected $_default_where_conditions_strategy;
105
+
106
+	/**
107
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
108
+	 * This is particularly useful when you want something between 'none' and 'default'
109
+	 *
110
+	 * @var EE_Default_Where_Conditions
111
+	 */
112
+	protected $_minimum_where_conditions_strategy;
113
+
114
+	/**
115
+	 * String describing how to find the "owner" of this model's objects.
116
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
117
+	 * But when there isn't, this indicates which related model, or transiently-related model,
118
+	 * has the foreign key to the wp_users table.
119
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
120
+	 * related to events, and events have a foreign key to wp_users.
121
+	 * On EEM_Transaction, this would be 'Transaction.Event'
122
+	 *
123
+	 * @var string
124
+	 */
125
+	protected $_model_chain_to_wp_user = '';
126
+
127
+	/**
128
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
129
+	 * don't need it (particularly CPT models)
130
+	 *
131
+	 * @var bool
132
+	 */
133
+	protected $_ignore_where_strategy = false;
134
+
135
+	/**
136
+	 * String used in caps relating to this model. Eg, if the caps relating to this
137
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
138
+	 *
139
+	 * @var string. If null it hasn't been initialized yet. If false then we
140
+	 * have indicated capabilities don't apply to this
141
+	 */
142
+	protected $_caps_slug = null;
143
+
144
+	/**
145
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
146
+	 * and next-level keys are capability names, and each's value is a
147
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
148
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
149
+	 * and then each capability in the corresponding sub-array that they're missing
150
+	 * adds the where conditions onto the query.
151
+	 *
152
+	 * @var array
153
+	 */
154
+	protected $_cap_restrictions = array(
155
+		self::caps_read       => array(),
156
+		self::caps_read_admin => array(),
157
+		self::caps_edit       => array(),
158
+		self::caps_delete     => array(),
159
+	);
160
+
161
+	/**
162
+	 * Array defining which cap restriction generators to use to create default
163
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
164
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
165
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
166
+	 * automatically set this to false (not just null).
167
+	 *
168
+	 * @var EE_Restriction_Generator_Base[]
169
+	 */
170
+	protected $_cap_restriction_generators = array();
171
+
172
+	/**
173
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
174
+	 */
175
+	const caps_read       = 'read';
176
+
177
+	const caps_read_admin = 'read_admin';
178
+
179
+	const caps_edit       = 'edit';
180
+
181
+	const caps_delete     = 'delete';
182
+
183
+	/**
184
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
185
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
186
+	 * maps to 'read' because when looking for relevant permissions we're going to use
187
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
188
+	 *
189
+	 * @var array
190
+	 */
191
+	protected $_cap_contexts_to_cap_action_map = array(
192
+		self::caps_read       => 'read',
193
+		self::caps_read_admin => 'read',
194
+		self::caps_edit       => 'edit',
195
+		self::caps_delete     => 'delete',
196
+	);
197
+
198
+	/**
199
+	 * Timezone
200
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
201
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
202
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
203
+	 * EE_Datetime_Field data type will have access to it.
204
+	 *
205
+	 * @var string
206
+	 */
207
+	protected $_timezone;
208
+
209
+
210
+	/**
211
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
212
+	 * multisite.
213
+	 *
214
+	 * @var int
215
+	 */
216
+	protected static $_model_query_blog_id;
217
+
218
+	/**
219
+	 * A copy of _fields, except the array keys are the model names pointed to by
220
+	 * the field
221
+	 *
222
+	 * @var EE_Model_Field_Base[]
223
+	 */
224
+	private $_cache_foreign_key_to_fields = array();
225
+
226
+	/**
227
+	 * Cached list of all the fields on the model, indexed by their name
228
+	 *
229
+	 * @var EE_Model_Field_Base[]
230
+	 */
231
+	private $_cached_fields = null;
232
+
233
+	/**
234
+	 * Cached list of all the fields on the model, except those that are
235
+	 * marked as only pertinent to the database
236
+	 *
237
+	 * @var EE_Model_Field_Base[]
238
+	 */
239
+	private $_cached_fields_non_db_only = null;
240
+
241
+	/**
242
+	 * A cached reference to the primary key for quick lookup
243
+	 *
244
+	 * @var EE_Model_Field_Base
245
+	 */
246
+	private $_primary_key_field = null;
247
+
248
+	/**
249
+	 * Flag indicating whether this model has a primary key or not
250
+	 *
251
+	 * @var boolean
252
+	 */
253
+	protected $_has_primary_key_field = null;
254
+
255
+	/**
256
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
257
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
258
+	 * This should be true for models that deal with data that should exist independent of EE.
259
+	 * For example, if the model can read and insert data that isn't used by EE, this should be true.
260
+	 * It would be false, however, if you could guarantee the model would only interact with EE data,
261
+	 * even if it uses a WP core table (eg event and venue models set this to false for that reason:
262
+	 * they can only read and insert events and venues custom post types, not arbitrary post types)
263
+	 * @var boolean
264
+	 */
265
+	protected $_wp_core_model = false;
266
+
267
+	/**
268
+	 *    List of valid operators that can be used for querying.
269
+	 * The keys are all operators we'll accept, the values are the real SQL
270
+	 * operators used
271
+	 *
272
+	 * @var array
273
+	 */
274
+	protected $_valid_operators = array(
275
+		'='           => '=',
276
+		'<='          => '<=',
277
+		'<'           => '<',
278
+		'>='          => '>=',
279
+		'>'           => '>',
280
+		'!='          => '!=',
281
+		'LIKE'        => 'LIKE',
282
+		'like'        => 'LIKE',
283
+		'NOT_LIKE'    => 'NOT LIKE',
284
+		'not_like'    => 'NOT LIKE',
285
+		'NOT LIKE'    => 'NOT LIKE',
286
+		'not like'    => 'NOT LIKE',
287
+		'IN'          => 'IN',
288
+		'in'          => 'IN',
289
+		'NOT_IN'      => 'NOT IN',
290
+		'not_in'      => 'NOT IN',
291
+		'NOT IN'      => 'NOT IN',
292
+		'not in'      => 'NOT IN',
293
+		'between'     => 'BETWEEN',
294
+		'BETWEEN'     => 'BETWEEN',
295
+		'IS_NOT_NULL' => 'IS NOT NULL',
296
+		'is_not_null' => 'IS NOT NULL',
297
+		'IS NOT NULL' => 'IS NOT NULL',
298
+		'is not null' => 'IS NOT NULL',
299
+		'IS_NULL'     => 'IS NULL',
300
+		'is_null'     => 'IS NULL',
301
+		'IS NULL'     => 'IS NULL',
302
+		'is null'     => 'IS NULL',
303
+		'REGEXP'      => 'REGEXP',
304
+		'regexp'      => 'REGEXP',
305
+		'NOT_REGEXP'  => 'NOT REGEXP',
306
+		'not_regexp'  => 'NOT REGEXP',
307
+		'NOT REGEXP'  => 'NOT REGEXP',
308
+		'not regexp'  => 'NOT REGEXP',
309
+	);
310
+
311
+	/**
312
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
313
+	 *
314
+	 * @var array
315
+	 */
316
+	protected $_in_style_operators = array('IN', 'NOT IN');
317
+
318
+	/**
319
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
320
+	 * '12-31-2012'"
321
+	 *
322
+	 * @var array
323
+	 */
324
+	protected $_between_style_operators = array('BETWEEN');
325
+
326
+	/**
327
+	 * Operators that work like SQL's like: input should be assumed to be a string, already prepared for a LIKE query.
328
+	 * @var array
329
+	 */
330
+	protected $_like_style_operators = array('LIKE', 'NOT LIKE');
331
+	/**
332
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
333
+	 * on a join table.
334
+	 *
335
+	 * @var array
336
+	 */
337
+	protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
338
+
339
+	/**
340
+	 * Allowed values for $query_params['order'] for ordering in queries
341
+	 *
342
+	 * @var array
343
+	 */
344
+	protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
345
+
346
+	/**
347
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
348
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
349
+	 *
350
+	 * @var array
351
+	 */
352
+	private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
353
+
354
+	/**
355
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
356
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
357
+	 *
358
+	 * @var array
359
+	 */
360
+	private $_allowed_query_params = array(
361
+		0,
362
+		'limit',
363
+		'order_by',
364
+		'group_by',
365
+		'having',
366
+		'force_join',
367
+		'order',
368
+		'on_join_limit',
369
+		'default_where_conditions',
370
+		'caps',
371
+	);
372
+
373
+	/**
374
+	 * All the data types that can be used in $wpdb->prepare statements.
375
+	 *
376
+	 * @var array
377
+	 */
378
+	private $_valid_wpdb_data_types = array('%d', '%s', '%f');
379
+
380
+	/**
381
+	 * @var EE_Registry $EE
382
+	 */
383
+	protected $EE = null;
384
+
385
+
386
+	/**
387
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
388
+	 *
389
+	 * @var int
390
+	 */
391
+	protected $_show_next_x_db_queries = 0;
392
+
393
+	/**
394
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
395
+	 * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
396
+	 *
397
+	 * @var array
398
+	 */
399
+	protected $_custom_selections = array();
400
+
401
+	/**
402
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
403
+	 * caches every model object we've fetched from the DB on this request
404
+	 *
405
+	 * @var array
406
+	 */
407
+	protected $_entity_map;
408
+
409
+	/**
410
+	 * @var LoaderInterface $loader
411
+	 */
412
+	private static $loader;
413
+
414
+
415
+	/**
416
+	 * constant used to show EEM_Base has not yet verified the db on this http request
417
+	 */
418
+	const db_verified_none = 0;
419
+
420
+	/**
421
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
422
+	 * but not the addons' dbs
423
+	 */
424
+	const db_verified_core = 1;
425
+
426
+	/**
427
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
428
+	 * the EE core db too)
429
+	 */
430
+	const db_verified_addons = 2;
431
+
432
+	/**
433
+	 * indicates whether an EEM_Base child has already re-verified the DB
434
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
435
+	 * looking like EEM_Base::db_verified_*
436
+	 *
437
+	 * @var int - 0 = none, 1 = core, 2 = addons
438
+	 */
439
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
440
+
441
+	/**
442
+	 * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
443
+	 *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
444
+	 *        registrations for non-trashed tickets for non-trashed datetimes)
445
+	 */
446
+	const default_where_conditions_all = 'all';
447
+
448
+	/**
449
+	 * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
450
+	 *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
451
+	 *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
452
+	 *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
453
+	 *        models which share tables with other models, this can return data for the wrong model.
454
+	 */
455
+	const default_where_conditions_this_only = 'this_model_only';
456
+
457
+	/**
458
+	 * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
459
+	 *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
460
+	 *        return all registrations related to non-trashed tickets and non-trashed datetimes)
461
+	 */
462
+	const default_where_conditions_others_only = 'other_models_only';
463
+
464
+	/**
465
+	 * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
466
+	 *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
467
+	 *        their table with other models, like the Event and Venue models. For example, when querying for events
468
+	 *        ordered by their venues' name, this will be sure to only return real events with associated real venues
469
+	 *        (regardless of whether those events and venues are trashed)
470
+	 *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
471
+	 *        events.
472
+	 */
473
+	const default_where_conditions_minimum_all = 'minimum';
474
+
475
+	/**
476
+	 * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
477
+	 *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
478
+	 *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
479
+	 *        not)
480
+	 */
481
+	const default_where_conditions_minimum_others = 'full_this_minimum_others';
482
+
483
+	/**
484
+	 * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
485
+	 *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
486
+	 *        it's possible it will return table entries for other models. You should use
487
+	 *        EEM_Base::default_where_conditions_minimum_all instead.
488
+	 */
489
+	const default_where_conditions_none = 'none';
490
+
491
+
492
+
493
+	/**
494
+	 * About all child constructors:
495
+	 * they should define the _tables, _fields and _model_relations arrays.
496
+	 * Should ALWAYS be called after child constructor.
497
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
498
+	 * finalizes constructing all the object's attributes.
499
+	 * Generally, rather than requiring a child to code
500
+	 * $this->_tables = array(
501
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
502
+	 *        ...);
503
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
504
+	 * each EE_Table has a function to set the table's alias after the constructor, using
505
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
506
+	 * do something similar.
507
+	 *
508
+	 * @param null $timezone
509
+	 * @throws EE_Error
510
+	 */
511
+	protected function __construct($timezone = null)
512
+	{
513
+		// check that the model has not been loaded too soon
514
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
515
+			throw new EE_Error (
516
+				sprintf(
517
+					__('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.',
518
+						'event_espresso'),
519
+					get_class($this)
520
+				)
521
+			);
522
+		}
523
+		/**
524
+		 * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
525
+		 */
526
+		if (empty(EEM_Base::$_model_query_blog_id)) {
527
+			EEM_Base::set_model_query_blog_id();
528
+		}
529
+		/**
530
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
531
+		 * just use EE_Register_Model_Extension
532
+		 *
533
+		 * @var EE_Table_Base[] $_tables
534
+		 */
535
+		$this->_tables = (array)apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
536
+		foreach ($this->_tables as $table_alias => $table_obj) {
537
+			/** @var $table_obj EE_Table_Base */
538
+			$table_obj->_construct_finalize_with_alias($table_alias);
539
+			if ($table_obj instanceof EE_Secondary_Table) {
540
+				/** @var $table_obj EE_Secondary_Table */
541
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
542
+			}
543
+		}
544
+		/**
545
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
546
+		 * EE_Register_Model_Extension
547
+		 *
548
+		 * @param EE_Model_Field_Base[] $_fields
549
+		 */
550
+		$this->_fields = (array)apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
551
+		$this->_invalidate_field_caches();
552
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
553
+			if (! array_key_exists($table_alias, $this->_tables)) {
554
+				throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
555
+					'event_espresso'), $table_alias, implode(",", $this->_fields)));
556
+			}
557
+			foreach ($fields_for_table as $field_name => $field_obj) {
558
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
559
+				//primary key field base has a slightly different _construct_finalize
560
+				/** @var $field_obj EE_Model_Field_Base */
561
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
562
+			}
563
+		}
564
+		// everything is related to Extra_Meta
565
+		if (get_class($this) !== 'EEM_Extra_Meta') {
566
+			//make extra meta related to everything, but don't block deleting things just
567
+			//because they have related extra meta info. For now just orphan those extra meta
568
+			//in the future we should automatically delete them
569
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
570
+		}
571
+		//and change logs
572
+		if (get_class($this) !== 'EEM_Change_Log') {
573
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
574
+		}
575
+		/**
576
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
577
+		 * EE_Register_Model_Extension
578
+		 *
579
+		 * @param EE_Model_Relation_Base[] $_model_relations
580
+		 */
581
+		$this->_model_relations = (array)apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
582
+			$this->_model_relations);
583
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
584
+			/** @var $relation_obj EE_Model_Relation_Base */
585
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
586
+		}
587
+		foreach ($this->_indexes as $index_name => $index_obj) {
588
+			/** @var $index_obj EE_Index */
589
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
590
+		}
591
+		$this->set_timezone($timezone);
592
+		//finalize default where condition strategy, or set default
593
+		if (! $this->_default_where_conditions_strategy) {
594
+			//nothing was set during child constructor, so set default
595
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
596
+		}
597
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
598
+		if (! $this->_minimum_where_conditions_strategy) {
599
+			//nothing was set during child constructor, so set default
600
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
601
+		}
602
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
603
+		//if the cap slug hasn't been set, and we haven't set it to false on purpose
604
+		//to indicate to NOT set it, set it to the logical default
605
+		if ($this->_caps_slug === null) {
606
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
607
+		}
608
+		//initialize the standard cap restriction generators if none were specified by the child constructor
609
+		if ($this->_cap_restriction_generators !== false) {
610
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
611
+				if (! isset($this->_cap_restriction_generators[$cap_context])) {
612
+					$this->_cap_restriction_generators[$cap_context] = apply_filters(
613
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
614
+						new EE_Restriction_Generator_Protected(),
615
+						$cap_context,
616
+						$this
617
+					);
618
+				}
619
+			}
620
+		}
621
+		//if there are cap restriction generators, use them to make the default cap restrictions
622
+		if ($this->_cap_restriction_generators !== false) {
623
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
624
+				if (! $generator_object) {
625
+					continue;
626
+				}
627
+				if (! $generator_object instanceof EE_Restriction_Generator_Base) {
628
+					throw new EE_Error(
629
+						sprintf(
630
+							__('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.',
631
+								'event_espresso'),
632
+							$context,
633
+							$this->get_this_model_name()
634
+						)
635
+					);
636
+				}
637
+				$action = $this->cap_action_for_context($context);
638
+				if (! $generator_object->construction_finalized()) {
639
+					$generator_object->_construct_finalize($this, $action);
640
+				}
641
+			}
642
+		}
643
+		do_action('AHEE__' . get_class($this) . '__construct__end');
644
+	}
645
+
646
+
647
+
648
+	/**
649
+	 * Used to set the $_model_query_blog_id static property.
650
+	 *
651
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
652
+	 *                      value for get_current_blog_id() will be used.
653
+	 */
654
+	public static function set_model_query_blog_id($blog_id = 0)
655
+	{
656
+		EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
657
+	}
658
+
659
+
660
+
661
+	/**
662
+	 * Returns whatever is set as the internal $model_query_blog_id.
663
+	 *
664
+	 * @return int
665
+	 */
666
+	public static function get_model_query_blog_id()
667
+	{
668
+		return EEM_Base::$_model_query_blog_id;
669
+	}
670
+
671
+
672
+
673
+	/**
674
+	 * This function is a singleton method used to instantiate the Espresso_model object
675
+	 *
676
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
677
+	 *                                (and any incoming timezone data that gets saved).
678
+	 *                                Note this just sends the timezone info to the date time model field objects.
679
+	 *                                Default is NULL
680
+	 *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
681
+	 * @return static (as in the concrete child class)
682
+	 * @throws EE_Error
683
+	 * @throws InvalidArgumentException
684
+	 * @throws InvalidDataTypeException
685
+	 * @throws InvalidInterfaceException
686
+	 */
687
+	public static function instance($timezone = null)
688
+	{
689
+		// check if instance of Espresso_model already exists
690
+		if (! static::$_instance instanceof static) {
691
+			// instantiate Espresso_model
692
+			static::$_instance = new static(
693
+				$timezone,
694
+				LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
695
+			);
696
+		}
697
+		//we might have a timezone set, let set_timezone decide what to do with it
698
+		static::$_instance->set_timezone($timezone);
699
+		// Espresso_model object
700
+		return static::$_instance;
701
+	}
702
+
703
+
704
+
705
+	/**
706
+	 * resets the model and returns it
707
+	 *
708
+	 * @param null | string $timezone
709
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
710
+	 * all its properties reset; if it wasn't instantiated, returns null)
711
+	 * @throws EE_Error
712
+	 * @throws ReflectionException
713
+	 * @throws InvalidArgumentException
714
+	 * @throws InvalidDataTypeException
715
+	 * @throws InvalidInterfaceException
716
+	 */
717
+	public static function reset($timezone = null)
718
+	{
719
+		if (static::$_instance instanceof EEM_Base) {
720
+			//let's try to NOT swap out the current instance for a new one
721
+			//because if someone has a reference to it, we can't remove their reference
722
+			//so it's best to keep using the same reference, but change the original object
723
+			//reset all its properties to their original values as defined in the class
724
+			$r = new ReflectionClass(get_class(static::$_instance));
725
+			$static_properties = $r->getStaticProperties();
726
+			foreach ($r->getDefaultProperties() as $property => $value) {
727
+				//don't set instance to null like it was originally,
728
+				//but it's static anyways, and we're ignoring static properties (for now at least)
729
+				if (! isset($static_properties[$property])) {
730
+					static::$_instance->{$property} = $value;
731
+				}
732
+			}
733
+			//and then directly call its constructor again, like we would if we were creating a new one
734
+			static::$_instance->__construct(
735
+				$timezone,
736
+				LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
737
+			);
738
+			return self::instance();
739
+		}
740
+		return null;
741
+	}
742
+
743
+
744
+
745
+	/**
746
+	 * @return LoaderInterface
747
+	 * @throws InvalidArgumentException
748
+	 * @throws InvalidDataTypeException
749
+	 * @throws InvalidInterfaceException
750
+	 */
751
+	private static function getLoader()
752
+	{
753
+		if(! EEM_Base::$loader instanceof LoaderInterface) {
754
+			EEM_Base::$loader = LoaderFactory::getLoader();
755
+		}
756
+		return EEM_Base::$loader;
757
+	}
758
+
759
+
760
+
761
+	/**
762
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
763
+	 *
764
+	 * @param  boolean $translated return localized strings or JUST the array.
765
+	 * @return array
766
+	 * @throws EE_Error
767
+	 * @throws InvalidArgumentException
768
+	 * @throws InvalidDataTypeException
769
+	 * @throws InvalidInterfaceException
770
+	 */
771
+	public function status_array($translated = false)
772
+	{
773
+		if (! array_key_exists('Status', $this->_model_relations)) {
774
+			return array();
775
+		}
776
+		$model_name = $this->get_this_model_name();
777
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
778
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
779
+		$status_array = array();
780
+		foreach ($stati as $status) {
781
+			$status_array[$status->ID()] = $status->get('STS_code');
782
+		}
783
+		return $translated
784
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
785
+			: $status_array;
786
+	}
787
+
788
+
789
+
790
+	/**
791
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
792
+	 *
793
+	 * @param array $query_params             {
794
+	 * @var array $0 (where) array {
795
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
796
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
797
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
798
+	 *                                        conditions based on related models (and even
799
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
800
+	 *                                        name. Eg,
801
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
802
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
803
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
804
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
805
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
806
+	 *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
807
+	 *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
808
+	 *                                        to Venues (even when each of those models actually consisted of two
809
+	 *                                        tables). Also, you may chain the model relations together. Eg instead of
810
+	 *                                        just having
811
+	 *                                        "Venue.VNU_ID", you could have
812
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
813
+	 *                                        events are related to Registrations, which are related to Attendees). You
814
+	 *                                        can take it even further with
815
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
816
+	 *                                        (from the default of '='), change the value to an numerically-indexed
817
+	 *                                        array, where the first item in the list is the operator. eg: array(
818
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
819
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
820
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
821
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
822
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
823
+	 *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
824
+	 *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
825
+	 *                                        the operator is IN. Also, values can actually be field names. To indicate
826
+	 *                                        the value is a field, simply provide a third array item (true) to the
827
+	 *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
828
+	 *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
829
+	 *                                        Note: you can also use related model field names like you would any other
830
+	 *                                        field name. eg:
831
+	 *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
832
+	 *                                        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__>' =>
833
+	 *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
834
+	 *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
835
+	 *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
836
+	 *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
837
+	 *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
838
+	 *                                        to be what you last specified. IE, "AND"s by default, but if you had
839
+	 *                                        previously specified to use ORs to join, ORs will continue to be used.
840
+	 *                                        So, if you specify to use an "OR" to join conditions, it will continue to
841
+	 *                                        "stick" until you specify an AND. eg
842
+	 *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
843
+	 *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
844
+	 *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
845
+	 *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
846
+	 *                                        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 >>
847
+	 *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
848
+	 *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
849
+	 *                                        too, eg:
850
+	 *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
851
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
852
+	 *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
853
+	 *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
854
+	 *                                        Remember when you provide two numbers for the limit, the 1st number is
855
+	 *                                        the OFFSET, the 2nd is the LIMIT
856
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
857
+	 *                                        can do paging on one-to-many multi-table-joins. Send an array in the
858
+	 *                                        following format array('on_join_limit'
859
+	 *                                        => array( 'table_alias', array(1,2) ) ).
860
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
861
+	 *                                        values are either 'ASC' or 'DESC'.
862
+	 *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
863
+	 *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
864
+	 *                                        DESC..." respectively. Like the
865
+	 *                                        'where' conditions, these fields can be on related models. Eg
866
+	 *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
867
+	 *                                        perfectly valid from any model related to 'Registration' (like Event,
868
+	 *                                        Attendee, Price, Datetime, etc.)
869
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
870
+	 *                                        'order' specifies whether to order the field specified in 'order_by' in
871
+	 *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
872
+	 *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
873
+	 *                                        order by the primary key. Eg,
874
+	 *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
875
+	 *                                        //(will join with the Datetime model's table(s) and order by its field
876
+	 *                                        DTT_EVT_start) or
877
+	 *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
878
+	 *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
879
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
880
+	 *                                        'group_by'=>'VNU_ID', or
881
+	 *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
882
+	 *                                        if no
883
+	 *                                        $group_by is specified, and a limit is set, automatically groups by the
884
+	 *                                        model's primary key (or combined primary keys). This avoids some
885
+	 *                                        weirdness that results when using limits, tons of joins, and no group by,
886
+	 *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
887
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
888
+	 *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
889
+	 *                                        results)
890
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
891
+	 *                                        array where values are models to be joined in the query.Eg
892
+	 *                                        array('Attendee','Payment','Datetime'). You may join with transient
893
+	 *                                        models using period, eg "Registration.Transaction.Payment". You will
894
+	 *                                        probably only want to do this in hopes of increasing efficiency, as
895
+	 *                                        related models which belongs to the current model
896
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
897
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
898
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
899
+	 *                                        set this to 'none' to disable all default where conditions. Eg, usually
900
+	 *                                        soft-deleted objects are filtered-out if you want to include them, set
901
+	 *                                        this query param to 'none'. If you want to ONLY disable THIS model's
902
+	 *                                        default where conditions set it to 'other_models_only'. If you only want
903
+	 *                                        this model's default where conditions added to the query, use
904
+	 *                                        'this_model_only'. If you want to use all default where conditions
905
+	 *                                        (default), set to 'all'.
906
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
907
+	 *                                        we just NOT apply any capabilities/permissions/restrictions and return
908
+	 *                                        everything? Or should we only show the current user items they should be
909
+	 *                                        able to view on the frontend, backend, edit, or delete? can be set to
910
+	 *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
911
+	 *                                        }
912
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
913
+	 *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
914
+	 *                                        again. Array keys are object IDs (if there is a primary key on the model.
915
+	 *                                        if not, numerically indexed) Some full examples: get 10 transactions
916
+	 *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
917
+	 *                                        array( array(
918
+	 *                                        'OR'=>array(
919
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
920
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
921
+	 *                                        )
922
+	 *                                        ),
923
+	 *                                        'limit'=>10,
924
+	 *                                        'group_by'=>'TXN_ID'
925
+	 *                                        ));
926
+	 *                                        get all the answers to the question titled "shirt size" for event with id
927
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
928
+	 *                                        'Question.QST_display_text'=>'shirt size',
929
+	 *                                        'Registration.Event.EVT_ID'=>12
930
+	 *                                        ),
931
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
932
+	 *                                        ));
933
+	 * @throws EE_Error
934
+	 */
935
+	public function get_all($query_params = array())
936
+	{
937
+		if (isset($query_params['limit'])
938
+			&& ! isset($query_params['group_by'])
939
+		) {
940
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
941
+		}
942
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
943
+	}
944
+
945
+
946
+
947
+	/**
948
+	 * Modifies the query parameters so we only get back model objects
949
+	 * that "belong" to the current user
950
+	 *
951
+	 * @param array $query_params @see EEM_Base::get_all()
952
+	 * @return array like EEM_Base::get_all
953
+	 */
954
+	public function alter_query_params_to_only_include_mine($query_params = array())
955
+	{
956
+		$wp_user_field_name = $this->wp_user_field_name();
957
+		if ($wp_user_field_name) {
958
+			$query_params[0][$wp_user_field_name] = get_current_user_id();
959
+		}
960
+		return $query_params;
961
+	}
962
+
963
+
964
+
965
+	/**
966
+	 * Returns the name of the field's name that points to the WP_User table
967
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
968
+	 * foreign key to the WP_User table)
969
+	 *
970
+	 * @return string|boolean string on success, boolean false when there is no
971
+	 * foreign key to the WP_User table
972
+	 */
973
+	public function wp_user_field_name()
974
+	{
975
+		try {
976
+			if (! empty($this->_model_chain_to_wp_user)) {
977
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
978
+				$last_model_name = end($models_to_follow_to_wp_users);
979
+				$model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
980
+				$model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
981
+			} else {
982
+				$model_with_fk_to_wp_users = $this;
983
+				$model_chain_to_wp_user = '';
984
+			}
985
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
986
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
987
+		} catch (EE_Error $e) {
988
+			return false;
989
+		}
990
+	}
991
+
992
+
993
+
994
+	/**
995
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
996
+	 * (or transiently-related model) has a foreign key to the wp_users table;
997
+	 * useful for finding if model objects of this type are 'owned' by the current user.
998
+	 * This is an empty string when the foreign key is on this model and when it isn't,
999
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
1000
+	 * (or transiently-related model)
1001
+	 *
1002
+	 * @return string
1003
+	 */
1004
+	public function model_chain_to_wp_user()
1005
+	{
1006
+		return $this->_model_chain_to_wp_user;
1007
+	}
1008
+
1009
+
1010
+
1011
+	/**
1012
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1013
+	 * like how registrations don't have a foreign key to wp_users, but the
1014
+	 * events they are for are), or is unrelated to wp users.
1015
+	 * generally available
1016
+	 *
1017
+	 * @return boolean
1018
+	 */
1019
+	public function is_owned()
1020
+	{
1021
+		if ($this->model_chain_to_wp_user()) {
1022
+			return true;
1023
+		}
1024
+		try {
1025
+			$this->get_foreign_key_to('WP_User');
1026
+			return true;
1027
+		} catch (EE_Error $e) {
1028
+			return false;
1029
+		}
1030
+	}
1031
+
1032
+
1033
+
1034
+	/**
1035
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1036
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1037
+	 * the model)
1038
+	 *
1039
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1040
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1041
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1042
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1043
+	 *                                  override this and set the select to "*", or a specific column name, like
1044
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1045
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1046
+	 *                                  the aliases used to refer to this selection, and values are to be
1047
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1048
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1049
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1050
+	 * @throws EE_Error
1051
+	 */
1052
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1053
+	{
1054
+		// remember the custom selections, if any, and type cast as array
1055
+		// (unless $columns_to_select is an object, then just set as an empty array)
1056
+		// Note: (array) 'some string' === array( 'some string' )
1057
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1058
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1059
+		$select_expressions = $columns_to_select !== null
1060
+			? $this->_construct_select_from_input($columns_to_select)
1061
+			: $this->_construct_default_select_sql($model_query_info);
1062
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1063
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
1064
+	}
1065
+
1066
+
1067
+
1068
+	/**
1069
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
1070
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
1071
+	 * take care of joins, field preparation etc.
1072
+	 *
1073
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1074
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1075
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1076
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1077
+	 *                                  override this and set the select to "*", or a specific column name, like
1078
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1079
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1080
+	 *                                  the aliases used to refer to this selection, and values are to be
1081
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1082
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1083
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1084
+	 * @throws EE_Error
1085
+	 */
1086
+	public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1087
+	{
1088
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1089
+	}
1090
+
1091
+
1092
+
1093
+	/**
1094
+	 * For creating a custom select statement
1095
+	 *
1096
+	 * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1097
+	 *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1098
+	 *                                 SQL, and 1=>is the datatype
1099
+	 * @throws EE_Error
1100
+	 * @return string
1101
+	 */
1102
+	private function _construct_select_from_input($columns_to_select)
1103
+	{
1104
+		if (is_array($columns_to_select)) {
1105
+			$select_sql_array = array();
1106
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
1107
+				if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1108
+					throw new EE_Error(
1109
+						sprintf(
1110
+							__(
1111
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1112
+								'event_espresso'
1113
+							),
1114
+							$selection_and_datatype,
1115
+							$alias
1116
+						)
1117
+					);
1118
+				}
1119
+				if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
1120
+					throw new EE_Error(
1121
+						sprintf(
1122
+							esc_html__(
1123
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1124
+								'event_espresso'
1125
+							),
1126
+							$selection_and_datatype[1],
1127
+							$selection_and_datatype[0],
1128
+							$alias,
1129
+							implode(', ', $this->_valid_wpdb_data_types)
1130
+						)
1131
+					);
1132
+				}
1133
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1134
+			}
1135
+			$columns_to_select_string = implode(', ', $select_sql_array);
1136
+		} else {
1137
+			$columns_to_select_string = $columns_to_select;
1138
+		}
1139
+		return $columns_to_select_string;
1140
+	}
1141
+
1142
+
1143
+
1144
+	/**
1145
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1146
+	 *
1147
+	 * @return string
1148
+	 * @throws EE_Error
1149
+	 */
1150
+	public function primary_key_name()
1151
+	{
1152
+		return $this->get_primary_key_field()->get_name();
1153
+	}
1154
+
1155
+
1156
+
1157
+	/**
1158
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1159
+	 * If there is no primary key on this model, $id is treated as primary key string
1160
+	 *
1161
+	 * @param mixed $id int or string, depending on the type of the model's primary key
1162
+	 * @return EE_Base_Class
1163
+	 */
1164
+	public function get_one_by_ID($id)
1165
+	{
1166
+		if ($this->get_from_entity_map($id)) {
1167
+			return $this->get_from_entity_map($id);
1168
+		}
1169
+		return $this->get_one(
1170
+			$this->alter_query_params_to_restrict_by_ID(
1171
+				$id,
1172
+				array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1173
+			)
1174
+		);
1175
+	}
1176
+
1177
+
1178
+
1179
+	/**
1180
+	 * Alters query parameters to only get items with this ID are returned.
1181
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1182
+	 * or could just be a simple primary key ID
1183
+	 *
1184
+	 * @param int   $id
1185
+	 * @param array $query_params
1186
+	 * @return array of normal query params, @see EEM_Base::get_all
1187
+	 * @throws EE_Error
1188
+	 */
1189
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1190
+	{
1191
+		if (! isset($query_params[0])) {
1192
+			$query_params[0] = array();
1193
+		}
1194
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
1195
+		if ($conditions_from_id === null) {
1196
+			$query_params[0][$this->primary_key_name()] = $id;
1197
+		} else {
1198
+			//no primary key, so the $id must be from the get_index_primary_key_string()
1199
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1200
+		}
1201
+		return $query_params;
1202
+	}
1203
+
1204
+
1205
+
1206
+	/**
1207
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1208
+	 * array. If no item is found, null is returned.
1209
+	 *
1210
+	 * @param array $query_params like EEM_Base's $query_params variable.
1211
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1212
+	 * @throws EE_Error
1213
+	 */
1214
+	public function get_one($query_params = array())
1215
+	{
1216
+		if (! is_array($query_params)) {
1217
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
1218
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1219
+					gettype($query_params)), '4.6.0');
1220
+			$query_params = array();
1221
+		}
1222
+		$query_params['limit'] = 1;
1223
+		$items = $this->get_all($query_params);
1224
+		if (empty($items)) {
1225
+			return null;
1226
+		}
1227
+		return array_shift($items);
1228
+	}
1229
+
1230
+
1231
+
1232
+	/**
1233
+	 * Returns the next x number of items in sequence from the given value as
1234
+	 * found in the database matching the given query conditions.
1235
+	 *
1236
+	 * @param mixed $current_field_value    Value used for the reference point.
1237
+	 * @param null  $field_to_order_by      What field is used for the
1238
+	 *                                      reference point.
1239
+	 * @param int   $limit                  How many to return.
1240
+	 * @param array $query_params           Extra conditions on the query.
1241
+	 * @param null  $columns_to_select      If left null, then an array of
1242
+	 *                                      EE_Base_Class objects is returned,
1243
+	 *                                      otherwise you can indicate just the
1244
+	 *                                      columns you want returned.
1245
+	 * @return EE_Base_Class[]|array
1246
+	 * @throws EE_Error
1247
+	 */
1248
+	public function next_x(
1249
+		$current_field_value,
1250
+		$field_to_order_by = null,
1251
+		$limit = 1,
1252
+		$query_params = array(),
1253
+		$columns_to_select = null
1254
+	) {
1255
+		return $this->_get_consecutive(
1256
+			$current_field_value,
1257
+			'>',
1258
+			$field_to_order_by,
1259
+			$limit,
1260
+			$query_params,
1261
+			$columns_to_select
1262
+		);
1263
+	}
1264
+
1265
+
1266
+
1267
+	/**
1268
+	 * Returns the previous x number of items in sequence from the given value
1269
+	 * as found in the database matching the given query conditions.
1270
+	 *
1271
+	 * @param mixed $current_field_value    Value used for the reference point.
1272
+	 * @param null  $field_to_order_by      What field is used for the
1273
+	 *                                      reference point.
1274
+	 * @param int   $limit                  How many to return.
1275
+	 * @param array $query_params           Extra conditions on the query.
1276
+	 * @param null  $columns_to_select      If left null, then an array of
1277
+	 *                                      EE_Base_Class objects is returned,
1278
+	 *                                      otherwise you can indicate just the
1279
+	 *                                      columns you want returned.
1280
+	 * @return EE_Base_Class[]|array
1281
+	 * @throws EE_Error
1282
+	 */
1283
+	public function previous_x(
1284
+		$current_field_value,
1285
+		$field_to_order_by = null,
1286
+		$limit = 1,
1287
+		$query_params = array(),
1288
+		$columns_to_select = null
1289
+	) {
1290
+		return $this->_get_consecutive(
1291
+			$current_field_value,
1292
+			'<',
1293
+			$field_to_order_by,
1294
+			$limit,
1295
+			$query_params,
1296
+			$columns_to_select
1297
+		);
1298
+	}
1299
+
1300
+
1301
+
1302
+	/**
1303
+	 * Returns the next item in sequence from the given value as found in the
1304
+	 * database matching the given query conditions.
1305
+	 *
1306
+	 * @param mixed $current_field_value    Value used for the reference point.
1307
+	 * @param null  $field_to_order_by      What field is used for the
1308
+	 *                                      reference point.
1309
+	 * @param array $query_params           Extra conditions on the query.
1310
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1311
+	 *                                      object is returned, otherwise you
1312
+	 *                                      can indicate just the columns you
1313
+	 *                                      want and a single array indexed by
1314
+	 *                                      the columns will be returned.
1315
+	 * @return EE_Base_Class|null|array()
1316
+	 * @throws EE_Error
1317
+	 */
1318
+	public function next(
1319
+		$current_field_value,
1320
+		$field_to_order_by = null,
1321
+		$query_params = array(),
1322
+		$columns_to_select = null
1323
+	) {
1324
+		$results = $this->_get_consecutive(
1325
+			$current_field_value,
1326
+			'>',
1327
+			$field_to_order_by,
1328
+			1,
1329
+			$query_params,
1330
+			$columns_to_select
1331
+		);
1332
+		return empty($results) ? null : reset($results);
1333
+	}
1334
+
1335
+
1336
+
1337
+	/**
1338
+	 * Returns the previous item in sequence from the given value as found in
1339
+	 * the database matching the given query conditions.
1340
+	 *
1341
+	 * @param mixed $current_field_value    Value used for the reference point.
1342
+	 * @param null  $field_to_order_by      What field is used for the
1343
+	 *                                      reference point.
1344
+	 * @param array $query_params           Extra conditions on the query.
1345
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1346
+	 *                                      object is returned, otherwise you
1347
+	 *                                      can indicate just the columns you
1348
+	 *                                      want and a single array indexed by
1349
+	 *                                      the columns will be returned.
1350
+	 * @return EE_Base_Class|null|array()
1351
+	 * @throws EE_Error
1352
+	 */
1353
+	public function previous(
1354
+		$current_field_value,
1355
+		$field_to_order_by = null,
1356
+		$query_params = array(),
1357
+		$columns_to_select = null
1358
+	) {
1359
+		$results = $this->_get_consecutive(
1360
+			$current_field_value,
1361
+			'<',
1362
+			$field_to_order_by,
1363
+			1,
1364
+			$query_params,
1365
+			$columns_to_select
1366
+		);
1367
+		return empty($results) ? null : reset($results);
1368
+	}
1369
+
1370
+
1371
+
1372
+	/**
1373
+	 * Returns the a consecutive number of items in sequence from the given
1374
+	 * value as found in the database matching the given query conditions.
1375
+	 *
1376
+	 * @param mixed  $current_field_value   Value used for the reference point.
1377
+	 * @param string $operand               What operand is used for the sequence.
1378
+	 * @param string $field_to_order_by     What field is used for the reference point.
1379
+	 * @param int    $limit                 How many to return.
1380
+	 * @param array  $query_params          Extra conditions on the query.
1381
+	 * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1382
+	 *                                      otherwise you can indicate just the columns you want returned.
1383
+	 * @return EE_Base_Class[]|array
1384
+	 * @throws EE_Error
1385
+	 */
1386
+	protected function _get_consecutive(
1387
+		$current_field_value,
1388
+		$operand = '>',
1389
+		$field_to_order_by = null,
1390
+		$limit = 1,
1391
+		$query_params = array(),
1392
+		$columns_to_select = null
1393
+	) {
1394
+		//if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1395
+		if (empty($field_to_order_by)) {
1396
+			if ($this->has_primary_key_field()) {
1397
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
1398
+			} else {
1399
+				if (WP_DEBUG) {
1400
+					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).',
1401
+						'event_espresso'));
1402
+				}
1403
+				EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1404
+				return array();
1405
+			}
1406
+		}
1407
+		if (! is_array($query_params)) {
1408
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1409
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1410
+					gettype($query_params)), '4.6.0');
1411
+			$query_params = array();
1412
+		}
1413
+		//let's add the where query param for consecutive look up.
1414
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1415
+		$query_params['limit'] = $limit;
1416
+		//set direction
1417
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1418
+		$query_params['order_by'] = $operand === '>'
1419
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
1420
+			: array($field_to_order_by => 'DESC') + $incoming_orderby;
1421
+		//if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1422
+		if (empty($columns_to_select)) {
1423
+			return $this->get_all($query_params);
1424
+		}
1425
+		//getting just the fields
1426
+		return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1427
+	}
1428
+
1429
+
1430
+
1431
+	/**
1432
+	 * This sets the _timezone property after model object has been instantiated.
1433
+	 *
1434
+	 * @param null | string $timezone valid PHP DateTimeZone timezone string
1435
+	 */
1436
+	public function set_timezone($timezone)
1437
+	{
1438
+		if ($timezone !== null) {
1439
+			$this->_timezone = $timezone;
1440
+		}
1441
+		//note we need to loop through relations and set the timezone on those objects as well.
1442
+		foreach ($this->_model_relations as $relation) {
1443
+			$relation->set_timezone($timezone);
1444
+		}
1445
+		//and finally we do the same for any datetime fields
1446
+		foreach ($this->_fields as $field) {
1447
+			if ($field instanceof EE_Datetime_Field) {
1448
+				$field->set_timezone($timezone);
1449
+			}
1450
+		}
1451
+	}
1452
+
1453
+
1454
+
1455
+	/**
1456
+	 * This just returns whatever is set for the current timezone.
1457
+	 *
1458
+	 * @access public
1459
+	 * @return string
1460
+	 */
1461
+	public function get_timezone()
1462
+	{
1463
+		//first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1464
+		if (empty($this->_timezone)) {
1465
+			foreach ($this->_fields as $field) {
1466
+				if ($field instanceof EE_Datetime_Field) {
1467
+					$this->set_timezone($field->get_timezone());
1468
+					break;
1469
+				}
1470
+			}
1471
+		}
1472
+		//if timezone STILL empty then return the default timezone for the site.
1473
+		if (empty($this->_timezone)) {
1474
+			$this->set_timezone(EEH_DTT_Helper::get_timezone());
1475
+		}
1476
+		return $this->_timezone;
1477
+	}
1478
+
1479
+
1480
+
1481
+	/**
1482
+	 * This returns the date formats set for the given field name and also ensures that
1483
+	 * $this->_timezone property is set correctly.
1484
+	 *
1485
+	 * @since 4.6.x
1486
+	 * @param string $field_name The name of the field the formats are being retrieved for.
1487
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1488
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1489
+	 * @return array formats in an array with the date format first, and the time format last.
1490
+	 */
1491
+	public function get_formats_for($field_name, $pretty = false)
1492
+	{
1493
+		$field_settings = $this->field_settings_for($field_name);
1494
+		//if not a valid EE_Datetime_Field then throw error
1495
+		if (! $field_settings instanceof EE_Datetime_Field) {
1496
+			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.',
1497
+				'event_espresso'), $field_name));
1498
+		}
1499
+		//while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1500
+		//the field.
1501
+		$this->_timezone = $field_settings->get_timezone();
1502
+		return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1503
+	}
1504
+
1505
+
1506
+
1507
+	/**
1508
+	 * This returns the current time in a format setup for a query on this model.
1509
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1510
+	 * it will return:
1511
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1512
+	 *  NOW
1513
+	 *  - or a unix timestamp (equivalent to time())
1514
+	 * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
1515
+	 * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
1516
+	 * the time returned to be the current time down to the exact second, set $timestamp to true.
1517
+	 * @since 4.6.x
1518
+	 * @param string $field_name       The field the current time is needed for.
1519
+	 * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1520
+	 *                                 formatted string matching the set format for the field in the set timezone will
1521
+	 *                                 be returned.
1522
+	 * @param string $what             Whether to return the string in just the time format, the date format, or both.
1523
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1524
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1525
+	 *                                 exception is triggered.
1526
+	 */
1527
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1528
+	{
1529
+		$formats = $this->get_formats_for($field_name);
1530
+		$DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1531
+		if ($timestamp) {
1532
+			return $DateTime->format('U');
1533
+		}
1534
+		//not returning timestamp, so return formatted string in timezone.
1535
+		switch ($what) {
1536
+			case 'time' :
1537
+				return $DateTime->format($formats[1]);
1538
+				break;
1539
+			case 'date' :
1540
+				return $DateTime->format($formats[0]);
1541
+				break;
1542
+			default :
1543
+				return $DateTime->format(implode(' ', $formats));
1544
+				break;
1545
+		}
1546
+	}
1547
+
1548
+
1549
+
1550
+	/**
1551
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1552
+	 * for the model are.  Returns a DateTime object.
1553
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1554
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1555
+	 * ignored.
1556
+	 *
1557
+	 * @param string $field_name      The field being setup.
1558
+	 * @param string $timestring      The date time string being used.
1559
+	 * @param string $incoming_format The format for the time string.
1560
+	 * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1561
+	 *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1562
+	 *                                format is
1563
+	 *                                'U', this is ignored.
1564
+	 * @return DateTime
1565
+	 * @throws EE_Error
1566
+	 */
1567
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1568
+	{
1569
+		//just using this to ensure the timezone is set correctly internally
1570
+		$this->get_formats_for($field_name);
1571
+		//load EEH_DTT_Helper
1572
+		$set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1573
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1574
+		return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1575
+	}
1576
+
1577
+
1578
+
1579
+	/**
1580
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1581
+	 *
1582
+	 * @return EE_Table_Base[]
1583
+	 */
1584
+	public function get_tables()
1585
+	{
1586
+		return $this->_tables;
1587
+	}
1588
+
1589
+
1590
+
1591
+	/**
1592
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1593
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
1594
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1595
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1596
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1597
+	 * model object with EVT_ID = 1
1598
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1599
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1600
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1601
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1602
+	 * are not specified)
1603
+	 *
1604
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1605
+	 *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1606
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
1607
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
1608
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
1609
+	 *                                         ID=34, we'd use this method as follows:
1610
+	 *                                         EEM_Transaction::instance()->update(
1611
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1612
+	 *                                         array(array('TXN_ID'=>34)));
1613
+	 * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1614
+	 *                                         in client code into what's expected to be stored on each field. Eg,
1615
+	 *                                         consider updating Question's QST_admin_label field is of type
1616
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
1617
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
1618
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
1619
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1620
+	 *                                         TRUE, it is assumed that you've already called
1621
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1622
+	 *                                         malicious javascript. However, if
1623
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
1624
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1625
+	 *                                         and every other field, before insertion. We provide this parameter
1626
+	 *                                         because model objects perform their prepare_for_set function on all
1627
+	 *                                         their values, and so don't need to be called again (and in many cases,
1628
+	 *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1629
+	 *                                         prepare_for_set method...)
1630
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1631
+	 *                                         in this model's entity map according to $fields_n_values that match
1632
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
1633
+	 *                                         by setting this to FALSE, but be aware that model objects being used
1634
+	 *                                         could get out-of-sync with the database
1635
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1636
+	 *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1637
+	 *                                         bad)
1638
+	 * @throws EE_Error
1639
+	 */
1640
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1641
+	{
1642
+		if (! is_array($query_params)) {
1643
+			EE_Error::doing_it_wrong('EEM_Base::update',
1644
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1645
+					gettype($query_params)), '4.6.0');
1646
+			$query_params = array();
1647
+		}
1648
+		/**
1649
+		 * Action called before a model update call has been made.
1650
+		 *
1651
+		 * @param EEM_Base $model
1652
+		 * @param array    $fields_n_values the updated fields and their new values
1653
+		 * @param array    $query_params    @see EEM_Base::get_all()
1654
+		 */
1655
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1656
+		/**
1657
+		 * Filters the fields about to be updated given the query parameters. You can provide the
1658
+		 * $query_params to $this->get_all() to find exactly which records will be updated
1659
+		 *
1660
+		 * @param array    $fields_n_values fields and their new values
1661
+		 * @param EEM_Base $model           the model being queried
1662
+		 * @param array    $query_params    see EEM_Base::get_all()
1663
+		 */
1664
+		$fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1665
+			$query_params);
1666
+		//need to verify that, for any entry we want to update, there are entries in each secondary table.
1667
+		//to do that, for each table, verify that it's PK isn't null.
1668
+		$tables = $this->get_tables();
1669
+		//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
1670
+		//NOTE: we should make this code more efficient by NOT querying twice
1671
+		//before the real update, but that needs to first go through ALPHA testing
1672
+		//as it's dangerous. says Mike August 8 2014
1673
+		//we want to make sure the default_where strategy is ignored
1674
+		$this->_ignore_where_strategy = true;
1675
+		$wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1676
+		foreach ($wpdb_select_results as $wpdb_result) {
1677
+			// type cast stdClass as array
1678
+			$wpdb_result = (array)$wpdb_result;
1679
+			//get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1680
+			if ($this->has_primary_key_field()) {
1681
+				$main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1682
+			} else {
1683
+				//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)
1684
+				$main_table_pk_value = null;
1685
+			}
1686
+			//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
1687
+			//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
1688
+			if (count($tables) > 1) {
1689
+				//foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1690
+				//in that table, and so we'll want to insert one
1691
+				foreach ($tables as $table_obj) {
1692
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1693
+					//if there is no private key for this table on the results, it means there's no entry
1694
+					//in this table, right? so insert a row in the current table, using any fields available
1695
+					if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1696
+						   && $wpdb_result[$this_table_pk_column])
1697
+					) {
1698
+						$success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1699
+							$main_table_pk_value);
1700
+						//if we died here, report the error
1701
+						if (! $success) {
1702
+							return false;
1703
+						}
1704
+					}
1705
+				}
1706
+			}
1707
+			//				//and now check that if we have cached any models by that ID on the model, that
1708
+			//				//they also get updated properly
1709
+			//				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1710
+			//				if( $model_object ){
1711
+			//					foreach( $fields_n_values as $field => $value ){
1712
+			//						$model_object->set($field, $value);
1713
+			//let's make sure default_where strategy is followed now
1714
+			$this->_ignore_where_strategy = false;
1715
+		}
1716
+		//if we want to keep model objects in sync, AND
1717
+		//if this wasn't called from a model object (to update itself)
1718
+		//then we want to make sure we keep all the existing
1719
+		//model objects in sync with the db
1720
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1721
+			if ($this->has_primary_key_field()) {
1722
+				$model_objs_affected_ids = $this->get_col($query_params);
1723
+			} else {
1724
+				//we need to select a bunch of columns and then combine them into the the "index primary key string"s
1725
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1726
+				$model_objs_affected_ids = array();
1727
+				foreach ($models_affected_key_columns as $row) {
1728
+					$combined_index_key = $this->get_index_primary_key_string($row);
1729
+					$model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1730
+				}
1731
+			}
1732
+			if (! $model_objs_affected_ids) {
1733
+				//wait wait wait- if nothing was affected let's stop here
1734
+				return 0;
1735
+			}
1736
+			foreach ($model_objs_affected_ids as $id) {
1737
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
1738
+				if ($model_obj_in_entity_map) {
1739
+					foreach ($fields_n_values as $field => $new_value) {
1740
+						$model_obj_in_entity_map->set($field, $new_value);
1741
+					}
1742
+				}
1743
+			}
1744
+			//if there is a primary key on this model, we can now do a slight optimization
1745
+			if ($this->has_primary_key_field()) {
1746
+				//we already know what we want to update. So let's make the query simpler so it's a little more efficient
1747
+				$query_params = array(
1748
+					array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1749
+					'limit'                    => count($model_objs_affected_ids),
1750
+					'default_where_conditions' => EEM_Base::default_where_conditions_none,
1751
+				);
1752
+			}
1753
+		}
1754
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1755
+		$SQL = "UPDATE "
1756
+			   . $model_query_info->get_full_join_sql()
1757
+			   . " SET "
1758
+			   . $this->_construct_update_sql($fields_n_values)
1759
+			   . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1760
+		$rows_affected = $this->_do_wpdb_query('query', array($SQL));
1761
+		/**
1762
+		 * Action called after a model update call has been made.
1763
+		 *
1764
+		 * @param EEM_Base $model
1765
+		 * @param array    $fields_n_values the updated fields and their new values
1766
+		 * @param array    $query_params    @see EEM_Base::get_all()
1767
+		 * @param int      $rows_affected
1768
+		 */
1769
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1770
+		return $rows_affected;//how many supposedly got updated
1771
+	}
1772
+
1773
+
1774
+
1775
+	/**
1776
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1777
+	 * are teh values of the field specified (or by default the primary key field)
1778
+	 * that matched the query params. Note that you should pass the name of the
1779
+	 * model FIELD, not the database table's column name.
1780
+	 *
1781
+	 * @param array  $query_params @see EEM_Base::get_all()
1782
+	 * @param string $field_to_select
1783
+	 * @return array just like $wpdb->get_col()
1784
+	 * @throws EE_Error
1785
+	 */
1786
+	public function get_col($query_params = array(), $field_to_select = null)
1787
+	{
1788
+		if ($field_to_select) {
1789
+			$field = $this->field_settings_for($field_to_select);
1790
+		} elseif ($this->has_primary_key_field()) {
1791
+			$field = $this->get_primary_key_field();
1792
+		} else {
1793
+			//no primary key, just grab the first column
1794
+			$field = reset($this->field_settings());
1795
+		}
1796
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1797
+		$select_expressions = $field->get_qualified_column();
1798
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1799
+		return $this->_do_wpdb_query('get_col', array($SQL));
1800
+	}
1801
+
1802
+
1803
+
1804
+	/**
1805
+	 * Returns a single column value for a single row from the database
1806
+	 *
1807
+	 * @param array  $query_params    @see EEM_Base::get_all()
1808
+	 * @param string $field_to_select @see EEM_Base::get_col()
1809
+	 * @return string
1810
+	 * @throws EE_Error
1811
+	 */
1812
+	public function get_var($query_params = array(), $field_to_select = null)
1813
+	{
1814
+		$query_params['limit'] = 1;
1815
+		$col = $this->get_col($query_params, $field_to_select);
1816
+		if (! empty($col)) {
1817
+			return reset($col);
1818
+		}
1819
+		return null;
1820
+	}
1821
+
1822
+
1823
+
1824
+	/**
1825
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1826
+	 * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1827
+	 * injection, but currently no further filtering is done
1828
+	 *
1829
+	 * @global      $wpdb
1830
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1831
+	 *                               be updated to in the DB
1832
+	 * @return string of SQL
1833
+	 * @throws EE_Error
1834
+	 */
1835
+	public function _construct_update_sql($fields_n_values)
1836
+	{
1837
+		/** @type WPDB $wpdb */
1838
+		global $wpdb;
1839
+		$cols_n_values = array();
1840
+		foreach ($fields_n_values as $field_name => $value) {
1841
+			$field_obj = $this->field_settings_for($field_name);
1842
+			//if the value is NULL, we want to assign the value to that.
1843
+			//wpdb->prepare doesn't really handle that properly
1844
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1845
+			$value_sql = $prepared_value === null ? 'NULL'
1846
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1847
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1848
+		}
1849
+		return implode(",", $cols_n_values);
1850
+	}
1851
+
1852
+
1853
+
1854
+	/**
1855
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1856
+	 * Performs a HARD delete, meaning the database row should always be removed,
1857
+	 * not just have a flag field on it switched
1858
+	 * Wrapper for EEM_Base::delete_permanently()
1859
+	 *
1860
+	 * @param mixed $id
1861
+	 * @param boolean $allow_blocking
1862
+	 * @return int the number of rows deleted
1863
+	 * @throws EE_Error
1864
+	 */
1865
+	public function delete_permanently_by_ID($id, $allow_blocking = true)
1866
+	{
1867
+		return $this->delete_permanently(
1868
+			array(
1869
+				array($this->get_primary_key_field()->get_name() => $id),
1870
+				'limit' => 1,
1871
+			),
1872
+			$allow_blocking
1873
+		);
1874
+	}
1875
+
1876
+
1877
+
1878
+	/**
1879
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1880
+	 * Wrapper for EEM_Base::delete()
1881
+	 *
1882
+	 * @param mixed $id
1883
+	 * @param boolean $allow_blocking
1884
+	 * @return int the number of rows deleted
1885
+	 * @throws EE_Error
1886
+	 */
1887
+	public function delete_by_ID($id, $allow_blocking = true)
1888
+	{
1889
+		return $this->delete(
1890
+			array(
1891
+				array($this->get_primary_key_field()->get_name() => $id),
1892
+				'limit' => 1,
1893
+			),
1894
+			$allow_blocking
1895
+		);
1896
+	}
1897
+
1898
+
1899
+
1900
+	/**
1901
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
1902
+	 * meaning if the model has a field that indicates its been "trashed" or
1903
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
1904
+	 *
1905
+	 * @see EEM_Base::delete_permanently
1906
+	 * @param array   $query_params
1907
+	 * @param boolean $allow_blocking
1908
+	 * @return int how many rows got deleted
1909
+	 * @throws EE_Error
1910
+	 */
1911
+	public function delete($query_params, $allow_blocking = true)
1912
+	{
1913
+		return $this->delete_permanently($query_params, $allow_blocking);
1914
+	}
1915
+
1916
+
1917
+
1918
+	/**
1919
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
1920
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1921
+	 * as archived, not actually deleted
1922
+	 *
1923
+	 * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1924
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1925
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1926
+	 *                                deletes regardless of other objects which may depend on it. Its generally
1927
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1928
+	 *                                DB
1929
+	 * @return int how many rows got deleted
1930
+	 * @throws EE_Error
1931
+	 */
1932
+	public function delete_permanently($query_params, $allow_blocking = true)
1933
+	{
1934
+		/**
1935
+		 * Action called just before performing a real deletion query. You can use the
1936
+		 * model and its $query_params to find exactly which items will be deleted
1937
+		 *
1938
+		 * @param EEM_Base $model
1939
+		 * @param array    $query_params   @see EEM_Base::get_all()
1940
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
1941
+		 *                                 to block (prevent) this deletion
1942
+		 */
1943
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1944
+		//some MySQL databases may be running safe mode, which may restrict
1945
+		//deletion if there is no KEY column used in the WHERE statement of a deletion.
1946
+		//to get around this, we first do a SELECT, get all the IDs, and then run another query
1947
+		//to delete them
1948
+		$items_for_deletion = $this->_get_all_wpdb_results($query_params);
1949
+		$columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
1950
+		$deletion_where_query_part = $this->_build_query_part_for_deleting_from_columns_and_values(
1951
+			$columns_and_ids_for_deleting
1952
+		);
1953
+		/**
1954
+		 * Allows client code to act on the items being deleted before the query is actually executed.
1955
+		 *
1956
+		 * @param EEM_Base $this  The model instance being acted on.
1957
+		 * @param array    $query_params  The incoming array of query parameters influencing what gets deleted.
1958
+		 * @param bool     $allow_blocking @see param description in method phpdoc block.
1959
+		 * @param array $columns_and_ids_for_deleting       An array indicating what entities will get removed as
1960
+		 *                                                  derived from the incoming query parameters.
1961
+		 *                                                  @see details on the structure of this array in the phpdocs
1962
+		 *                                                  for the `_get_ids_for_delete_method`
1963
+		 *
1964
+		 */
1965
+		do_action('AHEE__EEM_Base__delete__before_query',
1966
+			$this,
1967
+			$query_params,
1968
+			$allow_blocking,
1969
+			$columns_and_ids_for_deleting
1970
+		);
1971
+		if ($deletion_where_query_part) {
1972
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
1973
+			$table_aliases = array_keys($this->_tables);
1974
+			$SQL = "DELETE "
1975
+				   . implode(", ", $table_aliases)
1976
+				   . " FROM "
1977
+				   . $model_query_info->get_full_join_sql()
1978
+				   . " WHERE "
1979
+				   . $deletion_where_query_part;
1980
+			$rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1981
+		} else {
1982
+			$rows_deleted = 0;
1983
+		}
1984
+
1985
+		//Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
1986
+		//there was no error with the delete query.
1987
+		if ($this->has_primary_key_field()
1988
+			&& $rows_deleted !== false
1989
+			&& isset($columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()])
1990
+		) {
1991
+			$ids_for_removal = $columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()];
1992
+			foreach ($ids_for_removal as $id) {
1993
+				if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
1994
+					unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
1995
+				}
1996
+			}
1997
+
1998
+			// delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
1999
+			//`EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
2000
+			//unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
2001
+			// (although it is possible).
2002
+			//Note this can be skipped by using the provided filter and returning false.
2003
+			if (apply_filters(
2004
+				'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
2005
+				! $this instanceof EEM_Extra_Meta,
2006
+				$this
2007
+			)) {
2008
+				EEM_Extra_Meta::instance()->delete_permanently(array(
2009
+					0 => array(
2010
+						'EXM_type' => $this->get_this_model_name(),
2011
+						'OBJ_ID'   => array(
2012
+							'IN',
2013
+							$ids_for_removal
2014
+						)
2015
+					)
2016
+				));
2017
+			}
2018
+		}
2019
+
2020
+		/**
2021
+		 * Action called just after performing a real deletion query. Although at this point the
2022
+		 * items should have been deleted
2023
+		 *
2024
+		 * @param EEM_Base $model
2025
+		 * @param array    $query_params @see EEM_Base::get_all()
2026
+		 * @param int      $rows_deleted
2027
+		 */
2028
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
2029
+		return $rows_deleted;//how many supposedly got deleted
2030
+	}
2031
+
2032
+
2033
+
2034
+	/**
2035
+	 * Checks all the relations that throw error messages when there are blocking related objects
2036
+	 * for related model objects. If there are any related model objects on those relations,
2037
+	 * adds an EE_Error, and return true
2038
+	 *
2039
+	 * @param EE_Base_Class|int $this_model_obj_or_id
2040
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
2041
+	 *                                                 should be ignored when determining whether there are related
2042
+	 *                                                 model objects which block this model object's deletion. Useful
2043
+	 *                                                 if you know A is related to B and are considering deleting A,
2044
+	 *                                                 but want to see if A has any other objects blocking its deletion
2045
+	 *                                                 before removing the relation between A and B
2046
+	 * @return boolean
2047
+	 * @throws EE_Error
2048
+	 */
2049
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
2050
+	{
2051
+		//first, if $ignore_this_model_obj was supplied, get its model
2052
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
2053
+			$ignored_model = $ignore_this_model_obj->get_model();
2054
+		} else {
2055
+			$ignored_model = null;
2056
+		}
2057
+		//now check all the relations of $this_model_obj_or_id and see if there
2058
+		//are any related model objects blocking it?
2059
+		$is_blocked = false;
2060
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
2061
+			if ($relation_obj->block_delete_if_related_models_exist()) {
2062
+				//if $ignore_this_model_obj was supplied, then for the query
2063
+				//on that model needs to be told to ignore $ignore_this_model_obj
2064
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
2065
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
2066
+						array(
2067
+							$ignored_model->get_primary_key_field()->get_name() => array(
2068
+								'!=',
2069
+								$ignore_this_model_obj->ID(),
2070
+							),
2071
+						),
2072
+					));
2073
+				} else {
2074
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
2075
+				}
2076
+				if ($related_model_objects) {
2077
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2078
+					$is_blocked = true;
2079
+				}
2080
+			}
2081
+		}
2082
+		return $is_blocked;
2083
+	}
2084
+
2085
+
2086
+	/**
2087
+	 * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
2088
+	 * @param array $row_results_for_deleting
2089
+	 * @param bool  $allow_blocking
2090
+	 * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
2091
+	 *                 model DOES have a primary_key_field, then the array will be a simple single dimension array where
2092
+	 *                 the key is the fully qualified primary key column and the value is an array of ids that will be
2093
+	 *                 deleted. Example:
2094
+	 *                      array('Event.EVT_ID' => array( 1,2,3))
2095
+	 *                 If the model DOES NOT have a primary_key_field, then the array will be a two dimensional array
2096
+	 *                 where each element is a group of columns and values that get deleted. Example:
2097
+	 *                      array(
2098
+	 *                          0 => array(
2099
+	 *                              'Term_Relationship.object_id' => 1
2100
+	 *                              'Term_Relationship.term_taxonomy_id' => 5
2101
+	 *                          ),
2102
+	 *                          1 => array(
2103
+	 *                              'Term_Relationship.object_id' => 1
2104
+	 *                              'Term_Relationship.term_taxonomy_id' => 6
2105
+	 *                          )
2106
+	 *                      )
2107
+	 * @throws EE_Error
2108
+	 */
2109
+	protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
2110
+	{
2111
+		$ids_to_delete_indexed_by_column = array();
2112
+		if ($this->has_primary_key_field()) {
2113
+			$primary_table = $this->_get_main_table();
2114
+			$primary_table_pk_field = $this->get_field_by_column($primary_table->get_fully_qualified_pk_column());
2115
+			$other_tables = $this->_get_other_tables();
2116
+			$ids_to_delete_indexed_by_column = $query = array();
2117
+			foreach ($row_results_for_deleting as $item_to_delete) {
2118
+				//before we mark this item for deletion,
2119
+				//make sure there's no related entities blocking its deletion (if we're checking)
2120
+				if (
2121
+					$allow_blocking
2122
+					&& $this->delete_is_blocked_by_related_models(
2123
+						$item_to_delete[$primary_table->get_fully_qualified_pk_column()]
2124
+					)
2125
+				) {
2126
+					continue;
2127
+				}
2128
+				//primary table deletes
2129
+				if (isset($item_to_delete[$primary_table->get_fully_qualified_pk_column()])) {
2130
+					$ids_to_delete_indexed_by_column[$primary_table->get_fully_qualified_pk_column()][] =
2131
+						$item_to_delete[$primary_table->get_fully_qualified_pk_column()];
2132
+				}
2133
+			}
2134
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2135
+			$fields = $this->get_combined_primary_key_fields();
2136
+			foreach ($row_results_for_deleting as $item_to_delete) {
2137
+				$ids_to_delete_indexed_by_column_for_row = array();
2138
+				foreach ($fields as $cpk_field) {
2139
+					if ($cpk_field instanceof EE_Model_Field_Base) {
2140
+						$ids_to_delete_indexed_by_column_for_row[$cpk_field->get_qualified_column()] =
2141
+							$item_to_delete[$cpk_field->get_qualified_column()];
2142
+					}
2143
+				}
2144
+				$ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
2145
+			}
2146
+		} else {
2147
+			//so there's no primary key and no combined key...
2148
+			//sorry, can't help you
2149
+			throw new EE_Error(
2150
+				sprintf(
2151
+					__(
2152
+						"Cannot delete objects of type %s because there is no primary key NOR combined key",
2153
+						"event_espresso"
2154
+					), get_class($this)
2155
+				)
2156
+			);
2157
+		}
2158
+		return $ids_to_delete_indexed_by_column;
2159
+	}
2160
+
2161
+
2162
+	/**
2163
+	 * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
2164
+	 * the corresponding query_part for the query performing the delete.
2165
+	 *
2166
+	 * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
2167
+	 * @return string
2168
+	 * @throws EE_Error
2169
+	 */
2170
+	protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column) {
2171
+		$query_part = '';
2172
+		if (empty($ids_to_delete_indexed_by_column)) {
2173
+			return $query_part;
2174
+		} elseif ($this->has_primary_key_field()) {
2175
+			$query = array();
2176
+			foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
2177
+				//make sure we have unique $ids
2178
+				$ids = array_unique($ids);
2179
+				$query[] = $column . ' IN(' . implode(',', $ids) . ')';
2180
+			}
2181
+			$query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
2182
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2183
+			$ways_to_identify_a_row = array();
2184
+			foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
2185
+				$values_for_each_combined_primary_key_for_a_row = array();
2186
+				foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
2187
+					$values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
2188
+				}
2189
+				$ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2190
+			}
2191
+			$query_part = implode(' OR ', $ways_to_identify_a_row);
2192
+		}
2193
+		return $query_part;
2194
+	}
2195
+
2196
+
2197
+
2198
+	/**
2199
+	 * Gets the model field by the fully qualified name
2200
+	 * @param string $qualified_column_name eg 'Event_CPT.post_name' or $field_obj->get_qualified_column()
2201
+	 * @return EE_Model_Field_Base
2202
+	 */
2203
+	public function get_field_by_column($qualified_column_name)
2204
+	{
2205
+	   foreach($this->field_settings(true) as $field_name => $field_obj){
2206
+		   if($field_obj->get_qualified_column() === $qualified_column_name){
2207
+			   return $field_obj;
2208
+		   }
2209
+	   }
2210
+		throw new EE_Error(
2211
+			sprintf(
2212
+				esc_html__('Could not find a field on the model "%1$s" for qualified column "%2$s"', 'event_espresso'),
2213
+				$this->get_this_model_name(),
2214
+				$qualified_column_name
2215
+			)
2216
+		);
2217
+	}
2218
+
2219
+
2220
+
2221
+	/**
2222
+	 * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2223
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2224
+	 * column
2225
+	 *
2226
+	 * @param array  $query_params   like EEM_Base::get_all's
2227
+	 * @param string $field_to_count field on model to count by (not column name)
2228
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2229
+	 *                               that by the setting $distinct to TRUE;
2230
+	 * @return int
2231
+	 * @throws EE_Error
2232
+	 */
2233
+	public function count($query_params = array(), $field_to_count = null, $distinct = false)
2234
+	{
2235
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2236
+		if ($field_to_count) {
2237
+			$field_obj = $this->field_settings_for($field_to_count);
2238
+			$column_to_count = $field_obj->get_qualified_column();
2239
+		} elseif ($this->has_primary_key_field()) {
2240
+			$pk_field_obj = $this->get_primary_key_field();
2241
+			$column_to_count = $pk_field_obj->get_qualified_column();
2242
+		} else {
2243
+			//there's no primary key
2244
+			//if we're counting distinct items, and there's no primary key,
2245
+			//we need to list out the columns for distinction;
2246
+			//otherwise we can just use star
2247
+			if ($distinct) {
2248
+				$columns_to_use = array();
2249
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2250
+					$columns_to_use[] = $field_obj->get_qualified_column();
2251
+				}
2252
+				$column_to_count = implode(',', $columns_to_use);
2253
+			} else {
2254
+				$column_to_count = '*';
2255
+			}
2256
+		}
2257
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2258
+		$SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2259
+		return (int)$this->_do_wpdb_query('get_var', array($SQL));
2260
+	}
2261
+
2262
+
2263
+
2264
+	/**
2265
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2266
+	 *
2267
+	 * @param array  $query_params like EEM_Base::get_all
2268
+	 * @param string $field_to_sum name of field (array key in $_fields array)
2269
+	 * @return float
2270
+	 * @throws EE_Error
2271
+	 */
2272
+	public function sum($query_params, $field_to_sum = null)
2273
+	{
2274
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2275
+		if ($field_to_sum) {
2276
+			$field_obj = $this->field_settings_for($field_to_sum);
2277
+		} else {
2278
+			$field_obj = $this->get_primary_key_field();
2279
+		}
2280
+		$column_to_count = $field_obj->get_qualified_column();
2281
+		$SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2282
+		$return_value = $this->_do_wpdb_query('get_var', array($SQL));
2283
+		$data_type = $field_obj->get_wpdb_data_type();
2284
+		if ($data_type === '%d' || $data_type === '%s') {
2285
+			return (float)$return_value;
2286
+		}
2287
+		//must be %f
2288
+		return (float)$return_value;
2289
+	}
2290
+
2291
+
2292
+
2293
+	/**
2294
+	 * Just calls the specified method on $wpdb with the given arguments
2295
+	 * Consolidates a little extra error handling code
2296
+	 *
2297
+	 * @param string $wpdb_method
2298
+	 * @param array  $arguments_to_provide
2299
+	 * @throws EE_Error
2300
+	 * @global wpdb  $wpdb
2301
+	 * @return mixed
2302
+	 */
2303
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2304
+	{
2305
+		//if we're in maintenance mode level 2, DON'T run any queries
2306
+		//because level 2 indicates the database needs updating and
2307
+		//is probably out of sync with the code
2308
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2309
+			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.",
2310
+				"event_espresso")));
2311
+		}
2312
+		/** @type WPDB $wpdb */
2313
+		global $wpdb;
2314
+		if (! method_exists($wpdb, $wpdb_method)) {
2315
+			throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2316
+				'event_espresso'), $wpdb_method));
2317
+		}
2318
+		if (WP_DEBUG) {
2319
+			$old_show_errors_value = $wpdb->show_errors;
2320
+			$wpdb->show_errors(false);
2321
+		}
2322
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2323
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
2324
+		if (WP_DEBUG) {
2325
+			$wpdb->show_errors($old_show_errors_value);
2326
+			if (! empty($wpdb->last_error)) {
2327
+				throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2328
+			}
2329
+			if ($result === false) {
2330
+				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"',
2331
+					'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2332
+			}
2333
+		} elseif ($result === false) {
2334
+			EE_Error::add_error(
2335
+				sprintf(
2336
+					__('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"',
2337
+						'event_espresso'),
2338
+					$wpdb_method,
2339
+					var_export($arguments_to_provide, true),
2340
+					$wpdb->last_error
2341
+				),
2342
+				__FILE__,
2343
+				__FUNCTION__,
2344
+				__LINE__
2345
+			);
2346
+		}
2347
+		return $result;
2348
+	}
2349
+
2350
+
2351
+
2352
+	/**
2353
+	 * Attempts to run the indicated WPDB method with the provided arguments,
2354
+	 * and if there's an error tries to verify the DB is correct. Uses
2355
+	 * the static property EEM_Base::$_db_verification_level to determine whether
2356
+	 * we should try to fix the EE core db, the addons, or just give up
2357
+	 *
2358
+	 * @param string $wpdb_method
2359
+	 * @param array  $arguments_to_provide
2360
+	 * @return mixed
2361
+	 */
2362
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2363
+	{
2364
+		/** @type WPDB $wpdb */
2365
+		global $wpdb;
2366
+		$wpdb->last_error = null;
2367
+		$result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2368
+		// was there an error running the query? but we don't care on new activations
2369
+		// (we're going to setup the DB anyway on new activations)
2370
+		if (($result === false || ! empty($wpdb->last_error))
2371
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2372
+		) {
2373
+			switch (EEM_Base::$_db_verification_level) {
2374
+				case EEM_Base::db_verified_none :
2375
+					// let's double-check core's DB
2376
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2377
+					break;
2378
+				case EEM_Base::db_verified_core :
2379
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2380
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2381
+					break;
2382
+				case EEM_Base::db_verified_addons :
2383
+					// ummmm... you in trouble
2384
+					return $result;
2385
+					break;
2386
+			}
2387
+			if (! empty($error_message)) {
2388
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2389
+				trigger_error($error_message);
2390
+			}
2391
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2392
+		}
2393
+		return $result;
2394
+	}
2395
+
2396
+
2397
+
2398
+	/**
2399
+	 * Verifies the EE core database is up-to-date and records that we've done it on
2400
+	 * EEM_Base::$_db_verification_level
2401
+	 *
2402
+	 * @param string $wpdb_method
2403
+	 * @param array  $arguments_to_provide
2404
+	 * @return string
2405
+	 */
2406
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
2407
+	{
2408
+		/** @type WPDB $wpdb */
2409
+		global $wpdb;
2410
+		//ok remember that we've already attempted fixing the core db, in case the problem persists
2411
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2412
+		$error_message = sprintf(
2413
+			__('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2414
+				'event_espresso'),
2415
+			$wpdb->last_error,
2416
+			$wpdb_method,
2417
+			wp_json_encode($arguments_to_provide)
2418
+		);
2419
+		EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2420
+		return $error_message;
2421
+	}
2422
+
2423
+
2424
+
2425
+	/**
2426
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
2427
+	 * EEM_Base::$_db_verification_level
2428
+	 *
2429
+	 * @param $wpdb_method
2430
+	 * @param $arguments_to_provide
2431
+	 * @return string
2432
+	 */
2433
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2434
+	{
2435
+		/** @type WPDB $wpdb */
2436
+		global $wpdb;
2437
+		//ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2438
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2439
+		$error_message = sprintf(
2440
+			__('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2441
+				'event_espresso'),
2442
+			$wpdb->last_error,
2443
+			$wpdb_method,
2444
+			wp_json_encode($arguments_to_provide)
2445
+		);
2446
+		EE_System::instance()->initialize_addons();
2447
+		return $error_message;
2448
+	}
2449
+
2450
+
2451
+
2452
+	/**
2453
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2454
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2455
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2456
+	 * ..."
2457
+	 *
2458
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
2459
+	 * @return string
2460
+	 */
2461
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2462
+	{
2463
+		return " FROM " . $model_query_info->get_full_join_sql() .
2464
+			   $model_query_info->get_where_sql() .
2465
+			   $model_query_info->get_group_by_sql() .
2466
+			   $model_query_info->get_having_sql() .
2467
+			   $model_query_info->get_order_by_sql() .
2468
+			   $model_query_info->get_limit_sql();
2469
+	}
2470
+
2471
+
2472
+
2473
+	/**
2474
+	 * Set to easily debug the next X queries ran from this model.
2475
+	 *
2476
+	 * @param int $count
2477
+	 */
2478
+	public function show_next_x_db_queries($count = 1)
2479
+	{
2480
+		$this->_show_next_x_db_queries = $count;
2481
+	}
2482
+
2483
+
2484
+
2485
+	/**
2486
+	 * @param $sql_query
2487
+	 */
2488
+	public function show_db_query_if_previously_requested($sql_query)
2489
+	{
2490
+		if ($this->_show_next_x_db_queries > 0) {
2491
+			echo $sql_query;
2492
+			$this->_show_next_x_db_queries--;
2493
+		}
2494
+	}
2495
+
2496
+
2497
+
2498
+	/**
2499
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2500
+	 * There are the 3 cases:
2501
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2502
+	 * $otherModelObject has no ID, it is first saved.
2503
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2504
+	 * has no ID, it is first saved.
2505
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2506
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2507
+	 * join table
2508
+	 *
2509
+	 * @param        EE_Base_Class                     /int $thisModelObject
2510
+	 * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2511
+	 * @param string $relationName                     , key in EEM_Base::_relations
2512
+	 *                                                 an attendee to a group, you also want to specify which role they
2513
+	 *                                                 will have in that group. So you would use this parameter to
2514
+	 *                                                 specify array('role-column-name'=>'role-id')
2515
+	 * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2516
+	 *                                                 to for relation to methods that allow you to further specify
2517
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2518
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
2519
+	 *                                                 because these will be inserted in any new rows created as well.
2520
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2521
+	 * @throws EE_Error
2522
+	 */
2523
+	public function add_relationship_to(
2524
+		$id_or_obj,
2525
+		$other_model_id_or_obj,
2526
+		$relationName,
2527
+		$extra_join_model_fields_n_values = array()
2528
+	) {
2529
+		$relation_obj = $this->related_settings_for($relationName);
2530
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2531
+	}
2532
+
2533
+
2534
+
2535
+	/**
2536
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2537
+	 * There are the 3 cases:
2538
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2539
+	 * error
2540
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2541
+	 * an error
2542
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2543
+	 *
2544
+	 * @param        EE_Base_Class /int $id_or_obj
2545
+	 * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2546
+	 * @param string $relationName key in EEM_Base::_relations
2547
+	 * @return boolean of success
2548
+	 * @throws EE_Error
2549
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2550
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2551
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2552
+	 *                             because these will be inserted in any new rows created as well.
2553
+	 */
2554
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2555
+	{
2556
+		$relation_obj = $this->related_settings_for($relationName);
2557
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2558
+	}
2559
+
2560
+
2561
+
2562
+	/**
2563
+	 * @param mixed           $id_or_obj
2564
+	 * @param string          $relationName
2565
+	 * @param array           $where_query_params
2566
+	 * @param EE_Base_Class[] objects to which relations were removed
2567
+	 * @return \EE_Base_Class[]
2568
+	 * @throws EE_Error
2569
+	 */
2570
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2571
+	{
2572
+		$relation_obj = $this->related_settings_for($relationName);
2573
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2574
+	}
2575
+
2576
+
2577
+
2578
+	/**
2579
+	 * Gets all the related items of the specified $model_name, using $query_params.
2580
+	 * Note: by default, we remove the "default query params"
2581
+	 * because we want to get even deleted items etc.
2582
+	 *
2583
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2584
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
2585
+	 * @param array  $query_params like EEM_Base::get_all
2586
+	 * @return EE_Base_Class[]
2587
+	 * @throws EE_Error
2588
+	 */
2589
+	public function get_all_related($id_or_obj, $model_name, $query_params = null)
2590
+	{
2591
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2592
+		$relation_settings = $this->related_settings_for($model_name);
2593
+		return $relation_settings->get_all_related($model_obj, $query_params);
2594
+	}
2595
+
2596
+
2597
+
2598
+	/**
2599
+	 * Deletes all the model objects across the relation indicated by $model_name
2600
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
2601
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
2602
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2603
+	 *
2604
+	 * @param EE_Base_Class|int|string $id_or_obj
2605
+	 * @param string                   $model_name
2606
+	 * @param array                    $query_params
2607
+	 * @return int how many deleted
2608
+	 * @throws EE_Error
2609
+	 */
2610
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
2611
+	{
2612
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2613
+		$relation_settings = $this->related_settings_for($model_name);
2614
+		return $relation_settings->delete_all_related($model_obj, $query_params);
2615
+	}
2616
+
2617
+
2618
+
2619
+	/**
2620
+	 * Hard deletes all the model objects across the relation indicated by $model_name
2621
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
2622
+	 * the model objects can't be hard deleted because of blocking related model objects,
2623
+	 * just does a soft-delete on them instead.
2624
+	 *
2625
+	 * @param EE_Base_Class|int|string $id_or_obj
2626
+	 * @param string                   $model_name
2627
+	 * @param array                    $query_params
2628
+	 * @return int how many deleted
2629
+	 * @throws EE_Error
2630
+	 */
2631
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2632
+	{
2633
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2634
+		$relation_settings = $this->related_settings_for($model_name);
2635
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
2636
+	}
2637
+
2638
+
2639
+
2640
+	/**
2641
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2642
+	 * unless otherwise specified in the $query_params
2643
+	 *
2644
+	 * @param        int             /EE_Base_Class $id_or_obj
2645
+	 * @param string $model_name     like 'Event', or 'Registration'
2646
+	 * @param array  $query_params   like EEM_Base::get_all's
2647
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
2648
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2649
+	 *                               that by the setting $distinct to TRUE;
2650
+	 * @return int
2651
+	 * @throws EE_Error
2652
+	 */
2653
+	public function count_related(
2654
+		$id_or_obj,
2655
+		$model_name,
2656
+		$query_params = array(),
2657
+		$field_to_count = null,
2658
+		$distinct = false
2659
+	) {
2660
+		$related_model = $this->get_related_model_obj($model_name);
2661
+		//we're just going to use the query params on the related model's normal get_all query,
2662
+		//except add a condition to say to match the current mod
2663
+		if (! isset($query_params['default_where_conditions'])) {
2664
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2665
+		}
2666
+		$this_model_name = $this->get_this_model_name();
2667
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2668
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2669
+		return $related_model->count($query_params, $field_to_count, $distinct);
2670
+	}
2671
+
2672
+
2673
+
2674
+	/**
2675
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
2676
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2677
+	 *
2678
+	 * @param        int           /EE_Base_Class $id_or_obj
2679
+	 * @param string $model_name   like 'Event', or 'Registration'
2680
+	 * @param array  $query_params like EEM_Base::get_all's
2681
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
2682
+	 * @return float
2683
+	 * @throws EE_Error
2684
+	 */
2685
+	public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2686
+	{
2687
+		$related_model = $this->get_related_model_obj($model_name);
2688
+		if (! is_array($query_params)) {
2689
+			EE_Error::doing_it_wrong('EEM_Base::sum_related',
2690
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2691
+					gettype($query_params)), '4.6.0');
2692
+			$query_params = array();
2693
+		}
2694
+		//we're just going to use the query params on the related model's normal get_all query,
2695
+		//except add a condition to say to match the current mod
2696
+		if (! isset($query_params['default_where_conditions'])) {
2697
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2698
+		}
2699
+		$this_model_name = $this->get_this_model_name();
2700
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2701
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2702
+		return $related_model->sum($query_params, $field_to_sum);
2703
+	}
2704
+
2705
+
2706
+
2707
+	/**
2708
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2709
+	 * $modelObject
2710
+	 *
2711
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2712
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2713
+	 * @param array               $query_params     like EEM_Base::get_all's
2714
+	 * @return EE_Base_Class
2715
+	 * @throws EE_Error
2716
+	 */
2717
+	public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2718
+	{
2719
+		$query_params['limit'] = 1;
2720
+		$results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2721
+		if ($results) {
2722
+			return array_shift($results);
2723
+		}
2724
+		return null;
2725
+	}
2726
+
2727
+
2728
+
2729
+	/**
2730
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2731
+	 *
2732
+	 * @return string
2733
+	 */
2734
+	public function get_this_model_name()
2735
+	{
2736
+		return str_replace("EEM_", "", get_class($this));
2737
+	}
2738
+
2739
+
2740
+
2741
+	/**
2742
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2743
+	 *
2744
+	 * @return EE_Any_Foreign_Model_Name_Field
2745
+	 * @throws EE_Error
2746
+	 */
2747
+	public function get_field_containing_related_model_name()
2748
+	{
2749
+		foreach ($this->field_settings(true) as $field) {
2750
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2751
+				$field_with_model_name = $field;
2752
+			}
2753
+		}
2754
+		if (! isset($field_with_model_name) || ! $field_with_model_name) {
2755
+			throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2756
+				$this->get_this_model_name()));
2757
+		}
2758
+		return $field_with_model_name;
2759
+	}
2760
+
2761
+
2762
+
2763
+	/**
2764
+	 * Inserts a new entry into the database, for each table.
2765
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2766
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2767
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
2768
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
2769
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2770
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2771
+	 *
2772
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2773
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2774
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2775
+	 *                              of EEM_Base)
2776
+	 * @return int new primary key on main table that got inserted
2777
+	 * @throws EE_Error
2778
+	 */
2779
+	public function insert($field_n_values)
2780
+	{
2781
+		/**
2782
+		 * Filters the fields and their values before inserting an item using the models
2783
+		 *
2784
+		 * @param array    $fields_n_values keys are the fields and values are their new values
2785
+		 * @param EEM_Base $model           the model used
2786
+		 */
2787
+		$field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2788
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
2789
+			$main_table = $this->_get_main_table();
2790
+			$new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2791
+			if ($new_id !== false) {
2792
+				foreach ($this->_get_other_tables() as $other_table) {
2793
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2794
+				}
2795
+			}
2796
+			/**
2797
+			 * Done just after attempting to insert a new model object
2798
+			 *
2799
+			 * @param EEM_Base   $model           used
2800
+			 * @param array      $fields_n_values fields and their values
2801
+			 * @param int|string the              ID of the newly-inserted model object
2802
+			 */
2803
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2804
+			return $new_id;
2805
+		}
2806
+		return false;
2807
+	}
2808
+
2809
+
2810
+
2811
+	/**
2812
+	 * Checks that the result would satisfy the unique indexes on this model
2813
+	 *
2814
+	 * @param array  $field_n_values
2815
+	 * @param string $action
2816
+	 * @return boolean
2817
+	 * @throws EE_Error
2818
+	 */
2819
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2820
+	{
2821
+		foreach ($this->unique_indexes() as $index_name => $index) {
2822
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2823
+			if ($this->exists(array($uniqueness_where_params))) {
2824
+				EE_Error::add_error(
2825
+					sprintf(
2826
+						__(
2827
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2828
+							"event_espresso"
2829
+						),
2830
+						$action,
2831
+						$this->_get_class_name(),
2832
+						$index_name,
2833
+						implode(",", $index->field_names()),
2834
+						http_build_query($uniqueness_where_params)
2835
+					),
2836
+					__FILE__,
2837
+					__FUNCTION__,
2838
+					__LINE__
2839
+				);
2840
+				return false;
2841
+			}
2842
+		}
2843
+		return true;
2844
+	}
2845
+
2846
+
2847
+
2848
+	/**
2849
+	 * Checks the database for an item that conflicts (ie, if this item were
2850
+	 * saved to the DB would break some uniqueness requirement, like a primary key
2851
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
2852
+	 * can be either an EE_Base_Class or an array of fields n values
2853
+	 *
2854
+	 * @param EE_Base_Class|array $obj_or_fields_array
2855
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
2856
+	 *                                                 when looking for conflicts
2857
+	 *                                                 (ie, if false, we ignore the model object's primary key
2858
+	 *                                                 when finding "conflicts". If true, it's also considered).
2859
+	 *                                                 Only works for INT primary key,
2860
+	 *                                                 STRING primary keys cannot be ignored
2861
+	 * @throws EE_Error
2862
+	 * @return EE_Base_Class|array
2863
+	 */
2864
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2865
+	{
2866
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
2867
+			$fields_n_values = $obj_or_fields_array->model_field_array();
2868
+		} elseif (is_array($obj_or_fields_array)) {
2869
+			$fields_n_values = $obj_or_fields_array;
2870
+		} else {
2871
+			throw new EE_Error(
2872
+				sprintf(
2873
+					__(
2874
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2875
+						"event_espresso"
2876
+					),
2877
+					get_class($this),
2878
+					$obj_or_fields_array
2879
+				)
2880
+			);
2881
+		}
2882
+		$query_params = array();
2883
+		if ($this->has_primary_key_field()
2884
+			&& ($include_primary_key
2885
+				|| $this->get_primary_key_field()
2886
+				   instanceof
2887
+				   EE_Primary_Key_String_Field)
2888
+			&& isset($fields_n_values[$this->primary_key_name()])
2889
+		) {
2890
+			$query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2891
+		}
2892
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2893
+			$uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2894
+			$query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2895
+		}
2896
+		//if there is nothing to base this search on, then we shouldn't find anything
2897
+		if (empty($query_params)) {
2898
+			return array();
2899
+		}
2900
+		return $this->get_one($query_params);
2901
+	}
2902
+
2903
+
2904
+
2905
+	/**
2906
+	 * Like count, but is optimized and returns a boolean instead of an int
2907
+	 *
2908
+	 * @param array $query_params
2909
+	 * @return boolean
2910
+	 * @throws EE_Error
2911
+	 */
2912
+	public function exists($query_params)
2913
+	{
2914
+		$query_params['limit'] = 1;
2915
+		return $this->count($query_params) > 0;
2916
+	}
2917
+
2918
+
2919
+
2920
+	/**
2921
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
2922
+	 *
2923
+	 * @param int|string $id
2924
+	 * @return boolean
2925
+	 * @throws EE_Error
2926
+	 */
2927
+	public function exists_by_ID($id)
2928
+	{
2929
+		return $this->exists(
2930
+			array(
2931
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
2932
+				array(
2933
+					$this->primary_key_name() => $id,
2934
+				),
2935
+			)
2936
+		);
2937
+	}
2938
+
2939
+
2940
+
2941
+	/**
2942
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2943
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2944
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2945
+	 * on the main table)
2946
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
2947
+	 * cases where we want to call it directly rather than via insert().
2948
+	 *
2949
+	 * @access   protected
2950
+	 * @param EE_Table_Base $table
2951
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2952
+	 *                                       float
2953
+	 * @param int           $new_id          for now we assume only int keys
2954
+	 * @throws EE_Error
2955
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2956
+	 * @return int ID of new row inserted, or FALSE on failure
2957
+	 */
2958
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2959
+	{
2960
+		global $wpdb;
2961
+		$insertion_col_n_values = array();
2962
+		$format_for_insertion = array();
2963
+		$fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2964
+		foreach ($fields_on_table as $field_name => $field_obj) {
2965
+			//check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2966
+			if ($field_obj->is_auto_increment()) {
2967
+				continue;
2968
+			}
2969
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2970
+			//if the value we want to assign it to is NULL, just don't mention it for the insertion
2971
+			if ($prepared_value !== null) {
2972
+				$insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2973
+				$format_for_insertion[] = $field_obj->get_wpdb_data_type();
2974
+			}
2975
+		}
2976
+		if ($table instanceof EE_Secondary_Table && $new_id) {
2977
+			//its not the main table, so we should have already saved the main table's PK which we just inserted
2978
+			//so add the fk to the main table as a column
2979
+			$insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2980
+			$format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2981
+		}
2982
+		//insert the new entry
2983
+		$result = $this->_do_wpdb_query('insert',
2984
+			array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2985
+		if ($result === false) {
2986
+			return false;
2987
+		}
2988
+		//ok, now what do we return for the ID of the newly-inserted thing?
2989
+		if ($this->has_primary_key_field()) {
2990
+			if ($this->get_primary_key_field()->is_auto_increment()) {
2991
+				return $wpdb->insert_id;
2992
+			}
2993
+			//it's not an auto-increment primary key, so
2994
+			//it must have been supplied
2995
+			return $fields_n_values[$this->get_primary_key_field()->get_name()];
2996
+		}
2997
+		//we can't return a  primary key because there is none. instead return
2998
+		//a unique string indicating this model
2999
+		return $this->get_index_primary_key_string($fields_n_values);
3000
+	}
3001
+
3002
+
3003
+
3004
+	/**
3005
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
3006
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
3007
+	 * and there is no default, we pass it along. WPDB will take care of it)
3008
+	 *
3009
+	 * @param EE_Model_Field_Base $field_obj
3010
+	 * @param array               $fields_n_values
3011
+	 * @return mixed string|int|float depending on what the table column will be expecting
3012
+	 * @throws EE_Error
3013
+	 */
3014
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
3015
+	{
3016
+		//if this field doesn't allow nullable, don't allow it
3017
+		if (
3018
+			! $field_obj->is_nullable()
3019
+			&& (
3020
+				! isset($fields_n_values[$field_obj->get_name()])
3021
+				|| $fields_n_values[$field_obj->get_name()] === null
3022
+			)
3023
+		) {
3024
+			$fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
3025
+		}
3026
+		$unprepared_value = isset($fields_n_values[$field_obj->get_name()])
3027
+			? $fields_n_values[$field_obj->get_name()]
3028
+			: null;
3029
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
3030
+	}
3031
+
3032
+
3033
+
3034
+	/**
3035
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
3036
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
3037
+	 * the field's prepare_for_set() method.
3038
+	 *
3039
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
3040
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
3041
+	 *                                   top of file)
3042
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
3043
+	 *                                   $value is a custom selection
3044
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
3045
+	 */
3046
+	private function _prepare_value_for_use_in_db($value, $field)
3047
+	{
3048
+		if ($field && $field instanceof EE_Model_Field_Base) {
3049
+			switch ($this->_values_already_prepared_by_model_object) {
3050
+				/** @noinspection PhpMissingBreakStatementInspection */
3051
+				case self::not_prepared_by_model_object:
3052
+					$value = $field->prepare_for_set($value);
3053
+				//purposefully left out "return"
3054
+				case self::prepared_by_model_object:
3055
+					/** @noinspection SuspiciousAssignmentsInspection */
3056
+					$value = $field->prepare_for_use_in_db($value);
3057
+				case self::prepared_for_use_in_db:
3058
+					//leave the value alone
3059
+			}
3060
+			return $value;
3061
+		}
3062
+		return $value;
3063
+	}
3064
+
3065
+
3066
+
3067
+	/**
3068
+	 * Returns the main table on this model
3069
+	 *
3070
+	 * @return EE_Primary_Table
3071
+	 * @throws EE_Error
3072
+	 */
3073
+	protected function _get_main_table()
3074
+	{
3075
+		foreach ($this->_tables as $table) {
3076
+			if ($table instanceof EE_Primary_Table) {
3077
+				return $table;
3078
+			}
3079
+		}
3080
+		throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
3081
+			'event_espresso'), get_class($this)));
3082
+	}
3083
+
3084
+
3085
+
3086
+	/**
3087
+	 * table
3088
+	 * returns EE_Primary_Table table name
3089
+	 *
3090
+	 * @return string
3091
+	 * @throws EE_Error
3092
+	 */
3093
+	public function table()
3094
+	{
3095
+		return $this->_get_main_table()->get_table_name();
3096
+	}
3097
+
3098
+
3099
+
3100
+	/**
3101
+	 * table
3102
+	 * returns first EE_Secondary_Table table name
3103
+	 *
3104
+	 * @return string
3105
+	 */
3106
+	public function second_table()
3107
+	{
3108
+		// grab second table from tables array
3109
+		$second_table = end($this->_tables);
3110
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
3111
+	}
3112
+
3113
+
3114
+
3115
+	/**
3116
+	 * get_table_obj_by_alias
3117
+	 * returns table name given it's alias
3118
+	 *
3119
+	 * @param string $table_alias
3120
+	 * @return EE_Primary_Table | EE_Secondary_Table
3121
+	 */
3122
+	public function get_table_obj_by_alias($table_alias = '')
3123
+	{
3124
+		return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3125
+	}
3126
+
3127
+
3128
+
3129
+	/**
3130
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3131
+	 *
3132
+	 * @return EE_Secondary_Table[]
3133
+	 */
3134
+	protected function _get_other_tables()
3135
+	{
3136
+		$other_tables = array();
3137
+		foreach ($this->_tables as $table_alias => $table) {
3138
+			if ($table instanceof EE_Secondary_Table) {
3139
+				$other_tables[$table_alias] = $table;
3140
+			}
3141
+		}
3142
+		return $other_tables;
3143
+	}
3144
+
3145
+
3146
+
3147
+	/**
3148
+	 * Finds all the fields that correspond to the given table
3149
+	 *
3150
+	 * @param string $table_alias , array key in EEM_Base::_tables
3151
+	 * @return EE_Model_Field_Base[]
3152
+	 */
3153
+	public function _get_fields_for_table($table_alias)
3154
+	{
3155
+		return $this->_fields[$table_alias];
3156
+	}
3157
+
3158
+
3159
+
3160
+	/**
3161
+	 * Recurses through all the where parameters, and finds all the related models we'll need
3162
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3163
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3164
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3165
+	 * related Registration, Transaction, and Payment models.
3166
+	 *
3167
+	 * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3168
+	 * @return EE_Model_Query_Info_Carrier
3169
+	 * @throws EE_Error
3170
+	 */
3171
+	public function _extract_related_models_from_query($query_params)
3172
+	{
3173
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
3174
+		if (array_key_exists(0, $query_params)) {
3175
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3176
+		}
3177
+		if (array_key_exists('group_by', $query_params)) {
3178
+			if (is_array($query_params['group_by'])) {
3179
+				$this->_extract_related_models_from_sub_params_array_values(
3180
+					$query_params['group_by'],
3181
+					$query_info_carrier,
3182
+					'group_by'
3183
+				);
3184
+			} elseif (! empty ($query_params['group_by'])) {
3185
+				$this->_extract_related_model_info_from_query_param(
3186
+					$query_params['group_by'],
3187
+					$query_info_carrier,
3188
+					'group_by'
3189
+				);
3190
+			}
3191
+		}
3192
+		if (array_key_exists('having', $query_params)) {
3193
+			$this->_extract_related_models_from_sub_params_array_keys(
3194
+				$query_params[0],
3195
+				$query_info_carrier,
3196
+				'having'
3197
+			);
3198
+		}
3199
+		if (array_key_exists('order_by', $query_params)) {
3200
+			if (is_array($query_params['order_by'])) {
3201
+				$this->_extract_related_models_from_sub_params_array_keys(
3202
+					$query_params['order_by'],
3203
+					$query_info_carrier,
3204
+					'order_by'
3205
+				);
3206
+			} elseif (! empty($query_params['order_by'])) {
3207
+				$this->_extract_related_model_info_from_query_param(
3208
+					$query_params['order_by'],
3209
+					$query_info_carrier,
3210
+					'order_by'
3211
+				);
3212
+			}
3213
+		}
3214
+		if (array_key_exists('force_join', $query_params)) {
3215
+			$this->_extract_related_models_from_sub_params_array_values(
3216
+				$query_params['force_join'],
3217
+				$query_info_carrier,
3218
+				'force_join'
3219
+			);
3220
+		}
3221
+		return $query_info_carrier;
3222
+	}
3223
+
3224
+
3225
+
3226
+	/**
3227
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3228
+	 *
3229
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3230
+	 *                                                      $query_params['having']
3231
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3232
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3233
+	 * @throws EE_Error
3234
+	 * @return \EE_Model_Query_Info_Carrier
3235
+	 */
3236
+	private function _extract_related_models_from_sub_params_array_keys(
3237
+		$sub_query_params,
3238
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3239
+		$query_param_type
3240
+	) {
3241
+		if (! empty($sub_query_params)) {
3242
+			$sub_query_params = (array)$sub_query_params;
3243
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
3244
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3245
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3246
+					$query_param_type);
3247
+				//if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3248
+				//indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3249
+				//extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3250
+				//of array('Registration.TXN_ID'=>23)
3251
+				$query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3252
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3253
+					if (! is_array($possibly_array_of_params)) {
3254
+						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'))",
3255
+							"event_espresso"),
3256
+							$param, $possibly_array_of_params));
3257
+					}
3258
+					$this->_extract_related_models_from_sub_params_array_keys(
3259
+						$possibly_array_of_params,
3260
+						$model_query_info_carrier, $query_param_type
3261
+					);
3262
+				} elseif ($query_param_type === 0 //ie WHERE
3263
+						  && is_array($possibly_array_of_params)
3264
+						  && isset($possibly_array_of_params[2])
3265
+						  && $possibly_array_of_params[2] == true
3266
+				) {
3267
+					//then $possible_array_of_params looks something like array('<','DTT_sold',true)
3268
+					//indicating that $possible_array_of_params[1] is actually a field name,
3269
+					//from which we should extract query parameters!
3270
+					if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3271
+						throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3272
+							"event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3273
+					}
3274
+					$this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3275
+						$model_query_info_carrier, $query_param_type);
3276
+				}
3277
+			}
3278
+		}
3279
+		return $model_query_info_carrier;
3280
+	}
3281
+
3282
+
3283
+
3284
+	/**
3285
+	 * For extracting related models from forced_joins, where the array values contain the info about what
3286
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3287
+	 *
3288
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3289
+	 *                                                      $query_params['having']
3290
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3291
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3292
+	 * @throws EE_Error
3293
+	 * @return \EE_Model_Query_Info_Carrier
3294
+	 */
3295
+	private function _extract_related_models_from_sub_params_array_values(
3296
+		$sub_query_params,
3297
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3298
+		$query_param_type
3299
+	) {
3300
+		if (! empty($sub_query_params)) {
3301
+			if (! is_array($sub_query_params)) {
3302
+				throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3303
+					$sub_query_params));
3304
+			}
3305
+			foreach ($sub_query_params as $param) {
3306
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3307
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3308
+					$query_param_type);
3309
+			}
3310
+		}
3311
+		return $model_query_info_carrier;
3312
+	}
3313
+
3314
+
3315
+
3316
+	/**
3317
+	 * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3318
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3319
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
3320
+	 * but use them in a different order. Eg, we need to know what models we are querying
3321
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3322
+	 * other models before we can finalize the where clause SQL.
3323
+	 *
3324
+	 * @param array $query_params
3325
+	 * @throws EE_Error
3326
+	 * @return EE_Model_Query_Info_Carrier
3327
+	 */
3328
+	public function _create_model_query_info_carrier($query_params)
3329
+	{
3330
+		if (! is_array($query_params)) {
3331
+			EE_Error::doing_it_wrong(
3332
+				'EEM_Base::_create_model_query_info_carrier',
3333
+				sprintf(
3334
+					__(
3335
+						'$query_params should be an array, you passed a variable of type %s',
3336
+						'event_espresso'
3337
+					),
3338
+					gettype($query_params)
3339
+				),
3340
+				'4.6.0'
3341
+			);
3342
+			$query_params = array();
3343
+		}
3344
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3345
+		//first check if we should alter the query to account for caps or not
3346
+		//because the caps might require us to do extra joins
3347
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3348
+			$query_params[0] = $where_query_params = array_replace_recursive(
3349
+				$where_query_params,
3350
+				$this->caps_where_conditions(
3351
+					$query_params['caps']
3352
+				)
3353
+			);
3354
+		}
3355
+		$query_object = $this->_extract_related_models_from_query($query_params);
3356
+		//verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3357
+		foreach ($where_query_params as $key => $value) {
3358
+			if (is_int($key)) {
3359
+				throw new EE_Error(
3360
+					sprintf(
3361
+						__(
3362
+							"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.",
3363
+							"event_espresso"
3364
+						),
3365
+						$key,
3366
+						var_export($value, true),
3367
+						var_export($query_params, true),
3368
+						get_class($this)
3369
+					)
3370
+				);
3371
+			}
3372
+		}
3373
+		if (
3374
+			array_key_exists('default_where_conditions', $query_params)
3375
+			&& ! empty($query_params['default_where_conditions'])
3376
+		) {
3377
+			$use_default_where_conditions = $query_params['default_where_conditions'];
3378
+		} else {
3379
+			$use_default_where_conditions = EEM_Base::default_where_conditions_all;
3380
+		}
3381
+		$where_query_params = array_merge(
3382
+			$this->_get_default_where_conditions_for_models_in_query(
3383
+				$query_object,
3384
+				$use_default_where_conditions,
3385
+				$where_query_params
3386
+			),
3387
+			$where_query_params
3388
+		);
3389
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3390
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3391
+		// So we need to setup a subquery and use that for the main join.
3392
+		// Note for now this only works on the primary table for the model.
3393
+		// So for instance, you could set the limit array like this:
3394
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3395
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3396
+			$query_object->set_main_model_join_sql(
3397
+				$this->_construct_limit_join_select(
3398
+					$query_params['on_join_limit'][0],
3399
+					$query_params['on_join_limit'][1]
3400
+				)
3401
+			);
3402
+		}
3403
+		//set limit
3404
+		if (array_key_exists('limit', $query_params)) {
3405
+			if (is_array($query_params['limit'])) {
3406
+				if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3407
+					$e = sprintf(
3408
+						__(
3409
+							"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)",
3410
+							"event_espresso"
3411
+						),
3412
+						http_build_query($query_params['limit'])
3413
+					);
3414
+					throw new EE_Error($e . "|" . $e);
3415
+				}
3416
+				//they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3417
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3418
+			} elseif (! empty ($query_params['limit'])) {
3419
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3420
+			}
3421
+		}
3422
+		//set order by
3423
+		if (array_key_exists('order_by', $query_params)) {
3424
+			if (is_array($query_params['order_by'])) {
3425
+				//if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3426
+				//specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3427
+				//including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3428
+				if (array_key_exists('order', $query_params)) {
3429
+					throw new EE_Error(
3430
+						sprintf(
3431
+							__(
3432
+								"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 ",
3433
+								"event_espresso"
3434
+							),
3435
+							get_class($this),
3436
+							implode(", ", array_keys($query_params['order_by'])),
3437
+							implode(", ", $query_params['order_by']),
3438
+							$query_params['order']
3439
+						)
3440
+					);
3441
+				}
3442
+				$this->_extract_related_models_from_sub_params_array_keys(
3443
+					$query_params['order_by'],
3444
+					$query_object,
3445
+					'order_by'
3446
+				);
3447
+				//assume it's an array of fields to order by
3448
+				$order_array = array();
3449
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3450
+					$order = $this->_extract_order($order);
3451
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3452
+				}
3453
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3454
+			} elseif (! empty ($query_params['order_by'])) {
3455
+				$this->_extract_related_model_info_from_query_param(
3456
+					$query_params['order_by'],
3457
+					$query_object,
3458
+					'order',
3459
+					$query_params['order_by']
3460
+				);
3461
+				$order = isset($query_params['order'])
3462
+					? $this->_extract_order($query_params['order'])
3463
+					: 'DESC';
3464
+				$query_object->set_order_by_sql(
3465
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3466
+				);
3467
+			}
3468
+		}
3469
+		//if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3470
+		if (! array_key_exists('order_by', $query_params)
3471
+			&& array_key_exists('order', $query_params)
3472
+			&& ! empty($query_params['order'])
3473
+		) {
3474
+			$pk_field = $this->get_primary_key_field();
3475
+			$order = $this->_extract_order($query_params['order']);
3476
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3477
+		}
3478
+		//set group by
3479
+		if (array_key_exists('group_by', $query_params)) {
3480
+			if (is_array($query_params['group_by'])) {
3481
+				//it's an array, so assume we'll be grouping by a bunch of stuff
3482
+				$group_by_array = array();
3483
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
3484
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3485
+				}
3486
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3487
+			} elseif (! empty ($query_params['group_by'])) {
3488
+				$query_object->set_group_by_sql(
3489
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3490
+				);
3491
+			}
3492
+		}
3493
+		//set having
3494
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
3495
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3496
+		}
3497
+		//now, just verify they didn't pass anything wack
3498
+		foreach ($query_params as $query_key => $query_value) {
3499
+			if (! in_array($query_key, $this->_allowed_query_params, true)) {
3500
+				throw new EE_Error(
3501
+					sprintf(
3502
+						__(
3503
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3504
+							'event_espresso'
3505
+						),
3506
+						$query_key,
3507
+						get_class($this),
3508
+						//						print_r( $this->_allowed_query_params, TRUE )
3509
+						implode(',', $this->_allowed_query_params)
3510
+					)
3511
+				);
3512
+			}
3513
+		}
3514
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
3515
+		if (empty($main_model_join_sql)) {
3516
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
3517
+		}
3518
+		return $query_object;
3519
+	}
3520
+
3521
+
3522
+
3523
+	/**
3524
+	 * Gets the where conditions that should be imposed on the query based on the
3525
+	 * context (eg reading frontend, backend, edit or delete).
3526
+	 *
3527
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
3528
+	 * @return array like EEM_Base::get_all() 's $query_params[0]
3529
+	 * @throws EE_Error
3530
+	 */
3531
+	public function caps_where_conditions($context = self::caps_read)
3532
+	{
3533
+		EEM_Base::verify_is_valid_cap_context($context);
3534
+		$cap_where_conditions = array();
3535
+		$cap_restrictions = $this->caps_missing($context);
3536
+		/**
3537
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
3538
+		 */
3539
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3540
+			$cap_where_conditions = array_replace_recursive($cap_where_conditions,
3541
+				$restriction_if_no_cap->get_default_where_conditions());
3542
+		}
3543
+		return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3544
+			$cap_restrictions);
3545
+	}
3546
+
3547
+
3548
+
3549
+	/**
3550
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3551
+	 * otherwise throws an exception
3552
+	 *
3553
+	 * @param string $should_be_order_string
3554
+	 * @return string either ASC, asc, DESC or desc
3555
+	 * @throws EE_Error
3556
+	 */
3557
+	private function _extract_order($should_be_order_string)
3558
+	{
3559
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3560
+			return $should_be_order_string;
3561
+		}
3562
+		throw new EE_Error(
3563
+			sprintf(
3564
+				__(
3565
+					"While performing a query on '%s', tried to use '%s' as an order parameter. ",
3566
+					"event_espresso"
3567
+				), get_class($this), $should_be_order_string
3568
+			)
3569
+		);
3570
+	}
3571
+
3572
+
3573
+
3574
+	/**
3575
+	 * Looks at all the models which are included in this query, and asks each
3576
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3577
+	 * so they can be merged
3578
+	 *
3579
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
3580
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3581
+	 *                                                                  'none' means NO default where conditions will
3582
+	 *                                                                  be used AT ALL during this query.
3583
+	 *                                                                  'other_models_only' means default where
3584
+	 *                                                                  conditions from other models will be used, but
3585
+	 *                                                                  not for this primary model. 'all', the default,
3586
+	 *                                                                  means default where conditions will apply as
3587
+	 *                                                                  normal
3588
+	 * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3589
+	 * @throws EE_Error
3590
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
3591
+	 */
3592
+	private function _get_default_where_conditions_for_models_in_query(
3593
+		EE_Model_Query_Info_Carrier $query_info_carrier,
3594
+		$use_default_where_conditions = EEM_Base::default_where_conditions_all,
3595
+		$where_query_params = array()
3596
+	) {
3597
+		$allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3598
+		if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3599
+			throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3600
+				"event_espresso"), $use_default_where_conditions,
3601
+				implode(", ", $allowed_used_default_where_conditions_values)));
3602
+		}
3603
+		$universal_query_params = array();
3604
+		if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3605
+			$universal_query_params = $this->_get_default_where_conditions();
3606
+		} else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3607
+			$universal_query_params = $this->_get_minimum_where_conditions();
3608
+		}
3609
+		foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3610
+			$related_model = $this->get_related_model_obj($model_name);
3611
+			if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3612
+				$related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3613
+			} elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3614
+				$related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3615
+			} else {
3616
+				//we don't want to add full or even minimum default where conditions from this model, so just continue
3617
+				continue;
3618
+			}
3619
+			$overrides = $this->_override_defaults_or_make_null_friendly(
3620
+				$related_model_universal_where_params,
3621
+				$where_query_params,
3622
+				$related_model,
3623
+				$model_relation_path
3624
+			);
3625
+			$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3626
+				$universal_query_params,
3627
+				$overrides
3628
+			);
3629
+		}
3630
+		return $universal_query_params;
3631
+	}
3632
+
3633
+
3634
+
3635
+	/**
3636
+	 * Determines whether or not we should use default where conditions for the model in question
3637
+	 * (this model, or other related models).
3638
+	 * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3639
+	 * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3640
+	 * We should use default where conditions on related models when they requested to use default where conditions
3641
+	 * on all models, or specifically just on other related models
3642
+	 * @param      $default_where_conditions_value
3643
+	 * @param bool $for_this_model false means this is for OTHER related models
3644
+	 * @return bool
3645
+	 */
3646
+	private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3647
+	{
3648
+		return (
3649
+				   $for_this_model
3650
+				   && in_array(
3651
+					   $default_where_conditions_value,
3652
+					   array(
3653
+						   EEM_Base::default_where_conditions_all,
3654
+						   EEM_Base::default_where_conditions_this_only,
3655
+						   EEM_Base::default_where_conditions_minimum_others,
3656
+					   ),
3657
+					   true
3658
+				   )
3659
+			   )
3660
+			   || (
3661
+				   ! $for_this_model
3662
+				   && in_array(
3663
+					   $default_where_conditions_value,
3664
+					   array(
3665
+						   EEM_Base::default_where_conditions_all,
3666
+						   EEM_Base::default_where_conditions_others_only,
3667
+					   ),
3668
+					   true
3669
+				   )
3670
+			   );
3671
+	}
3672
+
3673
+	/**
3674
+	 * Determines whether or not we should use default minimum conditions for the model in question
3675
+	 * (this model, or other related models).
3676
+	 * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3677
+	 * where conditions.
3678
+	 * We should use minimum where conditions on related models if they requested to use minimum where conditions
3679
+	 * on this model or others
3680
+	 * @param      $default_where_conditions_value
3681
+	 * @param bool $for_this_model false means this is for OTHER related models
3682
+	 * @return bool
3683
+	 */
3684
+	private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3685
+	{
3686
+		return (
3687
+				   $for_this_model
3688
+				   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3689
+			   )
3690
+			   || (
3691
+				   ! $for_this_model
3692
+				   && in_array(
3693
+					   $default_where_conditions_value,
3694
+					   array(
3695
+						   EEM_Base::default_where_conditions_minimum_others,
3696
+						   EEM_Base::default_where_conditions_minimum_all,
3697
+					   ),
3698
+					   true
3699
+				   )
3700
+			   );
3701
+	}
3702
+
3703
+
3704
+	/**
3705
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3706
+	 * then we also add a special where condition which allows for that model's primary key
3707
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3708
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3709
+	 *
3710
+	 * @param array    $default_where_conditions
3711
+	 * @param array    $provided_where_conditions
3712
+	 * @param EEM_Base $model
3713
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
3714
+	 * @return array like EEM_Base::get_all's $query_params[0]
3715
+	 * @throws EE_Error
3716
+	 */
3717
+	private function _override_defaults_or_make_null_friendly(
3718
+		$default_where_conditions,
3719
+		$provided_where_conditions,
3720
+		$model,
3721
+		$model_relation_path
3722
+	) {
3723
+		$null_friendly_where_conditions = array();
3724
+		$none_overridden = true;
3725
+		$or_condition_key_for_defaults = 'OR*' . get_class($model);
3726
+		foreach ($default_where_conditions as $key => $val) {
3727
+			if (isset($provided_where_conditions[$key])) {
3728
+				$none_overridden = false;
3729
+			} else {
3730
+				$null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3731
+			}
3732
+		}
3733
+		if ($none_overridden && $default_where_conditions) {
3734
+			if ($model->has_primary_key_field()) {
3735
+				$null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3736
+																				. "."
3737
+																				. $model->primary_key_name()] = array('IS NULL');
3738
+			}/*else{
3739 3739
 				//@todo NO PK, use other defaults
3740 3740
 			}*/
3741
-        }
3742
-        return $null_friendly_where_conditions;
3743
-    }
3744
-
3745
-
3746
-
3747
-    /**
3748
-     * Uses the _default_where_conditions_strategy set during __construct() to get
3749
-     * default where conditions on all get_all, update, and delete queries done by this model.
3750
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3751
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3752
-     *
3753
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3754
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3755
-     */
3756
-    private function _get_default_where_conditions($model_relation_path = null)
3757
-    {
3758
-        if ($this->_ignore_where_strategy) {
3759
-            return array();
3760
-        }
3761
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3762
-    }
3763
-
3764
-
3765
-
3766
-    /**
3767
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
3768
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
3769
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3770
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3771
-     * Similar to _get_default_where_conditions
3772
-     *
3773
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3774
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3775
-     */
3776
-    protected function _get_minimum_where_conditions($model_relation_path = null)
3777
-    {
3778
-        if ($this->_ignore_where_strategy) {
3779
-            return array();
3780
-        }
3781
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3782
-    }
3783
-
3784
-
3785
-
3786
-    /**
3787
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3788
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3789
-     *
3790
-     * @param EE_Model_Query_Info_Carrier $model_query_info
3791
-     * @return string
3792
-     * @throws EE_Error
3793
-     */
3794
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3795
-    {
3796
-        $selects = $this->_get_columns_to_select_for_this_model();
3797
-        foreach (
3798
-            $model_query_info->get_model_names_included() as $model_relation_chain =>
3799
-            $name_of_other_model_included
3800
-        ) {
3801
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3802
-            $other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3803
-            foreach ($other_model_selects as $key => $value) {
3804
-                $selects[] = $value;
3805
-            }
3806
-        }
3807
-        return implode(", ", $selects);
3808
-    }
3809
-
3810
-
3811
-
3812
-    /**
3813
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3814
-     * So that's going to be the columns for all the fields on the model
3815
-     *
3816
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
3817
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3818
-     */
3819
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3820
-    {
3821
-        $fields = $this->field_settings();
3822
-        $selects = array();
3823
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3824
-            $this->get_this_model_name());
3825
-        foreach ($fields as $field_obj) {
3826
-            $selects[] = $table_alias_with_model_relation_chain_prefix
3827
-                         . $field_obj->get_table_alias()
3828
-                         . "."
3829
-                         . $field_obj->get_table_column()
3830
-                         . " AS '"
3831
-                         . $table_alias_with_model_relation_chain_prefix
3832
-                         . $field_obj->get_table_alias()
3833
-                         . "."
3834
-                         . $field_obj->get_table_column()
3835
-                         . "'";
3836
-        }
3837
-        //make sure we are also getting the PKs of each table
3838
-        $tables = $this->get_tables();
3839
-        if (count($tables) > 1) {
3840
-            foreach ($tables as $table_obj) {
3841
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3842
-                                       . $table_obj->get_fully_qualified_pk_column();
3843
-                if (! in_array($qualified_pk_column, $selects)) {
3844
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3845
-                }
3846
-            }
3847
-        }
3848
-        return $selects;
3849
-    }
3850
-
3851
-
3852
-
3853
-    /**
3854
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3855
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3856
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3857
-     * SQL for joining, and the data types
3858
-     *
3859
-     * @param null|string                 $original_query_param
3860
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
3861
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3862
-     * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3863
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3864
-     *                                                          column name. We only want model names, eg 'Event.Venue'
3865
-     *                                                          or 'Registration's
3866
-     * @param string                      $original_query_param what it originally was (eg
3867
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3868
-     *                                                          matches $query_param
3869
-     * @throws EE_Error
3870
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3871
-     */
3872
-    private function _extract_related_model_info_from_query_param(
3873
-        $query_param,
3874
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3875
-        $query_param_type,
3876
-        $original_query_param = null
3877
-    ) {
3878
-        if ($original_query_param === null) {
3879
-            $original_query_param = $query_param;
3880
-        }
3881
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3882
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3883
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3884
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3885
-        //check to see if we have a field on this model
3886
-        $this_model_fields = $this->field_settings(true);
3887
-        if (array_key_exists($query_param, $this_model_fields)) {
3888
-            if ($allow_fields) {
3889
-                return;
3890
-            }
3891
-            throw new EE_Error(
3892
-                sprintf(
3893
-                    __(
3894
-                        "Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3895
-                        "event_espresso"
3896
-                    ),
3897
-                    $query_param, get_class($this), $query_param_type, $original_query_param
3898
-                )
3899
-            );
3900
-        }
3901
-        //check if this is a special logic query param
3902
-        if (in_array($query_param, $this->_logic_query_param_keys, true)) {
3903
-            if ($allow_logic_query_params) {
3904
-                return;
3905
-            }
3906
-            throw new EE_Error(
3907
-                sprintf(
3908
-                    __(
3909
-                        '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',
3910
-                        'event_espresso'
3911
-                    ),
3912
-                    implode('", "', $this->_logic_query_param_keys),
3913
-                    $query_param,
3914
-                    get_class($this),
3915
-                    '<br />',
3916
-                    "\t"
3917
-                    . ' $passed_in_query_info = <pre>'
3918
-                    . print_r($passed_in_query_info, true)
3919
-                    . '</pre>'
3920
-                    . "\n\t"
3921
-                    . ' $query_param_type = '
3922
-                    . $query_param_type
3923
-                    . "\n\t"
3924
-                    . ' $original_query_param = '
3925
-                    . $original_query_param
3926
-                )
3927
-            );
3928
-        }
3929
-        //check if it's a custom selection
3930
-        if (array_key_exists($query_param, $this->_custom_selections)) {
3931
-            return;
3932
-        }
3933
-        //check if has a model name at the beginning
3934
-        //and
3935
-        //check if it's a field on a related model
3936
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3937
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3938
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3939
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3940
-                if ($query_param === '') {
3941
-                    //nothing left to $query_param
3942
-                    //we should actually end in a field name, not a model like this!
3943
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3944
-                        "event_espresso"),
3945
-                        $query_param, $query_param_type, get_class($this), $valid_related_model_name));
3946
-                }
3947
-                $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3948
-                $related_model_obj->_extract_related_model_info_from_query_param(
3949
-                    $query_param,
3950
-                    $passed_in_query_info, $query_param_type, $original_query_param
3951
-                );
3952
-                return;
3953
-            }
3954
-            if ($query_param === $valid_related_model_name) {
3955
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3956
-                return;
3957
-            }
3958
-        }
3959
-        //ok so $query_param didn't start with a model name
3960
-        //and we previously confirmed it wasn't a logic query param or field on the current model
3961
-        //it's wack, that's what it is
3962
-        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",
3963
-            "event_espresso"),
3964
-            $query_param, get_class($this), $query_param_type, $original_query_param));
3965
-    }
3966
-
3967
-
3968
-
3969
-    /**
3970
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3971
-     * and store it on $passed_in_query_info
3972
-     *
3973
-     * @param string                      $model_name
3974
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3975
-     * @param string                      $original_query_param used to extract the relation chain between the queried
3976
-     *                                                          model and $model_name. Eg, if we are querying Event,
3977
-     *                                                          and are adding a join to 'Payment' with the original
3978
-     *                                                          query param key
3979
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3980
-     *                                                          to extract 'Registration.Transaction.Payment', in case
3981
-     *                                                          Payment wants to add default query params so that it
3982
-     *                                                          will know what models to prepend onto its default query
3983
-     *                                                          params or in case it wants to rename tables (in case
3984
-     *                                                          there are multiple joins to the same table)
3985
-     * @return void
3986
-     * @throws EE_Error
3987
-     */
3988
-    private function _add_join_to_model(
3989
-        $model_name,
3990
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3991
-        $original_query_param
3992
-    ) {
3993
-        $relation_obj = $this->related_settings_for($model_name);
3994
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3995
-        //check if the relation is HABTM, because then we're essentially doing two joins
3996
-        //If so, join first to the JOIN table, and add its data types, and then continue as normal
3997
-        if ($relation_obj instanceof EE_HABTM_Relation) {
3998
-            $join_model_obj = $relation_obj->get_join_model();
3999
-            //replace the model specified with the join model for this relation chain, whi
4000
-            $relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
4001
-                $join_model_obj->get_this_model_name(), $model_relation_chain);
4002
-            $passed_in_query_info->merge(
4003
-                new EE_Model_Query_Info_Carrier(
4004
-                    array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
4005
-                    $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model)
4006
-                )
4007
-            );
4008
-        }
4009
-        //now just join to the other table pointed to by the relation object, and add its data types
4010
-        $passed_in_query_info->merge(
4011
-            new EE_Model_Query_Info_Carrier(
4012
-                array($model_relation_chain => $model_name),
4013
-                $relation_obj->get_join_statement($model_relation_chain)
4014
-            )
4015
-        );
4016
-    }
4017
-
4018
-
4019
-
4020
-    /**
4021
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
4022
-     *
4023
-     * @param array $where_params like EEM_Base::get_all
4024
-     * @return string of SQL
4025
-     * @throws EE_Error
4026
-     */
4027
-    private function _construct_where_clause($where_params)
4028
-    {
4029
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
4030
-        if ($SQL) {
4031
-            return " WHERE " . $SQL;
4032
-        }
4033
-        return '';
4034
-    }
4035
-
4036
-
4037
-
4038
-    /**
4039
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
4040
-     * and should be passed HAVING parameters, not WHERE parameters
4041
-     *
4042
-     * @param array $having_params
4043
-     * @return string
4044
-     * @throws EE_Error
4045
-     */
4046
-    private function _construct_having_clause($having_params)
4047
-    {
4048
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
4049
-        if ($SQL) {
4050
-            return " HAVING " . $SQL;
4051
-        }
4052
-        return '';
4053
-    }
4054
-
4055
-
4056
-    /**
4057
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
4058
-     * Event_Meta.meta_value = 'foo'))"
4059
-     *
4060
-     * @param array  $where_params see EEM_Base::get_all for documentation
4061
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
4062
-     * @throws EE_Error
4063
-     * @return string of SQL
4064
-     */
4065
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
4066
-    {
4067
-        $where_clauses = array();
4068
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
4069
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
4070
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
4071
-                switch ($query_param) {
4072
-                    case 'not':
4073
-                    case 'NOT':
4074
-                        $where_clauses[] = "! ("
4075
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4076
-                                $glue)
4077
-                                           . ")";
4078
-                        break;
4079
-                    case 'and':
4080
-                    case 'AND':
4081
-                        $where_clauses[] = " ("
4082
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4083
-                                ' AND ')
4084
-                                           . ")";
4085
-                        break;
4086
-                    case 'or':
4087
-                    case 'OR':
4088
-                        $where_clauses[] = " ("
4089
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4090
-                                ' OR ')
4091
-                                           . ")";
4092
-                        break;
4093
-                }
4094
-            } else {
4095
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
4096
-                //if it's not a normal field, maybe it's a custom selection?
4097
-                if (! $field_obj) {
4098
-                    if (isset($this->_custom_selections[$query_param][1])) {
4099
-                        $field_obj = $this->_custom_selections[$query_param][1];
4100
-                    } else {
4101
-                        throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
4102
-                            "event_espresso"), $query_param));
4103
-                    }
4104
-                }
4105
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
4106
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
4107
-            }
4108
-        }
4109
-        return $where_clauses ? implode($glue, $where_clauses) : '';
4110
-    }
4111
-
4112
-
4113
-
4114
-    /**
4115
-     * Takes the input parameter and extract the table name (alias) and column name
4116
-     *
4117
-     * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4118
-     * @throws EE_Error
4119
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4120
-     */
4121
-    private function _deduce_column_name_from_query_param($query_param)
4122
-    {
4123
-        $field = $this->_deduce_field_from_query_param($query_param);
4124
-        if ($field) {
4125
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4126
-                $query_param);
4127
-            return $table_alias_prefix . $field->get_qualified_column();
4128
-        }
4129
-        if (array_key_exists($query_param, $this->_custom_selections)) {
4130
-            //maybe it's custom selection item?
4131
-            //if so, just use it as the "column name"
4132
-            return $query_param;
4133
-        }
4134
-        throw new EE_Error(
4135
-            sprintf(
4136
-                __(
4137
-                    "%s is not a valid field on this model, nor a custom selection (%s)",
4138
-                    "event_espresso"
4139
-                ), $query_param, implode(",", $this->_custom_selections)
4140
-            )
4141
-        );
4142
-    }
4143
-
4144
-
4145
-
4146
-    /**
4147
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4148
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4149
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4150
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4151
-     *
4152
-     * @param string $condition_query_param_key
4153
-     * @return string
4154
-     */
4155
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4156
-    {
4157
-        $pos_of_star = strpos($condition_query_param_key, '*');
4158
-        if ($pos_of_star === false) {
4159
-            return $condition_query_param_key;
4160
-        }
4161
-        $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4162
-        return $condition_query_param_sans_star;
4163
-    }
4164
-
4165
-
4166
-
4167
-    /**
4168
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4169
-     *
4170
-     * @param                            mixed      array | string    $op_and_value
4171
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4172
-     * @throws EE_Error
4173
-     * @return string
4174
-     */
4175
-    private function _construct_op_and_value($op_and_value, $field_obj)
4176
-    {
4177
-        if (is_array($op_and_value)) {
4178
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4179
-            if (! $operator) {
4180
-                $php_array_like_string = array();
4181
-                foreach ($op_and_value as $key => $value) {
4182
-                    $php_array_like_string[] = "$key=>$value";
4183
-                }
4184
-                throw new EE_Error(
4185
-                    sprintf(
4186
-                        __(
4187
-                            "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))",
4188
-                            "event_espresso"
4189
-                        ),
4190
-                        implode(",", $php_array_like_string)
4191
-                    )
4192
-                );
4193
-            }
4194
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4195
-        } else {
4196
-            $operator = '=';
4197
-            $value = $op_and_value;
4198
-        }
4199
-        //check to see if the value is actually another field
4200
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4201
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4202
-        }
4203
-        if (in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
4204
-            //in this case, the value should be an array, or at least a comma-separated list
4205
-            //it will need to handle a little differently
4206
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
4207
-            //note: $cleaned_value has already been run through $wpdb->prepare()
4208
-            return $operator . SP . $cleaned_value;
4209
-        }
4210
-        if (in_array($operator, $this->valid_between_style_operators()) && is_array($value)) {
4211
-            //the value should be an array with count of two.
4212
-            if (count($value) !== 2) {
4213
-                throw new EE_Error(
4214
-                    sprintf(
4215
-                        __(
4216
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4217
-                            'event_espresso'
4218
-                        ),
4219
-                        "BETWEEN"
4220
-                    )
4221
-                );
4222
-            }
4223
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
4224
-            return $operator . SP . $cleaned_value;
4225
-        }
4226
-        if (in_array($operator, $this->valid_null_style_operators())) {
4227
-            if ($value !== null) {
4228
-                throw new EE_Error(
4229
-                    sprintf(
4230
-                        __(
4231
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4232
-                            "event_espresso"
4233
-                        ),
4234
-                        $value,
4235
-                        $operator
4236
-                    )
4237
-                );
4238
-            }
4239
-            return $operator;
4240
-        }
4241
-        if (in_array($operator, $this->valid_like_style_operators()) && ! is_array($value)) {
4242
-            //if the operator is 'LIKE', we want to allow percent signs (%) and not
4243
-            //remove other junk. So just treat it as a string.
4244
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4245
-        }
4246
-        if (! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
4247
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4248
-        }
4249
-        if (in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
4250
-            throw new EE_Error(
4251
-                sprintf(
4252
-                    __(
4253
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4254
-                        'event_espresso'
4255
-                    ),
4256
-                    $operator,
4257
-                    $operator
4258
-                )
4259
-            );
4260
-        }
4261
-        if (! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
4262
-            throw new EE_Error(
4263
-                sprintf(
4264
-                    __(
4265
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4266
-                        'event_espresso'
4267
-                    ),
4268
-                    $operator,
4269
-                    $operator
4270
-                )
4271
-            );
4272
-        }
4273
-        throw new EE_Error(
4274
-            sprintf(
4275
-                __(
4276
-                    "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4277
-                    "event_espresso"
4278
-                ),
4279
-                http_build_query($op_and_value)
4280
-            )
4281
-        );
4282
-    }
4283
-
4284
-
4285
-
4286
-    /**
4287
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4288
-     *
4289
-     * @param array                      $values
4290
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4291
-     *                                              '%s'
4292
-     * @return string
4293
-     * @throws EE_Error
4294
-     */
4295
-    public function _construct_between_value($values, $field_obj)
4296
-    {
4297
-        $cleaned_values = array();
4298
-        foreach ($values as $value) {
4299
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4300
-        }
4301
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4302
-    }
4303
-
4304
-
4305
-
4306
-    /**
4307
-     * Takes an array or a comma-separated list of $values and cleans them
4308
-     * according to $data_type using $wpdb->prepare, and then makes the list a
4309
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4310
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4311
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4312
-     *
4313
-     * @param mixed                      $values    array or comma-separated string
4314
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4315
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4316
-     * @throws EE_Error
4317
-     */
4318
-    public function _construct_in_value($values, $field_obj)
4319
-    {
4320
-        //check if the value is a CSV list
4321
-        if (is_string($values)) {
4322
-            //in which case, turn it into an array
4323
-            $values = explode(",", $values);
4324
-        }
4325
-        $cleaned_values = array();
4326
-        foreach ($values as $value) {
4327
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4328
-        }
4329
-        //we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4330
-        //but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4331
-        //which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4332
-        if (empty($cleaned_values)) {
4333
-            $all_fields = $this->field_settings();
4334
-            $a_field = array_shift($all_fields);
4335
-            $main_table = $this->_get_main_table();
4336
-            $cleaned_values[] = "SELECT "
4337
-                                . $a_field->get_table_column()
4338
-                                . " FROM "
4339
-                                . $main_table->get_table_name()
4340
-                                . " WHERE FALSE";
4341
-        }
4342
-        return "(" . implode(",", $cleaned_values) . ")";
4343
-    }
4344
-
4345
-
4346
-
4347
-    /**
4348
-     * @param mixed                      $value
4349
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4350
-     * @throws EE_Error
4351
-     * @return false|null|string
4352
-     */
4353
-    private function _wpdb_prepare_using_field($value, $field_obj)
4354
-    {
4355
-        /** @type WPDB $wpdb */
4356
-        global $wpdb;
4357
-        if ($field_obj instanceof EE_Model_Field_Base) {
4358
-            return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4359
-                $this->_prepare_value_for_use_in_db($value, $field_obj));
4360
-        } //$field_obj should really just be a data type
4361
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4362
-            throw new EE_Error(
4363
-                sprintf(
4364
-                    __("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4365
-                    $field_obj, implode(",", $this->_valid_wpdb_data_types)
4366
-                )
4367
-            );
4368
-        }
4369
-        return $wpdb->prepare($field_obj, $value);
4370
-    }
4371
-
4372
-
4373
-
4374
-    /**
4375
-     * Takes the input parameter and finds the model field that it indicates.
4376
-     *
4377
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4378
-     * @throws EE_Error
4379
-     * @return EE_Model_Field_Base
4380
-     */
4381
-    protected function _deduce_field_from_query_param($query_param_name)
4382
-    {
4383
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
4384
-        //which will help us find the database table and column
4385
-        $query_param_parts = explode(".", $query_param_name);
4386
-        if (empty($query_param_parts)) {
4387
-            throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4388
-                'event_espresso'), $query_param_name));
4389
-        }
4390
-        $number_of_parts = count($query_param_parts);
4391
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4392
-        if ($number_of_parts === 1) {
4393
-            $field_name = $last_query_param_part;
4394
-            $model_obj = $this;
4395
-        } else {// $number_of_parts >= 2
4396
-            //the last part is the column name, and there are only 2parts. therefore...
4397
-            $field_name = $last_query_param_part;
4398
-            $model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4399
-        }
4400
-        try {
4401
-            return $model_obj->field_settings_for($field_name);
4402
-        } catch (EE_Error $e) {
4403
-            return null;
4404
-        }
4405
-    }
4406
-
4407
-
4408
-
4409
-    /**
4410
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4411
-     * alias and column which corresponds to it
4412
-     *
4413
-     * @param string $field_name
4414
-     * @throws EE_Error
4415
-     * @return string
4416
-     */
4417
-    public function _get_qualified_column_for_field($field_name)
4418
-    {
4419
-        $all_fields = $this->field_settings();
4420
-        $field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4421
-        if ($field) {
4422
-            return $field->get_qualified_column();
4423
-        }
4424
-        throw new EE_Error(
4425
-            sprintf(
4426
-                __(
4427
-                    "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.",
4428
-                    'event_espresso'
4429
-                ), $field_name, get_class($this)
4430
-            )
4431
-        );
4432
-    }
4433
-
4434
-
4435
-
4436
-    /**
4437
-     * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4438
-     * Example usage:
4439
-     * EEM_Ticket::instance()->get_all_wpdb_results(
4440
-     *      array(),
4441
-     *      ARRAY_A,
4442
-     *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4443
-     *  );
4444
-     * is equivalent to
4445
-     *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4446
-     * and
4447
-     *  EEM_Event::instance()->get_all_wpdb_results(
4448
-     *      array(
4449
-     *          array(
4450
-     *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4451
-     *          ),
4452
-     *          ARRAY_A,
4453
-     *          implode(
4454
-     *              ', ',
4455
-     *              array_merge(
4456
-     *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4457
-     *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4458
-     *              )
4459
-     *          )
4460
-     *      )
4461
-     *  );
4462
-     * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4463
-     *
4464
-     * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4465
-     *                                            and the one whose fields you are selecting for example: when querying
4466
-     *                                            tickets model and selecting fields from the tickets model you would
4467
-     *                                            leave this parameter empty, because no models are needed to join
4468
-     *                                            between the queried model and the selected one. Likewise when
4469
-     *                                            querying the datetime model and selecting fields from the tickets
4470
-     *                                            model, it would also be left empty, because there is a direct
4471
-     *                                            relation from datetimes to tickets, so no model is needed to join
4472
-     *                                            them together. However, when querying from the event model and
4473
-     *                                            selecting fields from the ticket model, you should provide the string
4474
-     *                                            'Datetime', indicating that the event model must first join to the
4475
-     *                                            datetime model in order to find its relation to ticket model.
4476
-     *                                            Also, when querying from the venue model and selecting fields from
4477
-     *                                            the ticket model, you should provide the string 'Event.Datetime',
4478
-     *                                            indicating you need to join the venue model to the event model,
4479
-     *                                            to the datetime model, in order to find its relation to the ticket model.
4480
-     *                                            This string is used to deduce the prefix that gets added onto the
4481
-     *                                            models' tables qualified columns
4482
-     * @param bool   $return_string               if true, will return a string with qualified column names separated
4483
-     *                                            by ', ' if false, will simply return a numerically indexed array of
4484
-     *                                            qualified column names
4485
-     * @return array|string
4486
-     */
4487
-    public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4488
-    {
4489
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4490
-        $qualified_columns = array();
4491
-        foreach ($this->field_settings() as $field_name => $field) {
4492
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4493
-        }
4494
-        return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4495
-    }
4496
-
4497
-
4498
-
4499
-    /**
4500
-     * constructs the select use on special limit joins
4501
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4502
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
4503
-     * (as that is typically where the limits would be set).
4504
-     *
4505
-     * @param  string       $table_alias The table the select is being built for
4506
-     * @param  mixed|string $limit       The limit for this select
4507
-     * @return string                The final select join element for the query.
4508
-     */
4509
-    public function _construct_limit_join_select($table_alias, $limit)
4510
-    {
4511
-        $SQL = '';
4512
-        foreach ($this->_tables as $table_obj) {
4513
-            if ($table_obj instanceof EE_Primary_Table) {
4514
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4515
-                    ? $table_obj->get_select_join_limit($limit)
4516
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4517
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
4518
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4519
-                    ? $table_obj->get_select_join_limit_join($limit)
4520
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4521
-            }
4522
-        }
4523
-        return $SQL;
4524
-    }
4525
-
4526
-
4527
-
4528
-    /**
4529
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4530
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4531
-     *
4532
-     * @return string SQL
4533
-     * @throws EE_Error
4534
-     */
4535
-    public function _construct_internal_join()
4536
-    {
4537
-        $SQL = $this->_get_main_table()->get_table_sql();
4538
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4539
-        return $SQL;
4540
-    }
4541
-
4542
-
4543
-
4544
-    /**
4545
-     * Constructs the SQL for joining all the tables on this model.
4546
-     * Normally $alias should be the primary table's alias, but in cases where
4547
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4548
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4549
-     * alias, this will construct SQL like:
4550
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4551
-     * With $alias being a secondary table's alias, this will construct SQL like:
4552
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4553
-     *
4554
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4555
-     * @return string
4556
-     */
4557
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4558
-    {
4559
-        $SQL = '';
4560
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4561
-        foreach ($this->_tables as $table_obj) {
4562
-            if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4563
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4564
-                    //so we're joining to this table, meaning the table is already in
4565
-                    //the FROM statement, BUT the primary table isn't. So we want
4566
-                    //to add the inverse join sql
4567
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4568
-                } else {
4569
-                    //just add a regular JOIN to this table from the primary table
4570
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
4571
-                }
4572
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4573
-        }
4574
-        return $SQL;
4575
-    }
4576
-
4577
-
4578
-
4579
-    /**
4580
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
4581
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4582
-     * their data type (eg, '%s', '%d', etc)
4583
-     *
4584
-     * @return array
4585
-     */
4586
-    public function _get_data_types()
4587
-    {
4588
-        $data_types = array();
4589
-        foreach ($this->field_settings() as $field_obj) {
4590
-            //$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4591
-            /** @var $field_obj EE_Model_Field_Base */
4592
-            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4593
-        }
4594
-        return $data_types;
4595
-    }
4596
-
4597
-
4598
-
4599
-    /**
4600
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4601
-     *
4602
-     * @param string $model_name
4603
-     * @throws EE_Error
4604
-     * @return EEM_Base
4605
-     */
4606
-    public function get_related_model_obj($model_name)
4607
-    {
4608
-        $model_classname = "EEM_" . $model_name;
4609
-        if (! class_exists($model_classname)) {
4610
-            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",
4611
-                'event_espresso'), $model_name, $model_classname));
4612
-        }
4613
-        return call_user_func($model_classname . "::instance");
4614
-    }
4615
-
4616
-
4617
-
4618
-    /**
4619
-     * Returns the array of EE_ModelRelations for this model.
4620
-     *
4621
-     * @return EE_Model_Relation_Base[]
4622
-     */
4623
-    public function relation_settings()
4624
-    {
4625
-        return $this->_model_relations;
4626
-    }
4627
-
4628
-
4629
-
4630
-    /**
4631
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
4632
-     * because without THOSE models, this model probably doesn't have much purpose.
4633
-     * (Eg, without an event, datetimes have little purpose.)
4634
-     *
4635
-     * @return EE_Belongs_To_Relation[]
4636
-     */
4637
-    public function belongs_to_relations()
4638
-    {
4639
-        $belongs_to_relations = array();
4640
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
4641
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
4642
-                $belongs_to_relations[$model_name] = $relation_obj;
4643
-            }
4644
-        }
4645
-        return $belongs_to_relations;
4646
-    }
4647
-
4648
-
4649
-
4650
-    /**
4651
-     * Returns the specified EE_Model_Relation, or throws an exception
4652
-     *
4653
-     * @param string $relation_name name of relation, key in $this->_relatedModels
4654
-     * @throws EE_Error
4655
-     * @return EE_Model_Relation_Base
4656
-     */
4657
-    public function related_settings_for($relation_name)
4658
-    {
4659
-        $relatedModels = $this->relation_settings();
4660
-        if (! array_key_exists($relation_name, $relatedModels)) {
4661
-            throw new EE_Error(
4662
-                sprintf(
4663
-                    __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4664
-                        'event_espresso'),
4665
-                    $relation_name,
4666
-                    $this->_get_class_name(),
4667
-                    implode(', ', array_keys($relatedModels))
4668
-                )
4669
-            );
4670
-        }
4671
-        return $relatedModels[$relation_name];
4672
-    }
4673
-
4674
-
4675
-
4676
-    /**
4677
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4678
-     * fields
4679
-     *
4680
-     * @param string $fieldName
4681
-     * @param boolean $include_db_only_fields
4682
-     * @throws EE_Error
4683
-     * @return EE_Model_Field_Base
4684
-     */
4685
-    public function field_settings_for($fieldName, $include_db_only_fields = true)
4686
-    {
4687
-        $fieldSettings = $this->field_settings($include_db_only_fields);
4688
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4689
-            throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4690
-                get_class($this)));
4691
-        }
4692
-        return $fieldSettings[$fieldName];
4693
-    }
4694
-
4695
-
4696
-
4697
-    /**
4698
-     * Checks if this field exists on this model
4699
-     *
4700
-     * @param string $fieldName a key in the model's _field_settings array
4701
-     * @return boolean
4702
-     */
4703
-    public function has_field($fieldName)
4704
-    {
4705
-        $fieldSettings = $this->field_settings(true);
4706
-        if (isset($fieldSettings[$fieldName])) {
4707
-            return true;
4708
-        }
4709
-        return false;
4710
-    }
4711
-
4712
-
4713
-
4714
-    /**
4715
-     * Returns whether or not this model has a relation to the specified model
4716
-     *
4717
-     * @param string $relation_name possibly one of the keys in the relation_settings array
4718
-     * @return boolean
4719
-     */
4720
-    public function has_relation($relation_name)
4721
-    {
4722
-        $relations = $this->relation_settings();
4723
-        if (isset($relations[$relation_name])) {
4724
-            return true;
4725
-        }
4726
-        return false;
4727
-    }
4728
-
4729
-
4730
-
4731
-    /**
4732
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4733
-     * Eg, on EE_Answer that would be ANS_ID field object
4734
-     *
4735
-     * @param $field_obj
4736
-     * @return boolean
4737
-     */
4738
-    public function is_primary_key_field($field_obj)
4739
-    {
4740
-        return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4741
-    }
4742
-
4743
-
4744
-
4745
-    /**
4746
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4747
-     * Eg, on EE_Answer that would be ANS_ID field object
4748
-     *
4749
-     * @return EE_Model_Field_Base
4750
-     * @throws EE_Error
4751
-     */
4752
-    public function get_primary_key_field()
4753
-    {
4754
-        if ($this->_primary_key_field === null) {
4755
-            foreach ($this->field_settings(true) as $field_obj) {
4756
-                if ($this->is_primary_key_field($field_obj)) {
4757
-                    $this->_primary_key_field = $field_obj;
4758
-                    break;
4759
-                }
4760
-            }
4761
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4762
-                throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4763
-                    get_class($this)));
4764
-            }
4765
-        }
4766
-        return $this->_primary_key_field;
4767
-    }
4768
-
4769
-
4770
-
4771
-    /**
4772
-     * Returns whether or not not there is a primary key on this model.
4773
-     * Internally does some caching.
4774
-     *
4775
-     * @return boolean
4776
-     */
4777
-    public function has_primary_key_field()
4778
-    {
4779
-        if ($this->_has_primary_key_field === null) {
4780
-            try {
4781
-                $this->get_primary_key_field();
4782
-                $this->_has_primary_key_field = true;
4783
-            } catch (EE_Error $e) {
4784
-                $this->_has_primary_key_field = false;
4785
-            }
4786
-        }
4787
-        return $this->_has_primary_key_field;
4788
-    }
4789
-
4790
-
4791
-
4792
-    /**
4793
-     * Finds the first field of type $field_class_name.
4794
-     *
4795
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4796
-     *                                 EE_Foreign_Key_Field, etc
4797
-     * @return EE_Model_Field_Base or null if none is found
4798
-     */
4799
-    public function get_a_field_of_type($field_class_name)
4800
-    {
4801
-        foreach ($this->field_settings() as $field) {
4802
-            if ($field instanceof $field_class_name) {
4803
-                return $field;
4804
-            }
4805
-        }
4806
-        return null;
4807
-    }
4808
-
4809
-
4810
-
4811
-    /**
4812
-     * Gets a foreign key field pointing to model.
4813
-     *
4814
-     * @param string $model_name eg Event, Registration, not EEM_Event
4815
-     * @return EE_Foreign_Key_Field_Base
4816
-     * @throws EE_Error
4817
-     */
4818
-    public function get_foreign_key_to($model_name)
4819
-    {
4820
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4821
-            foreach ($this->field_settings() as $field) {
4822
-                if (
4823
-                    $field instanceof EE_Foreign_Key_Field_Base
4824
-                    && in_array($model_name, $field->get_model_names_pointed_to())
4825
-                ) {
4826
-                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
4827
-                    break;
4828
-                }
4829
-            }
4830
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4831
-                throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4832
-                    'event_espresso'), $model_name, get_class($this)));
4833
-            }
4834
-        }
4835
-        return $this->_cache_foreign_key_to_fields[$model_name];
4836
-    }
4837
-
4838
-
4839
-
4840
-    /**
4841
-     * Gets the table name (including $wpdb->prefix) for the table alias
4842
-     *
4843
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4844
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4845
-     *                            Either one works
4846
-     * @return string
4847
-     */
4848
-    public function get_table_for_alias($table_alias)
4849
-    {
4850
-        $table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4851
-        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4852
-    }
4853
-
4854
-
4855
-
4856
-    /**
4857
-     * Returns a flat array of all field son this model, instead of organizing them
4858
-     * by table_alias as they are in the constructor.
4859
-     *
4860
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4861
-     * @return EE_Model_Field_Base[] where the keys are the field's name
4862
-     */
4863
-    public function field_settings($include_db_only_fields = false)
4864
-    {
4865
-        if ($include_db_only_fields) {
4866
-            if ($this->_cached_fields === null) {
4867
-                $this->_cached_fields = array();
4868
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4869
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4870
-                        $this->_cached_fields[$field_name] = $field_obj;
4871
-                    }
4872
-                }
4873
-            }
4874
-            return $this->_cached_fields;
4875
-        }
4876
-        if ($this->_cached_fields_non_db_only === null) {
4877
-            $this->_cached_fields_non_db_only = array();
4878
-            foreach ($this->_fields as $fields_corresponding_to_table) {
4879
-                foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4880
-                    /** @var $field_obj EE_Model_Field_Base */
4881
-                    if (! $field_obj->is_db_only_field()) {
4882
-                        $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4883
-                    }
4884
-                }
4885
-            }
4886
-        }
4887
-        return $this->_cached_fields_non_db_only;
4888
-    }
4889
-
4890
-
4891
-
4892
-    /**
4893
-     *        cycle though array of attendees and create objects out of each item
4894
-     *
4895
-     * @access        private
4896
-     * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4897
-     * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4898
-     *                           numerically indexed)
4899
-     * @throws EE_Error
4900
-     */
4901
-    protected function _create_objects($rows = array())
4902
-    {
4903
-        $array_of_objects = array();
4904
-        if (empty($rows)) {
4905
-            return array();
4906
-        }
4907
-        $count_if_model_has_no_primary_key = 0;
4908
-        $has_primary_key = $this->has_primary_key_field();
4909
-        $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4910
-        foreach ((array)$rows as $row) {
4911
-            if (empty($row)) {
4912
-                //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4913
-                return array();
4914
-            }
4915
-            //check if we've already set this object in the results array,
4916
-            //in which case there's no need to process it further (again)
4917
-            if ($has_primary_key) {
4918
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4919
-                    $row,
4920
-                    $primary_key_field->get_qualified_column(),
4921
-                    $primary_key_field->get_table_column()
4922
-                );
4923
-                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4924
-                    continue;
4925
-                }
4926
-            }
4927
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
4928
-            if (! $classInstance) {
4929
-                throw new EE_Error(
4930
-                    sprintf(
4931
-                        __('Could not create instance of class %s from row %s', 'event_espresso'),
4932
-                        $this->get_this_model_name(),
4933
-                        http_build_query($row)
4934
-                    )
4935
-                );
4936
-            }
4937
-            //set the timezone on the instantiated objects
4938
-            $classInstance->set_timezone($this->_timezone);
4939
-            //make sure if there is any timezone setting present that we set the timezone for the object
4940
-            $key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4941
-            $array_of_objects[$key] = $classInstance;
4942
-            //also, for all the relations of type BelongsTo, see if we can cache
4943
-            //those related models
4944
-            //(we could do this for other relations too, but if there are conditions
4945
-            //that filtered out some fo the results, then we'd be caching an incomplete set
4946
-            //so it requires a little more thought than just caching them immediately...)
4947
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
4948
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
4949
-                    //check if this model's INFO is present. If so, cache it on the model
4950
-                    $other_model = $relation_obj->get_other_model();
4951
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4952
-                    //if we managed to make a model object from the results, cache it on the main model object
4953
-                    if ($other_model_obj_maybe) {
4954
-                        //set timezone on these other model objects if they are present
4955
-                        $other_model_obj_maybe->set_timezone($this->_timezone);
4956
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
4957
-                    }
4958
-                }
4959
-            }
4960
-        }
4961
-        return $array_of_objects;
4962
-    }
4963
-
4964
-
4965
-
4966
-    /**
4967
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4968
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4969
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4970
-     * object (as set in the model_field!).
4971
-     *
4972
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4973
-     */
4974
-    public function create_default_object()
4975
-    {
4976
-        $this_model_fields_and_values = array();
4977
-        //setup the row using default values;
4978
-        foreach ($this->field_settings() as $field_name => $field_obj) {
4979
-            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4980
-        }
4981
-        $className = $this->_get_class_name();
4982
-        $classInstance = EE_Registry::instance()
4983
-                                    ->load_class($className, array($this_model_fields_and_values), false, false);
4984
-        return $classInstance;
4985
-    }
4986
-
4987
-
4988
-
4989
-    /**
4990
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4991
-     *                             or an stdClass where each property is the name of a column,
4992
-     * @return EE_Base_Class
4993
-     * @throws EE_Error
4994
-     */
4995
-    public function instantiate_class_from_array_or_object($cols_n_values)
4996
-    {
4997
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4998
-            $cols_n_values = get_object_vars($cols_n_values);
4999
-        }
5000
-        $primary_key = null;
5001
-        //make sure the array only has keys that are fields/columns on this model
5002
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5003
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
5004
-            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
5005
-        }
5006
-        $className = $this->_get_class_name();
5007
-        //check we actually found results that we can use to build our model object
5008
-        //if not, return null
5009
-        if ($this->has_primary_key_field()) {
5010
-            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
5011
-                return null;
5012
-            }
5013
-        } else if ($this->unique_indexes()) {
5014
-            $first_column = reset($this_model_fields_n_values);
5015
-            if (empty($first_column)) {
5016
-                return null;
5017
-            }
5018
-        }
5019
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
5020
-        if ($primary_key) {
5021
-            $classInstance = $this->get_from_entity_map($primary_key);
5022
-            if (! $classInstance) {
5023
-                $classInstance = EE_Registry::instance()
5024
-                                            ->load_class($className,
5025
-                                                array($this_model_fields_n_values, $this->_timezone), true, false);
5026
-                // add this new object to the entity map
5027
-                $classInstance = $this->add_to_entity_map($classInstance);
5028
-            }
5029
-        } else {
5030
-            $classInstance = EE_Registry::instance()
5031
-                                        ->load_class($className, array($this_model_fields_n_values, $this->_timezone),
5032
-                                            true, false);
5033
-        }
5034
-        return $classInstance;
5035
-    }
5036
-
5037
-
5038
-
5039
-    /**
5040
-     * Gets the model object from the  entity map if it exists
5041
-     *
5042
-     * @param int|string $id the ID of the model object
5043
-     * @return EE_Base_Class
5044
-     */
5045
-    public function get_from_entity_map($id)
5046
-    {
5047
-        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
5048
-            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
5049
-    }
5050
-
5051
-
5052
-
5053
-    /**
5054
-     * add_to_entity_map
5055
-     * Adds the object to the model's entity mappings
5056
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
5057
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
5058
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
5059
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
5060
-     *        then this method should be called immediately after the update query
5061
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
5062
-     * so on multisite, the entity map is specific to the query being done for a specific site.
5063
-     *
5064
-     * @param    EE_Base_Class $object
5065
-     * @throws EE_Error
5066
-     * @return \EE_Base_Class
5067
-     */
5068
-    public function add_to_entity_map(EE_Base_Class $object)
5069
-    {
5070
-        $className = $this->_get_class_name();
5071
-        if (! $object instanceof $className) {
5072
-            throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
5073
-                is_object($object) ? get_class($object) : $object, $className));
5074
-        }
5075
-        /** @var $object EE_Base_Class */
5076
-        if (! $object->ID()) {
5077
-            throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
5078
-                "event_espresso"), get_class($this)));
5079
-        }
5080
-        // double check it's not already there
5081
-        $classInstance = $this->get_from_entity_map($object->ID());
5082
-        if ($classInstance) {
5083
-            return $classInstance;
5084
-        }
5085
-        $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
5086
-        return $object;
5087
-    }
5088
-
5089
-
5090
-
5091
-    /**
5092
-     * if a valid identifier is provided, then that entity is unset from the entity map,
5093
-     * if no identifier is provided, then the entire entity map is emptied
5094
-     *
5095
-     * @param int|string $id the ID of the model object
5096
-     * @return boolean
5097
-     */
5098
-    public function clear_entity_map($id = null)
5099
-    {
5100
-        if (empty($id)) {
5101
-            $this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
5102
-            return true;
5103
-        }
5104
-        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
5105
-            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
5106
-            return true;
5107
-        }
5108
-        return false;
5109
-    }
5110
-
5111
-
5112
-
5113
-    /**
5114
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
5115
-     * Given an array where keys are column (or column alias) names and values,
5116
-     * returns an array of their corresponding field names and database values
5117
-     *
5118
-     * @param array $cols_n_values
5119
-     * @return array
5120
-     */
5121
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
5122
-    {
5123
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5124
-    }
5125
-
5126
-
5127
-
5128
-    /**
5129
-     * _deduce_fields_n_values_from_cols_n_values
5130
-     * Given an array where keys are column (or column alias) names and values,
5131
-     * returns an array of their corresponding field names and database values
5132
-     *
5133
-     * @param string $cols_n_values
5134
-     * @return array
5135
-     */
5136
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5137
-    {
5138
-        $this_model_fields_n_values = array();
5139
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
5140
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5141
-                $table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5142
-            //there is a primary key on this table and its not set. Use defaults for all its columns
5143
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
5144
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5145
-                    if (! $field_obj->is_db_only_field()) {
5146
-                        //prepare field as if its coming from db
5147
-                        $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5148
-                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5149
-                    }
5150
-                }
5151
-            } else {
5152
-                //the table's rows existed. Use their values
5153
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5154
-                    if (! $field_obj->is_db_only_field()) {
5155
-                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5156
-                            $cols_n_values, $field_obj->get_qualified_column(),
5157
-                            $field_obj->get_table_column()
5158
-                        );
5159
-                    }
5160
-                }
5161
-            }
5162
-        }
5163
-        return $this_model_fields_n_values;
5164
-    }
5165
-
5166
-
5167
-
5168
-    /**
5169
-     * @param $cols_n_values
5170
-     * @param $qualified_column
5171
-     * @param $regular_column
5172
-     * @return null
5173
-     */
5174
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5175
-    {
5176
-        $value = null;
5177
-        //ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5178
-        //does the field on the model relate to this column retrieved from the db?
5179
-        //or is it a db-only field? (not relating to the model)
5180
-        if (isset($cols_n_values[$qualified_column])) {
5181
-            $value = $cols_n_values[$qualified_column];
5182
-        } elseif (isset($cols_n_values[$regular_column])) {
5183
-            $value = $cols_n_values[$regular_column];
5184
-        }
5185
-        return $value;
5186
-    }
5187
-
5188
-
5189
-
5190
-    /**
5191
-     * refresh_entity_map_from_db
5192
-     * Makes sure the model object in the entity map at $id assumes the values
5193
-     * of the database (opposite of EE_base_Class::save())
5194
-     *
5195
-     * @param int|string $id
5196
-     * @return EE_Base_Class
5197
-     * @throws EE_Error
5198
-     */
5199
-    public function refresh_entity_map_from_db($id)
5200
-    {
5201
-        $obj_in_map = $this->get_from_entity_map($id);
5202
-        if ($obj_in_map) {
5203
-            $wpdb_results = $this->_get_all_wpdb_results(
5204
-                array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5205
-            );
5206
-            if ($wpdb_results && is_array($wpdb_results)) {
5207
-                $one_row = reset($wpdb_results);
5208
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5209
-                    $obj_in_map->set_from_db($field_name, $db_value);
5210
-                }
5211
-                //clear the cache of related model objects
5212
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5213
-                    $obj_in_map->clear_cache($relation_name, null, true);
5214
-                }
5215
-            }
5216
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5217
-            return $obj_in_map;
5218
-        }
5219
-        return $this->get_one_by_ID($id);
5220
-    }
5221
-
5222
-
5223
-
5224
-    /**
5225
-     * refresh_entity_map_with
5226
-     * Leaves the entry in the entity map alone, but updates it to match the provided
5227
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5228
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5229
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5230
-     *
5231
-     * @param int|string    $id
5232
-     * @param EE_Base_Class $replacing_model_obj
5233
-     * @return \EE_Base_Class
5234
-     * @throws EE_Error
5235
-     */
5236
-    public function refresh_entity_map_with($id, $replacing_model_obj)
5237
-    {
5238
-        $obj_in_map = $this->get_from_entity_map($id);
5239
-        if ($obj_in_map) {
5240
-            if ($replacing_model_obj instanceof EE_Base_Class) {
5241
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5242
-                    $obj_in_map->set($field_name, $value);
5243
-                }
5244
-                //make the model object in the entity map's cache match the $replacing_model_obj
5245
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5246
-                    $obj_in_map->clear_cache($relation_name, null, true);
5247
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5248
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5249
-                    }
5250
-                }
5251
-            }
5252
-            return $obj_in_map;
5253
-        }
5254
-        $this->add_to_entity_map($replacing_model_obj);
5255
-        return $replacing_model_obj;
5256
-    }
5257
-
5258
-
5259
-
5260
-    /**
5261
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5262
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5263
-     * require_once($this->_getClassName().".class.php");
5264
-     *
5265
-     * @return string
5266
-     */
5267
-    private function _get_class_name()
5268
-    {
5269
-        return "EE_" . $this->get_this_model_name();
5270
-    }
5271
-
5272
-
5273
-
5274
-    /**
5275
-     * Get the name of the items this model represents, for the quantity specified. Eg,
5276
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5277
-     * it would be 'Events'.
5278
-     *
5279
-     * @param int $quantity
5280
-     * @return string
5281
-     */
5282
-    public function item_name($quantity = 1)
5283
-    {
5284
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5285
-    }
5286
-
5287
-
5288
-
5289
-    /**
5290
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5291
-     * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5292
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5293
-     * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5294
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5295
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5296
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
5297
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
5298
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5299
-     * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5300
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5301
-     *        return $previousReturnValue.$returnString;
5302
-     * }
5303
-     * require('EEM_Answer.model.php');
5304
-     * $answer=EEM_Answer::instance();
5305
-     * echo $answer->my_callback('monkeys',100);
5306
-     * //will output "you called my_callback! and passed args:monkeys,100"
5307
-     *
5308
-     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5309
-     * @param array  $args       array of original arguments passed to the function
5310
-     * @throws EE_Error
5311
-     * @return mixed whatever the plugin which calls add_filter decides
5312
-     */
5313
-    public function __call($methodName, $args)
5314
-    {
5315
-        $className = get_class($this);
5316
-        $tagName = "FHEE__{$className}__{$methodName}";
5317
-        if (! has_filter($tagName)) {
5318
-            throw new EE_Error(
5319
-                sprintf(
5320
-                    __('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 );',
5321
-                        'event_espresso'),
5322
-                    $methodName,
5323
-                    $className,
5324
-                    $tagName,
5325
-                    '<br />'
5326
-                )
5327
-            );
5328
-        }
5329
-        return apply_filters($tagName, null, $this, $args);
5330
-    }
5331
-
5332
-
5333
-
5334
-    /**
5335
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5336
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5337
-     *
5338
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5339
-     *                                                       the EE_Base_Class object that corresponds to this Model,
5340
-     *                                                       the object's class name
5341
-     *                                                       or object's ID
5342
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5343
-     *                                                       exists in the database. If it does not, we add it
5344
-     * @throws EE_Error
5345
-     * @return EE_Base_Class
5346
-     */
5347
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5348
-    {
5349
-        $className = $this->_get_class_name();
5350
-        if ($base_class_obj_or_id instanceof $className) {
5351
-            $model_object = $base_class_obj_or_id;
5352
-        } else {
5353
-            $primary_key_field = $this->get_primary_key_field();
5354
-            if (
5355
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
5356
-                && (
5357
-                    is_int($base_class_obj_or_id)
5358
-                    || is_string($base_class_obj_or_id)
5359
-                )
5360
-            ) {
5361
-                // assume it's an ID.
5362
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
5363
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5364
-            } else if (
5365
-                $primary_key_field instanceof EE_Primary_Key_String_Field
5366
-                && is_string($base_class_obj_or_id)
5367
-            ) {
5368
-                // assume its a string representation of the object
5369
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5370
-            } else {
5371
-                throw new EE_Error(
5372
-                    sprintf(
5373
-                        __(
5374
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5375
-                            'event_espresso'
5376
-                        ),
5377
-                        $base_class_obj_or_id,
5378
-                        $this->_get_class_name(),
5379
-                        print_r($base_class_obj_or_id, true)
5380
-                    )
5381
-                );
5382
-            }
5383
-        }
5384
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
5385
-            $model_object->save();
5386
-        }
5387
-        return $model_object;
5388
-    }
5389
-
5390
-
5391
-
5392
-    /**
5393
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5394
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
5395
-     * returns it ID.
5396
-     *
5397
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
5398
-     * @return int|string depending on the type of this model object's ID
5399
-     * @throws EE_Error
5400
-     */
5401
-    public function ensure_is_ID($base_class_obj_or_id)
5402
-    {
5403
-        $className = $this->_get_class_name();
5404
-        if ($base_class_obj_or_id instanceof $className) {
5405
-            /** @var $base_class_obj_or_id EE_Base_Class */
5406
-            $id = $base_class_obj_or_id->ID();
5407
-        } elseif (is_int($base_class_obj_or_id)) {
5408
-            //assume it's an ID
5409
-            $id = $base_class_obj_or_id;
5410
-        } elseif (is_string($base_class_obj_or_id)) {
5411
-            //assume its a string representation of the object
5412
-            $id = $base_class_obj_or_id;
5413
-        } else {
5414
-            throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5415
-                'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5416
-                print_r($base_class_obj_or_id, true)));
5417
-        }
5418
-        return $id;
5419
-    }
5420
-
5421
-
5422
-
5423
-    /**
5424
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5425
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5426
-     * been sanitized and converted into the appropriate domain.
5427
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5428
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5429
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5430
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5431
-     * $EVT = EEM_Event::instance(); $old_setting =
5432
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5433
-     * $EVT->assume_values_already_prepared_by_model_object(true);
5434
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5435
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5436
-     *
5437
-     * @param int $values_already_prepared like one of the constants on EEM_Base
5438
-     * @return void
5439
-     */
5440
-    public function assume_values_already_prepared_by_model_object(
5441
-        $values_already_prepared = self::not_prepared_by_model_object
5442
-    ) {
5443
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
5444
-    }
5445
-
5446
-
5447
-
5448
-    /**
5449
-     * Read comments for assume_values_already_prepared_by_model_object()
5450
-     *
5451
-     * @return int
5452
-     */
5453
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
5454
-    {
5455
-        return $this->_values_already_prepared_by_model_object;
5456
-    }
5457
-
5458
-
5459
-
5460
-    /**
5461
-     * Gets all the indexes on this model
5462
-     *
5463
-     * @return EE_Index[]
5464
-     */
5465
-    public function indexes()
5466
-    {
5467
-        return $this->_indexes;
5468
-    }
5469
-
5470
-
5471
-
5472
-    /**
5473
-     * Gets all the Unique Indexes on this model
5474
-     *
5475
-     * @return EE_Unique_Index[]
5476
-     */
5477
-    public function unique_indexes()
5478
-    {
5479
-        $unique_indexes = array();
5480
-        foreach ($this->_indexes as $name => $index) {
5481
-            if ($index instanceof EE_Unique_Index) {
5482
-                $unique_indexes [$name] = $index;
5483
-            }
5484
-        }
5485
-        return $unique_indexes;
5486
-    }
5487
-
5488
-
5489
-
5490
-    /**
5491
-     * Gets all the fields which, when combined, make the primary key.
5492
-     * This is usually just an array with 1 element (the primary key), but in cases
5493
-     * where there is no primary key, it's a combination of fields as defined
5494
-     * on a primary index
5495
-     *
5496
-     * @return EE_Model_Field_Base[] indexed by the field's name
5497
-     * @throws EE_Error
5498
-     */
5499
-    public function get_combined_primary_key_fields()
5500
-    {
5501
-        foreach ($this->indexes() as $index) {
5502
-            if ($index instanceof EE_Primary_Key_Index) {
5503
-                return $index->fields();
5504
-            }
5505
-        }
5506
-        return array($this->primary_key_name() => $this->get_primary_key_field());
5507
-    }
5508
-
5509
-
5510
-
5511
-    /**
5512
-     * Used to build a primary key string (when the model has no primary key),
5513
-     * which can be used a unique string to identify this model object.
5514
-     *
5515
-     * @param array $cols_n_values keys are field names, values are their values
5516
-     * @return string
5517
-     * @throws EE_Error
5518
-     */
5519
-    public function get_index_primary_key_string($cols_n_values)
5520
-    {
5521
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5522
-            $this->get_combined_primary_key_fields());
5523
-        return http_build_query($cols_n_values_for_primary_key_index);
5524
-    }
5525
-
5526
-
5527
-
5528
-    /**
5529
-     * Gets the field values from the primary key string
5530
-     *
5531
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5532
-     * @param string $index_primary_key_string
5533
-     * @return null|array
5534
-     * @throws EE_Error
5535
-     */
5536
-    public function parse_index_primary_key_string($index_primary_key_string)
5537
-    {
5538
-        $key_fields = $this->get_combined_primary_key_fields();
5539
-        //check all of them are in the $id
5540
-        $key_vals_in_combined_pk = array();
5541
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5542
-        foreach ($key_fields as $key_field_name => $field_obj) {
5543
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5544
-                return null;
5545
-            }
5546
-        }
5547
-        return $key_vals_in_combined_pk;
5548
-    }
5549
-
5550
-
5551
-
5552
-    /**
5553
-     * verifies that an array of key-value pairs for model fields has a key
5554
-     * for each field comprising the primary key index
5555
-     *
5556
-     * @param array $key_vals
5557
-     * @return boolean
5558
-     * @throws EE_Error
5559
-     */
5560
-    public function has_all_combined_primary_key_fields($key_vals)
5561
-    {
5562
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5563
-        foreach ($keys_it_should_have as $key) {
5564
-            if (! isset($key_vals[$key])) {
5565
-                return false;
5566
-            }
5567
-        }
5568
-        return true;
5569
-    }
5570
-
5571
-
5572
-
5573
-    /**
5574
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5575
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
5576
-     *
5577
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5578
-     * @param array               $query_params                     like EEM_Base::get_all's query_params.
5579
-     * @throws EE_Error
5580
-     * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5581
-     *                                                              indexed)
5582
-     */
5583
-    public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5584
-    {
5585
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5586
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
5587
-        } elseif (is_array($model_object_or_attributes_array)) {
5588
-            $attributes_array = $model_object_or_attributes_array;
5589
-        } else {
5590
-            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",
5591
-                "event_espresso"), $model_object_or_attributes_array));
5592
-        }
5593
-        //even copies obviously won't have the same ID, so remove the primary key
5594
-        //from the WHERE conditions for finding copies (if there is a primary key, of course)
5595
-        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5596
-            unset($attributes_array[$this->primary_key_name()]);
5597
-        }
5598
-        if (isset($query_params[0])) {
5599
-            $query_params[0] = array_merge($attributes_array, $query_params);
5600
-        } else {
5601
-            $query_params[0] = $attributes_array;
5602
-        }
5603
-        return $this->get_all($query_params);
5604
-    }
5605
-
5606
-
5607
-
5608
-    /**
5609
-     * Gets the first copy we find. See get_all_copies for more details
5610
-     *
5611
-     * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5612
-     * @param array $query_params
5613
-     * @return EE_Base_Class
5614
-     * @throws EE_Error
5615
-     */
5616
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5617
-    {
5618
-        if (! is_array($query_params)) {
5619
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5620
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5621
-                    gettype($query_params)), '4.6.0');
5622
-            $query_params = array();
5623
-        }
5624
-        $query_params['limit'] = 1;
5625
-        $copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5626
-        if (is_array($copies)) {
5627
-            return array_shift($copies);
5628
-        }
5629
-        return null;
5630
-    }
5631
-
5632
-
5633
-
5634
-    /**
5635
-     * Updates the item with the specified id. Ignores default query parameters because
5636
-     * we have specified the ID, and its assumed we KNOW what we're doing
5637
-     *
5638
-     * @param array      $fields_n_values keys are field names, values are their new values
5639
-     * @param int|string $id              the value of the primary key to update
5640
-     * @return int number of rows updated
5641
-     * @throws EE_Error
5642
-     */
5643
-    public function update_by_ID($fields_n_values, $id)
5644
-    {
5645
-        $query_params = array(
5646
-            0                          => array($this->get_primary_key_field()->get_name() => $id),
5647
-            'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5648
-        );
5649
-        return $this->update($fields_n_values, $query_params);
5650
-    }
5651
-
5652
-
5653
-
5654
-    /**
5655
-     * Changes an operator which was supplied to the models into one usable in SQL
5656
-     *
5657
-     * @param string $operator_supplied
5658
-     * @return string an operator which can be used in SQL
5659
-     * @throws EE_Error
5660
-     */
5661
-    private function _prepare_operator_for_sql($operator_supplied)
5662
-    {
5663
-        $sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5664
-            : null;
5665
-        if ($sql_operator) {
5666
-            return $sql_operator;
5667
-        }
5668
-        throw new EE_Error(
5669
-            sprintf(
5670
-                __(
5671
-                    "The operator '%s' is not in the list of valid operators: %s",
5672
-                    "event_espresso"
5673
-                ), $operator_supplied, implode(",", array_keys($this->_valid_operators))
5674
-            )
5675
-        );
5676
-    }
5677
-
5678
-
5679
-
5680
-    /**
5681
-     * Gets the valid operators
5682
-     * @return array keys are accepted strings, values are the SQL they are converted to
5683
-     */
5684
-    public function valid_operators(){
5685
-        return $this->_valid_operators;
5686
-    }
5687
-
5688
-
5689
-
5690
-    /**
5691
-     * Gets the between-style operators (take 2 arguments).
5692
-     * @return array keys are accepted strings, values are the SQL they are converted to
5693
-     */
5694
-    public function valid_between_style_operators()
5695
-    {
5696
-        return array_intersect(
5697
-            $this->valid_operators(),
5698
-            $this->_between_style_operators
5699
-        );
5700
-    }
5701
-
5702
-    /**
5703
-     * Gets the "like"-style operators (take a single argument, but it may contain wildcards)
5704
-     * @return array keys are accepted strings, values are the SQL they are converted to
5705
-     */
5706
-    public function valid_like_style_operators()
5707
-    {
5708
-        return array_intersect(
5709
-            $this->valid_operators(),
5710
-            $this->_like_style_operators
5711
-        );
5712
-    }
5713
-
5714
-    /**
5715
-     * Gets the "in"-style operators
5716
-     * @return array keys are accepted strings, values are the SQL they are converted to
5717
-     */
5718
-    public function valid_in_style_operators()
5719
-    {
5720
-        return array_intersect(
5721
-            $this->valid_operators(),
5722
-            $this->_in_style_operators
5723
-        );
5724
-    }
5725
-
5726
-    /**
5727
-     * Gets the "null"-style operators (accept no arguments)
5728
-     * @return array keys are accepted strings, values are the SQL they are converted to
5729
-     */
5730
-    public function valid_null_style_operators()
5731
-    {
5732
-        return array_intersect(
5733
-            $this->valid_operators(),
5734
-            $this->_null_style_operators
5735
-        );
5736
-    }
5737
-
5738
-    /**
5739
-     * Gets an array where keys are the primary keys and values are their 'names'
5740
-     * (as determined by the model object's name() function, which is often overridden)
5741
-     *
5742
-     * @param array $query_params like get_all's
5743
-     * @return string[]
5744
-     * @throws EE_Error
5745
-     */
5746
-    public function get_all_names($query_params = array())
5747
-    {
5748
-        $objs = $this->get_all($query_params);
5749
-        $names = array();
5750
-        foreach ($objs as $obj) {
5751
-            $names[$obj->ID()] = $obj->name();
5752
-        }
5753
-        return $names;
5754
-    }
5755
-
5756
-
5757
-
5758
-    /**
5759
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
5760
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5761
-     * this is duplicated effort and reduces efficiency) you would be better to use
5762
-     * array_keys() on $model_objects.
5763
-     *
5764
-     * @param \EE_Base_Class[] $model_objects
5765
-     * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5766
-     *                                               in the returned array
5767
-     * @return array
5768
-     * @throws EE_Error
5769
-     */
5770
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
5771
-    {
5772
-        if (! $this->has_primary_key_field()) {
5773
-            if (WP_DEBUG) {
5774
-                EE_Error::add_error(
5775
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5776
-                    __FILE__,
5777
-                    __FUNCTION__,
5778
-                    __LINE__
5779
-                );
5780
-            }
5781
-        }
5782
-        $IDs = array();
5783
-        foreach ($model_objects as $model_object) {
5784
-            $id = $model_object->ID();
5785
-            if (! $id) {
5786
-                if ($filter_out_empty_ids) {
5787
-                    continue;
5788
-                }
5789
-                if (WP_DEBUG) {
5790
-                    EE_Error::add_error(
5791
-                        __(
5792
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5793
-                            'event_espresso'
5794
-                        ),
5795
-                        __FILE__,
5796
-                        __FUNCTION__,
5797
-                        __LINE__
5798
-                    );
5799
-                }
5800
-            }
5801
-            $IDs[] = $id;
5802
-        }
5803
-        return $IDs;
5804
-    }
5805
-
5806
-
5807
-
5808
-    /**
5809
-     * Returns the string used in capabilities relating to this model. If there
5810
-     * are no capabilities that relate to this model returns false
5811
-     *
5812
-     * @return string|false
5813
-     */
5814
-    public function cap_slug()
5815
-    {
5816
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5817
-    }
5818
-
5819
-
5820
-
5821
-    /**
5822
-     * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5823
-     * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5824
-     * only returns the cap restrictions array in that context (ie, the array
5825
-     * at that key)
5826
-     *
5827
-     * @param string $context
5828
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
5829
-     * @throws EE_Error
5830
-     */
5831
-    public function cap_restrictions($context = EEM_Base::caps_read)
5832
-    {
5833
-        EEM_Base::verify_is_valid_cap_context($context);
5834
-        //check if we ought to run the restriction generator first
5835
-        if (
5836
-            isset($this->_cap_restriction_generators[$context])
5837
-            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5838
-            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5839
-        ) {
5840
-            $this->_cap_restrictions[$context] = array_merge(
5841
-                $this->_cap_restrictions[$context],
5842
-                $this->_cap_restriction_generators[$context]->generate_restrictions()
5843
-            );
5844
-        }
5845
-        //and make sure we've finalized the construction of each restriction
5846
-        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5847
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5848
-                $where_conditions_obj->_finalize_construct($this);
5849
-            }
5850
-        }
5851
-        return $this->_cap_restrictions[$context];
5852
-    }
5853
-
5854
-
5855
-
5856
-    /**
5857
-     * Indicating whether or not this model thinks its a wp core model
5858
-     *
5859
-     * @return boolean
5860
-     */
5861
-    public function is_wp_core_model()
5862
-    {
5863
-        return $this->_wp_core_model;
5864
-    }
5865
-
5866
-
5867
-
5868
-    /**
5869
-     * Gets all the caps that are missing which impose a restriction on
5870
-     * queries made in this context
5871
-     *
5872
-     * @param string $context one of EEM_Base::caps_ constants
5873
-     * @return EE_Default_Where_Conditions[] indexed by capability name
5874
-     * @throws EE_Error
5875
-     */
5876
-    public function caps_missing($context = EEM_Base::caps_read)
5877
-    {
5878
-        $missing_caps = array();
5879
-        $cap_restrictions = $this->cap_restrictions($context);
5880
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5881
-            if (! EE_Capabilities::instance()
5882
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5883
-            ) {
5884
-                $missing_caps[$cap] = $restriction_if_no_cap;
5885
-            }
5886
-        }
5887
-        return $missing_caps;
5888
-    }
5889
-
5890
-
5891
-
5892
-    /**
5893
-     * Gets the mapping from capability contexts to action strings used in capability names
5894
-     *
5895
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5896
-     * one of 'read', 'edit', or 'delete'
5897
-     */
5898
-    public function cap_contexts_to_cap_action_map()
5899
-    {
5900
-        return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5901
-            $this);
5902
-    }
5903
-
5904
-
5905
-
5906
-    /**
5907
-     * Gets the action string for the specified capability context
5908
-     *
5909
-     * @param string $context
5910
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5911
-     * @throws EE_Error
5912
-     */
5913
-    public function cap_action_for_context($context)
5914
-    {
5915
-        $mapping = $this->cap_contexts_to_cap_action_map();
5916
-        if (isset($mapping[$context])) {
5917
-            return $mapping[$context];
5918
-        }
5919
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5920
-            return $action;
5921
-        }
5922
-        throw new EE_Error(
5923
-            sprintf(
5924
-                __('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5925
-                $context,
5926
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5927
-            )
5928
-        );
5929
-    }
5930
-
5931
-
5932
-
5933
-    /**
5934
-     * Returns all the capability contexts which are valid when querying models
5935
-     *
5936
-     * @return array
5937
-     */
5938
-    public static function valid_cap_contexts()
5939
-    {
5940
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5941
-            self::caps_read,
5942
-            self::caps_read_admin,
5943
-            self::caps_edit,
5944
-            self::caps_delete,
5945
-        ));
5946
-    }
5947
-
5948
-
5949
-
5950
-    /**
5951
-     * Returns all valid options for 'default_where_conditions'
5952
-     *
5953
-     * @return array
5954
-     */
5955
-    public static function valid_default_where_conditions()
5956
-    {
5957
-        return array(
5958
-            EEM_Base::default_where_conditions_all,
5959
-            EEM_Base::default_where_conditions_this_only,
5960
-            EEM_Base::default_where_conditions_others_only,
5961
-            EEM_Base::default_where_conditions_minimum_all,
5962
-            EEM_Base::default_where_conditions_minimum_others,
5963
-            EEM_Base::default_where_conditions_none
5964
-        );
5965
-    }
5966
-
5967
-    // public static function default_where_conditions_full
5968
-    /**
5969
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5970
-     *
5971
-     * @param string $context
5972
-     * @return bool
5973
-     * @throws EE_Error
5974
-     */
5975
-    static public function verify_is_valid_cap_context($context)
5976
-    {
5977
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
5978
-        if (in_array($context, $valid_cap_contexts)) {
5979
-            return true;
5980
-        }
5981
-        throw new EE_Error(
5982
-            sprintf(
5983
-                __(
5984
-                    'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5985
-                    'event_espresso'
5986
-                ),
5987
-                $context,
5988
-                'EEM_Base',
5989
-                implode(',', $valid_cap_contexts)
5990
-            )
5991
-        );
5992
-    }
5993
-
5994
-
5995
-
5996
-    /**
5997
-     * Clears all the models field caches. This is only useful when a sub-class
5998
-     * might have added a field or something and these caches might be invalidated
5999
-     */
6000
-    protected function _invalidate_field_caches()
6001
-    {
6002
-        $this->_cache_foreign_key_to_fields = array();
6003
-        $this->_cached_fields = null;
6004
-        $this->_cached_fields_non_db_only = null;
6005
-    }
6006
-
6007
-
6008
-
6009
-    /**
6010
-     * Gets the list of all the where query param keys that relate to logic instead of field names
6011
-     * (eg "and", "or", "not").
6012
-     *
6013
-     * @return array
6014
-     */
6015
-    public function logic_query_param_keys()
6016
-    {
6017
-        return $this->_logic_query_param_keys;
6018
-    }
6019
-
6020
-
6021
-
6022
-    /**
6023
-     * Determines whether or not the where query param array key is for a logic query param.
6024
-     * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
6025
-     * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
6026
-     *
6027
-     * @param $query_param_key
6028
-     * @return bool
6029
-     */
6030
-    public function is_logic_query_param_key($query_param_key)
6031
-    {
6032
-        foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
6033
-            if ($query_param_key === $logic_query_param_key
6034
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
6035
-            ) {
6036
-                return true;
6037
-            }
6038
-        }
6039
-        return false;
6040
-    }
3741
+		}
3742
+		return $null_friendly_where_conditions;
3743
+	}
3744
+
3745
+
3746
+
3747
+	/**
3748
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
3749
+	 * default where conditions on all get_all, update, and delete queries done by this model.
3750
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3751
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3752
+	 *
3753
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3754
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3755
+	 */
3756
+	private function _get_default_where_conditions($model_relation_path = null)
3757
+	{
3758
+		if ($this->_ignore_where_strategy) {
3759
+			return array();
3760
+		}
3761
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3762
+	}
3763
+
3764
+
3765
+
3766
+	/**
3767
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
3768
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
3769
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3770
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3771
+	 * Similar to _get_default_where_conditions
3772
+	 *
3773
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3774
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3775
+	 */
3776
+	protected function _get_minimum_where_conditions($model_relation_path = null)
3777
+	{
3778
+		if ($this->_ignore_where_strategy) {
3779
+			return array();
3780
+		}
3781
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3782
+	}
3783
+
3784
+
3785
+
3786
+	/**
3787
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3788
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3789
+	 *
3790
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
3791
+	 * @return string
3792
+	 * @throws EE_Error
3793
+	 */
3794
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3795
+	{
3796
+		$selects = $this->_get_columns_to_select_for_this_model();
3797
+		foreach (
3798
+			$model_query_info->get_model_names_included() as $model_relation_chain =>
3799
+			$name_of_other_model_included
3800
+		) {
3801
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3802
+			$other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3803
+			foreach ($other_model_selects as $key => $value) {
3804
+				$selects[] = $value;
3805
+			}
3806
+		}
3807
+		return implode(", ", $selects);
3808
+	}
3809
+
3810
+
3811
+
3812
+	/**
3813
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3814
+	 * So that's going to be the columns for all the fields on the model
3815
+	 *
3816
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
3817
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3818
+	 */
3819
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3820
+	{
3821
+		$fields = $this->field_settings();
3822
+		$selects = array();
3823
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3824
+			$this->get_this_model_name());
3825
+		foreach ($fields as $field_obj) {
3826
+			$selects[] = $table_alias_with_model_relation_chain_prefix
3827
+						 . $field_obj->get_table_alias()
3828
+						 . "."
3829
+						 . $field_obj->get_table_column()
3830
+						 . " AS '"
3831
+						 . $table_alias_with_model_relation_chain_prefix
3832
+						 . $field_obj->get_table_alias()
3833
+						 . "."
3834
+						 . $field_obj->get_table_column()
3835
+						 . "'";
3836
+		}
3837
+		//make sure we are also getting the PKs of each table
3838
+		$tables = $this->get_tables();
3839
+		if (count($tables) > 1) {
3840
+			foreach ($tables as $table_obj) {
3841
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3842
+									   . $table_obj->get_fully_qualified_pk_column();
3843
+				if (! in_array($qualified_pk_column, $selects)) {
3844
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3845
+				}
3846
+			}
3847
+		}
3848
+		return $selects;
3849
+	}
3850
+
3851
+
3852
+
3853
+	/**
3854
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3855
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3856
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3857
+	 * SQL for joining, and the data types
3858
+	 *
3859
+	 * @param null|string                 $original_query_param
3860
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
3861
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3862
+	 * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3863
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3864
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
3865
+	 *                                                          or 'Registration's
3866
+	 * @param string                      $original_query_param what it originally was (eg
3867
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3868
+	 *                                                          matches $query_param
3869
+	 * @throws EE_Error
3870
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3871
+	 */
3872
+	private function _extract_related_model_info_from_query_param(
3873
+		$query_param,
3874
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3875
+		$query_param_type,
3876
+		$original_query_param = null
3877
+	) {
3878
+		if ($original_query_param === null) {
3879
+			$original_query_param = $query_param;
3880
+		}
3881
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3882
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3883
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3884
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3885
+		//check to see if we have a field on this model
3886
+		$this_model_fields = $this->field_settings(true);
3887
+		if (array_key_exists($query_param, $this_model_fields)) {
3888
+			if ($allow_fields) {
3889
+				return;
3890
+			}
3891
+			throw new EE_Error(
3892
+				sprintf(
3893
+					__(
3894
+						"Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3895
+						"event_espresso"
3896
+					),
3897
+					$query_param, get_class($this), $query_param_type, $original_query_param
3898
+				)
3899
+			);
3900
+		}
3901
+		//check if this is a special logic query param
3902
+		if (in_array($query_param, $this->_logic_query_param_keys, true)) {
3903
+			if ($allow_logic_query_params) {
3904
+				return;
3905
+			}
3906
+			throw new EE_Error(
3907
+				sprintf(
3908
+					__(
3909
+						'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',
3910
+						'event_espresso'
3911
+					),
3912
+					implode('", "', $this->_logic_query_param_keys),
3913
+					$query_param,
3914
+					get_class($this),
3915
+					'<br />',
3916
+					"\t"
3917
+					. ' $passed_in_query_info = <pre>'
3918
+					. print_r($passed_in_query_info, true)
3919
+					. '</pre>'
3920
+					. "\n\t"
3921
+					. ' $query_param_type = '
3922
+					. $query_param_type
3923
+					. "\n\t"
3924
+					. ' $original_query_param = '
3925
+					. $original_query_param
3926
+				)
3927
+			);
3928
+		}
3929
+		//check if it's a custom selection
3930
+		if (array_key_exists($query_param, $this->_custom_selections)) {
3931
+			return;
3932
+		}
3933
+		//check if has a model name at the beginning
3934
+		//and
3935
+		//check if it's a field on a related model
3936
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3937
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3938
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3939
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
3940
+				if ($query_param === '') {
3941
+					//nothing left to $query_param
3942
+					//we should actually end in a field name, not a model like this!
3943
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3944
+						"event_espresso"),
3945
+						$query_param, $query_param_type, get_class($this), $valid_related_model_name));
3946
+				}
3947
+				$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3948
+				$related_model_obj->_extract_related_model_info_from_query_param(
3949
+					$query_param,
3950
+					$passed_in_query_info, $query_param_type, $original_query_param
3951
+				);
3952
+				return;
3953
+			}
3954
+			if ($query_param === $valid_related_model_name) {
3955
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3956
+				return;
3957
+			}
3958
+		}
3959
+		//ok so $query_param didn't start with a model name
3960
+		//and we previously confirmed it wasn't a logic query param or field on the current model
3961
+		//it's wack, that's what it is
3962
+		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",
3963
+			"event_espresso"),
3964
+			$query_param, get_class($this), $query_param_type, $original_query_param));
3965
+	}
3966
+
3967
+
3968
+
3969
+	/**
3970
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3971
+	 * and store it on $passed_in_query_info
3972
+	 *
3973
+	 * @param string                      $model_name
3974
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3975
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
3976
+	 *                                                          model and $model_name. Eg, if we are querying Event,
3977
+	 *                                                          and are adding a join to 'Payment' with the original
3978
+	 *                                                          query param key
3979
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3980
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
3981
+	 *                                                          Payment wants to add default query params so that it
3982
+	 *                                                          will know what models to prepend onto its default query
3983
+	 *                                                          params or in case it wants to rename tables (in case
3984
+	 *                                                          there are multiple joins to the same table)
3985
+	 * @return void
3986
+	 * @throws EE_Error
3987
+	 */
3988
+	private function _add_join_to_model(
3989
+		$model_name,
3990
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3991
+		$original_query_param
3992
+	) {
3993
+		$relation_obj = $this->related_settings_for($model_name);
3994
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3995
+		//check if the relation is HABTM, because then we're essentially doing two joins
3996
+		//If so, join first to the JOIN table, and add its data types, and then continue as normal
3997
+		if ($relation_obj instanceof EE_HABTM_Relation) {
3998
+			$join_model_obj = $relation_obj->get_join_model();
3999
+			//replace the model specified with the join model for this relation chain, whi
4000
+			$relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
4001
+				$join_model_obj->get_this_model_name(), $model_relation_chain);
4002
+			$passed_in_query_info->merge(
4003
+				new EE_Model_Query_Info_Carrier(
4004
+					array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
4005
+					$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model)
4006
+				)
4007
+			);
4008
+		}
4009
+		//now just join to the other table pointed to by the relation object, and add its data types
4010
+		$passed_in_query_info->merge(
4011
+			new EE_Model_Query_Info_Carrier(
4012
+				array($model_relation_chain => $model_name),
4013
+				$relation_obj->get_join_statement($model_relation_chain)
4014
+			)
4015
+		);
4016
+	}
4017
+
4018
+
4019
+
4020
+	/**
4021
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
4022
+	 *
4023
+	 * @param array $where_params like EEM_Base::get_all
4024
+	 * @return string of SQL
4025
+	 * @throws EE_Error
4026
+	 */
4027
+	private function _construct_where_clause($where_params)
4028
+	{
4029
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
4030
+		if ($SQL) {
4031
+			return " WHERE " . $SQL;
4032
+		}
4033
+		return '';
4034
+	}
4035
+
4036
+
4037
+
4038
+	/**
4039
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
4040
+	 * and should be passed HAVING parameters, not WHERE parameters
4041
+	 *
4042
+	 * @param array $having_params
4043
+	 * @return string
4044
+	 * @throws EE_Error
4045
+	 */
4046
+	private function _construct_having_clause($having_params)
4047
+	{
4048
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
4049
+		if ($SQL) {
4050
+			return " HAVING " . $SQL;
4051
+		}
4052
+		return '';
4053
+	}
4054
+
4055
+
4056
+	/**
4057
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
4058
+	 * Event_Meta.meta_value = 'foo'))"
4059
+	 *
4060
+	 * @param array  $where_params see EEM_Base::get_all for documentation
4061
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
4062
+	 * @throws EE_Error
4063
+	 * @return string of SQL
4064
+	 */
4065
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
4066
+	{
4067
+		$where_clauses = array();
4068
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
4069
+			$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
4070
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
4071
+				switch ($query_param) {
4072
+					case 'not':
4073
+					case 'NOT':
4074
+						$where_clauses[] = "! ("
4075
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4076
+								$glue)
4077
+										   . ")";
4078
+						break;
4079
+					case 'and':
4080
+					case 'AND':
4081
+						$where_clauses[] = " ("
4082
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4083
+								' AND ')
4084
+										   . ")";
4085
+						break;
4086
+					case 'or':
4087
+					case 'OR':
4088
+						$where_clauses[] = " ("
4089
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4090
+								' OR ')
4091
+										   . ")";
4092
+						break;
4093
+				}
4094
+			} else {
4095
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
4096
+				//if it's not a normal field, maybe it's a custom selection?
4097
+				if (! $field_obj) {
4098
+					if (isset($this->_custom_selections[$query_param][1])) {
4099
+						$field_obj = $this->_custom_selections[$query_param][1];
4100
+					} else {
4101
+						throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
4102
+							"event_espresso"), $query_param));
4103
+					}
4104
+				}
4105
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
4106
+				$where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
4107
+			}
4108
+		}
4109
+		return $where_clauses ? implode($glue, $where_clauses) : '';
4110
+	}
4111
+
4112
+
4113
+
4114
+	/**
4115
+	 * Takes the input parameter and extract the table name (alias) and column name
4116
+	 *
4117
+	 * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4118
+	 * @throws EE_Error
4119
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4120
+	 */
4121
+	private function _deduce_column_name_from_query_param($query_param)
4122
+	{
4123
+		$field = $this->_deduce_field_from_query_param($query_param);
4124
+		if ($field) {
4125
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4126
+				$query_param);
4127
+			return $table_alias_prefix . $field->get_qualified_column();
4128
+		}
4129
+		if (array_key_exists($query_param, $this->_custom_selections)) {
4130
+			//maybe it's custom selection item?
4131
+			//if so, just use it as the "column name"
4132
+			return $query_param;
4133
+		}
4134
+		throw new EE_Error(
4135
+			sprintf(
4136
+				__(
4137
+					"%s is not a valid field on this model, nor a custom selection (%s)",
4138
+					"event_espresso"
4139
+				), $query_param, implode(",", $this->_custom_selections)
4140
+			)
4141
+		);
4142
+	}
4143
+
4144
+
4145
+
4146
+	/**
4147
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4148
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4149
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4150
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4151
+	 *
4152
+	 * @param string $condition_query_param_key
4153
+	 * @return string
4154
+	 */
4155
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4156
+	{
4157
+		$pos_of_star = strpos($condition_query_param_key, '*');
4158
+		if ($pos_of_star === false) {
4159
+			return $condition_query_param_key;
4160
+		}
4161
+		$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4162
+		return $condition_query_param_sans_star;
4163
+	}
4164
+
4165
+
4166
+
4167
+	/**
4168
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4169
+	 *
4170
+	 * @param                            mixed      array | string    $op_and_value
4171
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4172
+	 * @throws EE_Error
4173
+	 * @return string
4174
+	 */
4175
+	private function _construct_op_and_value($op_and_value, $field_obj)
4176
+	{
4177
+		if (is_array($op_and_value)) {
4178
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4179
+			if (! $operator) {
4180
+				$php_array_like_string = array();
4181
+				foreach ($op_and_value as $key => $value) {
4182
+					$php_array_like_string[] = "$key=>$value";
4183
+				}
4184
+				throw new EE_Error(
4185
+					sprintf(
4186
+						__(
4187
+							"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))",
4188
+							"event_espresso"
4189
+						),
4190
+						implode(",", $php_array_like_string)
4191
+					)
4192
+				);
4193
+			}
4194
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4195
+		} else {
4196
+			$operator = '=';
4197
+			$value = $op_and_value;
4198
+		}
4199
+		//check to see if the value is actually another field
4200
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4201
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4202
+		}
4203
+		if (in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
4204
+			//in this case, the value should be an array, or at least a comma-separated list
4205
+			//it will need to handle a little differently
4206
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
4207
+			//note: $cleaned_value has already been run through $wpdb->prepare()
4208
+			return $operator . SP . $cleaned_value;
4209
+		}
4210
+		if (in_array($operator, $this->valid_between_style_operators()) && is_array($value)) {
4211
+			//the value should be an array with count of two.
4212
+			if (count($value) !== 2) {
4213
+				throw new EE_Error(
4214
+					sprintf(
4215
+						__(
4216
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4217
+							'event_espresso'
4218
+						),
4219
+						"BETWEEN"
4220
+					)
4221
+				);
4222
+			}
4223
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
4224
+			return $operator . SP . $cleaned_value;
4225
+		}
4226
+		if (in_array($operator, $this->valid_null_style_operators())) {
4227
+			if ($value !== null) {
4228
+				throw new EE_Error(
4229
+					sprintf(
4230
+						__(
4231
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4232
+							"event_espresso"
4233
+						),
4234
+						$value,
4235
+						$operator
4236
+					)
4237
+				);
4238
+			}
4239
+			return $operator;
4240
+		}
4241
+		if (in_array($operator, $this->valid_like_style_operators()) && ! is_array($value)) {
4242
+			//if the operator is 'LIKE', we want to allow percent signs (%) and not
4243
+			//remove other junk. So just treat it as a string.
4244
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4245
+		}
4246
+		if (! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
4247
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4248
+		}
4249
+		if (in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
4250
+			throw new EE_Error(
4251
+				sprintf(
4252
+					__(
4253
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4254
+						'event_espresso'
4255
+					),
4256
+					$operator,
4257
+					$operator
4258
+				)
4259
+			);
4260
+		}
4261
+		if (! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
4262
+			throw new EE_Error(
4263
+				sprintf(
4264
+					__(
4265
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4266
+						'event_espresso'
4267
+					),
4268
+					$operator,
4269
+					$operator
4270
+				)
4271
+			);
4272
+		}
4273
+		throw new EE_Error(
4274
+			sprintf(
4275
+				__(
4276
+					"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4277
+					"event_espresso"
4278
+				),
4279
+				http_build_query($op_and_value)
4280
+			)
4281
+		);
4282
+	}
4283
+
4284
+
4285
+
4286
+	/**
4287
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4288
+	 *
4289
+	 * @param array                      $values
4290
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4291
+	 *                                              '%s'
4292
+	 * @return string
4293
+	 * @throws EE_Error
4294
+	 */
4295
+	public function _construct_between_value($values, $field_obj)
4296
+	{
4297
+		$cleaned_values = array();
4298
+		foreach ($values as $value) {
4299
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4300
+		}
4301
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
4302
+	}
4303
+
4304
+
4305
+
4306
+	/**
4307
+	 * Takes an array or a comma-separated list of $values and cleans them
4308
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
4309
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4310
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4311
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4312
+	 *
4313
+	 * @param mixed                      $values    array or comma-separated string
4314
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4315
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4316
+	 * @throws EE_Error
4317
+	 */
4318
+	public function _construct_in_value($values, $field_obj)
4319
+	{
4320
+		//check if the value is a CSV list
4321
+		if (is_string($values)) {
4322
+			//in which case, turn it into an array
4323
+			$values = explode(",", $values);
4324
+		}
4325
+		$cleaned_values = array();
4326
+		foreach ($values as $value) {
4327
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4328
+		}
4329
+		//we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4330
+		//but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4331
+		//which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4332
+		if (empty($cleaned_values)) {
4333
+			$all_fields = $this->field_settings();
4334
+			$a_field = array_shift($all_fields);
4335
+			$main_table = $this->_get_main_table();
4336
+			$cleaned_values[] = "SELECT "
4337
+								. $a_field->get_table_column()
4338
+								. " FROM "
4339
+								. $main_table->get_table_name()
4340
+								. " WHERE FALSE";
4341
+		}
4342
+		return "(" . implode(",", $cleaned_values) . ")";
4343
+	}
4344
+
4345
+
4346
+
4347
+	/**
4348
+	 * @param mixed                      $value
4349
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4350
+	 * @throws EE_Error
4351
+	 * @return false|null|string
4352
+	 */
4353
+	private function _wpdb_prepare_using_field($value, $field_obj)
4354
+	{
4355
+		/** @type WPDB $wpdb */
4356
+		global $wpdb;
4357
+		if ($field_obj instanceof EE_Model_Field_Base) {
4358
+			return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4359
+				$this->_prepare_value_for_use_in_db($value, $field_obj));
4360
+		} //$field_obj should really just be a data type
4361
+		if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4362
+			throw new EE_Error(
4363
+				sprintf(
4364
+					__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4365
+					$field_obj, implode(",", $this->_valid_wpdb_data_types)
4366
+				)
4367
+			);
4368
+		}
4369
+		return $wpdb->prepare($field_obj, $value);
4370
+	}
4371
+
4372
+
4373
+
4374
+	/**
4375
+	 * Takes the input parameter and finds the model field that it indicates.
4376
+	 *
4377
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4378
+	 * @throws EE_Error
4379
+	 * @return EE_Model_Field_Base
4380
+	 */
4381
+	protected function _deduce_field_from_query_param($query_param_name)
4382
+	{
4383
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
4384
+		//which will help us find the database table and column
4385
+		$query_param_parts = explode(".", $query_param_name);
4386
+		if (empty($query_param_parts)) {
4387
+			throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4388
+				'event_espresso'), $query_param_name));
4389
+		}
4390
+		$number_of_parts = count($query_param_parts);
4391
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4392
+		if ($number_of_parts === 1) {
4393
+			$field_name = $last_query_param_part;
4394
+			$model_obj = $this;
4395
+		} else {// $number_of_parts >= 2
4396
+			//the last part is the column name, and there are only 2parts. therefore...
4397
+			$field_name = $last_query_param_part;
4398
+			$model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4399
+		}
4400
+		try {
4401
+			return $model_obj->field_settings_for($field_name);
4402
+		} catch (EE_Error $e) {
4403
+			return null;
4404
+		}
4405
+	}
4406
+
4407
+
4408
+
4409
+	/**
4410
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4411
+	 * alias and column which corresponds to it
4412
+	 *
4413
+	 * @param string $field_name
4414
+	 * @throws EE_Error
4415
+	 * @return string
4416
+	 */
4417
+	public function _get_qualified_column_for_field($field_name)
4418
+	{
4419
+		$all_fields = $this->field_settings();
4420
+		$field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4421
+		if ($field) {
4422
+			return $field->get_qualified_column();
4423
+		}
4424
+		throw new EE_Error(
4425
+			sprintf(
4426
+				__(
4427
+					"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.",
4428
+					'event_espresso'
4429
+				), $field_name, get_class($this)
4430
+			)
4431
+		);
4432
+	}
4433
+
4434
+
4435
+
4436
+	/**
4437
+	 * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4438
+	 * Example usage:
4439
+	 * EEM_Ticket::instance()->get_all_wpdb_results(
4440
+	 *      array(),
4441
+	 *      ARRAY_A,
4442
+	 *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4443
+	 *  );
4444
+	 * is equivalent to
4445
+	 *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4446
+	 * and
4447
+	 *  EEM_Event::instance()->get_all_wpdb_results(
4448
+	 *      array(
4449
+	 *          array(
4450
+	 *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4451
+	 *          ),
4452
+	 *          ARRAY_A,
4453
+	 *          implode(
4454
+	 *              ', ',
4455
+	 *              array_merge(
4456
+	 *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4457
+	 *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4458
+	 *              )
4459
+	 *          )
4460
+	 *      )
4461
+	 *  );
4462
+	 * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4463
+	 *
4464
+	 * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4465
+	 *                                            and the one whose fields you are selecting for example: when querying
4466
+	 *                                            tickets model and selecting fields from the tickets model you would
4467
+	 *                                            leave this parameter empty, because no models are needed to join
4468
+	 *                                            between the queried model and the selected one. Likewise when
4469
+	 *                                            querying the datetime model and selecting fields from the tickets
4470
+	 *                                            model, it would also be left empty, because there is a direct
4471
+	 *                                            relation from datetimes to tickets, so no model is needed to join
4472
+	 *                                            them together. However, when querying from the event model and
4473
+	 *                                            selecting fields from the ticket model, you should provide the string
4474
+	 *                                            'Datetime', indicating that the event model must first join to the
4475
+	 *                                            datetime model in order to find its relation to ticket model.
4476
+	 *                                            Also, when querying from the venue model and selecting fields from
4477
+	 *                                            the ticket model, you should provide the string 'Event.Datetime',
4478
+	 *                                            indicating you need to join the venue model to the event model,
4479
+	 *                                            to the datetime model, in order to find its relation to the ticket model.
4480
+	 *                                            This string is used to deduce the prefix that gets added onto the
4481
+	 *                                            models' tables qualified columns
4482
+	 * @param bool   $return_string               if true, will return a string with qualified column names separated
4483
+	 *                                            by ', ' if false, will simply return a numerically indexed array of
4484
+	 *                                            qualified column names
4485
+	 * @return array|string
4486
+	 */
4487
+	public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4488
+	{
4489
+		$table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4490
+		$qualified_columns = array();
4491
+		foreach ($this->field_settings() as $field_name => $field) {
4492
+			$qualified_columns[] = $table_prefix . $field->get_qualified_column();
4493
+		}
4494
+		return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4495
+	}
4496
+
4497
+
4498
+
4499
+	/**
4500
+	 * constructs the select use on special limit joins
4501
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4502
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
4503
+	 * (as that is typically where the limits would be set).
4504
+	 *
4505
+	 * @param  string       $table_alias The table the select is being built for
4506
+	 * @param  mixed|string $limit       The limit for this select
4507
+	 * @return string                The final select join element for the query.
4508
+	 */
4509
+	public function _construct_limit_join_select($table_alias, $limit)
4510
+	{
4511
+		$SQL = '';
4512
+		foreach ($this->_tables as $table_obj) {
4513
+			if ($table_obj instanceof EE_Primary_Table) {
4514
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4515
+					? $table_obj->get_select_join_limit($limit)
4516
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4517
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
4518
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4519
+					? $table_obj->get_select_join_limit_join($limit)
4520
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
4521
+			}
4522
+		}
4523
+		return $SQL;
4524
+	}
4525
+
4526
+
4527
+
4528
+	/**
4529
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4530
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4531
+	 *
4532
+	 * @return string SQL
4533
+	 * @throws EE_Error
4534
+	 */
4535
+	public function _construct_internal_join()
4536
+	{
4537
+		$SQL = $this->_get_main_table()->get_table_sql();
4538
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4539
+		return $SQL;
4540
+	}
4541
+
4542
+
4543
+
4544
+	/**
4545
+	 * Constructs the SQL for joining all the tables on this model.
4546
+	 * Normally $alias should be the primary table's alias, but in cases where
4547
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4548
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4549
+	 * alias, this will construct SQL like:
4550
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4551
+	 * With $alias being a secondary table's alias, this will construct SQL like:
4552
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4553
+	 *
4554
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4555
+	 * @return string
4556
+	 */
4557
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4558
+	{
4559
+		$SQL = '';
4560
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4561
+		foreach ($this->_tables as $table_obj) {
4562
+			if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4563
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4564
+					//so we're joining to this table, meaning the table is already in
4565
+					//the FROM statement, BUT the primary table isn't. So we want
4566
+					//to add the inverse join sql
4567
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4568
+				} else {
4569
+					//just add a regular JOIN to this table from the primary table
4570
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
4571
+				}
4572
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4573
+		}
4574
+		return $SQL;
4575
+	}
4576
+
4577
+
4578
+
4579
+	/**
4580
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
4581
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4582
+	 * their data type (eg, '%s', '%d', etc)
4583
+	 *
4584
+	 * @return array
4585
+	 */
4586
+	public function _get_data_types()
4587
+	{
4588
+		$data_types = array();
4589
+		foreach ($this->field_settings() as $field_obj) {
4590
+			//$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4591
+			/** @var $field_obj EE_Model_Field_Base */
4592
+			$data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4593
+		}
4594
+		return $data_types;
4595
+	}
4596
+
4597
+
4598
+
4599
+	/**
4600
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4601
+	 *
4602
+	 * @param string $model_name
4603
+	 * @throws EE_Error
4604
+	 * @return EEM_Base
4605
+	 */
4606
+	public function get_related_model_obj($model_name)
4607
+	{
4608
+		$model_classname = "EEM_" . $model_name;
4609
+		if (! class_exists($model_classname)) {
4610
+			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",
4611
+				'event_espresso'), $model_name, $model_classname));
4612
+		}
4613
+		return call_user_func($model_classname . "::instance");
4614
+	}
4615
+
4616
+
4617
+
4618
+	/**
4619
+	 * Returns the array of EE_ModelRelations for this model.
4620
+	 *
4621
+	 * @return EE_Model_Relation_Base[]
4622
+	 */
4623
+	public function relation_settings()
4624
+	{
4625
+		return $this->_model_relations;
4626
+	}
4627
+
4628
+
4629
+
4630
+	/**
4631
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
4632
+	 * because without THOSE models, this model probably doesn't have much purpose.
4633
+	 * (Eg, without an event, datetimes have little purpose.)
4634
+	 *
4635
+	 * @return EE_Belongs_To_Relation[]
4636
+	 */
4637
+	public function belongs_to_relations()
4638
+	{
4639
+		$belongs_to_relations = array();
4640
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
4641
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
4642
+				$belongs_to_relations[$model_name] = $relation_obj;
4643
+			}
4644
+		}
4645
+		return $belongs_to_relations;
4646
+	}
4647
+
4648
+
4649
+
4650
+	/**
4651
+	 * Returns the specified EE_Model_Relation, or throws an exception
4652
+	 *
4653
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
4654
+	 * @throws EE_Error
4655
+	 * @return EE_Model_Relation_Base
4656
+	 */
4657
+	public function related_settings_for($relation_name)
4658
+	{
4659
+		$relatedModels = $this->relation_settings();
4660
+		if (! array_key_exists($relation_name, $relatedModels)) {
4661
+			throw new EE_Error(
4662
+				sprintf(
4663
+					__('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4664
+						'event_espresso'),
4665
+					$relation_name,
4666
+					$this->_get_class_name(),
4667
+					implode(', ', array_keys($relatedModels))
4668
+				)
4669
+			);
4670
+		}
4671
+		return $relatedModels[$relation_name];
4672
+	}
4673
+
4674
+
4675
+
4676
+	/**
4677
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4678
+	 * fields
4679
+	 *
4680
+	 * @param string $fieldName
4681
+	 * @param boolean $include_db_only_fields
4682
+	 * @throws EE_Error
4683
+	 * @return EE_Model_Field_Base
4684
+	 */
4685
+	public function field_settings_for($fieldName, $include_db_only_fields = true)
4686
+	{
4687
+		$fieldSettings = $this->field_settings($include_db_only_fields);
4688
+		if (! array_key_exists($fieldName, $fieldSettings)) {
4689
+			throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4690
+				get_class($this)));
4691
+		}
4692
+		return $fieldSettings[$fieldName];
4693
+	}
4694
+
4695
+
4696
+
4697
+	/**
4698
+	 * Checks if this field exists on this model
4699
+	 *
4700
+	 * @param string $fieldName a key in the model's _field_settings array
4701
+	 * @return boolean
4702
+	 */
4703
+	public function has_field($fieldName)
4704
+	{
4705
+		$fieldSettings = $this->field_settings(true);
4706
+		if (isset($fieldSettings[$fieldName])) {
4707
+			return true;
4708
+		}
4709
+		return false;
4710
+	}
4711
+
4712
+
4713
+
4714
+	/**
4715
+	 * Returns whether or not this model has a relation to the specified model
4716
+	 *
4717
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
4718
+	 * @return boolean
4719
+	 */
4720
+	public function has_relation($relation_name)
4721
+	{
4722
+		$relations = $this->relation_settings();
4723
+		if (isset($relations[$relation_name])) {
4724
+			return true;
4725
+		}
4726
+		return false;
4727
+	}
4728
+
4729
+
4730
+
4731
+	/**
4732
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4733
+	 * Eg, on EE_Answer that would be ANS_ID field object
4734
+	 *
4735
+	 * @param $field_obj
4736
+	 * @return boolean
4737
+	 */
4738
+	public function is_primary_key_field($field_obj)
4739
+	{
4740
+		return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4741
+	}
4742
+
4743
+
4744
+
4745
+	/**
4746
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4747
+	 * Eg, on EE_Answer that would be ANS_ID field object
4748
+	 *
4749
+	 * @return EE_Model_Field_Base
4750
+	 * @throws EE_Error
4751
+	 */
4752
+	public function get_primary_key_field()
4753
+	{
4754
+		if ($this->_primary_key_field === null) {
4755
+			foreach ($this->field_settings(true) as $field_obj) {
4756
+				if ($this->is_primary_key_field($field_obj)) {
4757
+					$this->_primary_key_field = $field_obj;
4758
+					break;
4759
+				}
4760
+			}
4761
+			if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4762
+				throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4763
+					get_class($this)));
4764
+			}
4765
+		}
4766
+		return $this->_primary_key_field;
4767
+	}
4768
+
4769
+
4770
+
4771
+	/**
4772
+	 * Returns whether or not not there is a primary key on this model.
4773
+	 * Internally does some caching.
4774
+	 *
4775
+	 * @return boolean
4776
+	 */
4777
+	public function has_primary_key_field()
4778
+	{
4779
+		if ($this->_has_primary_key_field === null) {
4780
+			try {
4781
+				$this->get_primary_key_field();
4782
+				$this->_has_primary_key_field = true;
4783
+			} catch (EE_Error $e) {
4784
+				$this->_has_primary_key_field = false;
4785
+			}
4786
+		}
4787
+		return $this->_has_primary_key_field;
4788
+	}
4789
+
4790
+
4791
+
4792
+	/**
4793
+	 * Finds the first field of type $field_class_name.
4794
+	 *
4795
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4796
+	 *                                 EE_Foreign_Key_Field, etc
4797
+	 * @return EE_Model_Field_Base or null if none is found
4798
+	 */
4799
+	public function get_a_field_of_type($field_class_name)
4800
+	{
4801
+		foreach ($this->field_settings() as $field) {
4802
+			if ($field instanceof $field_class_name) {
4803
+				return $field;
4804
+			}
4805
+		}
4806
+		return null;
4807
+	}
4808
+
4809
+
4810
+
4811
+	/**
4812
+	 * Gets a foreign key field pointing to model.
4813
+	 *
4814
+	 * @param string $model_name eg Event, Registration, not EEM_Event
4815
+	 * @return EE_Foreign_Key_Field_Base
4816
+	 * @throws EE_Error
4817
+	 */
4818
+	public function get_foreign_key_to($model_name)
4819
+	{
4820
+		if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4821
+			foreach ($this->field_settings() as $field) {
4822
+				if (
4823
+					$field instanceof EE_Foreign_Key_Field_Base
4824
+					&& in_array($model_name, $field->get_model_names_pointed_to())
4825
+				) {
4826
+					$this->_cache_foreign_key_to_fields[$model_name] = $field;
4827
+					break;
4828
+				}
4829
+			}
4830
+			if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4831
+				throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4832
+					'event_espresso'), $model_name, get_class($this)));
4833
+			}
4834
+		}
4835
+		return $this->_cache_foreign_key_to_fields[$model_name];
4836
+	}
4837
+
4838
+
4839
+
4840
+	/**
4841
+	 * Gets the table name (including $wpdb->prefix) for the table alias
4842
+	 *
4843
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4844
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4845
+	 *                            Either one works
4846
+	 * @return string
4847
+	 */
4848
+	public function get_table_for_alias($table_alias)
4849
+	{
4850
+		$table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4851
+		return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4852
+	}
4853
+
4854
+
4855
+
4856
+	/**
4857
+	 * Returns a flat array of all field son this model, instead of organizing them
4858
+	 * by table_alias as they are in the constructor.
4859
+	 *
4860
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4861
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
4862
+	 */
4863
+	public function field_settings($include_db_only_fields = false)
4864
+	{
4865
+		if ($include_db_only_fields) {
4866
+			if ($this->_cached_fields === null) {
4867
+				$this->_cached_fields = array();
4868
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4869
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4870
+						$this->_cached_fields[$field_name] = $field_obj;
4871
+					}
4872
+				}
4873
+			}
4874
+			return $this->_cached_fields;
4875
+		}
4876
+		if ($this->_cached_fields_non_db_only === null) {
4877
+			$this->_cached_fields_non_db_only = array();
4878
+			foreach ($this->_fields as $fields_corresponding_to_table) {
4879
+				foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4880
+					/** @var $field_obj EE_Model_Field_Base */
4881
+					if (! $field_obj->is_db_only_field()) {
4882
+						$this->_cached_fields_non_db_only[$field_name] = $field_obj;
4883
+					}
4884
+				}
4885
+			}
4886
+		}
4887
+		return $this->_cached_fields_non_db_only;
4888
+	}
4889
+
4890
+
4891
+
4892
+	/**
4893
+	 *        cycle though array of attendees and create objects out of each item
4894
+	 *
4895
+	 * @access        private
4896
+	 * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4897
+	 * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4898
+	 *                           numerically indexed)
4899
+	 * @throws EE_Error
4900
+	 */
4901
+	protected function _create_objects($rows = array())
4902
+	{
4903
+		$array_of_objects = array();
4904
+		if (empty($rows)) {
4905
+			return array();
4906
+		}
4907
+		$count_if_model_has_no_primary_key = 0;
4908
+		$has_primary_key = $this->has_primary_key_field();
4909
+		$primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4910
+		foreach ((array)$rows as $row) {
4911
+			if (empty($row)) {
4912
+				//wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4913
+				return array();
4914
+			}
4915
+			//check if we've already set this object in the results array,
4916
+			//in which case there's no need to process it further (again)
4917
+			if ($has_primary_key) {
4918
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4919
+					$row,
4920
+					$primary_key_field->get_qualified_column(),
4921
+					$primary_key_field->get_table_column()
4922
+				);
4923
+				if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4924
+					continue;
4925
+				}
4926
+			}
4927
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
4928
+			if (! $classInstance) {
4929
+				throw new EE_Error(
4930
+					sprintf(
4931
+						__('Could not create instance of class %s from row %s', 'event_espresso'),
4932
+						$this->get_this_model_name(),
4933
+						http_build_query($row)
4934
+					)
4935
+				);
4936
+			}
4937
+			//set the timezone on the instantiated objects
4938
+			$classInstance->set_timezone($this->_timezone);
4939
+			//make sure if there is any timezone setting present that we set the timezone for the object
4940
+			$key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4941
+			$array_of_objects[$key] = $classInstance;
4942
+			//also, for all the relations of type BelongsTo, see if we can cache
4943
+			//those related models
4944
+			//(we could do this for other relations too, but if there are conditions
4945
+			//that filtered out some fo the results, then we'd be caching an incomplete set
4946
+			//so it requires a little more thought than just caching them immediately...)
4947
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
4948
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
4949
+					//check if this model's INFO is present. If so, cache it on the model
4950
+					$other_model = $relation_obj->get_other_model();
4951
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4952
+					//if we managed to make a model object from the results, cache it on the main model object
4953
+					if ($other_model_obj_maybe) {
4954
+						//set timezone on these other model objects if they are present
4955
+						$other_model_obj_maybe->set_timezone($this->_timezone);
4956
+						$classInstance->cache($modelName, $other_model_obj_maybe);
4957
+					}
4958
+				}
4959
+			}
4960
+		}
4961
+		return $array_of_objects;
4962
+	}
4963
+
4964
+
4965
+
4966
+	/**
4967
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4968
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4969
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4970
+	 * object (as set in the model_field!).
4971
+	 *
4972
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4973
+	 */
4974
+	public function create_default_object()
4975
+	{
4976
+		$this_model_fields_and_values = array();
4977
+		//setup the row using default values;
4978
+		foreach ($this->field_settings() as $field_name => $field_obj) {
4979
+			$this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4980
+		}
4981
+		$className = $this->_get_class_name();
4982
+		$classInstance = EE_Registry::instance()
4983
+									->load_class($className, array($this_model_fields_and_values), false, false);
4984
+		return $classInstance;
4985
+	}
4986
+
4987
+
4988
+
4989
+	/**
4990
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
4991
+	 *                             or an stdClass where each property is the name of a column,
4992
+	 * @return EE_Base_Class
4993
+	 * @throws EE_Error
4994
+	 */
4995
+	public function instantiate_class_from_array_or_object($cols_n_values)
4996
+	{
4997
+		if (! is_array($cols_n_values) && is_object($cols_n_values)) {
4998
+			$cols_n_values = get_object_vars($cols_n_values);
4999
+		}
5000
+		$primary_key = null;
5001
+		//make sure the array only has keys that are fields/columns on this model
5002
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5003
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
5004
+			$primary_key = $this_model_fields_n_values[$this->primary_key_name()];
5005
+		}
5006
+		$className = $this->_get_class_name();
5007
+		//check we actually found results that we can use to build our model object
5008
+		//if not, return null
5009
+		if ($this->has_primary_key_field()) {
5010
+			if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
5011
+				return null;
5012
+			}
5013
+		} else if ($this->unique_indexes()) {
5014
+			$first_column = reset($this_model_fields_n_values);
5015
+			if (empty($first_column)) {
5016
+				return null;
5017
+			}
5018
+		}
5019
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
5020
+		if ($primary_key) {
5021
+			$classInstance = $this->get_from_entity_map($primary_key);
5022
+			if (! $classInstance) {
5023
+				$classInstance = EE_Registry::instance()
5024
+											->load_class($className,
5025
+												array($this_model_fields_n_values, $this->_timezone), true, false);
5026
+				// add this new object to the entity map
5027
+				$classInstance = $this->add_to_entity_map($classInstance);
5028
+			}
5029
+		} else {
5030
+			$classInstance = EE_Registry::instance()
5031
+										->load_class($className, array($this_model_fields_n_values, $this->_timezone),
5032
+											true, false);
5033
+		}
5034
+		return $classInstance;
5035
+	}
5036
+
5037
+
5038
+
5039
+	/**
5040
+	 * Gets the model object from the  entity map if it exists
5041
+	 *
5042
+	 * @param int|string $id the ID of the model object
5043
+	 * @return EE_Base_Class
5044
+	 */
5045
+	public function get_from_entity_map($id)
5046
+	{
5047
+		return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
5048
+			? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
5049
+	}
5050
+
5051
+
5052
+
5053
+	/**
5054
+	 * add_to_entity_map
5055
+	 * Adds the object to the model's entity mappings
5056
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
5057
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
5058
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
5059
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
5060
+	 *        then this method should be called immediately after the update query
5061
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
5062
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
5063
+	 *
5064
+	 * @param    EE_Base_Class $object
5065
+	 * @throws EE_Error
5066
+	 * @return \EE_Base_Class
5067
+	 */
5068
+	public function add_to_entity_map(EE_Base_Class $object)
5069
+	{
5070
+		$className = $this->_get_class_name();
5071
+		if (! $object instanceof $className) {
5072
+			throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
5073
+				is_object($object) ? get_class($object) : $object, $className));
5074
+		}
5075
+		/** @var $object EE_Base_Class */
5076
+		if (! $object->ID()) {
5077
+			throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
5078
+				"event_espresso"), get_class($this)));
5079
+		}
5080
+		// double check it's not already there
5081
+		$classInstance = $this->get_from_entity_map($object->ID());
5082
+		if ($classInstance) {
5083
+			return $classInstance;
5084
+		}
5085
+		$this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
5086
+		return $object;
5087
+	}
5088
+
5089
+
5090
+
5091
+	/**
5092
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
5093
+	 * if no identifier is provided, then the entire entity map is emptied
5094
+	 *
5095
+	 * @param int|string $id the ID of the model object
5096
+	 * @return boolean
5097
+	 */
5098
+	public function clear_entity_map($id = null)
5099
+	{
5100
+		if (empty($id)) {
5101
+			$this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
5102
+			return true;
5103
+		}
5104
+		if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
5105
+			unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
5106
+			return true;
5107
+		}
5108
+		return false;
5109
+	}
5110
+
5111
+
5112
+
5113
+	/**
5114
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
5115
+	 * Given an array where keys are column (or column alias) names and values,
5116
+	 * returns an array of their corresponding field names and database values
5117
+	 *
5118
+	 * @param array $cols_n_values
5119
+	 * @return array
5120
+	 */
5121
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
5122
+	{
5123
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5124
+	}
5125
+
5126
+
5127
+
5128
+	/**
5129
+	 * _deduce_fields_n_values_from_cols_n_values
5130
+	 * Given an array where keys are column (or column alias) names and values,
5131
+	 * returns an array of their corresponding field names and database values
5132
+	 *
5133
+	 * @param string $cols_n_values
5134
+	 * @return array
5135
+	 */
5136
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5137
+	{
5138
+		$this_model_fields_n_values = array();
5139
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
5140
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5141
+				$table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5142
+			//there is a primary key on this table and its not set. Use defaults for all its columns
5143
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
5144
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5145
+					if (! $field_obj->is_db_only_field()) {
5146
+						//prepare field as if its coming from db
5147
+						$prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5148
+						$this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5149
+					}
5150
+				}
5151
+			} else {
5152
+				//the table's rows existed. Use their values
5153
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5154
+					if (! $field_obj->is_db_only_field()) {
5155
+						$this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5156
+							$cols_n_values, $field_obj->get_qualified_column(),
5157
+							$field_obj->get_table_column()
5158
+						);
5159
+					}
5160
+				}
5161
+			}
5162
+		}
5163
+		return $this_model_fields_n_values;
5164
+	}
5165
+
5166
+
5167
+
5168
+	/**
5169
+	 * @param $cols_n_values
5170
+	 * @param $qualified_column
5171
+	 * @param $regular_column
5172
+	 * @return null
5173
+	 */
5174
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5175
+	{
5176
+		$value = null;
5177
+		//ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5178
+		//does the field on the model relate to this column retrieved from the db?
5179
+		//or is it a db-only field? (not relating to the model)
5180
+		if (isset($cols_n_values[$qualified_column])) {
5181
+			$value = $cols_n_values[$qualified_column];
5182
+		} elseif (isset($cols_n_values[$regular_column])) {
5183
+			$value = $cols_n_values[$regular_column];
5184
+		}
5185
+		return $value;
5186
+	}
5187
+
5188
+
5189
+
5190
+	/**
5191
+	 * refresh_entity_map_from_db
5192
+	 * Makes sure the model object in the entity map at $id assumes the values
5193
+	 * of the database (opposite of EE_base_Class::save())
5194
+	 *
5195
+	 * @param int|string $id
5196
+	 * @return EE_Base_Class
5197
+	 * @throws EE_Error
5198
+	 */
5199
+	public function refresh_entity_map_from_db($id)
5200
+	{
5201
+		$obj_in_map = $this->get_from_entity_map($id);
5202
+		if ($obj_in_map) {
5203
+			$wpdb_results = $this->_get_all_wpdb_results(
5204
+				array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5205
+			);
5206
+			if ($wpdb_results && is_array($wpdb_results)) {
5207
+				$one_row = reset($wpdb_results);
5208
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5209
+					$obj_in_map->set_from_db($field_name, $db_value);
5210
+				}
5211
+				//clear the cache of related model objects
5212
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5213
+					$obj_in_map->clear_cache($relation_name, null, true);
5214
+				}
5215
+			}
5216
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5217
+			return $obj_in_map;
5218
+		}
5219
+		return $this->get_one_by_ID($id);
5220
+	}
5221
+
5222
+
5223
+
5224
+	/**
5225
+	 * refresh_entity_map_with
5226
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
5227
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5228
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5229
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5230
+	 *
5231
+	 * @param int|string    $id
5232
+	 * @param EE_Base_Class $replacing_model_obj
5233
+	 * @return \EE_Base_Class
5234
+	 * @throws EE_Error
5235
+	 */
5236
+	public function refresh_entity_map_with($id, $replacing_model_obj)
5237
+	{
5238
+		$obj_in_map = $this->get_from_entity_map($id);
5239
+		if ($obj_in_map) {
5240
+			if ($replacing_model_obj instanceof EE_Base_Class) {
5241
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5242
+					$obj_in_map->set($field_name, $value);
5243
+				}
5244
+				//make the model object in the entity map's cache match the $replacing_model_obj
5245
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5246
+					$obj_in_map->clear_cache($relation_name, null, true);
5247
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5248
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5249
+					}
5250
+				}
5251
+			}
5252
+			return $obj_in_map;
5253
+		}
5254
+		$this->add_to_entity_map($replacing_model_obj);
5255
+		return $replacing_model_obj;
5256
+	}
5257
+
5258
+
5259
+
5260
+	/**
5261
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5262
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5263
+	 * require_once($this->_getClassName().".class.php");
5264
+	 *
5265
+	 * @return string
5266
+	 */
5267
+	private function _get_class_name()
5268
+	{
5269
+		return "EE_" . $this->get_this_model_name();
5270
+	}
5271
+
5272
+
5273
+
5274
+	/**
5275
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
5276
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5277
+	 * it would be 'Events'.
5278
+	 *
5279
+	 * @param int $quantity
5280
+	 * @return string
5281
+	 */
5282
+	public function item_name($quantity = 1)
5283
+	{
5284
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5285
+	}
5286
+
5287
+
5288
+
5289
+	/**
5290
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5291
+	 * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5292
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5293
+	 * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5294
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5295
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5296
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
5297
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
5298
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5299
+	 * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5300
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5301
+	 *        return $previousReturnValue.$returnString;
5302
+	 * }
5303
+	 * require('EEM_Answer.model.php');
5304
+	 * $answer=EEM_Answer::instance();
5305
+	 * echo $answer->my_callback('monkeys',100);
5306
+	 * //will output "you called my_callback! and passed args:monkeys,100"
5307
+	 *
5308
+	 * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5309
+	 * @param array  $args       array of original arguments passed to the function
5310
+	 * @throws EE_Error
5311
+	 * @return mixed whatever the plugin which calls add_filter decides
5312
+	 */
5313
+	public function __call($methodName, $args)
5314
+	{
5315
+		$className = get_class($this);
5316
+		$tagName = "FHEE__{$className}__{$methodName}";
5317
+		if (! has_filter($tagName)) {
5318
+			throw new EE_Error(
5319
+				sprintf(
5320
+					__('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 );',
5321
+						'event_espresso'),
5322
+					$methodName,
5323
+					$className,
5324
+					$tagName,
5325
+					'<br />'
5326
+				)
5327
+			);
5328
+		}
5329
+		return apply_filters($tagName, null, $this, $args);
5330
+	}
5331
+
5332
+
5333
+
5334
+	/**
5335
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5336
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5337
+	 *
5338
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5339
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
5340
+	 *                                                       the object's class name
5341
+	 *                                                       or object's ID
5342
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5343
+	 *                                                       exists in the database. If it does not, we add it
5344
+	 * @throws EE_Error
5345
+	 * @return EE_Base_Class
5346
+	 */
5347
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5348
+	{
5349
+		$className = $this->_get_class_name();
5350
+		if ($base_class_obj_or_id instanceof $className) {
5351
+			$model_object = $base_class_obj_or_id;
5352
+		} else {
5353
+			$primary_key_field = $this->get_primary_key_field();
5354
+			if (
5355
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
5356
+				&& (
5357
+					is_int($base_class_obj_or_id)
5358
+					|| is_string($base_class_obj_or_id)
5359
+				)
5360
+			) {
5361
+				// assume it's an ID.
5362
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
5363
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5364
+			} else if (
5365
+				$primary_key_field instanceof EE_Primary_Key_String_Field
5366
+				&& is_string($base_class_obj_or_id)
5367
+			) {
5368
+				// assume its a string representation of the object
5369
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5370
+			} else {
5371
+				throw new EE_Error(
5372
+					sprintf(
5373
+						__(
5374
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5375
+							'event_espresso'
5376
+						),
5377
+						$base_class_obj_or_id,
5378
+						$this->_get_class_name(),
5379
+						print_r($base_class_obj_or_id, true)
5380
+					)
5381
+				);
5382
+			}
5383
+		}
5384
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
5385
+			$model_object->save();
5386
+		}
5387
+		return $model_object;
5388
+	}
5389
+
5390
+
5391
+
5392
+	/**
5393
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5394
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
5395
+	 * returns it ID.
5396
+	 *
5397
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
5398
+	 * @return int|string depending on the type of this model object's ID
5399
+	 * @throws EE_Error
5400
+	 */
5401
+	public function ensure_is_ID($base_class_obj_or_id)
5402
+	{
5403
+		$className = $this->_get_class_name();
5404
+		if ($base_class_obj_or_id instanceof $className) {
5405
+			/** @var $base_class_obj_or_id EE_Base_Class */
5406
+			$id = $base_class_obj_or_id->ID();
5407
+		} elseif (is_int($base_class_obj_or_id)) {
5408
+			//assume it's an ID
5409
+			$id = $base_class_obj_or_id;
5410
+		} elseif (is_string($base_class_obj_or_id)) {
5411
+			//assume its a string representation of the object
5412
+			$id = $base_class_obj_or_id;
5413
+		} else {
5414
+			throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5415
+				'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5416
+				print_r($base_class_obj_or_id, true)));
5417
+		}
5418
+		return $id;
5419
+	}
5420
+
5421
+
5422
+
5423
+	/**
5424
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5425
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5426
+	 * been sanitized and converted into the appropriate domain.
5427
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5428
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5429
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5430
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5431
+	 * $EVT = EEM_Event::instance(); $old_setting =
5432
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5433
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
5434
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5435
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5436
+	 *
5437
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
5438
+	 * @return void
5439
+	 */
5440
+	public function assume_values_already_prepared_by_model_object(
5441
+		$values_already_prepared = self::not_prepared_by_model_object
5442
+	) {
5443
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
5444
+	}
5445
+
5446
+
5447
+
5448
+	/**
5449
+	 * Read comments for assume_values_already_prepared_by_model_object()
5450
+	 *
5451
+	 * @return int
5452
+	 */
5453
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
5454
+	{
5455
+		return $this->_values_already_prepared_by_model_object;
5456
+	}
5457
+
5458
+
5459
+
5460
+	/**
5461
+	 * Gets all the indexes on this model
5462
+	 *
5463
+	 * @return EE_Index[]
5464
+	 */
5465
+	public function indexes()
5466
+	{
5467
+		return $this->_indexes;
5468
+	}
5469
+
5470
+
5471
+
5472
+	/**
5473
+	 * Gets all the Unique Indexes on this model
5474
+	 *
5475
+	 * @return EE_Unique_Index[]
5476
+	 */
5477
+	public function unique_indexes()
5478
+	{
5479
+		$unique_indexes = array();
5480
+		foreach ($this->_indexes as $name => $index) {
5481
+			if ($index instanceof EE_Unique_Index) {
5482
+				$unique_indexes [$name] = $index;
5483
+			}
5484
+		}
5485
+		return $unique_indexes;
5486
+	}
5487
+
5488
+
5489
+
5490
+	/**
5491
+	 * Gets all the fields which, when combined, make the primary key.
5492
+	 * This is usually just an array with 1 element (the primary key), but in cases
5493
+	 * where there is no primary key, it's a combination of fields as defined
5494
+	 * on a primary index
5495
+	 *
5496
+	 * @return EE_Model_Field_Base[] indexed by the field's name
5497
+	 * @throws EE_Error
5498
+	 */
5499
+	public function get_combined_primary_key_fields()
5500
+	{
5501
+		foreach ($this->indexes() as $index) {
5502
+			if ($index instanceof EE_Primary_Key_Index) {
5503
+				return $index->fields();
5504
+			}
5505
+		}
5506
+		return array($this->primary_key_name() => $this->get_primary_key_field());
5507
+	}
5508
+
5509
+
5510
+
5511
+	/**
5512
+	 * Used to build a primary key string (when the model has no primary key),
5513
+	 * which can be used a unique string to identify this model object.
5514
+	 *
5515
+	 * @param array $cols_n_values keys are field names, values are their values
5516
+	 * @return string
5517
+	 * @throws EE_Error
5518
+	 */
5519
+	public function get_index_primary_key_string($cols_n_values)
5520
+	{
5521
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5522
+			$this->get_combined_primary_key_fields());
5523
+		return http_build_query($cols_n_values_for_primary_key_index);
5524
+	}
5525
+
5526
+
5527
+
5528
+	/**
5529
+	 * Gets the field values from the primary key string
5530
+	 *
5531
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5532
+	 * @param string $index_primary_key_string
5533
+	 * @return null|array
5534
+	 * @throws EE_Error
5535
+	 */
5536
+	public function parse_index_primary_key_string($index_primary_key_string)
5537
+	{
5538
+		$key_fields = $this->get_combined_primary_key_fields();
5539
+		//check all of them are in the $id
5540
+		$key_vals_in_combined_pk = array();
5541
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5542
+		foreach ($key_fields as $key_field_name => $field_obj) {
5543
+			if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5544
+				return null;
5545
+			}
5546
+		}
5547
+		return $key_vals_in_combined_pk;
5548
+	}
5549
+
5550
+
5551
+
5552
+	/**
5553
+	 * verifies that an array of key-value pairs for model fields has a key
5554
+	 * for each field comprising the primary key index
5555
+	 *
5556
+	 * @param array $key_vals
5557
+	 * @return boolean
5558
+	 * @throws EE_Error
5559
+	 */
5560
+	public function has_all_combined_primary_key_fields($key_vals)
5561
+	{
5562
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5563
+		foreach ($keys_it_should_have as $key) {
5564
+			if (! isset($key_vals[$key])) {
5565
+				return false;
5566
+			}
5567
+		}
5568
+		return true;
5569
+	}
5570
+
5571
+
5572
+
5573
+	/**
5574
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5575
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
5576
+	 *
5577
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5578
+	 * @param array               $query_params                     like EEM_Base::get_all's query_params.
5579
+	 * @throws EE_Error
5580
+	 * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5581
+	 *                                                              indexed)
5582
+	 */
5583
+	public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5584
+	{
5585
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5586
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
5587
+		} elseif (is_array($model_object_or_attributes_array)) {
5588
+			$attributes_array = $model_object_or_attributes_array;
5589
+		} else {
5590
+			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",
5591
+				"event_espresso"), $model_object_or_attributes_array));
5592
+		}
5593
+		//even copies obviously won't have the same ID, so remove the primary key
5594
+		//from the WHERE conditions for finding copies (if there is a primary key, of course)
5595
+		if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5596
+			unset($attributes_array[$this->primary_key_name()]);
5597
+		}
5598
+		if (isset($query_params[0])) {
5599
+			$query_params[0] = array_merge($attributes_array, $query_params);
5600
+		} else {
5601
+			$query_params[0] = $attributes_array;
5602
+		}
5603
+		return $this->get_all($query_params);
5604
+	}
5605
+
5606
+
5607
+
5608
+	/**
5609
+	 * Gets the first copy we find. See get_all_copies for more details
5610
+	 *
5611
+	 * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5612
+	 * @param array $query_params
5613
+	 * @return EE_Base_Class
5614
+	 * @throws EE_Error
5615
+	 */
5616
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5617
+	{
5618
+		if (! is_array($query_params)) {
5619
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5620
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5621
+					gettype($query_params)), '4.6.0');
5622
+			$query_params = array();
5623
+		}
5624
+		$query_params['limit'] = 1;
5625
+		$copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5626
+		if (is_array($copies)) {
5627
+			return array_shift($copies);
5628
+		}
5629
+		return null;
5630
+	}
5631
+
5632
+
5633
+
5634
+	/**
5635
+	 * Updates the item with the specified id. Ignores default query parameters because
5636
+	 * we have specified the ID, and its assumed we KNOW what we're doing
5637
+	 *
5638
+	 * @param array      $fields_n_values keys are field names, values are their new values
5639
+	 * @param int|string $id              the value of the primary key to update
5640
+	 * @return int number of rows updated
5641
+	 * @throws EE_Error
5642
+	 */
5643
+	public function update_by_ID($fields_n_values, $id)
5644
+	{
5645
+		$query_params = array(
5646
+			0                          => array($this->get_primary_key_field()->get_name() => $id),
5647
+			'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5648
+		);
5649
+		return $this->update($fields_n_values, $query_params);
5650
+	}
5651
+
5652
+
5653
+
5654
+	/**
5655
+	 * Changes an operator which was supplied to the models into one usable in SQL
5656
+	 *
5657
+	 * @param string $operator_supplied
5658
+	 * @return string an operator which can be used in SQL
5659
+	 * @throws EE_Error
5660
+	 */
5661
+	private function _prepare_operator_for_sql($operator_supplied)
5662
+	{
5663
+		$sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5664
+			: null;
5665
+		if ($sql_operator) {
5666
+			return $sql_operator;
5667
+		}
5668
+		throw new EE_Error(
5669
+			sprintf(
5670
+				__(
5671
+					"The operator '%s' is not in the list of valid operators: %s",
5672
+					"event_espresso"
5673
+				), $operator_supplied, implode(",", array_keys($this->_valid_operators))
5674
+			)
5675
+		);
5676
+	}
5677
+
5678
+
5679
+
5680
+	/**
5681
+	 * Gets the valid operators
5682
+	 * @return array keys are accepted strings, values are the SQL they are converted to
5683
+	 */
5684
+	public function valid_operators(){
5685
+		return $this->_valid_operators;
5686
+	}
5687
+
5688
+
5689
+
5690
+	/**
5691
+	 * Gets the between-style operators (take 2 arguments).
5692
+	 * @return array keys are accepted strings, values are the SQL they are converted to
5693
+	 */
5694
+	public function valid_between_style_operators()
5695
+	{
5696
+		return array_intersect(
5697
+			$this->valid_operators(),
5698
+			$this->_between_style_operators
5699
+		);
5700
+	}
5701
+
5702
+	/**
5703
+	 * Gets the "like"-style operators (take a single argument, but it may contain wildcards)
5704
+	 * @return array keys are accepted strings, values are the SQL they are converted to
5705
+	 */
5706
+	public function valid_like_style_operators()
5707
+	{
5708
+		return array_intersect(
5709
+			$this->valid_operators(),
5710
+			$this->_like_style_operators
5711
+		);
5712
+	}
5713
+
5714
+	/**
5715
+	 * Gets the "in"-style operators
5716
+	 * @return array keys are accepted strings, values are the SQL they are converted to
5717
+	 */
5718
+	public function valid_in_style_operators()
5719
+	{
5720
+		return array_intersect(
5721
+			$this->valid_operators(),
5722
+			$this->_in_style_operators
5723
+		);
5724
+	}
5725
+
5726
+	/**
5727
+	 * Gets the "null"-style operators (accept no arguments)
5728
+	 * @return array keys are accepted strings, values are the SQL they are converted to
5729
+	 */
5730
+	public function valid_null_style_operators()
5731
+	{
5732
+		return array_intersect(
5733
+			$this->valid_operators(),
5734
+			$this->_null_style_operators
5735
+		);
5736
+	}
5737
+
5738
+	/**
5739
+	 * Gets an array where keys are the primary keys and values are their 'names'
5740
+	 * (as determined by the model object's name() function, which is often overridden)
5741
+	 *
5742
+	 * @param array $query_params like get_all's
5743
+	 * @return string[]
5744
+	 * @throws EE_Error
5745
+	 */
5746
+	public function get_all_names($query_params = array())
5747
+	{
5748
+		$objs = $this->get_all($query_params);
5749
+		$names = array();
5750
+		foreach ($objs as $obj) {
5751
+			$names[$obj->ID()] = $obj->name();
5752
+		}
5753
+		return $names;
5754
+	}
5755
+
5756
+
5757
+
5758
+	/**
5759
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
5760
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5761
+	 * this is duplicated effort and reduces efficiency) you would be better to use
5762
+	 * array_keys() on $model_objects.
5763
+	 *
5764
+	 * @param \EE_Base_Class[] $model_objects
5765
+	 * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5766
+	 *                                               in the returned array
5767
+	 * @return array
5768
+	 * @throws EE_Error
5769
+	 */
5770
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
5771
+	{
5772
+		if (! $this->has_primary_key_field()) {
5773
+			if (WP_DEBUG) {
5774
+				EE_Error::add_error(
5775
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5776
+					__FILE__,
5777
+					__FUNCTION__,
5778
+					__LINE__
5779
+				);
5780
+			}
5781
+		}
5782
+		$IDs = array();
5783
+		foreach ($model_objects as $model_object) {
5784
+			$id = $model_object->ID();
5785
+			if (! $id) {
5786
+				if ($filter_out_empty_ids) {
5787
+					continue;
5788
+				}
5789
+				if (WP_DEBUG) {
5790
+					EE_Error::add_error(
5791
+						__(
5792
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5793
+							'event_espresso'
5794
+						),
5795
+						__FILE__,
5796
+						__FUNCTION__,
5797
+						__LINE__
5798
+					);
5799
+				}
5800
+			}
5801
+			$IDs[] = $id;
5802
+		}
5803
+		return $IDs;
5804
+	}
5805
+
5806
+
5807
+
5808
+	/**
5809
+	 * Returns the string used in capabilities relating to this model. If there
5810
+	 * are no capabilities that relate to this model returns false
5811
+	 *
5812
+	 * @return string|false
5813
+	 */
5814
+	public function cap_slug()
5815
+	{
5816
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5817
+	}
5818
+
5819
+
5820
+
5821
+	/**
5822
+	 * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5823
+	 * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5824
+	 * only returns the cap restrictions array in that context (ie, the array
5825
+	 * at that key)
5826
+	 *
5827
+	 * @param string $context
5828
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
5829
+	 * @throws EE_Error
5830
+	 */
5831
+	public function cap_restrictions($context = EEM_Base::caps_read)
5832
+	{
5833
+		EEM_Base::verify_is_valid_cap_context($context);
5834
+		//check if we ought to run the restriction generator first
5835
+		if (
5836
+			isset($this->_cap_restriction_generators[$context])
5837
+			&& $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5838
+			&& ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5839
+		) {
5840
+			$this->_cap_restrictions[$context] = array_merge(
5841
+				$this->_cap_restrictions[$context],
5842
+				$this->_cap_restriction_generators[$context]->generate_restrictions()
5843
+			);
5844
+		}
5845
+		//and make sure we've finalized the construction of each restriction
5846
+		foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5847
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5848
+				$where_conditions_obj->_finalize_construct($this);
5849
+			}
5850
+		}
5851
+		return $this->_cap_restrictions[$context];
5852
+	}
5853
+
5854
+
5855
+
5856
+	/**
5857
+	 * Indicating whether or not this model thinks its a wp core model
5858
+	 *
5859
+	 * @return boolean
5860
+	 */
5861
+	public function is_wp_core_model()
5862
+	{
5863
+		return $this->_wp_core_model;
5864
+	}
5865
+
5866
+
5867
+
5868
+	/**
5869
+	 * Gets all the caps that are missing which impose a restriction on
5870
+	 * queries made in this context
5871
+	 *
5872
+	 * @param string $context one of EEM_Base::caps_ constants
5873
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
5874
+	 * @throws EE_Error
5875
+	 */
5876
+	public function caps_missing($context = EEM_Base::caps_read)
5877
+	{
5878
+		$missing_caps = array();
5879
+		$cap_restrictions = $this->cap_restrictions($context);
5880
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5881
+			if (! EE_Capabilities::instance()
5882
+								 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5883
+			) {
5884
+				$missing_caps[$cap] = $restriction_if_no_cap;
5885
+			}
5886
+		}
5887
+		return $missing_caps;
5888
+	}
5889
+
5890
+
5891
+
5892
+	/**
5893
+	 * Gets the mapping from capability contexts to action strings used in capability names
5894
+	 *
5895
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5896
+	 * one of 'read', 'edit', or 'delete'
5897
+	 */
5898
+	public function cap_contexts_to_cap_action_map()
5899
+	{
5900
+		return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5901
+			$this);
5902
+	}
5903
+
5904
+
5905
+
5906
+	/**
5907
+	 * Gets the action string for the specified capability context
5908
+	 *
5909
+	 * @param string $context
5910
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5911
+	 * @throws EE_Error
5912
+	 */
5913
+	public function cap_action_for_context($context)
5914
+	{
5915
+		$mapping = $this->cap_contexts_to_cap_action_map();
5916
+		if (isset($mapping[$context])) {
5917
+			return $mapping[$context];
5918
+		}
5919
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5920
+			return $action;
5921
+		}
5922
+		throw new EE_Error(
5923
+			sprintf(
5924
+				__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5925
+				$context,
5926
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5927
+			)
5928
+		);
5929
+	}
5930
+
5931
+
5932
+
5933
+	/**
5934
+	 * Returns all the capability contexts which are valid when querying models
5935
+	 *
5936
+	 * @return array
5937
+	 */
5938
+	public static function valid_cap_contexts()
5939
+	{
5940
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5941
+			self::caps_read,
5942
+			self::caps_read_admin,
5943
+			self::caps_edit,
5944
+			self::caps_delete,
5945
+		));
5946
+	}
5947
+
5948
+
5949
+
5950
+	/**
5951
+	 * Returns all valid options for 'default_where_conditions'
5952
+	 *
5953
+	 * @return array
5954
+	 */
5955
+	public static function valid_default_where_conditions()
5956
+	{
5957
+		return array(
5958
+			EEM_Base::default_where_conditions_all,
5959
+			EEM_Base::default_where_conditions_this_only,
5960
+			EEM_Base::default_where_conditions_others_only,
5961
+			EEM_Base::default_where_conditions_minimum_all,
5962
+			EEM_Base::default_where_conditions_minimum_others,
5963
+			EEM_Base::default_where_conditions_none
5964
+		);
5965
+	}
5966
+
5967
+	// public static function default_where_conditions_full
5968
+	/**
5969
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5970
+	 *
5971
+	 * @param string $context
5972
+	 * @return bool
5973
+	 * @throws EE_Error
5974
+	 */
5975
+	static public function verify_is_valid_cap_context($context)
5976
+	{
5977
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
5978
+		if (in_array($context, $valid_cap_contexts)) {
5979
+			return true;
5980
+		}
5981
+		throw new EE_Error(
5982
+			sprintf(
5983
+				__(
5984
+					'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5985
+					'event_espresso'
5986
+				),
5987
+				$context,
5988
+				'EEM_Base',
5989
+				implode(',', $valid_cap_contexts)
5990
+			)
5991
+		);
5992
+	}
5993
+
5994
+
5995
+
5996
+	/**
5997
+	 * Clears all the models field caches. This is only useful when a sub-class
5998
+	 * might have added a field or something and these caches might be invalidated
5999
+	 */
6000
+	protected function _invalidate_field_caches()
6001
+	{
6002
+		$this->_cache_foreign_key_to_fields = array();
6003
+		$this->_cached_fields = null;
6004
+		$this->_cached_fields_non_db_only = null;
6005
+	}
6006
+
6007
+
6008
+
6009
+	/**
6010
+	 * Gets the list of all the where query param keys that relate to logic instead of field names
6011
+	 * (eg "and", "or", "not").
6012
+	 *
6013
+	 * @return array
6014
+	 */
6015
+	public function logic_query_param_keys()
6016
+	{
6017
+		return $this->_logic_query_param_keys;
6018
+	}
6019
+
6020
+
6021
+
6022
+	/**
6023
+	 * Determines whether or not the where query param array key is for a logic query param.
6024
+	 * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
6025
+	 * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
6026
+	 *
6027
+	 * @param $query_param_key
6028
+	 * @return bool
6029
+	 */
6030
+	public function is_logic_query_param_key($query_param_key)
6031
+	{
6032
+		foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
6033
+			if ($query_param_key === $logic_query_param_key
6034
+				|| strpos($query_param_key, $logic_query_param_key . '*') === 0
6035
+			) {
6036
+				return true;
6037
+			}
6038
+		}
6039
+		return false;
6040
+	}
6041 6041
 
6042 6042
 
6043 6043
 
Please login to merge, or discard this patch.