Completed
Branch FET-9856-direct-instantiation (b60923)
by
unknown
53:33 queued 42:49
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.040');
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.040');
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_classes/EE_Base_Class.class.php 3 patches
Doc Comments   +11 added lines, -10 removed lines patch added patch discarded remove patch
@@ -120,7 +120,7 @@  discard block
 block discarded – undo
120 120
     /**
121 121
      * @param array  $fieldValues
122 122
      * @param string $timezone
123
-     * @param array  $date_formats
123
+     * @param string[]  $date_formats
124 124
      * @return EE_Base_Class
125 125
      * @throws EE_Error
126 126
      */
@@ -684,7 +684,7 @@  discard block
 block discarded – undo
684 684
      *
685 685
      * @param \EE_Datetime_Field $datetime_field
686 686
      * @param bool               $pretty
687
-     * @param null $date_or_time
687
+     * @param string|null $date_or_time
688 688
      * @return void
689 689
      * @throws EE_Error
690 690
      */
@@ -1023,7 +1023,7 @@  discard block
 block discarded – undo
1023 1023
      *
1024 1024
      * @param null  $field_to_order_by  What field is being used as the reference point.
1025 1025
      * @param array $query_params       Any additional conditions on the query.
1026
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
1026
+     * @param string  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
1027 1027
      *                                  you can indicate just the columns you want returned
1028 1028
      * @return array|EE_Base_Class
1029 1029
      * @throws EE_Error
@@ -1049,7 +1049,7 @@  discard block
 block discarded – undo
1049 1049
      *
1050 1050
      * @param null  $field_to_order_by  What field is being used as the reference point.
1051 1051
      * @param array $query_params       Any additional conditions on the query.
1052
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
1052
+     * @param string  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
1053 1053
      *                                  you can indicate just the column you want returned
1054 1054
      * @return array|EE_Base_Class
1055 1055
      * @throws EE_Error
@@ -1123,7 +1123,7 @@  discard block
 block discarded – undo
1123 1123
      * This method simply returns the RAW unprocessed value for the given property in this class
1124 1124
      *
1125 1125
      * @param  string $field_name A valid fieldname
1126
-     * @return mixed              Whatever the raw value stored on the property is.
1126
+     * @return integer|null              Whatever the raw value stored on the property is.
1127 1127
      * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
1128 1128
      */
1129 1129
     public function get_raw($field_name)
@@ -1401,7 +1401,7 @@  discard block
 block discarded – undo
1401 1401
      * sets the time on a datetime property
1402 1402
      *
1403 1403
      * @access protected
1404
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
1404
+     * @param string $time      a valid time string for php datetime functions (or DateTime object)
1405 1405
      * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
1406 1406
      * @throws EE_Error
1407 1407
      */
@@ -1416,7 +1416,7 @@  discard block
 block discarded – undo
1416 1416
      * sets the date on a datetime property
1417 1417
      *
1418 1418
      * @access protected
1419
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
1419
+     * @param string $date      a valid date string for php datetime functions ( or DateTime object)
1420 1420
      * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
1421 1421
      * @throws EE_Error
1422 1422
      */
@@ -1479,6 +1479,7 @@  discard block
 block discarded – undo
1479 1479
      * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
1480 1480
      * @param string               $prepend    You can include something to prepend on the timestamp
1481 1481
      * @param string               $append     You can include something to append on the timestamp
1482
+     * @param string $args
1482 1483
      * @throws EE_Error
1483 1484
      * @return string timestamp
1484 1485
      */
@@ -1880,7 +1881,7 @@  discard block
 block discarded – undo
1880 1881
      *
1881 1882
      * @param  array  $props_n_values   incoming array of properties and their values
1882 1883
      * @param  string $classname        the classname of the child class
1883
-     * @param null    $timezone
1884
+     * @param string    $timezone
1884 1885
      * @param array   $date_formats     incoming date_formats in an array where the first value is the
1885 1886
      *                                  date_format and the second value is the time format
1886 1887
      * @return mixed (EE_Base_Class|bool)
@@ -1959,7 +1960,7 @@  discard block
 block discarded – undo
1959 1960
      * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
1960 1961
      *
1961 1962
      * @param string $model_classname
1962
-     * @param null   $timezone
1963
+     * @param string|null   $timezone
1963 1964
      * @return EEM_Base
1964 1965
      */
1965 1966
     protected static function _get_model_instance_with_name($model_classname, $timezone = null)
@@ -2461,7 +2462,7 @@  discard block
 block discarded – undo
2461 2462
      *
2462 2463
      * @param string $meta_key
2463 2464
      * @param mixed  $meta_value
2464
-     * @param mixed  $previous_value
2465
+     * @param boolean  $previous_value
2465 2466
      * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
2466 2467
      * @throws EE_Error
2467 2468
      * NOTE: if the values haven't changed, returns 0
Please login to merge, or discard this patch.
Indentation   +2766 added lines, -2766 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 do_action('AHEE_log', __FILE__, ' FILE LOADED', '');
5 5
 
@@ -25,2771 +25,2771 @@  discard block
 block discarded – undo
25 25
 abstract class EE_Base_Class
26 26
 {
27 27
 
28
-    /**
29
-     * This is an array of the original properties and values provided during construction
30
-     * of this model object. (keys are model field names, values are their values).
31
-     * This list is important to remember so that when we are merging data from the db, we know
32
-     * which values to override and which to not override.
33
-     *
34
-     * @var array
35
-     */
36
-    protected $_props_n_values_provided_in_constructor;
37
-
38
-    /**
39
-     * Timezone
40
-     * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
41
-     * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
42
-     * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
43
-     * access to it.
44
-     *
45
-     * @var string
46
-     */
47
-    protected $_timezone;
48
-
49
-
50
-
51
-    /**
52
-     * date format
53
-     * pattern or format for displaying dates
54
-     *
55
-     * @var string $_dt_frmt
56
-     */
57
-    protected $_dt_frmt;
58
-
59
-
60
-
61
-    /**
62
-     * time format
63
-     * pattern or format for displaying time
64
-     *
65
-     * @var string $_tm_frmt
66
-     */
67
-    protected $_tm_frmt;
68
-
69
-
70
-
71
-    /**
72
-     * This property is for holding a cached array of object properties indexed by property name as the key.
73
-     * The purpose of this is for setting a cache on properties that may have calculated values after a
74
-     * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
75
-     * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
76
-     *
77
-     * @var array
78
-     */
79
-    protected $_cached_properties = array();
80
-
81
-    /**
82
-     * An array containing keys of the related model, and values are either an array of related mode objects or a
83
-     * single
84
-     * related model object. see the model's _model_relations. The keys should match those specified. And if the
85
-     * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
86
-     * all others have an array)
87
-     *
88
-     * @var array
89
-     */
90
-    protected $_model_relations = array();
91
-
92
-    /**
93
-     * Array where keys are field names (see the model's _fields property) and values are their values. To see what
94
-     * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
95
-     *
96
-     * @var array
97
-     */
98
-    protected $_fields = array();
99
-
100
-    /**
101
-     * @var boolean indicating whether or not this model object is intended to ever be saved
102
-     * For example, we might create model objects intended to only be used for the duration
103
-     * of this request and to be thrown away, and if they were accidentally saved
104
-     * it would be a bug.
105
-     */
106
-    protected $_allow_persist = true;
107
-
108
-    /**
109
-     * @var boolean indicating whether or not this model object's properties have changed since construction
110
-     */
111
-    protected $_has_changes = false;
112
-
113
-    /**
114
-     * @var EEM_Base
115
-     */
116
-    protected $_model;
117
-
118
-
119
-
120
-    /**
121
-     * @param array  $fieldValues
122
-     * @param string $timezone
123
-     * @param array  $date_formats
124
-     * @return EE_Base_Class
125
-     * @throws EE_Error
126
-     */
127
-    public static function new_instance($fieldValues = array(), $timezone = '', $date_formats = array() ) {
128
-        return self::static_constructor((array) $fieldValues, false, $timezone,  $date_formats);
129
-    }
130
-
131
-
132
-
133
-    /**
134
-     * @deprecated
135
-     * @param array  $fieldValues
136
-     * @param string $timezone
137
-     * @return EE_Base_Class
138
-     * @throws EE_Error
139
-     */
140
-    public static function new_instance_from_db($fieldValues = array(), $timezone = '') {
141
-        return self::static_constructor((array) $fieldValues, true, $timezone);
142
-    }
143
-
144
-
145
-
146
-    /**
147
-     * @param array  $fieldValues
148
-     * @param bool   $from_db
149
-     * @param string $timezone
150
-     * @param array  $date_formats
151
-     * @return EE_Base_Class
152
-     * @throws EE_Error
153
-     */
154
-    public static function static_constructor(
155
-        array $fieldValues = array(),
156
-        $from_db = false,
157
-        $timezone = '',
158
-        array $date_formats = array()
159
-    ) {
160
-        $className = get_called_class();
161
-        if (! $from_db) {
162
-            $cached_object = EE_Base_Class::_check_for_object(
163
-                $fieldValues,
164
-                $className,
165
-                $timezone,
166
-                $date_formats
167
-            );
168
-            if ($cached_object) {
169
-                return $cached_object;
170
-            }
171
-        }
172
-        return new $className($fieldValues, $from_db, $timezone, $date_formats);
173
-    }
174
-
175
-
176
-
177
-    /**
178
-     * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children play nice
179
-     *
180
-     * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
181
-     *                                                         layer of the model's _fields array, (eg, EVT_ID,
182
-     *                                                         TXN_amount, QST_name, etc) and values are their values
183
-     * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
184
-     *                                                         corresponding db model or not.
185
-     * @param string  $timezone                                indicate what timezone you want any datetime fields to
186
-     *                                                         be in when instantiating a EE_Base_Class object.
187
-     * @param array   $date_formats                            An array of date formats to set on construct where first
188
-     *                                                         value is the date_format and second value is the time
189
-     *                                                         format.
190
-     * @throws EE_Error
191
-     */
192
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
193
-    {
194
-        $className = get_class($this);
195
-        do_action("AHEE__{$className}__construct", $this, $fieldValues);
196
-        $model = $this->get_model();
197
-        $model_fields = $model->field_settings(false);
198
-        // ensure $fieldValues is an array
199
-        $fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
200
-        // EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
201
-        // verify client code has not passed any invalid field names
202
-        foreach ($fieldValues as $field_name => $field_value) {
203
-            if ( ! isset($model_fields[$field_name])) {
204
-                throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
205
-                    "event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
206
-            }
207
-        }
208
-        // EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
209
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
210
-        if ( ! empty($date_formats) && is_array($date_formats)) {
211
-            list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
212
-        } else {
213
-            //set default formats for date and time
214
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
215
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
216
-        }
217
-        //if db model is instantiating
218
-        if ($bydb) {
219
-            //client code has indicated these field values are from the database
220
-            foreach ($model_fields as $fieldName => $field) {
221
-                $this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
222
-            }
223
-        } else {
224
-            //we're constructing a brand
225
-            //new instance of the model object. Generally, this means we'll need to do more field validation
226
-            foreach ($model_fields as $fieldName => $field) {
227
-                $this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
228
-            }
229
-        }
230
-        //remember what values were passed to this constructor
231
-        $this->_props_n_values_provided_in_constructor = $fieldValues;
232
-        //remember in entity mapper
233
-        if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
234
-            $model->add_to_entity_map($this);
235
-        }
236
-        //setup all the relations
237
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
238
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
239
-                $this->_model_relations[$relation_name] = null;
240
-            } else {
241
-                $this->_model_relations[$relation_name] = array();
242
-            }
243
-        }
244
-        /**
245
-         * Action done at the end of each model object construction
246
-         *
247
-         * @param EE_Base_Class $this the model object just created
248
-         */
249
-        do_action('AHEE__EE_Base_Class__construct__finished', $this);
250
-    }
251
-
252
-
253
-
254
-    /**
255
-     * Gets whether or not this model object is allowed to persist/be saved to the database.
256
-     *
257
-     * @return boolean
258
-     */
259
-    public function allow_persist()
260
-    {
261
-        return $this->_allow_persist;
262
-    }
263
-
264
-
265
-
266
-    /**
267
-     * Sets whether or not this model object should be allowed to be saved to the DB.
268
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
269
-     * you got new information that somehow made you change your mind.
270
-     *
271
-     * @param boolean $allow_persist
272
-     * @return boolean
273
-     */
274
-    public function set_allow_persist($allow_persist)
275
-    {
276
-        return $this->_allow_persist = $allow_persist;
277
-    }
278
-
279
-
280
-
281
-    /**
282
-     * Gets the field's original value when this object was constructed during this request.
283
-     * This can be helpful when determining if a model object has changed or not
284
-     *
285
-     * @param string $field_name
286
-     * @return mixed|null
287
-     * @throws EE_Error
288
-     */
289
-    public function get_original($field_name)
290
-    {
291
-        if (isset($this->_props_n_values_provided_in_constructor[$field_name])
292
-            && $field_settings = $this->get_model()->field_settings_for($field_name)
293
-        ) {
294
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
295
-        } else {
296
-            return null;
297
-        }
298
-    }
299
-
300
-
301
-
302
-    /**
303
-     * @param EE_Base_Class $obj
304
-     * @return string
305
-     */
306
-    public function get_class($obj)
307
-    {
308
-        return get_class($obj);
309
-    }
310
-
311
-
312
-
313
-    /**
314
-     * Overrides parent because parent expects old models.
315
-     * This also doesn't do any validation, and won't work for serialized arrays
316
-     *
317
-     * @param    string $field_name
318
-     * @param    mixed  $field_value
319
-     * @param bool      $use_default
320
-     * @throws EE_Error
321
-     */
322
-    public function set($field_name, $field_value, $use_default = false)
323
-    {
324
-        // if not using default and nothing has changed, and object has already been setup (has ID),
325
-        // then don't do anything
326
-        if (
327
-            ! $use_default
328
-            && $this->_fields[$field_name] === $field_value
329
-            && $this->ID()
330
-        ) {
331
-            return;
332
-        }
333
-        $model = $this->get_model();
334
-        $this->_has_changes = true;
335
-        $field_obj = $model->field_settings_for($field_name);
336
-        if ($field_obj instanceof EE_Model_Field_Base) {
337
-            //			if ( method_exists( $field_obj, 'set_timezone' )) {
338
-            if ($field_obj instanceof EE_Datetime_Field) {
339
-                $field_obj->set_timezone($this->_timezone);
340
-                $field_obj->set_date_format($this->_dt_frmt);
341
-                $field_obj->set_time_format($this->_tm_frmt);
342
-            }
343
-            $holder_of_value = $field_obj->prepare_for_set($field_value);
344
-            //should the value be null?
345
-            if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
346
-                $this->_fields[$field_name] = $field_obj->get_default_value();
347
-                /**
348
-                 * To save having to refactor all the models, if a default value is used for a
349
-                 * EE_Datetime_Field, and that value is not null nor is it a DateTime
350
-                 * object.  Then let's do a set again to ensure that it becomes a DateTime
351
-                 * object.
352
-                 *
353
-                 * @since 4.6.10+
354
-                 */
355
-                if (
356
-                    $field_obj instanceof EE_Datetime_Field
357
-                    && $this->_fields[$field_name] !== null
358
-                    && ! $this->_fields[$field_name] instanceof DateTime
359
-                ) {
360
-                    empty($this->_fields[$field_name])
361
-                        ? $this->set($field_name, time())
362
-                        : $this->set($field_name, $this->_fields[$field_name]);
363
-                }
364
-            } else {
365
-                $this->_fields[$field_name] = $holder_of_value;
366
-            }
367
-            //if we're not in the constructor...
368
-            //now check if what we set was a primary key
369
-            if (
370
-                //note: props_n_values_provided_in_constructor is only set at the END of the constructor
371
-                $this->_props_n_values_provided_in_constructor
372
-                && $field_value
373
-                && $field_name === $model->primary_key_name()
374
-            ) {
375
-                //if so, we want all this object's fields to be filled either with
376
-                //what we've explicitly set on this model
377
-                //or what we have in the db
378
-                // echo "setting primary key!";
379
-                $fields_on_model = self::_get_model(get_class($this))->field_settings();
380
-                $obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
381
-                foreach ($fields_on_model as $field_obj) {
382
-                    if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
383
-                         && $field_obj->get_name() !== $field_name
384
-                    ) {
385
-                        $this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
386
-                    }
387
-                }
388
-                //oh this model object has an ID? well make sure its in the entity mapper
389
-                $model->add_to_entity_map($this);
390
-            }
391
-            //let's unset any cache for this field_name from the $_cached_properties property.
392
-            $this->_clear_cached_property($field_name);
393
-        } else {
394
-            throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
395
-                "event_espresso"), $field_name));
396
-        }
397
-    }
398
-
399
-
400
-
401
-    /**
402
-     * This sets the field value on the db column if it exists for the given $column_name or
403
-     * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
404
-     *
405
-     * @see EE_message::get_column_value for related documentation on the necessity of this method.
406
-     * @param string $field_name  Must be the exact column name.
407
-     * @param mixed  $field_value The value to set.
408
-     * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
409
-     * @throws EE_Error
410
-     */
411
-    public function set_field_or_extra_meta($field_name, $field_value)
412
-    {
413
-        if ($this->get_model()->has_field($field_name)) {
414
-            $this->set($field_name, $field_value);
415
-            return true;
416
-        } else {
417
-            //ensure this object is saved first so that extra meta can be properly related.
418
-            $this->save();
419
-            return $this->update_extra_meta($field_name, $field_value);
420
-        }
421
-    }
422
-
423
-
424
-
425
-    /**
426
-     * This retrieves the value of the db column set on this class or if that's not present
427
-     * it will attempt to retrieve from extra_meta if found.
428
-     * Example Usage:
429
-     * Via EE_Message child class:
430
-     * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
431
-     * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
432
-     * also have additional main fields specific to the messenger.  The system accommodates those extra
433
-     * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
434
-     * value for those extra fields dynamically via the EE_message object.
435
-     *
436
-     * @param  string $field_name expecting the fully qualified field name.
437
-     * @return mixed|null  value for the field if found.  null if not found.
438
-     * @throws EE_Error
439
-     */
440
-    public function get_field_or_extra_meta($field_name)
441
-    {
442
-        if ($this->get_model()->has_field($field_name)) {
443
-            $column_value = $this->get($field_name);
444
-        } else {
445
-            //This isn't a column in the main table, let's see if it is in the extra meta.
446
-            $column_value = $this->get_extra_meta($field_name, true, null);
447
-        }
448
-        return $column_value;
449
-    }
450
-
451
-
452
-
453
-    /**
454
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
455
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
456
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
457
-     * available to all child classes that may be using the EE_Datetime_Field for a field data type.
458
-     *
459
-     * @access public
460
-     * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
461
-     * @return void
462
-     * @throws EE_Error
463
-     */
464
-    public function set_timezone($timezone = '')
465
-    {
466
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
467
-        //make sure we clear all cached properties because they won't be relevant now
468
-        $this->_clear_cached_properties();
469
-        //make sure we update field settings and the date for all EE_Datetime_Fields
470
-        $model_fields = $this->get_model()->field_settings(false);
471
-        foreach ($model_fields as $field_name => $field_obj) {
472
-            if ($field_obj instanceof EE_Datetime_Field) {
473
-                $field_obj->set_timezone($this->_timezone);
474
-                if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
475
-                    $this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
476
-                }
477
-            }
478
-        }
479
-    }
480
-
481
-
482
-
483
-    /**
484
-     * This just returns whatever is set for the current timezone.
485
-     *
486
-     * @access public
487
-     * @return string timezone string
488
-     */
489
-    public function get_timezone()
490
-    {
491
-        return $this->_timezone;
492
-    }
493
-
494
-
495
-
496
-    /**
497
-     * This sets the internal date format to what is sent in to be used as the new default for the class
498
-     * internally instead of wp set date format options
499
-     *
500
-     * @since 4.6
501
-     * @param string $format should be a format recognizable by PHP date() functions.
502
-     */
503
-    public function set_date_format($format)
504
-    {
505
-        $this->_dt_frmt = $format;
506
-        //clear cached_properties because they won't be relevant now.
507
-        $this->_clear_cached_properties();
508
-    }
509
-
510
-
511
-
512
-    /**
513
-     * This sets the internal time format string to what is sent in to be used as the new default for the
514
-     * class internally instead of wp set time format options.
515
-     *
516
-     * @since 4.6
517
-     * @param string $format should be a format recognizable by PHP date() functions.
518
-     */
519
-    public function set_time_format($format)
520
-    {
521
-        $this->_tm_frmt = $format;
522
-        //clear cached_properties because they won't be relevant now.
523
-        $this->_clear_cached_properties();
524
-    }
525
-
526
-
527
-
528
-    /**
529
-     * This returns the current internal set format for the date and time formats.
530
-     *
531
-     * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
532
-     *                             where the first value is the date format and the second value is the time format.
533
-     * @return mixed string|array
534
-     */
535
-    public function get_format($full = true)
536
-    {
537
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
538
-    }
539
-
540
-
541
-
542
-    /**
543
-     * cache
544
-     * stores the passed model object on the current model object.
545
-     * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
546
-     *
547
-     * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
548
-     *                                       'Registration' associated with this model object
549
-     * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
550
-     *                                       that could be a payment or a registration)
551
-     * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
552
-     *                                       items which will be stored in an array on this object
553
-     * @throws EE_Error
554
-     * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
555
-     *                  related thing, no array)
556
-     */
557
-    public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
558
-    {
559
-        // its entirely possible that there IS no related object yet in which case there is nothing to cache.
560
-        if ( ! $object_to_cache instanceof EE_Base_Class) {
561
-            return false;
562
-        }
563
-        // also get "how" the object is related, or throw an error
564
-        if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
565
-            throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
566
-                $relationName, get_class($this)));
567
-        }
568
-        // how many things are related ?
569
-        if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
570
-            // if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
571
-            // so for these model objects just set it to be cached
572
-            $this->_model_relations[$relationName] = $object_to_cache;
573
-            $return = true;
574
-        } else {
575
-            // otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
576
-            // eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
577
-            if ( ! is_array($this->_model_relations[$relationName])) {
578
-                // if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
579
-                $this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
580
-                    ? array($this->_model_relations[$relationName]) : array();
581
-            }
582
-            // first check for a cache_id which is normally empty
583
-            if ( ! empty($cache_id)) {
584
-                // if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
585
-                $this->_model_relations[$relationName][$cache_id] = $object_to_cache;
586
-                $return = $cache_id;
587
-            } elseif ($object_to_cache->ID()) {
588
-                // OR the cached object originally came from the db, so let's just use it's PK for an ID
589
-                $this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
590
-                $return = $object_to_cache->ID();
591
-            } else {
592
-                // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
593
-                $this->_model_relations[$relationName][] = $object_to_cache;
594
-                // move the internal pointer to the end of the array
595
-                end($this->_model_relations[$relationName]);
596
-                // and grab the key so that we can return it
597
-                $return = key($this->_model_relations[$relationName]);
598
-            }
599
-        }
600
-        return $return;
601
-    }
602
-
603
-
604
-
605
-    /**
606
-     * For adding an item to the cached_properties property.
607
-     *
608
-     * @access protected
609
-     * @param string      $fieldname the property item the corresponding value is for.
610
-     * @param mixed       $value     The value we are caching.
611
-     * @param string|null $cache_type
612
-     * @return void
613
-     * @throws EE_Error
614
-     */
615
-    protected function _set_cached_property($fieldname, $value, $cache_type = null)
616
-    {
617
-        //first make sure this property exists
618
-        $this->get_model()->field_settings_for($fieldname);
619
-        $cache_type = empty($cache_type) ? 'standard' : $cache_type;
620
-        $this->_cached_properties[$fieldname][$cache_type] = $value;
621
-    }
622
-
623
-
624
-
625
-    /**
626
-     * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
627
-     * This also SETS the cache if we return the actual property!
628
-     *
629
-     * @param string $fieldname        the name of the property we're trying to retrieve
630
-     * @param bool   $pretty
631
-     * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
632
-     *                                 (in cases where the same property may be used for different outputs
633
-     *                                 - i.e. datetime, money etc.)
634
-     *                                 It can also accept certain pre-defined "schema" strings
635
-     *                                 to define how to output the property.
636
-     *                                 see the field's prepare_for_pretty_echoing for what strings can be used
637
-     * @return mixed                   whatever the value for the property is we're retrieving
638
-     * @throws EE_Error
639
-     */
640
-    protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
641
-    {
642
-        //verify the field exists
643
-        $model = $this->get_model();
644
-        $model->field_settings_for($fieldname);
645
-        $cache_type = $pretty ? 'pretty' : 'standard';
646
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
647
-        if (isset($this->_cached_properties[$fieldname][$cache_type])) {
648
-            return $this->_cached_properties[$fieldname][$cache_type];
649
-        }
650
-        $value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
651
-        $this->_set_cached_property($fieldname, $value, $cache_type);
652
-        return $value;
653
-    }
654
-
655
-
656
-
657
-    /**
658
-     * If the cache didn't fetch the needed item, this fetches it.
659
-     * @param string $fieldname
660
-     * @param bool $pretty
661
-     * @param string $extra_cache_ref
662
-     * @return mixed
663
-     */
664
-    protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
665
-    {
666
-        $field_obj = $this->get_model()->field_settings_for($fieldname);
667
-        // If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
668
-        if ($field_obj instanceof EE_Datetime_Field) {
669
-            $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
670
-        }
671
-        if ( ! isset($this->_fields[$fieldname])) {
672
-            $this->_fields[$fieldname] = null;
673
-        }
674
-        $value = $pretty
675
-            ? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
676
-            : $field_obj->prepare_for_get($this->_fields[$fieldname]);
677
-        return $value;
678
-    }
679
-
680
-
681
-
682
-    /**
683
-     * set timezone, formats, and output for EE_Datetime_Field objects
684
-     *
685
-     * @param \EE_Datetime_Field $datetime_field
686
-     * @param bool               $pretty
687
-     * @param null $date_or_time
688
-     * @return void
689
-     * @throws EE_Error
690
-     */
691
-    protected function _prepare_datetime_field(
692
-        EE_Datetime_Field $datetime_field,
693
-        $pretty = false,
694
-        $date_or_time = null
695
-    ) {
696
-        $datetime_field->set_timezone($this->_timezone);
697
-        $datetime_field->set_date_format($this->_dt_frmt, $pretty);
698
-        $datetime_field->set_time_format($this->_tm_frmt, $pretty);
699
-        //set the output returned
700
-        switch ($date_or_time) {
701
-            case 'D' :
702
-                $datetime_field->set_date_time_output('date');
703
-                break;
704
-            case 'T' :
705
-                $datetime_field->set_date_time_output('time');
706
-                break;
707
-            default :
708
-                $datetime_field->set_date_time_output();
709
-        }
710
-    }
711
-
712
-
713
-
714
-    /**
715
-     * This just takes care of clearing out the cached_properties
716
-     *
717
-     * @return void
718
-     */
719
-    protected function _clear_cached_properties()
720
-    {
721
-        $this->_cached_properties = array();
722
-    }
723
-
724
-
725
-
726
-    /**
727
-     * This just clears out ONE property if it exists in the cache
728
-     *
729
-     * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
730
-     * @return void
731
-     */
732
-    protected function _clear_cached_property($property_name)
733
-    {
734
-        if (isset($this->_cached_properties[$property_name])) {
735
-            unset($this->_cached_properties[$property_name]);
736
-        }
737
-    }
738
-
739
-
740
-
741
-    /**
742
-     * Ensures that this related thing is a model object.
743
-     *
744
-     * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
745
-     * @param string $model_name   name of the related thing, eg 'Attendee',
746
-     * @return EE_Base_Class
747
-     * @throws EE_Error
748
-     */
749
-    protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
750
-    {
751
-        $other_model_instance = self::_get_model_instance_with_name(
752
-            self::_get_model_classname($model_name),
753
-            $this->_timezone
754
-        );
755
-        return $other_model_instance->ensure_is_obj($object_or_id);
756
-    }
757
-
758
-
759
-
760
-    /**
761
-     * Forgets the cached model of the given relation Name. So the next time we request it,
762
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
763
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
764
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
765
-     *
766
-     * @param string $relationName                         one of the keys in the _model_relations array on the model.
767
-     *                                                     Eg 'Registration'
768
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
769
-     *                                                     if you intend to use $clear_all = TRUE, or the relation only
770
-     *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
771
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if
772
-     *                                                     this is HasMany or HABTM.
773
-     * @throws EE_Error
774
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
775
-     *                       relation from all
776
-     */
777
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
778
-    {
779
-        $relationship_to_model = $this->get_model()->related_settings_for($relationName);
780
-        $index_in_cache = '';
781
-        if ( ! $relationship_to_model) {
782
-            throw new EE_Error(
783
-                sprintf(
784
-                    __("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
785
-                    $relationName,
786
-                    get_class($this)
787
-                )
788
-            );
789
-        }
790
-        if ($clear_all) {
791
-            $obj_removed = true;
792
-            $this->_model_relations[$relationName] = null;
793
-        } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
794
-            $obj_removed = $this->_model_relations[$relationName];
795
-            $this->_model_relations[$relationName] = null;
796
-        } else {
797
-            if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
798
-                && $object_to_remove_or_index_into_array->ID()
799
-            ) {
800
-                $index_in_cache = $object_to_remove_or_index_into_array->ID();
801
-                if (is_array($this->_model_relations[$relationName])
802
-                    && ! isset($this->_model_relations[$relationName][$index_in_cache])
803
-                ) {
804
-                    $index_found_at = null;
805
-                    //find this object in the array even though it has a different key
806
-                    foreach ($this->_model_relations[$relationName] as $index => $obj) {
807
-                        if (
808
-                            $obj instanceof EE_Base_Class
809
-                            && (
810
-                                $obj == $object_to_remove_or_index_into_array
811
-                                || $obj->ID() === $object_to_remove_or_index_into_array->ID()
812
-                            )
813
-                        ) {
814
-                            $index_found_at = $index;
815
-                            break;
816
-                        }
817
-                    }
818
-                    if ($index_found_at) {
819
-                        $index_in_cache = $index_found_at;
820
-                    } else {
821
-                        //it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
822
-                        //if it wasn't in it to begin with. So we're done
823
-                        return $object_to_remove_or_index_into_array;
824
-                    }
825
-                }
826
-            } elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
827
-                //so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
828
-                foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
829
-                    if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
830
-                        $index_in_cache = $index;
831
-                    }
832
-                }
833
-            } else {
834
-                $index_in_cache = $object_to_remove_or_index_into_array;
835
-            }
836
-            //supposedly we've found it. But it could just be that the client code
837
-            //provided a bad index/object
838
-            if (
839
-            isset(
840
-                $this->_model_relations[$relationName],
841
-                $this->_model_relations[$relationName][$index_in_cache]
842
-            )
843
-            ) {
844
-                $obj_removed = $this->_model_relations[$relationName][$index_in_cache];
845
-                unset($this->_model_relations[$relationName][$index_in_cache]);
846
-            } else {
847
-                //that thing was never cached anyways.
848
-                $obj_removed = null;
849
-            }
850
-        }
851
-        return $obj_removed;
852
-    }
853
-
854
-
855
-
856
-    /**
857
-     * update_cache_after_object_save
858
-     * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
859
-     * obtained after being saved to the db
860
-     *
861
-     * @param string        $relationName       - the type of object that is cached
862
-     * @param EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
863
-     * @param string        $current_cache_id   - the ID that was used when originally caching the object
864
-     * @return boolean TRUE on success, FALSE on fail
865
-     * @throws EE_Error
866
-     */
867
-    public function update_cache_after_object_save(
868
-        $relationName,
869
-        EE_Base_Class $newly_saved_object,
870
-        $current_cache_id = ''
871
-    ) {
872
-        // verify that incoming object is of the correct type
873
-        $obj_class = 'EE_' . $relationName;
874
-        if ($newly_saved_object instanceof $obj_class) {
875
-            /* @type EE_Base_Class $newly_saved_object */
876
-            // now get the type of relation
877
-            $relationship_to_model = $this->get_model()->related_settings_for($relationName);
878
-            // if this is a 1:1 relationship
879
-            if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
880
-                // then just replace the cached object with the newly saved object
881
-                $this->_model_relations[$relationName] = $newly_saved_object;
882
-                return true;
883
-                // or if it's some kind of sordid feral polyamorous relationship...
884
-            } elseif (is_array($this->_model_relations[$relationName])
885
-                      && isset($this->_model_relations[$relationName][$current_cache_id])
886
-            ) {
887
-                // then remove the current cached item
888
-                unset($this->_model_relations[$relationName][$current_cache_id]);
889
-                // and cache the newly saved object using it's new ID
890
-                $this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
891
-                return true;
892
-            }
893
-        }
894
-        return false;
895
-    }
896
-
897
-
898
-
899
-    /**
900
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
901
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
902
-     *
903
-     * @param string $relationName
904
-     * @return EE_Base_Class
905
-     */
906
-    public function get_one_from_cache($relationName)
907
-    {
908
-        $cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
909
-            : null;
910
-        if (is_array($cached_array_or_object)) {
911
-            return array_shift($cached_array_or_object);
912
-        } else {
913
-            return $cached_array_or_object;
914
-        }
915
-    }
916
-
917
-
918
-
919
-    /**
920
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
921
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
922
-     *
923
-     * @param string $relationName
924
-     * @throws EE_Error
925
-     * @return EE_Base_Class[] NOT necessarily indexed by primary keys
926
-     */
927
-    public function get_all_from_cache($relationName)
928
-    {
929
-        $objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
930
-        // if the result is not an array, but exists, make it an array
931
-        $objects = is_array($objects) ? $objects : array($objects);
932
-        //bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
933
-        //basically, if this model object was stored in the session, and these cached model objects
934
-        //already have IDs, let's make sure they're in their model's entity mapper
935
-        //otherwise we will have duplicates next time we call
936
-        // EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
937
-        $model = EE_Registry::instance()->load_model($relationName);
938
-        foreach ($objects as $model_object) {
939
-            if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
940
-                //ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
941
-                if ($model_object->ID()) {
942
-                    $model->add_to_entity_map($model_object);
943
-                }
944
-            } else {
945
-                throw new EE_Error(
946
-                    sprintf(
947
-                        __(
948
-                            'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
949
-                            'event_espresso'
950
-                        ),
951
-                        $relationName,
952
-                        gettype($model_object)
953
-                    )
954
-                );
955
-            }
956
-        }
957
-        return $objects;
958
-    }
959
-
960
-
961
-
962
-    /**
963
-     * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
964
-     * matching the given query conditions.
965
-     *
966
-     * @param null  $field_to_order_by  What field is being used as the reference point.
967
-     * @param int   $limit              How many objects to return.
968
-     * @param array $query_params       Any additional conditions on the query.
969
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
970
-     *                                  you can indicate just the columns you want returned
971
-     * @return array|EE_Base_Class[]
972
-     * @throws EE_Error
973
-     */
974
-    public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
975
-    {
976
-        $model = $this->get_model();
977
-        $field = empty($field_to_order_by) && $model->has_primary_key_field()
978
-            ? $model->get_primary_key_field()->get_name()
979
-            : $field_to_order_by;
980
-        $current_value = ! empty($field) ? $this->get($field) : null;
981
-        if (empty($field) || empty($current_value)) {
982
-            return array();
983
-        }
984
-        return $model->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
985
-    }
986
-
987
-
988
-
989
-    /**
990
-     * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
991
-     * matching the given query conditions.
992
-     *
993
-     * @param null  $field_to_order_by  What field is being used as the reference point.
994
-     * @param int   $limit              How many objects to return.
995
-     * @param array $query_params       Any additional conditions on the query.
996
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
997
-     *                                  you can indicate just the columns you want returned
998
-     * @return array|EE_Base_Class[]
999
-     * @throws EE_Error
1000
-     */
1001
-    public function previous_x(
1002
-        $field_to_order_by = null,
1003
-        $limit = 1,
1004
-        $query_params = array(),
1005
-        $columns_to_select = null
1006
-    ) {
1007
-        $model = $this->get_model();
1008
-        $field = empty($field_to_order_by) && $model->has_primary_key_field()
1009
-            ? $model->get_primary_key_field()->get_name()
1010
-            : $field_to_order_by;
1011
-        $current_value = ! empty($field) ? $this->get($field) : null;
1012
-        if (empty($field) || empty($current_value)) {
1013
-            return array();
1014
-        }
1015
-        return $model->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
1016
-    }
1017
-
1018
-
1019
-
1020
-    /**
1021
-     * Returns the next EE_Base_Class object in sequence from this object as found in the database
1022
-     * matching the given query conditions.
1023
-     *
1024
-     * @param null  $field_to_order_by  What field is being used as the reference point.
1025
-     * @param array $query_params       Any additional conditions on the query.
1026
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
1027
-     *                                  you can indicate just the columns you want returned
1028
-     * @return array|EE_Base_Class
1029
-     * @throws EE_Error
1030
-     */
1031
-    public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
1032
-    {
1033
-        $model = $this->get_model();
1034
-        $field = empty($field_to_order_by) && $model->has_primary_key_field()
1035
-            ? $model->get_primary_key_field()->get_name()
1036
-            : $field_to_order_by;
1037
-        $current_value = ! empty($field) ? $this->get($field) : null;
1038
-        if (empty($field) || empty($current_value)) {
1039
-            return array();
1040
-        }
1041
-        return $model->next($current_value, $field, $query_params, $columns_to_select);
1042
-    }
1043
-
1044
-
1045
-
1046
-    /**
1047
-     * Returns the previous EE_Base_Class object in sequence from this object as found in the database
1048
-     * matching the given query conditions.
1049
-     *
1050
-     * @param null  $field_to_order_by  What field is being used as the reference point.
1051
-     * @param array $query_params       Any additional conditions on the query.
1052
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
1053
-     *                                  you can indicate just the column you want returned
1054
-     * @return array|EE_Base_Class
1055
-     * @throws EE_Error
1056
-     */
1057
-    public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
1058
-    {
1059
-        $model = $this->get_model();
1060
-        $field = empty($field_to_order_by) && $model->has_primary_key_field()
1061
-            ? $model->get_primary_key_field()->get_name()
1062
-            : $field_to_order_by;
1063
-        $current_value = ! empty($field) ? $this->get($field) : null;
1064
-        if (empty($field) || empty($current_value)) {
1065
-            return array();
1066
-        }
1067
-        return $model->previous($current_value, $field, $query_params, $columns_to_select);
1068
-    }
1069
-
1070
-
1071
-
1072
-    /**
1073
-     * Overrides parent because parent expects old models.
1074
-     * This also doesn't do any validation, and won't work for serialized arrays
1075
-     *
1076
-     * @param string $field_name
1077
-     * @param mixed  $field_value_from_db
1078
-     * @throws EE_Error
1079
-     */
1080
-    public function set_from_db($field_name, $field_value_from_db)
1081
-    {
1082
-        $field_obj = $this->get_model()->field_settings_for($field_name);
1083
-        if ($field_obj instanceof EE_Model_Field_Base) {
1084
-            //you would think the DB has no NULLs for non-null label fields right? wrong!
1085
-            //eg, a CPT model object could have an entry in the posts table, but no
1086
-            //entry in the meta table. Meaning that all its columns in the meta table
1087
-            //are null! yikes! so when we find one like that, use defaults for its meta columns
1088
-            if ($field_value_from_db === null) {
1089
-                if ($field_obj->is_nullable()) {
1090
-                    //if the field allows nulls, then let it be null
1091
-                    $field_value = null;
1092
-                } else {
1093
-                    $field_value = $field_obj->get_default_value();
1094
-                }
1095
-            } else {
1096
-                $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
1097
-            }
1098
-            $this->_fields[$field_name] = $field_value;
1099
-            $this->_clear_cached_property($field_name);
1100
-        }
1101
-    }
1102
-
1103
-
1104
-
1105
-    /**
1106
-     * verifies that the specified field is of the correct type
1107
-     *
1108
-     * @param string $field_name
1109
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
1110
-     *                                (in cases where the same property may be used for different outputs
1111
-     *                                - i.e. datetime, money etc.)
1112
-     * @return mixed
1113
-     * @throws EE_Error
1114
-     */
1115
-    public function get($field_name, $extra_cache_ref = null)
1116
-    {
1117
-        return $this->_get_cached_property($field_name, false, $extra_cache_ref);
1118
-    }
1119
-
1120
-
1121
-
1122
-    /**
1123
-     * This method simply returns the RAW unprocessed value for the given property in this class
1124
-     *
1125
-     * @param  string $field_name A valid fieldname
1126
-     * @return mixed              Whatever the raw value stored on the property is.
1127
-     * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
1128
-     */
1129
-    public function get_raw($field_name)
1130
-    {
1131
-        $field_settings = $this->get_model()->field_settings_for($field_name);
1132
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
1133
-            ? $this->_fields[$field_name]->format('U')
1134
-            : $this->_fields[$field_name];
1135
-    }
1136
-
1137
-
1138
-
1139
-    /**
1140
-     * This is used to return the internal DateTime object used for a field that is a
1141
-     * EE_Datetime_Field.
1142
-     *
1143
-     * @param string $field_name               The field name retrieving the DateTime object.
1144
-     * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
1145
-     * @throws EE_Error
1146
-     *                                         an error is set and false returned.  If the field IS an
1147
-     *                                         EE_Datetime_Field and but the field value is null, then
1148
-     *                                         just null is returned (because that indicates that likely
1149
-     *                                         this field is nullable).
1150
-     */
1151
-    public function get_DateTime_object($field_name)
1152
-    {
1153
-        $field_settings = $this->get_model()->field_settings_for($field_name);
1154
-        if ( ! $field_settings instanceof EE_Datetime_Field) {
1155
-            EE_Error::add_error(
1156
-                sprintf(
1157
-                    __(
1158
-                        'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
1159
-                        'event_espresso'
1160
-                    ),
1161
-                    $field_name
1162
-                ),
1163
-                __FILE__,
1164
-                __FUNCTION__,
1165
-                __LINE__
1166
-            );
1167
-            return false;
1168
-        }
1169
-        return $this->_fields[$field_name];
1170
-    }
1171
-
1172
-
1173
-
1174
-    /**
1175
-     * To be used in template to immediately echo out the value, and format it for output.
1176
-     * Eg, should call stripslashes and whatnot before echoing
1177
-     *
1178
-     * @param string $field_name      the name of the field as it appears in the DB
1179
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
1180
-     *                                (in cases where the same property may be used for different outputs
1181
-     *                                - i.e. datetime, money etc.)
1182
-     * @return void
1183
-     * @throws EE_Error
1184
-     */
1185
-    public function e($field_name, $extra_cache_ref = null)
1186
-    {
1187
-        echo $this->get_pretty($field_name, $extra_cache_ref);
1188
-    }
1189
-
1190
-
1191
-
1192
-    /**
1193
-     * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
1194
-     * can be easily used as the value of form input.
1195
-     *
1196
-     * @param string $field_name
1197
-     * @return void
1198
-     * @throws EE_Error
1199
-     */
1200
-    public function f($field_name)
1201
-    {
1202
-        $this->e($field_name, 'form_input');
1203
-    }
1204
-
1205
-
1206
-
1207
-    /**
1208
-     * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
1209
-     * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
1210
-     * to see what options are available.
1211
-     *
1212
-     * @param string $field_name
1213
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
1214
-     *                                (in cases where the same property may be used for different outputs
1215
-     *                                - i.e. datetime, money etc.)
1216
-     * @return mixed
1217
-     * @throws EE_Error
1218
-     */
1219
-    public function get_pretty($field_name, $extra_cache_ref = null)
1220
-    {
1221
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
1222
-    }
1223
-
1224
-
1225
-
1226
-    /**
1227
-     * This simply returns the datetime for the given field name
1228
-     * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
1229
-     * (and the equivalent e_date, e_time, e_datetime).
1230
-     *
1231
-     * @access   protected
1232
-     * @param string   $field_name   Field on the instantiated EE_Base_Class child object
1233
-     * @param string   $dt_frmt      valid datetime format used for date
1234
-     *                               (if '' then we just use the default on the field,
1235
-     *                               if NULL we use the last-used format)
1236
-     * @param string   $tm_frmt      Same as above except this is for time format
1237
-     * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
1238
-     * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
1239
-     * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
1240
-     *                               if field is not a valid dtt field, or void if echoing
1241
-     * @throws EE_Error
1242
-     */
1243
-    protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
1244
-    {
1245
-        // clear cached property
1246
-        $this->_clear_cached_property($field_name);
1247
-        //reset format properties because they are used in get()
1248
-        $this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
1249
-        $this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
1250
-        if ($echo) {
1251
-            $this->e($field_name, $date_or_time);
1252
-            return '';
1253
-        }
1254
-        return $this->get($field_name, $date_or_time);
1255
-    }
1256
-
1257
-
1258
-
1259
-    /**
1260
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
1261
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
1262
-     * other echoes the pretty value for dtt)
1263
-     *
1264
-     * @param  string $field_name name of model object datetime field holding the value
1265
-     * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
1266
-     * @return string            datetime value formatted
1267
-     * @throws EE_Error
1268
-     */
1269
-    public function get_date($field_name, $format = '')
1270
-    {
1271
-        return $this->_get_datetime($field_name, $format, null, 'D');
1272
-    }
1273
-
1274
-
1275
-
1276
-    /**
1277
-     * @param      $field_name
1278
-     * @param string $format
1279
-     * @throws EE_Error
1280
-     */
1281
-    public function e_date($field_name, $format = '')
1282
-    {
1283
-        $this->_get_datetime($field_name, $format, null, 'D', true);
1284
-    }
1285
-
1286
-
1287
-
1288
-    /**
1289
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
1290
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
1291
-     * other echoes the pretty value for dtt)
1292
-     *
1293
-     * @param  string $field_name name of model object datetime field holding the value
1294
-     * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
1295
-     * @return string             datetime value formatted
1296
-     * @throws EE_Error
1297
-     */
1298
-    public function get_time($field_name, $format = '')
1299
-    {
1300
-        return $this->_get_datetime($field_name, null, $format, 'T');
1301
-    }
1302
-
1303
-
1304
-
1305
-    /**
1306
-     * @param      $field_name
1307
-     * @param string $format
1308
-     * @throws EE_Error
1309
-     */
1310
-    public function e_time($field_name, $format = '')
1311
-    {
1312
-        $this->_get_datetime($field_name, null, $format, 'T', true);
1313
-    }
1314
-
1315
-
1316
-
1317
-    /**
1318
-     * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
1319
-     * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
1320
-     * other echoes the pretty value for dtt)
1321
-     *
1322
-     * @param  string $field_name name of model object datetime field holding the value
1323
-     * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
1324
-     * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
1325
-     * @return string             datetime value formatted
1326
-     * @throws EE_Error
1327
-     */
1328
-    public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
1329
-    {
1330
-        return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
1331
-    }
1332
-
1333
-
1334
-
1335
-    /**
1336
-     * @param string $field_name
1337
-     * @param string $dt_frmt
1338
-     * @param string $tm_frmt
1339
-     * @throws EE_Error
1340
-     */
1341
-    public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
1342
-    {
1343
-        $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
1344
-    }
1345
-
1346
-
1347
-
1348
-    /**
1349
-     * Get the i8ln value for a date using the WordPress @see date_i18n function.
1350
-     *
1351
-     * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
1352
-     * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
1353
-     *                           on the object will be used.
1354
-     * @return string Date and time string in set locale or false if no field exists for the given
1355
-     * @throws EE_Error
1356
-     *                           field name.
1357
-     */
1358
-    public function get_i18n_datetime($field_name, $format = '')
1359
-    {
1360
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
1361
-        return date_i18n(
1362
-            $format,
1363
-            EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
1364
-        );
1365
-    }
1366
-
1367
-
1368
-
1369
-    /**
1370
-     * This method validates whether the given field name is a valid field on the model object as well as it is of a
1371
-     * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
1372
-     * thrown.
1373
-     *
1374
-     * @param  string $field_name The field name being checked
1375
-     * @throws EE_Error
1376
-     * @return EE_Datetime_Field
1377
-     */
1378
-    protected function _get_dtt_field_settings($field_name)
1379
-    {
1380
-        $field = $this->get_model()->field_settings_for($field_name);
1381
-        //check if field is dtt
1382
-        if ($field instanceof EE_Datetime_Field) {
1383
-            return $field;
1384
-        } else {
1385
-            throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
1386
-                'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
1387
-        }
1388
-    }
1389
-
1390
-
1391
-
1392
-
1393
-    /**
1394
-     * NOTE ABOUT BELOW:
1395
-     * These convenience date and time setters are for setting date and time independently.  In other words you might
1396
-     * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
1397
-     * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
1398
-     * method and make sure you send the entire datetime value for setting.
1399
-     */
1400
-    /**
1401
-     * sets the time on a datetime property
1402
-     *
1403
-     * @access protected
1404
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
1405
-     * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
1406
-     * @throws EE_Error
1407
-     */
1408
-    protected function _set_time_for($time, $fieldname)
1409
-    {
1410
-        $this->_set_date_time('T', $time, $fieldname);
1411
-    }
1412
-
1413
-
1414
-
1415
-    /**
1416
-     * sets the date on a datetime property
1417
-     *
1418
-     * @access protected
1419
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
1420
-     * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
1421
-     * @throws EE_Error
1422
-     */
1423
-    protected function _set_date_for($date, $fieldname)
1424
-    {
1425
-        $this->_set_date_time('D', $date, $fieldname);
1426
-    }
1427
-
1428
-
1429
-
1430
-    /**
1431
-     * This takes care of setting a date or time independently on a given model object property. This method also
1432
-     * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
1433
-     *
1434
-     * @access protected
1435
-     * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
1436
-     * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
1437
-     * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
1438
-     *                                        EE_Datetime_Field property)
1439
-     * @throws EE_Error
1440
-     */
1441
-    protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
1442
-    {
1443
-        $field = $this->_get_dtt_field_settings($fieldname);
1444
-        $field->set_timezone($this->_timezone);
1445
-        $field->set_date_format($this->_dt_frmt);
1446
-        $field->set_time_format($this->_tm_frmt);
1447
-        switch ($what) {
1448
-            case 'T' :
1449
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
1450
-                    $datetime_value,
1451
-                    $this->_fields[$fieldname]
1452
-                );
1453
-                break;
1454
-            case 'D' :
1455
-                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
1456
-                    $datetime_value,
1457
-                    $this->_fields[$fieldname]
1458
-                );
1459
-                break;
1460
-            case 'B' :
1461
-                $this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
1462
-                break;
1463
-        }
1464
-        $this->_clear_cached_property($fieldname);
1465
-    }
1466
-
1467
-
1468
-
1469
-    /**
1470
-     * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
1471
-     * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
1472
-     * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
1473
-     * that could lead to some unexpected results!
1474
-     *
1475
-     * @access public
1476
-     * @param string               $field_name This is the name of the field on the object that contains the date/time
1477
-     *                                         value being returned.
1478
-     * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
1479
-     * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
1480
-     * @param string               $prepend    You can include something to prepend on the timestamp
1481
-     * @param string               $append     You can include something to append on the timestamp
1482
-     * @throws EE_Error
1483
-     * @return string timestamp
1484
-     */
1485
-    public function display_in_my_timezone(
1486
-        $field_name,
1487
-        $callback = 'get_datetime',
1488
-        $args = null,
1489
-        $prepend = '',
1490
-        $append = ''
1491
-    ) {
1492
-        $timezone = EEH_DTT_Helper::get_timezone();
1493
-        if ($timezone === $this->_timezone) {
1494
-            return '';
1495
-        }
1496
-        $original_timezone = $this->_timezone;
1497
-        $this->set_timezone($timezone);
1498
-        $fn = (array)$field_name;
1499
-        $args = array_merge($fn, (array)$args);
1500
-        if ( ! method_exists($this, $callback)) {
1501
-            throw new EE_Error(
1502
-                sprintf(
1503
-                    __(
1504
-                        'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
1505
-                        'event_espresso'
1506
-                    ),
1507
-                    $callback
1508
-                )
1509
-            );
1510
-        }
1511
-        $args = (array)$args;
1512
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
1513
-        $this->set_timezone($original_timezone);
1514
-        return $return;
1515
-    }
1516
-
1517
-
1518
-
1519
-    /**
1520
-     * Deletes this model object.
1521
-     * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
1522
-     * override
1523
-     * `EE_Base_Class::_delete` NOT this class.
1524
-     *
1525
-     * @return boolean | int
1526
-     * @throws EE_Error
1527
-     */
1528
-    public function delete()
1529
-    {
1530
-        /**
1531
-         * Called just before the `EE_Base_Class::_delete` method call.
1532
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
1533
-         * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
1534
-         * soft deletes (trash) the object and does not permanently delete it.
1535
-         *
1536
-         * @param EE_Base_Class $model_object about to be 'deleted'
1537
-         */
1538
-        do_action('AHEE__EE_Base_Class__delete__before', $this);
1539
-        $result = $this->_delete();
1540
-        /**
1541
-         * Called just after the `EE_Base_Class::_delete` method call.
1542
-         * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
1543
-         * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
1544
-         * soft deletes (trash) the object and does not permanently delete it.
1545
-         *
1546
-         * @param EE_Base_Class $model_object that was just 'deleted'
1547
-         * @param boolean       $result
1548
-         */
1549
-        do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
1550
-        return $result;
1551
-    }
1552
-
1553
-
1554
-
1555
-    /**
1556
-     * Calls the specific delete method for the instantiated class.
1557
-     * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
1558
-     * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
1559
-     * `EE_Base_Class::delete`
1560
-     *
1561
-     * @return bool|int
1562
-     * @throws EE_Error
1563
-     */
1564
-    protected function _delete()
1565
-    {
1566
-        return $this->delete_permanently();
1567
-    }
1568
-
1569
-
1570
-
1571
-    /**
1572
-     * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
1573
-     * error)
1574
-     *
1575
-     * @return bool | int
1576
-     * @throws EE_Error
1577
-     */
1578
-    public function delete_permanently()
1579
-    {
1580
-        /**
1581
-         * Called just before HARD deleting a model object
1582
-         *
1583
-         * @param EE_Base_Class $model_object about to be 'deleted'
1584
-         */
1585
-        do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
1586
-        $model = $this->get_model();
1587
-        $result = $model->delete_permanently_by_ID($this->ID());
1588
-        $this->refresh_cache_of_related_objects();
1589
-        /**
1590
-         * Called just after HARD deleting a model object
1591
-         *
1592
-         * @param EE_Base_Class $model_object that was just 'deleted'
1593
-         * @param boolean       $result
1594
-         */
1595
-        do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
1596
-        return $result;
1597
-    }
1598
-
1599
-
1600
-
1601
-    /**
1602
-     * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
1603
-     * related model objects
1604
-     *
1605
-     * @throws EE_Error
1606
-     */
1607
-    public function refresh_cache_of_related_objects()
1608
-    {
1609
-        $model = $this->get_model();
1610
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
1611
-            if ( ! empty($this->_model_relations[$relation_name])) {
1612
-                $related_objects = $this->_model_relations[$relation_name];
1613
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
1614
-                    //this relation only stores a single model object, not an array
1615
-                    //but let's make it consistent
1616
-                    $related_objects = array($related_objects);
1617
-                }
1618
-                foreach ($related_objects as $related_object) {
1619
-                    //only refresh their cache if they're in memory
1620
-                    if ($related_object instanceof EE_Base_Class) {
1621
-                        $related_object->clear_cache($model->get_this_model_name(), $this);
1622
-                    }
1623
-                }
1624
-            }
1625
-        }
1626
-    }
1627
-
1628
-
1629
-
1630
-    /**
1631
-     *        Saves this object to the database. An array may be supplied to set some values on this
1632
-     * object just before saving.
1633
-     *
1634
-     * @access public
1635
-     * @param array $set_cols_n_values keys are field names, values are their new values,
1636
-     *                                 if provided during the save() method (often client code will change the fields'
1637
-     *                                 values before calling save)
1638
-     * @throws EE_Error
1639
-     * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
1640
-     *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
1641
-     */
1642
-    public function save($set_cols_n_values = array())
1643
-    {
1644
-        $model = $this->get_model();
1645
-        /**
1646
-         * Filters the fields we're about to save on the model object
1647
-         *
1648
-         * @param array         $set_cols_n_values
1649
-         * @param EE_Base_Class $model_object
1650
-         */
1651
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
1652
-            $this);
1653
-        //set attributes as provided in $set_cols_n_values
1654
-        foreach ($set_cols_n_values as $column => $value) {
1655
-            $this->set($column, $value);
1656
-        }
1657
-        // no changes ? then don't do anything
1658
-        if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
1659
-            return 0;
1660
-        }
1661
-        /**
1662
-         * Saving a model object.
1663
-         * Before we perform a save, this action is fired.
1664
-         *
1665
-         * @param EE_Base_Class $model_object the model object about to be saved.
1666
-         */
1667
-        do_action('AHEE__EE_Base_Class__save__begin', $this);
1668
-        if ( ! $this->allow_persist()) {
1669
-            return 0;
1670
-        }
1671
-        //now get current attribute values
1672
-        $save_cols_n_values = $this->_fields;
1673
-        //if the object already has an ID, update it. Otherwise, insert it
1674
-        //also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
1675
-        $old_assumption_concerning_value_preparation = $model
1676
-                                                            ->get_assumption_concerning_values_already_prepared_by_model_object();
1677
-        $model->assume_values_already_prepared_by_model_object(true);
1678
-        //does this model have an autoincrement PK?
1679
-        if ($model->has_primary_key_field()) {
1680
-            if ($model->get_primary_key_field()->is_auto_increment()) {
1681
-                //ok check if it's set, if so: update; if not, insert
1682
-                if ( ! empty($save_cols_n_values[$model->primary_key_name()])) {
1683
-                    $results = $model->update_by_ID($save_cols_n_values, $this->ID());
1684
-                } else {
1685
-                    unset($save_cols_n_values[$model->primary_key_name()]);
1686
-                    $results = $model->insert($save_cols_n_values);
1687
-                    if ($results) {
1688
-                        //if successful, set the primary key
1689
-                        //but don't use the normal SET method, because it will check if
1690
-                        //an item with the same ID exists in the mapper & db, then
1691
-                        //will find it in the db (because we just added it) and THAT object
1692
-                        //will get added to the mapper before we can add this one!
1693
-                        //but if we just avoid using the SET method, all that headache can be avoided
1694
-                        $pk_field_name = $model->primary_key_name();
1695
-                        $this->_fields[$pk_field_name] = $results;
1696
-                        $this->_clear_cached_property($pk_field_name);
1697
-                        $model->add_to_entity_map($this);
1698
-                        $this->_update_cached_related_model_objs_fks();
1699
-                    }
1700
-                }
1701
-            } else {//PK is NOT auto-increment
1702
-                //so check if one like it already exists in the db
1703
-                if ($model->exists_by_ID($this->ID())) {
1704
-                    if (WP_DEBUG && ! $this->in_entity_map()) {
1705
-                        throw new EE_Error(
1706
-                            sprintf(
1707
-                                __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
1708
-                                    'event_espresso'),
1709
-                                get_class($this),
1710
-                                get_class($model) . '::instance()->add_to_entity_map()',
1711
-                                get_class($model) . '::instance()->get_one_by_ID()',
1712
-                                '<br />'
1713
-                            )
1714
-                        );
1715
-                    }
1716
-                    $results = $model->update_by_ID($save_cols_n_values, $this->ID());
1717
-                } else {
1718
-                    $results = $model->insert($save_cols_n_values);
1719
-                    $this->_update_cached_related_model_objs_fks();
1720
-                }
1721
-            }
1722
-        } else {//there is NO primary key
1723
-            $already_in_db = false;
1724
-            foreach ($model->unique_indexes() as $index) {
1725
-                $uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
1726
-                if ($model->exists(array($uniqueness_where_params))) {
1727
-                    $already_in_db = true;
1728
-                }
1729
-            }
1730
-            if ($already_in_db) {
1731
-                $combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
1732
-                    $model->get_combined_primary_key_fields());
1733
-                $results = $model->update($save_cols_n_values, $combined_pk_fields_n_values);
1734
-            } else {
1735
-                $results = $model->insert($save_cols_n_values);
1736
-            }
1737
-        }
1738
-        //restore the old assumption about values being prepared by the model object
1739
-        $model
1740
-             ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
1741
-        /**
1742
-         * After saving the model object this action is called
1743
-         *
1744
-         * @param EE_Base_Class $model_object which was just saved
1745
-         * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
1746
-         *                                    the new ID (or 0 if an error occurred and it wasn't updated)
1747
-         */
1748
-        do_action('AHEE__EE_Base_Class__save__end', $this, $results);
1749
-        $this->_has_changes = false;
1750
-        return $results;
1751
-    }
1752
-
1753
-
1754
-
1755
-    /**
1756
-     * Updates the foreign key on related models objects pointing to this to have this model object's ID
1757
-     * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
1758
-     * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
1759
-     * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
1760
-     * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
1761
-     * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
1762
-     * or not they exist in the DB (if they do, their DB records will be automatically updated)
1763
-     *
1764
-     * @return void
1765
-     * @throws EE_Error
1766
-     */
1767
-    protected function _update_cached_related_model_objs_fks()
1768
-    {
1769
-        $model = $this->get_model();
1770
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
1771
-            if ($relation_obj instanceof EE_Has_Many_Relation) {
1772
-                foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
1773
-                    $fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
1774
-                        $model->get_this_model_name()
1775
-                    );
1776
-                    $related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
1777
-                    if ($related_model_obj_in_cache->ID()) {
1778
-                        $related_model_obj_in_cache->save();
1779
-                    }
1780
-                }
1781
-            }
1782
-        }
1783
-    }
1784
-
1785
-
1786
-
1787
-    /**
1788
-     * Saves this model object and its NEW cached relations to the database.
1789
-     * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
1790
-     * In order for that to work, we would need to mark model objects as dirty/clean...
1791
-     * because otherwise, there's a potential for infinite looping of saving
1792
-     * Saves the cached related model objects, and ensures the relation between them
1793
-     * and this object and properly setup
1794
-     *
1795
-     * @return int ID of new model object on save; 0 on failure+
1796
-     * @throws EE_Error
1797
-     */
1798
-    public function save_new_cached_related_model_objs()
1799
-    {
1800
-        //make sure this has been saved
1801
-        if ( ! $this->ID()) {
1802
-            $id = $this->save();
1803
-        } else {
1804
-            $id = $this->ID();
1805
-        }
1806
-        //now save all the NEW cached model objects  (ie they don't exist in the DB)
1807
-        foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
1808
-            if ($this->_model_relations[$relationName]) {
1809
-                //is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
1810
-                //or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
1811
-                if ($relationObj instanceof EE_Belongs_To_Relation) {
1812
-                    //add a relation to that relation type (which saves the appropriate thing in the process)
1813
-                    //but ONLY if it DOES NOT exist in the DB
1814
-                    /* @var $related_model_obj EE_Base_Class */
1815
-                    $related_model_obj = $this->_model_relations[$relationName];
1816
-                    //					if( ! $related_model_obj->ID()){
1817
-                    $this->_add_relation_to($related_model_obj, $relationName);
1818
-                    $related_model_obj->save_new_cached_related_model_objs();
1819
-                    //					}
1820
-                } else {
1821
-                    foreach ($this->_model_relations[$relationName] as $related_model_obj) {
1822
-                        //add a relation to that relation type (which saves the appropriate thing in the process)
1823
-                        //but ONLY if it DOES NOT exist in the DB
1824
-                        //						if( ! $related_model_obj->ID()){
1825
-                        $this->_add_relation_to($related_model_obj, $relationName);
1826
-                        $related_model_obj->save_new_cached_related_model_objs();
1827
-                        //						}
1828
-                    }
1829
-                }
1830
-            }
1831
-        }
1832
-        return $id;
1833
-    }
1834
-
1835
-
1836
-
1837
-    /**
1838
-     * for getting a model while instantiated.
1839
-     *
1840
-     * @return \EEM_Base | \EEM_CPT_Base
1841
-     */
1842
-    public function get_model()
1843
-    {
1844
-        if( ! $this->_model){
1845
-            $modelName = self::_get_model_classname(get_class($this));
1846
-            $this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
1847
-        } else {
1848
-            $this->_model->set_timezone($this->_timezone);
1849
-        }
1850
-
1851
-        return $this->_model;
1852
-    }
1853
-
1854
-
1855
-
1856
-    /**
1857
-     * @param $props_n_values
1858
-     * @param $classname
1859
-     * @return mixed bool|EE_Base_Class|EEM_CPT_Base
1860
-     * @throws EE_Error
1861
-     */
1862
-    protected static function _get_object_from_entity_mapper($props_n_values, $classname)
1863
-    {
1864
-        //TODO: will not work for Term_Relationships because they have no PK!
1865
-        $primary_id_ref = self::_get_primary_key_name($classname);
1866
-        if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
1867
-            $id = $props_n_values[$primary_id_ref];
1868
-            return self::_get_model($classname)->get_from_entity_map($id);
1869
-        }
1870
-        return false;
1871
-    }
1872
-
1873
-
1874
-
1875
-    /**
1876
-     * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
1877
-     * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
1878
-     * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
1879
-     * we return false.
1880
-     *
1881
-     * @param  array  $props_n_values   incoming array of properties and their values
1882
-     * @param  string $classname        the classname of the child class
1883
-     * @param null    $timezone
1884
-     * @param array   $date_formats     incoming date_formats in an array where the first value is the
1885
-     *                                  date_format and the second value is the time format
1886
-     * @return mixed (EE_Base_Class|bool)
1887
-     * @throws EE_Error
1888
-     */
1889
-    protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
1890
-    {
1891
-        $existing = null;
1892
-        $model = self::_get_model($classname, $timezone);
1893
-        if ($model->has_primary_key_field()) {
1894
-            $primary_id_ref = self::_get_primary_key_name($classname);
1895
-            if (array_key_exists($primary_id_ref, $props_n_values)
1896
-                && ! empty($props_n_values[$primary_id_ref])
1897
-            ) {
1898
-                $existing = $model->get_one_by_ID(
1899
-                    $props_n_values[$primary_id_ref]
1900
-                );
1901
-            }
1902
-        } elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
1903
-            //no primary key on this model, but there's still a matching item in the DB
1904
-            $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
1905
-                self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
1906
-            );
1907
-        }
1908
-        if ($existing) {
1909
-            //set date formats if present before setting values
1910
-            if ( ! empty($date_formats) && is_array($date_formats)) {
1911
-                $existing->set_date_format($date_formats[0]);
1912
-                $existing->set_time_format($date_formats[1]);
1913
-            } else {
1914
-                //set default formats for date and time
1915
-                $existing->set_date_format(get_option('date_format'));
1916
-                $existing->set_time_format(get_option('time_format'));
1917
-            }
1918
-            foreach ($props_n_values as $property => $field_value) {
1919
-                $existing->set($property, $field_value);
1920
-            }
1921
-            return $existing;
1922
-        } else {
1923
-            return false;
1924
-        }
1925
-    }
1926
-
1927
-
1928
-
1929
-    /**
1930
-     * Gets the EEM_*_Model for this class
1931
-     *
1932
-     * @access public now, as this is more convenient
1933
-     * @param      $classname
1934
-     * @param null $timezone
1935
-     * @throws EE_Error
1936
-     * @return EEM_Base
1937
-     */
1938
-    protected static function _get_model($classname, $timezone = null)
1939
-    {
1940
-        //find model for this class
1941
-        if ( ! $classname) {
1942
-            throw new EE_Error(
1943
-                sprintf(
1944
-                    __(
1945
-                        "What were you thinking calling _get_model(%s)?? You need to specify the class name",
1946
-                        "event_espresso"
1947
-                    ),
1948
-                    $classname
1949
-                )
1950
-            );
1951
-        }
1952
-        $modelName = self::_get_model_classname($classname);
1953
-        return self::_get_model_instance_with_name($modelName, $timezone);
1954
-    }
1955
-
1956
-
1957
-
1958
-    /**
1959
-     * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
1960
-     *
1961
-     * @param string $model_classname
1962
-     * @param null   $timezone
1963
-     * @return EEM_Base
1964
-     */
1965
-    protected static function _get_model_instance_with_name($model_classname, $timezone = null)
1966
-    {
1967
-        $model_classname = str_replace('EEM_', '', $model_classname);
1968
-        $model = EE_Registry::instance()->load_model($model_classname);
1969
-        $model->set_timezone($timezone);
1970
-        return $model;
1971
-    }
1972
-
1973
-
1974
-
1975
-    /**
1976
-     * If a model name is provided (eg Registration), gets the model classname for that model.
1977
-     * Also works if a model class's classname is provided (eg EE_Registration).
1978
-     *
1979
-     * @param null $model_name
1980
-     * @return string like EEM_Attendee
1981
-     */
1982
-    private static function _get_model_classname($model_name = null)
1983
-    {
1984
-        if (strpos($model_name, "EE_") === 0) {
1985
-            $model_classname = str_replace("EE_", "EEM_", $model_name);
1986
-        } else {
1987
-            $model_classname = "EEM_" . $model_name;
1988
-        }
1989
-        return $model_classname;
1990
-    }
1991
-
1992
-
1993
-
1994
-    /**
1995
-     * returns the name of the primary key attribute
1996
-     *
1997
-     * @param null $classname
1998
-     * @throws EE_Error
1999
-     * @return string
2000
-     */
2001
-    protected static function _get_primary_key_name($classname = null)
2002
-    {
2003
-        if ( ! $classname) {
2004
-            throw new EE_Error(
2005
-                sprintf(
2006
-                    __("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
2007
-                    $classname
2008
-                )
2009
-            );
2010
-        }
2011
-        return self::_get_model($classname)->get_primary_key_field()->get_name();
2012
-    }
2013
-
2014
-
2015
-
2016
-    /**
2017
-     * Gets the value of the primary key.
2018
-     * If the object hasn't yet been saved, it should be whatever the model field's default was
2019
-     * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
2020
-     * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
2021
-     *
2022
-     * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
2023
-     * @throws EE_Error
2024
-     */
2025
-    public function ID()
2026
-    {
2027
-        $model = $this->get_model();
2028
-        //now that we know the name of the variable, use a variable variable to get its value and return its
2029
-        if ($model->has_primary_key_field()) {
2030
-            return $this->_fields[$model->primary_key_name()];
2031
-        } else {
2032
-            return $model->get_index_primary_key_string($this->_fields);
2033
-        }
2034
-    }
2035
-
2036
-
2037
-
2038
-    /**
2039
-     * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
2040
-     * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
2041
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
2042
-     *
2043
-     * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
2044
-     * @param string $relationName                     eg 'Events','Question',etc.
2045
-     *                                                 an attendee to a group, you also want to specify which role they
2046
-     *                                                 will have in that group. So you would use this parameter to
2047
-     *                                                 specify array('role-column-name'=>'role-id')
2048
-     * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
2049
-     *                                                 allow you to further constrict the relation to being added.
2050
-     *                                                 However, keep in mind that the columns (keys) given must match a
2051
-     *                                                 column on the JOIN table and currently only the HABTM models
2052
-     *                                                 accept these additional conditions.  Also remember that if an
2053
-     *                                                 exact match isn't found for these extra cols/val pairs, then a
2054
-     *                                                 NEW row is created in the join table.
2055
-     * @param null   $cache_id
2056
-     * @throws EE_Error
2057
-     * @return EE_Base_Class the object the relation was added to
2058
-     */
2059
-    public function _add_relation_to(
2060
-        $otherObjectModelObjectOrID,
2061
-        $relationName,
2062
-        $extra_join_model_fields_n_values = array(),
2063
-        $cache_id = null
2064
-    ) {
2065
-        $model = $this->get_model();
2066
-        //if this thing exists in the DB, save the relation to the DB
2067
-        if ($this->ID()) {
2068
-            $otherObject = $model
2069
-                                ->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
2070
-                                    $extra_join_model_fields_n_values);
2071
-            //clear cache so future get_many_related and get_first_related() return new results.
2072
-            $this->clear_cache($relationName, $otherObject, true);
2073
-            if ($otherObject instanceof EE_Base_Class) {
2074
-                $otherObject->clear_cache($model->get_this_model_name(), $this);
2075
-            }
2076
-        } else {
2077
-            //this thing doesn't exist in the DB,  so just cache it
2078
-            if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
2079
-                throw new EE_Error(sprintf(
2080
-                    __('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
2081
-                        'event_espresso'),
2082
-                    $otherObjectModelObjectOrID,
2083
-                    get_class($this)
2084
-                ));
2085
-            } else {
2086
-                $otherObject = $otherObjectModelObjectOrID;
2087
-            }
2088
-            $this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
2089
-        }
2090
-        if ($otherObject instanceof EE_Base_Class) {
2091
-            //fix the reciprocal relation too
2092
-            if ($otherObject->ID()) {
2093
-                //its saved so assumed relations exist in the DB, so we can just
2094
-                //clear the cache so future queries use the updated info in the DB
2095
-                $otherObject->clear_cache($model->get_this_model_name(), null, true);
2096
-            } else {
2097
-                //it's not saved, so it caches relations like this
2098
-                $otherObject->cache($model->get_this_model_name(), $this);
2099
-            }
2100
-        }
2101
-        return $otherObject;
2102
-    }
2103
-
2104
-
2105
-
2106
-    /**
2107
-     * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
2108
-     * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
2109
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
2110
-     * from the cache
2111
-     *
2112
-     * @param mixed  $otherObjectModelObjectOrID
2113
-     *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
2114
-     *                to the DB yet
2115
-     * @param string $relationName
2116
-     * @param array  $where_query
2117
-     *                You can optionally include an array of key=>value pairs that allow you to further constrict the
2118
-     *                relation to being added. However, keep in mind that the columns (keys) given must match a column
2119
-     *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
2120
-     *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
2121
-     *                created in the join table.
2122
-     * @return EE_Base_Class the relation was removed from
2123
-     * @throws EE_Error
2124
-     */
2125
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
2126
-    {
2127
-        if ($this->ID()) {
2128
-            //if this exists in the DB, save the relation change to the DB too
2129
-            $otherObject = $this->get_model()
2130
-                                ->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
2131
-                                    $where_query);
2132
-            $this->clear_cache($relationName, $otherObject);
2133
-        } else {
2134
-            //this doesn't exist in the DB, just remove it from the cache
2135
-            $otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
2136
-        }
2137
-        if ($otherObject instanceof EE_Base_Class) {
2138
-            $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
2139
-        }
2140
-        return $otherObject;
2141
-    }
2142
-
2143
-
2144
-
2145
-    /**
2146
-     * Removes ALL the related things for the $relationName.
2147
-     *
2148
-     * @param string $relationName
2149
-     * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
2150
-     * @return EE_Base_Class
2151
-     * @throws EE_Error
2152
-     */
2153
-    public function _remove_relations($relationName, $where_query_params = array())
2154
-    {
2155
-        if ($this->ID()) {
2156
-            //if this exists in the DB, save the relation change to the DB too
2157
-            $otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
2158
-            $this->clear_cache($relationName, null, true);
2159
-        } else {
2160
-            //this doesn't exist in the DB, just remove it from the cache
2161
-            $otherObjects = $this->clear_cache($relationName, null, true);
2162
-        }
2163
-        if (is_array($otherObjects)) {
2164
-            foreach ($otherObjects as $otherObject) {
2165
-                $otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
2166
-            }
2167
-        }
2168
-        return $otherObjects;
2169
-    }
2170
-
2171
-
2172
-
2173
-    /**
2174
-     * Gets all the related model objects of the specified type. Eg, if the current class if
2175
-     * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
2176
-     * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
2177
-     * because we want to get even deleted items etc.
2178
-     *
2179
-     * @param string $relationName key in the model's _model_relations array
2180
-     * @param array  $query_params like EEM_Base::get_all
2181
-     * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
2182
-     * @throws EE_Error
2183
-     *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
2184
-     *                             you want IDs
2185
-     */
2186
-    public function get_many_related($relationName, $query_params = array())
2187
-    {
2188
-        if ($this->ID()) {
2189
-            //this exists in the DB, so get the related things from either the cache or the DB
2190
-            //if there are query parameters, forget about caching the related model objects.
2191
-            if ($query_params) {
2192
-                $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
2193
-            } else {
2194
-                //did we already cache the result of this query?
2195
-                $cached_results = $this->get_all_from_cache($relationName);
2196
-                if ( ! $cached_results) {
2197
-                    $related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
2198
-                    //if no query parameters were passed, then we got all the related model objects
2199
-                    //for that relation. We can cache them then.
2200
-                    foreach ($related_model_objects as $related_model_object) {
2201
-                        $this->cache($relationName, $related_model_object);
2202
-                    }
2203
-                } else {
2204
-                    $related_model_objects = $cached_results;
2205
-                }
2206
-            }
2207
-        } else {
2208
-            //this doesn't exist in the DB, so just get the related things from the cache
2209
-            $related_model_objects = $this->get_all_from_cache($relationName);
2210
-        }
2211
-        return $related_model_objects;
2212
-    }
2213
-
2214
-
2215
-
2216
-    /**
2217
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2218
-     * unless otherwise specified in the $query_params
2219
-     *
2220
-     * @param string $relation_name  model_name like 'Event', or 'Registration'
2221
-     * @param array  $query_params   like EEM_Base::get_all's
2222
-     * @param string $field_to_count name of field to count by. By default, uses primary key
2223
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2224
-     *                               that by the setting $distinct to TRUE;
2225
-     * @return int
2226
-     */
2227
-    public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
2228
-    {
2229
-        return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
2230
-    }
2231
-
2232
-
2233
-
2234
-    /**
2235
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
2236
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2237
-     *
2238
-     * @param string $relation_name model_name like 'Event', or 'Registration'
2239
-     * @param array  $query_params  like EEM_Base::get_all's
2240
-     * @param string $field_to_sum  name of field to count by.
2241
-     *                              By default, uses primary key (which doesn't make much sense, so you should probably
2242
-     *                              change it)
2243
-     * @return int
2244
-     */
2245
-    public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
2246
-    {
2247
-        return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
2248
-    }
2249
-
2250
-
2251
-
2252
-    /**
2253
-     * Gets the first (ie, one) related model object of the specified type.
2254
-     *
2255
-     * @param string $relationName key in the model's _model_relations array
2256
-     * @param array  $query_params like EEM_Base::get_all
2257
-     * @return EE_Base_Class (not an array, a single object)
2258
-     * @throws EE_Error
2259
-     */
2260
-    public function get_first_related($relationName, $query_params = array())
2261
-    {
2262
-        $model = $this->get_model();
2263
-        if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
2264
-            //if they've provided some query parameters, don't bother trying to cache the result
2265
-            //also make sure we're not caching the result of get_first_related
2266
-            //on a relation which should have an array of objects (because the cache might have an array of objects)
2267
-            if ($query_params
2268
-                || ! $model->related_settings_for($relationName)
2269
-                     instanceof
2270
-                     EE_Belongs_To_Relation
2271
-            ) {
2272
-                $related_model_object = $model->get_first_related($this, $relationName, $query_params);
2273
-            } else {
2274
-                //first, check if we've already cached the result of this query
2275
-                $cached_result = $this->get_one_from_cache($relationName);
2276
-                if ( ! $cached_result) {
2277
-                    $related_model_object = $model->get_first_related($this, $relationName, $query_params);
2278
-                    $this->cache($relationName, $related_model_object);
2279
-                } else {
2280
-                    $related_model_object = $cached_result;
2281
-                }
2282
-            }
2283
-        } else {
2284
-            $related_model_object = null;
2285
-            //this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
2286
-            if ($model->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
2287
-                $related_model_object = $model->get_first_related($this, $relationName, $query_params);
2288
-            }
2289
-            //this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
2290
-            if ( ! $related_model_object) {
2291
-                $related_model_object = $this->get_one_from_cache($relationName);
2292
-            }
2293
-        }
2294
-        return $related_model_object;
2295
-    }
2296
-
2297
-
2298
-
2299
-    /**
2300
-     * Does a delete on all related objects of type $relationName and removes
2301
-     * the current model object's relation to them. If they can't be deleted (because
2302
-     * of blocking related model objects) does nothing. If the related model objects are
2303
-     * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
2304
-     * If this model object doesn't exist yet in the DB, just removes its related things
2305
-     *
2306
-     * @param string $relationName
2307
-     * @param array  $query_params like EEM_Base::get_all's
2308
-     * @return int how many deleted
2309
-     * @throws EE_Error
2310
-     */
2311
-    public function delete_related($relationName, $query_params = array())
2312
-    {
2313
-        if ($this->ID()) {
2314
-            $count = $this->get_model()->delete_related($this, $relationName, $query_params);
2315
-        } else {
2316
-            $count = count($this->get_all_from_cache($relationName));
2317
-            $this->clear_cache($relationName, null, true);
2318
-        }
2319
-        return $count;
2320
-    }
2321
-
2322
-
2323
-
2324
-    /**
2325
-     * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
2326
-     * the current model object's relation to them. If they can't be deleted (because
2327
-     * of blocking related model objects) just does a soft delete on it instead, if possible.
2328
-     * If the related thing isn't a soft-deletable model object, this function is identical
2329
-     * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
2330
-     *
2331
-     * @param string $relationName
2332
-     * @param array  $query_params like EEM_Base::get_all's
2333
-     * @return int how many deleted (including those soft deleted)
2334
-     * @throws EE_Error
2335
-     */
2336
-    public function delete_related_permanently($relationName, $query_params = array())
2337
-    {
2338
-        if ($this->ID()) {
2339
-            $count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
2340
-        } else {
2341
-            $count = count($this->get_all_from_cache($relationName));
2342
-        }
2343
-        $this->clear_cache($relationName, null, true);
2344
-        return $count;
2345
-    }
2346
-
2347
-
2348
-
2349
-    /**
2350
-     * is_set
2351
-     * Just a simple utility function children can use for checking if property exists
2352
-     *
2353
-     * @access  public
2354
-     * @param  string $field_name property to check
2355
-     * @return bool                              TRUE if existing,FALSE if not.
2356
-     */
2357
-    public function is_set($field_name)
2358
-    {
2359
-        return isset($this->_fields[$field_name]);
2360
-    }
2361
-
2362
-
2363
-
2364
-    /**
2365
-     * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
2366
-     * EE_Error exception if they don't
2367
-     *
2368
-     * @param  mixed (string|array) $properties properties to check
2369
-     * @throws EE_Error
2370
-     * @return bool                              TRUE if existing, throw EE_Error if not.
2371
-     */
2372
-    protected function _property_exists($properties)
2373
-    {
2374
-        foreach ((array)$properties as $property_name) {
2375
-            //first make sure this property exists
2376
-            if ( ! $this->_fields[$property_name]) {
2377
-                throw new EE_Error(
2378
-                    sprintf(
2379
-                        __(
2380
-                            'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
2381
-                            'event_espresso'
2382
-                        ),
2383
-                        $property_name
2384
-                    )
2385
-                );
2386
-            }
2387
-        }
2388
-        return true;
2389
-    }
2390
-
2391
-
2392
-
2393
-    /**
2394
-     * This simply returns an array of model fields for this object
2395
-     *
2396
-     * @return array
2397
-     * @throws EE_Error
2398
-     */
2399
-    public function model_field_array()
2400
-    {
2401
-        $fields = $this->get_model()->field_settings(false);
2402
-        $properties = array();
2403
-        //remove prepended underscore
2404
-        foreach ($fields as $field_name => $settings) {
2405
-            $properties[$field_name] = $this->get($field_name);
2406
-        }
2407
-        return $properties;
2408
-    }
2409
-
2410
-
2411
-
2412
-    /**
2413
-     * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
2414
-     * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
2415
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
2416
-     * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
2417
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
2418
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
2419
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
2420
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
2421
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
2422
-     * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
2423
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
2424
-     *        return $previousReturnValue.$returnString;
2425
-     * }
2426
-     * require('EE_Answer.class.php');
2427
-     * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
2428
-     * echo $answer->my_callback('monkeys',100);
2429
-     * //will output "you called my_callback! and passed args:monkeys,100"
2430
-     *
2431
-     * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
2432
-     * @param array  $args       array of original arguments passed to the function
2433
-     * @throws EE_Error
2434
-     * @return mixed whatever the plugin which calls add_filter decides
2435
-     */
2436
-    public function __call($methodName, $args)
2437
-    {
2438
-        $className = get_class($this);
2439
-        $tagName = "FHEE__{$className}__{$methodName}";
2440
-        if ( ! has_filter($tagName)) {
2441
-            throw new EE_Error(
2442
-                sprintf(
2443
-                    __(
2444
-                        "Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
2445
-                        "event_espresso"
2446
-                    ),
2447
-                    $methodName,
2448
-                    $className,
2449
-                    $tagName
2450
-                )
2451
-            );
2452
-        }
2453
-        return apply_filters($tagName, null, $this, $args);
2454
-    }
2455
-
2456
-
2457
-
2458
-    /**
2459
-     * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
2460
-     * A $previous_value can be specified in case there are many meta rows with the same key
2461
-     *
2462
-     * @param string $meta_key
2463
-     * @param mixed  $meta_value
2464
-     * @param mixed  $previous_value
2465
-     * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
2466
-     * @throws EE_Error
2467
-     * NOTE: if the values haven't changed, returns 0
2468
-     */
2469
-    public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
2470
-    {
2471
-        $query_params = array(
2472
-            array(
2473
-                'EXM_key'  => $meta_key,
2474
-                'OBJ_ID'   => $this->ID(),
2475
-                'EXM_type' => $this->get_model()->get_this_model_name(),
2476
-            ),
2477
-        );
2478
-        if ($previous_value !== null) {
2479
-            $query_params[0]['EXM_value'] = $meta_value;
2480
-        }
2481
-        $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
2482
-        if ( ! $existing_rows_like_that) {
2483
-            return $this->add_extra_meta($meta_key, $meta_value);
2484
-        }
2485
-        foreach ($existing_rows_like_that as $existing_row) {
2486
-            $existing_row->save(array('EXM_value' => $meta_value));
2487
-        }
2488
-        return count($existing_rows_like_that);
2489
-    }
2490
-
2491
-
2492
-
2493
-    /**
2494
-     * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
2495
-     * no other extra meta for this model object have the same key. Returns TRUE if the
2496
-     * extra meta row was entered, false if not
2497
-     *
2498
-     * @param string  $meta_key
2499
-     * @param mixed   $meta_value
2500
-     * @param boolean $unique
2501
-     * @return boolean
2502
-     * @throws EE_Error
2503
-     */
2504
-    public function add_extra_meta($meta_key, $meta_value, $unique = false)
2505
-    {
2506
-        if ($unique) {
2507
-            $existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
2508
-                array(
2509
-                    array(
2510
-                        'EXM_key'  => $meta_key,
2511
-                        'OBJ_ID'   => $this->ID(),
2512
-                        'EXM_type' => $this->get_model()->get_this_model_name(),
2513
-                    ),
2514
-                )
2515
-            );
2516
-            if ($existing_extra_meta) {
2517
-                return false;
2518
-            }
2519
-        }
2520
-        $new_extra_meta = EE_Extra_Meta::new_instance(
2521
-            array(
2522
-                'EXM_key'   => $meta_key,
2523
-                'EXM_value' => $meta_value,
2524
-                'OBJ_ID'    => $this->ID(),
2525
-                'EXM_type'  => $this->get_model()->get_this_model_name(),
2526
-            )
2527
-        );
2528
-        $new_extra_meta->save();
2529
-        return true;
2530
-    }
2531
-
2532
-
2533
-
2534
-    /**
2535
-     * Deletes all the extra meta rows for this record as specified by key. If $meta_value
2536
-     * is specified, only deletes extra meta records with that value.
2537
-     *
2538
-     * @param string $meta_key
2539
-     * @param mixed  $meta_value
2540
-     * @return int number of extra meta rows deleted
2541
-     * @throws EE_Error
2542
-     */
2543
-    public function delete_extra_meta($meta_key, $meta_value = null)
2544
-    {
2545
-        $query_params = array(
2546
-            array(
2547
-                'EXM_key'  => $meta_key,
2548
-                'OBJ_ID'   => $this->ID(),
2549
-                'EXM_type' => $this->get_model()->get_this_model_name(),
2550
-            ),
2551
-        );
2552
-        if ($meta_value !== null) {
2553
-            $query_params[0]['EXM_value'] = $meta_value;
2554
-        }
2555
-        return EEM_Extra_Meta::instance()->delete($query_params);
2556
-    }
2557
-
2558
-
2559
-
2560
-    /**
2561
-     * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
2562
-     * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
2563
-     * You can specify $default is case you haven't found the extra meta
2564
-     *
2565
-     * @param string  $meta_key
2566
-     * @param boolean $single
2567
-     * @param mixed   $default if we don't find anything, what should we return?
2568
-     * @return mixed single value if $single; array if ! $single
2569
-     * @throws EE_Error
2570
-     */
2571
-    public function get_extra_meta($meta_key, $single = false, $default = null)
2572
-    {
2573
-        if ($single) {
2574
-            $result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
2575
-            if ($result instanceof EE_Extra_Meta) {
2576
-                return $result->value();
2577
-            } else {
2578
-                return $default;
2579
-            }
2580
-        } else {
2581
-            $results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
2582
-            if ($results) {
2583
-                $values = array();
2584
-                foreach ($results as $result) {
2585
-                    if ($result instanceof EE_Extra_Meta) {
2586
-                        $values[$result->ID()] = $result->value();
2587
-                    }
2588
-                }
2589
-                return $values;
2590
-            } else {
2591
-                return $default;
2592
-            }
2593
-        }
2594
-    }
2595
-
2596
-
2597
-
2598
-    /**
2599
-     * Returns a simple array of all the extra meta associated with this model object.
2600
-     * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
2601
-     * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
2602
-     * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
2603
-     * If $one_of_each_key is false, it will return an array with the top-level keys being
2604
-     * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
2605
-     * finally the extra meta's value as each sub-value. (eg
2606
-     * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
2607
-     *
2608
-     * @param boolean $one_of_each_key
2609
-     * @return array
2610
-     * @throws EE_Error
2611
-     */
2612
-    public function all_extra_meta_array($one_of_each_key = true)
2613
-    {
2614
-        $return_array = array();
2615
-        if ($one_of_each_key) {
2616
-            $extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
2617
-            foreach ($extra_meta_objs as $extra_meta_obj) {
2618
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
2619
-                    $return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
2620
-                }
2621
-            }
2622
-        } else {
2623
-            $extra_meta_objs = $this->get_many_related('Extra_Meta');
2624
-            foreach ($extra_meta_objs as $extra_meta_obj) {
2625
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
2626
-                    if ( ! isset($return_array[$extra_meta_obj->key()])) {
2627
-                        $return_array[$extra_meta_obj->key()] = array();
2628
-                    }
2629
-                    $return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
2630
-                }
2631
-            }
2632
-        }
2633
-        return $return_array;
2634
-    }
2635
-
2636
-
2637
-
2638
-    /**
2639
-     * Gets a pretty nice displayable nice for this model object. Often overridden
2640
-     *
2641
-     * @return string
2642
-     * @throws EE_Error
2643
-     */
2644
-    public function name()
2645
-    {
2646
-        //find a field that's not a text field
2647
-        $field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
2648
-        if ($field_we_can_use) {
2649
-            return $this->get($field_we_can_use->get_name());
2650
-        } else {
2651
-            $first_few_properties = $this->model_field_array();
2652
-            $first_few_properties = array_slice($first_few_properties, 0, 3);
2653
-            $name_parts = array();
2654
-            foreach ($first_few_properties as $name => $value) {
2655
-                $name_parts[] = "$name:$value";
2656
-            }
2657
-            return implode(",", $name_parts);
2658
-        }
2659
-    }
2660
-
2661
-
2662
-
2663
-    /**
2664
-     * in_entity_map
2665
-     * Checks if this model object has been proven to already be in the entity map
2666
-     *
2667
-     * @return boolean
2668
-     * @throws EE_Error
2669
-     */
2670
-    public function in_entity_map()
2671
-    {
2672
-        if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
2673
-            //well, if we looked, did we find it in the entity map?
2674
-            return true;
2675
-        } else {
2676
-            return false;
2677
-        }
2678
-    }
2679
-
2680
-
2681
-
2682
-    /**
2683
-     * refresh_from_db
2684
-     * Makes sure the fields and values on this model object are in-sync with what's in the database.
2685
-     *
2686
-     * @throws EE_Error if this model object isn't in the entity mapper (because then you should
2687
-     * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
2688
-     */
2689
-    public function refresh_from_db()
2690
-    {
2691
-        if ($this->ID() && $this->in_entity_map()) {
2692
-            $this->get_model()->refresh_entity_map_from_db($this->ID());
2693
-        } else {
2694
-            //if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
2695
-            //if it has an ID but it's not in the map, and you're asking me to refresh it
2696
-            //that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
2697
-            //absolutely nothing in it for this ID
2698
-            if (WP_DEBUG) {
2699
-                throw new EE_Error(
2700
-                    sprintf(
2701
-                        __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
2702
-                            'event_espresso'),
2703
-                        $this->ID(),
2704
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
2705
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
2706
-                    )
2707
-                );
2708
-            }
2709
-        }
2710
-    }
2711
-
2712
-
2713
-
2714
-    /**
2715
-     * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
2716
-     * (probably a bad assumption they have made, oh well)
2717
-     *
2718
-     * @return string
2719
-     */
2720
-    public function __toString()
2721
-    {
2722
-        try {
2723
-            return sprintf('%s (%s)', $this->name(), $this->ID());
2724
-        } catch (Exception $e) {
2725
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
2726
-            return '';
2727
-        }
2728
-    }
2729
-
2730
-
2731
-
2732
-    /**
2733
-     * Clear related model objects if they're already in the DB, because otherwise when we
2734
-     * UN-serialize this model object we'll need to be careful to add them to the entity map.
2735
-     * This means if we have made changes to those related model objects, and want to unserialize
2736
-     * the this model object on a subsequent request, changes to those related model objects will be lost.
2737
-     * Instead, those related model objects should be directly serialized and stored.
2738
-     * Eg, the following won't work:
2739
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
2740
-     * $att = $reg->attendee();
2741
-     * $att->set( 'ATT_fname', 'Dirk' );
2742
-     * update_option( 'my_option', serialize( $reg ) );
2743
-     * //END REQUEST
2744
-     * //START NEXT REQUEST
2745
-     * $reg = get_option( 'my_option' );
2746
-     * $reg->attendee()->save();
2747
-     * And would need to be replace with:
2748
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
2749
-     * $att = $reg->attendee();
2750
-     * $att->set( 'ATT_fname', 'Dirk' );
2751
-     * update_option( 'my_option', serialize( $reg ) );
2752
-     * //END REQUEST
2753
-     * //START NEXT REQUEST
2754
-     * $att = get_option( 'my_option' );
2755
-     * $att->save();
2756
-     *
2757
-     * @return array
2758
-     * @throws EE_Error
2759
-     */
2760
-    public function __sleep()
2761
-    {
2762
-        $model = $this->get_model();
2763
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
2764
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
2765
-                $classname = 'EE_' . $model->get_this_model_name();
2766
-                if (
2767
-                    $this->get_one_from_cache($relation_name) instanceof $classname
2768
-                    && $this->get_one_from_cache($relation_name)->ID()
2769
-                ) {
2770
-                    $this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
2771
-                }
2772
-            }
2773
-        }
2774
-        $this->_props_n_values_provided_in_constructor = array();
2775
-        $properties_to_serialize = get_object_vars($this);
2776
-        //don't serialize the model. It's big and that risks recursion
2777
-        unset($properties_to_serialize['_model']);
2778
-        return array_keys($properties_to_serialize);
2779
-    }
2780
-
2781
-
2782
-
2783
-    /**
2784
-     * restore _props_n_values_provided_in_constructor
2785
-     * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
2786
-     * and therefore should NOT be used to determine if state change has occurred since initial construction.
2787
-     * At best, you would only be able to detect if state change has occurred during THIS request.
2788
-     */
2789
-    public function __wakeup()
2790
-    {
2791
-        $this->_props_n_values_provided_in_constructor = $this->_fields;
2792
-    }
28
+	/**
29
+	 * This is an array of the original properties and values provided during construction
30
+	 * of this model object. (keys are model field names, values are their values).
31
+	 * This list is important to remember so that when we are merging data from the db, we know
32
+	 * which values to override and which to not override.
33
+	 *
34
+	 * @var array
35
+	 */
36
+	protected $_props_n_values_provided_in_constructor;
37
+
38
+	/**
39
+	 * Timezone
40
+	 * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
41
+	 * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
42
+	 * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
43
+	 * access to it.
44
+	 *
45
+	 * @var string
46
+	 */
47
+	protected $_timezone;
48
+
49
+
50
+
51
+	/**
52
+	 * date format
53
+	 * pattern or format for displaying dates
54
+	 *
55
+	 * @var string $_dt_frmt
56
+	 */
57
+	protected $_dt_frmt;
58
+
59
+
60
+
61
+	/**
62
+	 * time format
63
+	 * pattern or format for displaying time
64
+	 *
65
+	 * @var string $_tm_frmt
66
+	 */
67
+	protected $_tm_frmt;
68
+
69
+
70
+
71
+	/**
72
+	 * This property is for holding a cached array of object properties indexed by property name as the key.
73
+	 * The purpose of this is for setting a cache on properties that may have calculated values after a
74
+	 * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
75
+	 * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
76
+	 *
77
+	 * @var array
78
+	 */
79
+	protected $_cached_properties = array();
80
+
81
+	/**
82
+	 * An array containing keys of the related model, and values are either an array of related mode objects or a
83
+	 * single
84
+	 * related model object. see the model's _model_relations. The keys should match those specified. And if the
85
+	 * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
86
+	 * all others have an array)
87
+	 *
88
+	 * @var array
89
+	 */
90
+	protected $_model_relations = array();
91
+
92
+	/**
93
+	 * Array where keys are field names (see the model's _fields property) and values are their values. To see what
94
+	 * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
95
+	 *
96
+	 * @var array
97
+	 */
98
+	protected $_fields = array();
99
+
100
+	/**
101
+	 * @var boolean indicating whether or not this model object is intended to ever be saved
102
+	 * For example, we might create model objects intended to only be used for the duration
103
+	 * of this request and to be thrown away, and if they were accidentally saved
104
+	 * it would be a bug.
105
+	 */
106
+	protected $_allow_persist = true;
107
+
108
+	/**
109
+	 * @var boolean indicating whether or not this model object's properties have changed since construction
110
+	 */
111
+	protected $_has_changes = false;
112
+
113
+	/**
114
+	 * @var EEM_Base
115
+	 */
116
+	protected $_model;
117
+
118
+
119
+
120
+	/**
121
+	 * @param array  $fieldValues
122
+	 * @param string $timezone
123
+	 * @param array  $date_formats
124
+	 * @return EE_Base_Class
125
+	 * @throws EE_Error
126
+	 */
127
+	public static function new_instance($fieldValues = array(), $timezone = '', $date_formats = array() ) {
128
+		return self::static_constructor((array) $fieldValues, false, $timezone,  $date_formats);
129
+	}
130
+
131
+
132
+
133
+	/**
134
+	 * @deprecated
135
+	 * @param array  $fieldValues
136
+	 * @param string $timezone
137
+	 * @return EE_Base_Class
138
+	 * @throws EE_Error
139
+	 */
140
+	public static function new_instance_from_db($fieldValues = array(), $timezone = '') {
141
+		return self::static_constructor((array) $fieldValues, true, $timezone);
142
+	}
143
+
144
+
145
+
146
+	/**
147
+	 * @param array  $fieldValues
148
+	 * @param bool   $from_db
149
+	 * @param string $timezone
150
+	 * @param array  $date_formats
151
+	 * @return EE_Base_Class
152
+	 * @throws EE_Error
153
+	 */
154
+	public static function static_constructor(
155
+		array $fieldValues = array(),
156
+		$from_db = false,
157
+		$timezone = '',
158
+		array $date_formats = array()
159
+	) {
160
+		$className = get_called_class();
161
+		if (! $from_db) {
162
+			$cached_object = EE_Base_Class::_check_for_object(
163
+				$fieldValues,
164
+				$className,
165
+				$timezone,
166
+				$date_formats
167
+			);
168
+			if ($cached_object) {
169
+				return $cached_object;
170
+			}
171
+		}
172
+		return new $className($fieldValues, $from_db, $timezone, $date_formats);
173
+	}
174
+
175
+
176
+
177
+	/**
178
+	 * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children play nice
179
+	 *
180
+	 * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
181
+	 *                                                         layer of the model's _fields array, (eg, EVT_ID,
182
+	 *                                                         TXN_amount, QST_name, etc) and values are their values
183
+	 * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
184
+	 *                                                         corresponding db model or not.
185
+	 * @param string  $timezone                                indicate what timezone you want any datetime fields to
186
+	 *                                                         be in when instantiating a EE_Base_Class object.
187
+	 * @param array   $date_formats                            An array of date formats to set on construct where first
188
+	 *                                                         value is the date_format and second value is the time
189
+	 *                                                         format.
190
+	 * @throws EE_Error
191
+	 */
192
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
193
+	{
194
+		$className = get_class($this);
195
+		do_action("AHEE__{$className}__construct", $this, $fieldValues);
196
+		$model = $this->get_model();
197
+		$model_fields = $model->field_settings(false);
198
+		// ensure $fieldValues is an array
199
+		$fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
200
+		// EEH_Debug_Tools::printr( $fieldValues, '$fieldValues  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
201
+		// verify client code has not passed any invalid field names
202
+		foreach ($fieldValues as $field_name => $field_value) {
203
+			if ( ! isset($model_fields[$field_name])) {
204
+				throw new EE_Error(sprintf(__("Invalid field (%s) passed to constructor of %s. Allowed fields are :%s",
205
+					"event_espresso"), $field_name, get_class($this), implode(", ", array_keys($model_fields))));
206
+			}
207
+		}
208
+		// EEH_Debug_Tools::printr( $model_fields, '$model_fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
209
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
210
+		if ( ! empty($date_formats) && is_array($date_formats)) {
211
+			list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
212
+		} else {
213
+			//set default formats for date and time
214
+			$this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
215
+			$this->_tm_frmt = (string)get_option('time_format', 'g:i a');
216
+		}
217
+		//if db model is instantiating
218
+		if ($bydb) {
219
+			//client code has indicated these field values are from the database
220
+			foreach ($model_fields as $fieldName => $field) {
221
+				$this->set_from_db($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null);
222
+			}
223
+		} else {
224
+			//we're constructing a brand
225
+			//new instance of the model object. Generally, this means we'll need to do more field validation
226
+			foreach ($model_fields as $fieldName => $field) {
227
+				$this->set($fieldName, isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true);
228
+			}
229
+		}
230
+		//remember what values were passed to this constructor
231
+		$this->_props_n_values_provided_in_constructor = $fieldValues;
232
+		//remember in entity mapper
233
+		if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
234
+			$model->add_to_entity_map($this);
235
+		}
236
+		//setup all the relations
237
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
238
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
239
+				$this->_model_relations[$relation_name] = null;
240
+			} else {
241
+				$this->_model_relations[$relation_name] = array();
242
+			}
243
+		}
244
+		/**
245
+		 * Action done at the end of each model object construction
246
+		 *
247
+		 * @param EE_Base_Class $this the model object just created
248
+		 */
249
+		do_action('AHEE__EE_Base_Class__construct__finished', $this);
250
+	}
251
+
252
+
253
+
254
+	/**
255
+	 * Gets whether or not this model object is allowed to persist/be saved to the database.
256
+	 *
257
+	 * @return boolean
258
+	 */
259
+	public function allow_persist()
260
+	{
261
+		return $this->_allow_persist;
262
+	}
263
+
264
+
265
+
266
+	/**
267
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
268
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
269
+	 * you got new information that somehow made you change your mind.
270
+	 *
271
+	 * @param boolean $allow_persist
272
+	 * @return boolean
273
+	 */
274
+	public function set_allow_persist($allow_persist)
275
+	{
276
+		return $this->_allow_persist = $allow_persist;
277
+	}
278
+
279
+
280
+
281
+	/**
282
+	 * Gets the field's original value when this object was constructed during this request.
283
+	 * This can be helpful when determining if a model object has changed or not
284
+	 *
285
+	 * @param string $field_name
286
+	 * @return mixed|null
287
+	 * @throws EE_Error
288
+	 */
289
+	public function get_original($field_name)
290
+	{
291
+		if (isset($this->_props_n_values_provided_in_constructor[$field_name])
292
+			&& $field_settings = $this->get_model()->field_settings_for($field_name)
293
+		) {
294
+			return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
295
+		} else {
296
+			return null;
297
+		}
298
+	}
299
+
300
+
301
+
302
+	/**
303
+	 * @param EE_Base_Class $obj
304
+	 * @return string
305
+	 */
306
+	public function get_class($obj)
307
+	{
308
+		return get_class($obj);
309
+	}
310
+
311
+
312
+
313
+	/**
314
+	 * Overrides parent because parent expects old models.
315
+	 * This also doesn't do any validation, and won't work for serialized arrays
316
+	 *
317
+	 * @param    string $field_name
318
+	 * @param    mixed  $field_value
319
+	 * @param bool      $use_default
320
+	 * @throws EE_Error
321
+	 */
322
+	public function set($field_name, $field_value, $use_default = false)
323
+	{
324
+		// if not using default and nothing has changed, and object has already been setup (has ID),
325
+		// then don't do anything
326
+		if (
327
+			! $use_default
328
+			&& $this->_fields[$field_name] === $field_value
329
+			&& $this->ID()
330
+		) {
331
+			return;
332
+		}
333
+		$model = $this->get_model();
334
+		$this->_has_changes = true;
335
+		$field_obj = $model->field_settings_for($field_name);
336
+		if ($field_obj instanceof EE_Model_Field_Base) {
337
+			//			if ( method_exists( $field_obj, 'set_timezone' )) {
338
+			if ($field_obj instanceof EE_Datetime_Field) {
339
+				$field_obj->set_timezone($this->_timezone);
340
+				$field_obj->set_date_format($this->_dt_frmt);
341
+				$field_obj->set_time_format($this->_tm_frmt);
342
+			}
343
+			$holder_of_value = $field_obj->prepare_for_set($field_value);
344
+			//should the value be null?
345
+			if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
346
+				$this->_fields[$field_name] = $field_obj->get_default_value();
347
+				/**
348
+				 * To save having to refactor all the models, if a default value is used for a
349
+				 * EE_Datetime_Field, and that value is not null nor is it a DateTime
350
+				 * object.  Then let's do a set again to ensure that it becomes a DateTime
351
+				 * object.
352
+				 *
353
+				 * @since 4.6.10+
354
+				 */
355
+				if (
356
+					$field_obj instanceof EE_Datetime_Field
357
+					&& $this->_fields[$field_name] !== null
358
+					&& ! $this->_fields[$field_name] instanceof DateTime
359
+				) {
360
+					empty($this->_fields[$field_name])
361
+						? $this->set($field_name, time())
362
+						: $this->set($field_name, $this->_fields[$field_name]);
363
+				}
364
+			} else {
365
+				$this->_fields[$field_name] = $holder_of_value;
366
+			}
367
+			//if we're not in the constructor...
368
+			//now check if what we set was a primary key
369
+			if (
370
+				//note: props_n_values_provided_in_constructor is only set at the END of the constructor
371
+				$this->_props_n_values_provided_in_constructor
372
+				&& $field_value
373
+				&& $field_name === $model->primary_key_name()
374
+			) {
375
+				//if so, we want all this object's fields to be filled either with
376
+				//what we've explicitly set on this model
377
+				//or what we have in the db
378
+				// echo "setting primary key!";
379
+				$fields_on_model = self::_get_model(get_class($this))->field_settings();
380
+				$obj_in_db = self::_get_model(get_class($this))->get_one_by_ID($field_value);
381
+				foreach ($fields_on_model as $field_obj) {
382
+					if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
383
+						 && $field_obj->get_name() !== $field_name
384
+					) {
385
+						$this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
386
+					}
387
+				}
388
+				//oh this model object has an ID? well make sure its in the entity mapper
389
+				$model->add_to_entity_map($this);
390
+			}
391
+			//let's unset any cache for this field_name from the $_cached_properties property.
392
+			$this->_clear_cached_property($field_name);
393
+		} else {
394
+			throw new EE_Error(sprintf(__("A valid EE_Model_Field_Base could not be found for the given field name: %s",
395
+				"event_espresso"), $field_name));
396
+		}
397
+	}
398
+
399
+
400
+
401
+	/**
402
+	 * This sets the field value on the db column if it exists for the given $column_name or
403
+	 * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
404
+	 *
405
+	 * @see EE_message::get_column_value for related documentation on the necessity of this method.
406
+	 * @param string $field_name  Must be the exact column name.
407
+	 * @param mixed  $field_value The value to set.
408
+	 * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
409
+	 * @throws EE_Error
410
+	 */
411
+	public function set_field_or_extra_meta($field_name, $field_value)
412
+	{
413
+		if ($this->get_model()->has_field($field_name)) {
414
+			$this->set($field_name, $field_value);
415
+			return true;
416
+		} else {
417
+			//ensure this object is saved first so that extra meta can be properly related.
418
+			$this->save();
419
+			return $this->update_extra_meta($field_name, $field_value);
420
+		}
421
+	}
422
+
423
+
424
+
425
+	/**
426
+	 * This retrieves the value of the db column set on this class or if that's not present
427
+	 * it will attempt to retrieve from extra_meta if found.
428
+	 * Example Usage:
429
+	 * Via EE_Message child class:
430
+	 * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
431
+	 * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
432
+	 * also have additional main fields specific to the messenger.  The system accommodates those extra
433
+	 * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
434
+	 * value for those extra fields dynamically via the EE_message object.
435
+	 *
436
+	 * @param  string $field_name expecting the fully qualified field name.
437
+	 * @return mixed|null  value for the field if found.  null if not found.
438
+	 * @throws EE_Error
439
+	 */
440
+	public function get_field_or_extra_meta($field_name)
441
+	{
442
+		if ($this->get_model()->has_field($field_name)) {
443
+			$column_value = $this->get($field_name);
444
+		} else {
445
+			//This isn't a column in the main table, let's see if it is in the extra meta.
446
+			$column_value = $this->get_extra_meta($field_name, true, null);
447
+		}
448
+		return $column_value;
449
+	}
450
+
451
+
452
+
453
+	/**
454
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
455
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
456
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
457
+	 * available to all child classes that may be using the EE_Datetime_Field for a field data type.
458
+	 *
459
+	 * @access public
460
+	 * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
461
+	 * @return void
462
+	 * @throws EE_Error
463
+	 */
464
+	public function set_timezone($timezone = '')
465
+	{
466
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
467
+		//make sure we clear all cached properties because they won't be relevant now
468
+		$this->_clear_cached_properties();
469
+		//make sure we update field settings and the date for all EE_Datetime_Fields
470
+		$model_fields = $this->get_model()->field_settings(false);
471
+		foreach ($model_fields as $field_name => $field_obj) {
472
+			if ($field_obj instanceof EE_Datetime_Field) {
473
+				$field_obj->set_timezone($this->_timezone);
474
+				if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
475
+					$this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
476
+				}
477
+			}
478
+		}
479
+	}
480
+
481
+
482
+
483
+	/**
484
+	 * This just returns whatever is set for the current timezone.
485
+	 *
486
+	 * @access public
487
+	 * @return string timezone string
488
+	 */
489
+	public function get_timezone()
490
+	{
491
+		return $this->_timezone;
492
+	}
493
+
494
+
495
+
496
+	/**
497
+	 * This sets the internal date format to what is sent in to be used as the new default for the class
498
+	 * internally instead of wp set date format options
499
+	 *
500
+	 * @since 4.6
501
+	 * @param string $format should be a format recognizable by PHP date() functions.
502
+	 */
503
+	public function set_date_format($format)
504
+	{
505
+		$this->_dt_frmt = $format;
506
+		//clear cached_properties because they won't be relevant now.
507
+		$this->_clear_cached_properties();
508
+	}
509
+
510
+
511
+
512
+	/**
513
+	 * This sets the internal time format string to what is sent in to be used as the new default for the
514
+	 * class internally instead of wp set time format options.
515
+	 *
516
+	 * @since 4.6
517
+	 * @param string $format should be a format recognizable by PHP date() functions.
518
+	 */
519
+	public function set_time_format($format)
520
+	{
521
+		$this->_tm_frmt = $format;
522
+		//clear cached_properties because they won't be relevant now.
523
+		$this->_clear_cached_properties();
524
+	}
525
+
526
+
527
+
528
+	/**
529
+	 * This returns the current internal set format for the date and time formats.
530
+	 *
531
+	 * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
532
+	 *                             where the first value is the date format and the second value is the time format.
533
+	 * @return mixed string|array
534
+	 */
535
+	public function get_format($full = true)
536
+	{
537
+		return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
538
+	}
539
+
540
+
541
+
542
+	/**
543
+	 * cache
544
+	 * stores the passed model object on the current model object.
545
+	 * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
546
+	 *
547
+	 * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
548
+	 *                                       'Registration' associated with this model object
549
+	 * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
550
+	 *                                       that could be a payment or a registration)
551
+	 * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
552
+	 *                                       items which will be stored in an array on this object
553
+	 * @throws EE_Error
554
+	 * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
555
+	 *                  related thing, no array)
556
+	 */
557
+	public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
558
+	{
559
+		// its entirely possible that there IS no related object yet in which case there is nothing to cache.
560
+		if ( ! $object_to_cache instanceof EE_Base_Class) {
561
+			return false;
562
+		}
563
+		// also get "how" the object is related, or throw an error
564
+		if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
565
+			throw new EE_Error(sprintf(__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
566
+				$relationName, get_class($this)));
567
+		}
568
+		// how many things are related ?
569
+		if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
570
+			// if it's a "belongs to" relationship, then there's only one related model object  eg, if this is a registration, there's only 1 attendee for it
571
+			// so for these model objects just set it to be cached
572
+			$this->_model_relations[$relationName] = $object_to_cache;
573
+			$return = true;
574
+		} else {
575
+			// otherwise, this is the "many" side of a one to many relationship, so we'll add the object to the array of related objects for that type.
576
+			// eg: if this is an event, there are many registrations for that event, so we cache the registrations in an array
577
+			if ( ! is_array($this->_model_relations[$relationName])) {
578
+				// if for some reason, the cached item is a model object, then stick that in the array, otherwise start with an empty array
579
+				$this->_model_relations[$relationName] = $this->_model_relations[$relationName] instanceof EE_Base_Class
580
+					? array($this->_model_relations[$relationName]) : array();
581
+			}
582
+			// first check for a cache_id which is normally empty
583
+			if ( ! empty($cache_id)) {
584
+				// if the cache_id exists, then it means we are purposely trying to cache this with a known key that can then be used to retrieve the object later on
585
+				$this->_model_relations[$relationName][$cache_id] = $object_to_cache;
586
+				$return = $cache_id;
587
+			} elseif ($object_to_cache->ID()) {
588
+				// OR the cached object originally came from the db, so let's just use it's PK for an ID
589
+				$this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
590
+				$return = $object_to_cache->ID();
591
+			} else {
592
+				// OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
593
+				$this->_model_relations[$relationName][] = $object_to_cache;
594
+				// move the internal pointer to the end of the array
595
+				end($this->_model_relations[$relationName]);
596
+				// and grab the key so that we can return it
597
+				$return = key($this->_model_relations[$relationName]);
598
+			}
599
+		}
600
+		return $return;
601
+	}
602
+
603
+
604
+
605
+	/**
606
+	 * For adding an item to the cached_properties property.
607
+	 *
608
+	 * @access protected
609
+	 * @param string      $fieldname the property item the corresponding value is for.
610
+	 * @param mixed       $value     The value we are caching.
611
+	 * @param string|null $cache_type
612
+	 * @return void
613
+	 * @throws EE_Error
614
+	 */
615
+	protected function _set_cached_property($fieldname, $value, $cache_type = null)
616
+	{
617
+		//first make sure this property exists
618
+		$this->get_model()->field_settings_for($fieldname);
619
+		$cache_type = empty($cache_type) ? 'standard' : $cache_type;
620
+		$this->_cached_properties[$fieldname][$cache_type] = $value;
621
+	}
622
+
623
+
624
+
625
+	/**
626
+	 * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
627
+	 * This also SETS the cache if we return the actual property!
628
+	 *
629
+	 * @param string $fieldname        the name of the property we're trying to retrieve
630
+	 * @param bool   $pretty
631
+	 * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
632
+	 *                                 (in cases where the same property may be used for different outputs
633
+	 *                                 - i.e. datetime, money etc.)
634
+	 *                                 It can also accept certain pre-defined "schema" strings
635
+	 *                                 to define how to output the property.
636
+	 *                                 see the field's prepare_for_pretty_echoing for what strings can be used
637
+	 * @return mixed                   whatever the value for the property is we're retrieving
638
+	 * @throws EE_Error
639
+	 */
640
+	protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
641
+	{
642
+		//verify the field exists
643
+		$model = $this->get_model();
644
+		$model->field_settings_for($fieldname);
645
+		$cache_type = $pretty ? 'pretty' : 'standard';
646
+		$cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
647
+		if (isset($this->_cached_properties[$fieldname][$cache_type])) {
648
+			return $this->_cached_properties[$fieldname][$cache_type];
649
+		}
650
+		$value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
651
+		$this->_set_cached_property($fieldname, $value, $cache_type);
652
+		return $value;
653
+	}
654
+
655
+
656
+
657
+	/**
658
+	 * If the cache didn't fetch the needed item, this fetches it.
659
+	 * @param string $fieldname
660
+	 * @param bool $pretty
661
+	 * @param string $extra_cache_ref
662
+	 * @return mixed
663
+	 */
664
+	protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
665
+	{
666
+		$field_obj = $this->get_model()->field_settings_for($fieldname);
667
+		// If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
668
+		if ($field_obj instanceof EE_Datetime_Field) {
669
+			$this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
670
+		}
671
+		if ( ! isset($this->_fields[$fieldname])) {
672
+			$this->_fields[$fieldname] = null;
673
+		}
674
+		$value = $pretty
675
+			? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
676
+			: $field_obj->prepare_for_get($this->_fields[$fieldname]);
677
+		return $value;
678
+	}
679
+
680
+
681
+
682
+	/**
683
+	 * set timezone, formats, and output for EE_Datetime_Field objects
684
+	 *
685
+	 * @param \EE_Datetime_Field $datetime_field
686
+	 * @param bool               $pretty
687
+	 * @param null $date_or_time
688
+	 * @return void
689
+	 * @throws EE_Error
690
+	 */
691
+	protected function _prepare_datetime_field(
692
+		EE_Datetime_Field $datetime_field,
693
+		$pretty = false,
694
+		$date_or_time = null
695
+	) {
696
+		$datetime_field->set_timezone($this->_timezone);
697
+		$datetime_field->set_date_format($this->_dt_frmt, $pretty);
698
+		$datetime_field->set_time_format($this->_tm_frmt, $pretty);
699
+		//set the output returned
700
+		switch ($date_or_time) {
701
+			case 'D' :
702
+				$datetime_field->set_date_time_output('date');
703
+				break;
704
+			case 'T' :
705
+				$datetime_field->set_date_time_output('time');
706
+				break;
707
+			default :
708
+				$datetime_field->set_date_time_output();
709
+		}
710
+	}
711
+
712
+
713
+
714
+	/**
715
+	 * This just takes care of clearing out the cached_properties
716
+	 *
717
+	 * @return void
718
+	 */
719
+	protected function _clear_cached_properties()
720
+	{
721
+		$this->_cached_properties = array();
722
+	}
723
+
724
+
725
+
726
+	/**
727
+	 * This just clears out ONE property if it exists in the cache
728
+	 *
729
+	 * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
730
+	 * @return void
731
+	 */
732
+	protected function _clear_cached_property($property_name)
733
+	{
734
+		if (isset($this->_cached_properties[$property_name])) {
735
+			unset($this->_cached_properties[$property_name]);
736
+		}
737
+	}
738
+
739
+
740
+
741
+	/**
742
+	 * Ensures that this related thing is a model object.
743
+	 *
744
+	 * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
745
+	 * @param string $model_name   name of the related thing, eg 'Attendee',
746
+	 * @return EE_Base_Class
747
+	 * @throws EE_Error
748
+	 */
749
+	protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
750
+	{
751
+		$other_model_instance = self::_get_model_instance_with_name(
752
+			self::_get_model_classname($model_name),
753
+			$this->_timezone
754
+		);
755
+		return $other_model_instance->ensure_is_obj($object_or_id);
756
+	}
757
+
758
+
759
+
760
+	/**
761
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
762
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
763
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
764
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
765
+	 *
766
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model.
767
+	 *                                                     Eg 'Registration'
768
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
769
+	 *                                                     if you intend to use $clear_all = TRUE, or the relation only
770
+	 *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
771
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if
772
+	 *                                                     this is HasMany or HABTM.
773
+	 * @throws EE_Error
774
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
775
+	 *                       relation from all
776
+	 */
777
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
778
+	{
779
+		$relationship_to_model = $this->get_model()->related_settings_for($relationName);
780
+		$index_in_cache = '';
781
+		if ( ! $relationship_to_model) {
782
+			throw new EE_Error(
783
+				sprintf(
784
+					__("There is no relationship to %s on a %s. Cannot clear that cache", 'event_espresso'),
785
+					$relationName,
786
+					get_class($this)
787
+				)
788
+			);
789
+		}
790
+		if ($clear_all) {
791
+			$obj_removed = true;
792
+			$this->_model_relations[$relationName] = null;
793
+		} elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
794
+			$obj_removed = $this->_model_relations[$relationName];
795
+			$this->_model_relations[$relationName] = null;
796
+		} else {
797
+			if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
798
+				&& $object_to_remove_or_index_into_array->ID()
799
+			) {
800
+				$index_in_cache = $object_to_remove_or_index_into_array->ID();
801
+				if (is_array($this->_model_relations[$relationName])
802
+					&& ! isset($this->_model_relations[$relationName][$index_in_cache])
803
+				) {
804
+					$index_found_at = null;
805
+					//find this object in the array even though it has a different key
806
+					foreach ($this->_model_relations[$relationName] as $index => $obj) {
807
+						if (
808
+							$obj instanceof EE_Base_Class
809
+							&& (
810
+								$obj == $object_to_remove_or_index_into_array
811
+								|| $obj->ID() === $object_to_remove_or_index_into_array->ID()
812
+							)
813
+						) {
814
+							$index_found_at = $index;
815
+							break;
816
+						}
817
+					}
818
+					if ($index_found_at) {
819
+						$index_in_cache = $index_found_at;
820
+					} else {
821
+						//it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
822
+						//if it wasn't in it to begin with. So we're done
823
+						return $object_to_remove_or_index_into_array;
824
+					}
825
+				}
826
+			} elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
827
+				//so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
828
+				foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
829
+					if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
830
+						$index_in_cache = $index;
831
+					}
832
+				}
833
+			} else {
834
+				$index_in_cache = $object_to_remove_or_index_into_array;
835
+			}
836
+			//supposedly we've found it. But it could just be that the client code
837
+			//provided a bad index/object
838
+			if (
839
+			isset(
840
+				$this->_model_relations[$relationName],
841
+				$this->_model_relations[$relationName][$index_in_cache]
842
+			)
843
+			) {
844
+				$obj_removed = $this->_model_relations[$relationName][$index_in_cache];
845
+				unset($this->_model_relations[$relationName][$index_in_cache]);
846
+			} else {
847
+				//that thing was never cached anyways.
848
+				$obj_removed = null;
849
+			}
850
+		}
851
+		return $obj_removed;
852
+	}
853
+
854
+
855
+
856
+	/**
857
+	 * update_cache_after_object_save
858
+	 * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
859
+	 * obtained after being saved to the db
860
+	 *
861
+	 * @param string        $relationName       - the type of object that is cached
862
+	 * @param EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
863
+	 * @param string        $current_cache_id   - the ID that was used when originally caching the object
864
+	 * @return boolean TRUE on success, FALSE on fail
865
+	 * @throws EE_Error
866
+	 */
867
+	public function update_cache_after_object_save(
868
+		$relationName,
869
+		EE_Base_Class $newly_saved_object,
870
+		$current_cache_id = ''
871
+	) {
872
+		// verify that incoming object is of the correct type
873
+		$obj_class = 'EE_' . $relationName;
874
+		if ($newly_saved_object instanceof $obj_class) {
875
+			/* @type EE_Base_Class $newly_saved_object */
876
+			// now get the type of relation
877
+			$relationship_to_model = $this->get_model()->related_settings_for($relationName);
878
+			// if this is a 1:1 relationship
879
+			if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
880
+				// then just replace the cached object with the newly saved object
881
+				$this->_model_relations[$relationName] = $newly_saved_object;
882
+				return true;
883
+				// or if it's some kind of sordid feral polyamorous relationship...
884
+			} elseif (is_array($this->_model_relations[$relationName])
885
+					  && isset($this->_model_relations[$relationName][$current_cache_id])
886
+			) {
887
+				// then remove the current cached item
888
+				unset($this->_model_relations[$relationName][$current_cache_id]);
889
+				// and cache the newly saved object using it's new ID
890
+				$this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
891
+				return true;
892
+			}
893
+		}
894
+		return false;
895
+	}
896
+
897
+
898
+
899
+	/**
900
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
901
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
902
+	 *
903
+	 * @param string $relationName
904
+	 * @return EE_Base_Class
905
+	 */
906
+	public function get_one_from_cache($relationName)
907
+	{
908
+		$cached_array_or_object = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName]
909
+			: null;
910
+		if (is_array($cached_array_or_object)) {
911
+			return array_shift($cached_array_or_object);
912
+		} else {
913
+			return $cached_array_or_object;
914
+		}
915
+	}
916
+
917
+
918
+
919
+	/**
920
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
921
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
922
+	 *
923
+	 * @param string $relationName
924
+	 * @throws EE_Error
925
+	 * @return EE_Base_Class[] NOT necessarily indexed by primary keys
926
+	 */
927
+	public function get_all_from_cache($relationName)
928
+	{
929
+		$objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
930
+		// if the result is not an array, but exists, make it an array
931
+		$objects = is_array($objects) ? $objects : array($objects);
932
+		//bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
933
+		//basically, if this model object was stored in the session, and these cached model objects
934
+		//already have IDs, let's make sure they're in their model's entity mapper
935
+		//otherwise we will have duplicates next time we call
936
+		// EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
937
+		$model = EE_Registry::instance()->load_model($relationName);
938
+		foreach ($objects as $model_object) {
939
+			if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
940
+				//ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
941
+				if ($model_object->ID()) {
942
+					$model->add_to_entity_map($model_object);
943
+				}
944
+			} else {
945
+				throw new EE_Error(
946
+					sprintf(
947
+						__(
948
+							'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
949
+							'event_espresso'
950
+						),
951
+						$relationName,
952
+						gettype($model_object)
953
+					)
954
+				);
955
+			}
956
+		}
957
+		return $objects;
958
+	}
959
+
960
+
961
+
962
+	/**
963
+	 * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
964
+	 * matching the given query conditions.
965
+	 *
966
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
967
+	 * @param int   $limit              How many objects to return.
968
+	 * @param array $query_params       Any additional conditions on the query.
969
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
970
+	 *                                  you can indicate just the columns you want returned
971
+	 * @return array|EE_Base_Class[]
972
+	 * @throws EE_Error
973
+	 */
974
+	public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
975
+	{
976
+		$model = $this->get_model();
977
+		$field = empty($field_to_order_by) && $model->has_primary_key_field()
978
+			? $model->get_primary_key_field()->get_name()
979
+			: $field_to_order_by;
980
+		$current_value = ! empty($field) ? $this->get($field) : null;
981
+		if (empty($field) || empty($current_value)) {
982
+			return array();
983
+		}
984
+		return $model->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
985
+	}
986
+
987
+
988
+
989
+	/**
990
+	 * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
991
+	 * matching the given query conditions.
992
+	 *
993
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
994
+	 * @param int   $limit              How many objects to return.
995
+	 * @param array $query_params       Any additional conditions on the query.
996
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
997
+	 *                                  you can indicate just the columns you want returned
998
+	 * @return array|EE_Base_Class[]
999
+	 * @throws EE_Error
1000
+	 */
1001
+	public function previous_x(
1002
+		$field_to_order_by = null,
1003
+		$limit = 1,
1004
+		$query_params = array(),
1005
+		$columns_to_select = null
1006
+	) {
1007
+		$model = $this->get_model();
1008
+		$field = empty($field_to_order_by) && $model->has_primary_key_field()
1009
+			? $model->get_primary_key_field()->get_name()
1010
+			: $field_to_order_by;
1011
+		$current_value = ! empty($field) ? $this->get($field) : null;
1012
+		if (empty($field) || empty($current_value)) {
1013
+			return array();
1014
+		}
1015
+		return $model->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
1016
+	}
1017
+
1018
+
1019
+
1020
+	/**
1021
+	 * Returns the next EE_Base_Class object in sequence from this object as found in the database
1022
+	 * matching the given query conditions.
1023
+	 *
1024
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
1025
+	 * @param array $query_params       Any additional conditions on the query.
1026
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
1027
+	 *                                  you can indicate just the columns you want returned
1028
+	 * @return array|EE_Base_Class
1029
+	 * @throws EE_Error
1030
+	 */
1031
+	public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
1032
+	{
1033
+		$model = $this->get_model();
1034
+		$field = empty($field_to_order_by) && $model->has_primary_key_field()
1035
+			? $model->get_primary_key_field()->get_name()
1036
+			: $field_to_order_by;
1037
+		$current_value = ! empty($field) ? $this->get($field) : null;
1038
+		if (empty($field) || empty($current_value)) {
1039
+			return array();
1040
+		}
1041
+		return $model->next($current_value, $field, $query_params, $columns_to_select);
1042
+	}
1043
+
1044
+
1045
+
1046
+	/**
1047
+	 * Returns the previous EE_Base_Class object in sequence from this object as found in the database
1048
+	 * matching the given query conditions.
1049
+	 *
1050
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
1051
+	 * @param array $query_params       Any additional conditions on the query.
1052
+	 * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
1053
+	 *                                  you can indicate just the column you want returned
1054
+	 * @return array|EE_Base_Class
1055
+	 * @throws EE_Error
1056
+	 */
1057
+	public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
1058
+	{
1059
+		$model = $this->get_model();
1060
+		$field = empty($field_to_order_by) && $model->has_primary_key_field()
1061
+			? $model->get_primary_key_field()->get_name()
1062
+			: $field_to_order_by;
1063
+		$current_value = ! empty($field) ? $this->get($field) : null;
1064
+		if (empty($field) || empty($current_value)) {
1065
+			return array();
1066
+		}
1067
+		return $model->previous($current_value, $field, $query_params, $columns_to_select);
1068
+	}
1069
+
1070
+
1071
+
1072
+	/**
1073
+	 * Overrides parent because parent expects old models.
1074
+	 * This also doesn't do any validation, and won't work for serialized arrays
1075
+	 *
1076
+	 * @param string $field_name
1077
+	 * @param mixed  $field_value_from_db
1078
+	 * @throws EE_Error
1079
+	 */
1080
+	public function set_from_db($field_name, $field_value_from_db)
1081
+	{
1082
+		$field_obj = $this->get_model()->field_settings_for($field_name);
1083
+		if ($field_obj instanceof EE_Model_Field_Base) {
1084
+			//you would think the DB has no NULLs for non-null label fields right? wrong!
1085
+			//eg, a CPT model object could have an entry in the posts table, but no
1086
+			//entry in the meta table. Meaning that all its columns in the meta table
1087
+			//are null! yikes! so when we find one like that, use defaults for its meta columns
1088
+			if ($field_value_from_db === null) {
1089
+				if ($field_obj->is_nullable()) {
1090
+					//if the field allows nulls, then let it be null
1091
+					$field_value = null;
1092
+				} else {
1093
+					$field_value = $field_obj->get_default_value();
1094
+				}
1095
+			} else {
1096
+				$field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
1097
+			}
1098
+			$this->_fields[$field_name] = $field_value;
1099
+			$this->_clear_cached_property($field_name);
1100
+		}
1101
+	}
1102
+
1103
+
1104
+
1105
+	/**
1106
+	 * verifies that the specified field is of the correct type
1107
+	 *
1108
+	 * @param string $field_name
1109
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
1110
+	 *                                (in cases where the same property may be used for different outputs
1111
+	 *                                - i.e. datetime, money etc.)
1112
+	 * @return mixed
1113
+	 * @throws EE_Error
1114
+	 */
1115
+	public function get($field_name, $extra_cache_ref = null)
1116
+	{
1117
+		return $this->_get_cached_property($field_name, false, $extra_cache_ref);
1118
+	}
1119
+
1120
+
1121
+
1122
+	/**
1123
+	 * This method simply returns the RAW unprocessed value for the given property in this class
1124
+	 *
1125
+	 * @param  string $field_name A valid fieldname
1126
+	 * @return mixed              Whatever the raw value stored on the property is.
1127
+	 * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
1128
+	 */
1129
+	public function get_raw($field_name)
1130
+	{
1131
+		$field_settings = $this->get_model()->field_settings_for($field_name);
1132
+		return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
1133
+			? $this->_fields[$field_name]->format('U')
1134
+			: $this->_fields[$field_name];
1135
+	}
1136
+
1137
+
1138
+
1139
+	/**
1140
+	 * This is used to return the internal DateTime object used for a field that is a
1141
+	 * EE_Datetime_Field.
1142
+	 *
1143
+	 * @param string $field_name               The field name retrieving the DateTime object.
1144
+	 * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
1145
+	 * @throws EE_Error
1146
+	 *                                         an error is set and false returned.  If the field IS an
1147
+	 *                                         EE_Datetime_Field and but the field value is null, then
1148
+	 *                                         just null is returned (because that indicates that likely
1149
+	 *                                         this field is nullable).
1150
+	 */
1151
+	public function get_DateTime_object($field_name)
1152
+	{
1153
+		$field_settings = $this->get_model()->field_settings_for($field_name);
1154
+		if ( ! $field_settings instanceof EE_Datetime_Field) {
1155
+			EE_Error::add_error(
1156
+				sprintf(
1157
+					__(
1158
+						'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
1159
+						'event_espresso'
1160
+					),
1161
+					$field_name
1162
+				),
1163
+				__FILE__,
1164
+				__FUNCTION__,
1165
+				__LINE__
1166
+			);
1167
+			return false;
1168
+		}
1169
+		return $this->_fields[$field_name];
1170
+	}
1171
+
1172
+
1173
+
1174
+	/**
1175
+	 * To be used in template to immediately echo out the value, and format it for output.
1176
+	 * Eg, should call stripslashes and whatnot before echoing
1177
+	 *
1178
+	 * @param string $field_name      the name of the field as it appears in the DB
1179
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
1180
+	 *                                (in cases where the same property may be used for different outputs
1181
+	 *                                - i.e. datetime, money etc.)
1182
+	 * @return void
1183
+	 * @throws EE_Error
1184
+	 */
1185
+	public function e($field_name, $extra_cache_ref = null)
1186
+	{
1187
+		echo $this->get_pretty($field_name, $extra_cache_ref);
1188
+	}
1189
+
1190
+
1191
+
1192
+	/**
1193
+	 * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
1194
+	 * can be easily used as the value of form input.
1195
+	 *
1196
+	 * @param string $field_name
1197
+	 * @return void
1198
+	 * @throws EE_Error
1199
+	 */
1200
+	public function f($field_name)
1201
+	{
1202
+		$this->e($field_name, 'form_input');
1203
+	}
1204
+
1205
+
1206
+
1207
+	/**
1208
+	 * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
1209
+	 * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
1210
+	 * to see what options are available.
1211
+	 *
1212
+	 * @param string $field_name
1213
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
1214
+	 *                                (in cases where the same property may be used for different outputs
1215
+	 *                                - i.e. datetime, money etc.)
1216
+	 * @return mixed
1217
+	 * @throws EE_Error
1218
+	 */
1219
+	public function get_pretty($field_name, $extra_cache_ref = null)
1220
+	{
1221
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
1222
+	}
1223
+
1224
+
1225
+
1226
+	/**
1227
+	 * This simply returns the datetime for the given field name
1228
+	 * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
1229
+	 * (and the equivalent e_date, e_time, e_datetime).
1230
+	 *
1231
+	 * @access   protected
1232
+	 * @param string   $field_name   Field on the instantiated EE_Base_Class child object
1233
+	 * @param string   $dt_frmt      valid datetime format used for date
1234
+	 *                               (if '' then we just use the default on the field,
1235
+	 *                               if NULL we use the last-used format)
1236
+	 * @param string   $tm_frmt      Same as above except this is for time format
1237
+	 * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
1238
+	 * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
1239
+	 * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
1240
+	 *                               if field is not a valid dtt field, or void if echoing
1241
+	 * @throws EE_Error
1242
+	 */
1243
+	protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
1244
+	{
1245
+		// clear cached property
1246
+		$this->_clear_cached_property($field_name);
1247
+		//reset format properties because they are used in get()
1248
+		$this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
1249
+		$this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
1250
+		if ($echo) {
1251
+			$this->e($field_name, $date_or_time);
1252
+			return '';
1253
+		}
1254
+		return $this->get($field_name, $date_or_time);
1255
+	}
1256
+
1257
+
1258
+
1259
+	/**
1260
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
1261
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
1262
+	 * other echoes the pretty value for dtt)
1263
+	 *
1264
+	 * @param  string $field_name name of model object datetime field holding the value
1265
+	 * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
1266
+	 * @return string            datetime value formatted
1267
+	 * @throws EE_Error
1268
+	 */
1269
+	public function get_date($field_name, $format = '')
1270
+	{
1271
+		return $this->_get_datetime($field_name, $format, null, 'D');
1272
+	}
1273
+
1274
+
1275
+
1276
+	/**
1277
+	 * @param      $field_name
1278
+	 * @param string $format
1279
+	 * @throws EE_Error
1280
+	 */
1281
+	public function e_date($field_name, $format = '')
1282
+	{
1283
+		$this->_get_datetime($field_name, $format, null, 'D', true);
1284
+	}
1285
+
1286
+
1287
+
1288
+	/**
1289
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
1290
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
1291
+	 * other echoes the pretty value for dtt)
1292
+	 *
1293
+	 * @param  string $field_name name of model object datetime field holding the value
1294
+	 * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
1295
+	 * @return string             datetime value formatted
1296
+	 * @throws EE_Error
1297
+	 */
1298
+	public function get_time($field_name, $format = '')
1299
+	{
1300
+		return $this->_get_datetime($field_name, null, $format, 'T');
1301
+	}
1302
+
1303
+
1304
+
1305
+	/**
1306
+	 * @param      $field_name
1307
+	 * @param string $format
1308
+	 * @throws EE_Error
1309
+	 */
1310
+	public function e_time($field_name, $format = '')
1311
+	{
1312
+		$this->_get_datetime($field_name, null, $format, 'T', true);
1313
+	}
1314
+
1315
+
1316
+
1317
+	/**
1318
+	 * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
1319
+	 * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
1320
+	 * other echoes the pretty value for dtt)
1321
+	 *
1322
+	 * @param  string $field_name name of model object datetime field holding the value
1323
+	 * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
1324
+	 * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
1325
+	 * @return string             datetime value formatted
1326
+	 * @throws EE_Error
1327
+	 */
1328
+	public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
1329
+	{
1330
+		return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
1331
+	}
1332
+
1333
+
1334
+
1335
+	/**
1336
+	 * @param string $field_name
1337
+	 * @param string $dt_frmt
1338
+	 * @param string $tm_frmt
1339
+	 * @throws EE_Error
1340
+	 */
1341
+	public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
1342
+	{
1343
+		$this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
1344
+	}
1345
+
1346
+
1347
+
1348
+	/**
1349
+	 * Get the i8ln value for a date using the WordPress @see date_i18n function.
1350
+	 *
1351
+	 * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
1352
+	 * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
1353
+	 *                           on the object will be used.
1354
+	 * @return string Date and time string in set locale or false if no field exists for the given
1355
+	 * @throws EE_Error
1356
+	 *                           field name.
1357
+	 */
1358
+	public function get_i18n_datetime($field_name, $format = '')
1359
+	{
1360
+		$format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
1361
+		return date_i18n(
1362
+			$format,
1363
+			EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
1364
+		);
1365
+	}
1366
+
1367
+
1368
+
1369
+	/**
1370
+	 * This method validates whether the given field name is a valid field on the model object as well as it is of a
1371
+	 * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
1372
+	 * thrown.
1373
+	 *
1374
+	 * @param  string $field_name The field name being checked
1375
+	 * @throws EE_Error
1376
+	 * @return EE_Datetime_Field
1377
+	 */
1378
+	protected function _get_dtt_field_settings($field_name)
1379
+	{
1380
+		$field = $this->get_model()->field_settings_for($field_name);
1381
+		//check if field is dtt
1382
+		if ($field instanceof EE_Datetime_Field) {
1383
+			return $field;
1384
+		} else {
1385
+			throw new EE_Error(sprintf(__('The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
1386
+				'event_espresso'), $field_name, self::_get_model_classname(get_class($this))));
1387
+		}
1388
+	}
1389
+
1390
+
1391
+
1392
+
1393
+	/**
1394
+	 * NOTE ABOUT BELOW:
1395
+	 * These convenience date and time setters are for setting date and time independently.  In other words you might
1396
+	 * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
1397
+	 * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
1398
+	 * method and make sure you send the entire datetime value for setting.
1399
+	 */
1400
+	/**
1401
+	 * sets the time on a datetime property
1402
+	 *
1403
+	 * @access protected
1404
+	 * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
1405
+	 * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
1406
+	 * @throws EE_Error
1407
+	 */
1408
+	protected function _set_time_for($time, $fieldname)
1409
+	{
1410
+		$this->_set_date_time('T', $time, $fieldname);
1411
+	}
1412
+
1413
+
1414
+
1415
+	/**
1416
+	 * sets the date on a datetime property
1417
+	 *
1418
+	 * @access protected
1419
+	 * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
1420
+	 * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
1421
+	 * @throws EE_Error
1422
+	 */
1423
+	protected function _set_date_for($date, $fieldname)
1424
+	{
1425
+		$this->_set_date_time('D', $date, $fieldname);
1426
+	}
1427
+
1428
+
1429
+
1430
+	/**
1431
+	 * This takes care of setting a date or time independently on a given model object property. This method also
1432
+	 * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
1433
+	 *
1434
+	 * @access protected
1435
+	 * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
1436
+	 * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
1437
+	 * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
1438
+	 *                                        EE_Datetime_Field property)
1439
+	 * @throws EE_Error
1440
+	 */
1441
+	protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
1442
+	{
1443
+		$field = $this->_get_dtt_field_settings($fieldname);
1444
+		$field->set_timezone($this->_timezone);
1445
+		$field->set_date_format($this->_dt_frmt);
1446
+		$field->set_time_format($this->_tm_frmt);
1447
+		switch ($what) {
1448
+			case 'T' :
1449
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
1450
+					$datetime_value,
1451
+					$this->_fields[$fieldname]
1452
+				);
1453
+				break;
1454
+			case 'D' :
1455
+				$this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
1456
+					$datetime_value,
1457
+					$this->_fields[$fieldname]
1458
+				);
1459
+				break;
1460
+			case 'B' :
1461
+				$this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
1462
+				break;
1463
+		}
1464
+		$this->_clear_cached_property($fieldname);
1465
+	}
1466
+
1467
+
1468
+
1469
+	/**
1470
+	 * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
1471
+	 * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
1472
+	 * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
1473
+	 * that could lead to some unexpected results!
1474
+	 *
1475
+	 * @access public
1476
+	 * @param string               $field_name This is the name of the field on the object that contains the date/time
1477
+	 *                                         value being returned.
1478
+	 * @param string               $callback   must match a valid method in this class (defaults to get_datetime)
1479
+	 * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
1480
+	 * @param string               $prepend    You can include something to prepend on the timestamp
1481
+	 * @param string               $append     You can include something to append on the timestamp
1482
+	 * @throws EE_Error
1483
+	 * @return string timestamp
1484
+	 */
1485
+	public function display_in_my_timezone(
1486
+		$field_name,
1487
+		$callback = 'get_datetime',
1488
+		$args = null,
1489
+		$prepend = '',
1490
+		$append = ''
1491
+	) {
1492
+		$timezone = EEH_DTT_Helper::get_timezone();
1493
+		if ($timezone === $this->_timezone) {
1494
+			return '';
1495
+		}
1496
+		$original_timezone = $this->_timezone;
1497
+		$this->set_timezone($timezone);
1498
+		$fn = (array)$field_name;
1499
+		$args = array_merge($fn, (array)$args);
1500
+		if ( ! method_exists($this, $callback)) {
1501
+			throw new EE_Error(
1502
+				sprintf(
1503
+					__(
1504
+						'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
1505
+						'event_espresso'
1506
+					),
1507
+					$callback
1508
+				)
1509
+			);
1510
+		}
1511
+		$args = (array)$args;
1512
+		$return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
1513
+		$this->set_timezone($original_timezone);
1514
+		return $return;
1515
+	}
1516
+
1517
+
1518
+
1519
+	/**
1520
+	 * Deletes this model object.
1521
+	 * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
1522
+	 * override
1523
+	 * `EE_Base_Class::_delete` NOT this class.
1524
+	 *
1525
+	 * @return boolean | int
1526
+	 * @throws EE_Error
1527
+	 */
1528
+	public function delete()
1529
+	{
1530
+		/**
1531
+		 * Called just before the `EE_Base_Class::_delete` method call.
1532
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
1533
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example, `EE_Soft_Delete_Base_Class::_delete`
1534
+		 * soft deletes (trash) the object and does not permanently delete it.
1535
+		 *
1536
+		 * @param EE_Base_Class $model_object about to be 'deleted'
1537
+		 */
1538
+		do_action('AHEE__EE_Base_Class__delete__before', $this);
1539
+		$result = $this->_delete();
1540
+		/**
1541
+		 * Called just after the `EE_Base_Class::_delete` method call.
1542
+		 * Note: `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
1543
+		 * should be aware that `_delete` may not always result in a permanent delete.  For example `EE_Soft_Base_Class::_delete`
1544
+		 * soft deletes (trash) the object and does not permanently delete it.
1545
+		 *
1546
+		 * @param EE_Base_Class $model_object that was just 'deleted'
1547
+		 * @param boolean       $result
1548
+		 */
1549
+		do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
1550
+		return $result;
1551
+	}
1552
+
1553
+
1554
+
1555
+	/**
1556
+	 * Calls the specific delete method for the instantiated class.
1557
+	 * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
1558
+	 * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
1559
+	 * `EE_Base_Class::delete`
1560
+	 *
1561
+	 * @return bool|int
1562
+	 * @throws EE_Error
1563
+	 */
1564
+	protected function _delete()
1565
+	{
1566
+		return $this->delete_permanently();
1567
+	}
1568
+
1569
+
1570
+
1571
+	/**
1572
+	 * Deletes this model object permanently from db (but keep in mind related models my block the delete and return an
1573
+	 * error)
1574
+	 *
1575
+	 * @return bool | int
1576
+	 * @throws EE_Error
1577
+	 */
1578
+	public function delete_permanently()
1579
+	{
1580
+		/**
1581
+		 * Called just before HARD deleting a model object
1582
+		 *
1583
+		 * @param EE_Base_Class $model_object about to be 'deleted'
1584
+		 */
1585
+		do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
1586
+		$model = $this->get_model();
1587
+		$result = $model->delete_permanently_by_ID($this->ID());
1588
+		$this->refresh_cache_of_related_objects();
1589
+		/**
1590
+		 * Called just after HARD deleting a model object
1591
+		 *
1592
+		 * @param EE_Base_Class $model_object that was just 'deleted'
1593
+		 * @param boolean       $result
1594
+		 */
1595
+		do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
1596
+		return $result;
1597
+	}
1598
+
1599
+
1600
+
1601
+	/**
1602
+	 * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
1603
+	 * related model objects
1604
+	 *
1605
+	 * @throws EE_Error
1606
+	 */
1607
+	public function refresh_cache_of_related_objects()
1608
+	{
1609
+		$model = $this->get_model();
1610
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
1611
+			if ( ! empty($this->_model_relations[$relation_name])) {
1612
+				$related_objects = $this->_model_relations[$relation_name];
1613
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
1614
+					//this relation only stores a single model object, not an array
1615
+					//but let's make it consistent
1616
+					$related_objects = array($related_objects);
1617
+				}
1618
+				foreach ($related_objects as $related_object) {
1619
+					//only refresh their cache if they're in memory
1620
+					if ($related_object instanceof EE_Base_Class) {
1621
+						$related_object->clear_cache($model->get_this_model_name(), $this);
1622
+					}
1623
+				}
1624
+			}
1625
+		}
1626
+	}
1627
+
1628
+
1629
+
1630
+	/**
1631
+	 *        Saves this object to the database. An array may be supplied to set some values on this
1632
+	 * object just before saving.
1633
+	 *
1634
+	 * @access public
1635
+	 * @param array $set_cols_n_values keys are field names, values are their new values,
1636
+	 *                                 if provided during the save() method (often client code will change the fields'
1637
+	 *                                 values before calling save)
1638
+	 * @throws EE_Error
1639
+	 * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
1640
+	 *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
1641
+	 */
1642
+	public function save($set_cols_n_values = array())
1643
+	{
1644
+		$model = $this->get_model();
1645
+		/**
1646
+		 * Filters the fields we're about to save on the model object
1647
+		 *
1648
+		 * @param array         $set_cols_n_values
1649
+		 * @param EE_Base_Class $model_object
1650
+		 */
1651
+		$set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
1652
+			$this);
1653
+		//set attributes as provided in $set_cols_n_values
1654
+		foreach ($set_cols_n_values as $column => $value) {
1655
+			$this->set($column, $value);
1656
+		}
1657
+		// no changes ? then don't do anything
1658
+		if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
1659
+			return 0;
1660
+		}
1661
+		/**
1662
+		 * Saving a model object.
1663
+		 * Before we perform a save, this action is fired.
1664
+		 *
1665
+		 * @param EE_Base_Class $model_object the model object about to be saved.
1666
+		 */
1667
+		do_action('AHEE__EE_Base_Class__save__begin', $this);
1668
+		if ( ! $this->allow_persist()) {
1669
+			return 0;
1670
+		}
1671
+		//now get current attribute values
1672
+		$save_cols_n_values = $this->_fields;
1673
+		//if the object already has an ID, update it. Otherwise, insert it
1674
+		//also: change the assumption about values passed to the model NOT being prepare dby the model object. They have been
1675
+		$old_assumption_concerning_value_preparation = $model
1676
+															->get_assumption_concerning_values_already_prepared_by_model_object();
1677
+		$model->assume_values_already_prepared_by_model_object(true);
1678
+		//does this model have an autoincrement PK?
1679
+		if ($model->has_primary_key_field()) {
1680
+			if ($model->get_primary_key_field()->is_auto_increment()) {
1681
+				//ok check if it's set, if so: update; if not, insert
1682
+				if ( ! empty($save_cols_n_values[$model->primary_key_name()])) {
1683
+					$results = $model->update_by_ID($save_cols_n_values, $this->ID());
1684
+				} else {
1685
+					unset($save_cols_n_values[$model->primary_key_name()]);
1686
+					$results = $model->insert($save_cols_n_values);
1687
+					if ($results) {
1688
+						//if successful, set the primary key
1689
+						//but don't use the normal SET method, because it will check if
1690
+						//an item with the same ID exists in the mapper & db, then
1691
+						//will find it in the db (because we just added it) and THAT object
1692
+						//will get added to the mapper before we can add this one!
1693
+						//but if we just avoid using the SET method, all that headache can be avoided
1694
+						$pk_field_name = $model->primary_key_name();
1695
+						$this->_fields[$pk_field_name] = $results;
1696
+						$this->_clear_cached_property($pk_field_name);
1697
+						$model->add_to_entity_map($this);
1698
+						$this->_update_cached_related_model_objs_fks();
1699
+					}
1700
+				}
1701
+			} else {//PK is NOT auto-increment
1702
+				//so check if one like it already exists in the db
1703
+				if ($model->exists_by_ID($this->ID())) {
1704
+					if (WP_DEBUG && ! $this->in_entity_map()) {
1705
+						throw new EE_Error(
1706
+							sprintf(
1707
+								__('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
1708
+									'event_espresso'),
1709
+								get_class($this),
1710
+								get_class($model) . '::instance()->add_to_entity_map()',
1711
+								get_class($model) . '::instance()->get_one_by_ID()',
1712
+								'<br />'
1713
+							)
1714
+						);
1715
+					}
1716
+					$results = $model->update_by_ID($save_cols_n_values, $this->ID());
1717
+				} else {
1718
+					$results = $model->insert($save_cols_n_values);
1719
+					$this->_update_cached_related_model_objs_fks();
1720
+				}
1721
+			}
1722
+		} else {//there is NO primary key
1723
+			$already_in_db = false;
1724
+			foreach ($model->unique_indexes() as $index) {
1725
+				$uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
1726
+				if ($model->exists(array($uniqueness_where_params))) {
1727
+					$already_in_db = true;
1728
+				}
1729
+			}
1730
+			if ($already_in_db) {
1731
+				$combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
1732
+					$model->get_combined_primary_key_fields());
1733
+				$results = $model->update($save_cols_n_values, $combined_pk_fields_n_values);
1734
+			} else {
1735
+				$results = $model->insert($save_cols_n_values);
1736
+			}
1737
+		}
1738
+		//restore the old assumption about values being prepared by the model object
1739
+		$model
1740
+			 ->assume_values_already_prepared_by_model_object($old_assumption_concerning_value_preparation);
1741
+		/**
1742
+		 * After saving the model object this action is called
1743
+		 *
1744
+		 * @param EE_Base_Class $model_object which was just saved
1745
+		 * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
1746
+		 *                                    the new ID (or 0 if an error occurred and it wasn't updated)
1747
+		 */
1748
+		do_action('AHEE__EE_Base_Class__save__end', $this, $results);
1749
+		$this->_has_changes = false;
1750
+		return $results;
1751
+	}
1752
+
1753
+
1754
+
1755
+	/**
1756
+	 * Updates the foreign key on related models objects pointing to this to have this model object's ID
1757
+	 * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
1758
+	 * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
1759
+	 * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
1760
+	 * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
1761
+	 * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
1762
+	 * or not they exist in the DB (if they do, their DB records will be automatically updated)
1763
+	 *
1764
+	 * @return void
1765
+	 * @throws EE_Error
1766
+	 */
1767
+	protected function _update_cached_related_model_objs_fks()
1768
+	{
1769
+		$model = $this->get_model();
1770
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
1771
+			if ($relation_obj instanceof EE_Has_Many_Relation) {
1772
+				foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
1773
+					$fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
1774
+						$model->get_this_model_name()
1775
+					);
1776
+					$related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
1777
+					if ($related_model_obj_in_cache->ID()) {
1778
+						$related_model_obj_in_cache->save();
1779
+					}
1780
+				}
1781
+			}
1782
+		}
1783
+	}
1784
+
1785
+
1786
+
1787
+	/**
1788
+	 * Saves this model object and its NEW cached relations to the database.
1789
+	 * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
1790
+	 * In order for that to work, we would need to mark model objects as dirty/clean...
1791
+	 * because otherwise, there's a potential for infinite looping of saving
1792
+	 * Saves the cached related model objects, and ensures the relation between them
1793
+	 * and this object and properly setup
1794
+	 *
1795
+	 * @return int ID of new model object on save; 0 on failure+
1796
+	 * @throws EE_Error
1797
+	 */
1798
+	public function save_new_cached_related_model_objs()
1799
+	{
1800
+		//make sure this has been saved
1801
+		if ( ! $this->ID()) {
1802
+			$id = $this->save();
1803
+		} else {
1804
+			$id = $this->ID();
1805
+		}
1806
+		//now save all the NEW cached model objects  (ie they don't exist in the DB)
1807
+		foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
1808
+			if ($this->_model_relations[$relationName]) {
1809
+				//is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
1810
+				//or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
1811
+				if ($relationObj instanceof EE_Belongs_To_Relation) {
1812
+					//add a relation to that relation type (which saves the appropriate thing in the process)
1813
+					//but ONLY if it DOES NOT exist in the DB
1814
+					/* @var $related_model_obj EE_Base_Class */
1815
+					$related_model_obj = $this->_model_relations[$relationName];
1816
+					//					if( ! $related_model_obj->ID()){
1817
+					$this->_add_relation_to($related_model_obj, $relationName);
1818
+					$related_model_obj->save_new_cached_related_model_objs();
1819
+					//					}
1820
+				} else {
1821
+					foreach ($this->_model_relations[$relationName] as $related_model_obj) {
1822
+						//add a relation to that relation type (which saves the appropriate thing in the process)
1823
+						//but ONLY if it DOES NOT exist in the DB
1824
+						//						if( ! $related_model_obj->ID()){
1825
+						$this->_add_relation_to($related_model_obj, $relationName);
1826
+						$related_model_obj->save_new_cached_related_model_objs();
1827
+						//						}
1828
+					}
1829
+				}
1830
+			}
1831
+		}
1832
+		return $id;
1833
+	}
1834
+
1835
+
1836
+
1837
+	/**
1838
+	 * for getting a model while instantiated.
1839
+	 *
1840
+	 * @return \EEM_Base | \EEM_CPT_Base
1841
+	 */
1842
+	public function get_model()
1843
+	{
1844
+		if( ! $this->_model){
1845
+			$modelName = self::_get_model_classname(get_class($this));
1846
+			$this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
1847
+		} else {
1848
+			$this->_model->set_timezone($this->_timezone);
1849
+		}
1850
+
1851
+		return $this->_model;
1852
+	}
1853
+
1854
+
1855
+
1856
+	/**
1857
+	 * @param $props_n_values
1858
+	 * @param $classname
1859
+	 * @return mixed bool|EE_Base_Class|EEM_CPT_Base
1860
+	 * @throws EE_Error
1861
+	 */
1862
+	protected static function _get_object_from_entity_mapper($props_n_values, $classname)
1863
+	{
1864
+		//TODO: will not work for Term_Relationships because they have no PK!
1865
+		$primary_id_ref = self::_get_primary_key_name($classname);
1866
+		if (array_key_exists($primary_id_ref, $props_n_values) && ! empty($props_n_values[$primary_id_ref])) {
1867
+			$id = $props_n_values[$primary_id_ref];
1868
+			return self::_get_model($classname)->get_from_entity_map($id);
1869
+		}
1870
+		return false;
1871
+	}
1872
+
1873
+
1874
+
1875
+	/**
1876
+	 * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
1877
+	 * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
1878
+	 * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
1879
+	 * we return false.
1880
+	 *
1881
+	 * @param  array  $props_n_values   incoming array of properties and their values
1882
+	 * @param  string $classname        the classname of the child class
1883
+	 * @param null    $timezone
1884
+	 * @param array   $date_formats     incoming date_formats in an array where the first value is the
1885
+	 *                                  date_format and the second value is the time format
1886
+	 * @return mixed (EE_Base_Class|bool)
1887
+	 * @throws EE_Error
1888
+	 */
1889
+	protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
1890
+	{
1891
+		$existing = null;
1892
+		$model = self::_get_model($classname, $timezone);
1893
+		if ($model->has_primary_key_field()) {
1894
+			$primary_id_ref = self::_get_primary_key_name($classname);
1895
+			if (array_key_exists($primary_id_ref, $props_n_values)
1896
+				&& ! empty($props_n_values[$primary_id_ref])
1897
+			) {
1898
+				$existing = $model->get_one_by_ID(
1899
+					$props_n_values[$primary_id_ref]
1900
+				);
1901
+			}
1902
+		} elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
1903
+			//no primary key on this model, but there's still a matching item in the DB
1904
+			$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
1905
+				self::_get_model($classname, $timezone)->get_index_primary_key_string($props_n_values)
1906
+			);
1907
+		}
1908
+		if ($existing) {
1909
+			//set date formats if present before setting values
1910
+			if ( ! empty($date_formats) && is_array($date_formats)) {
1911
+				$existing->set_date_format($date_formats[0]);
1912
+				$existing->set_time_format($date_formats[1]);
1913
+			} else {
1914
+				//set default formats for date and time
1915
+				$existing->set_date_format(get_option('date_format'));
1916
+				$existing->set_time_format(get_option('time_format'));
1917
+			}
1918
+			foreach ($props_n_values as $property => $field_value) {
1919
+				$existing->set($property, $field_value);
1920
+			}
1921
+			return $existing;
1922
+		} else {
1923
+			return false;
1924
+		}
1925
+	}
1926
+
1927
+
1928
+
1929
+	/**
1930
+	 * Gets the EEM_*_Model for this class
1931
+	 *
1932
+	 * @access public now, as this is more convenient
1933
+	 * @param      $classname
1934
+	 * @param null $timezone
1935
+	 * @throws EE_Error
1936
+	 * @return EEM_Base
1937
+	 */
1938
+	protected static function _get_model($classname, $timezone = null)
1939
+	{
1940
+		//find model for this class
1941
+		if ( ! $classname) {
1942
+			throw new EE_Error(
1943
+				sprintf(
1944
+					__(
1945
+						"What were you thinking calling _get_model(%s)?? You need to specify the class name",
1946
+						"event_espresso"
1947
+					),
1948
+					$classname
1949
+				)
1950
+			);
1951
+		}
1952
+		$modelName = self::_get_model_classname($classname);
1953
+		return self::_get_model_instance_with_name($modelName, $timezone);
1954
+	}
1955
+
1956
+
1957
+
1958
+	/**
1959
+	 * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
1960
+	 *
1961
+	 * @param string $model_classname
1962
+	 * @param null   $timezone
1963
+	 * @return EEM_Base
1964
+	 */
1965
+	protected static function _get_model_instance_with_name($model_classname, $timezone = null)
1966
+	{
1967
+		$model_classname = str_replace('EEM_', '', $model_classname);
1968
+		$model = EE_Registry::instance()->load_model($model_classname);
1969
+		$model->set_timezone($timezone);
1970
+		return $model;
1971
+	}
1972
+
1973
+
1974
+
1975
+	/**
1976
+	 * If a model name is provided (eg Registration), gets the model classname for that model.
1977
+	 * Also works if a model class's classname is provided (eg EE_Registration).
1978
+	 *
1979
+	 * @param null $model_name
1980
+	 * @return string like EEM_Attendee
1981
+	 */
1982
+	private static function _get_model_classname($model_name = null)
1983
+	{
1984
+		if (strpos($model_name, "EE_") === 0) {
1985
+			$model_classname = str_replace("EE_", "EEM_", $model_name);
1986
+		} else {
1987
+			$model_classname = "EEM_" . $model_name;
1988
+		}
1989
+		return $model_classname;
1990
+	}
1991
+
1992
+
1993
+
1994
+	/**
1995
+	 * returns the name of the primary key attribute
1996
+	 *
1997
+	 * @param null $classname
1998
+	 * @throws EE_Error
1999
+	 * @return string
2000
+	 */
2001
+	protected static function _get_primary_key_name($classname = null)
2002
+	{
2003
+		if ( ! $classname) {
2004
+			throw new EE_Error(
2005
+				sprintf(
2006
+					__("What were you thinking calling _get_primary_key_name(%s)", "event_espresso"),
2007
+					$classname
2008
+				)
2009
+			);
2010
+		}
2011
+		return self::_get_model($classname)->get_primary_key_field()->get_name();
2012
+	}
2013
+
2014
+
2015
+
2016
+	/**
2017
+	 * Gets the value of the primary key.
2018
+	 * If the object hasn't yet been saved, it should be whatever the model field's default was
2019
+	 * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
2020
+	 * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
2021
+	 *
2022
+	 * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
2023
+	 * @throws EE_Error
2024
+	 */
2025
+	public function ID()
2026
+	{
2027
+		$model = $this->get_model();
2028
+		//now that we know the name of the variable, use a variable variable to get its value and return its
2029
+		if ($model->has_primary_key_field()) {
2030
+			return $this->_fields[$model->primary_key_name()];
2031
+		} else {
2032
+			return $model->get_index_primary_key_string($this->_fields);
2033
+		}
2034
+	}
2035
+
2036
+
2037
+
2038
+	/**
2039
+	 * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
2040
+	 * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
2041
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
2042
+	 *
2043
+	 * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
2044
+	 * @param string $relationName                     eg 'Events','Question',etc.
2045
+	 *                                                 an attendee to a group, you also want to specify which role they
2046
+	 *                                                 will have in that group. So you would use this parameter to
2047
+	 *                                                 specify array('role-column-name'=>'role-id')
2048
+	 * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
2049
+	 *                                                 allow you to further constrict the relation to being added.
2050
+	 *                                                 However, keep in mind that the columns (keys) given must match a
2051
+	 *                                                 column on the JOIN table and currently only the HABTM models
2052
+	 *                                                 accept these additional conditions.  Also remember that if an
2053
+	 *                                                 exact match isn't found for these extra cols/val pairs, then a
2054
+	 *                                                 NEW row is created in the join table.
2055
+	 * @param null   $cache_id
2056
+	 * @throws EE_Error
2057
+	 * @return EE_Base_Class the object the relation was added to
2058
+	 */
2059
+	public function _add_relation_to(
2060
+		$otherObjectModelObjectOrID,
2061
+		$relationName,
2062
+		$extra_join_model_fields_n_values = array(),
2063
+		$cache_id = null
2064
+	) {
2065
+		$model = $this->get_model();
2066
+		//if this thing exists in the DB, save the relation to the DB
2067
+		if ($this->ID()) {
2068
+			$otherObject = $model
2069
+								->add_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
2070
+									$extra_join_model_fields_n_values);
2071
+			//clear cache so future get_many_related and get_first_related() return new results.
2072
+			$this->clear_cache($relationName, $otherObject, true);
2073
+			if ($otherObject instanceof EE_Base_Class) {
2074
+				$otherObject->clear_cache($model->get_this_model_name(), $this);
2075
+			}
2076
+		} else {
2077
+			//this thing doesn't exist in the DB,  so just cache it
2078
+			if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
2079
+				throw new EE_Error(sprintf(
2080
+					__('Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
2081
+						'event_espresso'),
2082
+					$otherObjectModelObjectOrID,
2083
+					get_class($this)
2084
+				));
2085
+			} else {
2086
+				$otherObject = $otherObjectModelObjectOrID;
2087
+			}
2088
+			$this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
2089
+		}
2090
+		if ($otherObject instanceof EE_Base_Class) {
2091
+			//fix the reciprocal relation too
2092
+			if ($otherObject->ID()) {
2093
+				//its saved so assumed relations exist in the DB, so we can just
2094
+				//clear the cache so future queries use the updated info in the DB
2095
+				$otherObject->clear_cache($model->get_this_model_name(), null, true);
2096
+			} else {
2097
+				//it's not saved, so it caches relations like this
2098
+				$otherObject->cache($model->get_this_model_name(), $this);
2099
+			}
2100
+		}
2101
+		return $otherObject;
2102
+	}
2103
+
2104
+
2105
+
2106
+	/**
2107
+	 * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
2108
+	 * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
2109
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
2110
+	 * from the cache
2111
+	 *
2112
+	 * @param mixed  $otherObjectModelObjectOrID
2113
+	 *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
2114
+	 *                to the DB yet
2115
+	 * @param string $relationName
2116
+	 * @param array  $where_query
2117
+	 *                You can optionally include an array of key=>value pairs that allow you to further constrict the
2118
+	 *                relation to being added. However, keep in mind that the columns (keys) given must match a column
2119
+	 *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
2120
+	 *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
2121
+	 *                created in the join table.
2122
+	 * @return EE_Base_Class the relation was removed from
2123
+	 * @throws EE_Error
2124
+	 */
2125
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
2126
+	{
2127
+		if ($this->ID()) {
2128
+			//if this exists in the DB, save the relation change to the DB too
2129
+			$otherObject = $this->get_model()
2130
+								->remove_relationship_to($this, $otherObjectModelObjectOrID, $relationName,
2131
+									$where_query);
2132
+			$this->clear_cache($relationName, $otherObject);
2133
+		} else {
2134
+			//this doesn't exist in the DB, just remove it from the cache
2135
+			$otherObject = $this->clear_cache($relationName, $otherObjectModelObjectOrID);
2136
+		}
2137
+		if ($otherObject instanceof EE_Base_Class) {
2138
+			$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
2139
+		}
2140
+		return $otherObject;
2141
+	}
2142
+
2143
+
2144
+
2145
+	/**
2146
+	 * Removes ALL the related things for the $relationName.
2147
+	 *
2148
+	 * @param string $relationName
2149
+	 * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
2150
+	 * @return EE_Base_Class
2151
+	 * @throws EE_Error
2152
+	 */
2153
+	public function _remove_relations($relationName, $where_query_params = array())
2154
+	{
2155
+		if ($this->ID()) {
2156
+			//if this exists in the DB, save the relation change to the DB too
2157
+			$otherObjects = $this->get_model()->remove_relations($this, $relationName, $where_query_params);
2158
+			$this->clear_cache($relationName, null, true);
2159
+		} else {
2160
+			//this doesn't exist in the DB, just remove it from the cache
2161
+			$otherObjects = $this->clear_cache($relationName, null, true);
2162
+		}
2163
+		if (is_array($otherObjects)) {
2164
+			foreach ($otherObjects as $otherObject) {
2165
+				$otherObject->clear_cache($this->get_model()->get_this_model_name(), $this);
2166
+			}
2167
+		}
2168
+		return $otherObjects;
2169
+	}
2170
+
2171
+
2172
+
2173
+	/**
2174
+	 * Gets all the related model objects of the specified type. Eg, if the current class if
2175
+	 * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
2176
+	 * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
2177
+	 * because we want to get even deleted items etc.
2178
+	 *
2179
+	 * @param string $relationName key in the model's _model_relations array
2180
+	 * @param array  $query_params like EEM_Base::get_all
2181
+	 * @return EE_Base_Class[] Results not necessarily indexed by IDs, because some results might not have primary keys
2182
+	 * @throws EE_Error
2183
+	 *                             or might not be saved yet. Consider using EEM_Base::get_IDs() on these results if
2184
+	 *                             you want IDs
2185
+	 */
2186
+	public function get_many_related($relationName, $query_params = array())
2187
+	{
2188
+		if ($this->ID()) {
2189
+			//this exists in the DB, so get the related things from either the cache or the DB
2190
+			//if there are query parameters, forget about caching the related model objects.
2191
+			if ($query_params) {
2192
+				$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
2193
+			} else {
2194
+				//did we already cache the result of this query?
2195
+				$cached_results = $this->get_all_from_cache($relationName);
2196
+				if ( ! $cached_results) {
2197
+					$related_model_objects = $this->get_model()->get_all_related($this, $relationName, $query_params);
2198
+					//if no query parameters were passed, then we got all the related model objects
2199
+					//for that relation. We can cache them then.
2200
+					foreach ($related_model_objects as $related_model_object) {
2201
+						$this->cache($relationName, $related_model_object);
2202
+					}
2203
+				} else {
2204
+					$related_model_objects = $cached_results;
2205
+				}
2206
+			}
2207
+		} else {
2208
+			//this doesn't exist in the DB, so just get the related things from the cache
2209
+			$related_model_objects = $this->get_all_from_cache($relationName);
2210
+		}
2211
+		return $related_model_objects;
2212
+	}
2213
+
2214
+
2215
+
2216
+	/**
2217
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2218
+	 * unless otherwise specified in the $query_params
2219
+	 *
2220
+	 * @param string $relation_name  model_name like 'Event', or 'Registration'
2221
+	 * @param array  $query_params   like EEM_Base::get_all's
2222
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
2223
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2224
+	 *                               that by the setting $distinct to TRUE;
2225
+	 * @return int
2226
+	 */
2227
+	public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
2228
+	{
2229
+		return $this->get_model()->count_related($this, $relation_name, $query_params, $field_to_count, $distinct);
2230
+	}
2231
+
2232
+
2233
+
2234
+	/**
2235
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
2236
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2237
+	 *
2238
+	 * @param string $relation_name model_name like 'Event', or 'Registration'
2239
+	 * @param array  $query_params  like EEM_Base::get_all's
2240
+	 * @param string $field_to_sum  name of field to count by.
2241
+	 *                              By default, uses primary key (which doesn't make much sense, so you should probably
2242
+	 *                              change it)
2243
+	 * @return int
2244
+	 */
2245
+	public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
2246
+	{
2247
+		return $this->get_model()->sum_related($this, $relation_name, $query_params, $field_to_sum);
2248
+	}
2249
+
2250
+
2251
+
2252
+	/**
2253
+	 * Gets the first (ie, one) related model object of the specified type.
2254
+	 *
2255
+	 * @param string $relationName key in the model's _model_relations array
2256
+	 * @param array  $query_params like EEM_Base::get_all
2257
+	 * @return EE_Base_Class (not an array, a single object)
2258
+	 * @throws EE_Error
2259
+	 */
2260
+	public function get_first_related($relationName, $query_params = array())
2261
+	{
2262
+		$model = $this->get_model();
2263
+		if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
2264
+			//if they've provided some query parameters, don't bother trying to cache the result
2265
+			//also make sure we're not caching the result of get_first_related
2266
+			//on a relation which should have an array of objects (because the cache might have an array of objects)
2267
+			if ($query_params
2268
+				|| ! $model->related_settings_for($relationName)
2269
+					 instanceof
2270
+					 EE_Belongs_To_Relation
2271
+			) {
2272
+				$related_model_object = $model->get_first_related($this, $relationName, $query_params);
2273
+			} else {
2274
+				//first, check if we've already cached the result of this query
2275
+				$cached_result = $this->get_one_from_cache($relationName);
2276
+				if ( ! $cached_result) {
2277
+					$related_model_object = $model->get_first_related($this, $relationName, $query_params);
2278
+					$this->cache($relationName, $related_model_object);
2279
+				} else {
2280
+					$related_model_object = $cached_result;
2281
+				}
2282
+			}
2283
+		} else {
2284
+			$related_model_object = null;
2285
+			//this doesn't exist in the Db, but maybe the relation is of type belongs to, and so the related thing might
2286
+			if ($model->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
2287
+				$related_model_object = $model->get_first_related($this, $relationName, $query_params);
2288
+			}
2289
+			//this doesn't exist in the DB and apparently the thing it belongs to doesn't either, just get what's cached on this object
2290
+			if ( ! $related_model_object) {
2291
+				$related_model_object = $this->get_one_from_cache($relationName);
2292
+			}
2293
+		}
2294
+		return $related_model_object;
2295
+	}
2296
+
2297
+
2298
+
2299
+	/**
2300
+	 * Does a delete on all related objects of type $relationName and removes
2301
+	 * the current model object's relation to them. If they can't be deleted (because
2302
+	 * of blocking related model objects) does nothing. If the related model objects are
2303
+	 * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
2304
+	 * If this model object doesn't exist yet in the DB, just removes its related things
2305
+	 *
2306
+	 * @param string $relationName
2307
+	 * @param array  $query_params like EEM_Base::get_all's
2308
+	 * @return int how many deleted
2309
+	 * @throws EE_Error
2310
+	 */
2311
+	public function delete_related($relationName, $query_params = array())
2312
+	{
2313
+		if ($this->ID()) {
2314
+			$count = $this->get_model()->delete_related($this, $relationName, $query_params);
2315
+		} else {
2316
+			$count = count($this->get_all_from_cache($relationName));
2317
+			$this->clear_cache($relationName, null, true);
2318
+		}
2319
+		return $count;
2320
+	}
2321
+
2322
+
2323
+
2324
+	/**
2325
+	 * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
2326
+	 * the current model object's relation to them. If they can't be deleted (because
2327
+	 * of blocking related model objects) just does a soft delete on it instead, if possible.
2328
+	 * If the related thing isn't a soft-deletable model object, this function is identical
2329
+	 * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
2330
+	 *
2331
+	 * @param string $relationName
2332
+	 * @param array  $query_params like EEM_Base::get_all's
2333
+	 * @return int how many deleted (including those soft deleted)
2334
+	 * @throws EE_Error
2335
+	 */
2336
+	public function delete_related_permanently($relationName, $query_params = array())
2337
+	{
2338
+		if ($this->ID()) {
2339
+			$count = $this->get_model()->delete_related_permanently($this, $relationName, $query_params);
2340
+		} else {
2341
+			$count = count($this->get_all_from_cache($relationName));
2342
+		}
2343
+		$this->clear_cache($relationName, null, true);
2344
+		return $count;
2345
+	}
2346
+
2347
+
2348
+
2349
+	/**
2350
+	 * is_set
2351
+	 * Just a simple utility function children can use for checking if property exists
2352
+	 *
2353
+	 * @access  public
2354
+	 * @param  string $field_name property to check
2355
+	 * @return bool                              TRUE if existing,FALSE if not.
2356
+	 */
2357
+	public function is_set($field_name)
2358
+	{
2359
+		return isset($this->_fields[$field_name]);
2360
+	}
2361
+
2362
+
2363
+
2364
+	/**
2365
+	 * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
2366
+	 * EE_Error exception if they don't
2367
+	 *
2368
+	 * @param  mixed (string|array) $properties properties to check
2369
+	 * @throws EE_Error
2370
+	 * @return bool                              TRUE if existing, throw EE_Error if not.
2371
+	 */
2372
+	protected function _property_exists($properties)
2373
+	{
2374
+		foreach ((array)$properties as $property_name) {
2375
+			//first make sure this property exists
2376
+			if ( ! $this->_fields[$property_name]) {
2377
+				throw new EE_Error(
2378
+					sprintf(
2379
+						__(
2380
+							'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
2381
+							'event_espresso'
2382
+						),
2383
+						$property_name
2384
+					)
2385
+				);
2386
+			}
2387
+		}
2388
+		return true;
2389
+	}
2390
+
2391
+
2392
+
2393
+	/**
2394
+	 * This simply returns an array of model fields for this object
2395
+	 *
2396
+	 * @return array
2397
+	 * @throws EE_Error
2398
+	 */
2399
+	public function model_field_array()
2400
+	{
2401
+		$fields = $this->get_model()->field_settings(false);
2402
+		$properties = array();
2403
+		//remove prepended underscore
2404
+		foreach ($fields as $field_name => $settings) {
2405
+			$properties[$field_name] = $this->get($field_name);
2406
+		}
2407
+		return $properties;
2408
+	}
2409
+
2410
+
2411
+
2412
+	/**
2413
+	 * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
2414
+	 * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
2415
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
2416
+	 * requiring a plugin to extend the EE_Base_Class (which works fine is there's only 1 plugin, but when will that
2417
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
2418
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
2419
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
2420
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
2421
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
2422
+	 * my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
2423
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
2424
+	 *        return $previousReturnValue.$returnString;
2425
+	 * }
2426
+	 * require('EE_Answer.class.php');
2427
+	 * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
2428
+	 * echo $answer->my_callback('monkeys',100);
2429
+	 * //will output "you called my_callback! and passed args:monkeys,100"
2430
+	 *
2431
+	 * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
2432
+	 * @param array  $args       array of original arguments passed to the function
2433
+	 * @throws EE_Error
2434
+	 * @return mixed whatever the plugin which calls add_filter decides
2435
+	 */
2436
+	public function __call($methodName, $args)
2437
+	{
2438
+		$className = get_class($this);
2439
+		$tagName = "FHEE__{$className}__{$methodName}";
2440
+		if ( ! has_filter($tagName)) {
2441
+			throw new EE_Error(
2442
+				sprintf(
2443
+					__(
2444
+						"Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
2445
+						"event_espresso"
2446
+					),
2447
+					$methodName,
2448
+					$className,
2449
+					$tagName
2450
+				)
2451
+			);
2452
+		}
2453
+		return apply_filters($tagName, null, $this, $args);
2454
+	}
2455
+
2456
+
2457
+
2458
+	/**
2459
+	 * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
2460
+	 * A $previous_value can be specified in case there are many meta rows with the same key
2461
+	 *
2462
+	 * @param string $meta_key
2463
+	 * @param mixed  $meta_value
2464
+	 * @param mixed  $previous_value
2465
+	 * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
2466
+	 * @throws EE_Error
2467
+	 * NOTE: if the values haven't changed, returns 0
2468
+	 */
2469
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
2470
+	{
2471
+		$query_params = array(
2472
+			array(
2473
+				'EXM_key'  => $meta_key,
2474
+				'OBJ_ID'   => $this->ID(),
2475
+				'EXM_type' => $this->get_model()->get_this_model_name(),
2476
+			),
2477
+		);
2478
+		if ($previous_value !== null) {
2479
+			$query_params[0]['EXM_value'] = $meta_value;
2480
+		}
2481
+		$existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
2482
+		if ( ! $existing_rows_like_that) {
2483
+			return $this->add_extra_meta($meta_key, $meta_value);
2484
+		}
2485
+		foreach ($existing_rows_like_that as $existing_row) {
2486
+			$existing_row->save(array('EXM_value' => $meta_value));
2487
+		}
2488
+		return count($existing_rows_like_that);
2489
+	}
2490
+
2491
+
2492
+
2493
+	/**
2494
+	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
2495
+	 * no other extra meta for this model object have the same key. Returns TRUE if the
2496
+	 * extra meta row was entered, false if not
2497
+	 *
2498
+	 * @param string  $meta_key
2499
+	 * @param mixed   $meta_value
2500
+	 * @param boolean $unique
2501
+	 * @return boolean
2502
+	 * @throws EE_Error
2503
+	 */
2504
+	public function add_extra_meta($meta_key, $meta_value, $unique = false)
2505
+	{
2506
+		if ($unique) {
2507
+			$existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
2508
+				array(
2509
+					array(
2510
+						'EXM_key'  => $meta_key,
2511
+						'OBJ_ID'   => $this->ID(),
2512
+						'EXM_type' => $this->get_model()->get_this_model_name(),
2513
+					),
2514
+				)
2515
+			);
2516
+			if ($existing_extra_meta) {
2517
+				return false;
2518
+			}
2519
+		}
2520
+		$new_extra_meta = EE_Extra_Meta::new_instance(
2521
+			array(
2522
+				'EXM_key'   => $meta_key,
2523
+				'EXM_value' => $meta_value,
2524
+				'OBJ_ID'    => $this->ID(),
2525
+				'EXM_type'  => $this->get_model()->get_this_model_name(),
2526
+			)
2527
+		);
2528
+		$new_extra_meta->save();
2529
+		return true;
2530
+	}
2531
+
2532
+
2533
+
2534
+	/**
2535
+	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
2536
+	 * is specified, only deletes extra meta records with that value.
2537
+	 *
2538
+	 * @param string $meta_key
2539
+	 * @param mixed  $meta_value
2540
+	 * @return int number of extra meta rows deleted
2541
+	 * @throws EE_Error
2542
+	 */
2543
+	public function delete_extra_meta($meta_key, $meta_value = null)
2544
+	{
2545
+		$query_params = array(
2546
+			array(
2547
+				'EXM_key'  => $meta_key,
2548
+				'OBJ_ID'   => $this->ID(),
2549
+				'EXM_type' => $this->get_model()->get_this_model_name(),
2550
+			),
2551
+		);
2552
+		if ($meta_value !== null) {
2553
+			$query_params[0]['EXM_value'] = $meta_value;
2554
+		}
2555
+		return EEM_Extra_Meta::instance()->delete($query_params);
2556
+	}
2557
+
2558
+
2559
+
2560
+	/**
2561
+	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
2562
+	 * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
2563
+	 * You can specify $default is case you haven't found the extra meta
2564
+	 *
2565
+	 * @param string  $meta_key
2566
+	 * @param boolean $single
2567
+	 * @param mixed   $default if we don't find anything, what should we return?
2568
+	 * @return mixed single value if $single; array if ! $single
2569
+	 * @throws EE_Error
2570
+	 */
2571
+	public function get_extra_meta($meta_key, $single = false, $default = null)
2572
+	{
2573
+		if ($single) {
2574
+			$result = $this->get_first_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
2575
+			if ($result instanceof EE_Extra_Meta) {
2576
+				return $result->value();
2577
+			} else {
2578
+				return $default;
2579
+			}
2580
+		} else {
2581
+			$results = $this->get_many_related('Extra_Meta', array(array('EXM_key' => $meta_key)));
2582
+			if ($results) {
2583
+				$values = array();
2584
+				foreach ($results as $result) {
2585
+					if ($result instanceof EE_Extra_Meta) {
2586
+						$values[$result->ID()] = $result->value();
2587
+					}
2588
+				}
2589
+				return $values;
2590
+			} else {
2591
+				return $default;
2592
+			}
2593
+		}
2594
+	}
2595
+
2596
+
2597
+
2598
+	/**
2599
+	 * Returns a simple array of all the extra meta associated with this model object.
2600
+	 * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
2601
+	 * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
2602
+	 * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
2603
+	 * If $one_of_each_key is false, it will return an array with the top-level keys being
2604
+	 * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
2605
+	 * finally the extra meta's value as each sub-value. (eg
2606
+	 * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
2607
+	 *
2608
+	 * @param boolean $one_of_each_key
2609
+	 * @return array
2610
+	 * @throws EE_Error
2611
+	 */
2612
+	public function all_extra_meta_array($one_of_each_key = true)
2613
+	{
2614
+		$return_array = array();
2615
+		if ($one_of_each_key) {
2616
+			$extra_meta_objs = $this->get_many_related('Extra_Meta', array('group_by' => 'EXM_key'));
2617
+			foreach ($extra_meta_objs as $extra_meta_obj) {
2618
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
2619
+					$return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
2620
+				}
2621
+			}
2622
+		} else {
2623
+			$extra_meta_objs = $this->get_many_related('Extra_Meta');
2624
+			foreach ($extra_meta_objs as $extra_meta_obj) {
2625
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
2626
+					if ( ! isset($return_array[$extra_meta_obj->key()])) {
2627
+						$return_array[$extra_meta_obj->key()] = array();
2628
+					}
2629
+					$return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
2630
+				}
2631
+			}
2632
+		}
2633
+		return $return_array;
2634
+	}
2635
+
2636
+
2637
+
2638
+	/**
2639
+	 * Gets a pretty nice displayable nice for this model object. Often overridden
2640
+	 *
2641
+	 * @return string
2642
+	 * @throws EE_Error
2643
+	 */
2644
+	public function name()
2645
+	{
2646
+		//find a field that's not a text field
2647
+		$field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
2648
+		if ($field_we_can_use) {
2649
+			return $this->get($field_we_can_use->get_name());
2650
+		} else {
2651
+			$first_few_properties = $this->model_field_array();
2652
+			$first_few_properties = array_slice($first_few_properties, 0, 3);
2653
+			$name_parts = array();
2654
+			foreach ($first_few_properties as $name => $value) {
2655
+				$name_parts[] = "$name:$value";
2656
+			}
2657
+			return implode(",", $name_parts);
2658
+		}
2659
+	}
2660
+
2661
+
2662
+
2663
+	/**
2664
+	 * in_entity_map
2665
+	 * Checks if this model object has been proven to already be in the entity map
2666
+	 *
2667
+	 * @return boolean
2668
+	 * @throws EE_Error
2669
+	 */
2670
+	public function in_entity_map()
2671
+	{
2672
+		if ($this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this) {
2673
+			//well, if we looked, did we find it in the entity map?
2674
+			return true;
2675
+		} else {
2676
+			return false;
2677
+		}
2678
+	}
2679
+
2680
+
2681
+
2682
+	/**
2683
+	 * refresh_from_db
2684
+	 * Makes sure the fields and values on this model object are in-sync with what's in the database.
2685
+	 *
2686
+	 * @throws EE_Error if this model object isn't in the entity mapper (because then you should
2687
+	 * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
2688
+	 */
2689
+	public function refresh_from_db()
2690
+	{
2691
+		if ($this->ID() && $this->in_entity_map()) {
2692
+			$this->get_model()->refresh_entity_map_from_db($this->ID());
2693
+		} else {
2694
+			//if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
2695
+			//if it has an ID but it's not in the map, and you're asking me to refresh it
2696
+			//that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
2697
+			//absolutely nothing in it for this ID
2698
+			if (WP_DEBUG) {
2699
+				throw new EE_Error(
2700
+					sprintf(
2701
+						__('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
2702
+							'event_espresso'),
2703
+						$this->ID(),
2704
+						get_class($this->get_model()) . '::instance()->add_to_entity_map()',
2705
+						get_class($this->get_model()) . '::instance()->refresh_entity_map()'
2706
+					)
2707
+				);
2708
+			}
2709
+		}
2710
+	}
2711
+
2712
+
2713
+
2714
+	/**
2715
+	 * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
2716
+	 * (probably a bad assumption they have made, oh well)
2717
+	 *
2718
+	 * @return string
2719
+	 */
2720
+	public function __toString()
2721
+	{
2722
+		try {
2723
+			return sprintf('%s (%s)', $this->name(), $this->ID());
2724
+		} catch (Exception $e) {
2725
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
2726
+			return '';
2727
+		}
2728
+	}
2729
+
2730
+
2731
+
2732
+	/**
2733
+	 * Clear related model objects if they're already in the DB, because otherwise when we
2734
+	 * UN-serialize this model object we'll need to be careful to add them to the entity map.
2735
+	 * This means if we have made changes to those related model objects, and want to unserialize
2736
+	 * the this model object on a subsequent request, changes to those related model objects will be lost.
2737
+	 * Instead, those related model objects should be directly serialized and stored.
2738
+	 * Eg, the following won't work:
2739
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
2740
+	 * $att = $reg->attendee();
2741
+	 * $att->set( 'ATT_fname', 'Dirk' );
2742
+	 * update_option( 'my_option', serialize( $reg ) );
2743
+	 * //END REQUEST
2744
+	 * //START NEXT REQUEST
2745
+	 * $reg = get_option( 'my_option' );
2746
+	 * $reg->attendee()->save();
2747
+	 * And would need to be replace with:
2748
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
2749
+	 * $att = $reg->attendee();
2750
+	 * $att->set( 'ATT_fname', 'Dirk' );
2751
+	 * update_option( 'my_option', serialize( $reg ) );
2752
+	 * //END REQUEST
2753
+	 * //START NEXT REQUEST
2754
+	 * $att = get_option( 'my_option' );
2755
+	 * $att->save();
2756
+	 *
2757
+	 * @return array
2758
+	 * @throws EE_Error
2759
+	 */
2760
+	public function __sleep()
2761
+	{
2762
+		$model = $this->get_model();
2763
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
2764
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
2765
+				$classname = 'EE_' . $model->get_this_model_name();
2766
+				if (
2767
+					$this->get_one_from_cache($relation_name) instanceof $classname
2768
+					&& $this->get_one_from_cache($relation_name)->ID()
2769
+				) {
2770
+					$this->clear_cache($relation_name, $this->get_one_from_cache($relation_name)->ID());
2771
+				}
2772
+			}
2773
+		}
2774
+		$this->_props_n_values_provided_in_constructor = array();
2775
+		$properties_to_serialize = get_object_vars($this);
2776
+		//don't serialize the model. It's big and that risks recursion
2777
+		unset($properties_to_serialize['_model']);
2778
+		return array_keys($properties_to_serialize);
2779
+	}
2780
+
2781
+
2782
+
2783
+	/**
2784
+	 * restore _props_n_values_provided_in_constructor
2785
+	 * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
2786
+	 * and therefore should NOT be used to determine if state change has occurred since initial construction.
2787
+	 * At best, you would only be able to detect if state change has occurred during THIS request.
2788
+	 */
2789
+	public function __wakeup()
2790
+	{
2791
+		$this->_props_n_values_provided_in_constructor = $this->_fields;
2792
+	}
2793 2793
 
2794 2794
 
2795 2795
 
Please login to merge, or discard this patch.
Spacing   +23 added lines, -23 removed lines patch added patch discarded remove patch
@@ -124,8 +124,8 @@  discard block
 block discarded – undo
124 124
      * @return EE_Base_Class
125 125
      * @throws EE_Error
126 126
      */
127
-    public static function new_instance($fieldValues = array(), $timezone = '', $date_formats = array() ) {
128
-        return self::static_constructor((array) $fieldValues, false, $timezone,  $date_formats);
127
+    public static function new_instance($fieldValues = array(), $timezone = '', $date_formats = array()) {
128
+        return self::static_constructor((array) $fieldValues, false, $timezone, $date_formats);
129 129
     }
130 130
 
131 131
 
@@ -158,7 +158,7 @@  discard block
 block discarded – undo
158 158
         array $date_formats = array()
159 159
     ) {
160 160
         $className = get_called_class();
161
-        if (! $from_db) {
161
+        if ( ! $from_db) {
162 162
             $cached_object = EE_Base_Class::_check_for_object(
163 163
                 $fieldValues,
164 164
                 $className,
@@ -211,8 +211,8 @@  discard block
 block discarded – undo
211 211
             list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
212 212
         } else {
213 213
             //set default formats for date and time
214
-            $this->_dt_frmt = (string)get_option('date_format', 'Y-m-d');
215
-            $this->_tm_frmt = (string)get_option('time_format', 'g:i a');
214
+            $this->_dt_frmt = (string) get_option('date_format', 'Y-m-d');
215
+            $this->_tm_frmt = (string) get_option('time_format', 'g:i a');
216 216
         }
217 217
         //if db model is instantiating
218 218
         if ($bydb) {
@@ -534,7 +534,7 @@  discard block
 block discarded – undo
534 534
      */
535 535
     public function get_format($full = true)
536 536
     {
537
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
537
+        return $full ? $this->_dt_frmt.' '.$this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
538 538
     }
539 539
 
540 540
 
@@ -643,7 +643,7 @@  discard block
 block discarded – undo
643 643
         $model = $this->get_model();
644 644
         $model->field_settings_for($fieldname);
645 645
         $cache_type = $pretty ? 'pretty' : 'standard';
646
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
646
+        $cache_type .= ! empty($extra_cache_ref) ? '_'.$extra_cache_ref : '';
647 647
         if (isset($this->_cached_properties[$fieldname][$cache_type])) {
648 648
             return $this->_cached_properties[$fieldname][$cache_type];
649 649
         }
@@ -870,7 +870,7 @@  discard block
 block discarded – undo
870 870
         $current_cache_id = ''
871 871
     ) {
872 872
         // verify that incoming object is of the correct type
873
-        $obj_class = 'EE_' . $relationName;
873
+        $obj_class = 'EE_'.$relationName;
874 874
         if ($newly_saved_object instanceof $obj_class) {
875 875
             /* @type EE_Base_Class $newly_saved_object */
876 876
             // now get the type of relation
@@ -1357,7 +1357,7 @@  discard block
 block discarded – undo
1357 1357
      */
1358 1358
     public function get_i18n_datetime($field_name, $format = '')
1359 1359
     {
1360
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
1360
+        $format = empty($format) ? $this->_dt_frmt.' '.$this->_tm_frmt : $format;
1361 1361
         return date_i18n(
1362 1362
             $format,
1363 1363
             EEH_DTT_Helper::get_timestamp_with_offset($this->get_raw($field_name), $this->_timezone)
@@ -1495,8 +1495,8 @@  discard block
 block discarded – undo
1495 1495
         }
1496 1496
         $original_timezone = $this->_timezone;
1497 1497
         $this->set_timezone($timezone);
1498
-        $fn = (array)$field_name;
1499
-        $args = array_merge($fn, (array)$args);
1498
+        $fn = (array) $field_name;
1499
+        $args = array_merge($fn, (array) $args);
1500 1500
         if ( ! method_exists($this, $callback)) {
1501 1501
             throw new EE_Error(
1502 1502
                 sprintf(
@@ -1508,8 +1508,8 @@  discard block
 block discarded – undo
1508 1508
                 )
1509 1509
             );
1510 1510
         }
1511
-        $args = (array)$args;
1512
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
1511
+        $args = (array) $args;
1512
+        $return = $prepend.call_user_func_array(array($this, $callback), $args).$append;
1513 1513
         $this->set_timezone($original_timezone);
1514 1514
         return $return;
1515 1515
     }
@@ -1648,14 +1648,14 @@  discard block
 block discarded – undo
1648 1648
          * @param array         $set_cols_n_values
1649 1649
          * @param EE_Base_Class $model_object
1650 1650
          */
1651
-        $set_cols_n_values = (array)apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
1651
+        $set_cols_n_values = (array) apply_filters('FHEE__EE_Base_Class__save__set_cols_n_values', $set_cols_n_values,
1652 1652
             $this);
1653 1653
         //set attributes as provided in $set_cols_n_values
1654 1654
         foreach ($set_cols_n_values as $column => $value) {
1655 1655
             $this->set($column, $value);
1656 1656
         }
1657 1657
         // no changes ? then don't do anything
1658
-        if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
1658
+        if ( ! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
1659 1659
             return 0;
1660 1660
         }
1661 1661
         /**
@@ -1707,8 +1707,8 @@  discard block
 block discarded – undo
1707 1707
                                 __('Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
1708 1708
                                     'event_espresso'),
1709 1709
                                 get_class($this),
1710
-                                get_class($model) . '::instance()->add_to_entity_map()',
1711
-                                get_class($model) . '::instance()->get_one_by_ID()',
1710
+                                get_class($model).'::instance()->add_to_entity_map()',
1711
+                                get_class($model).'::instance()->get_one_by_ID()',
1712 1712
                                 '<br />'
1713 1713
                             )
1714 1714
                         );
@@ -1841,7 +1841,7 @@  discard block
 block discarded – undo
1841 1841
      */
1842 1842
     public function get_model()
1843 1843
     {
1844
-        if( ! $this->_model){
1844
+        if ( ! $this->_model) {
1845 1845
             $modelName = self::_get_model_classname(get_class($this));
1846 1846
             $this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
1847 1847
         } else {
@@ -1984,7 +1984,7 @@  discard block
 block discarded – undo
1984 1984
         if (strpos($model_name, "EE_") === 0) {
1985 1985
             $model_classname = str_replace("EE_", "EEM_", $model_name);
1986 1986
         } else {
1987
-            $model_classname = "EEM_" . $model_name;
1987
+            $model_classname = "EEM_".$model_name;
1988 1988
         }
1989 1989
         return $model_classname;
1990 1990
     }
@@ -2371,7 +2371,7 @@  discard block
 block discarded – undo
2371 2371
      */
2372 2372
     protected function _property_exists($properties)
2373 2373
     {
2374
-        foreach ((array)$properties as $property_name) {
2374
+        foreach ((array) $properties as $property_name) {
2375 2375
             //first make sure this property exists
2376 2376
             if ( ! $this->_fields[$property_name]) {
2377 2377
                 throw new EE_Error(
@@ -2701,8 +2701,8 @@  discard block
 block discarded – undo
2701 2701
                         __('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
2702 2702
                             'event_espresso'),
2703 2703
                         $this->ID(),
2704
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
2705
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
2704
+                        get_class($this->get_model()).'::instance()->add_to_entity_map()',
2705
+                        get_class($this->get_model()).'::instance()->refresh_entity_map()'
2706 2706
                     )
2707 2707
                 );
2708 2708
             }
@@ -2762,7 +2762,7 @@  discard block
 block discarded – undo
2762 2762
         $model = $this->get_model();
2763 2763
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
2764 2764
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
2765
-                $classname = 'EE_' . $model->get_this_model_name();
2765
+                $classname = 'EE_'.$model->get_this_model_name();
2766 2766
                 if (
2767 2767
                     $this->get_one_from_cache($relation_name) instanceof $classname
2768 2768
                     && $this->get_one_from_cache($relation_name)->ID()
Please login to merge, or discard this patch.
core/db_models/EEM_Base.model.php 2 patches
Indentation   +5994 added lines, -5994 removed lines patch added patch discarded remove patch
@@ -32,6002 +32,6002 @@
 block discarded – undo
32 32
 abstract class EEM_Base extends EE_Base implements ResettableInterface
33 33
 {
34 34
 
35
-    //admin posty
36
-    //basic -> grants access to mine -> if they don't have it, select none
37
-    //*_others -> grants access to others that aren't private, and all mine -> if they don't have it, select mine
38
-    //*_private -> grants full access -> if dont have it, select all mine and others' non-private
39
-    //*_published -> grants access to published -> if they dont have it, select non-published
40
-    //*_global/default/system -> grants access to global items -> if they don't have it, select non-global
41
-    //publish_{thing} -> can change status TO publish; SPECIAL CASE
42
-    //frontend posty
43
-    //by default has access to published
44
-    //basic -> grants access to mine that aren't published, and all published
45
-    //*_others ->grants access to others that aren't private, all mine
46
-    //*_private -> grants full access
47
-    //frontend non-posty
48
-    //like admin posty
49
-    //category-y
50
-    //assign -> grants access to join-table
51
-    //(delete, edit)
52
-    //payment-method-y
53
-    //for each registered payment method,
54
-    //ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
55
-    /**
56
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
57
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
58
-     * They almost always WILL NOT, but it's not necessarily a requirement.
59
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
60
-     *
61
-     * @var boolean
62
-     */
63
-    private $_values_already_prepared_by_model_object = 0;
64
-
65
-    /**
66
-     * when $_values_already_prepared_by_model_object equals this, we assume
67
-     * the data is just like form input that needs to have the model fields'
68
-     * prepare_for_set and prepare_for_use_in_db called on it
69
-     */
70
-    const not_prepared_by_model_object = 0;
71
-
72
-    /**
73
-     * when $_values_already_prepared_by_model_object equals this, we
74
-     * assume this value is coming from a model object and doesn't need to have
75
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
76
-     */
77
-    const prepared_by_model_object = 1;
78
-
79
-    /**
80
-     * when $_values_already_prepared_by_model_object equals this, we assume
81
-     * the values are already to be used in the database (ie no processing is done
82
-     * on them by the model's fields)
83
-     */
84
-    const prepared_for_use_in_db = 2;
85
-
86
-
87
-    protected $singular_item = 'Item';
88
-
89
-    protected $plural_item   = 'Items';
90
-
91
-    /**
92
-     * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
93
-     */
94
-    protected $_tables;
95
-
96
-    /**
97
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
98
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
99
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
100
-     *
101
-     * @var \EE_Model_Field_Base[] $_fields
102
-     */
103
-    protected $_fields;
104
-
105
-    /**
106
-     * array of different kinds of relations
107
-     *
108
-     * @var \EE_Model_Relation_Base[] $_model_relations
109
-     */
110
-    protected $_model_relations;
111
-
112
-    /**
113
-     * @var \EE_Index[] $_indexes
114
-     */
115
-    protected $_indexes = array();
116
-
117
-    /**
118
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
119
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
120
-     * by setting the same columns as used in these queries in the query yourself.
121
-     *
122
-     * @var EE_Default_Where_Conditions
123
-     */
124
-    protected $_default_where_conditions_strategy;
125
-
126
-    /**
127
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
128
-     * This is particularly useful when you want something between 'none' and 'default'
129
-     *
130
-     * @var EE_Default_Where_Conditions
131
-     */
132
-    protected $_minimum_where_conditions_strategy;
133
-
134
-    /**
135
-     * String describing how to find the "owner" of this model's objects.
136
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
137
-     * But when there isn't, this indicates which related model, or transiently-related model,
138
-     * has the foreign key to the wp_users table.
139
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
140
-     * related to events, and events have a foreign key to wp_users.
141
-     * On EEM_Transaction, this would be 'Transaction.Event'
142
-     *
143
-     * @var string
144
-     */
145
-    protected $_model_chain_to_wp_user = '';
146
-
147
-    /**
148
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
149
-     * don't need it (particularly CPT models)
150
-     *
151
-     * @var bool
152
-     */
153
-    protected $_ignore_where_strategy = false;
154
-
155
-    /**
156
-     * String used in caps relating to this model. Eg, if the caps relating to this
157
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
158
-     *
159
-     * @var string. If null it hasn't been initialized yet. If false then we
160
-     * have indicated capabilities don't apply to this
161
-     */
162
-    protected $_caps_slug = null;
163
-
164
-    /**
165
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
166
-     * and next-level keys are capability names, and each's value is a
167
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
168
-     * they specify which context to use (ie, frontend, backend, edit or delete)
169
-     * and then each capability in the corresponding sub-array that they're missing
170
-     * adds the where conditions onto the query.
171
-     *
172
-     * @var array
173
-     */
174
-    protected $_cap_restrictions = array(
175
-        self::caps_read       => array(),
176
-        self::caps_read_admin => array(),
177
-        self::caps_edit       => array(),
178
-        self::caps_delete     => array(),
179
-    );
180
-
181
-    /**
182
-     * Array defining which cap restriction generators to use to create default
183
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
184
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
185
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
186
-     * automatically set this to false (not just null).
187
-     *
188
-     * @var EE_Restriction_Generator_Base[]
189
-     */
190
-    protected $_cap_restriction_generators = array();
191
-
192
-    /**
193
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
194
-     */
195
-    const caps_read       = 'read';
196
-
197
-    const caps_read_admin = 'read_admin';
198
-
199
-    const caps_edit       = 'edit';
200
-
201
-    const caps_delete     = 'delete';
202
-
203
-    /**
204
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
205
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
206
-     * maps to 'read' because when looking for relevant permissions we're going to use
207
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
208
-     *
209
-     * @var array
210
-     */
211
-    protected $_cap_contexts_to_cap_action_map = array(
212
-        self::caps_read       => 'read',
213
-        self::caps_read_admin => 'read',
214
-        self::caps_edit       => 'edit',
215
-        self::caps_delete     => 'delete',
216
-    );
217
-
218
-    /**
219
-     * Timezone
220
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
221
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
222
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
223
-     * EE_Datetime_Field data type will have access to it.
224
-     *
225
-     * @var string
226
-     */
227
-    protected $_timezone;
228
-
229
-
230
-    /**
231
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
232
-     * multisite.
233
-     *
234
-     * @var int
235
-     */
236
-    protected static $_model_query_blog_id;
237
-
238
-    /**
239
-     * A copy of _fields, except the array keys are the model names pointed to by
240
-     * the field
241
-     *
242
-     * @var EE_Model_Field_Base[]
243
-     */
244
-    private $_cache_foreign_key_to_fields = array();
245
-
246
-    /**
247
-     * Cached list of all the fields on the model, indexed by their name
248
-     *
249
-     * @var EE_Model_Field_Base[]
250
-     */
251
-    private $_cached_fields = null;
252
-
253
-    /**
254
-     * Cached list of all the fields on the model, except those that are
255
-     * marked as only pertinent to the database
256
-     *
257
-     * @var EE_Model_Field_Base[]
258
-     */
259
-    private $_cached_fields_non_db_only = null;
260
-
261
-    /**
262
-     * A cached reference to the primary key for quick lookup
263
-     *
264
-     * @var EE_Model_Field_Base
265
-     */
266
-    private $_primary_key_field = null;
267
-
268
-    /**
269
-     * Flag indicating whether this model has a primary key or not
270
-     *
271
-     * @var boolean
272
-     */
273
-    protected $_has_primary_key_field = null;
274
-
275
-    /**
276
-     * Whether or not this model is based off a table in WP core only (CPTs should set
277
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
278
-     *
279
-     * @var boolean
280
-     */
281
-    protected $_wp_core_model = false;
282
-
283
-    /**
284
-     *    List of valid operators that can be used for querying.
285
-     * The keys are all operators we'll accept, the values are the real SQL
286
-     * operators used
287
-     *
288
-     * @var array
289
-     */
290
-    protected $_valid_operators = array(
291
-        '='           => '=',
292
-        '<='          => '<=',
293
-        '<'           => '<',
294
-        '>='          => '>=',
295
-        '>'           => '>',
296
-        '!='          => '!=',
297
-        'LIKE'        => 'LIKE',
298
-        'like'        => 'LIKE',
299
-        'NOT_LIKE'    => 'NOT LIKE',
300
-        'not_like'    => 'NOT LIKE',
301
-        'NOT LIKE'    => 'NOT LIKE',
302
-        'not like'    => 'NOT LIKE',
303
-        'IN'          => 'IN',
304
-        'in'          => 'IN',
305
-        'NOT_IN'      => 'NOT IN',
306
-        'not_in'      => 'NOT IN',
307
-        'NOT IN'      => 'NOT IN',
308
-        'not in'      => 'NOT IN',
309
-        'between'     => 'BETWEEN',
310
-        'BETWEEN'     => 'BETWEEN',
311
-        'IS_NOT_NULL' => 'IS NOT NULL',
312
-        'is_not_null' => 'IS NOT NULL',
313
-        'IS NOT NULL' => 'IS NOT NULL',
314
-        'is not null' => 'IS NOT NULL',
315
-        'IS_NULL'     => 'IS NULL',
316
-        'is_null'     => 'IS NULL',
317
-        'IS NULL'     => 'IS NULL',
318
-        'is null'     => 'IS NULL',
319
-        'REGEXP'      => 'REGEXP',
320
-        'regexp'      => 'REGEXP',
321
-        'NOT_REGEXP'  => 'NOT REGEXP',
322
-        'not_regexp'  => 'NOT REGEXP',
323
-        'NOT REGEXP'  => 'NOT REGEXP',
324
-        'not regexp'  => 'NOT REGEXP',
325
-    );
326
-
327
-    /**
328
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
329
-     *
330
-     * @var array
331
-     */
332
-    protected $_in_style_operators = array('IN', 'NOT IN');
333
-
334
-    /**
335
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
336
-     * '12-31-2012'"
337
-     *
338
-     * @var array
339
-     */
340
-    protected $_between_style_operators = array('BETWEEN');
341
-
342
-    /**
343
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
344
-     * on a join table.
345
-     *
346
-     * @var array
347
-     */
348
-    protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
349
-
350
-    /**
351
-     * Allowed values for $query_params['order'] for ordering in queries
352
-     *
353
-     * @var array
354
-     */
355
-    protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
356
-
357
-    /**
358
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
359
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
360
-     *
361
-     * @var array
362
-     */
363
-    private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
364
-
365
-    /**
366
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
367
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
368
-     *
369
-     * @var array
370
-     */
371
-    private $_allowed_query_params = array(
372
-        0,
373
-        'limit',
374
-        'order_by',
375
-        'group_by',
376
-        'having',
377
-        'force_join',
378
-        'order',
379
-        'on_join_limit',
380
-        'default_where_conditions',
381
-        'caps',
382
-    );
383
-
384
-    /**
385
-     * All the data types that can be used in $wpdb->prepare statements.
386
-     *
387
-     * @var array
388
-     */
389
-    private $_valid_wpdb_data_types = array('%d', '%s', '%f');
390
-
391
-    /**
392
-     *    EE_Registry Object
393
-     *
394
-     * @var    object
395
-     * @access    protected
396
-     */
397
-    protected $EE = null;
398
-
399
-
400
-    /**
401
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
402
-     *
403
-     * @var int
404
-     */
405
-    protected $_show_next_x_db_queries = 0;
406
-
407
-    /**
408
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
409
-     * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
410
-     *
411
-     * @var array
412
-     */
413
-    protected $_custom_selections = array();
414
-
415
-    /**
416
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
417
-     * caches every model object we've fetched from the DB on this request
418
-     *
419
-     * @var array
420
-     */
421
-    protected $_entity_map;
422
-
423
-    /**
424
-     * constant used to show EEM_Base has not yet verified the db on this http request
425
-     */
426
-    const db_verified_none = 0;
427
-
428
-    /**
429
-     * constant used to show EEM_Base has verified the EE core db on this http request,
430
-     * but not the addons' dbs
431
-     */
432
-    const db_verified_core = 1;
433
-
434
-    /**
435
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
436
-     * the EE core db too)
437
-     */
438
-    const db_verified_addons = 2;
439
-
440
-    /**
441
-     * indicates whether an EEM_Base child has already re-verified the DB
442
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
443
-     * looking like EEM_Base::db_verified_*
444
-     *
445
-     * @var int - 0 = none, 1 = core, 2 = addons
446
-     */
447
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
448
-
449
-    /**
450
-     * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
451
-     *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
452
-     *        registrations for non-trashed tickets for non-trashed datetimes)
453
-     */
454
-    const default_where_conditions_all = 'all';
455
-
456
-    /**
457
-     * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
458
-     *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
459
-     *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
460
-     *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
461
-     *        models which share tables with other models, this can return data for the wrong model.
462
-     */
463
-    const default_where_conditions_this_only = 'this_model_only';
464
-
465
-    /**
466
-     * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
467
-     *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
468
-     *        return all registrations related to non-trashed tickets and non-trashed datetimes)
469
-     */
470
-    const default_where_conditions_others_only = 'other_models_only';
471
-
472
-    /**
473
-     * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
474
-     *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
475
-     *        their table with other models, like the Event and Venue models. For example, when querying for events
476
-     *        ordered by their venues' name, this will be sure to only return real events with associated real venues
477
-     *        (regardless of whether those events and venues are trashed)
478
-     *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
479
-     *        events.
480
-     */
481
-    const default_where_conditions_minimum_all = 'minimum';
482
-
483
-    /**
484
-     * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
485
-     *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
486
-     *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
487
-     *        not)
488
-     */
489
-    const default_where_conditions_minimum_others = 'full_this_minimum_others';
490
-
491
-    /**
492
-     * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
493
-     *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
494
-     *        it's possible it will return table entries for other models. You should use
495
-     *        EEM_Base::default_where_conditions_minimum_all instead.
496
-     */
497
-    const default_where_conditions_none = 'none';
498
-
499
-
500
-
501
-    /**
502
-     * About all child constructors:
503
-     * they should define the _tables, _fields and _model_relations arrays.
504
-     * Should ALWAYS be called after child constructor.
505
-     * In order to make the child constructors to be as simple as possible, this parent constructor
506
-     * finalizes constructing all the object's attributes.
507
-     * Generally, rather than requiring a child to code
508
-     * $this->_tables = array(
509
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
510
-     *        ...);
511
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
512
-     * each EE_Table has a function to set the table's alias after the constructor, using
513
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
514
-     * do something similar.
515
-     *
516
-     * @param null $timezone
517
-     * @throws EE_Error
518
-     */
519
-    protected function __construct($timezone = null)
520
-    {
521
-        // check that the model has not been loaded too soon
522
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
523
-            throw new EE_Error (
524
-                sprintf(
525
-                    __('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.',
526
-                        'event_espresso'),
527
-                    get_class($this)
528
-                )
529
-            );
530
-        }
531
-        /**
532
-         * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
533
-         */
534
-        if (empty(EEM_Base::$_model_query_blog_id)) {
535
-            EEM_Base::set_model_query_blog_id();
536
-        }
537
-        /**
538
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
539
-         * just use EE_Register_Model_Extension
540
-         *
541
-         * @var EE_Table_Base[] $_tables
542
-         */
543
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
544
-        foreach ($this->_tables as $table_alias => $table_obj) {
545
-            /** @var $table_obj EE_Table_Base */
546
-            $table_obj->_construct_finalize_with_alias($table_alias);
547
-            if ($table_obj instanceof EE_Secondary_Table) {
548
-                /** @var $table_obj EE_Secondary_Table */
549
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
550
-            }
551
-        }
552
-        /**
553
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
554
-         * EE_Register_Model_Extension
555
-         *
556
-         * @param EE_Model_Field_Base[] $_fields
557
-         */
558
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
559
-        $this->_invalidate_field_caches();
560
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
561
-            if (! array_key_exists($table_alias, $this->_tables)) {
562
-                throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
563
-                    'event_espresso'), $table_alias, implode(",", $this->_fields)));
564
-            }
565
-            foreach ($fields_for_table as $field_name => $field_obj) {
566
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
567
-                //primary key field base has a slightly different _construct_finalize
568
-                /** @var $field_obj EE_Model_Field_Base */
569
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
570
-            }
571
-        }
572
-        // everything is related to Extra_Meta
573
-        if (get_class($this) !== 'EEM_Extra_Meta') {
574
-            //make extra meta related to everything, but don't block deleting things just
575
-            //because they have related extra meta info. For now just orphan those extra meta
576
-            //in the future we should automatically delete them
577
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
578
-        }
579
-        //and change logs
580
-        if (get_class($this) !== 'EEM_Change_Log') {
581
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
582
-        }
583
-        /**
584
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
585
-         * EE_Register_Model_Extension
586
-         *
587
-         * @param EE_Model_Relation_Base[] $_model_relations
588
-         */
589
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
590
-            $this->_model_relations);
591
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
592
-            /** @var $relation_obj EE_Model_Relation_Base */
593
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
594
-        }
595
-        foreach ($this->_indexes as $index_name => $index_obj) {
596
-            /** @var $index_obj EE_Index */
597
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
598
-        }
599
-        $this->set_timezone($timezone);
600
-        //finalize default where condition strategy, or set default
601
-        if (! $this->_default_where_conditions_strategy) {
602
-            //nothing was set during child constructor, so set default
603
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
604
-        }
605
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
606
-        if (! $this->_minimum_where_conditions_strategy) {
607
-            //nothing was set during child constructor, so set default
608
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
609
-        }
610
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
611
-        //if the cap slug hasn't been set, and we haven't set it to false on purpose
612
-        //to indicate to NOT set it, set it to the logical default
613
-        if ($this->_caps_slug === null) {
614
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
615
-        }
616
-        //initialize the standard cap restriction generators if none were specified by the child constructor
617
-        if ($this->_cap_restriction_generators !== false) {
618
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
619
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
620
-                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
621
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
622
-                        new EE_Restriction_Generator_Protected(),
623
-                        $cap_context,
624
-                        $this
625
-                    );
626
-                }
627
-            }
628
-        }
629
-        //if there are cap restriction generators, use them to make the default cap restrictions
630
-        if ($this->_cap_restriction_generators !== false) {
631
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
632
-                if (! $generator_object) {
633
-                    continue;
634
-                }
635
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
636
-                    throw new EE_Error(
637
-                        sprintf(
638
-                            __('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.',
639
-                                'event_espresso'),
640
-                            $context,
641
-                            $this->get_this_model_name()
642
-                        )
643
-                    );
644
-                }
645
-                $action = $this->cap_action_for_context($context);
646
-                if (! $generator_object->construction_finalized()) {
647
-                    $generator_object->_construct_finalize($this, $action);
648
-                }
649
-            }
650
-        }
651
-        do_action('AHEE__' . get_class($this) . '__construct__end');
652
-    }
653
-
654
-
655
-
656
-    /**
657
-     * Generates the cap restrictions for the given context, or if they were
658
-     * already generated just gets what's cached
659
-     *
660
-     * @param string $context one of EEM_Base::valid_cap_contexts()
661
-     * @return EE_Default_Where_Conditions[]
662
-     */
663
-    protected function _generate_cap_restrictions($context)
664
-    {
665
-        if (isset($this->_cap_restriction_generators[$context])
666
-            && $this->_cap_restriction_generators[$context]
667
-               instanceof
668
-               EE_Restriction_Generator_Base
669
-        ) {
670
-            return $this->_cap_restriction_generators[$context]->generate_restrictions();
671
-        } else {
672
-            return array();
673
-        }
674
-    }
675
-
676
-
677
-
678
-    /**
679
-     * Used to set the $_model_query_blog_id static property.
680
-     *
681
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
682
-     *                      value for get_current_blog_id() will be used.
683
-     */
684
-    public static function set_model_query_blog_id($blog_id = 0)
685
-    {
686
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
687
-    }
688
-
689
-
690
-
691
-    /**
692
-     * Returns whatever is set as the internal $model_query_blog_id.
693
-     *
694
-     * @return int
695
-     */
696
-    public static function get_model_query_blog_id()
697
-    {
698
-        return EEM_Base::$_model_query_blog_id;
699
-    }
700
-
701
-
702
-
703
-    /**
704
-     * This function is a singleton method used to instantiate the Espresso_model object
705
-     *
706
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
707
-     *                                (and any incoming timezone data that gets saved).
708
-     *                                Note this just sends the timezone info to the date time model field objects.
709
-     *                                Default is NULL
710
-     *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
711
-     * @return static (as in the concrete child class)
712
-     * @throws InvalidArgumentException
713
-     * @throws InvalidInterfaceException
714
-     * @throws InvalidDataTypeException
715
-     * @throws EE_Error
716
-     */
717
-    public static function instance($timezone = null)
718
-    {
719
-        // check if instance of Espresso_model already exists
720
-        if (! static::$_instance instanceof static) {
721
-            // instantiate Espresso_model
722
-            static::$_instance = new static(
723
-                $timezone,
724
-                LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
725
-            );
726
-        }
727
-        //we might have a timezone set, let set_timezone decide what to do with it
728
-        static::$_instance->set_timezone($timezone);
729
-        // Espresso_model object
730
-        return static::$_instance;
731
-    }
732
-
733
-
734
-
735
-    /**
736
-     * resets the model and returns it
737
-     *
738
-     * @param null | string $timezone
739
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
740
-     * @throws ReflectionException
741
-     * all its properties reset; if it wasn't instantiated, returns null)
742
-     * @throws EE_Error
743
-     * @throws InvalidArgumentException
744
-     * @throws InvalidDataTypeException
745
-     * @throws InvalidInterfaceException
746
-     */
747
-    public static function reset($timezone = null)
748
-    {
749
-        if (static::$_instance instanceof EEM_Base) {
750
-            //let's try to NOT swap out the current instance for a new one
751
-            //because if someone has a reference to it, we can't remove their reference
752
-            //so it's best to keep using the same reference, but change the original object
753
-            //reset all its properties to their original values as defined in the class
754
-            $r = new ReflectionClass(get_class(static::$_instance));
755
-            $static_properties = $r->getStaticProperties();
756
-            foreach ($r->getDefaultProperties() as $property => $value) {
757
-                //don't set instance to null like it was originally,
758
-                //but it's static anyways, and we're ignoring static properties (for now at least)
759
-                if (! isset($static_properties[$property])) {
760
-                    static::$_instance->{$property} = $value;
761
-                }
762
-            }
763
-            //and then directly call its constructor again, like we would if we were creating a new one
764
-            static::$_instance->__construct(
765
-                $timezone,
766
-                LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
767
-            );
768
-            return self::instance();
769
-        }
770
-        return null;
771
-    }
772
-
773
-
774
-
775
-    /**
776
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
777
-     *
778
-     * @param  boolean $translated return localized strings or JUST the array.
779
-     * @return array
780
-     * @throws EE_Error
781
-     */
782
-    public function status_array($translated = false)
783
-    {
784
-        if (! array_key_exists('Status', $this->_model_relations)) {
785
-            return array();
786
-        }
787
-        $model_name = $this->get_this_model_name();
788
-        $status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
789
-        $stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
790
-        $status_array = array();
791
-        foreach ($stati as $status) {
792
-            $status_array[$status->ID()] = $status->get('STS_code');
793
-        }
794
-        return $translated
795
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
796
-            : $status_array;
797
-    }
798
-
799
-
800
-
801
-    /**
802
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
803
-     *
804
-     * @param array $query_params             {
805
-     * @var array $0 (where) array {
806
-     *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
807
-     *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
808
-     *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
809
-     *                                        conditions based on related models (and even
810
-     *                                        models-related-to-related-models) prepend the model's name onto the field
811
-     *                                        name. Eg,
812
-     *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
813
-     *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
814
-     *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
815
-     *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
816
-     *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
817
-     *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
818
-     *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
819
-     *                                        to Venues (even when each of those models actually consisted of two
820
-     *                                        tables). Also, you may chain the model relations together. Eg instead of
821
-     *                                        just having
822
-     *                                        "Venue.VNU_ID", you could have
823
-     *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
824
-     *                                        events are related to Registrations, which are related to Attendees). You
825
-     *                                        can take it even further with
826
-     *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
827
-     *                                        (from the default of '='), change the value to an numerically-indexed
828
-     *                                        array, where the first item in the list is the operator. eg: array(
829
-     *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
830
-     *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
831
-     *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
832
-     *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
833
-     *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
834
-     *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
835
-     *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
836
-     *                                        the operator is IN. Also, values can actually be field names. To indicate
837
-     *                                        the value is a field, simply provide a third array item (true) to the
838
-     *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
839
-     *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
840
-     *                                        Note: you can also use related model field names like you would any other
841
-     *                                        field name. eg:
842
-     *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
843
-     *                                        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__>' =>
844
-     *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
845
-     *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
846
-     *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
847
-     *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
848
-     *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
849
-     *                                        to be what you last specified. IE, "AND"s by default, but if you had
850
-     *                                        previously specified to use ORs to join, ORs will continue to be used.
851
-     *                                        So, if you specify to use an "OR" to join conditions, it will continue to
852
-     *                                        "stick" until you specify an AND. eg
853
-     *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
854
-     *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
855
-     *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
856
-     *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
857
-     *                                        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 >>
858
-     *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
859
-     *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
860
-     *                                        too, eg:
861
-     *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
862
-     * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
863
-     *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
864
-     *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
865
-     *                                        Remember when you provide two numbers for the limit, the 1st number is
866
-     *                                        the OFFSET, the 2nd is the LIMIT
867
-     * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
868
-     *                                        can do paging on one-to-many multi-table-joins. Send an array in the
869
-     *                                        following format array('on_join_limit'
870
-     *                                        => array( 'table_alias', array(1,2) ) ).
871
-     * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
872
-     *                                        values are either 'ASC' or 'DESC'.
873
-     *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
874
-     *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
875
-     *                                        DESC..." respectively. Like the
876
-     *                                        'where' conditions, these fields can be on related models. Eg
877
-     *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
878
-     *                                        perfectly valid from any model related to 'Registration' (like Event,
879
-     *                                        Attendee, Price, Datetime, etc.)
880
-     * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
881
-     *                                        'order' specifies whether to order the field specified in 'order_by' in
882
-     *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
883
-     *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
884
-     *                                        order by the primary key. Eg,
885
-     *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
886
-     *                                        //(will join with the Datetime model's table(s) and order by its field
887
-     *                                        DTT_EVT_start) or
888
-     *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
889
-     *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
890
-     * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
891
-     *                                        'group_by'=>'VNU_ID', or
892
-     *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
893
-     *                                        if no
894
-     *                                        $group_by is specified, and a limit is set, automatically groups by the
895
-     *                                        model's primary key (or combined primary keys). This avoids some
896
-     *                                        weirdness that results when using limits, tons of joins, and no group by,
897
-     *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
898
-     * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
899
-     *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
900
-     *                                        results)
901
-     * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
902
-     *                                        array where values are models to be joined in the query.Eg
903
-     *                                        array('Attendee','Payment','Datetime'). You may join with transient
904
-     *                                        models using period, eg "Registration.Transaction.Payment". You will
905
-     *                                        probably only want to do this in hopes of increasing efficiency, as
906
-     *                                        related models which belongs to the current model
907
-     *                                        (ie, the current model has a foreign key to them, like how Registration
908
-     *                                        belongs to Attendee) can be cached in order to avoid future queries
909
-     * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
910
-     *                                        set this to 'none' to disable all default where conditions. Eg, usually
911
-     *                                        soft-deleted objects are filtered-out if you want to include them, set
912
-     *                                        this query param to 'none'. If you want to ONLY disable THIS model's
913
-     *                                        default where conditions set it to 'other_models_only'. If you only want
914
-     *                                        this model's default where conditions added to the query, use
915
-     *                                        'this_model_only'. If you want to use all default where conditions
916
-     *                                        (default), set to 'all'.
917
-     * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
918
-     *                                        we just NOT apply any capabilities/permissions/restrictions and return
919
-     *                                        everything? Or should we only show the current user items they should be
920
-     *                                        able to view on the frontend, backend, edit, or delete? can be set to
921
-     *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
922
-     *                                        }
923
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
924
-     *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
925
-     *                                        again. Array keys are object IDs (if there is a primary key on the model.
926
-     *                                        if not, numerically indexed) Some full examples: get 10 transactions
927
-     *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
928
-     *                                        array( array(
929
-     *                                        'OR'=>array(
930
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
931
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
932
-     *                                        )
933
-     *                                        ),
934
-     *                                        'limit'=>10,
935
-     *                                        'group_by'=>'TXN_ID'
936
-     *                                        ));
937
-     *                                        get all the answers to the question titled "shirt size" for event with id
938
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
939
-     *                                        'Question.QST_display_text'=>'shirt size',
940
-     *                                        'Registration.Event.EVT_ID'=>12
941
-     *                                        ),
942
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
943
-     *                                        ));
944
-     * @throws EE_Error
945
-     */
946
-    public function get_all($query_params = array())
947
-    {
948
-        if (isset($query_params['limit'])
949
-            && ! isset($query_params['group_by'])
950
-        ) {
951
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
952
-        }
953
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
954
-    }
955
-
956
-
957
-
958
-    /**
959
-     * Modifies the query parameters so we only get back model objects
960
-     * that "belong" to the current user
961
-     *
962
-     * @param array $query_params @see EEM_Base::get_all()
963
-     * @return array like EEM_Base::get_all
964
-     */
965
-    public function alter_query_params_to_only_include_mine($query_params = array())
966
-    {
967
-        $wp_user_field_name = $this->wp_user_field_name();
968
-        if ($wp_user_field_name) {
969
-            $query_params[0][$wp_user_field_name] = get_current_user_id();
970
-        }
971
-        return $query_params;
972
-    }
973
-
974
-
975
-
976
-    /**
977
-     * Returns the name of the field's name that points to the WP_User table
978
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
979
-     * foreign key to the WP_User table)
980
-     *
981
-     * @return string|boolean string on success, boolean false when there is no
982
-     * foreign key to the WP_User table
983
-     */
984
-    public function wp_user_field_name()
985
-    {
986
-        try {
987
-            if (! empty($this->_model_chain_to_wp_user)) {
988
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
989
-                $last_model_name = end($models_to_follow_to_wp_users);
990
-                $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
991
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
992
-            } else {
993
-                $model_with_fk_to_wp_users = $this;
994
-                $model_chain_to_wp_user = '';
995
-            }
996
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
997
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
998
-        } catch (EE_Error $e) {
999
-            return false;
1000
-        }
1001
-    }
1002
-
1003
-
1004
-
1005
-    /**
1006
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
1007
-     * (or transiently-related model) has a foreign key to the wp_users table;
1008
-     * useful for finding if model objects of this type are 'owned' by the current user.
1009
-     * This is an empty string when the foreign key is on this model and when it isn't,
1010
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
1011
-     * (or transiently-related model)
1012
-     *
1013
-     * @return string
1014
-     */
1015
-    public function model_chain_to_wp_user()
1016
-    {
1017
-        return $this->_model_chain_to_wp_user;
1018
-    }
1019
-
1020
-
1021
-
1022
-    /**
1023
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1024
-     * like how registrations don't have a foreign key to wp_users, but the
1025
-     * events they are for are), or is unrelated to wp users.
1026
-     * generally available
1027
-     *
1028
-     * @return boolean
1029
-     */
1030
-    public function is_owned()
1031
-    {
1032
-        if ($this->model_chain_to_wp_user()) {
1033
-            return true;
1034
-        }
1035
-        try {
1036
-            $this->get_foreign_key_to('WP_User');
1037
-            return true;
1038
-        } catch (EE_Error $e) {
1039
-            return false;
1040
-        }
1041
-    }
1042
-
1043
-
1044
-
1045
-    /**
1046
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1047
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1048
-     * the model)
1049
-     *
1050
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1051
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1052
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1053
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1054
-     *                                  override this and set the select to "*", or a specific column name, like
1055
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1056
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1057
-     *                                  the aliases used to refer to this selection, and values are to be
1058
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1059
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1060
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1061
-     * @throws EE_Error
1062
-     */
1063
-    protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1064
-    {
1065
-        // remember the custom selections, if any, and type cast as array
1066
-        // (unless $columns_to_select is an object, then just set as an empty array)
1067
-        // Note: (array) 'some string' === array( 'some string' )
1068
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1069
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1070
-        $select_expressions = $columns_to_select !== null
1071
-            ? $this->_construct_select_from_input($columns_to_select)
1072
-            : $this->_construct_default_select_sql($model_query_info);
1073
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1074
-        return $this->_do_wpdb_query('get_results', array($SQL, $output));
1075
-    }
1076
-
1077
-
1078
-
1079
-    /**
1080
-     * Gets an array of rows from the database just like $wpdb->get_results would,
1081
-     * but you can use the $query_params like on EEM_Base::get_all() to more easily
1082
-     * take care of joins, field preparation etc.
1083
-     *
1084
-     * @param array  $query_params      like EEM_Base::get_all's $query_params
1085
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1086
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1087
-     *                                  fields on the model, and the models we joined to in the query. However, you can
1088
-     *                                  override this and set the select to "*", or a specific column name, like
1089
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1090
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1091
-     *                                  the aliases used to refer to this selection, and values are to be
1092
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1093
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1094
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1095
-     * @throws EE_Error
1096
-     */
1097
-    public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1098
-    {
1099
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1100
-    }
1101
-
1102
-
1103
-
1104
-    /**
1105
-     * For creating a custom select statement
1106
-     *
1107
-     * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1108
-     *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1109
-     *                                 SQL, and 1=>is the datatype
1110
-     * @throws EE_Error
1111
-     * @return string
1112
-     */
1113
-    private function _construct_select_from_input($columns_to_select)
1114
-    {
1115
-        if (is_array($columns_to_select)) {
1116
-            $select_sql_array = array();
1117
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
1118
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1119
-                    throw new EE_Error(
1120
-                        sprintf(
1121
-                            __(
1122
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1123
-                                "event_espresso"
1124
-                            ),
1125
-                            $selection_and_datatype,
1126
-                            $alias
1127
-                        )
1128
-                    );
1129
-                }
1130
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1131
-                    throw new EE_Error(
1132
-                        sprintf(
1133
-                            __(
1134
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1135
-                                "event_espresso"
1136
-                            ),
1137
-                            $selection_and_datatype[1],
1138
-                            $selection_and_datatype[0],
1139
-                            $alias,
1140
-                            implode(",", $this->_valid_wpdb_data_types)
1141
-                        )
1142
-                    );
1143
-                }
1144
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1145
-            }
1146
-            $columns_to_select_string = implode(", ", $select_sql_array);
1147
-        } else {
1148
-            $columns_to_select_string = $columns_to_select;
1149
-        }
1150
-        return $columns_to_select_string;
1151
-    }
1152
-
1153
-
1154
-
1155
-    /**
1156
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1157
-     *
1158
-     * @return string
1159
-     * @throws EE_Error
1160
-     */
1161
-    public function primary_key_name()
1162
-    {
1163
-        return $this->get_primary_key_field()->get_name();
1164
-    }
1165
-
1166
-
1167
-
1168
-    /**
1169
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1170
-     * If there is no primary key on this model, $id is treated as primary key string
1171
-     *
1172
-     * @param mixed $id int or string, depending on the type of the model's primary key
1173
-     * @return EE_Base_Class
1174
-     */
1175
-    public function get_one_by_ID($id)
1176
-    {
1177
-        if ($this->get_from_entity_map($id)) {
1178
-            return $this->get_from_entity_map($id);
1179
-        }
1180
-        return $this->get_one(
1181
-            $this->alter_query_params_to_restrict_by_ID(
1182
-                $id,
1183
-                array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1184
-            )
1185
-        );
1186
-    }
1187
-
1188
-
1189
-
1190
-    /**
1191
-     * Alters query parameters to only get items with this ID are returned.
1192
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1193
-     * or could just be a simple primary key ID
1194
-     *
1195
-     * @param int   $id
1196
-     * @param array $query_params
1197
-     * @return array of normal query params, @see EEM_Base::get_all
1198
-     * @throws EE_Error
1199
-     */
1200
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1201
-    {
1202
-        if (! isset($query_params[0])) {
1203
-            $query_params[0] = array();
1204
-        }
1205
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
1206
-        if ($conditions_from_id === null) {
1207
-            $query_params[0][$this->primary_key_name()] = $id;
1208
-        } else {
1209
-            //no primary key, so the $id must be from the get_index_primary_key_string()
1210
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1211
-        }
1212
-        return $query_params;
1213
-    }
1214
-
1215
-
1216
-
1217
-    /**
1218
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1219
-     * array. If no item is found, null is returned.
1220
-     *
1221
-     * @param array $query_params like EEM_Base's $query_params variable.
1222
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1223
-     * @throws EE_Error
1224
-     */
1225
-    public function get_one($query_params = array())
1226
-    {
1227
-        if (! is_array($query_params)) {
1228
-            EE_Error::doing_it_wrong('EEM_Base::get_one',
1229
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1230
-                    gettype($query_params)), '4.6.0');
1231
-            $query_params = array();
1232
-        }
1233
-        $query_params['limit'] = 1;
1234
-        $items = $this->get_all($query_params);
1235
-        if (empty($items)) {
1236
-            return null;
1237
-        }
1238
-        return array_shift($items);
1239
-    }
1240
-
1241
-
1242
-
1243
-    /**
1244
-     * Returns the next x number of items in sequence from the given value as
1245
-     * found in the database matching the given query conditions.
1246
-     *
1247
-     * @param mixed $current_field_value    Value used for the reference point.
1248
-     * @param null  $field_to_order_by      What field is used for the
1249
-     *                                      reference point.
1250
-     * @param int   $limit                  How many to return.
1251
-     * @param array $query_params           Extra conditions on the query.
1252
-     * @param null  $columns_to_select      If left null, then an array of
1253
-     *                                      EE_Base_Class objects is returned,
1254
-     *                                      otherwise you can indicate just the
1255
-     *                                      columns you want returned.
1256
-     * @return EE_Base_Class[]|array
1257
-     * @throws EE_Error
1258
-     */
1259
-    public function next_x(
1260
-        $current_field_value,
1261
-        $field_to_order_by = null,
1262
-        $limit = 1,
1263
-        $query_params = array(),
1264
-        $columns_to_select = null
1265
-    ) {
1266
-        return $this->_get_consecutive(
1267
-            $current_field_value,
1268
-            '>',
1269
-            $field_to_order_by,
1270
-            $limit,
1271
-            $query_params,
1272
-            $columns_to_select
1273
-        );
1274
-    }
1275
-
1276
-
1277
-
1278
-    /**
1279
-     * Returns the previous x number of items in sequence from the given value
1280
-     * as found in the database matching the given query conditions.
1281
-     *
1282
-     * @param mixed $current_field_value    Value used for the reference point.
1283
-     * @param null  $field_to_order_by      What field is used for the
1284
-     *                                      reference point.
1285
-     * @param int   $limit                  How many to return.
1286
-     * @param array $query_params           Extra conditions on the query.
1287
-     * @param null  $columns_to_select      If left null, then an array of
1288
-     *                                      EE_Base_Class objects is returned,
1289
-     *                                      otherwise you can indicate just the
1290
-     *                                      columns you want returned.
1291
-     * @return EE_Base_Class[]|array
1292
-     * @throws EE_Error
1293
-     */
1294
-    public function previous_x(
1295
-        $current_field_value,
1296
-        $field_to_order_by = null,
1297
-        $limit = 1,
1298
-        $query_params = array(),
1299
-        $columns_to_select = null
1300
-    ) {
1301
-        return $this->_get_consecutive(
1302
-            $current_field_value,
1303
-            '<',
1304
-            $field_to_order_by,
1305
-            $limit,
1306
-            $query_params,
1307
-            $columns_to_select
1308
-        );
1309
-    }
1310
-
1311
-
1312
-
1313
-    /**
1314
-     * Returns the next item in sequence from the given value as found in the
1315
-     * database matching the given query conditions.
1316
-     *
1317
-     * @param mixed $current_field_value    Value used for the reference point.
1318
-     * @param null  $field_to_order_by      What field is used for the
1319
-     *                                      reference point.
1320
-     * @param array $query_params           Extra conditions on the query.
1321
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1322
-     *                                      object is returned, otherwise you
1323
-     *                                      can indicate just the columns you
1324
-     *                                      want and a single array indexed by
1325
-     *                                      the columns will be returned.
1326
-     * @return EE_Base_Class|null|array()
1327
-     * @throws EE_Error
1328
-     */
1329
-    public function next(
1330
-        $current_field_value,
1331
-        $field_to_order_by = null,
1332
-        $query_params = array(),
1333
-        $columns_to_select = null
1334
-    ) {
1335
-        $results = $this->_get_consecutive(
1336
-            $current_field_value,
1337
-            '>',
1338
-            $field_to_order_by,
1339
-            1,
1340
-            $query_params,
1341
-            $columns_to_select
1342
-        );
1343
-        return empty($results) ? null : reset($results);
1344
-    }
1345
-
1346
-
1347
-
1348
-    /**
1349
-     * Returns the previous item in sequence from the given value as found in
1350
-     * the database matching the given query conditions.
1351
-     *
1352
-     * @param mixed $current_field_value    Value used for the reference point.
1353
-     * @param null  $field_to_order_by      What field is used for the
1354
-     *                                      reference point.
1355
-     * @param array $query_params           Extra conditions on the query.
1356
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
1357
-     *                                      object is returned, otherwise you
1358
-     *                                      can indicate just the columns you
1359
-     *                                      want and a single array indexed by
1360
-     *                                      the columns will be returned.
1361
-     * @return EE_Base_Class|null|array()
1362
-     * @throws EE_Error
1363
-     */
1364
-    public function previous(
1365
-        $current_field_value,
1366
-        $field_to_order_by = null,
1367
-        $query_params = array(),
1368
-        $columns_to_select = null
1369
-    ) {
1370
-        $results = $this->_get_consecutive(
1371
-            $current_field_value,
1372
-            '<',
1373
-            $field_to_order_by,
1374
-            1,
1375
-            $query_params,
1376
-            $columns_to_select
1377
-        );
1378
-        return empty($results) ? null : reset($results);
1379
-    }
1380
-
1381
-
1382
-
1383
-    /**
1384
-     * Returns the a consecutive number of items in sequence from the given
1385
-     * value as found in the database matching the given query conditions.
1386
-     *
1387
-     * @param mixed  $current_field_value   Value used for the reference point.
1388
-     * @param string $operand               What operand is used for the sequence.
1389
-     * @param string $field_to_order_by     What field is used for the reference point.
1390
-     * @param int    $limit                 How many to return.
1391
-     * @param array  $query_params          Extra conditions on the query.
1392
-     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1393
-     *                                      otherwise you can indicate just the columns you want returned.
1394
-     * @return EE_Base_Class[]|array
1395
-     * @throws EE_Error
1396
-     */
1397
-    protected function _get_consecutive(
1398
-        $current_field_value,
1399
-        $operand = '>',
1400
-        $field_to_order_by = null,
1401
-        $limit = 1,
1402
-        $query_params = array(),
1403
-        $columns_to_select = null
1404
-    ) {
1405
-        //if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1406
-        if (empty($field_to_order_by)) {
1407
-            if ($this->has_primary_key_field()) {
1408
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
1409
-            } else {
1410
-                if (WP_DEBUG) {
1411
-                    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).',
1412
-                        'event_espresso'));
1413
-                }
1414
-                EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1415
-                return array();
1416
-            }
1417
-        }
1418
-        if (! is_array($query_params)) {
1419
-            EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1420
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1421
-                    gettype($query_params)), '4.6.0');
1422
-            $query_params = array();
1423
-        }
1424
-        //let's add the where query param for consecutive look up.
1425
-        $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1426
-        $query_params['limit'] = $limit;
1427
-        //set direction
1428
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1429
-        $query_params['order_by'] = $operand === '>'
1430
-            ? array($field_to_order_by => 'ASC') + $incoming_orderby
1431
-            : array($field_to_order_by => 'DESC') + $incoming_orderby;
1432
-        //if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1433
-        if (empty($columns_to_select)) {
1434
-            return $this->get_all($query_params);
1435
-        }
1436
-        //getting just the fields
1437
-        return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1438
-    }
1439
-
1440
-
1441
-
1442
-    /**
1443
-     * This sets the _timezone property after model object has been instantiated.
1444
-     *
1445
-     * @param null | string $timezone valid PHP DateTimeZone timezone string
1446
-     */
1447
-    public function set_timezone($timezone)
1448
-    {
1449
-        if ($timezone !== null) {
1450
-            $this->_timezone = $timezone;
1451
-        }
1452
-        //note we need to loop through relations and set the timezone on those objects as well.
1453
-        foreach ($this->_model_relations as $relation) {
1454
-            $relation->set_timezone($timezone);
1455
-        }
1456
-        //and finally we do the same for any datetime fields
1457
-        foreach ($this->_fields as $field) {
1458
-            if ($field instanceof EE_Datetime_Field) {
1459
-                $field->set_timezone($timezone);
1460
-            }
1461
-        }
1462
-    }
1463
-
1464
-
1465
-
1466
-    /**
1467
-     * This just returns whatever is set for the current timezone.
1468
-     *
1469
-     * @access public
1470
-     * @return string
1471
-     */
1472
-    public function get_timezone()
1473
-    {
1474
-        //first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1475
-        if (empty($this->_timezone)) {
1476
-            foreach ($this->_fields as $field) {
1477
-                if ($field instanceof EE_Datetime_Field) {
1478
-                    $this->set_timezone($field->get_timezone());
1479
-                    break;
1480
-                }
1481
-            }
1482
-        }
1483
-        //if timezone STILL empty then return the default timezone for the site.
1484
-        if (empty($this->_timezone)) {
1485
-            $this->set_timezone(EEH_DTT_Helper::get_timezone());
1486
-        }
1487
-        return $this->_timezone;
1488
-    }
1489
-
1490
-
1491
-
1492
-    /**
1493
-     * This returns the date formats set for the given field name and also ensures that
1494
-     * $this->_timezone property is set correctly.
1495
-     *
1496
-     * @since 4.6.x
1497
-     * @param string $field_name The name of the field the formats are being retrieved for.
1498
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1499
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1500
-     * @return array formats in an array with the date format first, and the time format last.
1501
-     */
1502
-    public function get_formats_for($field_name, $pretty = false)
1503
-    {
1504
-        $field_settings = $this->field_settings_for($field_name);
1505
-        //if not a valid EE_Datetime_Field then throw error
1506
-        if (! $field_settings instanceof EE_Datetime_Field) {
1507
-            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.',
1508
-                'event_espresso'), $field_name));
1509
-        }
1510
-        //while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1511
-        //the field.
1512
-        $this->_timezone = $field_settings->get_timezone();
1513
-        return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1514
-    }
1515
-
1516
-
1517
-
1518
-    /**
1519
-     * This returns the current time in a format setup for a query on this model.
1520
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1521
-     * it will return:
1522
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1523
-     *  NOW
1524
-     *  - or a unix timestamp (equivalent to time())
1525
-     * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
1526
-     * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
1527
-     * the time returned to be the current time down to the exact second, set $timestamp to true.
1528
-     * @since 4.6.x
1529
-     * @param string $field_name       The field the current time is needed for.
1530
-     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1531
-     *                                 formatted string matching the set format for the field in the set timezone will
1532
-     *                                 be returned.
1533
-     * @param string $what             Whether to return the string in just the time format, the date format, or both.
1534
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1535
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1536
-     *                                 exception is triggered.
1537
-     */
1538
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1539
-    {
1540
-        $formats = $this->get_formats_for($field_name);
1541
-        $DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1542
-        if ($timestamp) {
1543
-            return $DateTime->format('U');
1544
-        }
1545
-        //not returning timestamp, so return formatted string in timezone.
1546
-        switch ($what) {
1547
-            case 'time' :
1548
-                return $DateTime->format($formats[1]);
1549
-                break;
1550
-            case 'date' :
1551
-                return $DateTime->format($formats[0]);
1552
-                break;
1553
-            default :
1554
-                return $DateTime->format(implode(' ', $formats));
1555
-                break;
1556
-        }
1557
-    }
1558
-
1559
-
1560
-
1561
-    /**
1562
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1563
-     * for the model are.  Returns a DateTime object.
1564
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1565
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1566
-     * ignored.
1567
-     *
1568
-     * @param string $field_name      The field being setup.
1569
-     * @param string $timestring      The date time string being used.
1570
-     * @param string $incoming_format The format for the time string.
1571
-     * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1572
-     *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1573
-     *                                format is
1574
-     *                                'U', this is ignored.
1575
-     * @return DateTime
1576
-     * @throws EE_Error
1577
-     */
1578
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1579
-    {
1580
-        //just using this to ensure the timezone is set correctly internally
1581
-        $this->get_formats_for($field_name);
1582
-        //load EEH_DTT_Helper
1583
-        $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1584
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1585
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1586
-    }
1587
-
1588
-
1589
-
1590
-    /**
1591
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1592
-     *
1593
-     * @return EE_Table_Base[]
1594
-     */
1595
-    public function get_tables()
1596
-    {
1597
-        return $this->_tables;
1598
-    }
1599
-
1600
-
1601
-
1602
-    /**
1603
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1604
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
1605
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1606
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1607
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1608
-     * model object with EVT_ID = 1
1609
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1610
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1611
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1612
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1613
-     * are not specified)
1614
-     *
1615
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1616
-     *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1617
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
1618
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
1619
-     *                                         we wanted to update only the TXN_details on any Transactions where its
1620
-     *                                         ID=34, we'd use this method as follows:
1621
-     *                                         EEM_Transaction::instance()->update(
1622
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1623
-     *                                         array(array('TXN_ID'=>34)));
1624
-     * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1625
-     *                                         in client code into what's expected to be stored on each field. Eg,
1626
-     *                                         consider updating Question's QST_admin_label field is of type
1627
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
1628
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
1629
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
1630
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1631
-     *                                         TRUE, it is assumed that you've already called
1632
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1633
-     *                                         malicious javascript. However, if
1634
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
1635
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1636
-     *                                         and every other field, before insertion. We provide this parameter
1637
-     *                                         because model objects perform their prepare_for_set function on all
1638
-     *                                         their values, and so don't need to be called again (and in many cases,
1639
-     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1640
-     *                                         prepare_for_set method...)
1641
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1642
-     *                                         in this model's entity map according to $fields_n_values that match
1643
-     *                                         $query_params. This obviously has some overhead, so you can disable it
1644
-     *                                         by setting this to FALSE, but be aware that model objects being used
1645
-     *                                         could get out-of-sync with the database
1646
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1647
-     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1648
-     *                                         bad)
1649
-     * @throws EE_Error
1650
-     */
1651
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1652
-    {
1653
-        if (! is_array($query_params)) {
1654
-            EE_Error::doing_it_wrong('EEM_Base::update',
1655
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1656
-                    gettype($query_params)), '4.6.0');
1657
-            $query_params = array();
1658
-        }
1659
-        /**
1660
-         * Action called before a model update call has been made.
1661
-         *
1662
-         * @param EEM_Base $model
1663
-         * @param array    $fields_n_values the updated fields and their new values
1664
-         * @param array    $query_params    @see EEM_Base::get_all()
1665
-         */
1666
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1667
-        /**
1668
-         * Filters the fields about to be updated given the query parameters. You can provide the
1669
-         * $query_params to $this->get_all() to find exactly which records will be updated
1670
-         *
1671
-         * @param array    $fields_n_values fields and their new values
1672
-         * @param EEM_Base $model           the model being queried
1673
-         * @param array    $query_params    see EEM_Base::get_all()
1674
-         */
1675
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1676
-            $query_params);
1677
-        //need to verify that, for any entry we want to update, there are entries in each secondary table.
1678
-        //to do that, for each table, verify that it's PK isn't null.
1679
-        $tables = $this->get_tables();
1680
-        //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
1681
-        //NOTE: we should make this code more efficient by NOT querying twice
1682
-        //before the real update, but that needs to first go through ALPHA testing
1683
-        //as it's dangerous. says Mike August 8 2014
1684
-        //we want to make sure the default_where strategy is ignored
1685
-        $this->_ignore_where_strategy = true;
1686
-        $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1687
-        foreach ($wpdb_select_results as $wpdb_result) {
1688
-            // type cast stdClass as array
1689
-            $wpdb_result = (array)$wpdb_result;
1690
-            //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1691
-            if ($this->has_primary_key_field()) {
1692
-                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1693
-            } else {
1694
-                //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)
1695
-                $main_table_pk_value = null;
1696
-            }
1697
-            //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
1698
-            //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
1699
-            if (count($tables) > 1) {
1700
-                //foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1701
-                //in that table, and so we'll want to insert one
1702
-                foreach ($tables as $table_obj) {
1703
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1704
-                    //if there is no private key for this table on the results, it means there's no entry
1705
-                    //in this table, right? so insert a row in the current table, using any fields available
1706
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1707
-                           && $wpdb_result[$this_table_pk_column])
1708
-                    ) {
1709
-                        $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1710
-                            $main_table_pk_value);
1711
-                        //if we died here, report the error
1712
-                        if (! $success) {
1713
-                            return false;
1714
-                        }
1715
-                    }
1716
-                }
1717
-            }
1718
-            //				//and now check that if we have cached any models by that ID on the model, that
1719
-            //				//they also get updated properly
1720
-            //				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1721
-            //				if( $model_object ){
1722
-            //					foreach( $fields_n_values as $field => $value ){
1723
-            //						$model_object->set($field, $value);
1724
-            //let's make sure default_where strategy is followed now
1725
-            $this->_ignore_where_strategy = false;
1726
-        }
1727
-        //if we want to keep model objects in sync, AND
1728
-        //if this wasn't called from a model object (to update itself)
1729
-        //then we want to make sure we keep all the existing
1730
-        //model objects in sync with the db
1731
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1732
-            if ($this->has_primary_key_field()) {
1733
-                $model_objs_affected_ids = $this->get_col($query_params);
1734
-            } else {
1735
-                //we need to select a bunch of columns and then combine them into the the "index primary key string"s
1736
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1737
-                $model_objs_affected_ids = array();
1738
-                foreach ($models_affected_key_columns as $row) {
1739
-                    $combined_index_key = $this->get_index_primary_key_string($row);
1740
-                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1741
-                }
1742
-            }
1743
-            if (! $model_objs_affected_ids) {
1744
-                //wait wait wait- if nothing was affected let's stop here
1745
-                return 0;
1746
-            }
1747
-            foreach ($model_objs_affected_ids as $id) {
1748
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
1749
-                if ($model_obj_in_entity_map) {
1750
-                    foreach ($fields_n_values as $field => $new_value) {
1751
-                        $model_obj_in_entity_map->set($field, $new_value);
1752
-                    }
1753
-                }
1754
-            }
1755
-            //if there is a primary key on this model, we can now do a slight optimization
1756
-            if ($this->has_primary_key_field()) {
1757
-                //we already know what we want to update. So let's make the query simpler so it's a little more efficient
1758
-                $query_params = array(
1759
-                    array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1760
-                    'limit'                    => count($model_objs_affected_ids),
1761
-                    'default_where_conditions' => EEM_Base::default_where_conditions_none,
1762
-                );
1763
-            }
1764
-        }
1765
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1766
-        $SQL = "UPDATE "
1767
-               . $model_query_info->get_full_join_sql()
1768
-               . " SET "
1769
-               . $this->_construct_update_sql($fields_n_values)
1770
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1771
-        $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1772
-        /**
1773
-         * Action called after a model update call has been made.
1774
-         *
1775
-         * @param EEM_Base $model
1776
-         * @param array    $fields_n_values the updated fields and their new values
1777
-         * @param array    $query_params    @see EEM_Base::get_all()
1778
-         * @param int      $rows_affected
1779
-         */
1780
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1781
-        return $rows_affected;//how many supposedly got updated
1782
-    }
1783
-
1784
-
1785
-
1786
-    /**
1787
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1788
-     * are teh values of the field specified (or by default the primary key field)
1789
-     * that matched the query params. Note that you should pass the name of the
1790
-     * model FIELD, not the database table's column name.
1791
-     *
1792
-     * @param array  $query_params @see EEM_Base::get_all()
1793
-     * @param string $field_to_select
1794
-     * @return array just like $wpdb->get_col()
1795
-     * @throws EE_Error
1796
-     */
1797
-    public function get_col($query_params = array(), $field_to_select = null)
1798
-    {
1799
-        if ($field_to_select) {
1800
-            $field = $this->field_settings_for($field_to_select);
1801
-        } elseif ($this->has_primary_key_field()) {
1802
-            $field = $this->get_primary_key_field();
1803
-        } else {
1804
-            //no primary key, just grab the first column
1805
-            $field = reset($this->field_settings());
1806
-        }
1807
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
1808
-        $select_expressions = $field->get_qualified_column();
1809
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1810
-        return $this->_do_wpdb_query('get_col', array($SQL));
1811
-    }
1812
-
1813
-
1814
-
1815
-    /**
1816
-     * Returns a single column value for a single row from the database
1817
-     *
1818
-     * @param array  $query_params    @see EEM_Base::get_all()
1819
-     * @param string $field_to_select @see EEM_Base::get_col()
1820
-     * @return string
1821
-     * @throws EE_Error
1822
-     */
1823
-    public function get_var($query_params = array(), $field_to_select = null)
1824
-    {
1825
-        $query_params['limit'] = 1;
1826
-        $col = $this->get_col($query_params, $field_to_select);
1827
-        if (! empty($col)) {
1828
-            return reset($col);
1829
-        }
1830
-        return null;
1831
-    }
1832
-
1833
-
1834
-
1835
-    /**
1836
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1837
-     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1838
-     * injection, but currently no further filtering is done
1839
-     *
1840
-     * @global      $wpdb
1841
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1842
-     *                               be updated to in the DB
1843
-     * @return string of SQL
1844
-     * @throws EE_Error
1845
-     */
1846
-    public function _construct_update_sql($fields_n_values)
1847
-    {
1848
-        /** @type WPDB $wpdb */
1849
-        global $wpdb;
1850
-        $cols_n_values = array();
1851
-        foreach ($fields_n_values as $field_name => $value) {
1852
-            $field_obj = $this->field_settings_for($field_name);
1853
-            //if the value is NULL, we want to assign the value to that.
1854
-            //wpdb->prepare doesn't really handle that properly
1855
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1856
-            $value_sql = $prepared_value === null ? 'NULL'
1857
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1858
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1859
-        }
1860
-        return implode(",", $cols_n_values);
1861
-    }
1862
-
1863
-
1864
-
1865
-    /**
1866
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1867
-     * Performs a HARD delete, meaning the database row should always be removed,
1868
-     * not just have a flag field on it switched
1869
-     * Wrapper for EEM_Base::delete_permanently()
1870
-     *
1871
-     * @param mixed $id
1872
-     * @return boolean whether the row got deleted or not
1873
-     * @throws EE_Error
1874
-     */
1875
-    public function delete_permanently_by_ID($id)
1876
-    {
1877
-        return $this->delete_permanently(
1878
-            array(
1879
-                array($this->get_primary_key_field()->get_name() => $id),
1880
-                'limit' => 1,
1881
-            )
1882
-        );
1883
-    }
1884
-
1885
-
1886
-
1887
-    /**
1888
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1889
-     * Wrapper for EEM_Base::delete()
1890
-     *
1891
-     * @param mixed $id
1892
-     * @return boolean whether the row got deleted or not
1893
-     * @throws EE_Error
1894
-     */
1895
-    public function delete_by_ID($id)
1896
-    {
1897
-        return $this->delete(
1898
-            array(
1899
-                array($this->get_primary_key_field()->get_name() => $id),
1900
-                'limit' => 1,
1901
-            )
1902
-        );
1903
-    }
1904
-
1905
-
1906
-
1907
-    /**
1908
-     * Identical to delete_permanently, but does a "soft" delete if possible,
1909
-     * meaning if the model has a field that indicates its been "trashed" or
1910
-     * "soft deleted", we will just set that instead of actually deleting the rows.
1911
-     *
1912
-     * @see EEM_Base::delete_permanently
1913
-     * @param array   $query_params
1914
-     * @param boolean $allow_blocking
1915
-     * @return int how many rows got deleted
1916
-     * @throws EE_Error
1917
-     */
1918
-    public function delete($query_params, $allow_blocking = true)
1919
-    {
1920
-        return $this->delete_permanently($query_params, $allow_blocking);
1921
-    }
1922
-
1923
-
1924
-
1925
-    /**
1926
-     * Deletes the model objects that meet the query params. Note: this method is overridden
1927
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1928
-     * as archived, not actually deleted
1929
-     *
1930
-     * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1931
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1932
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1933
-     *                                deletes regardless of other objects which may depend on it. Its generally
1934
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1935
-     *                                DB
1936
-     * @return int how many rows got deleted
1937
-     * @throws EE_Error
1938
-     */
1939
-    public function delete_permanently($query_params, $allow_blocking = true)
1940
-    {
1941
-        /**
1942
-         * Action called just before performing a real deletion query. You can use the
1943
-         * model and its $query_params to find exactly which items will be deleted
1944
-         *
1945
-         * @param EEM_Base $model
1946
-         * @param array    $query_params   @see EEM_Base::get_all()
1947
-         * @param boolean  $allow_blocking whether or not to allow related model objects
1948
-         *                                 to block (prevent) this deletion
1949
-         */
1950
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1951
-        //some MySQL databases may be running safe mode, which may restrict
1952
-        //deletion if there is no KEY column used in the WHERE statement of a deletion.
1953
-        //to get around this, we first do a SELECT, get all the IDs, and then run another query
1954
-        //to delete them
1955
-        $items_for_deletion = $this->_get_all_wpdb_results($query_params);
1956
-        $columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
1957
-        $deletion_where_query_part = $this->_build_query_part_for_deleting_from_columns_and_values(
1958
-            $columns_and_ids_for_deleting
1959
-        );
1960
-        /**
1961
-         * Allows client code to act on the items being deleted before the query is actually executed.
1962
-         *
1963
-         * @param EEM_Base $this  The model instance being acted on.
1964
-         * @param array    $query_params  The incoming array of query parameters influencing what gets deleted.
1965
-         * @param bool     $allow_blocking @see param description in method phpdoc block.
1966
-         * @param array $columns_and_ids_for_deleting       An array indicating what entities will get removed as
1967
-         *                                                  derived from the incoming query parameters.
1968
-         *                                                  @see details on the structure of this array in the phpdocs
1969
-         *                                                  for the `_get_ids_for_delete_method`
1970
-         *
1971
-         */
1972
-        do_action('AHEE__EEM_Base__delete__before_query',
1973
-            $this,
1974
-            $query_params,
1975
-            $allow_blocking,
1976
-            $columns_and_ids_for_deleting
1977
-        );
1978
-        if ($deletion_where_query_part) {
1979
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
1980
-            $table_aliases = array_keys($this->_tables);
1981
-            $SQL = "DELETE "
1982
-                   . implode(", ", $table_aliases)
1983
-                   . " FROM "
1984
-                   . $model_query_info->get_full_join_sql()
1985
-                   . " WHERE "
1986
-                   . $deletion_where_query_part;
1987
-            $rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1988
-        } else {
1989
-            $rows_deleted = 0;
1990
-        }
1991
-
1992
-        //Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
1993
-        //there was no error with the delete query.
1994
-        if ($this->has_primary_key_field()
1995
-            && $rows_deleted !== false
1996
-            && isset($columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()])
1997
-        ) {
1998
-            $ids_for_removal = $columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()];
1999
-            foreach ($ids_for_removal as $id) {
2000
-                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
2001
-                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
2002
-                }
2003
-            }
2004
-
2005
-            // delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
2006
-            //`EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
2007
-            //unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
2008
-            // (although it is possible).
2009
-            //Note this can be skipped by using the provided filter and returning false.
2010
-            if (apply_filters(
2011
-                'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
2012
-                ! $this instanceof EEM_Extra_Meta,
2013
-                $this
2014
-            )) {
2015
-                EEM_Extra_Meta::instance()->delete_permanently(array(
2016
-                    0 => array(
2017
-                        'EXM_type' => $this->get_this_model_name(),
2018
-                        'OBJ_ID'   => array(
2019
-                            'IN',
2020
-                            $ids_for_removal
2021
-                        )
2022
-                    )
2023
-                ));
2024
-            }
2025
-        }
2026
-
2027
-        /**
2028
-         * Action called just after performing a real deletion query. Although at this point the
2029
-         * items should have been deleted
2030
-         *
2031
-         * @param EEM_Base $model
2032
-         * @param array    $query_params @see EEM_Base::get_all()
2033
-         * @param int      $rows_deleted
2034
-         */
2035
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
2036
-        return $rows_deleted;//how many supposedly got deleted
2037
-    }
2038
-
2039
-
2040
-
2041
-    /**
2042
-     * Checks all the relations that throw error messages when there are blocking related objects
2043
-     * for related model objects. If there are any related model objects on those relations,
2044
-     * adds an EE_Error, and return true
2045
-     *
2046
-     * @param EE_Base_Class|int $this_model_obj_or_id
2047
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
2048
-     *                                                 should be ignored when determining whether there are related
2049
-     *                                                 model objects which block this model object's deletion. Useful
2050
-     *                                                 if you know A is related to B and are considering deleting A,
2051
-     *                                                 but want to see if A has any other objects blocking its deletion
2052
-     *                                                 before removing the relation between A and B
2053
-     * @return boolean
2054
-     * @throws EE_Error
2055
-     */
2056
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
2057
-    {
2058
-        //first, if $ignore_this_model_obj was supplied, get its model
2059
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
2060
-            $ignored_model = $ignore_this_model_obj->get_model();
2061
-        } else {
2062
-            $ignored_model = null;
2063
-        }
2064
-        //now check all the relations of $this_model_obj_or_id and see if there
2065
-        //are any related model objects blocking it?
2066
-        $is_blocked = false;
2067
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
2068
-            if ($relation_obj->block_delete_if_related_models_exist()) {
2069
-                //if $ignore_this_model_obj was supplied, then for the query
2070
-                //on that model needs to be told to ignore $ignore_this_model_obj
2071
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
2072
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
2073
-                        array(
2074
-                            $ignored_model->get_primary_key_field()->get_name() => array(
2075
-                                '!=',
2076
-                                $ignore_this_model_obj->ID(),
2077
-                            ),
2078
-                        ),
2079
-                    ));
2080
-                } else {
2081
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
2082
-                }
2083
-                if ($related_model_objects) {
2084
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2085
-                    $is_blocked = true;
2086
-                }
2087
-            }
2088
-        }
2089
-        return $is_blocked;
2090
-    }
2091
-
2092
-
2093
-    /**
2094
-     * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
2095
-     * @param array $row_results_for_deleting
2096
-     * @param bool  $allow_blocking
2097
-     * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
2098
-     *                 model DOES have a primary_key_field, then the array will be a simple single dimension array where
2099
-     *                 the key is the fully qualified primary key column and the value is an array of ids that will be
2100
-     *                 deleted. Example:
2101
-     *                      array('Event.EVT_ID' => array( 1,2,3))
2102
-     *                 If the model DOES NOT have a primary_key_field, then the array will be a two dimensional array
2103
-     *                 where each element is a group of columns and values that get deleted. Example:
2104
-     *                      array(
2105
-     *                          0 => array(
2106
-     *                              'Term_Relationship.object_id' => 1
2107
-     *                              'Term_Relationship.term_taxonomy_id' => 5
2108
-     *                          ),
2109
-     *                          1 => array(
2110
-     *                              'Term_Relationship.object_id' => 1
2111
-     *                              'Term_Relationship.term_taxonomy_id' => 6
2112
-     *                          )
2113
-     *                      )
2114
-     * @throws EE_Error
2115
-     */
2116
-    protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
2117
-    {
2118
-        $ids_to_delete_indexed_by_column = array();
2119
-        if ($this->has_primary_key_field()) {
2120
-            $primary_table = $this->_get_main_table();
2121
-            $other_tables = $this->_get_other_tables();
2122
-            $ids_to_delete_indexed_by_column = $query = array();
2123
-            foreach ($row_results_for_deleting as $item_to_delete) {
2124
-                //before we mark this item for deletion,
2125
-                //make sure there's no related entities blocking its deletion (if we're checking)
2126
-                if (
2127
-                    $allow_blocking
2128
-                    && $this->delete_is_blocked_by_related_models(
2129
-                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()]
2130
-                    )
2131
-                ) {
2132
-                    continue;
2133
-                }
2134
-                //primary table deletes
2135
-                if (isset($item_to_delete[$primary_table->get_fully_qualified_pk_column()])) {
2136
-                    $ids_to_delete_indexed_by_column[$primary_table->get_fully_qualified_pk_column()][] =
2137
-                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()];
2138
-                }
2139
-            }
2140
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2141
-            $fields = $this->get_combined_primary_key_fields();
2142
-            foreach ($row_results_for_deleting as $item_to_delete) {
2143
-                $ids_to_delete_indexed_by_column_for_row = array();
2144
-                foreach ($fields as $cpk_field) {
2145
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
2146
-                        $ids_to_delete_indexed_by_column_for_row[$cpk_field->get_qualified_column()] =
2147
-                            $item_to_delete[$cpk_field->get_qualified_column()];
2148
-                    }
2149
-                }
2150
-                $ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
2151
-            }
2152
-        } else {
2153
-            //so there's no primary key and no combined key...
2154
-            //sorry, can't help you
2155
-            throw new EE_Error(
2156
-                sprintf(
2157
-                    __(
2158
-                        "Cannot delete objects of type %s because there is no primary key NOR combined key",
2159
-                        "event_espresso"
2160
-                    ), get_class($this)
2161
-                )
2162
-            );
2163
-        }
2164
-        return $ids_to_delete_indexed_by_column;
2165
-    }
2166
-
2167
-
2168
-    /**
2169
-     * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
2170
-     * the corresponding query_part for the query performing the delete.
2171
-     *
2172
-     * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
2173
-     * @return string
2174
-     * @throws EE_Error
2175
-     */
2176
-    protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column) {
2177
-        $query_part = '';
2178
-        if (empty($ids_to_delete_indexed_by_column)) {
2179
-            return $query_part;
2180
-        } elseif ($this->has_primary_key_field()) {
2181
-            $query = array();
2182
-            foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
2183
-                //make sure we have unique $ids
2184
-                $ids = array_unique($ids);
2185
-                $query[] = $column . ' IN(' . implode(',', $ids) . ')';
2186
-            }
2187
-            $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
2188
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
2189
-            $ways_to_identify_a_row = array();
2190
-            foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
2191
-                $values_for_each_combined_primary_key_for_a_row = array();
2192
-                foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
2193
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
2194
-                }
2195
-                $ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2196
-            }
2197
-            $query_part = implode(' OR ', $ways_to_identify_a_row);
2198
-        }
2199
-        return $query_part;
2200
-    }
2201
-
2202
-
2203
-
2204
-
2205
-    /**
2206
-     * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2207
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2208
-     * column
2209
-     *
2210
-     * @param array  $query_params   like EEM_Base::get_all's
2211
-     * @param string $field_to_count field on model to count by (not column name)
2212
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2213
-     *                               that by the setting $distinct to TRUE;
2214
-     * @return int
2215
-     * @throws EE_Error
2216
-     */
2217
-    public function count($query_params = array(), $field_to_count = null, $distinct = false)
2218
-    {
2219
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2220
-        if ($field_to_count) {
2221
-            $field_obj = $this->field_settings_for($field_to_count);
2222
-            $column_to_count = $field_obj->get_qualified_column();
2223
-        } elseif ($this->has_primary_key_field()) {
2224
-            $pk_field_obj = $this->get_primary_key_field();
2225
-            $column_to_count = $pk_field_obj->get_qualified_column();
2226
-        } else {
2227
-            //there's no primary key
2228
-            //if we're counting distinct items, and there's no primary key,
2229
-            //we need to list out the columns for distinction;
2230
-            //otherwise we can just use star
2231
-            if ($distinct) {
2232
-                $columns_to_use = array();
2233
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2234
-                    $columns_to_use[] = $field_obj->get_qualified_column();
2235
-                }
2236
-                $column_to_count = implode(',', $columns_to_use);
2237
-            } else {
2238
-                $column_to_count = '*';
2239
-            }
2240
-        }
2241
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2242
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2243
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2244
-    }
2245
-
2246
-
2247
-
2248
-    /**
2249
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2250
-     *
2251
-     * @param array  $query_params like EEM_Base::get_all
2252
-     * @param string $field_to_sum name of field (array key in $_fields array)
2253
-     * @return float
2254
-     * @throws EE_Error
2255
-     */
2256
-    public function sum($query_params, $field_to_sum = null)
2257
-    {
2258
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
2259
-        if ($field_to_sum) {
2260
-            $field_obj = $this->field_settings_for($field_to_sum);
2261
-        } else {
2262
-            $field_obj = $this->get_primary_key_field();
2263
-        }
2264
-        $column_to_count = $field_obj->get_qualified_column();
2265
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2266
-        $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2267
-        $data_type = $field_obj->get_wpdb_data_type();
2268
-        if ($data_type === '%d' || $data_type === '%s') {
2269
-            return (float)$return_value;
2270
-        }
2271
-        //must be %f
2272
-        return (float)$return_value;
2273
-    }
2274
-
2275
-
2276
-
2277
-    /**
2278
-     * Just calls the specified method on $wpdb with the given arguments
2279
-     * Consolidates a little extra error handling code
2280
-     *
2281
-     * @param string $wpdb_method
2282
-     * @param array  $arguments_to_provide
2283
-     * @throws EE_Error
2284
-     * @global wpdb  $wpdb
2285
-     * @return mixed
2286
-     */
2287
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2288
-    {
2289
-        //if we're in maintenance mode level 2, DON'T run any queries
2290
-        //because level 2 indicates the database needs updating and
2291
-        //is probably out of sync with the code
2292
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2293
-            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.",
2294
-                "event_espresso")));
2295
-        }
2296
-        /** @type WPDB $wpdb */
2297
-        global $wpdb;
2298
-        if (! method_exists($wpdb, $wpdb_method)) {
2299
-            throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2300
-                'event_espresso'), $wpdb_method));
2301
-        }
2302
-        if (WP_DEBUG) {
2303
-            $old_show_errors_value = $wpdb->show_errors;
2304
-            $wpdb->show_errors(false);
2305
-        }
2306
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2307
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
2308
-        if (WP_DEBUG) {
2309
-            $wpdb->show_errors($old_show_errors_value);
2310
-            if (! empty($wpdb->last_error)) {
2311
-                throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2312
-            }
2313
-            if ($result === false) {
2314
-                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"',
2315
-                    'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2316
-            }
2317
-        } elseif ($result === false) {
2318
-            EE_Error::add_error(
2319
-                sprintf(
2320
-                    __('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"',
2321
-                        'event_espresso'),
2322
-                    $wpdb_method,
2323
-                    var_export($arguments_to_provide, true),
2324
-                    $wpdb->last_error
2325
-                ),
2326
-                __FILE__,
2327
-                __FUNCTION__,
2328
-                __LINE__
2329
-            );
2330
-        }
2331
-        return $result;
2332
-    }
2333
-
2334
-
2335
-
2336
-    /**
2337
-     * Attempts to run the indicated WPDB method with the provided arguments,
2338
-     * and if there's an error tries to verify the DB is correct. Uses
2339
-     * the static property EEM_Base::$_db_verification_level to determine whether
2340
-     * we should try to fix the EE core db, the addons, or just give up
2341
-     *
2342
-     * @param string $wpdb_method
2343
-     * @param array  $arguments_to_provide
2344
-     * @return mixed
2345
-     */
2346
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2347
-    {
2348
-        /** @type WPDB $wpdb */
2349
-        global $wpdb;
2350
-        $wpdb->last_error = null;
2351
-        $result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2352
-        // was there an error running the query? but we don't care on new activations
2353
-        // (we're going to setup the DB anyway on new activations)
2354
-        if (($result === false || ! empty($wpdb->last_error))
2355
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2356
-        ) {
2357
-            switch (EEM_Base::$_db_verification_level) {
2358
-                case EEM_Base::db_verified_none :
2359
-                    // let's double-check core's DB
2360
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2361
-                    break;
2362
-                case EEM_Base::db_verified_core :
2363
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2364
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2365
-                    break;
2366
-                case EEM_Base::db_verified_addons :
2367
-                    // ummmm... you in trouble
2368
-                    return $result;
2369
-                    break;
2370
-            }
2371
-            if (! empty($error_message)) {
2372
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2373
-                trigger_error($error_message);
2374
-            }
2375
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2376
-        }
2377
-        return $result;
2378
-    }
2379
-
2380
-
2381
-
2382
-    /**
2383
-     * Verifies the EE core database is up-to-date and records that we've done it on
2384
-     * EEM_Base::$_db_verification_level
2385
-     *
2386
-     * @param string $wpdb_method
2387
-     * @param array  $arguments_to_provide
2388
-     * @return string
2389
-     */
2390
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
2391
-    {
2392
-        /** @type WPDB $wpdb */
2393
-        global $wpdb;
2394
-        //ok remember that we've already attempted fixing the core db, in case the problem persists
2395
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2396
-        $error_message = sprintf(
2397
-            __('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2398
-                'event_espresso'),
2399
-            $wpdb->last_error,
2400
-            $wpdb_method,
2401
-            wp_json_encode($arguments_to_provide)
2402
-        );
2403
-        EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2404
-        return $error_message;
2405
-    }
2406
-
2407
-
2408
-
2409
-    /**
2410
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
2411
-     * EEM_Base::$_db_verification_level
2412
-     *
2413
-     * @param $wpdb_method
2414
-     * @param $arguments_to_provide
2415
-     * @return string
2416
-     */
2417
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2418
-    {
2419
-        /** @type WPDB $wpdb */
2420
-        global $wpdb;
2421
-        //ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2422
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2423
-        $error_message = sprintf(
2424
-            __('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2425
-                'event_espresso'),
2426
-            $wpdb->last_error,
2427
-            $wpdb_method,
2428
-            wp_json_encode($arguments_to_provide)
2429
-        );
2430
-        EE_System::instance()->initialize_addons();
2431
-        return $error_message;
2432
-    }
2433
-
2434
-
2435
-
2436
-    /**
2437
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2438
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2439
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2440
-     * ..."
2441
-     *
2442
-     * @param EE_Model_Query_Info_Carrier $model_query_info
2443
-     * @return string
2444
-     */
2445
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2446
-    {
2447
-        return " FROM " . $model_query_info->get_full_join_sql() .
2448
-               $model_query_info->get_where_sql() .
2449
-               $model_query_info->get_group_by_sql() .
2450
-               $model_query_info->get_having_sql() .
2451
-               $model_query_info->get_order_by_sql() .
2452
-               $model_query_info->get_limit_sql();
2453
-    }
2454
-
2455
-
2456
-
2457
-    /**
2458
-     * Set to easily debug the next X queries ran from this model.
2459
-     *
2460
-     * @param int $count
2461
-     */
2462
-    public function show_next_x_db_queries($count = 1)
2463
-    {
2464
-        $this->_show_next_x_db_queries = $count;
2465
-    }
2466
-
2467
-
2468
-
2469
-    /**
2470
-     * @param $sql_query
2471
-     */
2472
-    public function show_db_query_if_previously_requested($sql_query)
2473
-    {
2474
-        if ($this->_show_next_x_db_queries > 0) {
2475
-            echo $sql_query;
2476
-            $this->_show_next_x_db_queries--;
2477
-        }
2478
-    }
2479
-
2480
-
2481
-
2482
-    /**
2483
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2484
-     * There are the 3 cases:
2485
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2486
-     * $otherModelObject has no ID, it is first saved.
2487
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2488
-     * has no ID, it is first saved.
2489
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2490
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2491
-     * join table
2492
-     *
2493
-     * @param        EE_Base_Class                     /int $thisModelObject
2494
-     * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2495
-     * @param string $relationName                     , key in EEM_Base::_relations
2496
-     *                                                 an attendee to a group, you also want to specify which role they
2497
-     *                                                 will have in that group. So you would use this parameter to
2498
-     *                                                 specify array('role-column-name'=>'role-id')
2499
-     * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2500
-     *                                                 to for relation to methods that allow you to further specify
2501
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2502
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
2503
-     *                                                 because these will be inserted in any new rows created as well.
2504
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2505
-     * @throws EE_Error
2506
-     */
2507
-    public function add_relationship_to(
2508
-        $id_or_obj,
2509
-        $other_model_id_or_obj,
2510
-        $relationName,
2511
-        $extra_join_model_fields_n_values = array()
2512
-    ) {
2513
-        $relation_obj = $this->related_settings_for($relationName);
2514
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2515
-    }
2516
-
2517
-
2518
-
2519
-    /**
2520
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2521
-     * There are the 3 cases:
2522
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2523
-     * error
2524
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2525
-     * an error
2526
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2527
-     *
2528
-     * @param        EE_Base_Class /int $id_or_obj
2529
-     * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2530
-     * @param string $relationName key in EEM_Base::_relations
2531
-     * @return boolean of success
2532
-     * @throws EE_Error
2533
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2534
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2535
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2536
-     *                             because these will be inserted in any new rows created as well.
2537
-     */
2538
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2539
-    {
2540
-        $relation_obj = $this->related_settings_for($relationName);
2541
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2542
-    }
2543
-
2544
-
2545
-
2546
-    /**
2547
-     * @param mixed           $id_or_obj
2548
-     * @param string          $relationName
2549
-     * @param array           $where_query_params
2550
-     * @param EE_Base_Class[] objects to which relations were removed
2551
-     * @return \EE_Base_Class[]
2552
-     * @throws EE_Error
2553
-     */
2554
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2555
-    {
2556
-        $relation_obj = $this->related_settings_for($relationName);
2557
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2558
-    }
2559
-
2560
-
2561
-
2562
-    /**
2563
-     * Gets all the related items of the specified $model_name, using $query_params.
2564
-     * Note: by default, we remove the "default query params"
2565
-     * because we want to get even deleted items etc.
2566
-     *
2567
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2568
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
2569
-     * @param array  $query_params like EEM_Base::get_all
2570
-     * @return EE_Base_Class[]
2571
-     * @throws EE_Error
2572
-     */
2573
-    public function get_all_related($id_or_obj, $model_name, $query_params = null)
2574
-    {
2575
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2576
-        $relation_settings = $this->related_settings_for($model_name);
2577
-        return $relation_settings->get_all_related($model_obj, $query_params);
2578
-    }
2579
-
2580
-
2581
-
2582
-    /**
2583
-     * Deletes all the model objects across the relation indicated by $model_name
2584
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
2585
-     * However, if the model objects can't be deleted because of blocking related model objects, then
2586
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2587
-     *
2588
-     * @param EE_Base_Class|int|string $id_or_obj
2589
-     * @param string                   $model_name
2590
-     * @param array                    $query_params
2591
-     * @return int how many deleted
2592
-     * @throws EE_Error
2593
-     */
2594
-    public function delete_related($id_or_obj, $model_name, $query_params = array())
2595
-    {
2596
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2597
-        $relation_settings = $this->related_settings_for($model_name);
2598
-        return $relation_settings->delete_all_related($model_obj, $query_params);
2599
-    }
2600
-
2601
-
2602
-
2603
-    /**
2604
-     * Hard deletes all the model objects across the relation indicated by $model_name
2605
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
2606
-     * the model objects can't be hard deleted because of blocking related model objects,
2607
-     * just does a soft-delete on them instead.
2608
-     *
2609
-     * @param EE_Base_Class|int|string $id_or_obj
2610
-     * @param string                   $model_name
2611
-     * @param array                    $query_params
2612
-     * @return int how many deleted
2613
-     * @throws EE_Error
2614
-     */
2615
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2616
-    {
2617
-        $model_obj = $this->ensure_is_obj($id_or_obj);
2618
-        $relation_settings = $this->related_settings_for($model_name);
2619
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
2620
-    }
2621
-
2622
-
2623
-
2624
-    /**
2625
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2626
-     * unless otherwise specified in the $query_params
2627
-     *
2628
-     * @param        int             /EE_Base_Class $id_or_obj
2629
-     * @param string $model_name     like 'Event', or 'Registration'
2630
-     * @param array  $query_params   like EEM_Base::get_all's
2631
-     * @param string $field_to_count name of field to count by. By default, uses primary key
2632
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2633
-     *                               that by the setting $distinct to TRUE;
2634
-     * @return int
2635
-     * @throws EE_Error
2636
-     */
2637
-    public function count_related(
2638
-        $id_or_obj,
2639
-        $model_name,
2640
-        $query_params = array(),
2641
-        $field_to_count = null,
2642
-        $distinct = false
2643
-    ) {
2644
-        $related_model = $this->get_related_model_obj($model_name);
2645
-        //we're just going to use the query params on the related model's normal get_all query,
2646
-        //except add a condition to say to match the current mod
2647
-        if (! isset($query_params['default_where_conditions'])) {
2648
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2649
-        }
2650
-        $this_model_name = $this->get_this_model_name();
2651
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2652
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2653
-        return $related_model->count($query_params, $field_to_count, $distinct);
2654
-    }
2655
-
2656
-
2657
-
2658
-    /**
2659
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
2660
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2661
-     *
2662
-     * @param        int           /EE_Base_Class $id_or_obj
2663
-     * @param string $model_name   like 'Event', or 'Registration'
2664
-     * @param array  $query_params like EEM_Base::get_all's
2665
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
2666
-     * @return float
2667
-     * @throws EE_Error
2668
-     */
2669
-    public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2670
-    {
2671
-        $related_model = $this->get_related_model_obj($model_name);
2672
-        if (! is_array($query_params)) {
2673
-            EE_Error::doing_it_wrong('EEM_Base::sum_related',
2674
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2675
-                    gettype($query_params)), '4.6.0');
2676
-            $query_params = array();
2677
-        }
2678
-        //we're just going to use the query params on the related model's normal get_all query,
2679
-        //except add a condition to say to match the current mod
2680
-        if (! isset($query_params['default_where_conditions'])) {
2681
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2682
-        }
2683
-        $this_model_name = $this->get_this_model_name();
2684
-        $this_pk_field_name = $this->get_primary_key_field()->get_name();
2685
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2686
-        return $related_model->sum($query_params, $field_to_sum);
2687
-    }
2688
-
2689
-
2690
-
2691
-    /**
2692
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2693
-     * $modelObject
2694
-     *
2695
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2696
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2697
-     * @param array               $query_params     like EEM_Base::get_all's
2698
-     * @return EE_Base_Class
2699
-     * @throws EE_Error
2700
-     */
2701
-    public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2702
-    {
2703
-        $query_params['limit'] = 1;
2704
-        $results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2705
-        if ($results) {
2706
-            return array_shift($results);
2707
-        }
2708
-        return null;
2709
-    }
2710
-
2711
-
2712
-
2713
-    /**
2714
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2715
-     *
2716
-     * @return string
2717
-     */
2718
-    public function get_this_model_name()
2719
-    {
2720
-        return str_replace("EEM_", "", get_class($this));
2721
-    }
2722
-
2723
-
2724
-
2725
-    /**
2726
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2727
-     *
2728
-     * @return EE_Any_Foreign_Model_Name_Field
2729
-     * @throws EE_Error
2730
-     */
2731
-    public function get_field_containing_related_model_name()
2732
-    {
2733
-        foreach ($this->field_settings(true) as $field) {
2734
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2735
-                $field_with_model_name = $field;
2736
-            }
2737
-        }
2738
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2739
-            throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2740
-                $this->get_this_model_name()));
2741
-        }
2742
-        return $field_with_model_name;
2743
-    }
2744
-
2745
-
2746
-
2747
-    /**
2748
-     * Inserts a new entry into the database, for each table.
2749
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2750
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2751
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
2752
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
2753
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2754
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2755
-     *
2756
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2757
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2758
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2759
-     *                              of EEM_Base)
2760
-     * @return int new primary key on main table that got inserted
2761
-     * @throws EE_Error
2762
-     */
2763
-    public function insert($field_n_values)
2764
-    {
2765
-        /**
2766
-         * Filters the fields and their values before inserting an item using the models
2767
-         *
2768
-         * @param array    $fields_n_values keys are the fields and values are their new values
2769
-         * @param EEM_Base $model           the model used
2770
-         */
2771
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2772
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
2773
-            $main_table = $this->_get_main_table();
2774
-            $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2775
-            if ($new_id !== false) {
2776
-                foreach ($this->_get_other_tables() as $other_table) {
2777
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2778
-                }
2779
-            }
2780
-            /**
2781
-             * Done just after attempting to insert a new model object
2782
-             *
2783
-             * @param EEM_Base   $model           used
2784
-             * @param array      $fields_n_values fields and their values
2785
-             * @param int|string the              ID of the newly-inserted model object
2786
-             */
2787
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2788
-            return $new_id;
2789
-        }
2790
-        return false;
2791
-    }
2792
-
2793
-
2794
-
2795
-    /**
2796
-     * Checks that the result would satisfy the unique indexes on this model
2797
-     *
2798
-     * @param array  $field_n_values
2799
-     * @param string $action
2800
-     * @return boolean
2801
-     * @throws EE_Error
2802
-     */
2803
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2804
-    {
2805
-        foreach ($this->unique_indexes() as $index_name => $index) {
2806
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2807
-            if ($this->exists(array($uniqueness_where_params))) {
2808
-                EE_Error::add_error(
2809
-                    sprintf(
2810
-                        __(
2811
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2812
-                            "event_espresso"
2813
-                        ),
2814
-                        $action,
2815
-                        $this->_get_class_name(),
2816
-                        $index_name,
2817
-                        implode(",", $index->field_names()),
2818
-                        http_build_query($uniqueness_where_params)
2819
-                    ),
2820
-                    __FILE__,
2821
-                    __FUNCTION__,
2822
-                    __LINE__
2823
-                );
2824
-                return false;
2825
-            }
2826
-        }
2827
-        return true;
2828
-    }
2829
-
2830
-
2831
-
2832
-    /**
2833
-     * Checks the database for an item that conflicts (ie, if this item were
2834
-     * saved to the DB would break some uniqueness requirement, like a primary key
2835
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
2836
-     * can be either an EE_Base_Class or an array of fields n values
2837
-     *
2838
-     * @param EE_Base_Class|array $obj_or_fields_array
2839
-     * @param boolean             $include_primary_key whether to use the model object's primary key
2840
-     *                                                 when looking for conflicts
2841
-     *                                                 (ie, if false, we ignore the model object's primary key
2842
-     *                                                 when finding "conflicts". If true, it's also considered).
2843
-     *                                                 Only works for INT primary key,
2844
-     *                                                 STRING primary keys cannot be ignored
2845
-     * @throws EE_Error
2846
-     * @return EE_Base_Class|array
2847
-     */
2848
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2849
-    {
2850
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
2851
-            $fields_n_values = $obj_or_fields_array->model_field_array();
2852
-        } elseif (is_array($obj_or_fields_array)) {
2853
-            $fields_n_values = $obj_or_fields_array;
2854
-        } else {
2855
-            throw new EE_Error(
2856
-                sprintf(
2857
-                    __(
2858
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2859
-                        "event_espresso"
2860
-                    ),
2861
-                    get_class($this),
2862
-                    $obj_or_fields_array
2863
-                )
2864
-            );
2865
-        }
2866
-        $query_params = array();
2867
-        if ($this->has_primary_key_field()
2868
-            && ($include_primary_key
2869
-                || $this->get_primary_key_field()
2870
-                   instanceof
2871
-                   EE_Primary_Key_String_Field)
2872
-            && isset($fields_n_values[$this->primary_key_name()])
2873
-        ) {
2874
-            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2875
-        }
2876
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2877
-            $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2878
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2879
-        }
2880
-        //if there is nothing to base this search on, then we shouldn't find anything
2881
-        if (empty($query_params)) {
2882
-            return array();
2883
-        }
2884
-        return $this->get_one($query_params);
2885
-    }
2886
-
2887
-
2888
-
2889
-    /**
2890
-     * Like count, but is optimized and returns a boolean instead of an int
2891
-     *
2892
-     * @param array $query_params
2893
-     * @return boolean
2894
-     * @throws EE_Error
2895
-     */
2896
-    public function exists($query_params)
2897
-    {
2898
-        $query_params['limit'] = 1;
2899
-        return $this->count($query_params) > 0;
2900
-    }
2901
-
2902
-
2903
-
2904
-    /**
2905
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
2906
-     *
2907
-     * @param int|string $id
2908
-     * @return boolean
2909
-     * @throws EE_Error
2910
-     */
2911
-    public function exists_by_ID($id)
2912
-    {
2913
-        return $this->exists(
2914
-            array(
2915
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
2916
-                array(
2917
-                    $this->primary_key_name() => $id,
2918
-                ),
2919
-            )
2920
-        );
2921
-    }
2922
-
2923
-
2924
-
2925
-    /**
2926
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2927
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2928
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2929
-     * on the main table)
2930
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
2931
-     * cases where we want to call it directly rather than via insert().
2932
-     *
2933
-     * @access   protected
2934
-     * @param EE_Table_Base $table
2935
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2936
-     *                                       float
2937
-     * @param int           $new_id          for now we assume only int keys
2938
-     * @throws EE_Error
2939
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2940
-     * @return int ID of new row inserted, or FALSE on failure
2941
-     */
2942
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2943
-    {
2944
-        global $wpdb;
2945
-        $insertion_col_n_values = array();
2946
-        $format_for_insertion = array();
2947
-        $fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2948
-        foreach ($fields_on_table as $field_name => $field_obj) {
2949
-            //check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2950
-            if ($field_obj->is_auto_increment()) {
2951
-                continue;
2952
-            }
2953
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2954
-            //if the value we want to assign it to is NULL, just don't mention it for the insertion
2955
-            if ($prepared_value !== null) {
2956
-                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2957
-                $format_for_insertion[] = $field_obj->get_wpdb_data_type();
2958
-            }
2959
-        }
2960
-        if ($table instanceof EE_Secondary_Table && $new_id) {
2961
-            //its not the main table, so we should have already saved the main table's PK which we just inserted
2962
-            //so add the fk to the main table as a column
2963
-            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2964
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2965
-        }
2966
-        //insert the new entry
2967
-        $result = $this->_do_wpdb_query('insert',
2968
-            array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2969
-        if ($result === false) {
2970
-            return false;
2971
-        }
2972
-        //ok, now what do we return for the ID of the newly-inserted thing?
2973
-        if ($this->has_primary_key_field()) {
2974
-            if ($this->get_primary_key_field()->is_auto_increment()) {
2975
-                return $wpdb->insert_id;
2976
-            }
2977
-            //it's not an auto-increment primary key, so
2978
-            //it must have been supplied
2979
-            return $fields_n_values[$this->get_primary_key_field()->get_name()];
2980
-        }
2981
-        //we can't return a  primary key because there is none. instead return
2982
-        //a unique string indicating this model
2983
-        return $this->get_index_primary_key_string($fields_n_values);
2984
-    }
2985
-
2986
-
2987
-
2988
-    /**
2989
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2990
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2991
-     * and there is no default, we pass it along. WPDB will take care of it)
2992
-     *
2993
-     * @param EE_Model_Field_Base $field_obj
2994
-     * @param array               $fields_n_values
2995
-     * @return mixed string|int|float depending on what the table column will be expecting
2996
-     * @throws EE_Error
2997
-     */
2998
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2999
-    {
3000
-        //if this field doesn't allow nullable, don't allow it
3001
-        if (
3002
-            ! $field_obj->is_nullable()
3003
-            && (
3004
-                ! isset($fields_n_values[$field_obj->get_name()])
3005
-                || $fields_n_values[$field_obj->get_name()] === null
3006
-            )
3007
-        ) {
3008
-            $fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
3009
-        }
3010
-        $unprepared_value = isset($fields_n_values[$field_obj->get_name()])
3011
-            ? $fields_n_values[$field_obj->get_name()]
3012
-            : null;
3013
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
3014
-    }
3015
-
3016
-
3017
-
3018
-    /**
3019
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
3020
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
3021
-     * the field's prepare_for_set() method.
3022
-     *
3023
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
3024
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
3025
-     *                                   top of file)
3026
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
3027
-     *                                   $value is a custom selection
3028
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
3029
-     */
3030
-    private function _prepare_value_for_use_in_db($value, $field)
3031
-    {
3032
-        if ($field && $field instanceof EE_Model_Field_Base) {
3033
-            switch ($this->_values_already_prepared_by_model_object) {
3034
-                /** @noinspection PhpMissingBreakStatementInspection */
3035
-                case self::not_prepared_by_model_object:
3036
-                    $value = $field->prepare_for_set($value);
3037
-                //purposefully left out "return"
3038
-                case self::prepared_by_model_object:
3039
-                    /** @noinspection SuspiciousAssignmentsInspection */
3040
-                    $value = $field->prepare_for_use_in_db($value);
3041
-                case self::prepared_for_use_in_db:
3042
-                    //leave the value alone
3043
-            }
3044
-            return $value;
3045
-        }
3046
-        return $value;
3047
-    }
3048
-
3049
-
3050
-
3051
-    /**
3052
-     * Returns the main table on this model
3053
-     *
3054
-     * @return EE_Primary_Table
3055
-     * @throws EE_Error
3056
-     */
3057
-    protected function _get_main_table()
3058
-    {
3059
-        foreach ($this->_tables as $table) {
3060
-            if ($table instanceof EE_Primary_Table) {
3061
-                return $table;
3062
-            }
3063
-        }
3064
-        throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
3065
-            'event_espresso'), get_class($this)));
3066
-    }
3067
-
3068
-
3069
-
3070
-    /**
3071
-     * table
3072
-     * returns EE_Primary_Table table name
3073
-     *
3074
-     * @return string
3075
-     * @throws EE_Error
3076
-     */
3077
-    public function table()
3078
-    {
3079
-        return $this->_get_main_table()->get_table_name();
3080
-    }
3081
-
3082
-
3083
-
3084
-    /**
3085
-     * table
3086
-     * returns first EE_Secondary_Table table name
3087
-     *
3088
-     * @return string
3089
-     */
3090
-    public function second_table()
3091
-    {
3092
-        // grab second table from tables array
3093
-        $second_table = end($this->_tables);
3094
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
3095
-    }
3096
-
3097
-
3098
-
3099
-    /**
3100
-     * get_table_obj_by_alias
3101
-     * returns table name given it's alias
3102
-     *
3103
-     * @param string $table_alias
3104
-     * @return EE_Primary_Table | EE_Secondary_Table
3105
-     */
3106
-    public function get_table_obj_by_alias($table_alias = '')
3107
-    {
3108
-        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3109
-    }
3110
-
3111
-
3112
-
3113
-    /**
3114
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3115
-     *
3116
-     * @return EE_Secondary_Table[]
3117
-     */
3118
-    protected function _get_other_tables()
3119
-    {
3120
-        $other_tables = array();
3121
-        foreach ($this->_tables as $table_alias => $table) {
3122
-            if ($table instanceof EE_Secondary_Table) {
3123
-                $other_tables[$table_alias] = $table;
3124
-            }
3125
-        }
3126
-        return $other_tables;
3127
-    }
3128
-
3129
-
3130
-
3131
-    /**
3132
-     * Finds all the fields that correspond to the given table
3133
-     *
3134
-     * @param string $table_alias , array key in EEM_Base::_tables
3135
-     * @return EE_Model_Field_Base[]
3136
-     */
3137
-    public function _get_fields_for_table($table_alias)
3138
-    {
3139
-        return $this->_fields[$table_alias];
3140
-    }
3141
-
3142
-
3143
-
3144
-    /**
3145
-     * Recurses through all the where parameters, and finds all the related models we'll need
3146
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3147
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3148
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3149
-     * related Registration, Transaction, and Payment models.
3150
-     *
3151
-     * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3152
-     * @return EE_Model_Query_Info_Carrier
3153
-     * @throws EE_Error
3154
-     */
3155
-    public function _extract_related_models_from_query($query_params)
3156
-    {
3157
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
3158
-        if (array_key_exists(0, $query_params)) {
3159
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3160
-        }
3161
-        if (array_key_exists('group_by', $query_params)) {
3162
-            if (is_array($query_params['group_by'])) {
3163
-                $this->_extract_related_models_from_sub_params_array_values(
3164
-                    $query_params['group_by'],
3165
-                    $query_info_carrier,
3166
-                    'group_by'
3167
-                );
3168
-            } elseif (! empty ($query_params['group_by'])) {
3169
-                $this->_extract_related_model_info_from_query_param(
3170
-                    $query_params['group_by'],
3171
-                    $query_info_carrier,
3172
-                    'group_by'
3173
-                );
3174
-            }
3175
-        }
3176
-        if (array_key_exists('having', $query_params)) {
3177
-            $this->_extract_related_models_from_sub_params_array_keys(
3178
-                $query_params[0],
3179
-                $query_info_carrier,
3180
-                'having'
3181
-            );
3182
-        }
3183
-        if (array_key_exists('order_by', $query_params)) {
3184
-            if (is_array($query_params['order_by'])) {
3185
-                $this->_extract_related_models_from_sub_params_array_keys(
3186
-                    $query_params['order_by'],
3187
-                    $query_info_carrier,
3188
-                    'order_by'
3189
-                );
3190
-            } elseif (! empty($query_params['order_by'])) {
3191
-                $this->_extract_related_model_info_from_query_param(
3192
-                    $query_params['order_by'],
3193
-                    $query_info_carrier,
3194
-                    'order_by'
3195
-                );
3196
-            }
3197
-        }
3198
-        if (array_key_exists('force_join', $query_params)) {
3199
-            $this->_extract_related_models_from_sub_params_array_values(
3200
-                $query_params['force_join'],
3201
-                $query_info_carrier,
3202
-                'force_join'
3203
-            );
3204
-        }
3205
-        return $query_info_carrier;
3206
-    }
3207
-
3208
-
3209
-
3210
-    /**
3211
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3212
-     *
3213
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3214
-     *                                                      $query_params['having']
3215
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3216
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3217
-     * @throws EE_Error
3218
-     * @return \EE_Model_Query_Info_Carrier
3219
-     */
3220
-    private function _extract_related_models_from_sub_params_array_keys(
3221
-        $sub_query_params,
3222
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3223
-        $query_param_type
3224
-    ) {
3225
-        if (! empty($sub_query_params)) {
3226
-            $sub_query_params = (array)$sub_query_params;
3227
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
3228
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3229
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3230
-                    $query_param_type);
3231
-                //if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3232
-                //indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3233
-                //extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3234
-                //of array('Registration.TXN_ID'=>23)
3235
-                $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3236
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3237
-                    if (! is_array($possibly_array_of_params)) {
3238
-                        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'))",
3239
-                            "event_espresso"),
3240
-                            $param, $possibly_array_of_params));
3241
-                    }
3242
-                    $this->_extract_related_models_from_sub_params_array_keys(
3243
-                        $possibly_array_of_params,
3244
-                        $model_query_info_carrier, $query_param_type
3245
-                    );
3246
-                } elseif ($query_param_type === 0 //ie WHERE
3247
-                          && is_array($possibly_array_of_params)
3248
-                          && isset($possibly_array_of_params[2])
3249
-                          && $possibly_array_of_params[2] == true
3250
-                ) {
3251
-                    //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3252
-                    //indicating that $possible_array_of_params[1] is actually a field name,
3253
-                    //from which we should extract query parameters!
3254
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3255
-                        throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3256
-                            "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3257
-                    }
3258
-                    $this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3259
-                        $model_query_info_carrier, $query_param_type);
3260
-                }
3261
-            }
3262
-        }
3263
-        return $model_query_info_carrier;
3264
-    }
3265
-
3266
-
3267
-
3268
-    /**
3269
-     * For extracting related models from forced_joins, where the array values contain the info about what
3270
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3271
-     *
3272
-     * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3273
-     *                                                      $query_params['having']
3274
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3275
-     * @param string                      $query_param_type one of $this->_allowed_query_params
3276
-     * @throws EE_Error
3277
-     * @return \EE_Model_Query_Info_Carrier
3278
-     */
3279
-    private function _extract_related_models_from_sub_params_array_values(
3280
-        $sub_query_params,
3281
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
3282
-        $query_param_type
3283
-    ) {
3284
-        if (! empty($sub_query_params)) {
3285
-            if (! is_array($sub_query_params)) {
3286
-                throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3287
-                    $sub_query_params));
3288
-            }
3289
-            foreach ($sub_query_params as $param) {
3290
-                //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3291
-                $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3292
-                    $query_param_type);
3293
-            }
3294
-        }
3295
-        return $model_query_info_carrier;
3296
-    }
3297
-
3298
-
3299
-
3300
-    /**
3301
-     * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3302
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3303
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
3304
-     * but use them in a different order. Eg, we need to know what models we are querying
3305
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3306
-     * other models before we can finalize the where clause SQL.
3307
-     *
3308
-     * @param array $query_params
3309
-     * @throws EE_Error
3310
-     * @return EE_Model_Query_Info_Carrier
3311
-     */
3312
-    public function _create_model_query_info_carrier($query_params)
3313
-    {
3314
-        if (! is_array($query_params)) {
3315
-            EE_Error::doing_it_wrong(
3316
-                'EEM_Base::_create_model_query_info_carrier',
3317
-                sprintf(
3318
-                    __(
3319
-                        '$query_params should be an array, you passed a variable of type %s',
3320
-                        'event_espresso'
3321
-                    ),
3322
-                    gettype($query_params)
3323
-                ),
3324
-                '4.6.0'
3325
-            );
3326
-            $query_params = array();
3327
-        }
3328
-        $where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3329
-        //first check if we should alter the query to account for caps or not
3330
-        //because the caps might require us to do extra joins
3331
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3332
-            $query_params[0] = $where_query_params = array_replace_recursive(
3333
-                $where_query_params,
3334
-                $this->caps_where_conditions(
3335
-                    $query_params['caps']
3336
-                )
3337
-            );
3338
-        }
3339
-        $query_object = $this->_extract_related_models_from_query($query_params);
3340
-        //verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3341
-        foreach ($where_query_params as $key => $value) {
3342
-            if (is_int($key)) {
3343
-                throw new EE_Error(
3344
-                    sprintf(
3345
-                        __(
3346
-                            "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.",
3347
-                            "event_espresso"
3348
-                        ),
3349
-                        $key,
3350
-                        var_export($value, true),
3351
-                        var_export($query_params, true),
3352
-                        get_class($this)
3353
-                    )
3354
-                );
3355
-            }
3356
-        }
3357
-        if (
3358
-            array_key_exists('default_where_conditions', $query_params)
3359
-            && ! empty($query_params['default_where_conditions'])
3360
-        ) {
3361
-            $use_default_where_conditions = $query_params['default_where_conditions'];
3362
-        } else {
3363
-            $use_default_where_conditions = EEM_Base::default_where_conditions_all;
3364
-        }
3365
-        $where_query_params = array_merge(
3366
-            $this->_get_default_where_conditions_for_models_in_query(
3367
-                $query_object,
3368
-                $use_default_where_conditions,
3369
-                $where_query_params
3370
-            ),
3371
-            $where_query_params
3372
-        );
3373
-        $query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3374
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3375
-        // So we need to setup a subquery and use that for the main join.
3376
-        // Note for now this only works on the primary table for the model.
3377
-        // So for instance, you could set the limit array like this:
3378
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3379
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3380
-            $query_object->set_main_model_join_sql(
3381
-                $this->_construct_limit_join_select(
3382
-                    $query_params['on_join_limit'][0],
3383
-                    $query_params['on_join_limit'][1]
3384
-                )
3385
-            );
3386
-        }
3387
-        //set limit
3388
-        if (array_key_exists('limit', $query_params)) {
3389
-            if (is_array($query_params['limit'])) {
3390
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3391
-                    $e = sprintf(
3392
-                        __(
3393
-                            "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)",
3394
-                            "event_espresso"
3395
-                        ),
3396
-                        http_build_query($query_params['limit'])
3397
-                    );
3398
-                    throw new EE_Error($e . "|" . $e);
3399
-                }
3400
-                //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3401
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3402
-            } elseif (! empty ($query_params['limit'])) {
3403
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3404
-            }
3405
-        }
3406
-        //set order by
3407
-        if (array_key_exists('order_by', $query_params)) {
3408
-            if (is_array($query_params['order_by'])) {
3409
-                //if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3410
-                //specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3411
-                //including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3412
-                if (array_key_exists('order', $query_params)) {
3413
-                    throw new EE_Error(
3414
-                        sprintf(
3415
-                            __(
3416
-                                "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 ",
3417
-                                "event_espresso"
3418
-                            ),
3419
-                            get_class($this),
3420
-                            implode(", ", array_keys($query_params['order_by'])),
3421
-                            implode(", ", $query_params['order_by']),
3422
-                            $query_params['order']
3423
-                        )
3424
-                    );
3425
-                }
3426
-                $this->_extract_related_models_from_sub_params_array_keys(
3427
-                    $query_params['order_by'],
3428
-                    $query_object,
3429
-                    'order_by'
3430
-                );
3431
-                //assume it's an array of fields to order by
3432
-                $order_array = array();
3433
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3434
-                    $order = $this->_extract_order($order);
3435
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3436
-                }
3437
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3438
-            } elseif (! empty ($query_params['order_by'])) {
3439
-                $this->_extract_related_model_info_from_query_param(
3440
-                    $query_params['order_by'],
3441
-                    $query_object,
3442
-                    'order',
3443
-                    $query_params['order_by']
3444
-                );
3445
-                $order = isset($query_params['order'])
3446
-                    ? $this->_extract_order($query_params['order'])
3447
-                    : 'DESC';
3448
-                $query_object->set_order_by_sql(
3449
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3450
-                );
3451
-            }
3452
-        }
3453
-        //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3454
-        if (! array_key_exists('order_by', $query_params)
3455
-            && array_key_exists('order', $query_params)
3456
-            && ! empty($query_params['order'])
3457
-        ) {
3458
-            $pk_field = $this->get_primary_key_field();
3459
-            $order = $this->_extract_order($query_params['order']);
3460
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3461
-        }
3462
-        //set group by
3463
-        if (array_key_exists('group_by', $query_params)) {
3464
-            if (is_array($query_params['group_by'])) {
3465
-                //it's an array, so assume we'll be grouping by a bunch of stuff
3466
-                $group_by_array = array();
3467
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
3468
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3469
-                }
3470
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3471
-            } elseif (! empty ($query_params['group_by'])) {
3472
-                $query_object->set_group_by_sql(
3473
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3474
-                );
3475
-            }
3476
-        }
3477
-        //set having
3478
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
3479
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3480
-        }
3481
-        //now, just verify they didn't pass anything wack
3482
-        foreach ($query_params as $query_key => $query_value) {
3483
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3484
-                throw new EE_Error(
3485
-                    sprintf(
3486
-                        __(
3487
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3488
-                            'event_espresso'
3489
-                        ),
3490
-                        $query_key,
3491
-                        get_class($this),
3492
-                        //						print_r( $this->_allowed_query_params, TRUE )
3493
-                        implode(',', $this->_allowed_query_params)
3494
-                    )
3495
-                );
3496
-            }
3497
-        }
3498
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
3499
-        if (empty($main_model_join_sql)) {
3500
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
3501
-        }
3502
-        return $query_object;
3503
-    }
3504
-
3505
-
3506
-
3507
-    /**
3508
-     * Gets the where conditions that should be imposed on the query based on the
3509
-     * context (eg reading frontend, backend, edit or delete).
3510
-     *
3511
-     * @param string $context one of EEM_Base::valid_cap_contexts()
3512
-     * @return array like EEM_Base::get_all() 's $query_params[0]
3513
-     * @throws EE_Error
3514
-     */
3515
-    public function caps_where_conditions($context = self::caps_read)
3516
-    {
3517
-        EEM_Base::verify_is_valid_cap_context($context);
3518
-        $cap_where_conditions = array();
3519
-        $cap_restrictions = $this->caps_missing($context);
3520
-        /**
3521
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
3522
-         */
3523
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3524
-            $cap_where_conditions = array_replace_recursive($cap_where_conditions,
3525
-                $restriction_if_no_cap->get_default_where_conditions());
3526
-        }
3527
-        return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3528
-            $cap_restrictions);
3529
-    }
3530
-
3531
-
3532
-
3533
-    /**
3534
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3535
-     * otherwise throws an exception
3536
-     *
3537
-     * @param string $should_be_order_string
3538
-     * @return string either ASC, asc, DESC or desc
3539
-     * @throws EE_Error
3540
-     */
3541
-    private function _extract_order($should_be_order_string)
3542
-    {
3543
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3544
-            return $should_be_order_string;
3545
-        }
3546
-        throw new EE_Error(
3547
-            sprintf(
3548
-                __(
3549
-                    "While performing a query on '%s', tried to use '%s' as an order parameter. ",
3550
-                    "event_espresso"
3551
-                ), get_class($this), $should_be_order_string
3552
-            )
3553
-        );
3554
-    }
3555
-
3556
-
3557
-
3558
-    /**
3559
-     * Looks at all the models which are included in this query, and asks each
3560
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3561
-     * so they can be merged
3562
-     *
3563
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
3564
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3565
-     *                                                                  'none' means NO default where conditions will
3566
-     *                                                                  be used AT ALL during this query.
3567
-     *                                                                  'other_models_only' means default where
3568
-     *                                                                  conditions from other models will be used, but
3569
-     *                                                                  not for this primary model. 'all', the default,
3570
-     *                                                                  means default where conditions will apply as
3571
-     *                                                                  normal
3572
-     * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3573
-     * @throws EE_Error
3574
-     * @return array like $query_params[0], see EEM_Base::get_all for documentation
3575
-     */
3576
-    private function _get_default_where_conditions_for_models_in_query(
3577
-        EE_Model_Query_Info_Carrier $query_info_carrier,
3578
-        $use_default_where_conditions = EEM_Base::default_where_conditions_all,
3579
-        $where_query_params = array()
3580
-    ) {
3581
-        $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3582
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3583
-            throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3584
-                "event_espresso"), $use_default_where_conditions,
3585
-                implode(", ", $allowed_used_default_where_conditions_values)));
3586
-        }
3587
-        $universal_query_params = array();
3588
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3589
-            $universal_query_params = $this->_get_default_where_conditions();
3590
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3591
-            $universal_query_params = $this->_get_minimum_where_conditions();
3592
-        }
3593
-        foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3594
-            $related_model = $this->get_related_model_obj($model_name);
3595
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3596
-                $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3597
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3598
-                $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3599
-            } else {
3600
-                //we don't want to add full or even minimum default where conditions from this model, so just continue
3601
-                continue;
3602
-            }
3603
-            $overrides = $this->_override_defaults_or_make_null_friendly(
3604
-                $related_model_universal_where_params,
3605
-                $where_query_params,
3606
-                $related_model,
3607
-                $model_relation_path
3608
-            );
3609
-            $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3610
-                $universal_query_params,
3611
-                $overrides
3612
-            );
3613
-        }
3614
-        return $universal_query_params;
3615
-    }
3616
-
3617
-
3618
-
3619
-    /**
3620
-     * Determines whether or not we should use default where conditions for the model in question
3621
-     * (this model, or other related models).
3622
-     * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3623
-     * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3624
-     * We should use default where conditions on related models when they requested to use default where conditions
3625
-     * on all models, or specifically just on other related models
3626
-     * @param      $default_where_conditions_value
3627
-     * @param bool $for_this_model false means this is for OTHER related models
3628
-     * @return bool
3629
-     */
3630
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3631
-    {
3632
-        return (
3633
-                   $for_this_model
3634
-                   && in_array(
3635
-                       $default_where_conditions_value,
3636
-                       array(
3637
-                           EEM_Base::default_where_conditions_all,
3638
-                           EEM_Base::default_where_conditions_this_only,
3639
-                           EEM_Base::default_where_conditions_minimum_others,
3640
-                       ),
3641
-                       true
3642
-                   )
3643
-               )
3644
-               || (
3645
-                   ! $for_this_model
3646
-                   && in_array(
3647
-                       $default_where_conditions_value,
3648
-                       array(
3649
-                           EEM_Base::default_where_conditions_all,
3650
-                           EEM_Base::default_where_conditions_others_only,
3651
-                       ),
3652
-                       true
3653
-                   )
3654
-               );
3655
-    }
3656
-
3657
-    /**
3658
-     * Determines whether or not we should use default minimum conditions for the model in question
3659
-     * (this model, or other related models).
3660
-     * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3661
-     * where conditions.
3662
-     * We should use minimum where conditions on related models if they requested to use minimum where conditions
3663
-     * on this model or others
3664
-     * @param      $default_where_conditions_value
3665
-     * @param bool $for_this_model false means this is for OTHER related models
3666
-     * @return bool
3667
-     */
3668
-    private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3669
-    {
3670
-        return (
3671
-                   $for_this_model
3672
-                   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3673
-               )
3674
-               || (
3675
-                   ! $for_this_model
3676
-                   && in_array(
3677
-                       $default_where_conditions_value,
3678
-                       array(
3679
-                           EEM_Base::default_where_conditions_minimum_others,
3680
-                           EEM_Base::default_where_conditions_minimum_all,
3681
-                       ),
3682
-                       true
3683
-                   )
3684
-               );
3685
-    }
3686
-
3687
-
3688
-    /**
3689
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3690
-     * then we also add a special where condition which allows for that model's primary key
3691
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3692
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3693
-     *
3694
-     * @param array    $default_where_conditions
3695
-     * @param array    $provided_where_conditions
3696
-     * @param EEM_Base $model
3697
-     * @param string   $model_relation_path like 'Transaction.Payment.'
3698
-     * @return array like EEM_Base::get_all's $query_params[0]
3699
-     * @throws EE_Error
3700
-     */
3701
-    private function _override_defaults_or_make_null_friendly(
3702
-        $default_where_conditions,
3703
-        $provided_where_conditions,
3704
-        $model,
3705
-        $model_relation_path
3706
-    ) {
3707
-        $null_friendly_where_conditions = array();
3708
-        $none_overridden = true;
3709
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3710
-        foreach ($default_where_conditions as $key => $val) {
3711
-            if (isset($provided_where_conditions[$key])) {
3712
-                $none_overridden = false;
3713
-            } else {
3714
-                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3715
-            }
3716
-        }
3717
-        if ($none_overridden && $default_where_conditions) {
3718
-            if ($model->has_primary_key_field()) {
3719
-                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3720
-                                                                                . "."
3721
-                                                                                . $model->primary_key_name()] = array('IS NULL');
3722
-            }/*else{
35
+	//admin posty
36
+	//basic -> grants access to mine -> if they don't have it, select none
37
+	//*_others -> grants access to others that aren't private, and all mine -> if they don't have it, select mine
38
+	//*_private -> grants full access -> if dont have it, select all mine and others' non-private
39
+	//*_published -> grants access to published -> if they dont have it, select non-published
40
+	//*_global/default/system -> grants access to global items -> if they don't have it, select non-global
41
+	//publish_{thing} -> can change status TO publish; SPECIAL CASE
42
+	//frontend posty
43
+	//by default has access to published
44
+	//basic -> grants access to mine that aren't published, and all published
45
+	//*_others ->grants access to others that aren't private, all mine
46
+	//*_private -> grants full access
47
+	//frontend non-posty
48
+	//like admin posty
49
+	//category-y
50
+	//assign -> grants access to join-table
51
+	//(delete, edit)
52
+	//payment-method-y
53
+	//for each registered payment method,
54
+	//ee_payment_method_{pmttype} -> if they don't have it, select all where they aren't of that type
55
+	/**
56
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
57
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
58
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
59
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
60
+	 *
61
+	 * @var boolean
62
+	 */
63
+	private $_values_already_prepared_by_model_object = 0;
64
+
65
+	/**
66
+	 * when $_values_already_prepared_by_model_object equals this, we assume
67
+	 * the data is just like form input that needs to have the model fields'
68
+	 * prepare_for_set and prepare_for_use_in_db called on it
69
+	 */
70
+	const not_prepared_by_model_object = 0;
71
+
72
+	/**
73
+	 * when $_values_already_prepared_by_model_object equals this, we
74
+	 * assume this value is coming from a model object and doesn't need to have
75
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
76
+	 */
77
+	const prepared_by_model_object = 1;
78
+
79
+	/**
80
+	 * when $_values_already_prepared_by_model_object equals this, we assume
81
+	 * the values are already to be used in the database (ie no processing is done
82
+	 * on them by the model's fields)
83
+	 */
84
+	const prepared_for_use_in_db = 2;
85
+
86
+
87
+	protected $singular_item = 'Item';
88
+
89
+	protected $plural_item   = 'Items';
90
+
91
+	/**
92
+	 * @type \EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
93
+	 */
94
+	protected $_tables;
95
+
96
+	/**
97
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
98
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
99
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
100
+	 *
101
+	 * @var \EE_Model_Field_Base[] $_fields
102
+	 */
103
+	protected $_fields;
104
+
105
+	/**
106
+	 * array of different kinds of relations
107
+	 *
108
+	 * @var \EE_Model_Relation_Base[] $_model_relations
109
+	 */
110
+	protected $_model_relations;
111
+
112
+	/**
113
+	 * @var \EE_Index[] $_indexes
114
+	 */
115
+	protected $_indexes = array();
116
+
117
+	/**
118
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
119
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
120
+	 * by setting the same columns as used in these queries in the query yourself.
121
+	 *
122
+	 * @var EE_Default_Where_Conditions
123
+	 */
124
+	protected $_default_where_conditions_strategy;
125
+
126
+	/**
127
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
128
+	 * This is particularly useful when you want something between 'none' and 'default'
129
+	 *
130
+	 * @var EE_Default_Where_Conditions
131
+	 */
132
+	protected $_minimum_where_conditions_strategy;
133
+
134
+	/**
135
+	 * String describing how to find the "owner" of this model's objects.
136
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
137
+	 * But when there isn't, this indicates which related model, or transiently-related model,
138
+	 * has the foreign key to the wp_users table.
139
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
140
+	 * related to events, and events have a foreign key to wp_users.
141
+	 * On EEM_Transaction, this would be 'Transaction.Event'
142
+	 *
143
+	 * @var string
144
+	 */
145
+	protected $_model_chain_to_wp_user = '';
146
+
147
+	/**
148
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
149
+	 * don't need it (particularly CPT models)
150
+	 *
151
+	 * @var bool
152
+	 */
153
+	protected $_ignore_where_strategy = false;
154
+
155
+	/**
156
+	 * String used in caps relating to this model. Eg, if the caps relating to this
157
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
158
+	 *
159
+	 * @var string. If null it hasn't been initialized yet. If false then we
160
+	 * have indicated capabilities don't apply to this
161
+	 */
162
+	protected $_caps_slug = null;
163
+
164
+	/**
165
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
166
+	 * and next-level keys are capability names, and each's value is a
167
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
168
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
169
+	 * and then each capability in the corresponding sub-array that they're missing
170
+	 * adds the where conditions onto the query.
171
+	 *
172
+	 * @var array
173
+	 */
174
+	protected $_cap_restrictions = array(
175
+		self::caps_read       => array(),
176
+		self::caps_read_admin => array(),
177
+		self::caps_edit       => array(),
178
+		self::caps_delete     => array(),
179
+	);
180
+
181
+	/**
182
+	 * Array defining which cap restriction generators to use to create default
183
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
184
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
185
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
186
+	 * automatically set this to false (not just null).
187
+	 *
188
+	 * @var EE_Restriction_Generator_Base[]
189
+	 */
190
+	protected $_cap_restriction_generators = array();
191
+
192
+	/**
193
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
194
+	 */
195
+	const caps_read       = 'read';
196
+
197
+	const caps_read_admin = 'read_admin';
198
+
199
+	const caps_edit       = 'edit';
200
+
201
+	const caps_delete     = 'delete';
202
+
203
+	/**
204
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
205
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
206
+	 * maps to 'read' because when looking for relevant permissions we're going to use
207
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
208
+	 *
209
+	 * @var array
210
+	 */
211
+	protected $_cap_contexts_to_cap_action_map = array(
212
+		self::caps_read       => 'read',
213
+		self::caps_read_admin => 'read',
214
+		self::caps_edit       => 'edit',
215
+		self::caps_delete     => 'delete',
216
+	);
217
+
218
+	/**
219
+	 * Timezone
220
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
221
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
222
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
223
+	 * EE_Datetime_Field data type will have access to it.
224
+	 *
225
+	 * @var string
226
+	 */
227
+	protected $_timezone;
228
+
229
+
230
+	/**
231
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
232
+	 * multisite.
233
+	 *
234
+	 * @var int
235
+	 */
236
+	protected static $_model_query_blog_id;
237
+
238
+	/**
239
+	 * A copy of _fields, except the array keys are the model names pointed to by
240
+	 * the field
241
+	 *
242
+	 * @var EE_Model_Field_Base[]
243
+	 */
244
+	private $_cache_foreign_key_to_fields = array();
245
+
246
+	/**
247
+	 * Cached list of all the fields on the model, indexed by their name
248
+	 *
249
+	 * @var EE_Model_Field_Base[]
250
+	 */
251
+	private $_cached_fields = null;
252
+
253
+	/**
254
+	 * Cached list of all the fields on the model, except those that are
255
+	 * marked as only pertinent to the database
256
+	 *
257
+	 * @var EE_Model_Field_Base[]
258
+	 */
259
+	private $_cached_fields_non_db_only = null;
260
+
261
+	/**
262
+	 * A cached reference to the primary key for quick lookup
263
+	 *
264
+	 * @var EE_Model_Field_Base
265
+	 */
266
+	private $_primary_key_field = null;
267
+
268
+	/**
269
+	 * Flag indicating whether this model has a primary key or not
270
+	 *
271
+	 * @var boolean
272
+	 */
273
+	protected $_has_primary_key_field = null;
274
+
275
+	/**
276
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
277
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
278
+	 *
279
+	 * @var boolean
280
+	 */
281
+	protected $_wp_core_model = false;
282
+
283
+	/**
284
+	 *    List of valid operators that can be used for querying.
285
+	 * The keys are all operators we'll accept, the values are the real SQL
286
+	 * operators used
287
+	 *
288
+	 * @var array
289
+	 */
290
+	protected $_valid_operators = array(
291
+		'='           => '=',
292
+		'<='          => '<=',
293
+		'<'           => '<',
294
+		'>='          => '>=',
295
+		'>'           => '>',
296
+		'!='          => '!=',
297
+		'LIKE'        => 'LIKE',
298
+		'like'        => 'LIKE',
299
+		'NOT_LIKE'    => 'NOT LIKE',
300
+		'not_like'    => 'NOT LIKE',
301
+		'NOT LIKE'    => 'NOT LIKE',
302
+		'not like'    => 'NOT LIKE',
303
+		'IN'          => 'IN',
304
+		'in'          => 'IN',
305
+		'NOT_IN'      => 'NOT IN',
306
+		'not_in'      => 'NOT IN',
307
+		'NOT IN'      => 'NOT IN',
308
+		'not in'      => 'NOT IN',
309
+		'between'     => 'BETWEEN',
310
+		'BETWEEN'     => 'BETWEEN',
311
+		'IS_NOT_NULL' => 'IS NOT NULL',
312
+		'is_not_null' => 'IS NOT NULL',
313
+		'IS NOT NULL' => 'IS NOT NULL',
314
+		'is not null' => 'IS NOT NULL',
315
+		'IS_NULL'     => 'IS NULL',
316
+		'is_null'     => 'IS NULL',
317
+		'IS NULL'     => 'IS NULL',
318
+		'is null'     => 'IS NULL',
319
+		'REGEXP'      => 'REGEXP',
320
+		'regexp'      => 'REGEXP',
321
+		'NOT_REGEXP'  => 'NOT REGEXP',
322
+		'not_regexp'  => 'NOT REGEXP',
323
+		'NOT REGEXP'  => 'NOT REGEXP',
324
+		'not regexp'  => 'NOT REGEXP',
325
+	);
326
+
327
+	/**
328
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
329
+	 *
330
+	 * @var array
331
+	 */
332
+	protected $_in_style_operators = array('IN', 'NOT IN');
333
+
334
+	/**
335
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
336
+	 * '12-31-2012'"
337
+	 *
338
+	 * @var array
339
+	 */
340
+	protected $_between_style_operators = array('BETWEEN');
341
+
342
+	/**
343
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
344
+	 * on a join table.
345
+	 *
346
+	 * @var array
347
+	 */
348
+	protected $_null_style_operators = array('IS NOT NULL', 'IS NULL');
349
+
350
+	/**
351
+	 * Allowed values for $query_params['order'] for ordering in queries
352
+	 *
353
+	 * @var array
354
+	 */
355
+	protected $_allowed_order_values = array('asc', 'desc', 'ASC', 'DESC');
356
+
357
+	/**
358
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
359
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
360
+	 *
361
+	 * @var array
362
+	 */
363
+	private $_logic_query_param_keys = array('not', 'and', 'or', 'NOT', 'AND', 'OR');
364
+
365
+	/**
366
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
367
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
368
+	 *
369
+	 * @var array
370
+	 */
371
+	private $_allowed_query_params = array(
372
+		0,
373
+		'limit',
374
+		'order_by',
375
+		'group_by',
376
+		'having',
377
+		'force_join',
378
+		'order',
379
+		'on_join_limit',
380
+		'default_where_conditions',
381
+		'caps',
382
+	);
383
+
384
+	/**
385
+	 * All the data types that can be used in $wpdb->prepare statements.
386
+	 *
387
+	 * @var array
388
+	 */
389
+	private $_valid_wpdb_data_types = array('%d', '%s', '%f');
390
+
391
+	/**
392
+	 *    EE_Registry Object
393
+	 *
394
+	 * @var    object
395
+	 * @access    protected
396
+	 */
397
+	protected $EE = null;
398
+
399
+
400
+	/**
401
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
402
+	 *
403
+	 * @var int
404
+	 */
405
+	protected $_show_next_x_db_queries = 0;
406
+
407
+	/**
408
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
409
+	 * it gets saved on this property so those selections can be used in WHERE, GROUP_BY, etc.
410
+	 *
411
+	 * @var array
412
+	 */
413
+	protected $_custom_selections = array();
414
+
415
+	/**
416
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
417
+	 * caches every model object we've fetched from the DB on this request
418
+	 *
419
+	 * @var array
420
+	 */
421
+	protected $_entity_map;
422
+
423
+	/**
424
+	 * constant used to show EEM_Base has not yet verified the db on this http request
425
+	 */
426
+	const db_verified_none = 0;
427
+
428
+	/**
429
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
430
+	 * but not the addons' dbs
431
+	 */
432
+	const db_verified_core = 1;
433
+
434
+	/**
435
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
436
+	 * the EE core db too)
437
+	 */
438
+	const db_verified_addons = 2;
439
+
440
+	/**
441
+	 * indicates whether an EEM_Base child has already re-verified the DB
442
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
443
+	 * looking like EEM_Base::db_verified_*
444
+	 *
445
+	 * @var int - 0 = none, 1 = core, 2 = addons
446
+	 */
447
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
448
+
449
+	/**
450
+	 * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
451
+	 *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
452
+	 *        registrations for non-trashed tickets for non-trashed datetimes)
453
+	 */
454
+	const default_where_conditions_all = 'all';
455
+
456
+	/**
457
+	 * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
458
+	 *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
459
+	 *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
460
+	 *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
461
+	 *        models which share tables with other models, this can return data for the wrong model.
462
+	 */
463
+	const default_where_conditions_this_only = 'this_model_only';
464
+
465
+	/**
466
+	 * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
467
+	 *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
468
+	 *        return all registrations related to non-trashed tickets and non-trashed datetimes)
469
+	 */
470
+	const default_where_conditions_others_only = 'other_models_only';
471
+
472
+	/**
473
+	 * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
474
+	 *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
475
+	 *        their table with other models, like the Event and Venue models. For example, when querying for events
476
+	 *        ordered by their venues' name, this will be sure to only return real events with associated real venues
477
+	 *        (regardless of whether those events and venues are trashed)
478
+	 *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
479
+	 *        events.
480
+	 */
481
+	const default_where_conditions_minimum_all = 'minimum';
482
+
483
+	/**
484
+	 * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
485
+	 *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
486
+	 *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
487
+	 *        not)
488
+	 */
489
+	const default_where_conditions_minimum_others = 'full_this_minimum_others';
490
+
491
+	/**
492
+	 * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
493
+	 *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
494
+	 *        it's possible it will return table entries for other models. You should use
495
+	 *        EEM_Base::default_where_conditions_minimum_all instead.
496
+	 */
497
+	const default_where_conditions_none = 'none';
498
+
499
+
500
+
501
+	/**
502
+	 * About all child constructors:
503
+	 * they should define the _tables, _fields and _model_relations arrays.
504
+	 * Should ALWAYS be called after child constructor.
505
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
506
+	 * finalizes constructing all the object's attributes.
507
+	 * Generally, rather than requiring a child to code
508
+	 * $this->_tables = array(
509
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
510
+	 *        ...);
511
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
512
+	 * each EE_Table has a function to set the table's alias after the constructor, using
513
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
514
+	 * do something similar.
515
+	 *
516
+	 * @param null $timezone
517
+	 * @throws EE_Error
518
+	 */
519
+	protected function __construct($timezone = null)
520
+	{
521
+		// check that the model has not been loaded too soon
522
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
523
+			throw new EE_Error (
524
+				sprintf(
525
+					__('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.',
526
+						'event_espresso'),
527
+					get_class($this)
528
+				)
529
+			);
530
+		}
531
+		/**
532
+		 * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
533
+		 */
534
+		if (empty(EEM_Base::$_model_query_blog_id)) {
535
+			EEM_Base::set_model_query_blog_id();
536
+		}
537
+		/**
538
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
539
+		 * just use EE_Register_Model_Extension
540
+		 *
541
+		 * @var EE_Table_Base[] $_tables
542
+		 */
543
+		$this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
544
+		foreach ($this->_tables as $table_alias => $table_obj) {
545
+			/** @var $table_obj EE_Table_Base */
546
+			$table_obj->_construct_finalize_with_alias($table_alias);
547
+			if ($table_obj instanceof EE_Secondary_Table) {
548
+				/** @var $table_obj EE_Secondary_Table */
549
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
550
+			}
551
+		}
552
+		/**
553
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
554
+		 * EE_Register_Model_Extension
555
+		 *
556
+		 * @param EE_Model_Field_Base[] $_fields
557
+		 */
558
+		$this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
559
+		$this->_invalidate_field_caches();
560
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
561
+			if (! array_key_exists($table_alias, $this->_tables)) {
562
+				throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
563
+					'event_espresso'), $table_alias, implode(",", $this->_fields)));
564
+			}
565
+			foreach ($fields_for_table as $field_name => $field_obj) {
566
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
567
+				//primary key field base has a slightly different _construct_finalize
568
+				/** @var $field_obj EE_Model_Field_Base */
569
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
570
+			}
571
+		}
572
+		// everything is related to Extra_Meta
573
+		if (get_class($this) !== 'EEM_Extra_Meta') {
574
+			//make extra meta related to everything, but don't block deleting things just
575
+			//because they have related extra meta info. For now just orphan those extra meta
576
+			//in the future we should automatically delete them
577
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
578
+		}
579
+		//and change logs
580
+		if (get_class($this) !== 'EEM_Change_Log') {
581
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
582
+		}
583
+		/**
584
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
585
+		 * EE_Register_Model_Extension
586
+		 *
587
+		 * @param EE_Model_Relation_Base[] $_model_relations
588
+		 */
589
+		$this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
590
+			$this->_model_relations);
591
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
592
+			/** @var $relation_obj EE_Model_Relation_Base */
593
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
594
+		}
595
+		foreach ($this->_indexes as $index_name => $index_obj) {
596
+			/** @var $index_obj EE_Index */
597
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
598
+		}
599
+		$this->set_timezone($timezone);
600
+		//finalize default where condition strategy, or set default
601
+		if (! $this->_default_where_conditions_strategy) {
602
+			//nothing was set during child constructor, so set default
603
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
604
+		}
605
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
606
+		if (! $this->_minimum_where_conditions_strategy) {
607
+			//nothing was set during child constructor, so set default
608
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
609
+		}
610
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
611
+		//if the cap slug hasn't been set, and we haven't set it to false on purpose
612
+		//to indicate to NOT set it, set it to the logical default
613
+		if ($this->_caps_slug === null) {
614
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
615
+		}
616
+		//initialize the standard cap restriction generators if none were specified by the child constructor
617
+		if ($this->_cap_restriction_generators !== false) {
618
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
619
+				if (! isset($this->_cap_restriction_generators[$cap_context])) {
620
+					$this->_cap_restriction_generators[$cap_context] = apply_filters(
621
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
622
+						new EE_Restriction_Generator_Protected(),
623
+						$cap_context,
624
+						$this
625
+					);
626
+				}
627
+			}
628
+		}
629
+		//if there are cap restriction generators, use them to make the default cap restrictions
630
+		if ($this->_cap_restriction_generators !== false) {
631
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
632
+				if (! $generator_object) {
633
+					continue;
634
+				}
635
+				if (! $generator_object instanceof EE_Restriction_Generator_Base) {
636
+					throw new EE_Error(
637
+						sprintf(
638
+							__('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.',
639
+								'event_espresso'),
640
+							$context,
641
+							$this->get_this_model_name()
642
+						)
643
+					);
644
+				}
645
+				$action = $this->cap_action_for_context($context);
646
+				if (! $generator_object->construction_finalized()) {
647
+					$generator_object->_construct_finalize($this, $action);
648
+				}
649
+			}
650
+		}
651
+		do_action('AHEE__' . get_class($this) . '__construct__end');
652
+	}
653
+
654
+
655
+
656
+	/**
657
+	 * Generates the cap restrictions for the given context, or if they were
658
+	 * already generated just gets what's cached
659
+	 *
660
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
661
+	 * @return EE_Default_Where_Conditions[]
662
+	 */
663
+	protected function _generate_cap_restrictions($context)
664
+	{
665
+		if (isset($this->_cap_restriction_generators[$context])
666
+			&& $this->_cap_restriction_generators[$context]
667
+			   instanceof
668
+			   EE_Restriction_Generator_Base
669
+		) {
670
+			return $this->_cap_restriction_generators[$context]->generate_restrictions();
671
+		} else {
672
+			return array();
673
+		}
674
+	}
675
+
676
+
677
+
678
+	/**
679
+	 * Used to set the $_model_query_blog_id static property.
680
+	 *
681
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
682
+	 *                      value for get_current_blog_id() will be used.
683
+	 */
684
+	public static function set_model_query_blog_id($blog_id = 0)
685
+	{
686
+		EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
687
+	}
688
+
689
+
690
+
691
+	/**
692
+	 * Returns whatever is set as the internal $model_query_blog_id.
693
+	 *
694
+	 * @return int
695
+	 */
696
+	public static function get_model_query_blog_id()
697
+	{
698
+		return EEM_Base::$_model_query_blog_id;
699
+	}
700
+
701
+
702
+
703
+	/**
704
+	 * This function is a singleton method used to instantiate the Espresso_model object
705
+	 *
706
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
707
+	 *                                (and any incoming timezone data that gets saved).
708
+	 *                                Note this just sends the timezone info to the date time model field objects.
709
+	 *                                Default is NULL
710
+	 *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
711
+	 * @return static (as in the concrete child class)
712
+	 * @throws InvalidArgumentException
713
+	 * @throws InvalidInterfaceException
714
+	 * @throws InvalidDataTypeException
715
+	 * @throws EE_Error
716
+	 */
717
+	public static function instance($timezone = null)
718
+	{
719
+		// check if instance of Espresso_model already exists
720
+		if (! static::$_instance instanceof static) {
721
+			// instantiate Espresso_model
722
+			static::$_instance = new static(
723
+				$timezone,
724
+				LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
725
+			);
726
+		}
727
+		//we might have a timezone set, let set_timezone decide what to do with it
728
+		static::$_instance->set_timezone($timezone);
729
+		// Espresso_model object
730
+		return static::$_instance;
731
+	}
732
+
733
+
734
+
735
+	/**
736
+	 * resets the model and returns it
737
+	 *
738
+	 * @param null | string $timezone
739
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
740
+	 * @throws ReflectionException
741
+	 * all its properties reset; if it wasn't instantiated, returns null)
742
+	 * @throws EE_Error
743
+	 * @throws InvalidArgumentException
744
+	 * @throws InvalidDataTypeException
745
+	 * @throws InvalidInterfaceException
746
+	 */
747
+	public static function reset($timezone = null)
748
+	{
749
+		if (static::$_instance instanceof EEM_Base) {
750
+			//let's try to NOT swap out the current instance for a new one
751
+			//because if someone has a reference to it, we can't remove their reference
752
+			//so it's best to keep using the same reference, but change the original object
753
+			//reset all its properties to their original values as defined in the class
754
+			$r = new ReflectionClass(get_class(static::$_instance));
755
+			$static_properties = $r->getStaticProperties();
756
+			foreach ($r->getDefaultProperties() as $property => $value) {
757
+				//don't set instance to null like it was originally,
758
+				//but it's static anyways, and we're ignoring static properties (for now at least)
759
+				if (! isset($static_properties[$property])) {
760
+					static::$_instance->{$property} = $value;
761
+				}
762
+			}
763
+			//and then directly call its constructor again, like we would if we were creating a new one
764
+			static::$_instance->__construct(
765
+				$timezone,
766
+				LoaderFactory::getLoader()->load('EventEspresso\core\services\orm\ModelFieldFactory')
767
+			);
768
+			return self::instance();
769
+		}
770
+		return null;
771
+	}
772
+
773
+
774
+
775
+	/**
776
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
777
+	 *
778
+	 * @param  boolean $translated return localized strings or JUST the array.
779
+	 * @return array
780
+	 * @throws EE_Error
781
+	 */
782
+	public function status_array($translated = false)
783
+	{
784
+		if (! array_key_exists('Status', $this->_model_relations)) {
785
+			return array();
786
+		}
787
+		$model_name = $this->get_this_model_name();
788
+		$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
789
+		$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
790
+		$status_array = array();
791
+		foreach ($stati as $status) {
792
+			$status_array[$status->ID()] = $status->get('STS_code');
793
+		}
794
+		return $translated
795
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
796
+			: $status_array;
797
+	}
798
+
799
+
800
+
801
+	/**
802
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
803
+	 *
804
+	 * @param array $query_params             {
805
+	 * @var array $0 (where) array {
806
+	 *                                        eg: array('QST_display_text'=>'Are you bob?','QST_admin_text'=>'Determine
807
+	 *                                        if user is bob') becomes SQL >> "...WHERE QST_display_text = 'Are you
808
+	 *                                        bob?' AND QST_admin_text = 'Determine if user is bob'...") To add WHERE
809
+	 *                                        conditions based on related models (and even
810
+	 *                                        models-related-to-related-models) prepend the model's name onto the field
811
+	 *                                        name. Eg,
812
+	 *                                        EEM_Event::instance()->get_all(array(array('Venue.VNU_ID'=>12))); becomes
813
+	 *                                        SQL >> "SELECT * FROM wp_posts AS Event_CPT LEFT JOIN wp_esp_event_meta
814
+	 *                                        AS Event_Meta ON Event_CPT.ID = Event_Meta.EVT_ID LEFT JOIN
815
+	 *                                        wp_esp_event_venue AS Event_Venue ON Event_Venue.EVT_ID=Event_CPT.ID LEFT
816
+	 *                                        JOIN wp_posts AS Venue_CPT ON Venue_CPT.ID=Event_Venue.VNU_ID LEFT JOIN
817
+	 *                                        wp_esp_venue_meta AS Venue_Meta ON Venue_CPT.ID = Venue_Meta.VNU_ID WHERE
818
+	 *                                        Venue_CPT.ID = 12 Notice that automatically took care of joining Events
819
+	 *                                        to Venues (even when each of those models actually consisted of two
820
+	 *                                        tables). Also, you may chain the model relations together. Eg instead of
821
+	 *                                        just having
822
+	 *                                        "Venue.VNU_ID", you could have
823
+	 *                                        "Registration.Attendee.ATT_ID" as a field on a query for events (because
824
+	 *                                        events are related to Registrations, which are related to Attendees). You
825
+	 *                                        can take it even further with
826
+	 *                                        "Registration.Transaction.Payment.PAY_amount" etc. To change the operator
827
+	 *                                        (from the default of '='), change the value to an numerically-indexed
828
+	 *                                        array, where the first item in the list is the operator. eg: array(
829
+	 *                                        'QST_display_text' => array('LIKE','%bob%'), 'QST_ID' => array('<',34),
830
+	 *                                        'QST_wp_user' => array('in',array(1,2,7,23))) becomes SQL >> "...WHERE
831
+	 *                                        QST_display_text LIKE '%bob%' AND QST_ID < 34 AND QST_wp_user IN
832
+	 *                                        (1,2,7,23)...". Valid operators so far: =, !=, <, <=, >, >=, LIKE, NOT
833
+	 *                                        LIKE, IN (followed by numeric-indexed array), NOT IN (dido), BETWEEN
834
+	 *                                        (followed by an array with exactly 2 date strings), IS NULL, and IS NOT
835
+	 *                                        NULL Values can be a string, int, or float. They can also be arrays IFF
836
+	 *                                        the operator is IN. Also, values can actually be field names. To indicate
837
+	 *                                        the value is a field, simply provide a third array item (true) to the
838
+	 *                                        operator-value array like so: eg: array( 'DTT_reg_limit' => array('>',
839
+	 *                                        'DTT_sold', TRUE) ) becomes SQL >> "...WHERE DTT_reg_limit > DTT_sold"
840
+	 *                                        Note: you can also use related model field names like you would any other
841
+	 *                                        field name. eg:
842
+	 *                                        array('Datetime.DTT_reg_limit'=>array('=','Datetime.DTT_sold',TRUE) could
843
+	 *                                        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__>' =>
844
+	 *                                        345678912)) becomes SQL >> "...WHERE TXN_ID = 23 OR TXN_timestamp =
845
+	 *                                        345678912...". Also, to negate an entire set of conditions, use 'NOT' as
846
+	 *                                        an array key. eg: array('NOT'=>array('TXN_total' =>
847
+	 *                                        50, 'TXN_paid'=>23) becomes SQL >> "...where ! (TXN_total =50 AND
848
+	 *                                        TXN_paid =23) Note: the 'glue' used to join each condition will continue
849
+	 *                                        to be what you last specified. IE, "AND"s by default, but if you had
850
+	 *                                        previously specified to use ORs to join, ORs will continue to be used.
851
+	 *                                        So, if you specify to use an "OR" to join conditions, it will continue to
852
+	 *                                        "stick" until you specify an AND. eg
853
+	 *                                        array('OR'=>array('NOT'=>array('TXN_total' => 50,
854
+	 *                                        'TXN_paid'=>23)),AND=>array('TXN_ID'=>1,'STS_ID'=>'TIN') becomes SQL >>
855
+	 *                                        "...where ! (TXN_total =50 OR TXN_paid =23) AND TXN_ID=1 AND
856
+	 *                                        STS_ID='TIN'" They can be nested indefinitely. eg:
857
+	 *                                        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 >>
858
+	 *                                        "PAY_timestamp > 123412341 AND PAY_timestamp < 2354235235234 AND
859
+	 *                                        PAY_timestamp != 1241234123" This can be applied to condition operators
860
+	 *                                        too, eg:
861
+	 *                                        array('OR'=>array('REG_ID'=>3,'Transaction.TXN_ID'=>23),'OR*whatever'=>array('Attendee.ATT_fname'=>'bob','Attendee.ATT_lname'=>'wilson')));
862
+	 * @var mixed   $limit                    int|array    adds a limit to the query just like the SQL limit clause, so
863
+	 *                                        limits of "23", "25,50", and array(23,42) are all valid would become SQL
864
+	 *                                        "...LIMIT 23", "...LIMIT 25,50", and "...LIMIT 23,42" respectively.
865
+	 *                                        Remember when you provide two numbers for the limit, the 1st number is
866
+	 *                                        the OFFSET, the 2nd is the LIMIT
867
+	 * @var array   $on_join_limit            allows the setting of a special select join with a internal limit so you
868
+	 *                                        can do paging on one-to-many multi-table-joins. Send an array in the
869
+	 *                                        following format array('on_join_limit'
870
+	 *                                        => array( 'table_alias', array(1,2) ) ).
871
+	 * @var mixed   $order_by                 name of a column to order by, or an array where keys are field names and
872
+	 *                                        values are either 'ASC' or 'DESC'.
873
+	 *                                        'limit'=>array('STS_ID'=>'ASC','REG_date'=>'DESC'), which would becomes
874
+	 *                                        SQL "...ORDER BY TXN_timestamp..." and "...ORDER BY STS_ID ASC, REG_date
875
+	 *                                        DESC..." respectively. Like the
876
+	 *                                        'where' conditions, these fields can be on related models. Eg
877
+	 *                                        'order_by'=>array('Registration.Transaction.TXN_amount'=>'ASC') is
878
+	 *                                        perfectly valid from any model related to 'Registration' (like Event,
879
+	 *                                        Attendee, Price, Datetime, etc.)
880
+	 * @var string  $order                    If 'order_by' is used and its value is a string (NOT an array), then
881
+	 *                                        'order' specifies whether to order the field specified in 'order_by' in
882
+	 *                                        ascending or descending order. Acceptable values are 'ASC' or 'DESC'. If,
883
+	 *                                        'order_by' isn't used, but 'order' is, then it is assumed you want to
884
+	 *                                        order by the primary key. Eg,
885
+	 *                                        EEM_Event::instance()->get_all(array('order_by'=>'Datetime.DTT_EVT_start','order'=>'ASC');
886
+	 *                                        //(will join with the Datetime model's table(s) and order by its field
887
+	 *                                        DTT_EVT_start) or
888
+	 *                                        EEM_Registration::instance()->get_all(array('order'=>'ASC'));//will make
889
+	 *                                        SQL "SELECT * FROM wp_esp_registration ORDER BY REG_ID ASC"
890
+	 * @var mixed   $group_by                 name of field to order by, or an array of fields. Eg either
891
+	 *                                        'group_by'=>'VNU_ID', or
892
+	 *                                        'group_by'=>array('EVT_name','Registration.Transaction.TXN_total') Note:
893
+	 *                                        if no
894
+	 *                                        $group_by is specified, and a limit is set, automatically groups by the
895
+	 *                                        model's primary key (or combined primary keys). This avoids some
896
+	 *                                        weirdness that results when using limits, tons of joins, and no group by,
897
+	 *                                        see https://events.codebasehq.com/projects/event-espresso/tickets/9389
898
+	 * @var array   $having                   exactly like WHERE parameters array, except these conditions apply to the
899
+	 *                                        grouped results (whereas WHERE conditions apply to the pre-grouped
900
+	 *                                        results)
901
+	 * @var array   $force_join               forces a join with the models named. Should be a numerically-indexed
902
+	 *                                        array where values are models to be joined in the query.Eg
903
+	 *                                        array('Attendee','Payment','Datetime'). You may join with transient
904
+	 *                                        models using period, eg "Registration.Transaction.Payment". You will
905
+	 *                                        probably only want to do this in hopes of increasing efficiency, as
906
+	 *                                        related models which belongs to the current model
907
+	 *                                        (ie, the current model has a foreign key to them, like how Registration
908
+	 *                                        belongs to Attendee) can be cached in order to avoid future queries
909
+	 * @var string  $default_where_conditions can be set to 'none', 'this_model_only', 'other_models_only', or 'all'.
910
+	 *                                        set this to 'none' to disable all default where conditions. Eg, usually
911
+	 *                                        soft-deleted objects are filtered-out if you want to include them, set
912
+	 *                                        this query param to 'none'. If you want to ONLY disable THIS model's
913
+	 *                                        default where conditions set it to 'other_models_only'. If you only want
914
+	 *                                        this model's default where conditions added to the query, use
915
+	 *                                        'this_model_only'. If you want to use all default where conditions
916
+	 *                                        (default), set to 'all'.
917
+	 * @var string  $caps                     controls what capability requirements to apply to the query; ie, should
918
+	 *                                        we just NOT apply any capabilities/permissions/restrictions and return
919
+	 *                                        everything? Or should we only show the current user items they should be
920
+	 *                                        able to view on the frontend, backend, edit, or delete? can be set to
921
+	 *                                        'none' (default), 'read_frontend', 'read_backend', 'edit' or 'delete'
922
+	 *                                        }
923
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
924
+	 *                                        from EE_Base_Class[], use _get_all_wpdb_results()and make it public
925
+	 *                                        again. Array keys are object IDs (if there is a primary key on the model.
926
+	 *                                        if not, numerically indexed) Some full examples: get 10 transactions
927
+	 *                                        which have Scottish attendees: EEM_Transaction::instance()->get_all(
928
+	 *                                        array( array(
929
+	 *                                        'OR'=>array(
930
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
931
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
932
+	 *                                        )
933
+	 *                                        ),
934
+	 *                                        'limit'=>10,
935
+	 *                                        'group_by'=>'TXN_ID'
936
+	 *                                        ));
937
+	 *                                        get all the answers to the question titled "shirt size" for event with id
938
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
939
+	 *                                        'Question.QST_display_text'=>'shirt size',
940
+	 *                                        'Registration.Event.EVT_ID'=>12
941
+	 *                                        ),
942
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
943
+	 *                                        ));
944
+	 * @throws EE_Error
945
+	 */
946
+	public function get_all($query_params = array())
947
+	{
948
+		if (isset($query_params['limit'])
949
+			&& ! isset($query_params['group_by'])
950
+		) {
951
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
952
+		}
953
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params, ARRAY_A, null));
954
+	}
955
+
956
+
957
+
958
+	/**
959
+	 * Modifies the query parameters so we only get back model objects
960
+	 * that "belong" to the current user
961
+	 *
962
+	 * @param array $query_params @see EEM_Base::get_all()
963
+	 * @return array like EEM_Base::get_all
964
+	 */
965
+	public function alter_query_params_to_only_include_mine($query_params = array())
966
+	{
967
+		$wp_user_field_name = $this->wp_user_field_name();
968
+		if ($wp_user_field_name) {
969
+			$query_params[0][$wp_user_field_name] = get_current_user_id();
970
+		}
971
+		return $query_params;
972
+	}
973
+
974
+
975
+
976
+	/**
977
+	 * Returns the name of the field's name that points to the WP_User table
978
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
979
+	 * foreign key to the WP_User table)
980
+	 *
981
+	 * @return string|boolean string on success, boolean false when there is no
982
+	 * foreign key to the WP_User table
983
+	 */
984
+	public function wp_user_field_name()
985
+	{
986
+		try {
987
+			if (! empty($this->_model_chain_to_wp_user)) {
988
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
989
+				$last_model_name = end($models_to_follow_to_wp_users);
990
+				$model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
991
+				$model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
992
+			} else {
993
+				$model_with_fk_to_wp_users = $this;
994
+				$model_chain_to_wp_user = '';
995
+			}
996
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
997
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
998
+		} catch (EE_Error $e) {
999
+			return false;
1000
+		}
1001
+	}
1002
+
1003
+
1004
+
1005
+	/**
1006
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
1007
+	 * (or transiently-related model) has a foreign key to the wp_users table;
1008
+	 * useful for finding if model objects of this type are 'owned' by the current user.
1009
+	 * This is an empty string when the foreign key is on this model and when it isn't,
1010
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
1011
+	 * (or transiently-related model)
1012
+	 *
1013
+	 * @return string
1014
+	 */
1015
+	public function model_chain_to_wp_user()
1016
+	{
1017
+		return $this->_model_chain_to_wp_user;
1018
+	}
1019
+
1020
+
1021
+
1022
+	/**
1023
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
1024
+	 * like how registrations don't have a foreign key to wp_users, but the
1025
+	 * events they are for are), or is unrelated to wp users.
1026
+	 * generally available
1027
+	 *
1028
+	 * @return boolean
1029
+	 */
1030
+	public function is_owned()
1031
+	{
1032
+		if ($this->model_chain_to_wp_user()) {
1033
+			return true;
1034
+		}
1035
+		try {
1036
+			$this->get_foreign_key_to('WP_User');
1037
+			return true;
1038
+		} catch (EE_Error $e) {
1039
+			return false;
1040
+		}
1041
+	}
1042
+
1043
+
1044
+
1045
+	/**
1046
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
1047
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
1048
+	 * the model)
1049
+	 *
1050
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1051
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1052
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1053
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1054
+	 *                                  override this and set the select to "*", or a specific column name, like
1055
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1056
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1057
+	 *                                  the aliases used to refer to this selection, and values are to be
1058
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1059
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1060
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1061
+	 * @throws EE_Error
1062
+	 */
1063
+	protected function _get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1064
+	{
1065
+		// remember the custom selections, if any, and type cast as array
1066
+		// (unless $columns_to_select is an object, then just set as an empty array)
1067
+		// Note: (array) 'some string' === array( 'some string' )
1068
+		$this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1069
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1070
+		$select_expressions = $columns_to_select !== null
1071
+			? $this->_construct_select_from_input($columns_to_select)
1072
+			: $this->_construct_default_select_sql($model_query_info);
1073
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1074
+		return $this->_do_wpdb_query('get_results', array($SQL, $output));
1075
+	}
1076
+
1077
+
1078
+
1079
+	/**
1080
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
1081
+	 * but you can use the $query_params like on EEM_Base::get_all() to more easily
1082
+	 * take care of joins, field preparation etc.
1083
+	 *
1084
+	 * @param array  $query_params      like EEM_Base::get_all's $query_params
1085
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
1086
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
1087
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
1088
+	 *                                  override this and set the select to "*", or a specific column name, like
1089
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
1090
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
1091
+	 *                                  the aliases used to refer to this selection, and values are to be
1092
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
1093
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
1094
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
1095
+	 * @throws EE_Error
1096
+	 */
1097
+	public function get_all_wpdb_results($query_params = array(), $output = ARRAY_A, $columns_to_select = null)
1098
+	{
1099
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
1100
+	}
1101
+
1102
+
1103
+
1104
+	/**
1105
+	 * For creating a custom select statement
1106
+	 *
1107
+	 * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
1108
+	 *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
1109
+	 *                                 SQL, and 1=>is the datatype
1110
+	 * @throws EE_Error
1111
+	 * @return string
1112
+	 */
1113
+	private function _construct_select_from_input($columns_to_select)
1114
+	{
1115
+		if (is_array($columns_to_select)) {
1116
+			$select_sql_array = array();
1117
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
1118
+				if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1119
+					throw new EE_Error(
1120
+						sprintf(
1121
+							__(
1122
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
1123
+								"event_espresso"
1124
+							),
1125
+							$selection_and_datatype,
1126
+							$alias
1127
+						)
1128
+					);
1129
+				}
1130
+				if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1131
+					throw new EE_Error(
1132
+						sprintf(
1133
+							__(
1134
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
1135
+								"event_espresso"
1136
+							),
1137
+							$selection_and_datatype[1],
1138
+							$selection_and_datatype[0],
1139
+							$alias,
1140
+							implode(",", $this->_valid_wpdb_data_types)
1141
+						)
1142
+					);
1143
+				}
1144
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
1145
+			}
1146
+			$columns_to_select_string = implode(", ", $select_sql_array);
1147
+		} else {
1148
+			$columns_to_select_string = $columns_to_select;
1149
+		}
1150
+		return $columns_to_select_string;
1151
+	}
1152
+
1153
+
1154
+
1155
+	/**
1156
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
1157
+	 *
1158
+	 * @return string
1159
+	 * @throws EE_Error
1160
+	 */
1161
+	public function primary_key_name()
1162
+	{
1163
+		return $this->get_primary_key_field()->get_name();
1164
+	}
1165
+
1166
+
1167
+
1168
+	/**
1169
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
1170
+	 * If there is no primary key on this model, $id is treated as primary key string
1171
+	 *
1172
+	 * @param mixed $id int or string, depending on the type of the model's primary key
1173
+	 * @return EE_Base_Class
1174
+	 */
1175
+	public function get_one_by_ID($id)
1176
+	{
1177
+		if ($this->get_from_entity_map($id)) {
1178
+			return $this->get_from_entity_map($id);
1179
+		}
1180
+		return $this->get_one(
1181
+			$this->alter_query_params_to_restrict_by_ID(
1182
+				$id,
1183
+				array('default_where_conditions' => EEM_Base::default_where_conditions_minimum_all)
1184
+			)
1185
+		);
1186
+	}
1187
+
1188
+
1189
+
1190
+	/**
1191
+	 * Alters query parameters to only get items with this ID are returned.
1192
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
1193
+	 * or could just be a simple primary key ID
1194
+	 *
1195
+	 * @param int   $id
1196
+	 * @param array $query_params
1197
+	 * @return array of normal query params, @see EEM_Base::get_all
1198
+	 * @throws EE_Error
1199
+	 */
1200
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1201
+	{
1202
+		if (! isset($query_params[0])) {
1203
+			$query_params[0] = array();
1204
+		}
1205
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
1206
+		if ($conditions_from_id === null) {
1207
+			$query_params[0][$this->primary_key_name()] = $id;
1208
+		} else {
1209
+			//no primary key, so the $id must be from the get_index_primary_key_string()
1210
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
1211
+		}
1212
+		return $query_params;
1213
+	}
1214
+
1215
+
1216
+
1217
+	/**
1218
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
1219
+	 * array. If no item is found, null is returned.
1220
+	 *
1221
+	 * @param array $query_params like EEM_Base's $query_params variable.
1222
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
1223
+	 * @throws EE_Error
1224
+	 */
1225
+	public function get_one($query_params = array())
1226
+	{
1227
+		if (! is_array($query_params)) {
1228
+			EE_Error::doing_it_wrong('EEM_Base::get_one',
1229
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1230
+					gettype($query_params)), '4.6.0');
1231
+			$query_params = array();
1232
+		}
1233
+		$query_params['limit'] = 1;
1234
+		$items = $this->get_all($query_params);
1235
+		if (empty($items)) {
1236
+			return null;
1237
+		}
1238
+		return array_shift($items);
1239
+	}
1240
+
1241
+
1242
+
1243
+	/**
1244
+	 * Returns the next x number of items in sequence from the given value as
1245
+	 * found in the database matching the given query conditions.
1246
+	 *
1247
+	 * @param mixed $current_field_value    Value used for the reference point.
1248
+	 * @param null  $field_to_order_by      What field is used for the
1249
+	 *                                      reference point.
1250
+	 * @param int   $limit                  How many to return.
1251
+	 * @param array $query_params           Extra conditions on the query.
1252
+	 * @param null  $columns_to_select      If left null, then an array of
1253
+	 *                                      EE_Base_Class objects is returned,
1254
+	 *                                      otherwise you can indicate just the
1255
+	 *                                      columns you want returned.
1256
+	 * @return EE_Base_Class[]|array
1257
+	 * @throws EE_Error
1258
+	 */
1259
+	public function next_x(
1260
+		$current_field_value,
1261
+		$field_to_order_by = null,
1262
+		$limit = 1,
1263
+		$query_params = array(),
1264
+		$columns_to_select = null
1265
+	) {
1266
+		return $this->_get_consecutive(
1267
+			$current_field_value,
1268
+			'>',
1269
+			$field_to_order_by,
1270
+			$limit,
1271
+			$query_params,
1272
+			$columns_to_select
1273
+		);
1274
+	}
1275
+
1276
+
1277
+
1278
+	/**
1279
+	 * Returns the previous x number of items in sequence from the given value
1280
+	 * as found in the database matching the given query conditions.
1281
+	 *
1282
+	 * @param mixed $current_field_value    Value used for the reference point.
1283
+	 * @param null  $field_to_order_by      What field is used for the
1284
+	 *                                      reference point.
1285
+	 * @param int   $limit                  How many to return.
1286
+	 * @param array $query_params           Extra conditions on the query.
1287
+	 * @param null  $columns_to_select      If left null, then an array of
1288
+	 *                                      EE_Base_Class objects is returned,
1289
+	 *                                      otherwise you can indicate just the
1290
+	 *                                      columns you want returned.
1291
+	 * @return EE_Base_Class[]|array
1292
+	 * @throws EE_Error
1293
+	 */
1294
+	public function previous_x(
1295
+		$current_field_value,
1296
+		$field_to_order_by = null,
1297
+		$limit = 1,
1298
+		$query_params = array(),
1299
+		$columns_to_select = null
1300
+	) {
1301
+		return $this->_get_consecutive(
1302
+			$current_field_value,
1303
+			'<',
1304
+			$field_to_order_by,
1305
+			$limit,
1306
+			$query_params,
1307
+			$columns_to_select
1308
+		);
1309
+	}
1310
+
1311
+
1312
+
1313
+	/**
1314
+	 * Returns the next item in sequence from the given value as found in the
1315
+	 * database matching the given query conditions.
1316
+	 *
1317
+	 * @param mixed $current_field_value    Value used for the reference point.
1318
+	 * @param null  $field_to_order_by      What field is used for the
1319
+	 *                                      reference point.
1320
+	 * @param array $query_params           Extra conditions on the query.
1321
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1322
+	 *                                      object is returned, otherwise you
1323
+	 *                                      can indicate just the columns you
1324
+	 *                                      want and a single array indexed by
1325
+	 *                                      the columns will be returned.
1326
+	 * @return EE_Base_Class|null|array()
1327
+	 * @throws EE_Error
1328
+	 */
1329
+	public function next(
1330
+		$current_field_value,
1331
+		$field_to_order_by = null,
1332
+		$query_params = array(),
1333
+		$columns_to_select = null
1334
+	) {
1335
+		$results = $this->_get_consecutive(
1336
+			$current_field_value,
1337
+			'>',
1338
+			$field_to_order_by,
1339
+			1,
1340
+			$query_params,
1341
+			$columns_to_select
1342
+		);
1343
+		return empty($results) ? null : reset($results);
1344
+	}
1345
+
1346
+
1347
+
1348
+	/**
1349
+	 * Returns the previous item in sequence from the given value as found in
1350
+	 * the database matching the given query conditions.
1351
+	 *
1352
+	 * @param mixed $current_field_value    Value used for the reference point.
1353
+	 * @param null  $field_to_order_by      What field is used for the
1354
+	 *                                      reference point.
1355
+	 * @param array $query_params           Extra conditions on the query.
1356
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
1357
+	 *                                      object is returned, otherwise you
1358
+	 *                                      can indicate just the columns you
1359
+	 *                                      want and a single array indexed by
1360
+	 *                                      the columns will be returned.
1361
+	 * @return EE_Base_Class|null|array()
1362
+	 * @throws EE_Error
1363
+	 */
1364
+	public function previous(
1365
+		$current_field_value,
1366
+		$field_to_order_by = null,
1367
+		$query_params = array(),
1368
+		$columns_to_select = null
1369
+	) {
1370
+		$results = $this->_get_consecutive(
1371
+			$current_field_value,
1372
+			'<',
1373
+			$field_to_order_by,
1374
+			1,
1375
+			$query_params,
1376
+			$columns_to_select
1377
+		);
1378
+		return empty($results) ? null : reset($results);
1379
+	}
1380
+
1381
+
1382
+
1383
+	/**
1384
+	 * Returns the a consecutive number of items in sequence from the given
1385
+	 * value as found in the database matching the given query conditions.
1386
+	 *
1387
+	 * @param mixed  $current_field_value   Value used for the reference point.
1388
+	 * @param string $operand               What operand is used for the sequence.
1389
+	 * @param string $field_to_order_by     What field is used for the reference point.
1390
+	 * @param int    $limit                 How many to return.
1391
+	 * @param array  $query_params          Extra conditions on the query.
1392
+	 * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
1393
+	 *                                      otherwise you can indicate just the columns you want returned.
1394
+	 * @return EE_Base_Class[]|array
1395
+	 * @throws EE_Error
1396
+	 */
1397
+	protected function _get_consecutive(
1398
+		$current_field_value,
1399
+		$operand = '>',
1400
+		$field_to_order_by = null,
1401
+		$limit = 1,
1402
+		$query_params = array(),
1403
+		$columns_to_select = null
1404
+	) {
1405
+		//if $field_to_order_by is empty then let's assume we're ordering by the primary key.
1406
+		if (empty($field_to_order_by)) {
1407
+			if ($this->has_primary_key_field()) {
1408
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
1409
+			} else {
1410
+				if (WP_DEBUG) {
1411
+					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).',
1412
+						'event_espresso'));
1413
+				}
1414
+				EE_Error::add_error(__('There was an error with the query.', 'event_espresso'));
1415
+				return array();
1416
+			}
1417
+		}
1418
+		if (! is_array($query_params)) {
1419
+			EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1420
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1421
+					gettype($query_params)), '4.6.0');
1422
+			$query_params = array();
1423
+		}
1424
+		//let's add the where query param for consecutive look up.
1425
+		$query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1426
+		$query_params['limit'] = $limit;
1427
+		//set direction
1428
+		$incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1429
+		$query_params['order_by'] = $operand === '>'
1430
+			? array($field_to_order_by => 'ASC') + $incoming_orderby
1431
+			: array($field_to_order_by => 'DESC') + $incoming_orderby;
1432
+		//if $columns_to_select is empty then that means we're returning EE_Base_Class objects
1433
+		if (empty($columns_to_select)) {
1434
+			return $this->get_all($query_params);
1435
+		}
1436
+		//getting just the fields
1437
+		return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
1438
+	}
1439
+
1440
+
1441
+
1442
+	/**
1443
+	 * This sets the _timezone property after model object has been instantiated.
1444
+	 *
1445
+	 * @param null | string $timezone valid PHP DateTimeZone timezone string
1446
+	 */
1447
+	public function set_timezone($timezone)
1448
+	{
1449
+		if ($timezone !== null) {
1450
+			$this->_timezone = $timezone;
1451
+		}
1452
+		//note we need to loop through relations and set the timezone on those objects as well.
1453
+		foreach ($this->_model_relations as $relation) {
1454
+			$relation->set_timezone($timezone);
1455
+		}
1456
+		//and finally we do the same for any datetime fields
1457
+		foreach ($this->_fields as $field) {
1458
+			if ($field instanceof EE_Datetime_Field) {
1459
+				$field->set_timezone($timezone);
1460
+			}
1461
+		}
1462
+	}
1463
+
1464
+
1465
+
1466
+	/**
1467
+	 * This just returns whatever is set for the current timezone.
1468
+	 *
1469
+	 * @access public
1470
+	 * @return string
1471
+	 */
1472
+	public function get_timezone()
1473
+	{
1474
+		//first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
1475
+		if (empty($this->_timezone)) {
1476
+			foreach ($this->_fields as $field) {
1477
+				if ($field instanceof EE_Datetime_Field) {
1478
+					$this->set_timezone($field->get_timezone());
1479
+					break;
1480
+				}
1481
+			}
1482
+		}
1483
+		//if timezone STILL empty then return the default timezone for the site.
1484
+		if (empty($this->_timezone)) {
1485
+			$this->set_timezone(EEH_DTT_Helper::get_timezone());
1486
+		}
1487
+		return $this->_timezone;
1488
+	}
1489
+
1490
+
1491
+
1492
+	/**
1493
+	 * This returns the date formats set for the given field name and also ensures that
1494
+	 * $this->_timezone property is set correctly.
1495
+	 *
1496
+	 * @since 4.6.x
1497
+	 * @param string $field_name The name of the field the formats are being retrieved for.
1498
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
1499
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
1500
+	 * @return array formats in an array with the date format first, and the time format last.
1501
+	 */
1502
+	public function get_formats_for($field_name, $pretty = false)
1503
+	{
1504
+		$field_settings = $this->field_settings_for($field_name);
1505
+		//if not a valid EE_Datetime_Field then throw error
1506
+		if (! $field_settings instanceof EE_Datetime_Field) {
1507
+			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.',
1508
+				'event_espresso'), $field_name));
1509
+		}
1510
+		//while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
1511
+		//the field.
1512
+		$this->_timezone = $field_settings->get_timezone();
1513
+		return array($field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty));
1514
+	}
1515
+
1516
+
1517
+
1518
+	/**
1519
+	 * This returns the current time in a format setup for a query on this model.
1520
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
1521
+	 * it will return:
1522
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
1523
+	 *  NOW
1524
+	 *  - or a unix timestamp (equivalent to time())
1525
+	 * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
1526
+	 * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
1527
+	 * the time returned to be the current time down to the exact second, set $timestamp to true.
1528
+	 * @since 4.6.x
1529
+	 * @param string $field_name       The field the current time is needed for.
1530
+	 * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
1531
+	 *                                 formatted string matching the set format for the field in the set timezone will
1532
+	 *                                 be returned.
1533
+	 * @param string $what             Whether to return the string in just the time format, the date format, or both.
1534
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
1535
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
1536
+	 *                                 exception is triggered.
1537
+	 */
1538
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
1539
+	{
1540
+		$formats = $this->get_formats_for($field_name);
1541
+		$DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
1542
+		if ($timestamp) {
1543
+			return $DateTime->format('U');
1544
+		}
1545
+		//not returning timestamp, so return formatted string in timezone.
1546
+		switch ($what) {
1547
+			case 'time' :
1548
+				return $DateTime->format($formats[1]);
1549
+				break;
1550
+			case 'date' :
1551
+				return $DateTime->format($formats[0]);
1552
+				break;
1553
+			default :
1554
+				return $DateTime->format(implode(' ', $formats));
1555
+				break;
1556
+		}
1557
+	}
1558
+
1559
+
1560
+
1561
+	/**
1562
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
1563
+	 * for the model are.  Returns a DateTime object.
1564
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
1565
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
1566
+	 * ignored.
1567
+	 *
1568
+	 * @param string $field_name      The field being setup.
1569
+	 * @param string $timestring      The date time string being used.
1570
+	 * @param string $incoming_format The format for the time string.
1571
+	 * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
1572
+	 *                                the blog.  If this is not the case, then it can be specified here.  If incoming
1573
+	 *                                format is
1574
+	 *                                'U', this is ignored.
1575
+	 * @return DateTime
1576
+	 * @throws EE_Error
1577
+	 */
1578
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
1579
+	{
1580
+		//just using this to ensure the timezone is set correctly internally
1581
+		$this->get_formats_for($field_name);
1582
+		//load EEH_DTT_Helper
1583
+		$set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1584
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1585
+		return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1586
+	}
1587
+
1588
+
1589
+
1590
+	/**
1591
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
1592
+	 *
1593
+	 * @return EE_Table_Base[]
1594
+	 */
1595
+	public function get_tables()
1596
+	{
1597
+		return $this->_tables;
1598
+	}
1599
+
1600
+
1601
+
1602
+	/**
1603
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
1604
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
1605
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
1606
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
1607
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
1608
+	 * model object with EVT_ID = 1
1609
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
1610
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
1611
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
1612
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
1613
+	 * are not specified)
1614
+	 *
1615
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
1616
+	 *                                         columns!), values are strings, ints, floats, and maybe arrays if they
1617
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
1618
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
1619
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
1620
+	 *                                         ID=34, we'd use this method as follows:
1621
+	 *                                         EEM_Transaction::instance()->update(
1622
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
1623
+	 *                                         array(array('TXN_ID'=>34)));
1624
+	 * @param array   $query_params            very much like EEM_Base::get_all's $query_params
1625
+	 *                                         in client code into what's expected to be stored on each field. Eg,
1626
+	 *                                         consider updating Question's QST_admin_label field is of type
1627
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
1628
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
1629
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
1630
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
1631
+	 *                                         TRUE, it is assumed that you've already called
1632
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
1633
+	 *                                         malicious javascript. However, if
1634
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
1635
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
1636
+	 *                                         and every other field, before insertion. We provide this parameter
1637
+	 *                                         because model objects perform their prepare_for_set function on all
1638
+	 *                                         their values, and so don't need to be called again (and in many cases,
1639
+	 *                                         shouldn't be called again. Eg: if we escape HTML characters in the
1640
+	 *                                         prepare_for_set method...)
1641
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
1642
+	 *                                         in this model's entity map according to $fields_n_values that match
1643
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
1644
+	 *                                         by setting this to FALSE, but be aware that model objects being used
1645
+	 *                                         could get out-of-sync with the database
1646
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
1647
+	 *                                         rows affected which *could* include 0 which DOES NOT mean the query was
1648
+	 *                                         bad)
1649
+	 * @throws EE_Error
1650
+	 */
1651
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1652
+	{
1653
+		if (! is_array($query_params)) {
1654
+			EE_Error::doing_it_wrong('EEM_Base::update',
1655
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1656
+					gettype($query_params)), '4.6.0');
1657
+			$query_params = array();
1658
+		}
1659
+		/**
1660
+		 * Action called before a model update call has been made.
1661
+		 *
1662
+		 * @param EEM_Base $model
1663
+		 * @param array    $fields_n_values the updated fields and their new values
1664
+		 * @param array    $query_params    @see EEM_Base::get_all()
1665
+		 */
1666
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
1667
+		/**
1668
+		 * Filters the fields about to be updated given the query parameters. You can provide the
1669
+		 * $query_params to $this->get_all() to find exactly which records will be updated
1670
+		 *
1671
+		 * @param array    $fields_n_values fields and their new values
1672
+		 * @param EEM_Base $model           the model being queried
1673
+		 * @param array    $query_params    see EEM_Base::get_all()
1674
+		 */
1675
+		$fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1676
+			$query_params);
1677
+		//need to verify that, for any entry we want to update, there are entries in each secondary table.
1678
+		//to do that, for each table, verify that it's PK isn't null.
1679
+		$tables = $this->get_tables();
1680
+		//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
1681
+		//NOTE: we should make this code more efficient by NOT querying twice
1682
+		//before the real update, but that needs to first go through ALPHA testing
1683
+		//as it's dangerous. says Mike August 8 2014
1684
+		//we want to make sure the default_where strategy is ignored
1685
+		$this->_ignore_where_strategy = true;
1686
+		$wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1687
+		foreach ($wpdb_select_results as $wpdb_result) {
1688
+			// type cast stdClass as array
1689
+			$wpdb_result = (array)$wpdb_result;
1690
+			//get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1691
+			if ($this->has_primary_key_field()) {
1692
+				$main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
1693
+			} else {
1694
+				//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)
1695
+				$main_table_pk_value = null;
1696
+			}
1697
+			//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
1698
+			//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
1699
+			if (count($tables) > 1) {
1700
+				//foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
1701
+				//in that table, and so we'll want to insert one
1702
+				foreach ($tables as $table_obj) {
1703
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1704
+					//if there is no private key for this table on the results, it means there's no entry
1705
+					//in this table, right? so insert a row in the current table, using any fields available
1706
+					if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1707
+						   && $wpdb_result[$this_table_pk_column])
1708
+					) {
1709
+						$success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1710
+							$main_table_pk_value);
1711
+						//if we died here, report the error
1712
+						if (! $success) {
1713
+							return false;
1714
+						}
1715
+					}
1716
+				}
1717
+			}
1718
+			//				//and now check that if we have cached any models by that ID on the model, that
1719
+			//				//they also get updated properly
1720
+			//				$model_object = $this->get_from_entity_map( $main_table_pk_value );
1721
+			//				if( $model_object ){
1722
+			//					foreach( $fields_n_values as $field => $value ){
1723
+			//						$model_object->set($field, $value);
1724
+			//let's make sure default_where strategy is followed now
1725
+			$this->_ignore_where_strategy = false;
1726
+		}
1727
+		//if we want to keep model objects in sync, AND
1728
+		//if this wasn't called from a model object (to update itself)
1729
+		//then we want to make sure we keep all the existing
1730
+		//model objects in sync with the db
1731
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
1732
+			if ($this->has_primary_key_field()) {
1733
+				$model_objs_affected_ids = $this->get_col($query_params);
1734
+			} else {
1735
+				//we need to select a bunch of columns and then combine them into the the "index primary key string"s
1736
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
1737
+				$model_objs_affected_ids = array();
1738
+				foreach ($models_affected_key_columns as $row) {
1739
+					$combined_index_key = $this->get_index_primary_key_string($row);
1740
+					$model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1741
+				}
1742
+			}
1743
+			if (! $model_objs_affected_ids) {
1744
+				//wait wait wait- if nothing was affected let's stop here
1745
+				return 0;
1746
+			}
1747
+			foreach ($model_objs_affected_ids as $id) {
1748
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
1749
+				if ($model_obj_in_entity_map) {
1750
+					foreach ($fields_n_values as $field => $new_value) {
1751
+						$model_obj_in_entity_map->set($field, $new_value);
1752
+					}
1753
+				}
1754
+			}
1755
+			//if there is a primary key on this model, we can now do a slight optimization
1756
+			if ($this->has_primary_key_field()) {
1757
+				//we already know what we want to update. So let's make the query simpler so it's a little more efficient
1758
+				$query_params = array(
1759
+					array($this->primary_key_name() => array('IN', $model_objs_affected_ids)),
1760
+					'limit'                    => count($model_objs_affected_ids),
1761
+					'default_where_conditions' => EEM_Base::default_where_conditions_none,
1762
+				);
1763
+			}
1764
+		}
1765
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1766
+		$SQL = "UPDATE "
1767
+			   . $model_query_info->get_full_join_sql()
1768
+			   . " SET "
1769
+			   . $this->_construct_update_sql($fields_n_values)
1770
+			   . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1771
+		$rows_affected = $this->_do_wpdb_query('query', array($SQL));
1772
+		/**
1773
+		 * Action called after a model update call has been made.
1774
+		 *
1775
+		 * @param EEM_Base $model
1776
+		 * @param array    $fields_n_values the updated fields and their new values
1777
+		 * @param array    $query_params    @see EEM_Base::get_all()
1778
+		 * @param int      $rows_affected
1779
+		 */
1780
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1781
+		return $rows_affected;//how many supposedly got updated
1782
+	}
1783
+
1784
+
1785
+
1786
+	/**
1787
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
1788
+	 * are teh values of the field specified (or by default the primary key field)
1789
+	 * that matched the query params. Note that you should pass the name of the
1790
+	 * model FIELD, not the database table's column name.
1791
+	 *
1792
+	 * @param array  $query_params @see EEM_Base::get_all()
1793
+	 * @param string $field_to_select
1794
+	 * @return array just like $wpdb->get_col()
1795
+	 * @throws EE_Error
1796
+	 */
1797
+	public function get_col($query_params = array(), $field_to_select = null)
1798
+	{
1799
+		if ($field_to_select) {
1800
+			$field = $this->field_settings_for($field_to_select);
1801
+		} elseif ($this->has_primary_key_field()) {
1802
+			$field = $this->get_primary_key_field();
1803
+		} else {
1804
+			//no primary key, just grab the first column
1805
+			$field = reset($this->field_settings());
1806
+		}
1807
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
1808
+		$select_expressions = $field->get_qualified_column();
1809
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1810
+		return $this->_do_wpdb_query('get_col', array($SQL));
1811
+	}
1812
+
1813
+
1814
+
1815
+	/**
1816
+	 * Returns a single column value for a single row from the database
1817
+	 *
1818
+	 * @param array  $query_params    @see EEM_Base::get_all()
1819
+	 * @param string $field_to_select @see EEM_Base::get_col()
1820
+	 * @return string
1821
+	 * @throws EE_Error
1822
+	 */
1823
+	public function get_var($query_params = array(), $field_to_select = null)
1824
+	{
1825
+		$query_params['limit'] = 1;
1826
+		$col = $this->get_col($query_params, $field_to_select);
1827
+		if (! empty($col)) {
1828
+			return reset($col);
1829
+		}
1830
+		return null;
1831
+	}
1832
+
1833
+
1834
+
1835
+	/**
1836
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
1837
+	 * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
1838
+	 * injection, but currently no further filtering is done
1839
+	 *
1840
+	 * @global      $wpdb
1841
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
1842
+	 *                               be updated to in the DB
1843
+	 * @return string of SQL
1844
+	 * @throws EE_Error
1845
+	 */
1846
+	public function _construct_update_sql($fields_n_values)
1847
+	{
1848
+		/** @type WPDB $wpdb */
1849
+		global $wpdb;
1850
+		$cols_n_values = array();
1851
+		foreach ($fields_n_values as $field_name => $value) {
1852
+			$field_obj = $this->field_settings_for($field_name);
1853
+			//if the value is NULL, we want to assign the value to that.
1854
+			//wpdb->prepare doesn't really handle that properly
1855
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1856
+			$value_sql = $prepared_value === null ? 'NULL'
1857
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1858
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1859
+		}
1860
+		return implode(",", $cols_n_values);
1861
+	}
1862
+
1863
+
1864
+
1865
+	/**
1866
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1867
+	 * Performs a HARD delete, meaning the database row should always be removed,
1868
+	 * not just have a flag field on it switched
1869
+	 * Wrapper for EEM_Base::delete_permanently()
1870
+	 *
1871
+	 * @param mixed $id
1872
+	 * @return boolean whether the row got deleted or not
1873
+	 * @throws EE_Error
1874
+	 */
1875
+	public function delete_permanently_by_ID($id)
1876
+	{
1877
+		return $this->delete_permanently(
1878
+			array(
1879
+				array($this->get_primary_key_field()->get_name() => $id),
1880
+				'limit' => 1,
1881
+			)
1882
+		);
1883
+	}
1884
+
1885
+
1886
+
1887
+	/**
1888
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
1889
+	 * Wrapper for EEM_Base::delete()
1890
+	 *
1891
+	 * @param mixed $id
1892
+	 * @return boolean whether the row got deleted or not
1893
+	 * @throws EE_Error
1894
+	 */
1895
+	public function delete_by_ID($id)
1896
+	{
1897
+		return $this->delete(
1898
+			array(
1899
+				array($this->get_primary_key_field()->get_name() => $id),
1900
+				'limit' => 1,
1901
+			)
1902
+		);
1903
+	}
1904
+
1905
+
1906
+
1907
+	/**
1908
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
1909
+	 * meaning if the model has a field that indicates its been "trashed" or
1910
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
1911
+	 *
1912
+	 * @see EEM_Base::delete_permanently
1913
+	 * @param array   $query_params
1914
+	 * @param boolean $allow_blocking
1915
+	 * @return int how many rows got deleted
1916
+	 * @throws EE_Error
1917
+	 */
1918
+	public function delete($query_params, $allow_blocking = true)
1919
+	{
1920
+		return $this->delete_permanently($query_params, $allow_blocking);
1921
+	}
1922
+
1923
+
1924
+
1925
+	/**
1926
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
1927
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
1928
+	 * as archived, not actually deleted
1929
+	 *
1930
+	 * @param array   $query_params   very much like EEM_Base::get_all's $query_params
1931
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
1932
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
1933
+	 *                                deletes regardless of other objects which may depend on it. Its generally
1934
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
1935
+	 *                                DB
1936
+	 * @return int how many rows got deleted
1937
+	 * @throws EE_Error
1938
+	 */
1939
+	public function delete_permanently($query_params, $allow_blocking = true)
1940
+	{
1941
+		/**
1942
+		 * Action called just before performing a real deletion query. You can use the
1943
+		 * model and its $query_params to find exactly which items will be deleted
1944
+		 *
1945
+		 * @param EEM_Base $model
1946
+		 * @param array    $query_params   @see EEM_Base::get_all()
1947
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
1948
+		 *                                 to block (prevent) this deletion
1949
+		 */
1950
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
1951
+		//some MySQL databases may be running safe mode, which may restrict
1952
+		//deletion if there is no KEY column used in the WHERE statement of a deletion.
1953
+		//to get around this, we first do a SELECT, get all the IDs, and then run another query
1954
+		//to delete them
1955
+		$items_for_deletion = $this->_get_all_wpdb_results($query_params);
1956
+		$columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
1957
+		$deletion_where_query_part = $this->_build_query_part_for_deleting_from_columns_and_values(
1958
+			$columns_and_ids_for_deleting
1959
+		);
1960
+		/**
1961
+		 * Allows client code to act on the items being deleted before the query is actually executed.
1962
+		 *
1963
+		 * @param EEM_Base $this  The model instance being acted on.
1964
+		 * @param array    $query_params  The incoming array of query parameters influencing what gets deleted.
1965
+		 * @param bool     $allow_blocking @see param description in method phpdoc block.
1966
+		 * @param array $columns_and_ids_for_deleting       An array indicating what entities will get removed as
1967
+		 *                                                  derived from the incoming query parameters.
1968
+		 *                                                  @see details on the structure of this array in the phpdocs
1969
+		 *                                                  for the `_get_ids_for_delete_method`
1970
+		 *
1971
+		 */
1972
+		do_action('AHEE__EEM_Base__delete__before_query',
1973
+			$this,
1974
+			$query_params,
1975
+			$allow_blocking,
1976
+			$columns_and_ids_for_deleting
1977
+		);
1978
+		if ($deletion_where_query_part) {
1979
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
1980
+			$table_aliases = array_keys($this->_tables);
1981
+			$SQL = "DELETE "
1982
+				   . implode(", ", $table_aliases)
1983
+				   . " FROM "
1984
+				   . $model_query_info->get_full_join_sql()
1985
+				   . " WHERE "
1986
+				   . $deletion_where_query_part;
1987
+			$rows_deleted = $this->_do_wpdb_query('query', array($SQL));
1988
+		} else {
1989
+			$rows_deleted = 0;
1990
+		}
1991
+
1992
+		//Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
1993
+		//there was no error with the delete query.
1994
+		if ($this->has_primary_key_field()
1995
+			&& $rows_deleted !== false
1996
+			&& isset($columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()])
1997
+		) {
1998
+			$ids_for_removal = $columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()];
1999
+			foreach ($ids_for_removal as $id) {
2000
+				if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
2001
+					unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
2002
+				}
2003
+			}
2004
+
2005
+			// delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
2006
+			//`EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
2007
+			//unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
2008
+			// (although it is possible).
2009
+			//Note this can be skipped by using the provided filter and returning false.
2010
+			if (apply_filters(
2011
+				'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
2012
+				! $this instanceof EEM_Extra_Meta,
2013
+				$this
2014
+			)) {
2015
+				EEM_Extra_Meta::instance()->delete_permanently(array(
2016
+					0 => array(
2017
+						'EXM_type' => $this->get_this_model_name(),
2018
+						'OBJ_ID'   => array(
2019
+							'IN',
2020
+							$ids_for_removal
2021
+						)
2022
+					)
2023
+				));
2024
+			}
2025
+		}
2026
+
2027
+		/**
2028
+		 * Action called just after performing a real deletion query. Although at this point the
2029
+		 * items should have been deleted
2030
+		 *
2031
+		 * @param EEM_Base $model
2032
+		 * @param array    $query_params @see EEM_Base::get_all()
2033
+		 * @param int      $rows_deleted
2034
+		 */
2035
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
2036
+		return $rows_deleted;//how many supposedly got deleted
2037
+	}
2038
+
2039
+
2040
+
2041
+	/**
2042
+	 * Checks all the relations that throw error messages when there are blocking related objects
2043
+	 * for related model objects. If there are any related model objects on those relations,
2044
+	 * adds an EE_Error, and return true
2045
+	 *
2046
+	 * @param EE_Base_Class|int $this_model_obj_or_id
2047
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
2048
+	 *                                                 should be ignored when determining whether there are related
2049
+	 *                                                 model objects which block this model object's deletion. Useful
2050
+	 *                                                 if you know A is related to B and are considering deleting A,
2051
+	 *                                                 but want to see if A has any other objects blocking its deletion
2052
+	 *                                                 before removing the relation between A and B
2053
+	 * @return boolean
2054
+	 * @throws EE_Error
2055
+	 */
2056
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
2057
+	{
2058
+		//first, if $ignore_this_model_obj was supplied, get its model
2059
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
2060
+			$ignored_model = $ignore_this_model_obj->get_model();
2061
+		} else {
2062
+			$ignored_model = null;
2063
+		}
2064
+		//now check all the relations of $this_model_obj_or_id and see if there
2065
+		//are any related model objects blocking it?
2066
+		$is_blocked = false;
2067
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
2068
+			if ($relation_obj->block_delete_if_related_models_exist()) {
2069
+				//if $ignore_this_model_obj was supplied, then for the query
2070
+				//on that model needs to be told to ignore $ignore_this_model_obj
2071
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
2072
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, array(
2073
+						array(
2074
+							$ignored_model->get_primary_key_field()->get_name() => array(
2075
+								'!=',
2076
+								$ignore_this_model_obj->ID(),
2077
+							),
2078
+						),
2079
+					));
2080
+				} else {
2081
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
2082
+				}
2083
+				if ($related_model_objects) {
2084
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
2085
+					$is_blocked = true;
2086
+				}
2087
+			}
2088
+		}
2089
+		return $is_blocked;
2090
+	}
2091
+
2092
+
2093
+	/**
2094
+	 * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
2095
+	 * @param array $row_results_for_deleting
2096
+	 * @param bool  $allow_blocking
2097
+	 * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
2098
+	 *                 model DOES have a primary_key_field, then the array will be a simple single dimension array where
2099
+	 *                 the key is the fully qualified primary key column and the value is an array of ids that will be
2100
+	 *                 deleted. Example:
2101
+	 *                      array('Event.EVT_ID' => array( 1,2,3))
2102
+	 *                 If the model DOES NOT have a primary_key_field, then the array will be a two dimensional array
2103
+	 *                 where each element is a group of columns and values that get deleted. Example:
2104
+	 *                      array(
2105
+	 *                          0 => array(
2106
+	 *                              'Term_Relationship.object_id' => 1
2107
+	 *                              'Term_Relationship.term_taxonomy_id' => 5
2108
+	 *                          ),
2109
+	 *                          1 => array(
2110
+	 *                              'Term_Relationship.object_id' => 1
2111
+	 *                              'Term_Relationship.term_taxonomy_id' => 6
2112
+	 *                          )
2113
+	 *                      )
2114
+	 * @throws EE_Error
2115
+	 */
2116
+	protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
2117
+	{
2118
+		$ids_to_delete_indexed_by_column = array();
2119
+		if ($this->has_primary_key_field()) {
2120
+			$primary_table = $this->_get_main_table();
2121
+			$other_tables = $this->_get_other_tables();
2122
+			$ids_to_delete_indexed_by_column = $query = array();
2123
+			foreach ($row_results_for_deleting as $item_to_delete) {
2124
+				//before we mark this item for deletion,
2125
+				//make sure there's no related entities blocking its deletion (if we're checking)
2126
+				if (
2127
+					$allow_blocking
2128
+					&& $this->delete_is_blocked_by_related_models(
2129
+						$item_to_delete[$primary_table->get_fully_qualified_pk_column()]
2130
+					)
2131
+				) {
2132
+					continue;
2133
+				}
2134
+				//primary table deletes
2135
+				if (isset($item_to_delete[$primary_table->get_fully_qualified_pk_column()])) {
2136
+					$ids_to_delete_indexed_by_column[$primary_table->get_fully_qualified_pk_column()][] =
2137
+						$item_to_delete[$primary_table->get_fully_qualified_pk_column()];
2138
+				}
2139
+			}
2140
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2141
+			$fields = $this->get_combined_primary_key_fields();
2142
+			foreach ($row_results_for_deleting as $item_to_delete) {
2143
+				$ids_to_delete_indexed_by_column_for_row = array();
2144
+				foreach ($fields as $cpk_field) {
2145
+					if ($cpk_field instanceof EE_Model_Field_Base) {
2146
+						$ids_to_delete_indexed_by_column_for_row[$cpk_field->get_qualified_column()] =
2147
+							$item_to_delete[$cpk_field->get_qualified_column()];
2148
+					}
2149
+				}
2150
+				$ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
2151
+			}
2152
+		} else {
2153
+			//so there's no primary key and no combined key...
2154
+			//sorry, can't help you
2155
+			throw new EE_Error(
2156
+				sprintf(
2157
+					__(
2158
+						"Cannot delete objects of type %s because there is no primary key NOR combined key",
2159
+						"event_espresso"
2160
+					), get_class($this)
2161
+				)
2162
+			);
2163
+		}
2164
+		return $ids_to_delete_indexed_by_column;
2165
+	}
2166
+
2167
+
2168
+	/**
2169
+	 * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
2170
+	 * the corresponding query_part for the query performing the delete.
2171
+	 *
2172
+	 * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
2173
+	 * @return string
2174
+	 * @throws EE_Error
2175
+	 */
2176
+	protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column) {
2177
+		$query_part = '';
2178
+		if (empty($ids_to_delete_indexed_by_column)) {
2179
+			return $query_part;
2180
+		} elseif ($this->has_primary_key_field()) {
2181
+			$query = array();
2182
+			foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
2183
+				//make sure we have unique $ids
2184
+				$ids = array_unique($ids);
2185
+				$query[] = $column . ' IN(' . implode(',', $ids) . ')';
2186
+			}
2187
+			$query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
2188
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
2189
+			$ways_to_identify_a_row = array();
2190
+			foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
2191
+				$values_for_each_combined_primary_key_for_a_row = array();
2192
+				foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
2193
+					$values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
2194
+				}
2195
+				$ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2196
+			}
2197
+			$query_part = implode(' OR ', $ways_to_identify_a_row);
2198
+		}
2199
+		return $query_part;
2200
+	}
2201
+
2202
+
2203
+
2204
+
2205
+	/**
2206
+	 * Count all the rows that match criteria expressed in $query_params (an array just like arg to EEM_Base::get_all).
2207
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
2208
+	 * column
2209
+	 *
2210
+	 * @param array  $query_params   like EEM_Base::get_all's
2211
+	 * @param string $field_to_count field on model to count by (not column name)
2212
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2213
+	 *                               that by the setting $distinct to TRUE;
2214
+	 * @return int
2215
+	 * @throws EE_Error
2216
+	 */
2217
+	public function count($query_params = array(), $field_to_count = null, $distinct = false)
2218
+	{
2219
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2220
+		if ($field_to_count) {
2221
+			$field_obj = $this->field_settings_for($field_to_count);
2222
+			$column_to_count = $field_obj->get_qualified_column();
2223
+		} elseif ($this->has_primary_key_field()) {
2224
+			$pk_field_obj = $this->get_primary_key_field();
2225
+			$column_to_count = $pk_field_obj->get_qualified_column();
2226
+		} else {
2227
+			//there's no primary key
2228
+			//if we're counting distinct items, and there's no primary key,
2229
+			//we need to list out the columns for distinction;
2230
+			//otherwise we can just use star
2231
+			if ($distinct) {
2232
+				$columns_to_use = array();
2233
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
2234
+					$columns_to_use[] = $field_obj->get_qualified_column();
2235
+				}
2236
+				$column_to_count = implode(',', $columns_to_use);
2237
+			} else {
2238
+				$column_to_count = '*';
2239
+			}
2240
+		}
2241
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2242
+		$SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2243
+		return (int)$this->_do_wpdb_query('get_var', array($SQL));
2244
+	}
2245
+
2246
+
2247
+
2248
+	/**
2249
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
2250
+	 *
2251
+	 * @param array  $query_params like EEM_Base::get_all
2252
+	 * @param string $field_to_sum name of field (array key in $_fields array)
2253
+	 * @return float
2254
+	 * @throws EE_Error
2255
+	 */
2256
+	public function sum($query_params, $field_to_sum = null)
2257
+	{
2258
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
2259
+		if ($field_to_sum) {
2260
+			$field_obj = $this->field_settings_for($field_to_sum);
2261
+		} else {
2262
+			$field_obj = $this->get_primary_key_field();
2263
+		}
2264
+		$column_to_count = $field_obj->get_qualified_column();
2265
+		$SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2266
+		$return_value = $this->_do_wpdb_query('get_var', array($SQL));
2267
+		$data_type = $field_obj->get_wpdb_data_type();
2268
+		if ($data_type === '%d' || $data_type === '%s') {
2269
+			return (float)$return_value;
2270
+		}
2271
+		//must be %f
2272
+		return (float)$return_value;
2273
+	}
2274
+
2275
+
2276
+
2277
+	/**
2278
+	 * Just calls the specified method on $wpdb with the given arguments
2279
+	 * Consolidates a little extra error handling code
2280
+	 *
2281
+	 * @param string $wpdb_method
2282
+	 * @param array  $arguments_to_provide
2283
+	 * @throws EE_Error
2284
+	 * @global wpdb  $wpdb
2285
+	 * @return mixed
2286
+	 */
2287
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
2288
+	{
2289
+		//if we're in maintenance mode level 2, DON'T run any queries
2290
+		//because level 2 indicates the database needs updating and
2291
+		//is probably out of sync with the code
2292
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2293
+			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.",
2294
+				"event_espresso")));
2295
+		}
2296
+		/** @type WPDB $wpdb */
2297
+		global $wpdb;
2298
+		if (! method_exists($wpdb, $wpdb_method)) {
2299
+			throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2300
+				'event_espresso'), $wpdb_method));
2301
+		}
2302
+		if (WP_DEBUG) {
2303
+			$old_show_errors_value = $wpdb->show_errors;
2304
+			$wpdb->show_errors(false);
2305
+		}
2306
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2307
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
2308
+		if (WP_DEBUG) {
2309
+			$wpdb->show_errors($old_show_errors_value);
2310
+			if (! empty($wpdb->last_error)) {
2311
+				throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2312
+			}
2313
+			if ($result === false) {
2314
+				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"',
2315
+					'event_espresso'), $wpdb_method, var_export($arguments_to_provide, true)));
2316
+			}
2317
+		} elseif ($result === false) {
2318
+			EE_Error::add_error(
2319
+				sprintf(
2320
+					__('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"',
2321
+						'event_espresso'),
2322
+					$wpdb_method,
2323
+					var_export($arguments_to_provide, true),
2324
+					$wpdb->last_error
2325
+				),
2326
+				__FILE__,
2327
+				__FUNCTION__,
2328
+				__LINE__
2329
+			);
2330
+		}
2331
+		return $result;
2332
+	}
2333
+
2334
+
2335
+
2336
+	/**
2337
+	 * Attempts to run the indicated WPDB method with the provided arguments,
2338
+	 * and if there's an error tries to verify the DB is correct. Uses
2339
+	 * the static property EEM_Base::$_db_verification_level to determine whether
2340
+	 * we should try to fix the EE core db, the addons, or just give up
2341
+	 *
2342
+	 * @param string $wpdb_method
2343
+	 * @param array  $arguments_to_provide
2344
+	 * @return mixed
2345
+	 */
2346
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
2347
+	{
2348
+		/** @type WPDB $wpdb */
2349
+		global $wpdb;
2350
+		$wpdb->last_error = null;
2351
+		$result = call_user_func_array(array($wpdb, $wpdb_method), $arguments_to_provide);
2352
+		// was there an error running the query? but we don't care on new activations
2353
+		// (we're going to setup the DB anyway on new activations)
2354
+		if (($result === false || ! empty($wpdb->last_error))
2355
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
2356
+		) {
2357
+			switch (EEM_Base::$_db_verification_level) {
2358
+				case EEM_Base::db_verified_none :
2359
+					// let's double-check core's DB
2360
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
2361
+					break;
2362
+				case EEM_Base::db_verified_core :
2363
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
2364
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
2365
+					break;
2366
+				case EEM_Base::db_verified_addons :
2367
+					// ummmm... you in trouble
2368
+					return $result;
2369
+					break;
2370
+			}
2371
+			if (! empty($error_message)) {
2372
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2373
+				trigger_error($error_message);
2374
+			}
2375
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
2376
+		}
2377
+		return $result;
2378
+	}
2379
+
2380
+
2381
+
2382
+	/**
2383
+	 * Verifies the EE core database is up-to-date and records that we've done it on
2384
+	 * EEM_Base::$_db_verification_level
2385
+	 *
2386
+	 * @param string $wpdb_method
2387
+	 * @param array  $arguments_to_provide
2388
+	 * @return string
2389
+	 */
2390
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
2391
+	{
2392
+		/** @type WPDB $wpdb */
2393
+		global $wpdb;
2394
+		//ok remember that we've already attempted fixing the core db, in case the problem persists
2395
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
2396
+		$error_message = sprintf(
2397
+			__('WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
2398
+				'event_espresso'),
2399
+			$wpdb->last_error,
2400
+			$wpdb_method,
2401
+			wp_json_encode($arguments_to_provide)
2402
+		);
2403
+		EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
2404
+		return $error_message;
2405
+	}
2406
+
2407
+
2408
+
2409
+	/**
2410
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
2411
+	 * EEM_Base::$_db_verification_level
2412
+	 *
2413
+	 * @param $wpdb_method
2414
+	 * @param $arguments_to_provide
2415
+	 * @return string
2416
+	 */
2417
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
2418
+	{
2419
+		/** @type WPDB $wpdb */
2420
+		global $wpdb;
2421
+		//ok remember that we've already attempted fixing the addons dbs, in case the problem persists
2422
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
2423
+		$error_message = sprintf(
2424
+			__('WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
2425
+				'event_espresso'),
2426
+			$wpdb->last_error,
2427
+			$wpdb_method,
2428
+			wp_json_encode($arguments_to_provide)
2429
+		);
2430
+		EE_System::instance()->initialize_addons();
2431
+		return $error_message;
2432
+	}
2433
+
2434
+
2435
+
2436
+	/**
2437
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
2438
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
2439
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
2440
+	 * ..."
2441
+	 *
2442
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
2443
+	 * @return string
2444
+	 */
2445
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2446
+	{
2447
+		return " FROM " . $model_query_info->get_full_join_sql() .
2448
+			   $model_query_info->get_where_sql() .
2449
+			   $model_query_info->get_group_by_sql() .
2450
+			   $model_query_info->get_having_sql() .
2451
+			   $model_query_info->get_order_by_sql() .
2452
+			   $model_query_info->get_limit_sql();
2453
+	}
2454
+
2455
+
2456
+
2457
+	/**
2458
+	 * Set to easily debug the next X queries ran from this model.
2459
+	 *
2460
+	 * @param int $count
2461
+	 */
2462
+	public function show_next_x_db_queries($count = 1)
2463
+	{
2464
+		$this->_show_next_x_db_queries = $count;
2465
+	}
2466
+
2467
+
2468
+
2469
+	/**
2470
+	 * @param $sql_query
2471
+	 */
2472
+	public function show_db_query_if_previously_requested($sql_query)
2473
+	{
2474
+		if ($this->_show_next_x_db_queries > 0) {
2475
+			echo $sql_query;
2476
+			$this->_show_next_x_db_queries--;
2477
+		}
2478
+	}
2479
+
2480
+
2481
+
2482
+	/**
2483
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
2484
+	 * There are the 3 cases:
2485
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
2486
+	 * $otherModelObject has no ID, it is first saved.
2487
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
2488
+	 * has no ID, it is first saved.
2489
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
2490
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
2491
+	 * join table
2492
+	 *
2493
+	 * @param        EE_Base_Class                     /int $thisModelObject
2494
+	 * @param        EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
2495
+	 * @param string $relationName                     , key in EEM_Base::_relations
2496
+	 *                                                 an attendee to a group, you also want to specify which role they
2497
+	 *                                                 will have in that group. So you would use this parameter to
2498
+	 *                                                 specify array('role-column-name'=>'role-id')
2499
+	 * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
2500
+	 *                                                 to for relation to methods that allow you to further specify
2501
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
2502
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
2503
+	 *                                                 because these will be inserted in any new rows created as well.
2504
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
2505
+	 * @throws EE_Error
2506
+	 */
2507
+	public function add_relationship_to(
2508
+		$id_or_obj,
2509
+		$other_model_id_or_obj,
2510
+		$relationName,
2511
+		$extra_join_model_fields_n_values = array()
2512
+	) {
2513
+		$relation_obj = $this->related_settings_for($relationName);
2514
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
2515
+	}
2516
+
2517
+
2518
+
2519
+	/**
2520
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
2521
+	 * There are the 3 cases:
2522
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
2523
+	 * error
2524
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
2525
+	 * an error
2526
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
2527
+	 *
2528
+	 * @param        EE_Base_Class /int $id_or_obj
2529
+	 * @param        EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
2530
+	 * @param string $relationName key in EEM_Base::_relations
2531
+	 * @return boolean of success
2532
+	 * @throws EE_Error
2533
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
2534
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
2535
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
2536
+	 *                             because these will be inserted in any new rows created as well.
2537
+	 */
2538
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
2539
+	{
2540
+		$relation_obj = $this->related_settings_for($relationName);
2541
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
2542
+	}
2543
+
2544
+
2545
+
2546
+	/**
2547
+	 * @param mixed           $id_or_obj
2548
+	 * @param string          $relationName
2549
+	 * @param array           $where_query_params
2550
+	 * @param EE_Base_Class[] objects to which relations were removed
2551
+	 * @return \EE_Base_Class[]
2552
+	 * @throws EE_Error
2553
+	 */
2554
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = array())
2555
+	{
2556
+		$relation_obj = $this->related_settings_for($relationName);
2557
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
2558
+	}
2559
+
2560
+
2561
+
2562
+	/**
2563
+	 * Gets all the related items of the specified $model_name, using $query_params.
2564
+	 * Note: by default, we remove the "default query params"
2565
+	 * because we want to get even deleted items etc.
2566
+	 *
2567
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
2568
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
2569
+	 * @param array  $query_params like EEM_Base::get_all
2570
+	 * @return EE_Base_Class[]
2571
+	 * @throws EE_Error
2572
+	 */
2573
+	public function get_all_related($id_or_obj, $model_name, $query_params = null)
2574
+	{
2575
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2576
+		$relation_settings = $this->related_settings_for($model_name);
2577
+		return $relation_settings->get_all_related($model_obj, $query_params);
2578
+	}
2579
+
2580
+
2581
+
2582
+	/**
2583
+	 * Deletes all the model objects across the relation indicated by $model_name
2584
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
2585
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
2586
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
2587
+	 *
2588
+	 * @param EE_Base_Class|int|string $id_or_obj
2589
+	 * @param string                   $model_name
2590
+	 * @param array                    $query_params
2591
+	 * @return int how many deleted
2592
+	 * @throws EE_Error
2593
+	 */
2594
+	public function delete_related($id_or_obj, $model_name, $query_params = array())
2595
+	{
2596
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2597
+		$relation_settings = $this->related_settings_for($model_name);
2598
+		return $relation_settings->delete_all_related($model_obj, $query_params);
2599
+	}
2600
+
2601
+
2602
+
2603
+	/**
2604
+	 * Hard deletes all the model objects across the relation indicated by $model_name
2605
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
2606
+	 * the model objects can't be hard deleted because of blocking related model objects,
2607
+	 * just does a soft-delete on them instead.
2608
+	 *
2609
+	 * @param EE_Base_Class|int|string $id_or_obj
2610
+	 * @param string                   $model_name
2611
+	 * @param array                    $query_params
2612
+	 * @return int how many deleted
2613
+	 * @throws EE_Error
2614
+	 */
2615
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = array())
2616
+	{
2617
+		$model_obj = $this->ensure_is_obj($id_or_obj);
2618
+		$relation_settings = $this->related_settings_for($model_name);
2619
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
2620
+	}
2621
+
2622
+
2623
+
2624
+	/**
2625
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
2626
+	 * unless otherwise specified in the $query_params
2627
+	 *
2628
+	 * @param        int             /EE_Base_Class $id_or_obj
2629
+	 * @param string $model_name     like 'Event', or 'Registration'
2630
+	 * @param array  $query_params   like EEM_Base::get_all's
2631
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
2632
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
2633
+	 *                               that by the setting $distinct to TRUE;
2634
+	 * @return int
2635
+	 * @throws EE_Error
2636
+	 */
2637
+	public function count_related(
2638
+		$id_or_obj,
2639
+		$model_name,
2640
+		$query_params = array(),
2641
+		$field_to_count = null,
2642
+		$distinct = false
2643
+	) {
2644
+		$related_model = $this->get_related_model_obj($model_name);
2645
+		//we're just going to use the query params on the related model's normal get_all query,
2646
+		//except add a condition to say to match the current mod
2647
+		if (! isset($query_params['default_where_conditions'])) {
2648
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2649
+		}
2650
+		$this_model_name = $this->get_this_model_name();
2651
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2652
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2653
+		return $related_model->count($query_params, $field_to_count, $distinct);
2654
+	}
2655
+
2656
+
2657
+
2658
+	/**
2659
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
2660
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
2661
+	 *
2662
+	 * @param        int           /EE_Base_Class $id_or_obj
2663
+	 * @param string $model_name   like 'Event', or 'Registration'
2664
+	 * @param array  $query_params like EEM_Base::get_all's
2665
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
2666
+	 * @return float
2667
+	 * @throws EE_Error
2668
+	 */
2669
+	public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2670
+	{
2671
+		$related_model = $this->get_related_model_obj($model_name);
2672
+		if (! is_array($query_params)) {
2673
+			EE_Error::doing_it_wrong('EEM_Base::sum_related',
2674
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2675
+					gettype($query_params)), '4.6.0');
2676
+			$query_params = array();
2677
+		}
2678
+		//we're just going to use the query params on the related model's normal get_all query,
2679
+		//except add a condition to say to match the current mod
2680
+		if (! isset($query_params['default_where_conditions'])) {
2681
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2682
+		}
2683
+		$this_model_name = $this->get_this_model_name();
2684
+		$this_pk_field_name = $this->get_primary_key_field()->get_name();
2685
+		$query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2686
+		return $related_model->sum($query_params, $field_to_sum);
2687
+	}
2688
+
2689
+
2690
+
2691
+	/**
2692
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
2693
+	 * $modelObject
2694
+	 *
2695
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
2696
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
2697
+	 * @param array               $query_params     like EEM_Base::get_all's
2698
+	 * @return EE_Base_Class
2699
+	 * @throws EE_Error
2700
+	 */
2701
+	public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
2702
+	{
2703
+		$query_params['limit'] = 1;
2704
+		$results = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
2705
+		if ($results) {
2706
+			return array_shift($results);
2707
+		}
2708
+		return null;
2709
+	}
2710
+
2711
+
2712
+
2713
+	/**
2714
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
2715
+	 *
2716
+	 * @return string
2717
+	 */
2718
+	public function get_this_model_name()
2719
+	{
2720
+		return str_replace("EEM_", "", get_class($this));
2721
+	}
2722
+
2723
+
2724
+
2725
+	/**
2726
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
2727
+	 *
2728
+	 * @return EE_Any_Foreign_Model_Name_Field
2729
+	 * @throws EE_Error
2730
+	 */
2731
+	public function get_field_containing_related_model_name()
2732
+	{
2733
+		foreach ($this->field_settings(true) as $field) {
2734
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
2735
+				$field_with_model_name = $field;
2736
+			}
2737
+		}
2738
+		if (! isset($field_with_model_name) || ! $field_with_model_name) {
2739
+			throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2740
+				$this->get_this_model_name()));
2741
+		}
2742
+		return $field_with_model_name;
2743
+	}
2744
+
2745
+
2746
+
2747
+	/**
2748
+	 * Inserts a new entry into the database, for each table.
2749
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
2750
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
2751
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
2752
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
2753
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
2754
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
2755
+	 *
2756
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
2757
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
2758
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
2759
+	 *                              of EEM_Base)
2760
+	 * @return int new primary key on main table that got inserted
2761
+	 * @throws EE_Error
2762
+	 */
2763
+	public function insert($field_n_values)
2764
+	{
2765
+		/**
2766
+		 * Filters the fields and their values before inserting an item using the models
2767
+		 *
2768
+		 * @param array    $fields_n_values keys are the fields and values are their new values
2769
+		 * @param EEM_Base $model           the model used
2770
+		 */
2771
+		$field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2772
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
2773
+			$main_table = $this->_get_main_table();
2774
+			$new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
2775
+			if ($new_id !== false) {
2776
+				foreach ($this->_get_other_tables() as $other_table) {
2777
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
2778
+				}
2779
+			}
2780
+			/**
2781
+			 * Done just after attempting to insert a new model object
2782
+			 *
2783
+			 * @param EEM_Base   $model           used
2784
+			 * @param array      $fields_n_values fields and their values
2785
+			 * @param int|string the              ID of the newly-inserted model object
2786
+			 */
2787
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
2788
+			return $new_id;
2789
+		}
2790
+		return false;
2791
+	}
2792
+
2793
+
2794
+
2795
+	/**
2796
+	 * Checks that the result would satisfy the unique indexes on this model
2797
+	 *
2798
+	 * @param array  $field_n_values
2799
+	 * @param string $action
2800
+	 * @return boolean
2801
+	 * @throws EE_Error
2802
+	 */
2803
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
2804
+	{
2805
+		foreach ($this->unique_indexes() as $index_name => $index) {
2806
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
2807
+			if ($this->exists(array($uniqueness_where_params))) {
2808
+				EE_Error::add_error(
2809
+					sprintf(
2810
+						__(
2811
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
2812
+							"event_espresso"
2813
+						),
2814
+						$action,
2815
+						$this->_get_class_name(),
2816
+						$index_name,
2817
+						implode(",", $index->field_names()),
2818
+						http_build_query($uniqueness_where_params)
2819
+					),
2820
+					__FILE__,
2821
+					__FUNCTION__,
2822
+					__LINE__
2823
+				);
2824
+				return false;
2825
+			}
2826
+		}
2827
+		return true;
2828
+	}
2829
+
2830
+
2831
+
2832
+	/**
2833
+	 * Checks the database for an item that conflicts (ie, if this item were
2834
+	 * saved to the DB would break some uniqueness requirement, like a primary key
2835
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
2836
+	 * can be either an EE_Base_Class or an array of fields n values
2837
+	 *
2838
+	 * @param EE_Base_Class|array $obj_or_fields_array
2839
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
2840
+	 *                                                 when looking for conflicts
2841
+	 *                                                 (ie, if false, we ignore the model object's primary key
2842
+	 *                                                 when finding "conflicts". If true, it's also considered).
2843
+	 *                                                 Only works for INT primary key,
2844
+	 *                                                 STRING primary keys cannot be ignored
2845
+	 * @throws EE_Error
2846
+	 * @return EE_Base_Class|array
2847
+	 */
2848
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
2849
+	{
2850
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
2851
+			$fields_n_values = $obj_or_fields_array->model_field_array();
2852
+		} elseif (is_array($obj_or_fields_array)) {
2853
+			$fields_n_values = $obj_or_fields_array;
2854
+		} else {
2855
+			throw new EE_Error(
2856
+				sprintf(
2857
+					__(
2858
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
2859
+						"event_espresso"
2860
+					),
2861
+					get_class($this),
2862
+					$obj_or_fields_array
2863
+				)
2864
+			);
2865
+		}
2866
+		$query_params = array();
2867
+		if ($this->has_primary_key_field()
2868
+			&& ($include_primary_key
2869
+				|| $this->get_primary_key_field()
2870
+				   instanceof
2871
+				   EE_Primary_Key_String_Field)
2872
+			&& isset($fields_n_values[$this->primary_key_name()])
2873
+		) {
2874
+			$query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
2875
+		}
2876
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2877
+			$uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2878
+			$query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2879
+		}
2880
+		//if there is nothing to base this search on, then we shouldn't find anything
2881
+		if (empty($query_params)) {
2882
+			return array();
2883
+		}
2884
+		return $this->get_one($query_params);
2885
+	}
2886
+
2887
+
2888
+
2889
+	/**
2890
+	 * Like count, but is optimized and returns a boolean instead of an int
2891
+	 *
2892
+	 * @param array $query_params
2893
+	 * @return boolean
2894
+	 * @throws EE_Error
2895
+	 */
2896
+	public function exists($query_params)
2897
+	{
2898
+		$query_params['limit'] = 1;
2899
+		return $this->count($query_params) > 0;
2900
+	}
2901
+
2902
+
2903
+
2904
+	/**
2905
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
2906
+	 *
2907
+	 * @param int|string $id
2908
+	 * @return boolean
2909
+	 * @throws EE_Error
2910
+	 */
2911
+	public function exists_by_ID($id)
2912
+	{
2913
+		return $this->exists(
2914
+			array(
2915
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
2916
+				array(
2917
+					$this->primary_key_name() => $id,
2918
+				),
2919
+			)
2920
+		);
2921
+	}
2922
+
2923
+
2924
+
2925
+	/**
2926
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
2927
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
2928
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
2929
+	 * on the main table)
2930
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
2931
+	 * cases where we want to call it directly rather than via insert().
2932
+	 *
2933
+	 * @access   protected
2934
+	 * @param EE_Table_Base $table
2935
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
2936
+	 *                                       float
2937
+	 * @param int           $new_id          for now we assume only int keys
2938
+	 * @throws EE_Error
2939
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
2940
+	 * @return int ID of new row inserted, or FALSE on failure
2941
+	 */
2942
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
2943
+	{
2944
+		global $wpdb;
2945
+		$insertion_col_n_values = array();
2946
+		$format_for_insertion = array();
2947
+		$fields_on_table = $this->_get_fields_for_table($table->get_table_alias());
2948
+		foreach ($fields_on_table as $field_name => $field_obj) {
2949
+			//check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
2950
+			if ($field_obj->is_auto_increment()) {
2951
+				continue;
2952
+			}
2953
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
2954
+			//if the value we want to assign it to is NULL, just don't mention it for the insertion
2955
+			if ($prepared_value !== null) {
2956
+				$insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
2957
+				$format_for_insertion[] = $field_obj->get_wpdb_data_type();
2958
+			}
2959
+		}
2960
+		if ($table instanceof EE_Secondary_Table && $new_id) {
2961
+			//its not the main table, so we should have already saved the main table's PK which we just inserted
2962
+			//so add the fk to the main table as a column
2963
+			$insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2964
+			$format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2965
+		}
2966
+		//insert the new entry
2967
+		$result = $this->_do_wpdb_query('insert',
2968
+			array($table->get_table_name(), $insertion_col_n_values, $format_for_insertion));
2969
+		if ($result === false) {
2970
+			return false;
2971
+		}
2972
+		//ok, now what do we return for the ID of the newly-inserted thing?
2973
+		if ($this->has_primary_key_field()) {
2974
+			if ($this->get_primary_key_field()->is_auto_increment()) {
2975
+				return $wpdb->insert_id;
2976
+			}
2977
+			//it's not an auto-increment primary key, so
2978
+			//it must have been supplied
2979
+			return $fields_n_values[$this->get_primary_key_field()->get_name()];
2980
+		}
2981
+		//we can't return a  primary key because there is none. instead return
2982
+		//a unique string indicating this model
2983
+		return $this->get_index_primary_key_string($fields_n_values);
2984
+	}
2985
+
2986
+
2987
+
2988
+	/**
2989
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
2990
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
2991
+	 * and there is no default, we pass it along. WPDB will take care of it)
2992
+	 *
2993
+	 * @param EE_Model_Field_Base $field_obj
2994
+	 * @param array               $fields_n_values
2995
+	 * @return mixed string|int|float depending on what the table column will be expecting
2996
+	 * @throws EE_Error
2997
+	 */
2998
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
2999
+	{
3000
+		//if this field doesn't allow nullable, don't allow it
3001
+		if (
3002
+			! $field_obj->is_nullable()
3003
+			&& (
3004
+				! isset($fields_n_values[$field_obj->get_name()])
3005
+				|| $fields_n_values[$field_obj->get_name()] === null
3006
+			)
3007
+		) {
3008
+			$fields_n_values[$field_obj->get_name()] = $field_obj->get_default_value();
3009
+		}
3010
+		$unprepared_value = isset($fields_n_values[$field_obj->get_name()])
3011
+			? $fields_n_values[$field_obj->get_name()]
3012
+			: null;
3013
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
3014
+	}
3015
+
3016
+
3017
+
3018
+	/**
3019
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
3020
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
3021
+	 * the field's prepare_for_set() method.
3022
+	 *
3023
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
3024
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
3025
+	 *                                   top of file)
3026
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
3027
+	 *                                   $value is a custom selection
3028
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
3029
+	 */
3030
+	private function _prepare_value_for_use_in_db($value, $field)
3031
+	{
3032
+		if ($field && $field instanceof EE_Model_Field_Base) {
3033
+			switch ($this->_values_already_prepared_by_model_object) {
3034
+				/** @noinspection PhpMissingBreakStatementInspection */
3035
+				case self::not_prepared_by_model_object:
3036
+					$value = $field->prepare_for_set($value);
3037
+				//purposefully left out "return"
3038
+				case self::prepared_by_model_object:
3039
+					/** @noinspection SuspiciousAssignmentsInspection */
3040
+					$value = $field->prepare_for_use_in_db($value);
3041
+				case self::prepared_for_use_in_db:
3042
+					//leave the value alone
3043
+			}
3044
+			return $value;
3045
+		}
3046
+		return $value;
3047
+	}
3048
+
3049
+
3050
+
3051
+	/**
3052
+	 * Returns the main table on this model
3053
+	 *
3054
+	 * @return EE_Primary_Table
3055
+	 * @throws EE_Error
3056
+	 */
3057
+	protected function _get_main_table()
3058
+	{
3059
+		foreach ($this->_tables as $table) {
3060
+			if ($table instanceof EE_Primary_Table) {
3061
+				return $table;
3062
+			}
3063
+		}
3064
+		throw new EE_Error(sprintf(__('There are no main tables on %s. They should be added to _tables array in the constructor',
3065
+			'event_espresso'), get_class($this)));
3066
+	}
3067
+
3068
+
3069
+
3070
+	/**
3071
+	 * table
3072
+	 * returns EE_Primary_Table table name
3073
+	 *
3074
+	 * @return string
3075
+	 * @throws EE_Error
3076
+	 */
3077
+	public function table()
3078
+	{
3079
+		return $this->_get_main_table()->get_table_name();
3080
+	}
3081
+
3082
+
3083
+
3084
+	/**
3085
+	 * table
3086
+	 * returns first EE_Secondary_Table table name
3087
+	 *
3088
+	 * @return string
3089
+	 */
3090
+	public function second_table()
3091
+	{
3092
+		// grab second table from tables array
3093
+		$second_table = end($this->_tables);
3094
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
3095
+	}
3096
+
3097
+
3098
+
3099
+	/**
3100
+	 * get_table_obj_by_alias
3101
+	 * returns table name given it's alias
3102
+	 *
3103
+	 * @param string $table_alias
3104
+	 * @return EE_Primary_Table | EE_Secondary_Table
3105
+	 */
3106
+	public function get_table_obj_by_alias($table_alias = '')
3107
+	{
3108
+		return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
3109
+	}
3110
+
3111
+
3112
+
3113
+	/**
3114
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
3115
+	 *
3116
+	 * @return EE_Secondary_Table[]
3117
+	 */
3118
+	protected function _get_other_tables()
3119
+	{
3120
+		$other_tables = array();
3121
+		foreach ($this->_tables as $table_alias => $table) {
3122
+			if ($table instanceof EE_Secondary_Table) {
3123
+				$other_tables[$table_alias] = $table;
3124
+			}
3125
+		}
3126
+		return $other_tables;
3127
+	}
3128
+
3129
+
3130
+
3131
+	/**
3132
+	 * Finds all the fields that correspond to the given table
3133
+	 *
3134
+	 * @param string $table_alias , array key in EEM_Base::_tables
3135
+	 * @return EE_Model_Field_Base[]
3136
+	 */
3137
+	public function _get_fields_for_table($table_alias)
3138
+	{
3139
+		return $this->_fields[$table_alias];
3140
+	}
3141
+
3142
+
3143
+
3144
+	/**
3145
+	 * Recurses through all the where parameters, and finds all the related models we'll need
3146
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
3147
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
3148
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
3149
+	 * related Registration, Transaction, and Payment models.
3150
+	 *
3151
+	 * @param array $query_params like EEM_Base::get_all's $query_parameters['where']
3152
+	 * @return EE_Model_Query_Info_Carrier
3153
+	 * @throws EE_Error
3154
+	 */
3155
+	public function _extract_related_models_from_query($query_params)
3156
+	{
3157
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
3158
+		if (array_key_exists(0, $query_params)) {
3159
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
3160
+		}
3161
+		if (array_key_exists('group_by', $query_params)) {
3162
+			if (is_array($query_params['group_by'])) {
3163
+				$this->_extract_related_models_from_sub_params_array_values(
3164
+					$query_params['group_by'],
3165
+					$query_info_carrier,
3166
+					'group_by'
3167
+				);
3168
+			} elseif (! empty ($query_params['group_by'])) {
3169
+				$this->_extract_related_model_info_from_query_param(
3170
+					$query_params['group_by'],
3171
+					$query_info_carrier,
3172
+					'group_by'
3173
+				);
3174
+			}
3175
+		}
3176
+		if (array_key_exists('having', $query_params)) {
3177
+			$this->_extract_related_models_from_sub_params_array_keys(
3178
+				$query_params[0],
3179
+				$query_info_carrier,
3180
+				'having'
3181
+			);
3182
+		}
3183
+		if (array_key_exists('order_by', $query_params)) {
3184
+			if (is_array($query_params['order_by'])) {
3185
+				$this->_extract_related_models_from_sub_params_array_keys(
3186
+					$query_params['order_by'],
3187
+					$query_info_carrier,
3188
+					'order_by'
3189
+				);
3190
+			} elseif (! empty($query_params['order_by'])) {
3191
+				$this->_extract_related_model_info_from_query_param(
3192
+					$query_params['order_by'],
3193
+					$query_info_carrier,
3194
+					'order_by'
3195
+				);
3196
+			}
3197
+		}
3198
+		if (array_key_exists('force_join', $query_params)) {
3199
+			$this->_extract_related_models_from_sub_params_array_values(
3200
+				$query_params['force_join'],
3201
+				$query_info_carrier,
3202
+				'force_join'
3203
+			);
3204
+		}
3205
+		return $query_info_carrier;
3206
+	}
3207
+
3208
+
3209
+
3210
+	/**
3211
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
3212
+	 *
3213
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3214
+	 *                                                      $query_params['having']
3215
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3216
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3217
+	 * @throws EE_Error
3218
+	 * @return \EE_Model_Query_Info_Carrier
3219
+	 */
3220
+	private function _extract_related_models_from_sub_params_array_keys(
3221
+		$sub_query_params,
3222
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3223
+		$query_param_type
3224
+	) {
3225
+		if (! empty($sub_query_params)) {
3226
+			$sub_query_params = (array)$sub_query_params;
3227
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
3228
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3229
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3230
+					$query_param_type);
3231
+				//if $possibly_array_of_params is an array, try recursing into it, searching for keys which
3232
+				//indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
3233
+				//extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
3234
+				//of array('Registration.TXN_ID'=>23)
3235
+				$query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3236
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3237
+					if (! is_array($possibly_array_of_params)) {
3238
+						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'))",
3239
+							"event_espresso"),
3240
+							$param, $possibly_array_of_params));
3241
+					}
3242
+					$this->_extract_related_models_from_sub_params_array_keys(
3243
+						$possibly_array_of_params,
3244
+						$model_query_info_carrier, $query_param_type
3245
+					);
3246
+				} elseif ($query_param_type === 0 //ie WHERE
3247
+						  && is_array($possibly_array_of_params)
3248
+						  && isset($possibly_array_of_params[2])
3249
+						  && $possibly_array_of_params[2] == true
3250
+				) {
3251
+					//then $possible_array_of_params looks something like array('<','DTT_sold',true)
3252
+					//indicating that $possible_array_of_params[1] is actually a field name,
3253
+					//from which we should extract query parameters!
3254
+					if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3255
+						throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3256
+							"event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3257
+					}
3258
+					$this->_extract_related_model_info_from_query_param($possibly_array_of_params[1],
3259
+						$model_query_info_carrier, $query_param_type);
3260
+				}
3261
+			}
3262
+		}
3263
+		return $model_query_info_carrier;
3264
+	}
3265
+
3266
+
3267
+
3268
+	/**
3269
+	 * For extracting related models from forced_joins, where the array values contain the info about what
3270
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
3271
+	 *
3272
+	 * @param array                       $sub_query_params like EEM_Base::get_all's $query_params[0] or
3273
+	 *                                                      $query_params['having']
3274
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
3275
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
3276
+	 * @throws EE_Error
3277
+	 * @return \EE_Model_Query_Info_Carrier
3278
+	 */
3279
+	private function _extract_related_models_from_sub_params_array_values(
3280
+		$sub_query_params,
3281
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
3282
+		$query_param_type
3283
+	) {
3284
+		if (! empty($sub_query_params)) {
3285
+			if (! is_array($sub_query_params)) {
3286
+				throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3287
+					$sub_query_params));
3288
+			}
3289
+			foreach ($sub_query_params as $param) {
3290
+				//$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3291
+				$this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
3292
+					$query_param_type);
3293
+			}
3294
+		}
3295
+		return $model_query_info_carrier;
3296
+	}
3297
+
3298
+
3299
+
3300
+	/**
3301
+	 * Extract all the query parts from $query_params (an array like whats passed to EEM_Base::get_all)
3302
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
3303
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
3304
+	 * but use them in a different order. Eg, we need to know what models we are querying
3305
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
3306
+	 * other models before we can finalize the where clause SQL.
3307
+	 *
3308
+	 * @param array $query_params
3309
+	 * @throws EE_Error
3310
+	 * @return EE_Model_Query_Info_Carrier
3311
+	 */
3312
+	public function _create_model_query_info_carrier($query_params)
3313
+	{
3314
+		if (! is_array($query_params)) {
3315
+			EE_Error::doing_it_wrong(
3316
+				'EEM_Base::_create_model_query_info_carrier',
3317
+				sprintf(
3318
+					__(
3319
+						'$query_params should be an array, you passed a variable of type %s',
3320
+						'event_espresso'
3321
+					),
3322
+					gettype($query_params)
3323
+				),
3324
+				'4.6.0'
3325
+			);
3326
+			$query_params = array();
3327
+		}
3328
+		$where_query_params = isset($query_params[0]) ? $query_params[0] : array();
3329
+		//first check if we should alter the query to account for caps or not
3330
+		//because the caps might require us to do extra joins
3331
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
3332
+			$query_params[0] = $where_query_params = array_replace_recursive(
3333
+				$where_query_params,
3334
+				$this->caps_where_conditions(
3335
+					$query_params['caps']
3336
+				)
3337
+			);
3338
+		}
3339
+		$query_object = $this->_extract_related_models_from_query($query_params);
3340
+		//verify where_query_params has NO numeric indexes.... that's simply not how you use it!
3341
+		foreach ($where_query_params as $key => $value) {
3342
+			if (is_int($key)) {
3343
+				throw new EE_Error(
3344
+					sprintf(
3345
+						__(
3346
+							"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.",
3347
+							"event_espresso"
3348
+						),
3349
+						$key,
3350
+						var_export($value, true),
3351
+						var_export($query_params, true),
3352
+						get_class($this)
3353
+					)
3354
+				);
3355
+			}
3356
+		}
3357
+		if (
3358
+			array_key_exists('default_where_conditions', $query_params)
3359
+			&& ! empty($query_params['default_where_conditions'])
3360
+		) {
3361
+			$use_default_where_conditions = $query_params['default_where_conditions'];
3362
+		} else {
3363
+			$use_default_where_conditions = EEM_Base::default_where_conditions_all;
3364
+		}
3365
+		$where_query_params = array_merge(
3366
+			$this->_get_default_where_conditions_for_models_in_query(
3367
+				$query_object,
3368
+				$use_default_where_conditions,
3369
+				$where_query_params
3370
+			),
3371
+			$where_query_params
3372
+		);
3373
+		$query_object->set_where_sql($this->_construct_where_clause($where_query_params));
3374
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
3375
+		// So we need to setup a subquery and use that for the main join.
3376
+		// Note for now this only works on the primary table for the model.
3377
+		// So for instance, you could set the limit array like this:
3378
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
3379
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
3380
+			$query_object->set_main_model_join_sql(
3381
+				$this->_construct_limit_join_select(
3382
+					$query_params['on_join_limit'][0],
3383
+					$query_params['on_join_limit'][1]
3384
+				)
3385
+			);
3386
+		}
3387
+		//set limit
3388
+		if (array_key_exists('limit', $query_params)) {
3389
+			if (is_array($query_params['limit'])) {
3390
+				if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3391
+					$e = sprintf(
3392
+						__(
3393
+							"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)",
3394
+							"event_espresso"
3395
+						),
3396
+						http_build_query($query_params['limit'])
3397
+					);
3398
+					throw new EE_Error($e . "|" . $e);
3399
+				}
3400
+				//they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3401
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3402
+			} elseif (! empty ($query_params['limit'])) {
3403
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3404
+			}
3405
+		}
3406
+		//set order by
3407
+		if (array_key_exists('order_by', $query_params)) {
3408
+			if (is_array($query_params['order_by'])) {
3409
+				//if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
3410
+				//specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
3411
+				//including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
3412
+				if (array_key_exists('order', $query_params)) {
3413
+					throw new EE_Error(
3414
+						sprintf(
3415
+							__(
3416
+								"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 ",
3417
+								"event_espresso"
3418
+							),
3419
+							get_class($this),
3420
+							implode(", ", array_keys($query_params['order_by'])),
3421
+							implode(", ", $query_params['order_by']),
3422
+							$query_params['order']
3423
+						)
3424
+					);
3425
+				}
3426
+				$this->_extract_related_models_from_sub_params_array_keys(
3427
+					$query_params['order_by'],
3428
+					$query_object,
3429
+					'order_by'
3430
+				);
3431
+				//assume it's an array of fields to order by
3432
+				$order_array = array();
3433
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3434
+					$order = $this->_extract_order($order);
3435
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3436
+				}
3437
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3438
+			} elseif (! empty ($query_params['order_by'])) {
3439
+				$this->_extract_related_model_info_from_query_param(
3440
+					$query_params['order_by'],
3441
+					$query_object,
3442
+					'order',
3443
+					$query_params['order_by']
3444
+				);
3445
+				$order = isset($query_params['order'])
3446
+					? $this->_extract_order($query_params['order'])
3447
+					: 'DESC';
3448
+				$query_object->set_order_by_sql(
3449
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3450
+				);
3451
+			}
3452
+		}
3453
+		//if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3454
+		if (! array_key_exists('order_by', $query_params)
3455
+			&& array_key_exists('order', $query_params)
3456
+			&& ! empty($query_params['order'])
3457
+		) {
3458
+			$pk_field = $this->get_primary_key_field();
3459
+			$order = $this->_extract_order($query_params['order']);
3460
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3461
+		}
3462
+		//set group by
3463
+		if (array_key_exists('group_by', $query_params)) {
3464
+			if (is_array($query_params['group_by'])) {
3465
+				//it's an array, so assume we'll be grouping by a bunch of stuff
3466
+				$group_by_array = array();
3467
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
3468
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3469
+				}
3470
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3471
+			} elseif (! empty ($query_params['group_by'])) {
3472
+				$query_object->set_group_by_sql(
3473
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3474
+				);
3475
+			}
3476
+		}
3477
+		//set having
3478
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
3479
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
3480
+		}
3481
+		//now, just verify they didn't pass anything wack
3482
+		foreach ($query_params as $query_key => $query_value) {
3483
+			if (! in_array($query_key, $this->_allowed_query_params, true)) {
3484
+				throw new EE_Error(
3485
+					sprintf(
3486
+						__(
3487
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
3488
+							'event_espresso'
3489
+						),
3490
+						$query_key,
3491
+						get_class($this),
3492
+						//						print_r( $this->_allowed_query_params, TRUE )
3493
+						implode(',', $this->_allowed_query_params)
3494
+					)
3495
+				);
3496
+			}
3497
+		}
3498
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
3499
+		if (empty($main_model_join_sql)) {
3500
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
3501
+		}
3502
+		return $query_object;
3503
+	}
3504
+
3505
+
3506
+
3507
+	/**
3508
+	 * Gets the where conditions that should be imposed on the query based on the
3509
+	 * context (eg reading frontend, backend, edit or delete).
3510
+	 *
3511
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
3512
+	 * @return array like EEM_Base::get_all() 's $query_params[0]
3513
+	 * @throws EE_Error
3514
+	 */
3515
+	public function caps_where_conditions($context = self::caps_read)
3516
+	{
3517
+		EEM_Base::verify_is_valid_cap_context($context);
3518
+		$cap_where_conditions = array();
3519
+		$cap_restrictions = $this->caps_missing($context);
3520
+		/**
3521
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
3522
+		 */
3523
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
3524
+			$cap_where_conditions = array_replace_recursive($cap_where_conditions,
3525
+				$restriction_if_no_cap->get_default_where_conditions());
3526
+		}
3527
+		return apply_filters('FHEE__EEM_Base__caps_where_conditions__return', $cap_where_conditions, $this, $context,
3528
+			$cap_restrictions);
3529
+	}
3530
+
3531
+
3532
+
3533
+	/**
3534
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
3535
+	 * otherwise throws an exception
3536
+	 *
3537
+	 * @param string $should_be_order_string
3538
+	 * @return string either ASC, asc, DESC or desc
3539
+	 * @throws EE_Error
3540
+	 */
3541
+	private function _extract_order($should_be_order_string)
3542
+	{
3543
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
3544
+			return $should_be_order_string;
3545
+		}
3546
+		throw new EE_Error(
3547
+			sprintf(
3548
+				__(
3549
+					"While performing a query on '%s', tried to use '%s' as an order parameter. ",
3550
+					"event_espresso"
3551
+				), get_class($this), $should_be_order_string
3552
+			)
3553
+		);
3554
+	}
3555
+
3556
+
3557
+
3558
+	/**
3559
+	 * Looks at all the models which are included in this query, and asks each
3560
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
3561
+	 * so they can be merged
3562
+	 *
3563
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
3564
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
3565
+	 *                                                                  'none' means NO default where conditions will
3566
+	 *                                                                  be used AT ALL during this query.
3567
+	 *                                                                  'other_models_only' means default where
3568
+	 *                                                                  conditions from other models will be used, but
3569
+	 *                                                                  not for this primary model. 'all', the default,
3570
+	 *                                                                  means default where conditions will apply as
3571
+	 *                                                                  normal
3572
+	 * @param array                       $where_query_params           like EEM_Base::get_all's $query_params[0]
3573
+	 * @throws EE_Error
3574
+	 * @return array like $query_params[0], see EEM_Base::get_all for documentation
3575
+	 */
3576
+	private function _get_default_where_conditions_for_models_in_query(
3577
+		EE_Model_Query_Info_Carrier $query_info_carrier,
3578
+		$use_default_where_conditions = EEM_Base::default_where_conditions_all,
3579
+		$where_query_params = array()
3580
+	) {
3581
+		$allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3582
+		if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3583
+			throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3584
+				"event_espresso"), $use_default_where_conditions,
3585
+				implode(", ", $allowed_used_default_where_conditions_values)));
3586
+		}
3587
+		$universal_query_params = array();
3588
+		if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3589
+			$universal_query_params = $this->_get_default_where_conditions();
3590
+		} else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3591
+			$universal_query_params = $this->_get_minimum_where_conditions();
3592
+		}
3593
+		foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3594
+			$related_model = $this->get_related_model_obj($model_name);
3595
+			if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3596
+				$related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3597
+			} elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3598
+				$related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3599
+			} else {
3600
+				//we don't want to add full or even minimum default where conditions from this model, so just continue
3601
+				continue;
3602
+			}
3603
+			$overrides = $this->_override_defaults_or_make_null_friendly(
3604
+				$related_model_universal_where_params,
3605
+				$where_query_params,
3606
+				$related_model,
3607
+				$model_relation_path
3608
+			);
3609
+			$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
3610
+				$universal_query_params,
3611
+				$overrides
3612
+			);
3613
+		}
3614
+		return $universal_query_params;
3615
+	}
3616
+
3617
+
3618
+
3619
+	/**
3620
+	 * Determines whether or not we should use default where conditions for the model in question
3621
+	 * (this model, or other related models).
3622
+	 * Basically, we should use default where conditions on this model if they have requested to use them on all models,
3623
+	 * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
3624
+	 * We should use default where conditions on related models when they requested to use default where conditions
3625
+	 * on all models, or specifically just on other related models
3626
+	 * @param      $default_where_conditions_value
3627
+	 * @param bool $for_this_model false means this is for OTHER related models
3628
+	 * @return bool
3629
+	 */
3630
+	private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3631
+	{
3632
+		return (
3633
+				   $for_this_model
3634
+				   && in_array(
3635
+					   $default_where_conditions_value,
3636
+					   array(
3637
+						   EEM_Base::default_where_conditions_all,
3638
+						   EEM_Base::default_where_conditions_this_only,
3639
+						   EEM_Base::default_where_conditions_minimum_others,
3640
+					   ),
3641
+					   true
3642
+				   )
3643
+			   )
3644
+			   || (
3645
+				   ! $for_this_model
3646
+				   && in_array(
3647
+					   $default_where_conditions_value,
3648
+					   array(
3649
+						   EEM_Base::default_where_conditions_all,
3650
+						   EEM_Base::default_where_conditions_others_only,
3651
+					   ),
3652
+					   true
3653
+				   )
3654
+			   );
3655
+	}
3656
+
3657
+	/**
3658
+	 * Determines whether or not we should use default minimum conditions for the model in question
3659
+	 * (this model, or other related models).
3660
+	 * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
3661
+	 * where conditions.
3662
+	 * We should use minimum where conditions on related models if they requested to use minimum where conditions
3663
+	 * on this model or others
3664
+	 * @param      $default_where_conditions_value
3665
+	 * @param bool $for_this_model false means this is for OTHER related models
3666
+	 * @return bool
3667
+	 */
3668
+	private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
3669
+	{
3670
+		return (
3671
+				   $for_this_model
3672
+				   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
3673
+			   )
3674
+			   || (
3675
+				   ! $for_this_model
3676
+				   && in_array(
3677
+					   $default_where_conditions_value,
3678
+					   array(
3679
+						   EEM_Base::default_where_conditions_minimum_others,
3680
+						   EEM_Base::default_where_conditions_minimum_all,
3681
+					   ),
3682
+					   true
3683
+				   )
3684
+			   );
3685
+	}
3686
+
3687
+
3688
+	/**
3689
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
3690
+	 * then we also add a special where condition which allows for that model's primary key
3691
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
3692
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
3693
+	 *
3694
+	 * @param array    $default_where_conditions
3695
+	 * @param array    $provided_where_conditions
3696
+	 * @param EEM_Base $model
3697
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
3698
+	 * @return array like EEM_Base::get_all's $query_params[0]
3699
+	 * @throws EE_Error
3700
+	 */
3701
+	private function _override_defaults_or_make_null_friendly(
3702
+		$default_where_conditions,
3703
+		$provided_where_conditions,
3704
+		$model,
3705
+		$model_relation_path
3706
+	) {
3707
+		$null_friendly_where_conditions = array();
3708
+		$none_overridden = true;
3709
+		$or_condition_key_for_defaults = 'OR*' . get_class($model);
3710
+		foreach ($default_where_conditions as $key => $val) {
3711
+			if (isset($provided_where_conditions[$key])) {
3712
+				$none_overridden = false;
3713
+			} else {
3714
+				$null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
3715
+			}
3716
+		}
3717
+		if ($none_overridden && $default_where_conditions) {
3718
+			if ($model->has_primary_key_field()) {
3719
+				$null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
3720
+																				. "."
3721
+																				. $model->primary_key_name()] = array('IS NULL');
3722
+			}/*else{
3723 3723
 				//@todo NO PK, use other defaults
3724 3724
 			}*/
3725
-        }
3726
-        return $null_friendly_where_conditions;
3727
-    }
3728
-
3729
-
3730
-
3731
-    /**
3732
-     * Uses the _default_where_conditions_strategy set during __construct() to get
3733
-     * default where conditions on all get_all, update, and delete queries done by this model.
3734
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3735
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3736
-     *
3737
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3738
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3739
-     */
3740
-    private function _get_default_where_conditions($model_relation_path = null)
3741
-    {
3742
-        if ($this->_ignore_where_strategy) {
3743
-            return array();
3744
-        }
3745
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3746
-    }
3747
-
3748
-
3749
-
3750
-    /**
3751
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
3752
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
3753
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3754
-     * NOT array('Event_CPT.post_type'=>'esp_event').
3755
-     * Similar to _get_default_where_conditions
3756
-     *
3757
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3758
-     * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3759
-     */
3760
-    protected function _get_minimum_where_conditions($model_relation_path = null)
3761
-    {
3762
-        if ($this->_ignore_where_strategy) {
3763
-            return array();
3764
-        }
3765
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3766
-    }
3767
-
3768
-
3769
-
3770
-    /**
3771
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3772
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3773
-     *
3774
-     * @param EE_Model_Query_Info_Carrier $model_query_info
3775
-     * @return string
3776
-     * @throws EE_Error
3777
-     */
3778
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3779
-    {
3780
-        $selects = $this->_get_columns_to_select_for_this_model();
3781
-        foreach (
3782
-            $model_query_info->get_model_names_included() as $model_relation_chain =>
3783
-            $name_of_other_model_included
3784
-        ) {
3785
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3786
-            $other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3787
-            foreach ($other_model_selects as $key => $value) {
3788
-                $selects[] = $value;
3789
-            }
3790
-        }
3791
-        return implode(", ", $selects);
3792
-    }
3793
-
3794
-
3795
-
3796
-    /**
3797
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3798
-     * So that's going to be the columns for all the fields on the model
3799
-     *
3800
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
3801
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3802
-     */
3803
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3804
-    {
3805
-        $fields = $this->field_settings();
3806
-        $selects = array();
3807
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3808
-            $this->get_this_model_name());
3809
-        foreach ($fields as $field_obj) {
3810
-            $selects[] = $table_alias_with_model_relation_chain_prefix
3811
-                         . $field_obj->get_table_alias()
3812
-                         . "."
3813
-                         . $field_obj->get_table_column()
3814
-                         . " AS '"
3815
-                         . $table_alias_with_model_relation_chain_prefix
3816
-                         . $field_obj->get_table_alias()
3817
-                         . "."
3818
-                         . $field_obj->get_table_column()
3819
-                         . "'";
3820
-        }
3821
-        //make sure we are also getting the PKs of each table
3822
-        $tables = $this->get_tables();
3823
-        if (count($tables) > 1) {
3824
-            foreach ($tables as $table_obj) {
3825
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3826
-                                       . $table_obj->get_fully_qualified_pk_column();
3827
-                if (! in_array($qualified_pk_column, $selects)) {
3828
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3829
-                }
3830
-            }
3831
-        }
3832
-        return $selects;
3833
-    }
3834
-
3835
-
3836
-
3837
-    /**
3838
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3839
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3840
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3841
-     * SQL for joining, and the data types
3842
-     *
3843
-     * @param null|string                 $original_query_param
3844
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
3845
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3846
-     * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3847
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3848
-     *                                                          column name. We only want model names, eg 'Event.Venue'
3849
-     *                                                          or 'Registration's
3850
-     * @param string                      $original_query_param what it originally was (eg
3851
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3852
-     *                                                          matches $query_param
3853
-     * @throws EE_Error
3854
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3855
-     */
3856
-    private function _extract_related_model_info_from_query_param(
3857
-        $query_param,
3858
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3859
-        $query_param_type,
3860
-        $original_query_param = null
3861
-    ) {
3862
-        if ($original_query_param === null) {
3863
-            $original_query_param = $query_param;
3864
-        }
3865
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3866
-        /** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3867
-        $allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3868
-        $allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3869
-        //check to see if we have a field on this model
3870
-        $this_model_fields = $this->field_settings(true);
3871
-        if (array_key_exists($query_param, $this_model_fields)) {
3872
-            if ($allow_fields) {
3873
-                return;
3874
-            }
3875
-            throw new EE_Error(
3876
-                sprintf(
3877
-                    __(
3878
-                        "Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3879
-                        "event_espresso"
3880
-                    ),
3881
-                    $query_param, get_class($this), $query_param_type, $original_query_param
3882
-                )
3883
-            );
3884
-        }
3885
-        //check if this is a special logic query param
3886
-        if (in_array($query_param, $this->_logic_query_param_keys, true)) {
3887
-            if ($allow_logic_query_params) {
3888
-                return;
3889
-            }
3890
-            throw new EE_Error(
3891
-                sprintf(
3892
-                    __(
3893
-                        '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',
3894
-                        'event_espresso'
3895
-                    ),
3896
-                    implode('", "', $this->_logic_query_param_keys),
3897
-                    $query_param,
3898
-                    get_class($this),
3899
-                    '<br />',
3900
-                    "\t"
3901
-                    . ' $passed_in_query_info = <pre>'
3902
-                    . print_r($passed_in_query_info, true)
3903
-                    . '</pre>'
3904
-                    . "\n\t"
3905
-                    . ' $query_param_type = '
3906
-                    . $query_param_type
3907
-                    . "\n\t"
3908
-                    . ' $original_query_param = '
3909
-                    . $original_query_param
3910
-                )
3911
-            );
3912
-        }
3913
-        //check if it's a custom selection
3914
-        if (array_key_exists($query_param, $this->_custom_selections)) {
3915
-            return;
3916
-        }
3917
-        //check if has a model name at the beginning
3918
-        //and
3919
-        //check if it's a field on a related model
3920
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3921
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3922
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3923
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3924
-                if ($query_param === '') {
3925
-                    //nothing left to $query_param
3926
-                    //we should actually end in a field name, not a model like this!
3927
-                    throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3928
-                        "event_espresso"),
3929
-                        $query_param, $query_param_type, get_class($this), $valid_related_model_name));
3930
-                }
3931
-                $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3932
-                $related_model_obj->_extract_related_model_info_from_query_param(
3933
-                    $query_param,
3934
-                    $passed_in_query_info, $query_param_type, $original_query_param
3935
-                );
3936
-                return;
3937
-            }
3938
-            if ($query_param === $valid_related_model_name) {
3939
-                $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3940
-                return;
3941
-            }
3942
-        }
3943
-        //ok so $query_param didn't start with a model name
3944
-        //and we previously confirmed it wasn't a logic query param or field on the current model
3945
-        //it's wack, that's what it is
3946
-        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",
3947
-            "event_espresso"),
3948
-            $query_param, get_class($this), $query_param_type, $original_query_param));
3949
-    }
3950
-
3951
-
3952
-
3953
-    /**
3954
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3955
-     * and store it on $passed_in_query_info
3956
-     *
3957
-     * @param string                      $model_name
3958
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3959
-     * @param string                      $original_query_param used to extract the relation chain between the queried
3960
-     *                                                          model and $model_name. Eg, if we are querying Event,
3961
-     *                                                          and are adding a join to 'Payment' with the original
3962
-     *                                                          query param key
3963
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3964
-     *                                                          to extract 'Registration.Transaction.Payment', in case
3965
-     *                                                          Payment wants to add default query params so that it
3966
-     *                                                          will know what models to prepend onto its default query
3967
-     *                                                          params or in case it wants to rename tables (in case
3968
-     *                                                          there are multiple joins to the same table)
3969
-     * @return void
3970
-     * @throws EE_Error
3971
-     */
3972
-    private function _add_join_to_model(
3973
-        $model_name,
3974
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
3975
-        $original_query_param
3976
-    ) {
3977
-        $relation_obj = $this->related_settings_for($model_name);
3978
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3979
-        //check if the relation is HABTM, because then we're essentially doing two joins
3980
-        //If so, join first to the JOIN table, and add its data types, and then continue as normal
3981
-        if ($relation_obj instanceof EE_HABTM_Relation) {
3982
-            $join_model_obj = $relation_obj->get_join_model();
3983
-            //replace the model specified with the join model for this relation chain, whi
3984
-            $relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3985
-                $join_model_obj->get_this_model_name(), $model_relation_chain);
3986
-            $new_query_info = new EE_Model_Query_Info_Carrier(
3987
-                array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3988
-                $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3989
-            $passed_in_query_info->merge($new_query_info);
3990
-        }
3991
-        //now just join to the other table pointed to by the relation object, and add its data types
3992
-        $new_query_info = new EE_Model_Query_Info_Carrier(
3993
-            array($model_relation_chain => $model_name),
3994
-            $relation_obj->get_join_statement($model_relation_chain));
3995
-        $passed_in_query_info->merge($new_query_info);
3996
-    }
3997
-
3998
-
3999
-
4000
-    /**
4001
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
4002
-     *
4003
-     * @param array $where_params like EEM_Base::get_all
4004
-     * @return string of SQL
4005
-     * @throws EE_Error
4006
-     */
4007
-    private function _construct_where_clause($where_params)
4008
-    {
4009
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
4010
-        if ($SQL) {
4011
-            return " WHERE " . $SQL;
4012
-        }
4013
-        return '';
4014
-    }
4015
-
4016
-
4017
-
4018
-    /**
4019
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
4020
-     * and should be passed HAVING parameters, not WHERE parameters
4021
-     *
4022
-     * @param array $having_params
4023
-     * @return string
4024
-     * @throws EE_Error
4025
-     */
4026
-    private function _construct_having_clause($having_params)
4027
-    {
4028
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
4029
-        if ($SQL) {
4030
-            return " HAVING " . $SQL;
4031
-        }
4032
-        return '';
4033
-    }
4034
-
4035
-
4036
-
4037
-    /**
4038
-     * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
4039
-     * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
4040
-     * EEM_Attendee.
4041
-     *
4042
-     * @param string $field_name
4043
-     * @param string $model_name
4044
-     * @return EE_Model_Field_Base
4045
-     * @throws EE_Error
4046
-     */
4047
-    protected function _get_field_on_model($field_name, $model_name)
4048
-    {
4049
-        $model_class = 'EEM_' . $model_name;
4050
-        $model_filepath = $model_class . ".model.php";
4051
-        if (is_readable($model_filepath)) {
4052
-            require_once($model_filepath);
4053
-            $model_instance = call_user_func($model_name . "::instance");
4054
-            /* @var $model_instance EEM_Base */
4055
-            return $model_instance->field_settings_for($field_name);
4056
-        }
4057
-        throw new EE_Error(
4058
-            sprintf(
4059
-                __(
4060
-                    'No model named %s exists, with classname %s and filepath %s',
4061
-                    'event_espresso'
4062
-                ), $model_name, $model_class, $model_filepath
4063
-            )
4064
-        );
4065
-    }
4066
-
4067
-
4068
-
4069
-    /**
4070
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
4071
-     * Event_Meta.meta_value = 'foo'))"
4072
-     *
4073
-     * @param array  $where_params see EEM_Base::get_all for documentation
4074
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
4075
-     * @throws EE_Error
4076
-     * @return string of SQL
4077
-     */
4078
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
4079
-    {
4080
-        $where_clauses = array();
4081
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
4082
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
4083
-            if (in_array($query_param, $this->_logic_query_param_keys)) {
4084
-                switch ($query_param) {
4085
-                    case 'not':
4086
-                    case 'NOT':
4087
-                        $where_clauses[] = "! ("
4088
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4089
-                                $glue)
4090
-                                           . ")";
4091
-                        break;
4092
-                    case 'and':
4093
-                    case 'AND':
4094
-                        $where_clauses[] = " ("
4095
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4096
-                                ' AND ')
4097
-                                           . ")";
4098
-                        break;
4099
-                    case 'or':
4100
-                    case 'OR':
4101
-                        $where_clauses[] = " ("
4102
-                                           . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4103
-                                ' OR ')
4104
-                                           . ")";
4105
-                        break;
4106
-                }
4107
-            } else {
4108
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
4109
-                //if it's not a normal field, maybe it's a custom selection?
4110
-                if (! $field_obj) {
4111
-                    if (isset($this->_custom_selections[$query_param][1])) {
4112
-                        $field_obj = $this->_custom_selections[$query_param][1];
4113
-                    } else {
4114
-                        throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
4115
-                            "event_espresso"), $query_param));
4116
-                    }
4117
-                }
4118
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
4119
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
4120
-            }
4121
-        }
4122
-        return $where_clauses ? implode($glue, $where_clauses) : '';
4123
-    }
4124
-
4125
-
4126
-
4127
-    /**
4128
-     * Takes the input parameter and extract the table name (alias) and column name
4129
-     *
4130
-     * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4131
-     * @throws EE_Error
4132
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4133
-     */
4134
-    private function _deduce_column_name_from_query_param($query_param)
4135
-    {
4136
-        $field = $this->_deduce_field_from_query_param($query_param);
4137
-        if ($field) {
4138
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4139
-                $query_param);
4140
-            return $table_alias_prefix . $field->get_qualified_column();
4141
-        }
4142
-        if (array_key_exists($query_param, $this->_custom_selections)) {
4143
-            //maybe it's custom selection item?
4144
-            //if so, just use it as the "column name"
4145
-            return $query_param;
4146
-        }
4147
-        throw new EE_Error(
4148
-            sprintf(
4149
-                __(
4150
-                    "%s is not a valid field on this model, nor a custom selection (%s)",
4151
-                    "event_espresso"
4152
-                ), $query_param, implode(",", $this->_custom_selections)
4153
-            )
4154
-        );
4155
-    }
4156
-
4157
-
4158
-
4159
-    /**
4160
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4161
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4162
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4163
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4164
-     *
4165
-     * @param string $condition_query_param_key
4166
-     * @return string
4167
-     */
4168
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4169
-    {
4170
-        $pos_of_star = strpos($condition_query_param_key, '*');
4171
-        if ($pos_of_star === false) {
4172
-            return $condition_query_param_key;
4173
-        }
4174
-        $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4175
-        return $condition_query_param_sans_star;
4176
-    }
4177
-
4178
-
4179
-
4180
-    /**
4181
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4182
-     *
4183
-     * @param                            mixed      array | string    $op_and_value
4184
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4185
-     * @throws EE_Error
4186
-     * @return string
4187
-     */
4188
-    private function _construct_op_and_value($op_and_value, $field_obj)
4189
-    {
4190
-        if (is_array($op_and_value)) {
4191
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4192
-            if (! $operator) {
4193
-                $php_array_like_string = array();
4194
-                foreach ($op_and_value as $key => $value) {
4195
-                    $php_array_like_string[] = "$key=>$value";
4196
-                }
4197
-                throw new EE_Error(
4198
-                    sprintf(
4199
-                        __(
4200
-                            "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))",
4201
-                            "event_espresso"
4202
-                        ),
4203
-                        implode(",", $php_array_like_string)
4204
-                    )
4205
-                );
4206
-            }
4207
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4208
-        } else {
4209
-            $operator = '=';
4210
-            $value = $op_and_value;
4211
-        }
4212
-        //check to see if the value is actually another field
4213
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4214
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4215
-        }
4216
-        if (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4217
-            //in this case, the value should be an array, or at least a comma-separated list
4218
-            //it will need to handle a little differently
4219
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
4220
-            //note: $cleaned_value has already been run through $wpdb->prepare()
4221
-            return $operator . SP . $cleaned_value;
4222
-        }
4223
-        if (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4224
-            //the value should be an array with count of two.
4225
-            if (count($value) !== 2) {
4226
-                throw new EE_Error(
4227
-                    sprintf(
4228
-                        __(
4229
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4230
-                            'event_espresso'
4231
-                        ),
4232
-                        "BETWEEN"
4233
-                    )
4234
-                );
4235
-            }
4236
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
4237
-            return $operator . SP . $cleaned_value;
4238
-        }
4239
-        if (in_array($operator, $this->_null_style_operators)) {
4240
-            if ($value !== null) {
4241
-                throw new EE_Error(
4242
-                    sprintf(
4243
-                        __(
4244
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4245
-                            "event_espresso"
4246
-                        ),
4247
-                        $value,
4248
-                        $operator
4249
-                    )
4250
-                );
4251
-            }
4252
-            return $operator;
4253
-        }
4254
-        if ($operator === 'LIKE' && ! is_array($value)) {
4255
-            //if the operator is 'LIKE', we want to allow percent signs (%) and not
4256
-            //remove other junk. So just treat it as a string.
4257
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4258
-        }
4259
-        if (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4260
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4261
-        }
4262
-        if (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4263
-            throw new EE_Error(
4264
-                sprintf(
4265
-                    __(
4266
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4267
-                        'event_espresso'
4268
-                    ),
4269
-                    $operator,
4270
-                    $operator
4271
-                )
4272
-            );
4273
-        }
4274
-        if (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4275
-            throw new EE_Error(
4276
-                sprintf(
4277
-                    __(
4278
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4279
-                        'event_espresso'
4280
-                    ),
4281
-                    $operator,
4282
-                    $operator
4283
-                )
4284
-            );
4285
-        }
4286
-        throw new EE_Error(
4287
-            sprintf(
4288
-                __(
4289
-                    "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4290
-                    "event_espresso"
4291
-                ),
4292
-                http_build_query($op_and_value)
4293
-            )
4294
-        );
4295
-    }
4296
-
4297
-
4298
-
4299
-    /**
4300
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4301
-     *
4302
-     * @param array                      $values
4303
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4304
-     *                                              '%s'
4305
-     * @return string
4306
-     * @throws EE_Error
4307
-     */
4308
-    public function _construct_between_value($values, $field_obj)
4309
-    {
4310
-        $cleaned_values = array();
4311
-        foreach ($values as $value) {
4312
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4313
-        }
4314
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4315
-    }
4316
-
4317
-
4318
-
4319
-    /**
4320
-     * Takes an array or a comma-separated list of $values and cleans them
4321
-     * according to $data_type using $wpdb->prepare, and then makes the list a
4322
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4323
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4324
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4325
-     *
4326
-     * @param mixed                      $values    array or comma-separated string
4327
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4328
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4329
-     * @throws EE_Error
4330
-     */
4331
-    public function _construct_in_value($values, $field_obj)
4332
-    {
4333
-        //check if the value is a CSV list
4334
-        if (is_string($values)) {
4335
-            //in which case, turn it into an array
4336
-            $values = explode(",", $values);
4337
-        }
4338
-        $cleaned_values = array();
4339
-        foreach ($values as $value) {
4340
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4341
-        }
4342
-        //we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4343
-        //but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4344
-        //which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4345
-        if (empty($cleaned_values)) {
4346
-            $all_fields = $this->field_settings();
4347
-            $a_field = array_shift($all_fields);
4348
-            $main_table = $this->_get_main_table();
4349
-            $cleaned_values[] = "SELECT "
4350
-                                . $a_field->get_table_column()
4351
-                                . " FROM "
4352
-                                . $main_table->get_table_name()
4353
-                                . " WHERE FALSE";
4354
-        }
4355
-        return "(" . implode(",", $cleaned_values) . ")";
4356
-    }
4357
-
4358
-
4359
-
4360
-    /**
4361
-     * @param mixed                      $value
4362
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4363
-     * @throws EE_Error
4364
-     * @return false|null|string
4365
-     */
4366
-    private function _wpdb_prepare_using_field($value, $field_obj)
4367
-    {
4368
-        /** @type WPDB $wpdb */
4369
-        global $wpdb;
4370
-        if ($field_obj instanceof EE_Model_Field_Base) {
4371
-            return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4372
-                $this->_prepare_value_for_use_in_db($value, $field_obj));
4373
-        } //$field_obj should really just be a data type
4374
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4375
-            throw new EE_Error(
4376
-                sprintf(
4377
-                    __("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4378
-                    $field_obj, implode(",", $this->_valid_wpdb_data_types)
4379
-                )
4380
-            );
4381
-        }
4382
-        return $wpdb->prepare($field_obj, $value);
4383
-    }
4384
-
4385
-
4386
-
4387
-    /**
4388
-     * Takes the input parameter and finds the model field that it indicates.
4389
-     *
4390
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4391
-     * @throws EE_Error
4392
-     * @return EE_Model_Field_Base
4393
-     */
4394
-    protected function _deduce_field_from_query_param($query_param_name)
4395
-    {
4396
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
4397
-        //which will help us find the database table and column
4398
-        $query_param_parts = explode(".", $query_param_name);
4399
-        if (empty($query_param_parts)) {
4400
-            throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4401
-                'event_espresso'), $query_param_name));
4402
-        }
4403
-        $number_of_parts = count($query_param_parts);
4404
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4405
-        if ($number_of_parts === 1) {
4406
-            $field_name = $last_query_param_part;
4407
-            $model_obj = $this;
4408
-        } else {// $number_of_parts >= 2
4409
-            //the last part is the column name, and there are only 2parts. therefore...
4410
-            $field_name = $last_query_param_part;
4411
-            $model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4412
-        }
4413
-        try {
4414
-            return $model_obj->field_settings_for($field_name);
4415
-        } catch (EE_Error $e) {
4416
-            return null;
4417
-        }
4418
-    }
4419
-
4420
-
4421
-
4422
-    /**
4423
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4424
-     * alias and column which corresponds to it
4425
-     *
4426
-     * @param string $field_name
4427
-     * @throws EE_Error
4428
-     * @return string
4429
-     */
4430
-    public function _get_qualified_column_for_field($field_name)
4431
-    {
4432
-        $all_fields = $this->field_settings();
4433
-        $field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4434
-        if ($field) {
4435
-            return $field->get_qualified_column();
4436
-        }
4437
-        throw new EE_Error(
4438
-            sprintf(
4439
-                __(
4440
-                    "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.",
4441
-                    'event_espresso'
4442
-                ), $field_name, get_class($this)
4443
-            )
4444
-        );
4445
-    }
4446
-
4447
-
4448
-
4449
-    /**
4450
-     * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4451
-     * Example usage:
4452
-     * EEM_Ticket::instance()->get_all_wpdb_results(
4453
-     *      array(),
4454
-     *      ARRAY_A,
4455
-     *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4456
-     *  );
4457
-     * is equivalent to
4458
-     *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4459
-     * and
4460
-     *  EEM_Event::instance()->get_all_wpdb_results(
4461
-     *      array(
4462
-     *          array(
4463
-     *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4464
-     *          ),
4465
-     *          ARRAY_A,
4466
-     *          implode(
4467
-     *              ', ',
4468
-     *              array_merge(
4469
-     *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4470
-     *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4471
-     *              )
4472
-     *          )
4473
-     *      )
4474
-     *  );
4475
-     * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4476
-     *
4477
-     * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4478
-     *                                            and the one whose fields you are selecting for example: when querying
4479
-     *                                            tickets model and selecting fields from the tickets model you would
4480
-     *                                            leave this parameter empty, because no models are needed to join
4481
-     *                                            between the queried model and the selected one. Likewise when
4482
-     *                                            querying the datetime model and selecting fields from the tickets
4483
-     *                                            model, it would also be left empty, because there is a direct
4484
-     *                                            relation from datetimes to tickets, so no model is needed to join
4485
-     *                                            them together. However, when querying from the event model and
4486
-     *                                            selecting fields from the ticket model, you should provide the string
4487
-     *                                            'Datetime', indicating that the event model must first join to the
4488
-     *                                            datetime model in order to find its relation to ticket model.
4489
-     *                                            Also, when querying from the venue model and selecting fields from
4490
-     *                                            the ticket model, you should provide the string 'Event.Datetime',
4491
-     *                                            indicating you need to join the venue model to the event model,
4492
-     *                                            to the datetime model, in order to find its relation to the ticket model.
4493
-     *                                            This string is used to deduce the prefix that gets added onto the
4494
-     *                                            models' tables qualified columns
4495
-     * @param bool   $return_string               if true, will return a string with qualified column names separated
4496
-     *                                            by ', ' if false, will simply return a numerically indexed array of
4497
-     *                                            qualified column names
4498
-     * @return array|string
4499
-     */
4500
-    public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4501
-    {
4502
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4503
-        $qualified_columns = array();
4504
-        foreach ($this->field_settings() as $field_name => $field) {
4505
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4506
-        }
4507
-        return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4508
-    }
4509
-
4510
-
4511
-
4512
-    /**
4513
-     * constructs the select use on special limit joins
4514
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4515
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
4516
-     * (as that is typically where the limits would be set).
4517
-     *
4518
-     * @param  string       $table_alias The table the select is being built for
4519
-     * @param  mixed|string $limit       The limit for this select
4520
-     * @return string                The final select join element for the query.
4521
-     */
4522
-    public function _construct_limit_join_select($table_alias, $limit)
4523
-    {
4524
-        $SQL = '';
4525
-        foreach ($this->_tables as $table_obj) {
4526
-            if ($table_obj instanceof EE_Primary_Table) {
4527
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4528
-                    ? $table_obj->get_select_join_limit($limit)
4529
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4530
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
4531
-                $SQL .= $table_alias === $table_obj->get_table_alias()
4532
-                    ? $table_obj->get_select_join_limit_join($limit)
4533
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4534
-            }
4535
-        }
4536
-        return $SQL;
4537
-    }
4538
-
4539
-
4540
-
4541
-    /**
4542
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4543
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4544
-     *
4545
-     * @return string SQL
4546
-     * @throws EE_Error
4547
-     */
4548
-    public function _construct_internal_join()
4549
-    {
4550
-        $SQL = $this->_get_main_table()->get_table_sql();
4551
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4552
-        return $SQL;
4553
-    }
4554
-
4555
-
4556
-
4557
-    /**
4558
-     * Constructs the SQL for joining all the tables on this model.
4559
-     * Normally $alias should be the primary table's alias, but in cases where
4560
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4561
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4562
-     * alias, this will construct SQL like:
4563
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4564
-     * With $alias being a secondary table's alias, this will construct SQL like:
4565
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4566
-     *
4567
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4568
-     * @return string
4569
-     */
4570
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4571
-    {
4572
-        $SQL = '';
4573
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4574
-        foreach ($this->_tables as $table_obj) {
4575
-            if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4576
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4577
-                    //so we're joining to this table, meaning the table is already in
4578
-                    //the FROM statement, BUT the primary table isn't. So we want
4579
-                    //to add the inverse join sql
4580
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4581
-                } else {
4582
-                    //just add a regular JOIN to this table from the primary table
4583
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
4584
-                }
4585
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4586
-        }
4587
-        return $SQL;
4588
-    }
4589
-
4590
-
4591
-
4592
-    /**
4593
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
4594
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4595
-     * their data type (eg, '%s', '%d', etc)
4596
-     *
4597
-     * @return array
4598
-     */
4599
-    public function _get_data_types()
4600
-    {
4601
-        $data_types = array();
4602
-        foreach ($this->field_settings() as $field_obj) {
4603
-            //$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4604
-            /** @var $field_obj EE_Model_Field_Base */
4605
-            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4606
-        }
4607
-        return $data_types;
4608
-    }
4609
-
4610
-
4611
-
4612
-    /**
4613
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4614
-     *
4615
-     * @param string $model_name
4616
-     * @throws EE_Error
4617
-     * @return EEM_Base
4618
-     */
4619
-    public function get_related_model_obj($model_name)
4620
-    {
4621
-        $model_classname = "EEM_" . $model_name;
4622
-        if (! class_exists($model_classname)) {
4623
-            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",
4624
-                'event_espresso'), $model_name, $model_classname));
4625
-        }
4626
-        return call_user_func($model_classname . "::instance");
4627
-    }
4628
-
4629
-
4630
-
4631
-    /**
4632
-     * Returns the array of EE_ModelRelations for this model.
4633
-     *
4634
-     * @return EE_Model_Relation_Base[]
4635
-     */
4636
-    public function relation_settings()
4637
-    {
4638
-        return $this->_model_relations;
4639
-    }
4640
-
4641
-
4642
-
4643
-    /**
4644
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
4645
-     * because without THOSE models, this model probably doesn't have much purpose.
4646
-     * (Eg, without an event, datetimes have little purpose.)
4647
-     *
4648
-     * @return EE_Belongs_To_Relation[]
4649
-     */
4650
-    public function belongs_to_relations()
4651
-    {
4652
-        $belongs_to_relations = array();
4653
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
4654
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
4655
-                $belongs_to_relations[$model_name] = $relation_obj;
4656
-            }
4657
-        }
4658
-        return $belongs_to_relations;
4659
-    }
4660
-
4661
-
4662
-
4663
-    /**
4664
-     * Returns the specified EE_Model_Relation, or throws an exception
4665
-     *
4666
-     * @param string $relation_name name of relation, key in $this->_relatedModels
4667
-     * @throws EE_Error
4668
-     * @return EE_Model_Relation_Base
4669
-     */
4670
-    public function related_settings_for($relation_name)
4671
-    {
4672
-        $relatedModels = $this->relation_settings();
4673
-        if (! array_key_exists($relation_name, $relatedModels)) {
4674
-            throw new EE_Error(
4675
-                sprintf(
4676
-                    __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4677
-                        'event_espresso'),
4678
-                    $relation_name,
4679
-                    $this->_get_class_name(),
4680
-                    implode(', ', array_keys($relatedModels))
4681
-                )
4682
-            );
4683
-        }
4684
-        return $relatedModels[$relation_name];
4685
-    }
4686
-
4687
-
4688
-
4689
-    /**
4690
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4691
-     * fields
4692
-     *
4693
-     * @param string $fieldName
4694
-     * @throws EE_Error
4695
-     * @return EE_Model_Field_Base
4696
-     */
4697
-    public function field_settings_for($fieldName)
4698
-    {
4699
-        $fieldSettings = $this->field_settings(true);
4700
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4701
-            throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4702
-                get_class($this)));
4703
-        }
4704
-        return $fieldSettings[$fieldName];
4705
-    }
4706
-
4707
-
4708
-
4709
-    /**
4710
-     * Checks if this field exists on this model
4711
-     *
4712
-     * @param string $fieldName a key in the model's _field_settings array
4713
-     * @return boolean
4714
-     */
4715
-    public function has_field($fieldName)
4716
-    {
4717
-        $fieldSettings = $this->field_settings(true);
4718
-        if (isset($fieldSettings[$fieldName])) {
4719
-            return true;
4720
-        }
4721
-        return false;
4722
-    }
4723
-
4724
-
4725
-
4726
-    /**
4727
-     * Returns whether or not this model has a relation to the specified model
4728
-     *
4729
-     * @param string $relation_name possibly one of the keys in the relation_settings array
4730
-     * @return boolean
4731
-     */
4732
-    public function has_relation($relation_name)
4733
-    {
4734
-        $relations = $this->relation_settings();
4735
-        if (isset($relations[$relation_name])) {
4736
-            return true;
4737
-        }
4738
-        return false;
4739
-    }
4740
-
4741
-
4742
-
4743
-    /**
4744
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4745
-     * Eg, on EE_Answer that would be ANS_ID field object
4746
-     *
4747
-     * @param $field_obj
4748
-     * @return boolean
4749
-     */
4750
-    public function is_primary_key_field($field_obj)
4751
-    {
4752
-        return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4753
-    }
4754
-
4755
-
4756
-
4757
-    /**
4758
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4759
-     * Eg, on EE_Answer that would be ANS_ID field object
4760
-     *
4761
-     * @return EE_Model_Field_Base
4762
-     * @throws EE_Error
4763
-     */
4764
-    public function get_primary_key_field()
4765
-    {
4766
-        if ($this->_primary_key_field === null) {
4767
-            foreach ($this->field_settings(true) as $field_obj) {
4768
-                if ($this->is_primary_key_field($field_obj)) {
4769
-                    $this->_primary_key_field = $field_obj;
4770
-                    break;
4771
-                }
4772
-            }
4773
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4774
-                throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4775
-                    get_class($this)));
4776
-            }
4777
-        }
4778
-        return $this->_primary_key_field;
4779
-    }
4780
-
4781
-
4782
-
4783
-    /**
4784
-     * Returns whether or not not there is a primary key on this model.
4785
-     * Internally does some caching.
4786
-     *
4787
-     * @return boolean
4788
-     */
4789
-    public function has_primary_key_field()
4790
-    {
4791
-        if ($this->_has_primary_key_field === null) {
4792
-            try {
4793
-                $this->get_primary_key_field();
4794
-                $this->_has_primary_key_field = true;
4795
-            } catch (EE_Error $e) {
4796
-                $this->_has_primary_key_field = false;
4797
-            }
4798
-        }
4799
-        return $this->_has_primary_key_field;
4800
-    }
4801
-
4802
-
4803
-
4804
-    /**
4805
-     * Finds the first field of type $field_class_name.
4806
-     *
4807
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4808
-     *                                 EE_Foreign_Key_Field, etc
4809
-     * @return EE_Model_Field_Base or null if none is found
4810
-     */
4811
-    public function get_a_field_of_type($field_class_name)
4812
-    {
4813
-        foreach ($this->field_settings() as $field) {
4814
-            if ($field instanceof $field_class_name) {
4815
-                return $field;
4816
-            }
4817
-        }
4818
-        return null;
4819
-    }
4820
-
4821
-
4822
-
4823
-    /**
4824
-     * Gets a foreign key field pointing to model.
4825
-     *
4826
-     * @param string $model_name eg Event, Registration, not EEM_Event
4827
-     * @return EE_Foreign_Key_Field_Base
4828
-     * @throws EE_Error
4829
-     */
4830
-    public function get_foreign_key_to($model_name)
4831
-    {
4832
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4833
-            foreach ($this->field_settings() as $field) {
4834
-                if (
4835
-                    $field instanceof EE_Foreign_Key_Field_Base
4836
-                    && in_array($model_name, $field->get_model_names_pointed_to())
4837
-                ) {
4838
-                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
4839
-                    break;
4840
-                }
4841
-            }
4842
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4843
-                throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4844
-                    'event_espresso'), $model_name, get_class($this)));
4845
-            }
4846
-        }
4847
-        return $this->_cache_foreign_key_to_fields[$model_name];
4848
-    }
4849
-
4850
-
4851
-
4852
-    /**
4853
-     * Gets the table name (including $wpdb->prefix) for the table alias
4854
-     *
4855
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4856
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4857
-     *                            Either one works
4858
-     * @return string
4859
-     */
4860
-    public function get_table_for_alias($table_alias)
4861
-    {
4862
-        $table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4863
-        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4864
-    }
4865
-
4866
-
4867
-
4868
-    /**
4869
-     * Returns a flat array of all field son this model, instead of organizing them
4870
-     * by table_alias as they are in the constructor.
4871
-     *
4872
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4873
-     * @return EE_Model_Field_Base[] where the keys are the field's name
4874
-     */
4875
-    public function field_settings($include_db_only_fields = false)
4876
-    {
4877
-        if ($include_db_only_fields) {
4878
-            if ($this->_cached_fields === null) {
4879
-                $this->_cached_fields = array();
4880
-                foreach ($this->_fields as $fields_corresponding_to_table) {
4881
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4882
-                        $this->_cached_fields[$field_name] = $field_obj;
4883
-                    }
4884
-                }
4885
-            }
4886
-            return $this->_cached_fields;
4887
-        }
4888
-        if ($this->_cached_fields_non_db_only === null) {
4889
-            $this->_cached_fields_non_db_only = array();
4890
-            foreach ($this->_fields as $fields_corresponding_to_table) {
4891
-                foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4892
-                    /** @var $field_obj EE_Model_Field_Base */
4893
-                    if (! $field_obj->is_db_only_field()) {
4894
-                        $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4895
-                    }
4896
-                }
4897
-            }
4898
-        }
4899
-        return $this->_cached_fields_non_db_only;
4900
-    }
4901
-
4902
-
4903
-
4904
-    /**
4905
-     *        cycle though array of attendees and create objects out of each item
4906
-     *
4907
-     * @access        private
4908
-     * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4909
-     * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4910
-     *                           numerically indexed)
4911
-     * @throws EE_Error
4912
-     */
4913
-    protected function _create_objects($rows = array())
4914
-    {
4915
-        $array_of_objects = array();
4916
-        if (empty($rows)) {
4917
-            return array();
4918
-        }
4919
-        $count_if_model_has_no_primary_key = 0;
4920
-        $has_primary_key = $this->has_primary_key_field();
4921
-        $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4922
-        foreach ((array)$rows as $row) {
4923
-            if (empty($row)) {
4924
-                //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4925
-                return array();
4926
-            }
4927
-            //check if we've already set this object in the results array,
4928
-            //in which case there's no need to process it further (again)
4929
-            if ($has_primary_key) {
4930
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4931
-                    $row,
4932
-                    $primary_key_field->get_qualified_column(),
4933
-                    $primary_key_field->get_table_column()
4934
-                );
4935
-                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4936
-                    continue;
4937
-                }
4938
-            }
4939
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
4940
-            if (! $classInstance) {
4941
-                throw new EE_Error(
4942
-                    sprintf(
4943
-                        __('Could not create instance of class %s from row %s', 'event_espresso'),
4944
-                        $this->get_this_model_name(),
4945
-                        http_build_query($row)
4946
-                    )
4947
-                );
4948
-            }
4949
-            //set the timezone on the instantiated objects
4950
-            $classInstance->set_timezone($this->_timezone);
4951
-            //make sure if there is any timezone setting present that we set the timezone for the object
4952
-            $key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4953
-            $array_of_objects[$key] = $classInstance;
4954
-            //also, for all the relations of type BelongsTo, see if we can cache
4955
-            //those related models
4956
-            //(we could do this for other relations too, but if there are conditions
4957
-            //that filtered out some fo the results, then we'd be caching an incomplete set
4958
-            //so it requires a little more thought than just caching them immediately...)
4959
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
4960
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
4961
-                    //check if this model's INFO is present. If so, cache it on the model
4962
-                    $other_model = $relation_obj->get_other_model();
4963
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4964
-                    //if we managed to make a model object from the results, cache it on the main model object
4965
-                    if ($other_model_obj_maybe) {
4966
-                        //set timezone on these other model objects if they are present
4967
-                        $other_model_obj_maybe->set_timezone($this->_timezone);
4968
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
4969
-                    }
4970
-                }
4971
-            }
4972
-        }
4973
-        return $array_of_objects;
4974
-    }
4975
-
4976
-
4977
-
4978
-    /**
4979
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4980
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4981
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4982
-     * object (as set in the model_field!).
4983
-     *
4984
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4985
-     * @throws Exception
4986
-     */
4987
-    public function create_default_object()
4988
-    {
4989
-        $this_model_fields_and_values = array();
4990
-        //setup the row using default values;
4991
-        foreach ($this->field_settings() as $field_name => $field_obj) {
4992
-            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4993
-        }
4994
-        $classInstance = $this->_instantiate_new_instance_from_db(
4995
-            $this->_get_class_name(),
4996
-            $this_model_fields_and_values
4997
-        );
4998
-        return $classInstance;
4999
-    }
5000
-
5001
-
5002
-
5003
-    /**
5004
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
5005
-     *                             or an stdClass where each property is the name of a column,
5006
-     * @return EE_Base_Class
5007
-     * @throws Exception
5008
-     * @throws EE_Error
5009
-     */
5010
-    public function instantiate_class_from_array_or_object($cols_n_values)
5011
-    {
5012
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
5013
-            $cols_n_values = get_object_vars($cols_n_values);
5014
-        }
5015
-        $primary_key = null;
5016
-        //make sure the array only has keys that are fields/columns on this model
5017
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5018
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
5019
-            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
5020
-        }
5021
-        //check we actually found results that we can use to build our model object
5022
-        //if not, return null
5023
-        if ($this->has_primary_key_field()) {
5024
-            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
5025
-                return null;
5026
-            }
5027
-        } else if ($this->unique_indexes()) {
5028
-            $first_column = reset($this_model_fields_n_values);
5029
-            if (empty($first_column)) {
5030
-                return null;
5031
-            }
5032
-        }
5033
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
5034
-        if ($primary_key) {
5035
-            $classInstance = $this->get_from_entity_map($primary_key);
5036
-            if (! $classInstance) {
5037
-                $classInstance = $this->_instantiate_new_instance_from_db(
5038
-                    $this->_get_class_name(),
5039
-                    $this_model_fields_n_values
5040
-                );
5041
-                // add this new object to the entity map
5042
-                $classInstance = $this->add_to_entity_map($classInstance);
5043
-            }
5044
-        } else {
5045
-            $classInstance = $this->_instantiate_new_instance_from_db(
5046
-                $this->_get_class_name(),
5047
-                $this_model_fields_n_values
5048
-            );
5049
-        }
5050
-        // it is entirely possible that the instantiated class object has a set
5051
-        // timezone_string db field and has set it's internal _timezone property accordingly
5052
-        // (see new_instance_from_db in model objects particularly EE_Event for example).
5053
-        // In this case, we want to make sure the model object doesn't have its timezone string
5054
-        // overwritten by any timezone property currently set here on the model so,
5055
-        // we intentionally override the model _timezone property with the model_object timezone property.
5056
-        $this->set_timezone($classInstance->get_timezone());
5057
-        return $classInstance;
5058
-    }
5059
-
5060
-
5061
-
5062
-    /**
5063
-     * Gets the model object from the  entity map if it exists
5064
-     *
5065
-     * @param int|string $id the ID of the model object
5066
-     * @return EE_Base_Class
5067
-     */
5068
-    public function get_from_entity_map($id)
5069
-    {
5070
-        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
5071
-            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
5072
-    }
5073
-
5074
-
5075
-
5076
-    /**
5077
-     * add_to_entity_map
5078
-     * Adds the object to the model's entity mappings
5079
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
5080
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
5081
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
5082
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
5083
-     *        then this method should be called immediately after the update query
5084
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
5085
-     * so on multisite, the entity map is specific to the query being done for a specific site.
5086
-     *
5087
-     * @param    EE_Base_Class $object
5088
-     * @throws EE_Error
5089
-     * @return \EE_Base_Class
5090
-     */
5091
-    public function add_to_entity_map(EE_Base_Class $object)
5092
-    {
5093
-        $className = $this->_get_class_name();
5094
-        if (! $object instanceof $className) {
5095
-            throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
5096
-                is_object($object) ? get_class($object) : $object, $className));
5097
-        }
5098
-        /** @var $object EE_Base_Class */
5099
-        if (! $object->ID()) {
5100
-            throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
5101
-                "event_espresso"), get_class($this)));
5102
-        }
5103
-        // double check it's not already there
5104
-        $classInstance = $this->get_from_entity_map($object->ID());
5105
-        if ($classInstance) {
5106
-            return $classInstance;
5107
-        }
5108
-        $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
5109
-        return $object;
5110
-    }
5111
-
5112
-
5113
-
5114
-    /**
5115
-     * if a valid identifier is provided, then that entity is unset from the entity map,
5116
-     * if no identifier is provided, then the entire entity map is emptied
5117
-     *
5118
-     * @param int|string $id the ID of the model object
5119
-     * @return boolean
5120
-     */
5121
-    public function clear_entity_map($id = null)
5122
-    {
5123
-        if (empty($id)) {
5124
-            $this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
5125
-            return true;
5126
-        }
5127
-        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
5128
-            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
5129
-            return true;
5130
-        }
5131
-        return false;
5132
-    }
5133
-
5134
-
5135
-
5136
-    /**
5137
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
5138
-     * Given an array where keys are column (or column alias) names and values,
5139
-     * returns an array of their corresponding field names and database values
5140
-     *
5141
-     * @param array $cols_n_values
5142
-     * @return array
5143
-     */
5144
-    public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
5145
-    {
5146
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5147
-    }
5148
-
5149
-
5150
-
5151
-    /**
5152
-     * _deduce_fields_n_values_from_cols_n_values
5153
-     * Given an array where keys are column (or column alias) names and values,
5154
-     * returns an array of their corresponding field names and database values
5155
-     *
5156
-     * @param string $cols_n_values
5157
-     * @return array
5158
-     */
5159
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5160
-    {
5161
-        $this_model_fields_n_values = array();
5162
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
5163
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5164
-                $table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5165
-            //there is a primary key on this table and its not set. Use defaults for all its columns
5166
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
5167
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5168
-                    if (! $field_obj->is_db_only_field()) {
5169
-                        //prepare field as if its coming from db
5170
-                        $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5171
-                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5172
-                    }
5173
-                }
5174
-            } else {
5175
-                //the table's rows existed. Use their values
5176
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5177
-                    if (! $field_obj->is_db_only_field()) {
5178
-                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5179
-                            $cols_n_values, $field_obj->get_qualified_column(),
5180
-                            $field_obj->get_table_column()
5181
-                        );
5182
-                    }
5183
-                }
5184
-            }
5185
-        }
5186
-        return $this_model_fields_n_values;
5187
-    }
5188
-
5189
-
5190
-
5191
-    /**
5192
-     * @param $cols_n_values
5193
-     * @param $qualified_column
5194
-     * @param $regular_column
5195
-     * @return null
5196
-     */
5197
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5198
-    {
5199
-        $value = null;
5200
-        //ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5201
-        //does the field on the model relate to this column retrieved from the db?
5202
-        //or is it a db-only field? (not relating to the model)
5203
-        if (isset($cols_n_values[$qualified_column])) {
5204
-            $value = $cols_n_values[$qualified_column];
5205
-        } elseif (isset($cols_n_values[$regular_column])) {
5206
-            $value = $cols_n_values[$regular_column];
5207
-        }
5208
-        return $value;
5209
-    }
5210
-
5211
-
5212
-
5213
-    /**
5214
-     * refresh_entity_map_from_db
5215
-     * Makes sure the model object in the entity map at $id assumes the values
5216
-     * of the database (opposite of EE_base_Class::save())
5217
-     *
5218
-     * @param int|string $id
5219
-     * @return EE_Base_Class
5220
-     * @throws EE_Error
5221
-     */
5222
-    public function refresh_entity_map_from_db($id)
5223
-    {
5224
-        $obj_in_map = $this->get_from_entity_map($id);
5225
-        if ($obj_in_map) {
5226
-            $wpdb_results = $this->_get_all_wpdb_results(
5227
-                array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5228
-            );
5229
-            if ($wpdb_results && is_array($wpdb_results)) {
5230
-                $one_row = reset($wpdb_results);
5231
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5232
-                    $obj_in_map->set_from_db($field_name, $db_value);
5233
-                }
5234
-                //clear the cache of related model objects
5235
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5236
-                    $obj_in_map->clear_cache($relation_name, null, true);
5237
-                }
5238
-            }
5239
-            $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5240
-            return $obj_in_map;
5241
-        }
5242
-        return $this->get_one_by_ID($id);
5243
-    }
5244
-
5245
-
5246
-
5247
-    /**
5248
-     * refresh_entity_map_with
5249
-     * Leaves the entry in the entity map alone, but updates it to match the provided
5250
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5251
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5252
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5253
-     *
5254
-     * @param int|string    $id
5255
-     * @param EE_Base_Class $replacing_model_obj
5256
-     * @return \EE_Base_Class
5257
-     * @throws EE_Error
5258
-     */
5259
-    public function refresh_entity_map_with($id, $replacing_model_obj)
5260
-    {
5261
-        $obj_in_map = $this->get_from_entity_map($id);
5262
-        if ($obj_in_map) {
5263
-            if ($replacing_model_obj instanceof EE_Base_Class) {
5264
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5265
-                    $obj_in_map->set($field_name, $value);
5266
-                }
5267
-                //make the model object in the entity map's cache match the $replacing_model_obj
5268
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5269
-                    $obj_in_map->clear_cache($relation_name, null, true);
5270
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5271
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5272
-                    }
5273
-                }
5274
-            }
5275
-            return $obj_in_map;
5276
-        }
5277
-        $this->add_to_entity_map($replacing_model_obj);
5278
-        return $replacing_model_obj;
5279
-    }
5280
-
5281
-
5282
-
5283
-    /**
5284
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5285
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5286
-     * require_once($this->_getClassName().".class.php");
5287
-     *
5288
-     * @return string
5289
-     */
5290
-    private function _get_class_name()
5291
-    {
5292
-        return "EE_" . $this->get_this_model_name();
5293
-    }
5294
-
5295
-
5296
-
5297
-    /**
5298
-     * Get the name of the items this model represents, for the quantity specified. Eg,
5299
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5300
-     * it would be 'Events'.
5301
-     *
5302
-     * @param int $quantity
5303
-     * @return string
5304
-     */
5305
-    public function item_name($quantity = 1)
5306
-    {
5307
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5308
-    }
5309
-
5310
-
5311
-
5312
-    /**
5313
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5314
-     * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5315
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5316
-     * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5317
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5318
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5319
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
5320
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
5321
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5322
-     * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5323
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5324
-     *        return $previousReturnValue.$returnString;
5325
-     * }
5326
-     * require('EEM_Answer.model.php');
5327
-     * $answer=EEM_Answer::instance();
5328
-     * echo $answer->my_callback('monkeys',100);
5329
-     * //will output "you called my_callback! and passed args:monkeys,100"
5330
-     *
5331
-     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5332
-     * @param array  $args       array of original arguments passed to the function
5333
-     * @throws EE_Error
5334
-     * @return mixed whatever the plugin which calls add_filter decides
5335
-     */
5336
-    public function __call($methodName, $args)
5337
-    {
5338
-        $className = get_class($this);
5339
-        $tagName = "FHEE__{$className}__{$methodName}";
5340
-        if (! has_filter($tagName)) {
5341
-            throw new EE_Error(
5342
-                sprintf(
5343
-                    __('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 );',
5344
-                        'event_espresso'),
5345
-                    $methodName,
5346
-                    $className,
5347
-                    $tagName,
5348
-                    '<br />'
5349
-                )
5350
-            );
5351
-        }
5352
-        return apply_filters($tagName, null, $this, $args);
5353
-    }
5354
-
5355
-
5356
-
5357
-    /**
5358
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5359
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5360
-     *
5361
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5362
-     *                                                       the EE_Base_Class object that corresponds to this Model,
5363
-     *                                                       the object's class name
5364
-     *                                                       or object's ID
5365
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5366
-     *                                                       exists in the database. If it does not, we add it
5367
-     * @throws EE_Error
5368
-     * @return EE_Base_Class
5369
-     */
5370
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5371
-    {
5372
-        $className = $this->_get_class_name();
5373
-        if ($base_class_obj_or_id instanceof $className) {
5374
-            $model_object = $base_class_obj_or_id;
5375
-        } else {
5376
-            $primary_key_field = $this->get_primary_key_field();
5377
-            if (
5378
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
5379
-                && (
5380
-                    is_int($base_class_obj_or_id)
5381
-                    || is_string($base_class_obj_or_id)
5382
-                )
5383
-            ) {
5384
-                // assume it's an ID.
5385
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
5386
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5387
-            } else if (
5388
-                $primary_key_field instanceof EE_Primary_Key_String_Field
5389
-                && is_string($base_class_obj_or_id)
5390
-            ) {
5391
-                // assume its a string representation of the object
5392
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
5393
-            } else {
5394
-                throw new EE_Error(
5395
-                    sprintf(
5396
-                        __(
5397
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5398
-                            'event_espresso'
5399
-                        ),
5400
-                        $base_class_obj_or_id,
5401
-                        $this->_get_class_name(),
5402
-                        print_r($base_class_obj_or_id, true)
5403
-                    )
5404
-                );
5405
-            }
5406
-        }
5407
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
5408
-            $model_object->save();
5409
-        }
5410
-        return $model_object;
5411
-    }
5412
-
5413
-
5414
-
5415
-    /**
5416
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5417
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
5418
-     * returns it ID.
5419
-     *
5420
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
5421
-     * @return int|string depending on the type of this model object's ID
5422
-     * @throws EE_Error
5423
-     */
5424
-    public function ensure_is_ID($base_class_obj_or_id)
5425
-    {
5426
-        $className = $this->_get_class_name();
5427
-        if ($base_class_obj_or_id instanceof $className) {
5428
-            /** @var $base_class_obj_or_id EE_Base_Class */
5429
-            $id = $base_class_obj_or_id->ID();
5430
-        } elseif (is_int($base_class_obj_or_id)) {
5431
-            //assume it's an ID
5432
-            $id = $base_class_obj_or_id;
5433
-        } elseif (is_string($base_class_obj_or_id)) {
5434
-            //assume its a string representation of the object
5435
-            $id = $base_class_obj_or_id;
5436
-        } else {
5437
-            throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5438
-                'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5439
-                print_r($base_class_obj_or_id, true)));
5440
-        }
5441
-        return $id;
5442
-    }
5443
-
5444
-
5445
-
5446
-    /**
5447
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5448
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5449
-     * been sanitized and converted into the appropriate domain.
5450
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5451
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5452
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5453
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5454
-     * $EVT = EEM_Event::instance(); $old_setting =
5455
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5456
-     * $EVT->assume_values_already_prepared_by_model_object(true);
5457
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5458
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5459
-     *
5460
-     * @param int $values_already_prepared like one of the constants on EEM_Base
5461
-     * @return void
5462
-     */
5463
-    public function assume_values_already_prepared_by_model_object(
5464
-        $values_already_prepared = self::not_prepared_by_model_object
5465
-    ) {
5466
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
5467
-    }
5468
-
5469
-
5470
-
5471
-    /**
5472
-     * Read comments for assume_values_already_prepared_by_model_object()
5473
-     *
5474
-     * @return int
5475
-     */
5476
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
5477
-    {
5478
-        return $this->_values_already_prepared_by_model_object;
5479
-    }
5480
-
5481
-
5482
-
5483
-    /**
5484
-     * Gets all the indexes on this model
5485
-     *
5486
-     * @return EE_Index[]
5487
-     */
5488
-    public function indexes()
5489
-    {
5490
-        return $this->_indexes;
5491
-    }
5492
-
5493
-
5494
-
5495
-    /**
5496
-     * Gets all the Unique Indexes on this model
5497
-     *
5498
-     * @return EE_Unique_Index[]
5499
-     */
5500
-    public function unique_indexes()
5501
-    {
5502
-        $unique_indexes = array();
5503
-        foreach ($this->_indexes as $name => $index) {
5504
-            if ($index instanceof EE_Unique_Index) {
5505
-                $unique_indexes [$name] = $index;
5506
-            }
5507
-        }
5508
-        return $unique_indexes;
5509
-    }
5510
-
5511
-
5512
-
5513
-    /**
5514
-     * Gets all the fields which, when combined, make the primary key.
5515
-     * This is usually just an array with 1 element (the primary key), but in cases
5516
-     * where there is no primary key, it's a combination of fields as defined
5517
-     * on a primary index
5518
-     *
5519
-     * @return EE_Model_Field_Base[] indexed by the field's name
5520
-     * @throws EE_Error
5521
-     */
5522
-    public function get_combined_primary_key_fields()
5523
-    {
5524
-        foreach ($this->indexes() as $index) {
5525
-            if ($index instanceof EE_Primary_Key_Index) {
5526
-                return $index->fields();
5527
-            }
5528
-        }
5529
-        return array($this->primary_key_name() => $this->get_primary_key_field());
5530
-    }
5531
-
5532
-
5533
-
5534
-    /**
5535
-     * Used to build a primary key string (when the model has no primary key),
5536
-     * which can be used a unique string to identify this model object.
5537
-     *
5538
-     * @param array $cols_n_values keys are field names, values are their values
5539
-     * @return string
5540
-     * @throws EE_Error
5541
-     */
5542
-    public function get_index_primary_key_string($cols_n_values)
5543
-    {
5544
-        $cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5545
-            $this->get_combined_primary_key_fields());
5546
-        return http_build_query($cols_n_values_for_primary_key_index);
5547
-    }
5548
-
5549
-
5550
-
5551
-    /**
5552
-     * Gets the field values from the primary key string
5553
-     *
5554
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5555
-     * @param string $index_primary_key_string
5556
-     * @return null|array
5557
-     * @throws EE_Error
5558
-     */
5559
-    public function parse_index_primary_key_string($index_primary_key_string)
5560
-    {
5561
-        $key_fields = $this->get_combined_primary_key_fields();
5562
-        //check all of them are in the $id
5563
-        $key_vals_in_combined_pk = array();
5564
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5565
-        foreach ($key_fields as $key_field_name => $field_obj) {
5566
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5567
-                return null;
5568
-            }
5569
-        }
5570
-        return $key_vals_in_combined_pk;
5571
-    }
5572
-
5573
-
5574
-
5575
-    /**
5576
-     * verifies that an array of key-value pairs for model fields has a key
5577
-     * for each field comprising the primary key index
5578
-     *
5579
-     * @param array $key_vals
5580
-     * @return boolean
5581
-     * @throws EE_Error
5582
-     */
5583
-    public function has_all_combined_primary_key_fields($key_vals)
5584
-    {
5585
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5586
-        foreach ($keys_it_should_have as $key) {
5587
-            if (! isset($key_vals[$key])) {
5588
-                return false;
5589
-            }
5590
-        }
5591
-        return true;
5592
-    }
5593
-
5594
-
5595
-
5596
-    /**
5597
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5598
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
5599
-     *
5600
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5601
-     * @param array               $query_params                     like EEM_Base::get_all's query_params.
5602
-     * @throws EE_Error
5603
-     * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5604
-     *                                                              indexed)
5605
-     */
5606
-    public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5607
-    {
5608
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5609
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
5610
-        } elseif (is_array($model_object_or_attributes_array)) {
5611
-            $attributes_array = $model_object_or_attributes_array;
5612
-        } else {
5613
-            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",
5614
-                "event_espresso"), $model_object_or_attributes_array));
5615
-        }
5616
-        //even copies obviously won't have the same ID, so remove the primary key
5617
-        //from the WHERE conditions for finding copies (if there is a primary key, of course)
5618
-        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5619
-            unset($attributes_array[$this->primary_key_name()]);
5620
-        }
5621
-        if (isset($query_params[0])) {
5622
-            $query_params[0] = array_merge($attributes_array, $query_params);
5623
-        } else {
5624
-            $query_params[0] = $attributes_array;
5625
-        }
5626
-        return $this->get_all($query_params);
5627
-    }
5628
-
5629
-
5630
-
5631
-    /**
5632
-     * Gets the first copy we find. See get_all_copies for more details
5633
-     *
5634
-     * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5635
-     * @param array $query_params
5636
-     * @return EE_Base_Class
5637
-     * @throws EE_Error
5638
-     */
5639
-    public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5640
-    {
5641
-        if (! is_array($query_params)) {
5642
-            EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5643
-                sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5644
-                    gettype($query_params)), '4.6.0');
5645
-            $query_params = array();
5646
-        }
5647
-        $query_params['limit'] = 1;
5648
-        $copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5649
-        if (is_array($copies)) {
5650
-            return array_shift($copies);
5651
-        }
5652
-        return null;
5653
-    }
5654
-
5655
-
5656
-
5657
-    /**
5658
-     * Updates the item with the specified id. Ignores default query parameters because
5659
-     * we have specified the ID, and its assumed we KNOW what we're doing
5660
-     *
5661
-     * @param array      $fields_n_values keys are field names, values are their new values
5662
-     * @param int|string $id              the value of the primary key to update
5663
-     * @return int number of rows updated
5664
-     * @throws EE_Error
5665
-     */
5666
-    public function update_by_ID($fields_n_values, $id)
5667
-    {
5668
-        $query_params = array(
5669
-            0                          => array($this->get_primary_key_field()->get_name() => $id),
5670
-            'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5671
-        );
5672
-        return $this->update($fields_n_values, $query_params);
5673
-    }
5674
-
5675
-
5676
-
5677
-    /**
5678
-     * Changes an operator which was supplied to the models into one usable in SQL
5679
-     *
5680
-     * @param string $operator_supplied
5681
-     * @return string an operator which can be used in SQL
5682
-     * @throws EE_Error
5683
-     */
5684
-    private function _prepare_operator_for_sql($operator_supplied)
5685
-    {
5686
-        $sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5687
-            : null;
5688
-        if ($sql_operator) {
5689
-            return $sql_operator;
5690
-        }
5691
-        throw new EE_Error(
5692
-            sprintf(
5693
-                __(
5694
-                    "The operator '%s' is not in the list of valid operators: %s",
5695
-                    "event_espresso"
5696
-                ), $operator_supplied, implode(",", array_keys($this->_valid_operators))
5697
-            )
5698
-        );
5699
-    }
5700
-
5701
-
5702
-
5703
-    /**
5704
-     * Gets an array where keys are the primary keys and values are their 'names'
5705
-     * (as determined by the model object's name() function, which is often overridden)
5706
-     *
5707
-     * @param array $query_params like get_all's
5708
-     * @return string[]
5709
-     * @throws EE_Error
5710
-     */
5711
-    public function get_all_names($query_params = array())
5712
-    {
5713
-        $objs = $this->get_all($query_params);
5714
-        $names = array();
5715
-        foreach ($objs as $obj) {
5716
-            $names[$obj->ID()] = $obj->name();
5717
-        }
5718
-        return $names;
5719
-    }
5720
-
5721
-
5722
-
5723
-    /**
5724
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
5725
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5726
-     * this is duplicated effort and reduces efficiency) you would be better to use
5727
-     * array_keys() on $model_objects.
5728
-     *
5729
-     * @param \EE_Base_Class[] $model_objects
5730
-     * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5731
-     *                                               in the returned array
5732
-     * @return array
5733
-     * @throws EE_Error
5734
-     */
5735
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
5736
-    {
5737
-        if (! $this->has_primary_key_field()) {
5738
-            if (WP_DEBUG) {
5739
-                EE_Error::add_error(
5740
-                    __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5741
-                    __FILE__,
5742
-                    __FUNCTION__,
5743
-                    __LINE__
5744
-                );
5745
-            }
5746
-        }
5747
-        $IDs = array();
5748
-        foreach ($model_objects as $model_object) {
5749
-            $id = $model_object->ID();
5750
-            if (! $id) {
5751
-                if ($filter_out_empty_ids) {
5752
-                    continue;
5753
-                }
5754
-                if (WP_DEBUG) {
5755
-                    EE_Error::add_error(
5756
-                        __(
5757
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5758
-                            'event_espresso'
5759
-                        ),
5760
-                        __FILE__,
5761
-                        __FUNCTION__,
5762
-                        __LINE__
5763
-                    );
5764
-                }
5765
-            }
5766
-            $IDs[] = $id;
5767
-        }
5768
-        return $IDs;
5769
-    }
5770
-
5771
-
5772
-
5773
-    /**
5774
-     * Returns the string used in capabilities relating to this model. If there
5775
-     * are no capabilities that relate to this model returns false
5776
-     *
5777
-     * @return string|false
5778
-     */
5779
-    public function cap_slug()
5780
-    {
5781
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5782
-    }
5783
-
5784
-
5785
-
5786
-    /**
5787
-     * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5788
-     * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5789
-     * only returns the cap restrictions array in that context (ie, the array
5790
-     * at that key)
5791
-     *
5792
-     * @param string $context
5793
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
5794
-     * @throws EE_Error
5795
-     */
5796
-    public function cap_restrictions($context = EEM_Base::caps_read)
5797
-    {
5798
-        EEM_Base::verify_is_valid_cap_context($context);
5799
-        //check if we ought to run the restriction generator first
5800
-        if (
5801
-            isset($this->_cap_restriction_generators[$context])
5802
-            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5803
-            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5804
-        ) {
5805
-            $this->_cap_restrictions[$context] = array_merge(
5806
-                $this->_cap_restrictions[$context],
5807
-                $this->_cap_restriction_generators[$context]->generate_restrictions()
5808
-            );
5809
-        }
5810
-        //and make sure we've finalized the construction of each restriction
5811
-        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5812
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5813
-                $where_conditions_obj->_finalize_construct($this);
5814
-            }
5815
-        }
5816
-        return $this->_cap_restrictions[$context];
5817
-    }
5818
-
5819
-
5820
-
5821
-    /**
5822
-     * Indicating whether or not this model thinks its a wp core model
5823
-     *
5824
-     * @return boolean
5825
-     */
5826
-    public function is_wp_core_model()
5827
-    {
5828
-        return $this->_wp_core_model;
5829
-    }
5830
-
5831
-
5832
-
5833
-    /**
5834
-     * Gets all the caps that are missing which impose a restriction on
5835
-     * queries made in this context
5836
-     *
5837
-     * @param string $context one of EEM_Base::caps_ constants
5838
-     * @return EE_Default_Where_Conditions[] indexed by capability name
5839
-     * @throws EE_Error
5840
-     */
5841
-    public function caps_missing($context = EEM_Base::caps_read)
5842
-    {
5843
-        $missing_caps = array();
5844
-        $cap_restrictions = $this->cap_restrictions($context);
5845
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5846
-            if (! EE_Capabilities::instance()
5847
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5848
-            ) {
5849
-                $missing_caps[$cap] = $restriction_if_no_cap;
5850
-            }
5851
-        }
5852
-        return $missing_caps;
5853
-    }
5854
-
5855
-
5856
-
5857
-    /**
5858
-     * Gets the mapping from capability contexts to action strings used in capability names
5859
-     *
5860
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5861
-     * one of 'read', 'edit', or 'delete'
5862
-     */
5863
-    public function cap_contexts_to_cap_action_map()
5864
-    {
5865
-        return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5866
-            $this);
5867
-    }
5868
-
5869
-
5870
-
5871
-    /**
5872
-     * Gets the action string for the specified capability context
5873
-     *
5874
-     * @param string $context
5875
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5876
-     * @throws EE_Error
5877
-     */
5878
-    public function cap_action_for_context($context)
5879
-    {
5880
-        $mapping = $this->cap_contexts_to_cap_action_map();
5881
-        if (isset($mapping[$context])) {
5882
-            return $mapping[$context];
5883
-        }
5884
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5885
-            return $action;
5886
-        }
5887
-        throw new EE_Error(
5888
-            sprintf(
5889
-                __('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5890
-                $context,
5891
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5892
-            )
5893
-        );
5894
-    }
5895
-
5896
-
5897
-
5898
-    /**
5899
-     * Returns all the capability contexts which are valid when querying models
5900
-     *
5901
-     * @return array
5902
-     */
5903
-    public static function valid_cap_contexts()
5904
-    {
5905
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5906
-            self::caps_read,
5907
-            self::caps_read_admin,
5908
-            self::caps_edit,
5909
-            self::caps_delete,
5910
-        ));
5911
-    }
5912
-
5913
-
5914
-
5915
-    /**
5916
-     * Returns all valid options for 'default_where_conditions'
5917
-     *
5918
-     * @return array
5919
-     */
5920
-    public static function valid_default_where_conditions()
5921
-    {
5922
-        return array(
5923
-            EEM_Base::default_where_conditions_all,
5924
-            EEM_Base::default_where_conditions_this_only,
5925
-            EEM_Base::default_where_conditions_others_only,
5926
-            EEM_Base::default_where_conditions_minimum_all,
5927
-            EEM_Base::default_where_conditions_minimum_others,
5928
-            EEM_Base::default_where_conditions_none
5929
-        );
5930
-    }
5931
-
5932
-    // public static function default_where_conditions_full
5933
-    /**
5934
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5935
-     *
5936
-     * @param string $context
5937
-     * @return bool
5938
-     * @throws EE_Error
5939
-     */
5940
-    static public function verify_is_valid_cap_context($context)
5941
-    {
5942
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
5943
-        if (in_array($context, $valid_cap_contexts)) {
5944
-            return true;
5945
-        }
5946
-        throw new EE_Error(
5947
-            sprintf(
5948
-                __(
5949
-                    'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5950
-                    'event_espresso'
5951
-                ),
5952
-                $context,
5953
-                'EEM_Base',
5954
-                implode(',', $valid_cap_contexts)
5955
-            )
5956
-        );
5957
-    }
5958
-
5959
-
5960
-
5961
-    /**
5962
-     * Clears all the models field caches. This is only useful when a sub-class
5963
-     * might have added a field or something and these caches might be invalidated
5964
-     */
5965
-    protected function _invalidate_field_caches()
5966
-    {
5967
-        $this->_cache_foreign_key_to_fields = array();
5968
-        $this->_cached_fields = null;
5969
-        $this->_cached_fields_non_db_only = null;
5970
-    }
5971
-
5972
-
5973
-
5974
-    /**
5975
-     * _instantiate_new_instance_from_db
5976
-     *
5977
-     * @param string $class_name
5978
-     * @param array  $arguments
5979
-     * @return \EE_Base_Class
5980
-     * @throws Exception
5981
-     */
5982
-    public function _instantiate_new_instance_from_db($class_name, $arguments)
5983
-    {
5984
-        if ( ! class_exists($class_name)) {
5985
-            throw new EE_Error(
5986
-                sprintf(
5987
-                    __('The "%s" class does not exist. Please ensure that an autoloader is set.', 'event_espresso'),
5988
-                    $class_name
5989
-                )
5990
-            );
5991
-        }
5992
-        return call_user_func_array(
5993
-            array($class_name, 'static_constructor'),
5994
-            array((array)$arguments, true, $this->_timezone)
5995
-        );
5996
-    }
5997
-
5998
-
5999
-    /**
6000
-     * Gets the list of all the where query param keys that relate to logic instead of field names
6001
-     * (eg "and", "or", "not").
6002
-     *
6003
-     * @return array
6004
-     */
6005
-    public function logic_query_param_keys()
6006
-    {
6007
-        return $this->_logic_query_param_keys;
6008
-    }
6009
-
6010
-
6011
-
6012
-    /**
6013
-     * Determines whether or not the where query param array key is for a logic query param.
6014
-     * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
6015
-     * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
6016
-     *
6017
-     * @param $query_param_key
6018
-     * @return bool
6019
-     */
6020
-    public function is_logic_query_param_key($query_param_key)
6021
-    {
6022
-        foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
6023
-            if ($query_param_key === $logic_query_param_key
6024
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
6025
-            ) {
6026
-                return true;
6027
-            }
6028
-        }
6029
-        return false;
6030
-    }
3725
+		}
3726
+		return $null_friendly_where_conditions;
3727
+	}
3728
+
3729
+
3730
+
3731
+	/**
3732
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
3733
+	 * default where conditions on all get_all, update, and delete queries done by this model.
3734
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3735
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3736
+	 *
3737
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3738
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3739
+	 */
3740
+	private function _get_default_where_conditions($model_relation_path = null)
3741
+	{
3742
+		if ($this->_ignore_where_strategy) {
3743
+			return array();
3744
+		}
3745
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3746
+	}
3747
+
3748
+
3749
+
3750
+	/**
3751
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
3752
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
3753
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
3754
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
3755
+	 * Similar to _get_default_where_conditions
3756
+	 *
3757
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
3758
+	 * @return array like EEM_Base::get_all's $query_params[0] (where conditions)
3759
+	 */
3760
+	protected function _get_minimum_where_conditions($model_relation_path = null)
3761
+	{
3762
+		if ($this->_ignore_where_strategy) {
3763
+			return array();
3764
+		}
3765
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
3766
+	}
3767
+
3768
+
3769
+
3770
+	/**
3771
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
3772
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
3773
+	 *
3774
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
3775
+	 * @return string
3776
+	 * @throws EE_Error
3777
+	 */
3778
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
3779
+	{
3780
+		$selects = $this->_get_columns_to_select_for_this_model();
3781
+		foreach (
3782
+			$model_query_info->get_model_names_included() as $model_relation_chain =>
3783
+			$name_of_other_model_included
3784
+		) {
3785
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
3786
+			$other_model_selects = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
3787
+			foreach ($other_model_selects as $key => $value) {
3788
+				$selects[] = $value;
3789
+			}
3790
+		}
3791
+		return implode(", ", $selects);
3792
+	}
3793
+
3794
+
3795
+
3796
+	/**
3797
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
3798
+	 * So that's going to be the columns for all the fields on the model
3799
+	 *
3800
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
3801
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
3802
+	 */
3803
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
3804
+	{
3805
+		$fields = $this->field_settings();
3806
+		$selects = array();
3807
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain,
3808
+			$this->get_this_model_name());
3809
+		foreach ($fields as $field_obj) {
3810
+			$selects[] = $table_alias_with_model_relation_chain_prefix
3811
+						 . $field_obj->get_table_alias()
3812
+						 . "."
3813
+						 . $field_obj->get_table_column()
3814
+						 . " AS '"
3815
+						 . $table_alias_with_model_relation_chain_prefix
3816
+						 . $field_obj->get_table_alias()
3817
+						 . "."
3818
+						 . $field_obj->get_table_column()
3819
+						 . "'";
3820
+		}
3821
+		//make sure we are also getting the PKs of each table
3822
+		$tables = $this->get_tables();
3823
+		if (count($tables) > 1) {
3824
+			foreach ($tables as $table_obj) {
3825
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3826
+									   . $table_obj->get_fully_qualified_pk_column();
3827
+				if (! in_array($qualified_pk_column, $selects)) {
3828
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3829
+				}
3830
+			}
3831
+		}
3832
+		return $selects;
3833
+	}
3834
+
3835
+
3836
+
3837
+	/**
3838
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
3839
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
3840
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
3841
+	 * SQL for joining, and the data types
3842
+	 *
3843
+	 * @param null|string                 $original_query_param
3844
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
3845
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3846
+	 * @param    string                   $query_param_type     like Registration.Transaction.TXN_ID
3847
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
3848
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
3849
+	 *                                                          or 'Registration's
3850
+	 * @param string                      $original_query_param what it originally was (eg
3851
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
3852
+	 *                                                          matches $query_param
3853
+	 * @throws EE_Error
3854
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
3855
+	 */
3856
+	private function _extract_related_model_info_from_query_param(
3857
+		$query_param,
3858
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3859
+		$query_param_type,
3860
+		$original_query_param = null
3861
+	) {
3862
+		if ($original_query_param === null) {
3863
+			$original_query_param = $query_param;
3864
+		}
3865
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
3866
+		/** @var $allow_logic_query_params bool whether or not to allow logic_query_params like 'NOT','OR', or 'AND' */
3867
+		$allow_logic_query_params = in_array($query_param_type, array('where', 'having'));
3868
+		$allow_fields = in_array($query_param_type, array('where', 'having', 'order_by', 'group_by', 'order'));
3869
+		//check to see if we have a field on this model
3870
+		$this_model_fields = $this->field_settings(true);
3871
+		if (array_key_exists($query_param, $this_model_fields)) {
3872
+			if ($allow_fields) {
3873
+				return;
3874
+			}
3875
+			throw new EE_Error(
3876
+				sprintf(
3877
+					__(
3878
+						"Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
3879
+						"event_espresso"
3880
+					),
3881
+					$query_param, get_class($this), $query_param_type, $original_query_param
3882
+				)
3883
+			);
3884
+		}
3885
+		//check if this is a special logic query param
3886
+		if (in_array($query_param, $this->_logic_query_param_keys, true)) {
3887
+			if ($allow_logic_query_params) {
3888
+				return;
3889
+			}
3890
+			throw new EE_Error(
3891
+				sprintf(
3892
+					__(
3893
+						'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',
3894
+						'event_espresso'
3895
+					),
3896
+					implode('", "', $this->_logic_query_param_keys),
3897
+					$query_param,
3898
+					get_class($this),
3899
+					'<br />',
3900
+					"\t"
3901
+					. ' $passed_in_query_info = <pre>'
3902
+					. print_r($passed_in_query_info, true)
3903
+					. '</pre>'
3904
+					. "\n\t"
3905
+					. ' $query_param_type = '
3906
+					. $query_param_type
3907
+					. "\n\t"
3908
+					. ' $original_query_param = '
3909
+					. $original_query_param
3910
+				)
3911
+			);
3912
+		}
3913
+		//check if it's a custom selection
3914
+		if (array_key_exists($query_param, $this->_custom_selections)) {
3915
+			return;
3916
+		}
3917
+		//check if has a model name at the beginning
3918
+		//and
3919
+		//check if it's a field on a related model
3920
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3921
+			if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3922
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3923
+				$query_param = substr($query_param, strlen($valid_related_model_name . "."));
3924
+				if ($query_param === '') {
3925
+					//nothing left to $query_param
3926
+					//we should actually end in a field name, not a model like this!
3927
+					throw new EE_Error(sprintf(__("Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
3928
+						"event_espresso"),
3929
+						$query_param, $query_param_type, get_class($this), $valid_related_model_name));
3930
+				}
3931
+				$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
3932
+				$related_model_obj->_extract_related_model_info_from_query_param(
3933
+					$query_param,
3934
+					$passed_in_query_info, $query_param_type, $original_query_param
3935
+				);
3936
+				return;
3937
+			}
3938
+			if ($query_param === $valid_related_model_name) {
3939
+				$this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3940
+				return;
3941
+			}
3942
+		}
3943
+		//ok so $query_param didn't start with a model name
3944
+		//and we previously confirmed it wasn't a logic query param or field on the current model
3945
+		//it's wack, that's what it is
3946
+		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",
3947
+			"event_espresso"),
3948
+			$query_param, get_class($this), $query_param_type, $original_query_param));
3949
+	}
3950
+
3951
+
3952
+
3953
+	/**
3954
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
3955
+	 * and store it on $passed_in_query_info
3956
+	 *
3957
+	 * @param string                      $model_name
3958
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
3959
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
3960
+	 *                                                          model and $model_name. Eg, if we are querying Event,
3961
+	 *                                                          and are adding a join to 'Payment' with the original
3962
+	 *                                                          query param key
3963
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
3964
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
3965
+	 *                                                          Payment wants to add default query params so that it
3966
+	 *                                                          will know what models to prepend onto its default query
3967
+	 *                                                          params or in case it wants to rename tables (in case
3968
+	 *                                                          there are multiple joins to the same table)
3969
+	 * @return void
3970
+	 * @throws EE_Error
3971
+	 */
3972
+	private function _add_join_to_model(
3973
+		$model_name,
3974
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
3975
+		$original_query_param
3976
+	) {
3977
+		$relation_obj = $this->related_settings_for($model_name);
3978
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
3979
+		//check if the relation is HABTM, because then we're essentially doing two joins
3980
+		//If so, join first to the JOIN table, and add its data types, and then continue as normal
3981
+		if ($relation_obj instanceof EE_HABTM_Relation) {
3982
+			$join_model_obj = $relation_obj->get_join_model();
3983
+			//replace the model specified with the join model for this relation chain, whi
3984
+			$relation_chain_to_join_model = EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain($model_name,
3985
+				$join_model_obj->get_this_model_name(), $model_relation_chain);
3986
+			$new_query_info = new EE_Model_Query_Info_Carrier(
3987
+				array($relation_chain_to_join_model => $join_model_obj->get_this_model_name()),
3988
+				$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model));
3989
+			$passed_in_query_info->merge($new_query_info);
3990
+		}
3991
+		//now just join to the other table pointed to by the relation object, and add its data types
3992
+		$new_query_info = new EE_Model_Query_Info_Carrier(
3993
+			array($model_relation_chain => $model_name),
3994
+			$relation_obj->get_join_statement($model_relation_chain));
3995
+		$passed_in_query_info->merge($new_query_info);
3996
+	}
3997
+
3998
+
3999
+
4000
+	/**
4001
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
4002
+	 *
4003
+	 * @param array $where_params like EEM_Base::get_all
4004
+	 * @return string of SQL
4005
+	 * @throws EE_Error
4006
+	 */
4007
+	private function _construct_where_clause($where_params)
4008
+	{
4009
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
4010
+		if ($SQL) {
4011
+			return " WHERE " . $SQL;
4012
+		}
4013
+		return '';
4014
+	}
4015
+
4016
+
4017
+
4018
+	/**
4019
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
4020
+	 * and should be passed HAVING parameters, not WHERE parameters
4021
+	 *
4022
+	 * @param array $having_params
4023
+	 * @return string
4024
+	 * @throws EE_Error
4025
+	 */
4026
+	private function _construct_having_clause($having_params)
4027
+	{
4028
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
4029
+		if ($SQL) {
4030
+			return " HAVING " . $SQL;
4031
+		}
4032
+		return '';
4033
+	}
4034
+
4035
+
4036
+
4037
+	/**
4038
+	 * Gets the EE_Model_Field on the model indicated by $model_name and the $field_name.
4039
+	 * Eg, if called with _get_field_on_model('ATT_ID','Attendee'), it will return the EE_Primary_Key_Field on
4040
+	 * EEM_Attendee.
4041
+	 *
4042
+	 * @param string $field_name
4043
+	 * @param string $model_name
4044
+	 * @return EE_Model_Field_Base
4045
+	 * @throws EE_Error
4046
+	 */
4047
+	protected function _get_field_on_model($field_name, $model_name)
4048
+	{
4049
+		$model_class = 'EEM_' . $model_name;
4050
+		$model_filepath = $model_class . ".model.php";
4051
+		if (is_readable($model_filepath)) {
4052
+			require_once($model_filepath);
4053
+			$model_instance = call_user_func($model_name . "::instance");
4054
+			/* @var $model_instance EEM_Base */
4055
+			return $model_instance->field_settings_for($field_name);
4056
+		}
4057
+		throw new EE_Error(
4058
+			sprintf(
4059
+				__(
4060
+					'No model named %s exists, with classname %s and filepath %s',
4061
+					'event_espresso'
4062
+				), $model_name, $model_class, $model_filepath
4063
+			)
4064
+		);
4065
+	}
4066
+
4067
+
4068
+
4069
+	/**
4070
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
4071
+	 * Event_Meta.meta_value = 'foo'))"
4072
+	 *
4073
+	 * @param array  $where_params see EEM_Base::get_all for documentation
4074
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
4075
+	 * @throws EE_Error
4076
+	 * @return string of SQL
4077
+	 */
4078
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
4079
+	{
4080
+		$where_clauses = array();
4081
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
4082
+			$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
4083
+			if (in_array($query_param, $this->_logic_query_param_keys)) {
4084
+				switch ($query_param) {
4085
+					case 'not':
4086
+					case 'NOT':
4087
+						$where_clauses[] = "! ("
4088
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4089
+								$glue)
4090
+										   . ")";
4091
+						break;
4092
+					case 'and':
4093
+					case 'AND':
4094
+						$where_clauses[] = " ("
4095
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4096
+								' AND ')
4097
+										   . ")";
4098
+						break;
4099
+					case 'or':
4100
+					case 'OR':
4101
+						$where_clauses[] = " ("
4102
+										   . $this->_construct_condition_clause_recursive($op_and_value_or_sub_condition,
4103
+								' OR ')
4104
+										   . ")";
4105
+						break;
4106
+				}
4107
+			} else {
4108
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
4109
+				//if it's not a normal field, maybe it's a custom selection?
4110
+				if (! $field_obj) {
4111
+					if (isset($this->_custom_selections[$query_param][1])) {
4112
+						$field_obj = $this->_custom_selections[$query_param][1];
4113
+					} else {
4114
+						throw new EE_Error(sprintf(__("%s is neither a valid model field name, nor a custom selection",
4115
+							"event_espresso"), $query_param));
4116
+					}
4117
+				}
4118
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
4119
+				$where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
4120
+			}
4121
+		}
4122
+		return $where_clauses ? implode($glue, $where_clauses) : '';
4123
+	}
4124
+
4125
+
4126
+
4127
+	/**
4128
+	 * Takes the input parameter and extract the table name (alias) and column name
4129
+	 *
4130
+	 * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4131
+	 * @throws EE_Error
4132
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
4133
+	 */
4134
+	private function _deduce_column_name_from_query_param($query_param)
4135
+	{
4136
+		$field = $this->_deduce_field_from_query_param($query_param);
4137
+		if ($field) {
4138
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4139
+				$query_param);
4140
+			return $table_alias_prefix . $field->get_qualified_column();
4141
+		}
4142
+		if (array_key_exists($query_param, $this->_custom_selections)) {
4143
+			//maybe it's custom selection item?
4144
+			//if so, just use it as the "column name"
4145
+			return $query_param;
4146
+		}
4147
+		throw new EE_Error(
4148
+			sprintf(
4149
+				__(
4150
+					"%s is not a valid field on this model, nor a custom selection (%s)",
4151
+					"event_espresso"
4152
+				), $query_param, implode(",", $this->_custom_selections)
4153
+			)
4154
+		);
4155
+	}
4156
+
4157
+
4158
+
4159
+	/**
4160
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
4161
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
4162
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
4163
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
4164
+	 *
4165
+	 * @param string $condition_query_param_key
4166
+	 * @return string
4167
+	 */
4168
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
4169
+	{
4170
+		$pos_of_star = strpos($condition_query_param_key, '*');
4171
+		if ($pos_of_star === false) {
4172
+			return $condition_query_param_key;
4173
+		}
4174
+		$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
4175
+		return $condition_query_param_sans_star;
4176
+	}
4177
+
4178
+
4179
+
4180
+	/**
4181
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
4182
+	 *
4183
+	 * @param                            mixed      array | string    $op_and_value
4184
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
4185
+	 * @throws EE_Error
4186
+	 * @return string
4187
+	 */
4188
+	private function _construct_op_and_value($op_and_value, $field_obj)
4189
+	{
4190
+		if (is_array($op_and_value)) {
4191
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4192
+			if (! $operator) {
4193
+				$php_array_like_string = array();
4194
+				foreach ($op_and_value as $key => $value) {
4195
+					$php_array_like_string[] = "$key=>$value";
4196
+				}
4197
+				throw new EE_Error(
4198
+					sprintf(
4199
+						__(
4200
+							"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))",
4201
+							"event_espresso"
4202
+						),
4203
+						implode(",", $php_array_like_string)
4204
+					)
4205
+				);
4206
+			}
4207
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
4208
+		} else {
4209
+			$operator = '=';
4210
+			$value = $op_and_value;
4211
+		}
4212
+		//check to see if the value is actually another field
4213
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4214
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4215
+		}
4216
+		if (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4217
+			//in this case, the value should be an array, or at least a comma-separated list
4218
+			//it will need to handle a little differently
4219
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
4220
+			//note: $cleaned_value has already been run through $wpdb->prepare()
4221
+			return $operator . SP . $cleaned_value;
4222
+		}
4223
+		if (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4224
+			//the value should be an array with count of two.
4225
+			if (count($value) !== 2) {
4226
+				throw new EE_Error(
4227
+					sprintf(
4228
+						__(
4229
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
4230
+							'event_espresso'
4231
+						),
4232
+						"BETWEEN"
4233
+					)
4234
+				);
4235
+			}
4236
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
4237
+			return $operator . SP . $cleaned_value;
4238
+		}
4239
+		if (in_array($operator, $this->_null_style_operators)) {
4240
+			if ($value !== null) {
4241
+				throw new EE_Error(
4242
+					sprintf(
4243
+						__(
4244
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
4245
+							"event_espresso"
4246
+						),
4247
+						$value,
4248
+						$operator
4249
+					)
4250
+				);
4251
+			}
4252
+			return $operator;
4253
+		}
4254
+		if ($operator === 'LIKE' && ! is_array($value)) {
4255
+			//if the operator is 'LIKE', we want to allow percent signs (%) and not
4256
+			//remove other junk. So just treat it as a string.
4257
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4258
+		}
4259
+		if (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4260
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4261
+		}
4262
+		if (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4263
+			throw new EE_Error(
4264
+				sprintf(
4265
+					__(
4266
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
4267
+						'event_espresso'
4268
+					),
4269
+					$operator,
4270
+					$operator
4271
+				)
4272
+			);
4273
+		}
4274
+		if (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4275
+			throw new EE_Error(
4276
+				sprintf(
4277
+					__(
4278
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
4279
+						'event_espresso'
4280
+					),
4281
+					$operator,
4282
+					$operator
4283
+				)
4284
+			);
4285
+		}
4286
+		throw new EE_Error(
4287
+			sprintf(
4288
+				__(
4289
+					"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
4290
+					"event_espresso"
4291
+				),
4292
+				http_build_query($op_and_value)
4293
+			)
4294
+		);
4295
+	}
4296
+
4297
+
4298
+
4299
+	/**
4300
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
4301
+	 *
4302
+	 * @param array                      $values
4303
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
4304
+	 *                                              '%s'
4305
+	 * @return string
4306
+	 * @throws EE_Error
4307
+	 */
4308
+	public function _construct_between_value($values, $field_obj)
4309
+	{
4310
+		$cleaned_values = array();
4311
+		foreach ($values as $value) {
4312
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4313
+		}
4314
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
4315
+	}
4316
+
4317
+
4318
+
4319
+	/**
4320
+	 * Takes an array or a comma-separated list of $values and cleans them
4321
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
4322
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
4323
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
4324
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
4325
+	 *
4326
+	 * @param mixed                      $values    array or comma-separated string
4327
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
4328
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
4329
+	 * @throws EE_Error
4330
+	 */
4331
+	public function _construct_in_value($values, $field_obj)
4332
+	{
4333
+		//check if the value is a CSV list
4334
+		if (is_string($values)) {
4335
+			//in which case, turn it into an array
4336
+			$values = explode(",", $values);
4337
+		}
4338
+		$cleaned_values = array();
4339
+		foreach ($values as $value) {
4340
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4341
+		}
4342
+		//we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
4343
+		//but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
4344
+		//which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
4345
+		if (empty($cleaned_values)) {
4346
+			$all_fields = $this->field_settings();
4347
+			$a_field = array_shift($all_fields);
4348
+			$main_table = $this->_get_main_table();
4349
+			$cleaned_values[] = "SELECT "
4350
+								. $a_field->get_table_column()
4351
+								. " FROM "
4352
+								. $main_table->get_table_name()
4353
+								. " WHERE FALSE";
4354
+		}
4355
+		return "(" . implode(",", $cleaned_values) . ")";
4356
+	}
4357
+
4358
+
4359
+
4360
+	/**
4361
+	 * @param mixed                      $value
4362
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
4363
+	 * @throws EE_Error
4364
+	 * @return false|null|string
4365
+	 */
4366
+	private function _wpdb_prepare_using_field($value, $field_obj)
4367
+	{
4368
+		/** @type WPDB $wpdb */
4369
+		global $wpdb;
4370
+		if ($field_obj instanceof EE_Model_Field_Base) {
4371
+			return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4372
+				$this->_prepare_value_for_use_in_db($value, $field_obj));
4373
+		} //$field_obj should really just be a data type
4374
+		if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4375
+			throw new EE_Error(
4376
+				sprintf(
4377
+					__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
4378
+					$field_obj, implode(",", $this->_valid_wpdb_data_types)
4379
+				)
4380
+			);
4381
+		}
4382
+		return $wpdb->prepare($field_obj, $value);
4383
+	}
4384
+
4385
+
4386
+
4387
+	/**
4388
+	 * Takes the input parameter and finds the model field that it indicates.
4389
+	 *
4390
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
4391
+	 * @throws EE_Error
4392
+	 * @return EE_Model_Field_Base
4393
+	 */
4394
+	protected function _deduce_field_from_query_param($query_param_name)
4395
+	{
4396
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
4397
+		//which will help us find the database table and column
4398
+		$query_param_parts = explode(".", $query_param_name);
4399
+		if (empty($query_param_parts)) {
4400
+			throw new EE_Error(sprintf(__("_extract_column_name is empty when trying to extract column and table name from %s",
4401
+				'event_espresso'), $query_param_name));
4402
+		}
4403
+		$number_of_parts = count($query_param_parts);
4404
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
4405
+		if ($number_of_parts === 1) {
4406
+			$field_name = $last_query_param_part;
4407
+			$model_obj = $this;
4408
+		} else {// $number_of_parts >= 2
4409
+			//the last part is the column name, and there are only 2parts. therefore...
4410
+			$field_name = $last_query_param_part;
4411
+			$model_obj = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
4412
+		}
4413
+		try {
4414
+			return $model_obj->field_settings_for($field_name);
4415
+		} catch (EE_Error $e) {
4416
+			return null;
4417
+		}
4418
+	}
4419
+
4420
+
4421
+
4422
+	/**
4423
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
4424
+	 * alias and column which corresponds to it
4425
+	 *
4426
+	 * @param string $field_name
4427
+	 * @throws EE_Error
4428
+	 * @return string
4429
+	 */
4430
+	public function _get_qualified_column_for_field($field_name)
4431
+	{
4432
+		$all_fields = $this->field_settings();
4433
+		$field = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
4434
+		if ($field) {
4435
+			return $field->get_qualified_column();
4436
+		}
4437
+		throw new EE_Error(
4438
+			sprintf(
4439
+				__(
4440
+					"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.",
4441
+					'event_espresso'
4442
+				), $field_name, get_class($this)
4443
+			)
4444
+		);
4445
+	}
4446
+
4447
+
4448
+
4449
+	/**
4450
+	 * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
4451
+	 * Example usage:
4452
+	 * EEM_Ticket::instance()->get_all_wpdb_results(
4453
+	 *      array(),
4454
+	 *      ARRAY_A,
4455
+	 *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
4456
+	 *  );
4457
+	 * is equivalent to
4458
+	 *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
4459
+	 * and
4460
+	 *  EEM_Event::instance()->get_all_wpdb_results(
4461
+	 *      array(
4462
+	 *          array(
4463
+	 *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
4464
+	 *          ),
4465
+	 *          ARRAY_A,
4466
+	 *          implode(
4467
+	 *              ', ',
4468
+	 *              array_merge(
4469
+	 *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
4470
+	 *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
4471
+	 *              )
4472
+	 *          )
4473
+	 *      )
4474
+	 *  );
4475
+	 * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
4476
+	 *
4477
+	 * @param string $model_relation_chain        the chain of models used to join between the model you want to query
4478
+	 *                                            and the one whose fields you are selecting for example: when querying
4479
+	 *                                            tickets model and selecting fields from the tickets model you would
4480
+	 *                                            leave this parameter empty, because no models are needed to join
4481
+	 *                                            between the queried model and the selected one. Likewise when
4482
+	 *                                            querying the datetime model and selecting fields from the tickets
4483
+	 *                                            model, it would also be left empty, because there is a direct
4484
+	 *                                            relation from datetimes to tickets, so no model is needed to join
4485
+	 *                                            them together. However, when querying from the event model and
4486
+	 *                                            selecting fields from the ticket model, you should provide the string
4487
+	 *                                            'Datetime', indicating that the event model must first join to the
4488
+	 *                                            datetime model in order to find its relation to ticket model.
4489
+	 *                                            Also, when querying from the venue model and selecting fields from
4490
+	 *                                            the ticket model, you should provide the string 'Event.Datetime',
4491
+	 *                                            indicating you need to join the venue model to the event model,
4492
+	 *                                            to the datetime model, in order to find its relation to the ticket model.
4493
+	 *                                            This string is used to deduce the prefix that gets added onto the
4494
+	 *                                            models' tables qualified columns
4495
+	 * @param bool   $return_string               if true, will return a string with qualified column names separated
4496
+	 *                                            by ', ' if false, will simply return a numerically indexed array of
4497
+	 *                                            qualified column names
4498
+	 * @return array|string
4499
+	 */
4500
+	public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4501
+	{
4502
+		$table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4503
+		$qualified_columns = array();
4504
+		foreach ($this->field_settings() as $field_name => $field) {
4505
+			$qualified_columns[] = $table_prefix . $field->get_qualified_column();
4506
+		}
4507
+		return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4508
+	}
4509
+
4510
+
4511
+
4512
+	/**
4513
+	 * constructs the select use on special limit joins
4514
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
4515
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
4516
+	 * (as that is typically where the limits would be set).
4517
+	 *
4518
+	 * @param  string       $table_alias The table the select is being built for
4519
+	 * @param  mixed|string $limit       The limit for this select
4520
+	 * @return string                The final select join element for the query.
4521
+	 */
4522
+	public function _construct_limit_join_select($table_alias, $limit)
4523
+	{
4524
+		$SQL = '';
4525
+		foreach ($this->_tables as $table_obj) {
4526
+			if ($table_obj instanceof EE_Primary_Table) {
4527
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4528
+					? $table_obj->get_select_join_limit($limit)
4529
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4530
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
4531
+				$SQL .= $table_alias === $table_obj->get_table_alias()
4532
+					? $table_obj->get_select_join_limit_join($limit)
4533
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
4534
+			}
4535
+		}
4536
+		return $SQL;
4537
+	}
4538
+
4539
+
4540
+
4541
+	/**
4542
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
4543
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
4544
+	 *
4545
+	 * @return string SQL
4546
+	 * @throws EE_Error
4547
+	 */
4548
+	public function _construct_internal_join()
4549
+	{
4550
+		$SQL = $this->_get_main_table()->get_table_sql();
4551
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
4552
+		return $SQL;
4553
+	}
4554
+
4555
+
4556
+
4557
+	/**
4558
+	 * Constructs the SQL for joining all the tables on this model.
4559
+	 * Normally $alias should be the primary table's alias, but in cases where
4560
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
4561
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
4562
+	 * alias, this will construct SQL like:
4563
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
4564
+	 * With $alias being a secondary table's alias, this will construct SQL like:
4565
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
4566
+	 *
4567
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
4568
+	 * @return string
4569
+	 */
4570
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
4571
+	{
4572
+		$SQL = '';
4573
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
4574
+		foreach ($this->_tables as $table_obj) {
4575
+			if ($table_obj instanceof EE_Secondary_Table) {//table is secondary table
4576
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
4577
+					//so we're joining to this table, meaning the table is already in
4578
+					//the FROM statement, BUT the primary table isn't. So we want
4579
+					//to add the inverse join sql
4580
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
4581
+				} else {
4582
+					//just add a regular JOIN to this table from the primary table
4583
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
4584
+				}
4585
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
4586
+		}
4587
+		return $SQL;
4588
+	}
4589
+
4590
+
4591
+
4592
+	/**
4593
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
4594
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
4595
+	 * their data type (eg, '%s', '%d', etc)
4596
+	 *
4597
+	 * @return array
4598
+	 */
4599
+	public function _get_data_types()
4600
+	{
4601
+		$data_types = array();
4602
+		foreach ($this->field_settings() as $field_obj) {
4603
+			//$data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
4604
+			/** @var $field_obj EE_Model_Field_Base */
4605
+			$data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
4606
+		}
4607
+		return $data_types;
4608
+	}
4609
+
4610
+
4611
+
4612
+	/**
4613
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
4614
+	 *
4615
+	 * @param string $model_name
4616
+	 * @throws EE_Error
4617
+	 * @return EEM_Base
4618
+	 */
4619
+	public function get_related_model_obj($model_name)
4620
+	{
4621
+		$model_classname = "EEM_" . $model_name;
4622
+		if (! class_exists($model_classname)) {
4623
+			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",
4624
+				'event_espresso'), $model_name, $model_classname));
4625
+		}
4626
+		return call_user_func($model_classname . "::instance");
4627
+	}
4628
+
4629
+
4630
+
4631
+	/**
4632
+	 * Returns the array of EE_ModelRelations for this model.
4633
+	 *
4634
+	 * @return EE_Model_Relation_Base[]
4635
+	 */
4636
+	public function relation_settings()
4637
+	{
4638
+		return $this->_model_relations;
4639
+	}
4640
+
4641
+
4642
+
4643
+	/**
4644
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
4645
+	 * because without THOSE models, this model probably doesn't have much purpose.
4646
+	 * (Eg, without an event, datetimes have little purpose.)
4647
+	 *
4648
+	 * @return EE_Belongs_To_Relation[]
4649
+	 */
4650
+	public function belongs_to_relations()
4651
+	{
4652
+		$belongs_to_relations = array();
4653
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
4654
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
4655
+				$belongs_to_relations[$model_name] = $relation_obj;
4656
+			}
4657
+		}
4658
+		return $belongs_to_relations;
4659
+	}
4660
+
4661
+
4662
+
4663
+	/**
4664
+	 * Returns the specified EE_Model_Relation, or throws an exception
4665
+	 *
4666
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
4667
+	 * @throws EE_Error
4668
+	 * @return EE_Model_Relation_Base
4669
+	 */
4670
+	public function related_settings_for($relation_name)
4671
+	{
4672
+		$relatedModels = $this->relation_settings();
4673
+		if (! array_key_exists($relation_name, $relatedModels)) {
4674
+			throw new EE_Error(
4675
+				sprintf(
4676
+					__('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
4677
+						'event_espresso'),
4678
+					$relation_name,
4679
+					$this->_get_class_name(),
4680
+					implode(', ', array_keys($relatedModels))
4681
+				)
4682
+			);
4683
+		}
4684
+		return $relatedModels[$relation_name];
4685
+	}
4686
+
4687
+
4688
+
4689
+	/**
4690
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
4691
+	 * fields
4692
+	 *
4693
+	 * @param string $fieldName
4694
+	 * @throws EE_Error
4695
+	 * @return EE_Model_Field_Base
4696
+	 */
4697
+	public function field_settings_for($fieldName)
4698
+	{
4699
+		$fieldSettings = $this->field_settings(true);
4700
+		if (! array_key_exists($fieldName, $fieldSettings)) {
4701
+			throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4702
+				get_class($this)));
4703
+		}
4704
+		return $fieldSettings[$fieldName];
4705
+	}
4706
+
4707
+
4708
+
4709
+	/**
4710
+	 * Checks if this field exists on this model
4711
+	 *
4712
+	 * @param string $fieldName a key in the model's _field_settings array
4713
+	 * @return boolean
4714
+	 */
4715
+	public function has_field($fieldName)
4716
+	{
4717
+		$fieldSettings = $this->field_settings(true);
4718
+		if (isset($fieldSettings[$fieldName])) {
4719
+			return true;
4720
+		}
4721
+		return false;
4722
+	}
4723
+
4724
+
4725
+
4726
+	/**
4727
+	 * Returns whether or not this model has a relation to the specified model
4728
+	 *
4729
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
4730
+	 * @return boolean
4731
+	 */
4732
+	public function has_relation($relation_name)
4733
+	{
4734
+		$relations = $this->relation_settings();
4735
+		if (isset($relations[$relation_name])) {
4736
+			return true;
4737
+		}
4738
+		return false;
4739
+	}
4740
+
4741
+
4742
+
4743
+	/**
4744
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4745
+	 * Eg, on EE_Answer that would be ANS_ID field object
4746
+	 *
4747
+	 * @param $field_obj
4748
+	 * @return boolean
4749
+	 */
4750
+	public function is_primary_key_field($field_obj)
4751
+	{
4752
+		return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
4753
+	}
4754
+
4755
+
4756
+
4757
+	/**
4758
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
4759
+	 * Eg, on EE_Answer that would be ANS_ID field object
4760
+	 *
4761
+	 * @return EE_Model_Field_Base
4762
+	 * @throws EE_Error
4763
+	 */
4764
+	public function get_primary_key_field()
4765
+	{
4766
+		if ($this->_primary_key_field === null) {
4767
+			foreach ($this->field_settings(true) as $field_obj) {
4768
+				if ($this->is_primary_key_field($field_obj)) {
4769
+					$this->_primary_key_field = $field_obj;
4770
+					break;
4771
+				}
4772
+			}
4773
+			if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4774
+				throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4775
+					get_class($this)));
4776
+			}
4777
+		}
4778
+		return $this->_primary_key_field;
4779
+	}
4780
+
4781
+
4782
+
4783
+	/**
4784
+	 * Returns whether or not not there is a primary key on this model.
4785
+	 * Internally does some caching.
4786
+	 *
4787
+	 * @return boolean
4788
+	 */
4789
+	public function has_primary_key_field()
4790
+	{
4791
+		if ($this->_has_primary_key_field === null) {
4792
+			try {
4793
+				$this->get_primary_key_field();
4794
+				$this->_has_primary_key_field = true;
4795
+			} catch (EE_Error $e) {
4796
+				$this->_has_primary_key_field = false;
4797
+			}
4798
+		}
4799
+		return $this->_has_primary_key_field;
4800
+	}
4801
+
4802
+
4803
+
4804
+	/**
4805
+	 * Finds the first field of type $field_class_name.
4806
+	 *
4807
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
4808
+	 *                                 EE_Foreign_Key_Field, etc
4809
+	 * @return EE_Model_Field_Base or null if none is found
4810
+	 */
4811
+	public function get_a_field_of_type($field_class_name)
4812
+	{
4813
+		foreach ($this->field_settings() as $field) {
4814
+			if ($field instanceof $field_class_name) {
4815
+				return $field;
4816
+			}
4817
+		}
4818
+		return null;
4819
+	}
4820
+
4821
+
4822
+
4823
+	/**
4824
+	 * Gets a foreign key field pointing to model.
4825
+	 *
4826
+	 * @param string $model_name eg Event, Registration, not EEM_Event
4827
+	 * @return EE_Foreign_Key_Field_Base
4828
+	 * @throws EE_Error
4829
+	 */
4830
+	public function get_foreign_key_to($model_name)
4831
+	{
4832
+		if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4833
+			foreach ($this->field_settings() as $field) {
4834
+				if (
4835
+					$field instanceof EE_Foreign_Key_Field_Base
4836
+					&& in_array($model_name, $field->get_model_names_pointed_to())
4837
+				) {
4838
+					$this->_cache_foreign_key_to_fields[$model_name] = $field;
4839
+					break;
4840
+				}
4841
+			}
4842
+			if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4843
+				throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4844
+					'event_espresso'), $model_name, get_class($this)));
4845
+			}
4846
+		}
4847
+		return $this->_cache_foreign_key_to_fields[$model_name];
4848
+	}
4849
+
4850
+
4851
+
4852
+	/**
4853
+	 * Gets the table name (including $wpdb->prefix) for the table alias
4854
+	 *
4855
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
4856
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
4857
+	 *                            Either one works
4858
+	 * @return string
4859
+	 */
4860
+	public function get_table_for_alias($table_alias)
4861
+	{
4862
+		$table_alias_sans_model_relation_chain_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
4863
+		return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
4864
+	}
4865
+
4866
+
4867
+
4868
+	/**
4869
+	 * Returns a flat array of all field son this model, instead of organizing them
4870
+	 * by table_alias as they are in the constructor.
4871
+	 *
4872
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
4873
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
4874
+	 */
4875
+	public function field_settings($include_db_only_fields = false)
4876
+	{
4877
+		if ($include_db_only_fields) {
4878
+			if ($this->_cached_fields === null) {
4879
+				$this->_cached_fields = array();
4880
+				foreach ($this->_fields as $fields_corresponding_to_table) {
4881
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4882
+						$this->_cached_fields[$field_name] = $field_obj;
4883
+					}
4884
+				}
4885
+			}
4886
+			return $this->_cached_fields;
4887
+		}
4888
+		if ($this->_cached_fields_non_db_only === null) {
4889
+			$this->_cached_fields_non_db_only = array();
4890
+			foreach ($this->_fields as $fields_corresponding_to_table) {
4891
+				foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4892
+					/** @var $field_obj EE_Model_Field_Base */
4893
+					if (! $field_obj->is_db_only_field()) {
4894
+						$this->_cached_fields_non_db_only[$field_name] = $field_obj;
4895
+					}
4896
+				}
4897
+			}
4898
+		}
4899
+		return $this->_cached_fields_non_db_only;
4900
+	}
4901
+
4902
+
4903
+
4904
+	/**
4905
+	 *        cycle though array of attendees and create objects out of each item
4906
+	 *
4907
+	 * @access        private
4908
+	 * @param        array $rows of results of $wpdb->get_results($query,ARRAY_A)
4909
+	 * @return \EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
4910
+	 *                           numerically indexed)
4911
+	 * @throws EE_Error
4912
+	 */
4913
+	protected function _create_objects($rows = array())
4914
+	{
4915
+		$array_of_objects = array();
4916
+		if (empty($rows)) {
4917
+			return array();
4918
+		}
4919
+		$count_if_model_has_no_primary_key = 0;
4920
+		$has_primary_key = $this->has_primary_key_field();
4921
+		$primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4922
+		foreach ((array)$rows as $row) {
4923
+			if (empty($row)) {
4924
+				//wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4925
+				return array();
4926
+			}
4927
+			//check if we've already set this object in the results array,
4928
+			//in which case there's no need to process it further (again)
4929
+			if ($has_primary_key) {
4930
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
4931
+					$row,
4932
+					$primary_key_field->get_qualified_column(),
4933
+					$primary_key_field->get_table_column()
4934
+				);
4935
+				if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
4936
+					continue;
4937
+				}
4938
+			}
4939
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
4940
+			if (! $classInstance) {
4941
+				throw new EE_Error(
4942
+					sprintf(
4943
+						__('Could not create instance of class %s from row %s', 'event_espresso'),
4944
+						$this->get_this_model_name(),
4945
+						http_build_query($row)
4946
+					)
4947
+				);
4948
+			}
4949
+			//set the timezone on the instantiated objects
4950
+			$classInstance->set_timezone($this->_timezone);
4951
+			//make sure if there is any timezone setting present that we set the timezone for the object
4952
+			$key = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
4953
+			$array_of_objects[$key] = $classInstance;
4954
+			//also, for all the relations of type BelongsTo, see if we can cache
4955
+			//those related models
4956
+			//(we could do this for other relations too, but if there are conditions
4957
+			//that filtered out some fo the results, then we'd be caching an incomplete set
4958
+			//so it requires a little more thought than just caching them immediately...)
4959
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
4960
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
4961
+					//check if this model's INFO is present. If so, cache it on the model
4962
+					$other_model = $relation_obj->get_other_model();
4963
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
4964
+					//if we managed to make a model object from the results, cache it on the main model object
4965
+					if ($other_model_obj_maybe) {
4966
+						//set timezone on these other model objects if they are present
4967
+						$other_model_obj_maybe->set_timezone($this->_timezone);
4968
+						$classInstance->cache($modelName, $other_model_obj_maybe);
4969
+					}
4970
+				}
4971
+			}
4972
+		}
4973
+		return $array_of_objects;
4974
+	}
4975
+
4976
+
4977
+
4978
+	/**
4979
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
4980
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
4981
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
4982
+	 * object (as set in the model_field!).
4983
+	 *
4984
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
4985
+	 * @throws Exception
4986
+	 */
4987
+	public function create_default_object()
4988
+	{
4989
+		$this_model_fields_and_values = array();
4990
+		//setup the row using default values;
4991
+		foreach ($this->field_settings() as $field_name => $field_obj) {
4992
+			$this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
4993
+		}
4994
+		$classInstance = $this->_instantiate_new_instance_from_db(
4995
+			$this->_get_class_name(),
4996
+			$this_model_fields_and_values
4997
+		);
4998
+		return $classInstance;
4999
+	}
5000
+
5001
+
5002
+
5003
+	/**
5004
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
5005
+	 *                             or an stdClass where each property is the name of a column,
5006
+	 * @return EE_Base_Class
5007
+	 * @throws Exception
5008
+	 * @throws EE_Error
5009
+	 */
5010
+	public function instantiate_class_from_array_or_object($cols_n_values)
5011
+	{
5012
+		if (! is_array($cols_n_values) && is_object($cols_n_values)) {
5013
+			$cols_n_values = get_object_vars($cols_n_values);
5014
+		}
5015
+		$primary_key = null;
5016
+		//make sure the array only has keys that are fields/columns on this model
5017
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5018
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
5019
+			$primary_key = $this_model_fields_n_values[$this->primary_key_name()];
5020
+		}
5021
+		//check we actually found results that we can use to build our model object
5022
+		//if not, return null
5023
+		if ($this->has_primary_key_field()) {
5024
+			if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
5025
+				return null;
5026
+			}
5027
+		} else if ($this->unique_indexes()) {
5028
+			$first_column = reset($this_model_fields_n_values);
5029
+			if (empty($first_column)) {
5030
+				return null;
5031
+			}
5032
+		}
5033
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
5034
+		if ($primary_key) {
5035
+			$classInstance = $this->get_from_entity_map($primary_key);
5036
+			if (! $classInstance) {
5037
+				$classInstance = $this->_instantiate_new_instance_from_db(
5038
+					$this->_get_class_name(),
5039
+					$this_model_fields_n_values
5040
+				);
5041
+				// add this new object to the entity map
5042
+				$classInstance = $this->add_to_entity_map($classInstance);
5043
+			}
5044
+		} else {
5045
+			$classInstance = $this->_instantiate_new_instance_from_db(
5046
+				$this->_get_class_name(),
5047
+				$this_model_fields_n_values
5048
+			);
5049
+		}
5050
+		// it is entirely possible that the instantiated class object has a set
5051
+		// timezone_string db field and has set it's internal _timezone property accordingly
5052
+		// (see new_instance_from_db in model objects particularly EE_Event for example).
5053
+		// In this case, we want to make sure the model object doesn't have its timezone string
5054
+		// overwritten by any timezone property currently set here on the model so,
5055
+		// we intentionally override the model _timezone property with the model_object timezone property.
5056
+		$this->set_timezone($classInstance->get_timezone());
5057
+		return $classInstance;
5058
+	}
5059
+
5060
+
5061
+
5062
+	/**
5063
+	 * Gets the model object from the  entity map if it exists
5064
+	 *
5065
+	 * @param int|string $id the ID of the model object
5066
+	 * @return EE_Base_Class
5067
+	 */
5068
+	public function get_from_entity_map($id)
5069
+	{
5070
+		return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
5071
+			? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
5072
+	}
5073
+
5074
+
5075
+
5076
+	/**
5077
+	 * add_to_entity_map
5078
+	 * Adds the object to the model's entity mappings
5079
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
5080
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
5081
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
5082
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
5083
+	 *        then this method should be called immediately after the update query
5084
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
5085
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
5086
+	 *
5087
+	 * @param    EE_Base_Class $object
5088
+	 * @throws EE_Error
5089
+	 * @return \EE_Base_Class
5090
+	 */
5091
+	public function add_to_entity_map(EE_Base_Class $object)
5092
+	{
5093
+		$className = $this->_get_class_name();
5094
+		if (! $object instanceof $className) {
5095
+			throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
5096
+				is_object($object) ? get_class($object) : $object, $className));
5097
+		}
5098
+		/** @var $object EE_Base_Class */
5099
+		if (! $object->ID()) {
5100
+			throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
5101
+				"event_espresso"), get_class($this)));
5102
+		}
5103
+		// double check it's not already there
5104
+		$classInstance = $this->get_from_entity_map($object->ID());
5105
+		if ($classInstance) {
5106
+			return $classInstance;
5107
+		}
5108
+		$this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
5109
+		return $object;
5110
+	}
5111
+
5112
+
5113
+
5114
+	/**
5115
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
5116
+	 * if no identifier is provided, then the entire entity map is emptied
5117
+	 *
5118
+	 * @param int|string $id the ID of the model object
5119
+	 * @return boolean
5120
+	 */
5121
+	public function clear_entity_map($id = null)
5122
+	{
5123
+		if (empty($id)) {
5124
+			$this->_entity_map[EEM_Base::$_model_query_blog_id] = array();
5125
+			return true;
5126
+		}
5127
+		if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
5128
+			unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
5129
+			return true;
5130
+		}
5131
+		return false;
5132
+	}
5133
+
5134
+
5135
+
5136
+	/**
5137
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
5138
+	 * Given an array where keys are column (or column alias) names and values,
5139
+	 * returns an array of their corresponding field names and database values
5140
+	 *
5141
+	 * @param array $cols_n_values
5142
+	 * @return array
5143
+	 */
5144
+	public function deduce_fields_n_values_from_cols_n_values($cols_n_values)
5145
+	{
5146
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
5147
+	}
5148
+
5149
+
5150
+
5151
+	/**
5152
+	 * _deduce_fields_n_values_from_cols_n_values
5153
+	 * Given an array where keys are column (or column alias) names and values,
5154
+	 * returns an array of their corresponding field names and database values
5155
+	 *
5156
+	 * @param string $cols_n_values
5157
+	 * @return array
5158
+	 */
5159
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values)
5160
+	{
5161
+		$this_model_fields_n_values = array();
5162
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
5163
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not($cols_n_values,
5164
+				$table_obj->get_fully_qualified_pk_column(), $table_obj->get_pk_column());
5165
+			//there is a primary key on this table and its not set. Use defaults for all its columns
5166
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
5167
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5168
+					if (! $field_obj->is_db_only_field()) {
5169
+						//prepare field as if its coming from db
5170
+						$prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5171
+						$this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
5172
+					}
5173
+				}
5174
+			} else {
5175
+				//the table's rows existed. Use their values
5176
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5177
+					if (! $field_obj->is_db_only_field()) {
5178
+						$this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5179
+							$cols_n_values, $field_obj->get_qualified_column(),
5180
+							$field_obj->get_table_column()
5181
+						);
5182
+					}
5183
+				}
5184
+			}
5185
+		}
5186
+		return $this_model_fields_n_values;
5187
+	}
5188
+
5189
+
5190
+
5191
+	/**
5192
+	 * @param $cols_n_values
5193
+	 * @param $qualified_column
5194
+	 * @param $regular_column
5195
+	 * @return null
5196
+	 */
5197
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
5198
+	{
5199
+		$value = null;
5200
+		//ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
5201
+		//does the field on the model relate to this column retrieved from the db?
5202
+		//or is it a db-only field? (not relating to the model)
5203
+		if (isset($cols_n_values[$qualified_column])) {
5204
+			$value = $cols_n_values[$qualified_column];
5205
+		} elseif (isset($cols_n_values[$regular_column])) {
5206
+			$value = $cols_n_values[$regular_column];
5207
+		}
5208
+		return $value;
5209
+	}
5210
+
5211
+
5212
+
5213
+	/**
5214
+	 * refresh_entity_map_from_db
5215
+	 * Makes sure the model object in the entity map at $id assumes the values
5216
+	 * of the database (opposite of EE_base_Class::save())
5217
+	 *
5218
+	 * @param int|string $id
5219
+	 * @return EE_Base_Class
5220
+	 * @throws EE_Error
5221
+	 */
5222
+	public function refresh_entity_map_from_db($id)
5223
+	{
5224
+		$obj_in_map = $this->get_from_entity_map($id);
5225
+		if ($obj_in_map) {
5226
+			$wpdb_results = $this->_get_all_wpdb_results(
5227
+				array(array($this->get_primary_key_field()->get_name() => $id), 'limit' => 1)
5228
+			);
5229
+			if ($wpdb_results && is_array($wpdb_results)) {
5230
+				$one_row = reset($wpdb_results);
5231
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
5232
+					$obj_in_map->set_from_db($field_name, $db_value);
5233
+				}
5234
+				//clear the cache of related model objects
5235
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5236
+					$obj_in_map->clear_cache($relation_name, null, true);
5237
+				}
5238
+			}
5239
+			$this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
5240
+			return $obj_in_map;
5241
+		}
5242
+		return $this->get_one_by_ID($id);
5243
+	}
5244
+
5245
+
5246
+
5247
+	/**
5248
+	 * refresh_entity_map_with
5249
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
5250
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
5251
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
5252
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
5253
+	 *
5254
+	 * @param int|string    $id
5255
+	 * @param EE_Base_Class $replacing_model_obj
5256
+	 * @return \EE_Base_Class
5257
+	 * @throws EE_Error
5258
+	 */
5259
+	public function refresh_entity_map_with($id, $replacing_model_obj)
5260
+	{
5261
+		$obj_in_map = $this->get_from_entity_map($id);
5262
+		if ($obj_in_map) {
5263
+			if ($replacing_model_obj instanceof EE_Base_Class) {
5264
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
5265
+					$obj_in_map->set($field_name, $value);
5266
+				}
5267
+				//make the model object in the entity map's cache match the $replacing_model_obj
5268
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
5269
+					$obj_in_map->clear_cache($relation_name, null, true);
5270
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
5271
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
5272
+					}
5273
+				}
5274
+			}
5275
+			return $obj_in_map;
5276
+		}
5277
+		$this->add_to_entity_map($replacing_model_obj);
5278
+		return $replacing_model_obj;
5279
+	}
5280
+
5281
+
5282
+
5283
+	/**
5284
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
5285
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
5286
+	 * require_once($this->_getClassName().".class.php");
5287
+	 *
5288
+	 * @return string
5289
+	 */
5290
+	private function _get_class_name()
5291
+	{
5292
+		return "EE_" . $this->get_this_model_name();
5293
+	}
5294
+
5295
+
5296
+
5297
+	/**
5298
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
5299
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
5300
+	 * it would be 'Events'.
5301
+	 *
5302
+	 * @param int $quantity
5303
+	 * @return string
5304
+	 */
5305
+	public function item_name($quantity = 1)
5306
+	{
5307
+		return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5308
+	}
5309
+
5310
+
5311
+
5312
+	/**
5313
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
5314
+	 * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
5315
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
5316
+	 * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
5317
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
5318
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
5319
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
5320
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
5321
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
5322
+	 * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
5323
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
5324
+	 *        return $previousReturnValue.$returnString;
5325
+	 * }
5326
+	 * require('EEM_Answer.model.php');
5327
+	 * $answer=EEM_Answer::instance();
5328
+	 * echo $answer->my_callback('monkeys',100);
5329
+	 * //will output "you called my_callback! and passed args:monkeys,100"
5330
+	 *
5331
+	 * @param string $methodName name of method which was called on a child of EE_TempBase, but which
5332
+	 * @param array  $args       array of original arguments passed to the function
5333
+	 * @throws EE_Error
5334
+	 * @return mixed whatever the plugin which calls add_filter decides
5335
+	 */
5336
+	public function __call($methodName, $args)
5337
+	{
5338
+		$className = get_class($this);
5339
+		$tagName = "FHEE__{$className}__{$methodName}";
5340
+		if (! has_filter($tagName)) {
5341
+			throw new EE_Error(
5342
+				sprintf(
5343
+					__('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 );',
5344
+						'event_espresso'),
5345
+					$methodName,
5346
+					$className,
5347
+					$tagName,
5348
+					'<br />'
5349
+				)
5350
+			);
5351
+		}
5352
+		return apply_filters($tagName, null, $this, $args);
5353
+	}
5354
+
5355
+
5356
+
5357
+	/**
5358
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
5359
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
5360
+	 *
5361
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
5362
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
5363
+	 *                                                       the object's class name
5364
+	 *                                                       or object's ID
5365
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
5366
+	 *                                                       exists in the database. If it does not, we add it
5367
+	 * @throws EE_Error
5368
+	 * @return EE_Base_Class
5369
+	 */
5370
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
5371
+	{
5372
+		$className = $this->_get_class_name();
5373
+		if ($base_class_obj_or_id instanceof $className) {
5374
+			$model_object = $base_class_obj_or_id;
5375
+		} else {
5376
+			$primary_key_field = $this->get_primary_key_field();
5377
+			if (
5378
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
5379
+				&& (
5380
+					is_int($base_class_obj_or_id)
5381
+					|| is_string($base_class_obj_or_id)
5382
+				)
5383
+			) {
5384
+				// assume it's an ID.
5385
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
5386
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5387
+			} else if (
5388
+				$primary_key_field instanceof EE_Primary_Key_String_Field
5389
+				&& is_string($base_class_obj_or_id)
5390
+			) {
5391
+				// assume its a string representation of the object
5392
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
5393
+			} else {
5394
+				throw new EE_Error(
5395
+					sprintf(
5396
+						__(
5397
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5398
+							'event_espresso'
5399
+						),
5400
+						$base_class_obj_or_id,
5401
+						$this->_get_class_name(),
5402
+						print_r($base_class_obj_or_id, true)
5403
+					)
5404
+				);
5405
+			}
5406
+		}
5407
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
5408
+			$model_object->save();
5409
+		}
5410
+		return $model_object;
5411
+	}
5412
+
5413
+
5414
+
5415
+	/**
5416
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
5417
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
5418
+	 * returns it ID.
5419
+	 *
5420
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
5421
+	 * @return int|string depending on the type of this model object's ID
5422
+	 * @throws EE_Error
5423
+	 */
5424
+	public function ensure_is_ID($base_class_obj_or_id)
5425
+	{
5426
+		$className = $this->_get_class_name();
5427
+		if ($base_class_obj_or_id instanceof $className) {
5428
+			/** @var $base_class_obj_or_id EE_Base_Class */
5429
+			$id = $base_class_obj_or_id->ID();
5430
+		} elseif (is_int($base_class_obj_or_id)) {
5431
+			//assume it's an ID
5432
+			$id = $base_class_obj_or_id;
5433
+		} elseif (is_string($base_class_obj_or_id)) {
5434
+			//assume its a string representation of the object
5435
+			$id = $base_class_obj_or_id;
5436
+		} else {
5437
+			throw new EE_Error(sprintf(__("'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
5438
+				'event_espresso'), $base_class_obj_or_id, $this->_get_class_name(),
5439
+				print_r($base_class_obj_or_id, true)));
5440
+		}
5441
+		return $id;
5442
+	}
5443
+
5444
+
5445
+
5446
+	/**
5447
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
5448
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
5449
+	 * been sanitized and converted into the appropriate domain.
5450
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
5451
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
5452
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
5453
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
5454
+	 * $EVT = EEM_Event::instance(); $old_setting =
5455
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
5456
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
5457
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
5458
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
5459
+	 *
5460
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
5461
+	 * @return void
5462
+	 */
5463
+	public function assume_values_already_prepared_by_model_object(
5464
+		$values_already_prepared = self::not_prepared_by_model_object
5465
+	) {
5466
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
5467
+	}
5468
+
5469
+
5470
+
5471
+	/**
5472
+	 * Read comments for assume_values_already_prepared_by_model_object()
5473
+	 *
5474
+	 * @return int
5475
+	 */
5476
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
5477
+	{
5478
+		return $this->_values_already_prepared_by_model_object;
5479
+	}
5480
+
5481
+
5482
+
5483
+	/**
5484
+	 * Gets all the indexes on this model
5485
+	 *
5486
+	 * @return EE_Index[]
5487
+	 */
5488
+	public function indexes()
5489
+	{
5490
+		return $this->_indexes;
5491
+	}
5492
+
5493
+
5494
+
5495
+	/**
5496
+	 * Gets all the Unique Indexes on this model
5497
+	 *
5498
+	 * @return EE_Unique_Index[]
5499
+	 */
5500
+	public function unique_indexes()
5501
+	{
5502
+		$unique_indexes = array();
5503
+		foreach ($this->_indexes as $name => $index) {
5504
+			if ($index instanceof EE_Unique_Index) {
5505
+				$unique_indexes [$name] = $index;
5506
+			}
5507
+		}
5508
+		return $unique_indexes;
5509
+	}
5510
+
5511
+
5512
+
5513
+	/**
5514
+	 * Gets all the fields which, when combined, make the primary key.
5515
+	 * This is usually just an array with 1 element (the primary key), but in cases
5516
+	 * where there is no primary key, it's a combination of fields as defined
5517
+	 * on a primary index
5518
+	 *
5519
+	 * @return EE_Model_Field_Base[] indexed by the field's name
5520
+	 * @throws EE_Error
5521
+	 */
5522
+	public function get_combined_primary_key_fields()
5523
+	{
5524
+		foreach ($this->indexes() as $index) {
5525
+			if ($index instanceof EE_Primary_Key_Index) {
5526
+				return $index->fields();
5527
+			}
5528
+		}
5529
+		return array($this->primary_key_name() => $this->get_primary_key_field());
5530
+	}
5531
+
5532
+
5533
+
5534
+	/**
5535
+	 * Used to build a primary key string (when the model has no primary key),
5536
+	 * which can be used a unique string to identify this model object.
5537
+	 *
5538
+	 * @param array $cols_n_values keys are field names, values are their values
5539
+	 * @return string
5540
+	 * @throws EE_Error
5541
+	 */
5542
+	public function get_index_primary_key_string($cols_n_values)
5543
+	{
5544
+		$cols_n_values_for_primary_key_index = array_intersect_key($cols_n_values,
5545
+			$this->get_combined_primary_key_fields());
5546
+		return http_build_query($cols_n_values_for_primary_key_index);
5547
+	}
5548
+
5549
+
5550
+
5551
+	/**
5552
+	 * Gets the field values from the primary key string
5553
+	 *
5554
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
5555
+	 * @param string $index_primary_key_string
5556
+	 * @return null|array
5557
+	 * @throws EE_Error
5558
+	 */
5559
+	public function parse_index_primary_key_string($index_primary_key_string)
5560
+	{
5561
+		$key_fields = $this->get_combined_primary_key_fields();
5562
+		//check all of them are in the $id
5563
+		$key_vals_in_combined_pk = array();
5564
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5565
+		foreach ($key_fields as $key_field_name => $field_obj) {
5566
+			if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5567
+				return null;
5568
+			}
5569
+		}
5570
+		return $key_vals_in_combined_pk;
5571
+	}
5572
+
5573
+
5574
+
5575
+	/**
5576
+	 * verifies that an array of key-value pairs for model fields has a key
5577
+	 * for each field comprising the primary key index
5578
+	 *
5579
+	 * @param array $key_vals
5580
+	 * @return boolean
5581
+	 * @throws EE_Error
5582
+	 */
5583
+	public function has_all_combined_primary_key_fields($key_vals)
5584
+	{
5585
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5586
+		foreach ($keys_it_should_have as $key) {
5587
+			if (! isset($key_vals[$key])) {
5588
+				return false;
5589
+			}
5590
+		}
5591
+		return true;
5592
+	}
5593
+
5594
+
5595
+
5596
+	/**
5597
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
5598
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
5599
+	 *
5600
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
5601
+	 * @param array               $query_params                     like EEM_Base::get_all's query_params.
5602
+	 * @throws EE_Error
5603
+	 * @return \EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
5604
+	 *                                                              indexed)
5605
+	 */
5606
+	public function get_all_copies($model_object_or_attributes_array, $query_params = array())
5607
+	{
5608
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
5609
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
5610
+		} elseif (is_array($model_object_or_attributes_array)) {
5611
+			$attributes_array = $model_object_or_attributes_array;
5612
+		} else {
5613
+			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",
5614
+				"event_espresso"), $model_object_or_attributes_array));
5615
+		}
5616
+		//even copies obviously won't have the same ID, so remove the primary key
5617
+		//from the WHERE conditions for finding copies (if there is a primary key, of course)
5618
+		if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
5619
+			unset($attributes_array[$this->primary_key_name()]);
5620
+		}
5621
+		if (isset($query_params[0])) {
5622
+			$query_params[0] = array_merge($attributes_array, $query_params);
5623
+		} else {
5624
+			$query_params[0] = $attributes_array;
5625
+		}
5626
+		return $this->get_all($query_params);
5627
+	}
5628
+
5629
+
5630
+
5631
+	/**
5632
+	 * Gets the first copy we find. See get_all_copies for more details
5633
+	 *
5634
+	 * @param       mixed EE_Base_Class | array        $model_object_or_attributes_array
5635
+	 * @param array $query_params
5636
+	 * @return EE_Base_Class
5637
+	 * @throws EE_Error
5638
+	 */
5639
+	public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5640
+	{
5641
+		if (! is_array($query_params)) {
5642
+			EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5643
+				sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5644
+					gettype($query_params)), '4.6.0');
5645
+			$query_params = array();
5646
+		}
5647
+		$query_params['limit'] = 1;
5648
+		$copies = $this->get_all_copies($model_object_or_attributes_array, $query_params);
5649
+		if (is_array($copies)) {
5650
+			return array_shift($copies);
5651
+		}
5652
+		return null;
5653
+	}
5654
+
5655
+
5656
+
5657
+	/**
5658
+	 * Updates the item with the specified id. Ignores default query parameters because
5659
+	 * we have specified the ID, and its assumed we KNOW what we're doing
5660
+	 *
5661
+	 * @param array      $fields_n_values keys are field names, values are their new values
5662
+	 * @param int|string $id              the value of the primary key to update
5663
+	 * @return int number of rows updated
5664
+	 * @throws EE_Error
5665
+	 */
5666
+	public function update_by_ID($fields_n_values, $id)
5667
+	{
5668
+		$query_params = array(
5669
+			0                          => array($this->get_primary_key_field()->get_name() => $id),
5670
+			'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
5671
+		);
5672
+		return $this->update($fields_n_values, $query_params);
5673
+	}
5674
+
5675
+
5676
+
5677
+	/**
5678
+	 * Changes an operator which was supplied to the models into one usable in SQL
5679
+	 *
5680
+	 * @param string $operator_supplied
5681
+	 * @return string an operator which can be used in SQL
5682
+	 * @throws EE_Error
5683
+	 */
5684
+	private function _prepare_operator_for_sql($operator_supplied)
5685
+	{
5686
+		$sql_operator = isset($this->_valid_operators[$operator_supplied]) ? $this->_valid_operators[$operator_supplied]
5687
+			: null;
5688
+		if ($sql_operator) {
5689
+			return $sql_operator;
5690
+		}
5691
+		throw new EE_Error(
5692
+			sprintf(
5693
+				__(
5694
+					"The operator '%s' is not in the list of valid operators: %s",
5695
+					"event_espresso"
5696
+				), $operator_supplied, implode(",", array_keys($this->_valid_operators))
5697
+			)
5698
+		);
5699
+	}
5700
+
5701
+
5702
+
5703
+	/**
5704
+	 * Gets an array where keys are the primary keys and values are their 'names'
5705
+	 * (as determined by the model object's name() function, which is often overridden)
5706
+	 *
5707
+	 * @param array $query_params like get_all's
5708
+	 * @return string[]
5709
+	 * @throws EE_Error
5710
+	 */
5711
+	public function get_all_names($query_params = array())
5712
+	{
5713
+		$objs = $this->get_all($query_params);
5714
+		$names = array();
5715
+		foreach ($objs as $obj) {
5716
+			$names[$obj->ID()] = $obj->name();
5717
+		}
5718
+		return $names;
5719
+	}
5720
+
5721
+
5722
+
5723
+	/**
5724
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
5725
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
5726
+	 * this is duplicated effort and reduces efficiency) you would be better to use
5727
+	 * array_keys() on $model_objects.
5728
+	 *
5729
+	 * @param \EE_Base_Class[] $model_objects
5730
+	 * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
5731
+	 *                                               in the returned array
5732
+	 * @return array
5733
+	 * @throws EE_Error
5734
+	 */
5735
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
5736
+	{
5737
+		if (! $this->has_primary_key_field()) {
5738
+			if (WP_DEBUG) {
5739
+				EE_Error::add_error(
5740
+					__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
5741
+					__FILE__,
5742
+					__FUNCTION__,
5743
+					__LINE__
5744
+				);
5745
+			}
5746
+		}
5747
+		$IDs = array();
5748
+		foreach ($model_objects as $model_object) {
5749
+			$id = $model_object->ID();
5750
+			if (! $id) {
5751
+				if ($filter_out_empty_ids) {
5752
+					continue;
5753
+				}
5754
+				if (WP_DEBUG) {
5755
+					EE_Error::add_error(
5756
+						__(
5757
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
5758
+							'event_espresso'
5759
+						),
5760
+						__FILE__,
5761
+						__FUNCTION__,
5762
+						__LINE__
5763
+					);
5764
+				}
5765
+			}
5766
+			$IDs[] = $id;
5767
+		}
5768
+		return $IDs;
5769
+	}
5770
+
5771
+
5772
+
5773
+	/**
5774
+	 * Returns the string used in capabilities relating to this model. If there
5775
+	 * are no capabilities that relate to this model returns false
5776
+	 *
5777
+	 * @return string|false
5778
+	 */
5779
+	public function cap_slug()
5780
+	{
5781
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
5782
+	}
5783
+
5784
+
5785
+
5786
+	/**
5787
+	 * Returns the capability-restrictions array (@see EEM_Base::_cap_restrictions).
5788
+	 * If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
5789
+	 * only returns the cap restrictions array in that context (ie, the array
5790
+	 * at that key)
5791
+	 *
5792
+	 * @param string $context
5793
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
5794
+	 * @throws EE_Error
5795
+	 */
5796
+	public function cap_restrictions($context = EEM_Base::caps_read)
5797
+	{
5798
+		EEM_Base::verify_is_valid_cap_context($context);
5799
+		//check if we ought to run the restriction generator first
5800
+		if (
5801
+			isset($this->_cap_restriction_generators[$context])
5802
+			&& $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
5803
+			&& ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
5804
+		) {
5805
+			$this->_cap_restrictions[$context] = array_merge(
5806
+				$this->_cap_restrictions[$context],
5807
+				$this->_cap_restriction_generators[$context]->generate_restrictions()
5808
+			);
5809
+		}
5810
+		//and make sure we've finalized the construction of each restriction
5811
+		foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
5812
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
5813
+				$where_conditions_obj->_finalize_construct($this);
5814
+			}
5815
+		}
5816
+		return $this->_cap_restrictions[$context];
5817
+	}
5818
+
5819
+
5820
+
5821
+	/**
5822
+	 * Indicating whether or not this model thinks its a wp core model
5823
+	 *
5824
+	 * @return boolean
5825
+	 */
5826
+	public function is_wp_core_model()
5827
+	{
5828
+		return $this->_wp_core_model;
5829
+	}
5830
+
5831
+
5832
+
5833
+	/**
5834
+	 * Gets all the caps that are missing which impose a restriction on
5835
+	 * queries made in this context
5836
+	 *
5837
+	 * @param string $context one of EEM_Base::caps_ constants
5838
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
5839
+	 * @throws EE_Error
5840
+	 */
5841
+	public function caps_missing($context = EEM_Base::caps_read)
5842
+	{
5843
+		$missing_caps = array();
5844
+		$cap_restrictions = $this->cap_restrictions($context);
5845
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5846
+			if (! EE_Capabilities::instance()
5847
+								 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5848
+			) {
5849
+				$missing_caps[$cap] = $restriction_if_no_cap;
5850
+			}
5851
+		}
5852
+		return $missing_caps;
5853
+	}
5854
+
5855
+
5856
+
5857
+	/**
5858
+	 * Gets the mapping from capability contexts to action strings used in capability names
5859
+	 *
5860
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
5861
+	 * one of 'read', 'edit', or 'delete'
5862
+	 */
5863
+	public function cap_contexts_to_cap_action_map()
5864
+	{
5865
+		return apply_filters('FHEE__EEM_Base__cap_contexts_to_cap_action_map', $this->_cap_contexts_to_cap_action_map,
5866
+			$this);
5867
+	}
5868
+
5869
+
5870
+
5871
+	/**
5872
+	 * Gets the action string for the specified capability context
5873
+	 *
5874
+	 * @param string $context
5875
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
5876
+	 * @throws EE_Error
5877
+	 */
5878
+	public function cap_action_for_context($context)
5879
+	{
5880
+		$mapping = $this->cap_contexts_to_cap_action_map();
5881
+		if (isset($mapping[$context])) {
5882
+			return $mapping[$context];
5883
+		}
5884
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
5885
+			return $action;
5886
+		}
5887
+		throw new EE_Error(
5888
+			sprintf(
5889
+				__('Cannot find capability restrictions for context "%1$s", allowed values are:%2$s', 'event_espresso'),
5890
+				$context,
5891
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
5892
+			)
5893
+		);
5894
+	}
5895
+
5896
+
5897
+
5898
+	/**
5899
+	 * Returns all the capability contexts which are valid when querying models
5900
+	 *
5901
+	 * @return array
5902
+	 */
5903
+	public static function valid_cap_contexts()
5904
+	{
5905
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', array(
5906
+			self::caps_read,
5907
+			self::caps_read_admin,
5908
+			self::caps_edit,
5909
+			self::caps_delete,
5910
+		));
5911
+	}
5912
+
5913
+
5914
+
5915
+	/**
5916
+	 * Returns all valid options for 'default_where_conditions'
5917
+	 *
5918
+	 * @return array
5919
+	 */
5920
+	public static function valid_default_where_conditions()
5921
+	{
5922
+		return array(
5923
+			EEM_Base::default_where_conditions_all,
5924
+			EEM_Base::default_where_conditions_this_only,
5925
+			EEM_Base::default_where_conditions_others_only,
5926
+			EEM_Base::default_where_conditions_minimum_all,
5927
+			EEM_Base::default_where_conditions_minimum_others,
5928
+			EEM_Base::default_where_conditions_none
5929
+		);
5930
+	}
5931
+
5932
+	// public static function default_where_conditions_full
5933
+	/**
5934
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
5935
+	 *
5936
+	 * @param string $context
5937
+	 * @return bool
5938
+	 * @throws EE_Error
5939
+	 */
5940
+	static public function verify_is_valid_cap_context($context)
5941
+	{
5942
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
5943
+		if (in_array($context, $valid_cap_contexts)) {
5944
+			return true;
5945
+		}
5946
+		throw new EE_Error(
5947
+			sprintf(
5948
+				__(
5949
+					'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
5950
+					'event_espresso'
5951
+				),
5952
+				$context,
5953
+				'EEM_Base',
5954
+				implode(',', $valid_cap_contexts)
5955
+			)
5956
+		);
5957
+	}
5958
+
5959
+
5960
+
5961
+	/**
5962
+	 * Clears all the models field caches. This is only useful when a sub-class
5963
+	 * might have added a field or something and these caches might be invalidated
5964
+	 */
5965
+	protected function _invalidate_field_caches()
5966
+	{
5967
+		$this->_cache_foreign_key_to_fields = array();
5968
+		$this->_cached_fields = null;
5969
+		$this->_cached_fields_non_db_only = null;
5970
+	}
5971
+
5972
+
5973
+
5974
+	/**
5975
+	 * _instantiate_new_instance_from_db
5976
+	 *
5977
+	 * @param string $class_name
5978
+	 * @param array  $arguments
5979
+	 * @return \EE_Base_Class
5980
+	 * @throws Exception
5981
+	 */
5982
+	public function _instantiate_new_instance_from_db($class_name, $arguments)
5983
+	{
5984
+		if ( ! class_exists($class_name)) {
5985
+			throw new EE_Error(
5986
+				sprintf(
5987
+					__('The "%s" class does not exist. Please ensure that an autoloader is set.', 'event_espresso'),
5988
+					$class_name
5989
+				)
5990
+			);
5991
+		}
5992
+		return call_user_func_array(
5993
+			array($class_name, 'static_constructor'),
5994
+			array((array)$arguments, true, $this->_timezone)
5995
+		);
5996
+	}
5997
+
5998
+
5999
+	/**
6000
+	 * Gets the list of all the where query param keys that relate to logic instead of field names
6001
+	 * (eg "and", "or", "not").
6002
+	 *
6003
+	 * @return array
6004
+	 */
6005
+	public function logic_query_param_keys()
6006
+	{
6007
+		return $this->_logic_query_param_keys;
6008
+	}
6009
+
6010
+
6011
+
6012
+	/**
6013
+	 * Determines whether or not the where query param array key is for a logic query param.
6014
+	 * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
6015
+	 * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
6016
+	 *
6017
+	 * @param $query_param_key
6018
+	 * @return bool
6019
+	 */
6020
+	public function is_logic_query_param_key($query_param_key)
6021
+	{
6022
+		foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
6023
+			if ($query_param_key === $logic_query_param_key
6024
+				|| strpos($query_param_key, $logic_query_param_key . '*') === 0
6025
+			) {
6026
+				return true;
6027
+			}
6028
+		}
6029
+		return false;
6030
+	}
6031 6031
 
6032 6032
 
6033 6033
 
Please login to merge, or discard this patch.
Spacing   +156 added lines, -156 removed lines patch added patch discarded remove patch
@@ -519,8 +519,8 @@  discard block
 block discarded – undo
519 519
     protected function __construct($timezone = null)
520 520
     {
521 521
         // check that the model has not been loaded too soon
522
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
523
-            throw new EE_Error (
522
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
523
+            throw new EE_Error(
524 524
                 sprintf(
525 525
                     __('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.',
526 526
                         'event_espresso'),
@@ -540,7 +540,7 @@  discard block
 block discarded – undo
540 540
          *
541 541
          * @var EE_Table_Base[] $_tables
542 542
          */
543
-        $this->_tables = apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
543
+        $this->_tables = apply_filters('FHEE__'.get_class($this).'__construct__tables', $this->_tables);
544 544
         foreach ($this->_tables as $table_alias => $table_obj) {
545 545
             /** @var $table_obj EE_Table_Base */
546 546
             $table_obj->_construct_finalize_with_alias($table_alias);
@@ -555,10 +555,10 @@  discard block
 block discarded – undo
555 555
          *
556 556
          * @param EE_Model_Field_Base[] $_fields
557 557
          */
558
-        $this->_fields = apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
558
+        $this->_fields = apply_filters('FHEE__'.get_class($this).'__construct__fields', $this->_fields);
559 559
         $this->_invalidate_field_caches();
560 560
         foreach ($this->_fields as $table_alias => $fields_for_table) {
561
-            if (! array_key_exists($table_alias, $this->_tables)) {
561
+            if ( ! array_key_exists($table_alias, $this->_tables)) {
562 562
                 throw new EE_Error(sprintf(__("Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
563 563
                     'event_espresso'), $table_alias, implode(",", $this->_fields)));
564 564
             }
@@ -586,7 +586,7 @@  discard block
 block discarded – undo
586 586
          *
587 587
          * @param EE_Model_Relation_Base[] $_model_relations
588 588
          */
589
-        $this->_model_relations = apply_filters('FHEE__' . get_class($this) . '__construct__model_relations',
589
+        $this->_model_relations = apply_filters('FHEE__'.get_class($this).'__construct__model_relations',
590 590
             $this->_model_relations);
591 591
         foreach ($this->_model_relations as $model_name => $relation_obj) {
592 592
             /** @var $relation_obj EE_Model_Relation_Base */
@@ -598,12 +598,12 @@  discard block
 block discarded – undo
598 598
         }
599 599
         $this->set_timezone($timezone);
600 600
         //finalize default where condition strategy, or set default
601
-        if (! $this->_default_where_conditions_strategy) {
601
+        if ( ! $this->_default_where_conditions_strategy) {
602 602
             //nothing was set during child constructor, so set default
603 603
             $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
604 604
         }
605 605
         $this->_default_where_conditions_strategy->_finalize_construct($this);
606
-        if (! $this->_minimum_where_conditions_strategy) {
606
+        if ( ! $this->_minimum_where_conditions_strategy) {
607 607
             //nothing was set during child constructor, so set default
608 608
             $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
609 609
         }
@@ -616,7 +616,7 @@  discard block
 block discarded – undo
616 616
         //initialize the standard cap restriction generators if none were specified by the child constructor
617 617
         if ($this->_cap_restriction_generators !== false) {
618 618
             foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
619
-                if (! isset($this->_cap_restriction_generators[$cap_context])) {
619
+                if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
620 620
                     $this->_cap_restriction_generators[$cap_context] = apply_filters(
621 621
                         'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
622 622
                         new EE_Restriction_Generator_Protected(),
@@ -629,10 +629,10 @@  discard block
 block discarded – undo
629 629
         //if there are cap restriction generators, use them to make the default cap restrictions
630 630
         if ($this->_cap_restriction_generators !== false) {
631 631
             foreach ($this->_cap_restriction_generators as $context => $generator_object) {
632
-                if (! $generator_object) {
632
+                if ( ! $generator_object) {
633 633
                     continue;
634 634
                 }
635
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
635
+                if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
636 636
                     throw new EE_Error(
637 637
                         sprintf(
638 638
                             __('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.',
@@ -643,12 +643,12 @@  discard block
 block discarded – undo
643 643
                     );
644 644
                 }
645 645
                 $action = $this->cap_action_for_context($context);
646
-                if (! $generator_object->construction_finalized()) {
646
+                if ( ! $generator_object->construction_finalized()) {
647 647
                     $generator_object->_construct_finalize($this, $action);
648 648
                 }
649 649
             }
650 650
         }
651
-        do_action('AHEE__' . get_class($this) . '__construct__end');
651
+        do_action('AHEE__'.get_class($this).'__construct__end');
652 652
     }
653 653
 
654 654
 
@@ -683,7 +683,7 @@  discard block
 block discarded – undo
683 683
      */
684 684
     public static function set_model_query_blog_id($blog_id = 0)
685 685
     {
686
-        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int)$blog_id : get_current_blog_id();
686
+        EEM_Base::$_model_query_blog_id = $blog_id > 0 ? (int) $blog_id : get_current_blog_id();
687 687
     }
688 688
 
689 689
 
@@ -717,7 +717,7 @@  discard block
 block discarded – undo
717 717
     public static function instance($timezone = null)
718 718
     {
719 719
         // check if instance of Espresso_model already exists
720
-        if (! static::$_instance instanceof static) {
720
+        if ( ! static::$_instance instanceof static) {
721 721
             // instantiate Espresso_model
722 722
             static::$_instance = new static(
723 723
                 $timezone,
@@ -756,7 +756,7 @@  discard block
 block discarded – undo
756 756
             foreach ($r->getDefaultProperties() as $property => $value) {
757 757
                 //don't set instance to null like it was originally,
758 758
                 //but it's static anyways, and we're ignoring static properties (for now at least)
759
-                if (! isset($static_properties[$property])) {
759
+                if ( ! isset($static_properties[$property])) {
760 760
                     static::$_instance->{$property} = $value;
761 761
                 }
762 762
             }
@@ -781,7 +781,7 @@  discard block
 block discarded – undo
781 781
      */
782 782
     public function status_array($translated = false)
783 783
     {
784
-        if (! array_key_exists('Status', $this->_model_relations)) {
784
+        if ( ! array_key_exists('Status', $this->_model_relations)) {
785 785
             return array();
786 786
         }
787 787
         $model_name = $this->get_this_model_name();
@@ -984,17 +984,17 @@  discard block
 block discarded – undo
984 984
     public function wp_user_field_name()
985 985
     {
986 986
         try {
987
-            if (! empty($this->_model_chain_to_wp_user)) {
987
+            if ( ! empty($this->_model_chain_to_wp_user)) {
988 988
                 $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
989 989
                 $last_model_name = end($models_to_follow_to_wp_users);
990 990
                 $model_with_fk_to_wp_users = EE_Registry::instance()->load_model($last_model_name);
991
-                $model_chain_to_wp_user = $this->_model_chain_to_wp_user . '.';
991
+                $model_chain_to_wp_user = $this->_model_chain_to_wp_user.'.';
992 992
             } else {
993 993
                 $model_with_fk_to_wp_users = $this;
994 994
                 $model_chain_to_wp_user = '';
995 995
             }
996 996
             $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
997
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
997
+            return $model_chain_to_wp_user.$wp_user_field->get_name();
998 998
         } catch (EE_Error $e) {
999 999
             return false;
1000 1000
         }
@@ -1065,12 +1065,12 @@  discard block
 block discarded – undo
1065 1065
         // remember the custom selections, if any, and type cast as array
1066 1066
         // (unless $columns_to_select is an object, then just set as an empty array)
1067 1067
         // Note: (array) 'some string' === array( 'some string' )
1068
-        $this->_custom_selections = ! is_object($columns_to_select) ? (array)$columns_to_select : array();
1068
+        $this->_custom_selections = ! is_object($columns_to_select) ? (array) $columns_to_select : array();
1069 1069
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1070 1070
         $select_expressions = $columns_to_select !== null
1071 1071
             ? $this->_construct_select_from_input($columns_to_select)
1072 1072
             : $this->_construct_default_select_sql($model_query_info);
1073
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1073
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1074 1074
         return $this->_do_wpdb_query('get_results', array($SQL, $output));
1075 1075
     }
1076 1076
 
@@ -1115,7 +1115,7 @@  discard block
 block discarded – undo
1115 1115
         if (is_array($columns_to_select)) {
1116 1116
             $select_sql_array = array();
1117 1117
             foreach ($columns_to_select as $alias => $selection_and_datatype) {
1118
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1118
+                if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
1119 1119
                     throw new EE_Error(
1120 1120
                         sprintf(
1121 1121
                             __(
@@ -1127,7 +1127,7 @@  discard block
 block discarded – undo
1127 1127
                         )
1128 1128
                     );
1129 1129
                 }
1130
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1130
+                if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types)) {
1131 1131
                     throw new EE_Error(
1132 1132
                         sprintf(
1133 1133
                             __(
@@ -1199,7 +1199,7 @@  discard block
 block discarded – undo
1199 1199
      */
1200 1200
     public function alter_query_params_to_restrict_by_ID($id, $query_params = array())
1201 1201
     {
1202
-        if (! isset($query_params[0])) {
1202
+        if ( ! isset($query_params[0])) {
1203 1203
             $query_params[0] = array();
1204 1204
         }
1205 1205
         $conditions_from_id = $this->parse_index_primary_key_string($id);
@@ -1224,7 +1224,7 @@  discard block
 block discarded – undo
1224 1224
      */
1225 1225
     public function get_one($query_params = array())
1226 1226
     {
1227
-        if (! is_array($query_params)) {
1227
+        if ( ! is_array($query_params)) {
1228 1228
             EE_Error::doing_it_wrong('EEM_Base::get_one',
1229 1229
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1230 1230
                     gettype($query_params)), '4.6.0');
@@ -1415,7 +1415,7 @@  discard block
 block discarded – undo
1415 1415
                 return array();
1416 1416
             }
1417 1417
         }
1418
-        if (! is_array($query_params)) {
1418
+        if ( ! is_array($query_params)) {
1419 1419
             EE_Error::doing_it_wrong('EEM_Base::_get_consecutive',
1420 1420
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1421 1421
                     gettype($query_params)), '4.6.0');
@@ -1425,7 +1425,7 @@  discard block
 block discarded – undo
1425 1425
         $query_params[0][$field_to_order_by] = array($operand, $current_field_value);
1426 1426
         $query_params['limit'] = $limit;
1427 1427
         //set direction
1428
-        $incoming_orderby = isset($query_params['order_by']) ? (array)$query_params['order_by'] : array();
1428
+        $incoming_orderby = isset($query_params['order_by']) ? (array) $query_params['order_by'] : array();
1429 1429
         $query_params['order_by'] = $operand === '>'
1430 1430
             ? array($field_to_order_by => 'ASC') + $incoming_orderby
1431 1431
             : array($field_to_order_by => 'DESC') + $incoming_orderby;
@@ -1503,7 +1503,7 @@  discard block
 block discarded – undo
1503 1503
     {
1504 1504
         $field_settings = $this->field_settings_for($field_name);
1505 1505
         //if not a valid EE_Datetime_Field then throw error
1506
-        if (! $field_settings instanceof EE_Datetime_Field) {
1506
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
1507 1507
             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.',
1508 1508
                 'event_espresso'), $field_name));
1509 1509
         }
@@ -1582,7 +1582,7 @@  discard block
 block discarded – undo
1582 1582
         //load EEH_DTT_Helper
1583 1583
         $set_timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
1584 1584
         $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
1585
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime( $incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)) );
1585
+        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime($incomingDateTime->setTimezone(new DateTimeZone($this->_timezone)));
1586 1586
     }
1587 1587
 
1588 1588
 
@@ -1650,7 +1650,7 @@  discard block
 block discarded – undo
1650 1650
      */
1651 1651
     public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
1652 1652
     {
1653
-        if (! is_array($query_params)) {
1653
+        if ( ! is_array($query_params)) {
1654 1654
             EE_Error::doing_it_wrong('EEM_Base::update',
1655 1655
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
1656 1656
                     gettype($query_params)), '4.6.0');
@@ -1672,7 +1672,7 @@  discard block
 block discarded – undo
1672 1672
          * @param EEM_Base $model           the model being queried
1673 1673
          * @param array    $query_params    see EEM_Base::get_all()
1674 1674
          */
1675
-        $fields_n_values = (array)apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1675
+        $fields_n_values = (array) apply_filters('FHEE__EEM_Base__update__fields_n_values', $fields_n_values, $this,
1676 1676
             $query_params);
1677 1677
         //need to verify that, for any entry we want to update, there are entries in each secondary table.
1678 1678
         //to do that, for each table, verify that it's PK isn't null.
@@ -1686,7 +1686,7 @@  discard block
 block discarded – undo
1686 1686
         $wpdb_select_results = $this->_get_all_wpdb_results($query_params);
1687 1687
         foreach ($wpdb_select_results as $wpdb_result) {
1688 1688
             // type cast stdClass as array
1689
-            $wpdb_result = (array)$wpdb_result;
1689
+            $wpdb_result = (array) $wpdb_result;
1690 1690
             //get the model object's PK, as we'll want this if we need to insert a row into secondary tables
1691 1691
             if ($this->has_primary_key_field()) {
1692 1692
                 $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
@@ -1703,13 +1703,13 @@  discard block
 block discarded – undo
1703 1703
                     $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
1704 1704
                     //if there is no private key for this table on the results, it means there's no entry
1705 1705
                     //in this table, right? so insert a row in the current table, using any fields available
1706
-                    if (! (array_key_exists($this_table_pk_column, $wpdb_result)
1706
+                    if ( ! (array_key_exists($this_table_pk_column, $wpdb_result)
1707 1707
                            && $wpdb_result[$this_table_pk_column])
1708 1708
                     ) {
1709 1709
                         $success = $this->_insert_into_specific_table($table_obj, $fields_n_values,
1710 1710
                             $main_table_pk_value);
1711 1711
                         //if we died here, report the error
1712
-                        if (! $success) {
1712
+                        if ( ! $success) {
1713 1713
                             return false;
1714 1714
                         }
1715 1715
                     }
@@ -1740,7 +1740,7 @@  discard block
 block discarded – undo
1740 1740
                     $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
1741 1741
                 }
1742 1742
             }
1743
-            if (! $model_objs_affected_ids) {
1743
+            if ( ! $model_objs_affected_ids) {
1744 1744
                 //wait wait wait- if nothing was affected let's stop here
1745 1745
                 return 0;
1746 1746
             }
@@ -1767,7 +1767,7 @@  discard block
 block discarded – undo
1767 1767
                . $model_query_info->get_full_join_sql()
1768 1768
                . " SET "
1769 1769
                . $this->_construct_update_sql($fields_n_values)
1770
-               . $model_query_info->get_where_sql();//note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1770
+               . $model_query_info->get_where_sql(); //note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
1771 1771
         $rows_affected = $this->_do_wpdb_query('query', array($SQL));
1772 1772
         /**
1773 1773
          * Action called after a model update call has been made.
@@ -1778,7 +1778,7 @@  discard block
 block discarded – undo
1778 1778
          * @param int      $rows_affected
1779 1779
          */
1780 1780
         do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
1781
-        return $rows_affected;//how many supposedly got updated
1781
+        return $rows_affected; //how many supposedly got updated
1782 1782
     }
1783 1783
 
1784 1784
 
@@ -1806,7 +1806,7 @@  discard block
 block discarded – undo
1806 1806
         }
1807 1807
         $model_query_info = $this->_create_model_query_info_carrier($query_params);
1808 1808
         $select_expressions = $field->get_qualified_column();
1809
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
1809
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
1810 1810
         return $this->_do_wpdb_query('get_col', array($SQL));
1811 1811
     }
1812 1812
 
@@ -1824,7 +1824,7 @@  discard block
 block discarded – undo
1824 1824
     {
1825 1825
         $query_params['limit'] = 1;
1826 1826
         $col = $this->get_col($query_params, $field_to_select);
1827
-        if (! empty($col)) {
1827
+        if ( ! empty($col)) {
1828 1828
             return reset($col);
1829 1829
         }
1830 1830
         return null;
@@ -1855,7 +1855,7 @@  discard block
 block discarded – undo
1855 1855
             $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
1856 1856
             $value_sql = $prepared_value === null ? 'NULL'
1857 1857
                 : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
1858
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
1858
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
1859 1859
         }
1860 1860
         return implode(",", $cols_n_values);
1861 1861
     }
@@ -2033,7 +2033,7 @@  discard block
 block discarded – undo
2033 2033
          * @param int      $rows_deleted
2034 2034
          */
2035 2035
         do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
2036
-        return $rows_deleted;//how many supposedly got deleted
2036
+        return $rows_deleted; //how many supposedly got deleted
2037 2037
     }
2038 2038
 
2039 2039
 
@@ -2182,7 +2182,7 @@  discard block
 block discarded – undo
2182 2182
             foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
2183 2183
                 //make sure we have unique $ids
2184 2184
                 $ids = array_unique($ids);
2185
-                $query[] = $column . ' IN(' . implode(',', $ids) . ')';
2185
+                $query[] = $column.' IN('.implode(',', $ids).')';
2186 2186
             }
2187 2187
             $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
2188 2188
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2190,9 +2190,9 @@  discard block
 block discarded – undo
2190 2190
             foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
2191 2191
                 $values_for_each_combined_primary_key_for_a_row = array();
2192 2192
                 foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
2193
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
2193
+                    $values_for_each_combined_primary_key_for_a_row[] = $column.'='.$id;
2194 2194
                 }
2195
-                $ways_to_identify_a_row[] = '(' . implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2195
+                $ways_to_identify_a_row[] = '('.implode(' AND ', $values_for_each_combined_primary_key_for_a_row);
2196 2196
             }
2197 2197
             $query_part = implode(' OR ', $ways_to_identify_a_row);
2198 2198
         }
@@ -2238,9 +2238,9 @@  discard block
 block discarded – undo
2238 2238
                 $column_to_count = '*';
2239 2239
             }
2240 2240
         }
2241
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
2242
-        $SQL = "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2243
-        return (int)$this->_do_wpdb_query('get_var', array($SQL));
2241
+        $column_to_count = $distinct ? "DISTINCT ".$column_to_count : $column_to_count;
2242
+        $SQL = "SELECT COUNT(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2243
+        return (int) $this->_do_wpdb_query('get_var', array($SQL));
2244 2244
     }
2245 2245
 
2246 2246
 
@@ -2262,14 +2262,14 @@  discard block
 block discarded – undo
2262 2262
             $field_obj = $this->get_primary_key_field();
2263 2263
         }
2264 2264
         $column_to_count = $field_obj->get_qualified_column();
2265
-        $SQL = "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
2265
+        $SQL = "SELECT SUM(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
2266 2266
         $return_value = $this->_do_wpdb_query('get_var', array($SQL));
2267 2267
         $data_type = $field_obj->get_wpdb_data_type();
2268 2268
         if ($data_type === '%d' || $data_type === '%s') {
2269
-            return (float)$return_value;
2269
+            return (float) $return_value;
2270 2270
         }
2271 2271
         //must be %f
2272
-        return (float)$return_value;
2272
+        return (float) $return_value;
2273 2273
     }
2274 2274
 
2275 2275
 
@@ -2289,13 +2289,13 @@  discard block
 block discarded – undo
2289 2289
         //if we're in maintenance mode level 2, DON'T run any queries
2290 2290
         //because level 2 indicates the database needs updating and
2291 2291
         //is probably out of sync with the code
2292
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
2292
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
2293 2293
             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.",
2294 2294
                 "event_espresso")));
2295 2295
         }
2296 2296
         /** @type WPDB $wpdb */
2297 2297
         global $wpdb;
2298
-        if (! method_exists($wpdb, $wpdb_method)) {
2298
+        if ( ! method_exists($wpdb, $wpdb_method)) {
2299 2299
             throw new EE_Error(sprintf(__('There is no method named "%s" on Wordpress\' $wpdb object',
2300 2300
                 'event_espresso'), $wpdb_method));
2301 2301
         }
@@ -2307,7 +2307,7 @@  discard block
 block discarded – undo
2307 2307
         $this->show_db_query_if_previously_requested($wpdb->last_query);
2308 2308
         if (WP_DEBUG) {
2309 2309
             $wpdb->show_errors($old_show_errors_value);
2310
-            if (! empty($wpdb->last_error)) {
2310
+            if ( ! empty($wpdb->last_error)) {
2311 2311
                 throw new EE_Error(sprintf(__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
2312 2312
             }
2313 2313
             if ($result === false) {
@@ -2368,7 +2368,7 @@  discard block
 block discarded – undo
2368 2368
                     return $result;
2369 2369
                     break;
2370 2370
             }
2371
-            if (! empty($error_message)) {
2371
+            if ( ! empty($error_message)) {
2372 2372
                 EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
2373 2373
                 trigger_error($error_message);
2374 2374
             }
@@ -2444,11 +2444,11 @@  discard block
 block discarded – undo
2444 2444
      */
2445 2445
     private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
2446 2446
     {
2447
-        return " FROM " . $model_query_info->get_full_join_sql() .
2448
-               $model_query_info->get_where_sql() .
2449
-               $model_query_info->get_group_by_sql() .
2450
-               $model_query_info->get_having_sql() .
2451
-               $model_query_info->get_order_by_sql() .
2447
+        return " FROM ".$model_query_info->get_full_join_sql().
2448
+               $model_query_info->get_where_sql().
2449
+               $model_query_info->get_group_by_sql().
2450
+               $model_query_info->get_having_sql().
2451
+               $model_query_info->get_order_by_sql().
2452 2452
                $model_query_info->get_limit_sql();
2453 2453
     }
2454 2454
 
@@ -2644,12 +2644,12 @@  discard block
 block discarded – undo
2644 2644
         $related_model = $this->get_related_model_obj($model_name);
2645 2645
         //we're just going to use the query params on the related model's normal get_all query,
2646 2646
         //except add a condition to say to match the current mod
2647
-        if (! isset($query_params['default_where_conditions'])) {
2647
+        if ( ! isset($query_params['default_where_conditions'])) {
2648 2648
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2649 2649
         }
2650 2650
         $this_model_name = $this->get_this_model_name();
2651 2651
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2652
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2652
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2653 2653
         return $related_model->count($query_params, $field_to_count, $distinct);
2654 2654
     }
2655 2655
 
@@ -2669,7 +2669,7 @@  discard block
 block discarded – undo
2669 2669
     public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
2670 2670
     {
2671 2671
         $related_model = $this->get_related_model_obj($model_name);
2672
-        if (! is_array($query_params)) {
2672
+        if ( ! is_array($query_params)) {
2673 2673
             EE_Error::doing_it_wrong('EEM_Base::sum_related',
2674 2674
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
2675 2675
                     gettype($query_params)), '4.6.0');
@@ -2677,12 +2677,12 @@  discard block
 block discarded – undo
2677 2677
         }
2678 2678
         //we're just going to use the query params on the related model's normal get_all query,
2679 2679
         //except add a condition to say to match the current mod
2680
-        if (! isset($query_params['default_where_conditions'])) {
2680
+        if ( ! isset($query_params['default_where_conditions'])) {
2681 2681
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
2682 2682
         }
2683 2683
         $this_model_name = $this->get_this_model_name();
2684 2684
         $this_pk_field_name = $this->get_primary_key_field()->get_name();
2685
-        $query_params[0][$this_model_name . "." . $this_pk_field_name] = $id_or_obj;
2685
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
2686 2686
         return $related_model->sum($query_params, $field_to_sum);
2687 2687
     }
2688 2688
 
@@ -2735,7 +2735,7 @@  discard block
 block discarded – undo
2735 2735
                 $field_with_model_name = $field;
2736 2736
             }
2737 2737
         }
2738
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
2738
+        if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
2739 2739
             throw new EE_Error(sprintf(__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
2740 2740
                 $this->get_this_model_name()));
2741 2741
         }
@@ -2768,7 +2768,7 @@  discard block
 block discarded – undo
2768 2768
          * @param array    $fields_n_values keys are the fields and values are their new values
2769 2769
          * @param EEM_Base $model           the model used
2770 2770
          */
2771
-        $field_n_values = (array)apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2771
+        $field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
2772 2772
         if ($this->_satisfies_unique_indexes($field_n_values)) {
2773 2773
             $main_table = $this->_get_main_table();
2774 2774
             $new_id = $this->_insert_into_specific_table($main_table, $field_n_values, false);
@@ -2875,7 +2875,7 @@  discard block
 block discarded – undo
2875 2875
         }
2876 2876
         foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
2877 2877
             $uniqueness_where_params = array_intersect_key($fields_n_values, $unique_index->fields());
2878
-            $query_params[0]['OR']['AND*' . $unique_index_name] = $uniqueness_where_params;
2878
+            $query_params[0]['OR']['AND*'.$unique_index_name] = $uniqueness_where_params;
2879 2879
         }
2880 2880
         //if there is nothing to base this search on, then we shouldn't find anything
2881 2881
         if (empty($query_params)) {
@@ -2961,7 +2961,7 @@  discard block
 block discarded – undo
2961 2961
             //its not the main table, so we should have already saved the main table's PK which we just inserted
2962 2962
             //so add the fk to the main table as a column
2963 2963
             $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
2964
-            $format_for_insertion[] = '%d';//yes right now we're only allowing these foreign keys to be INTs
2964
+            $format_for_insertion[] = '%d'; //yes right now we're only allowing these foreign keys to be INTs
2965 2965
         }
2966 2966
         //insert the new entry
2967 2967
         $result = $this->_do_wpdb_query('insert',
@@ -3165,7 +3165,7 @@  discard block
 block discarded – undo
3165 3165
                     $query_info_carrier,
3166 3166
                     'group_by'
3167 3167
                 );
3168
-            } elseif (! empty ($query_params['group_by'])) {
3168
+            } elseif ( ! empty ($query_params['group_by'])) {
3169 3169
                 $this->_extract_related_model_info_from_query_param(
3170 3170
                     $query_params['group_by'],
3171 3171
                     $query_info_carrier,
@@ -3187,7 +3187,7 @@  discard block
 block discarded – undo
3187 3187
                     $query_info_carrier,
3188 3188
                     'order_by'
3189 3189
                 );
3190
-            } elseif (! empty($query_params['order_by'])) {
3190
+            } elseif ( ! empty($query_params['order_by'])) {
3191 3191
                 $this->_extract_related_model_info_from_query_param(
3192 3192
                     $query_params['order_by'],
3193 3193
                     $query_info_carrier,
@@ -3222,8 +3222,8 @@  discard block
 block discarded – undo
3222 3222
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3223 3223
         $query_param_type
3224 3224
     ) {
3225
-        if (! empty($sub_query_params)) {
3226
-            $sub_query_params = (array)$sub_query_params;
3225
+        if ( ! empty($sub_query_params)) {
3226
+            $sub_query_params = (array) $sub_query_params;
3227 3227
             foreach ($sub_query_params as $param => $possibly_array_of_params) {
3228 3228
                 //$param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
3229 3229
                 $this->_extract_related_model_info_from_query_param($param, $model_query_info_carrier,
@@ -3234,7 +3234,7 @@  discard block
 block discarded – undo
3234 3234
                 //of array('Registration.TXN_ID'=>23)
3235 3235
                 $query_param_sans_stars = $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
3236 3236
                 if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
3237
-                    if (! is_array($possibly_array_of_params)) {
3237
+                    if ( ! is_array($possibly_array_of_params)) {
3238 3238
                         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'))",
3239 3239
                             "event_espresso"),
3240 3240
                             $param, $possibly_array_of_params));
@@ -3251,7 +3251,7 @@  discard block
 block discarded – undo
3251 3251
                     //then $possible_array_of_params looks something like array('<','DTT_sold',true)
3252 3252
                     //indicating that $possible_array_of_params[1] is actually a field name,
3253 3253
                     //from which we should extract query parameters!
3254
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3254
+                    if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
3255 3255
                         throw new EE_Error(sprintf(__("Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
3256 3256
                             "event_espresso"), $query_param_type, implode(",", $possibly_array_of_params)));
3257 3257
                     }
@@ -3281,8 +3281,8 @@  discard block
 block discarded – undo
3281 3281
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
3282 3282
         $query_param_type
3283 3283
     ) {
3284
-        if (! empty($sub_query_params)) {
3285
-            if (! is_array($sub_query_params)) {
3284
+        if ( ! empty($sub_query_params)) {
3285
+            if ( ! is_array($sub_query_params)) {
3286 3286
                 throw new EE_Error(sprintf(__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
3287 3287
                     $sub_query_params));
3288 3288
             }
@@ -3311,7 +3311,7 @@  discard block
 block discarded – undo
3311 3311
      */
3312 3312
     public function _create_model_query_info_carrier($query_params)
3313 3313
     {
3314
-        if (! is_array($query_params)) {
3314
+        if ( ! is_array($query_params)) {
3315 3315
             EE_Error::doing_it_wrong(
3316 3316
                 'EEM_Base::_create_model_query_info_carrier',
3317 3317
                 sprintf(
@@ -3387,7 +3387,7 @@  discard block
 block discarded – undo
3387 3387
         //set limit
3388 3388
         if (array_key_exists('limit', $query_params)) {
3389 3389
             if (is_array($query_params['limit'])) {
3390
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
3390
+                if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
3391 3391
                     $e = sprintf(
3392 3392
                         __(
3393 3393
                             "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)",
@@ -3395,12 +3395,12 @@  discard block
 block discarded – undo
3395 3395
                         ),
3396 3396
                         http_build_query($query_params['limit'])
3397 3397
                     );
3398
-                    throw new EE_Error($e . "|" . $e);
3398
+                    throw new EE_Error($e."|".$e);
3399 3399
                 }
3400 3400
                 //they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
3401
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
3402
-            } elseif (! empty ($query_params['limit'])) {
3403
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
3401
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit'][0].",".$query_params['limit'][1]);
3402
+            } elseif ( ! empty ($query_params['limit'])) {
3403
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit']);
3404 3404
             }
3405 3405
         }
3406 3406
         //set order by
@@ -3432,10 +3432,10 @@  discard block
 block discarded – undo
3432 3432
                 $order_array = array();
3433 3433
                 foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
3434 3434
                     $order = $this->_extract_order($order);
3435
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
3435
+                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by).SP.$order;
3436 3436
                 }
3437
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
3438
-            } elseif (! empty ($query_params['order_by'])) {
3437
+                $query_object->set_order_by_sql(" ORDER BY ".implode(",", $order_array));
3438
+            } elseif ( ! empty ($query_params['order_by'])) {
3439 3439
                 $this->_extract_related_model_info_from_query_param(
3440 3440
                     $query_params['order_by'],
3441 3441
                     $query_object,
@@ -3446,18 +3446,18 @@  discard block
 block discarded – undo
3446 3446
                     ? $this->_extract_order($query_params['order'])
3447 3447
                     : 'DESC';
3448 3448
                 $query_object->set_order_by_sql(
3449
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
3449
+                    " ORDER BY ".$this->_deduce_column_name_from_query_param($query_params['order_by']).SP.$order
3450 3450
                 );
3451 3451
             }
3452 3452
         }
3453 3453
         //if 'order_by' wasn't set, maybe they are just using 'order' on its own?
3454
-        if (! array_key_exists('order_by', $query_params)
3454
+        if ( ! array_key_exists('order_by', $query_params)
3455 3455
             && array_key_exists('order', $query_params)
3456 3456
             && ! empty($query_params['order'])
3457 3457
         ) {
3458 3458
             $pk_field = $this->get_primary_key_field();
3459 3459
             $order = $this->_extract_order($query_params['order']);
3460
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
3460
+            $query_object->set_order_by_sql(" ORDER BY ".$pk_field->get_qualified_column().SP.$order);
3461 3461
         }
3462 3462
         //set group by
3463 3463
         if (array_key_exists('group_by', $query_params)) {
@@ -3467,10 +3467,10 @@  discard block
 block discarded – undo
3467 3467
                 foreach ($query_params['group_by'] as $field_name_to_group_by) {
3468 3468
                     $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
3469 3469
                 }
3470
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
3471
-            } elseif (! empty ($query_params['group_by'])) {
3470
+                $query_object->set_group_by_sql(" GROUP BY ".implode(", ", $group_by_array));
3471
+            } elseif ( ! empty ($query_params['group_by'])) {
3472 3472
                 $query_object->set_group_by_sql(
3473
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
3473
+                    " GROUP BY ".$this->_deduce_column_name_from_query_param($query_params['group_by'])
3474 3474
                 );
3475 3475
             }
3476 3476
         }
@@ -3480,7 +3480,7 @@  discard block
 block discarded – undo
3480 3480
         }
3481 3481
         //now, just verify they didn't pass anything wack
3482 3482
         foreach ($query_params as $query_key => $query_value) {
3483
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
3483
+            if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
3484 3484
                 throw new EE_Error(
3485 3485
                     sprintf(
3486 3486
                         __(
@@ -3579,22 +3579,22 @@  discard block
 block discarded – undo
3579 3579
         $where_query_params = array()
3580 3580
     ) {
3581 3581
         $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
3582
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3582
+        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
3583 3583
             throw new EE_Error(sprintf(__("You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
3584 3584
                 "event_espresso"), $use_default_where_conditions,
3585 3585
                 implode(", ", $allowed_used_default_where_conditions_values)));
3586 3586
         }
3587 3587
         $universal_query_params = array();
3588
-        if ($this->_should_use_default_where_conditions( $use_default_where_conditions, true)) {
3588
+        if ($this->_should_use_default_where_conditions($use_default_where_conditions, true)) {
3589 3589
             $universal_query_params = $this->_get_default_where_conditions();
3590
-        } else if ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, true)) {
3590
+        } else if ($this->_should_use_minimum_where_conditions($use_default_where_conditions, true)) {
3591 3591
             $universal_query_params = $this->_get_minimum_where_conditions();
3592 3592
         }
3593 3593
         foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
3594 3594
             $related_model = $this->get_related_model_obj($model_name);
3595
-            if ( $this->_should_use_default_where_conditions( $use_default_where_conditions, false)) {
3595
+            if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
3596 3596
                 $related_model_universal_where_params = $related_model->_get_default_where_conditions($model_relation_path);
3597
-            } elseif ($this->_should_use_minimum_where_conditions( $use_default_where_conditions, false)) {
3597
+            } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
3598 3598
                 $related_model_universal_where_params = $related_model->_get_minimum_where_conditions($model_relation_path);
3599 3599
             } else {
3600 3600
                 //we don't want to add full or even minimum default where conditions from this model, so just continue
@@ -3627,7 +3627,7 @@  discard block
 block discarded – undo
3627 3627
      * @param bool $for_this_model false means this is for OTHER related models
3628 3628
      * @return bool
3629 3629
      */
3630
-    private function _should_use_default_where_conditions( $default_where_conditions_value, $for_this_model = true )
3630
+    private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
3631 3631
     {
3632 3632
         return (
3633 3633
                    $for_this_model
@@ -3706,7 +3706,7 @@  discard block
 block discarded – undo
3706 3706
     ) {
3707 3707
         $null_friendly_where_conditions = array();
3708 3708
         $none_overridden = true;
3709
-        $or_condition_key_for_defaults = 'OR*' . get_class($model);
3709
+        $or_condition_key_for_defaults = 'OR*'.get_class($model);
3710 3710
         foreach ($default_where_conditions as $key => $val) {
3711 3711
             if (isset($provided_where_conditions[$key])) {
3712 3712
                 $none_overridden = false;
@@ -3824,7 +3824,7 @@  discard block
 block discarded – undo
3824 3824
             foreach ($tables as $table_obj) {
3825 3825
                 $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
3826 3826
                                        . $table_obj->get_fully_qualified_pk_column();
3827
-                if (! in_array($qualified_pk_column, $selects)) {
3827
+                if ( ! in_array($qualified_pk_column, $selects)) {
3828 3828
                     $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
3829 3829
                 }
3830 3830
             }
@@ -3918,9 +3918,9 @@  discard block
 block discarded – undo
3918 3918
         //and
3919 3919
         //check if it's a field on a related model
3920 3920
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
3921
-            if (strpos($query_param, $valid_related_model_name . ".") === 0) {
3921
+            if (strpos($query_param, $valid_related_model_name.".") === 0) {
3922 3922
                 $this->_add_join_to_model($valid_related_model_name, $passed_in_query_info, $original_query_param);
3923
-                $query_param = substr($query_param, strlen($valid_related_model_name . "."));
3923
+                $query_param = substr($query_param, strlen($valid_related_model_name."."));
3924 3924
                 if ($query_param === '') {
3925 3925
                     //nothing left to $query_param
3926 3926
                     //we should actually end in a field name, not a model like this!
@@ -4008,7 +4008,7 @@  discard block
 block discarded – undo
4008 4008
     {
4009 4009
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
4010 4010
         if ($SQL) {
4011
-            return " WHERE " . $SQL;
4011
+            return " WHERE ".$SQL;
4012 4012
         }
4013 4013
         return '';
4014 4014
     }
@@ -4027,7 +4027,7 @@  discard block
 block discarded – undo
4027 4027
     {
4028 4028
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
4029 4029
         if ($SQL) {
4030
-            return " HAVING " . $SQL;
4030
+            return " HAVING ".$SQL;
4031 4031
         }
4032 4032
         return '';
4033 4033
     }
@@ -4046,11 +4046,11 @@  discard block
 block discarded – undo
4046 4046
      */
4047 4047
     protected function _get_field_on_model($field_name, $model_name)
4048 4048
     {
4049
-        $model_class = 'EEM_' . $model_name;
4050
-        $model_filepath = $model_class . ".model.php";
4049
+        $model_class = 'EEM_'.$model_name;
4050
+        $model_filepath = $model_class.".model.php";
4051 4051
         if (is_readable($model_filepath)) {
4052 4052
             require_once($model_filepath);
4053
-            $model_instance = call_user_func($model_name . "::instance");
4053
+            $model_instance = call_user_func($model_name."::instance");
4054 4054
             /* @var $model_instance EEM_Base */
4055 4055
             return $model_instance->field_settings_for($field_name);
4056 4056
         }
@@ -4079,7 +4079,7 @@  discard block
 block discarded – undo
4079 4079
     {
4080 4080
         $where_clauses = array();
4081 4081
         foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
4082
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);//str_replace("*",'',$query_param);
4082
+            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param); //str_replace("*",'',$query_param);
4083 4083
             if (in_array($query_param, $this->_logic_query_param_keys)) {
4084 4084
                 switch ($query_param) {
4085 4085
                     case 'not':
@@ -4107,7 +4107,7 @@  discard block
 block discarded – undo
4107 4107
             } else {
4108 4108
                 $field_obj = $this->_deduce_field_from_query_param($query_param);
4109 4109
                 //if it's not a normal field, maybe it's a custom selection?
4110
-                if (! $field_obj) {
4110
+                if ( ! $field_obj) {
4111 4111
                     if (isset($this->_custom_selections[$query_param][1])) {
4112 4112
                         $field_obj = $this->_custom_selections[$query_param][1];
4113 4113
                     } else {
@@ -4116,7 +4116,7 @@  discard block
 block discarded – undo
4116 4116
                     }
4117 4117
                 }
4118 4118
                 $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
4119
-                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
4119
+                $where_clauses[] = $this->_deduce_column_name_from_query_param($query_param).SP.$op_and_value_sql;
4120 4120
             }
4121 4121
         }
4122 4122
         return $where_clauses ? implode($glue, $where_clauses) : '';
@@ -4137,7 +4137,7 @@  discard block
 block discarded – undo
4137 4137
         if ($field) {
4138 4138
             $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param($field->get_model_name(),
4139 4139
                 $query_param);
4140
-            return $table_alias_prefix . $field->get_qualified_column();
4140
+            return $table_alias_prefix.$field->get_qualified_column();
4141 4141
         }
4142 4142
         if (array_key_exists($query_param, $this->_custom_selections)) {
4143 4143
             //maybe it's custom selection item?
@@ -4189,7 +4189,7 @@  discard block
 block discarded – undo
4189 4189
     {
4190 4190
         if (is_array($op_and_value)) {
4191 4191
             $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
4192
-            if (! $operator) {
4192
+            if ( ! $operator) {
4193 4193
                 $php_array_like_string = array();
4194 4194
                 foreach ($op_and_value as $key => $value) {
4195 4195
                     $php_array_like_string[] = "$key=>$value";
@@ -4211,14 +4211,14 @@  discard block
 block discarded – undo
4211 4211
         }
4212 4212
         //check to see if the value is actually another field
4213 4213
         if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
4214
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
4214
+            return $operator.SP.$this->_deduce_column_name_from_query_param($value);
4215 4215
         }
4216 4216
         if (in_array($operator, $this->_in_style_operators) && is_array($value)) {
4217 4217
             //in this case, the value should be an array, or at least a comma-separated list
4218 4218
             //it will need to handle a little differently
4219 4219
             $cleaned_value = $this->_construct_in_value($value, $field_obj);
4220 4220
             //note: $cleaned_value has already been run through $wpdb->prepare()
4221
-            return $operator . SP . $cleaned_value;
4221
+            return $operator.SP.$cleaned_value;
4222 4222
         }
4223 4223
         if (in_array($operator, $this->_between_style_operators) && is_array($value)) {
4224 4224
             //the value should be an array with count of two.
@@ -4234,7 +4234,7 @@  discard block
 block discarded – undo
4234 4234
                 );
4235 4235
             }
4236 4236
             $cleaned_value = $this->_construct_between_value($value, $field_obj);
4237
-            return $operator . SP . $cleaned_value;
4237
+            return $operator.SP.$cleaned_value;
4238 4238
         }
4239 4239
         if (in_array($operator, $this->_null_style_operators)) {
4240 4240
             if ($value !== null) {
@@ -4254,10 +4254,10 @@  discard block
 block discarded – undo
4254 4254
         if ($operator === 'LIKE' && ! is_array($value)) {
4255 4255
             //if the operator is 'LIKE', we want to allow percent signs (%) and not
4256 4256
             //remove other junk. So just treat it as a string.
4257
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
4257
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, '%s');
4258 4258
         }
4259
-        if (! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4260
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
4259
+        if ( ! in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4260
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, $field_obj);
4261 4261
         }
4262 4262
         if (in_array($operator, $this->_in_style_operators) && ! is_array($value)) {
4263 4263
             throw new EE_Error(
@@ -4271,7 +4271,7 @@  discard block
 block discarded – undo
4271 4271
                 )
4272 4272
             );
4273 4273
         }
4274
-        if (! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4274
+        if ( ! in_array($operator, $this->_in_style_operators) && is_array($value)) {
4275 4275
             throw new EE_Error(
4276 4276
                 sprintf(
4277 4277
                     __(
@@ -4311,7 +4311,7 @@  discard block
 block discarded – undo
4311 4311
         foreach ($values as $value) {
4312 4312
             $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
4313 4313
         }
4314
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
4314
+        return $cleaned_values[0]." AND ".$cleaned_values[1];
4315 4315
     }
4316 4316
 
4317 4317
 
@@ -4352,7 +4352,7 @@  discard block
 block discarded – undo
4352 4352
                                 . $main_table->get_table_name()
4353 4353
                                 . " WHERE FALSE";
4354 4354
         }
4355
-        return "(" . implode(",", $cleaned_values) . ")";
4355
+        return "(".implode(",", $cleaned_values).")";
4356 4356
     }
4357 4357
 
4358 4358
 
@@ -4371,7 +4371,7 @@  discard block
 block discarded – undo
4371 4371
             return $wpdb->prepare($field_obj->get_wpdb_data_type(),
4372 4372
                 $this->_prepare_value_for_use_in_db($value, $field_obj));
4373 4373
         } //$field_obj should really just be a data type
4374
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4374
+        if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
4375 4375
             throw new EE_Error(
4376 4376
                 sprintf(
4377 4377
                     __("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
@@ -4499,10 +4499,10 @@  discard block
 block discarded – undo
4499 4499
      */
4500 4500
     public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
4501 4501
     {
4502
-        $table_prefix = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
4502
+        $table_prefix = str_replace('.', '__', $model_relation_chain).(empty($model_relation_chain) ? '' : '__');
4503 4503
         $qualified_columns = array();
4504 4504
         foreach ($this->field_settings() as $field_name => $field) {
4505
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
4505
+            $qualified_columns[] = $table_prefix.$field->get_qualified_column();
4506 4506
         }
4507 4507
         return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
4508 4508
     }
@@ -4526,11 +4526,11 @@  discard block
 block discarded – undo
4526 4526
             if ($table_obj instanceof EE_Primary_Table) {
4527 4527
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4528 4528
                     ? $table_obj->get_select_join_limit($limit)
4529
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
4529
+                    : SP.$table_obj->get_table_name()." AS ".$table_obj->get_table_alias().SP;
4530 4530
             } elseif ($table_obj instanceof EE_Secondary_Table) {
4531 4531
                 $SQL .= $table_alias === $table_obj->get_table_alias()
4532 4532
                     ? $table_obj->get_select_join_limit_join($limit)
4533
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
4533
+                    : SP.$table_obj->get_join_sql($table_alias).SP;
4534 4534
             }
4535 4535
         }
4536 4536
         return $SQL;
@@ -4618,12 +4618,12 @@  discard block
 block discarded – undo
4618 4618
      */
4619 4619
     public function get_related_model_obj($model_name)
4620 4620
     {
4621
-        $model_classname = "EEM_" . $model_name;
4622
-        if (! class_exists($model_classname)) {
4621
+        $model_classname = "EEM_".$model_name;
4622
+        if ( ! class_exists($model_classname)) {
4623 4623
             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",
4624 4624
                 'event_espresso'), $model_name, $model_classname));
4625 4625
         }
4626
-        return call_user_func($model_classname . "::instance");
4626
+        return call_user_func($model_classname."::instance");
4627 4627
     }
4628 4628
 
4629 4629
 
@@ -4670,7 +4670,7 @@  discard block
 block discarded – undo
4670 4670
     public function related_settings_for($relation_name)
4671 4671
     {
4672 4672
         $relatedModels = $this->relation_settings();
4673
-        if (! array_key_exists($relation_name, $relatedModels)) {
4673
+        if ( ! array_key_exists($relation_name, $relatedModels)) {
4674 4674
             throw new EE_Error(
4675 4675
                 sprintf(
4676 4676
                     __('Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
@@ -4697,7 +4697,7 @@  discard block
 block discarded – undo
4697 4697
     public function field_settings_for($fieldName)
4698 4698
     {
4699 4699
         $fieldSettings = $this->field_settings(true);
4700
-        if (! array_key_exists($fieldName, $fieldSettings)) {
4700
+        if ( ! array_key_exists($fieldName, $fieldSettings)) {
4701 4701
             throw new EE_Error(sprintf(__("There is no field/column '%s' on '%s'", 'event_espresso'), $fieldName,
4702 4702
                 get_class($this)));
4703 4703
         }
@@ -4770,7 +4770,7 @@  discard block
 block discarded – undo
4770 4770
                     break;
4771 4771
                 }
4772 4772
             }
4773
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4773
+            if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
4774 4774
                 throw new EE_Error(sprintf(__("There is no Primary Key defined on model %s", 'event_espresso'),
4775 4775
                     get_class($this)));
4776 4776
             }
@@ -4829,7 +4829,7 @@  discard block
 block discarded – undo
4829 4829
      */
4830 4830
     public function get_foreign_key_to($model_name)
4831 4831
     {
4832
-        if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4832
+        if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4833 4833
             foreach ($this->field_settings() as $field) {
4834 4834
                 if (
4835 4835
                     $field instanceof EE_Foreign_Key_Field_Base
@@ -4839,7 +4839,7 @@  discard block
 block discarded – undo
4839 4839
                     break;
4840 4840
                 }
4841 4841
             }
4842
-            if (! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4842
+            if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
4843 4843
                 throw new EE_Error(sprintf(__("There is no foreign key field pointing to model %s on model %s",
4844 4844
                     'event_espresso'), $model_name, get_class($this)));
4845 4845
             }
@@ -4890,7 +4890,7 @@  discard block
 block discarded – undo
4890 4890
             foreach ($this->_fields as $fields_corresponding_to_table) {
4891 4891
                 foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
4892 4892
                     /** @var $field_obj EE_Model_Field_Base */
4893
-                    if (! $field_obj->is_db_only_field()) {
4893
+                    if ( ! $field_obj->is_db_only_field()) {
4894 4894
                         $this->_cached_fields_non_db_only[$field_name] = $field_obj;
4895 4895
                     }
4896 4896
                 }
@@ -4919,7 +4919,7 @@  discard block
 block discarded – undo
4919 4919
         $count_if_model_has_no_primary_key = 0;
4920 4920
         $has_primary_key = $this->has_primary_key_field();
4921 4921
         $primary_key_field = $has_primary_key ? $this->get_primary_key_field() : null;
4922
-        foreach ((array)$rows as $row) {
4922
+        foreach ((array) $rows as $row) {
4923 4923
             if (empty($row)) {
4924 4924
                 //wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
4925 4925
                 return array();
@@ -4937,7 +4937,7 @@  discard block
 block discarded – undo
4937 4937
                 }
4938 4938
             }
4939 4939
             $classInstance = $this->instantiate_class_from_array_or_object($row);
4940
-            if (! $classInstance) {
4940
+            if ( ! $classInstance) {
4941 4941
                 throw new EE_Error(
4942 4942
                     sprintf(
4943 4943
                         __('Could not create instance of class %s from row %s', 'event_espresso'),
@@ -5009,7 +5009,7 @@  discard block
 block discarded – undo
5009 5009
      */
5010 5010
     public function instantiate_class_from_array_or_object($cols_n_values)
5011 5011
     {
5012
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
5012
+        if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
5013 5013
             $cols_n_values = get_object_vars($cols_n_values);
5014 5014
         }
5015 5015
         $primary_key = null;
@@ -5033,7 +5033,7 @@  discard block
 block discarded – undo
5033 5033
         // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
5034 5034
         if ($primary_key) {
5035 5035
             $classInstance = $this->get_from_entity_map($primary_key);
5036
-            if (! $classInstance) {
5036
+            if ( ! $classInstance) {
5037 5037
                 $classInstance = $this->_instantiate_new_instance_from_db(
5038 5038
                     $this->_get_class_name(),
5039 5039
                     $this_model_fields_n_values
@@ -5091,12 +5091,12 @@  discard block
 block discarded – undo
5091 5091
     public function add_to_entity_map(EE_Base_Class $object)
5092 5092
     {
5093 5093
         $className = $this->_get_class_name();
5094
-        if (! $object instanceof $className) {
5094
+        if ( ! $object instanceof $className) {
5095 5095
             throw new EE_Error(sprintf(__("You tried adding a %s to a mapping of %ss", "event_espresso"),
5096 5096
                 is_object($object) ? get_class($object) : $object, $className));
5097 5097
         }
5098 5098
         /** @var $object EE_Base_Class */
5099
-        if (! $object->ID()) {
5099
+        if ( ! $object->ID()) {
5100 5100
             throw new EE_Error(sprintf(__("You tried storing a model object with NO ID in the %s entity mapper.",
5101 5101
                 "event_espresso"), get_class($this)));
5102 5102
         }
@@ -5165,7 +5165,7 @@  discard block
 block discarded – undo
5165 5165
             //there is a primary key on this table and its not set. Use defaults for all its columns
5166 5166
             if ($table_pk_value === null && $table_obj->get_pk_column()) {
5167 5167
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5168
-                    if (! $field_obj->is_db_only_field()) {
5168
+                    if ( ! $field_obj->is_db_only_field()) {
5169 5169
                         //prepare field as if its coming from db
5170 5170
                         $prepared_value = $field_obj->prepare_for_set($field_obj->get_default_value());
5171 5171
                         $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
@@ -5174,7 +5174,7 @@  discard block
 block discarded – undo
5174 5174
             } else {
5175 5175
                 //the table's rows existed. Use their values
5176 5176
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
5177
-                    if (! $field_obj->is_db_only_field()) {
5177
+                    if ( ! $field_obj->is_db_only_field()) {
5178 5178
                         $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
5179 5179
                             $cols_n_values, $field_obj->get_qualified_column(),
5180 5180
                             $field_obj->get_table_column()
@@ -5289,7 +5289,7 @@  discard block
 block discarded – undo
5289 5289
      */
5290 5290
     private function _get_class_name()
5291 5291
     {
5292
-        return "EE_" . $this->get_this_model_name();
5292
+        return "EE_".$this->get_this_model_name();
5293 5293
     }
5294 5294
 
5295 5295
 
@@ -5304,7 +5304,7 @@  discard block
 block discarded – undo
5304 5304
      */
5305 5305
     public function item_name($quantity = 1)
5306 5306
     {
5307
-        return (int)$quantity === 1 ? $this->singular_item : $this->plural_item;
5307
+        return (int) $quantity === 1 ? $this->singular_item : $this->plural_item;
5308 5308
     }
5309 5309
 
5310 5310
 
@@ -5337,7 +5337,7 @@  discard block
 block discarded – undo
5337 5337
     {
5338 5338
         $className = get_class($this);
5339 5339
         $tagName = "FHEE__{$className}__{$methodName}";
5340
-        if (! has_filter($tagName)) {
5340
+        if ( ! has_filter($tagName)) {
5341 5341
             throw new EE_Error(
5342 5342
                 sprintf(
5343 5343
                     __('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 );',
@@ -5563,7 +5563,7 @@  discard block
 block discarded – undo
5563 5563
         $key_vals_in_combined_pk = array();
5564 5564
         parse_str($index_primary_key_string, $key_vals_in_combined_pk);
5565 5565
         foreach ($key_fields as $key_field_name => $field_obj) {
5566
-            if (! isset($key_vals_in_combined_pk[$key_field_name])) {
5566
+            if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
5567 5567
                 return null;
5568 5568
             }
5569 5569
         }
@@ -5584,7 +5584,7 @@  discard block
 block discarded – undo
5584 5584
     {
5585 5585
         $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
5586 5586
         foreach ($keys_it_should_have as $key) {
5587
-            if (! isset($key_vals[$key])) {
5587
+            if ( ! isset($key_vals[$key])) {
5588 5588
                 return false;
5589 5589
             }
5590 5590
         }
@@ -5638,7 +5638,7 @@  discard block
 block discarded – undo
5638 5638
      */
5639 5639
     public function get_one_copy($model_object_or_attributes_array, $query_params = array())
5640 5640
     {
5641
-        if (! is_array($query_params)) {
5641
+        if ( ! is_array($query_params)) {
5642 5642
             EE_Error::doing_it_wrong('EEM_Base::get_one_copy',
5643 5643
                 sprintf(__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
5644 5644
                     gettype($query_params)), '4.6.0');
@@ -5734,7 +5734,7 @@  discard block
 block discarded – undo
5734 5734
      */
5735 5735
     public function get_IDs($model_objects, $filter_out_empty_ids = false)
5736 5736
     {
5737
-        if (! $this->has_primary_key_field()) {
5737
+        if ( ! $this->has_primary_key_field()) {
5738 5738
             if (WP_DEBUG) {
5739 5739
                 EE_Error::add_error(
5740 5740
                     __('Trying to get IDs from a model than has no primary key', 'event_espresso'),
@@ -5747,7 +5747,7 @@  discard block
 block discarded – undo
5747 5747
         $IDs = array();
5748 5748
         foreach ($model_objects as $model_object) {
5749 5749
             $id = $model_object->ID();
5750
-            if (! $id) {
5750
+            if ( ! $id) {
5751 5751
                 if ($filter_out_empty_ids) {
5752 5752
                     continue;
5753 5753
                 }
@@ -5843,8 +5843,8 @@  discard block
 block discarded – undo
5843 5843
         $missing_caps = array();
5844 5844
         $cap_restrictions = $this->cap_restrictions($context);
5845 5845
         foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
5846
-            if (! EE_Capabilities::instance()
5847
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
5846
+            if ( ! EE_Capabilities::instance()
5847
+                                 ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
5848 5848
             ) {
5849 5849
                 $missing_caps[$cap] = $restriction_if_no_cap;
5850 5850
             }
@@ -5991,7 +5991,7 @@  discard block
 block discarded – undo
5991 5991
         }
5992 5992
         return call_user_func_array(
5993 5993
             array($class_name, 'static_constructor'),
5994
-            array((array)$arguments, true, $this->_timezone)
5994
+            array((array) $arguments, true, $this->_timezone)
5995 5995
         );
5996 5996
     }
5997 5997
 
@@ -6021,7 +6021,7 @@  discard block
 block discarded – undo
6021 6021
     {
6022 6022
         foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
6023 6023
             if ($query_param_key === $logic_query_param_key
6024
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
6024
+                || strpos($query_param_key, $logic_query_param_key.'*') === 0
6025 6025
             ) {
6026 6026
                 return true;
6027 6027
             }
Please login to merge, or discard this patch.