Completed
Branch FET/9575/invisible-recaptcha (699a26)
by
unknown
30:35 queued 15:52
created
core/libraries/rest_api/ModelDataTranslator.php 3 patches
Unused Use Statements   -2 removed lines patch added patch discarded remove patch
@@ -2,11 +2,9 @@
 block discarded – undo
2 2
 namespace EventEspresso\core\libraries\rest_api;
3 3
 
4 4
 use DomainException;
5
-use EE_Capabilities;
6 5
 use EE_Datetime_Field;
7 6
 use EE_Error;
8 7
 use EE_Infinite_Integer_Field;
9
-use EE_Maybe_Serialized_Simple_HTML_Field;
10 8
 use EE_Model_Field_Base;
11 9
 use EE_Serialized_Text_Field;
12 10
 use EEM_Base;
Please login to merge, or discard this patch.
Indentation   +834 added lines, -834 removed lines patch added patch discarded remove patch
@@ -12,7 +12,7 @@  discard block
 block discarded – undo
12 12
 use EEM_Base;
13 13
 
14 14
 if (! defined('EVENT_ESPRESSO_VERSION')) {
15
-    exit('No direct script access allowed');
15
+	exit('No direct script access allowed');
16 16
 }
17 17
 
18 18
 
@@ -37,837 +37,837 @@  discard block
 block discarded – undo
37 37
 class ModelDataTranslator
38 38
 {
39 39
 
40
-    /**
41
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
42
-     * fields that COULD contain -1; so we use null
43
-     */
44
-    const EE_INF_IN_REST = null;
45
-
46
-
47
-
48
-    /**
49
-     * Prepares a possible array of input values from JSON for use by the models
50
-     *
51
-     * @param EE_Model_Field_Base $field_obj
52
-     * @param mixed                $original_value_maybe_array
53
-     * @param string               $requested_version
54
-     * @param string               $timezone_string treat values as being in this timezone
55
-     * @return mixed
56
-     * @throws RestException
57
-     */
58
-    public static function prepareFieldValuesFromJson(
59
-        $field_obj,
60
-        $original_value_maybe_array,
61
-        $requested_version,
62
-        $timezone_string = 'UTC'
63
-    ) {
64
-        if (is_array($original_value_maybe_array)
65
-            && ! $field_obj instanceof EE_Serialized_Text_Field
66
-        ) {
67
-            $new_value_maybe_array = array();
68
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
69
-                $new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson(
70
-                    $field_obj,
71
-                    $array_item,
72
-                    $requested_version,
73
-                    $timezone_string
74
-                );
75
-            }
76
-        } else {
77
-            $new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
78
-                $field_obj,
79
-                $original_value_maybe_array,
80
-                $requested_version,
81
-                $timezone_string
82
-            );
83
-        }
84
-        return $new_value_maybe_array;
85
-    }
86
-
87
-
88
-
89
-    /**
90
-     * Prepares an array of field values FOR use in JSON/REST API
91
-     *
92
-     * @param EE_Model_Field_Base $field_obj
93
-     * @param mixed                $original_value_maybe_array
94
-     * @param string               $request_version (eg 4.8.36)
95
-     * @return array
96
-     */
97
-    public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
98
-    {
99
-        if (is_array($original_value_maybe_array)) {
100
-            $new_value = array();
101
-            foreach ($original_value_maybe_array as $key => $value) {
102
-                $new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson($field_obj, $value, $request_version);
103
-            }
104
-        } else {
105
-            $new_value = ModelDataTranslator::prepareFieldValueForJson(
106
-                $field_obj,
107
-                $original_value_maybe_array,
108
-                $request_version
109
-            );
110
-        }
111
-        return $new_value;
112
-    }
113
-
114
-
115
-    /**
116
-     * Prepares incoming data from the json or $_REQUEST parameters for the models'
117
-     * "$query_params".
118
-     *
119
-     * @param EE_Model_Field_Base $field_obj
120
-     * @param mixed               $original_value
121
-     * @param string              $requested_version
122
-     * @param string              $timezone_string treat values as being in this timezone
123
-     * @return mixed
124
-     * @throws RestException
125
-     * @throws DomainException
126
-     * @throws EE_Error
127
-     */
128
-    public static function prepareFieldValueFromJson(
129
-        $field_obj,
130
-        $original_value,
131
-        $requested_version,
132
-        $timezone_string = 'UTC' // UTC
133
-    ) {
134
-        //check if they accidentally submitted an error value. If so throw an exception
135
-        if (is_array($original_value)
136
-            && isset($original_value['error_code'], $original_value['error_message'])) {
137
-            throw new RestException(
138
-                'rest_submitted_error_value',
139
-                sprintf(
140
-                    esc_html__(
141
-                        'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
142
-                        'event_espresso'
143
-                    ),
144
-                    $field_obj->get_name()
145
-                ),
146
-                array(
147
-                    'status' => 400,
148
-                )
149
-            );
150
-        }
151
-        //double-check for serialized PHP. We never accept serialized PHP. No way Jose.
152
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
153
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
154
-        $new_value = null;
155
-        //walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
156
-        // way Jose.
157
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
158
-        if ($field_obj instanceof EE_Infinite_Integer_Field
159
-            && in_array($original_value, array(null, ''), true)
160
-        ) {
161
-            $new_value = EE_INF;
162
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
163
-            $new_value = rest_parse_date(
164
-                self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
165
-            );
166
-            if ($new_value === false) {
167
-                throw new RestException(
168
-                    'invalid_format_for_timestamp',
169
-                    sprintf(
170
-                        esc_html__(
171
-                            'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
172
-                            'event_espresso'
173
-                        ),
174
-                        'RFC3339',
175
-                        'ISO8601',
176
-                        $original_value
177
-                    ),
178
-                    array(
179
-                        'status' => 400
180
-                    )
181
-                );
182
-            }
183
-        } else {
184
-            $new_value = $original_value;
185
-        }
186
-        return $new_value;
187
-    }
188
-
189
-
190
-    /**
191
-     * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
192
-     * information via details obtained from the host site.
193
-     *
194
-     * @param string            $original_timestamp
195
-     * @param EE_Datetime_Field $datetime_field
196
-     * @param                   $timezone_string
197
-     * @return string
198
-     * @throws DomainException
199
-     */
200
-    private static function getTimestampWithTimezoneOffset(
201
-        $original_timestamp,
202
-        EE_Datetime_Field $datetime_field,
203
-        $timezone_string
204
-    ) {
205
-        //already have timezone information?
206
-        if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) {
207
-            //yes, we're ignoring the timezone.
208
-            return $original_timestamp;
209
-        }
210
-        //need to append timezone
211
-        list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
212
-            $datetime_field->get_timezone_offset(
213
-                new \DateTimeZone($timezone_string),
214
-                $original_timestamp
215
-            )
216
-        );
217
-        $offset_string =
218
-            str_pad(
219
-                floor($offset_secs / HOUR_IN_SECONDS),
220
-                2,
221
-                '0',
222
-                STR_PAD_LEFT
223
-            )
224
-            . ':'
225
-            . str_pad(
226
-                ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
227
-                2,
228
-                '0',
229
-                STR_PAD_LEFT
230
-            );
231
-        return $original_timestamp . $offset_sign . $offset_string;
232
-    }
233
-
234
-
235
-
236
-    /**
237
-     * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
238
-     * think that can happen). If $data is an array, recurses into its keys and values
239
-     * @param mixed $data
240
-     * @throws RestException
241
-     * @return void
242
-     */
243
-    public static function throwExceptionIfContainsSerializedData($data)
244
-    {
245
-        if (is_array($data)) {
246
-            foreach ($data as $key => $value) {
247
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
248
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
249
-            }
250
-        } else {
251
-            if (is_serialized($data) || is_object($data)) {
252
-                throw new RestException(
253
-                    'serialized_data_submission_prohibited',
254
-                    esc_html__(
255
-                        // @codingStandardsIgnoreStart
256
-                        'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
257
-                        // @codingStandardsIgnoreEnd
258
-                        'event_espresso'
259
-                    )
260
-                );
261
-            }
262
-        }
263
-    }
264
-
265
-
266
-
267
-    /**
268
-     * determines what's going on with them timezone strings
269
-     *
270
-     * @param int $timezone_offset
271
-     * @return array
272
-     */
273
-    private static function parseTimezoneOffset($timezone_offset)
274
-    {
275
-        $first_char = substr((string)$timezone_offset, 0, 1);
276
-        if ($first_char === '+' || $first_char === '-') {
277
-            $offset_sign = $first_char;
278
-            $offset_secs = substr((string)$timezone_offset, 1);
279
-        } else {
280
-            $offset_sign = '+';
281
-            $offset_secs = $timezone_offset;
282
-        }
283
-        return array($offset_sign, $offset_secs);
284
-    }
285
-
286
-
287
-
288
-    /**
289
-     * Prepares a field's value for display in the API
290
-     *
291
-     * @param EE_Model_Field_Base $field_obj
292
-     * @param mixed                $original_value
293
-     * @param string               $requested_version
294
-     * @return mixed
295
-     */
296
-    public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
297
-    {
298
-        if ($original_value === EE_INF) {
299
-            $new_value = ModelDataTranslator::EE_INF_IN_REST;
300
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
301
-            if (is_string($original_value)) {
302
-                //did they submit a string of a unix timestamp?
303
-                if (is_numeric($original_value)) {
304
-                    $datetime_obj = new \DateTime();
305
-                    $datetime_obj->setTimestamp((int)$original_value);
306
-                } else {
307
-                    //first, check if its a MySQL timestamp in GMT
308
-                    $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
309
-                }
310
-                if (! $datetime_obj instanceof \DateTime) {
311
-                    //so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
312
-                    $datetime_obj = $field_obj->prepare_for_set($original_value);
313
-                }
314
-                $original_value = $datetime_obj;
315
-            }
316
-            if ($original_value instanceof \DateTime) {
317
-                $new_value = $original_value->format('Y-m-d H:i:s');
318
-            } elseif (is_int($original_value) || is_float($original_value)) {
319
-                $new_value = date('Y-m-d H:i:s', $original_value);
320
-            } elseif($original_value === null || $original_value === '') {
321
-                $new_value = null;
322
-            } else {
323
-                //so it's not a datetime object, unix timestamp (as string or int),
324
-                //MySQL timestamp, or even a string in the field object's format. So no idea what it is
325
-                throw new \EE_Error(
326
-                    sprintf(
327
-                        esc_html__(
328
-                        // @codingStandardsIgnoreStart
329
-                            'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
330
-                            // @codingStandardsIgnoreEnd
331
-                            'event_espressso'
332
-                        ),
333
-                        $original_value,
334
-                        $field_obj->get_name(),
335
-                        $field_obj->get_model_name(),
336
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
337
-                    )
338
-                );
339
-            }
340
-            $new_value = mysql_to_rfc3339($new_value);
341
-        } else {
342
-            $new_value = $original_value;
343
-        }
344
-        //are we about to send an object? just don't. We have no good way to represent it in JSON.
345
-        // can't just check using is_object() because that missed PHP incomplete objects
346
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
347
-            $new_value = array(
348
-                'error_code' => 'php_object_not_return',
349
-                'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
350
-            );
351
-        }
352
-        return apply_filters(
353
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
354
-            $new_value,
355
-            $field_obj,
356
-            $original_value,
357
-            $requested_version
358
-        );
359
-    }
360
-
361
-
362
-
363
-    /**
364
-     * Prepares condition-query-parameters (like what's in where and having) from
365
-     * the format expected in the API to use in the models
366
-     *
367
-     * @param array     $inputted_query_params_of_this_type
368
-     * @param EEM_Base $model
369
-     * @param string    $requested_version
370
-     * @param boolean $writing whether this data will be written to the DB, or if we're just building a query.
371
-     *                         If we're writing to the DB, we don't expect any operators, or any logic query parameters,
372
-     *                         and we also won't accept serialized data unless the current user has unfiltered_html.
373
-     * @return array
374
-     * @throws DomainException
375
-     * @throws RestException
376
-     * @throws EE_Error
377
-     */
378
-    public static function prepareConditionsQueryParamsForModels(
379
-        $inputted_query_params_of_this_type,
380
-        EEM_Base $model,
381
-        $requested_version,
382
-        $writing = false
383
-    ) {
384
-        $query_param_for_models = array();
385
-        $valid_operators = $model->valid_operators();
386
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
387
-            $is_gmt_datetime_field = false;
388
-            $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
389
-                $query_param_key
390
-            );
391
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
392
-                $query_param_sans_stars,
393
-                $model
394
-            );
395
-            //double-check is it a *_gmt field?
396
-            if (! $field instanceof EE_Model_Field_Base
397
-                && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
398
-            ) {
399
-                //yep, take off '_gmt', and find the field
400
-                $query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars);
401
-                $field = ModelDataTranslator::deduceFieldFromQueryParam(
402
-                    $query_param_key,
403
-                    $model
404
-                );
405
-                $timezone = 'UTC';
406
-                $is_gmt_datetime_field = true;
407
-            } elseif ($field instanceof EE_Datetime_Field) {
408
-                //so it's not a GMT field. Set the timezone on the model to the default
409
-                $timezone = \EEH_DTT_Helper::get_valid_timezone_string();
410
-            } else {
411
-                //just keep using what's already set for the timezone
412
-                $timezone = $model->get_timezone();
413
-            }
414
-            if ($field instanceof EE_Model_Field_Base) {
415
-                if (! $writing && is_array($query_param_value)) {
416
-                    if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
417
-                        if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
418
-                            throw new RestException(
419
-                                'numerically_indexed_array_of_values_only',
420
-                                sprintf(
421
-                                    esc_html__(
422
-                                        'The array provided for the parameter "%1$s" should be numerically indexed.',
423
-                                        'event_espresso'
424
-                                    ),
425
-                                    $query_param_key
426
-                                ),
427
-                                array(
428
-                                    'status' => 400,
429
-                                )
430
-                            );
431
-                        }
432
-                    }
433
-                    //did they specify an operator?
434
-                    if (isset($query_param_value[0])
435
-                        && isset($valid_operators[$query_param_value[0]])
436
-                    ) {
437
-                        $op = $query_param_value[0];
438
-                        $translated_value = array($op);
439
-                        if (array_key_exists($op, $model->valid_in_style_operators())
440
-                            && isset($query_param_value[1])
441
-                            && ! isset($query_param_value[2])
442
-                        ) {
443
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
444
-                                $field,
445
-                                $query_param_value[1],
446
-                                $requested_version,
447
-                                $timezone
448
-                            );
449
-                        } elseif (array_key_exists($op, $model->valid_between_style_operators())
450
-                            && isset($query_param_value[1], $query_param_value[2])
451
-                            && !isset($query_param_value[3])
452
-                        ) {
453
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
454
-                                $field,
455
-                                $query_param_value[1],
456
-                                $requested_version,
457
-                                $timezone
458
-                            );
459
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
460
-                                $field,
461
-                                $query_param_value[2],
462
-                                $requested_version,
463
-                                $timezone
464
-                            );
465
-                        } elseif (array_key_exists($op, $model->valid_like_style_operators())
466
-                            && isset($query_param_value[1])
467
-                            && ! isset($query_param_value[2])
468
-                        ) {
469
-                            //we want to leave this value mostly-as-is (eg don't force it to be a float
470
-                            //or a boolean or an enum value. Leave it as-is with wildcards etc)
471
-                            //but do verify it at least doesn't have any serialized data
472
-                            ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
473
-                            $translated_value[] = $query_param_value[1];
474
-                        } elseif (array_key_exists($op, $model->valid_null_style_operators())
475
-                            && !isset($query_param_value[1])) {
476
-                            //no arguments should have been provided, so don't look for any
477
-                        } elseif (isset($query_param_value[1])
478
-                            && !isset($query_param_value[2])
479
-                            && ! array_key_exists(
480
-                                $op,
481
-                                array_merge(
482
-                                    $model->valid_in_style_operators(),
483
-                                    $model->valid_null_style_operators(),
484
-                                    $model->valid_like_style_operators(),
485
-                                    $model->valid_between_style_operators()
486
-                                )
487
-                            )
488
-                        ) {
489
-                            //it's a valid operator, but none of the exceptions. Treat it normally.
490
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
491
-                                $field,
492
-                                $query_param_value[1],
493
-                                $requested_version,
494
-                                $timezone
495
-                            );
496
-                        } else {
497
-                            //so they provided a valid operator, but wrong number of arguments
498
-                            if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
499
-                                throw new RestException(
500
-                                    'wrong_number_of_arguments',
501
-                                    sprintf(
502
-                                        esc_html__(
503
-                                            'The operator you provided, "%1$s" had the wrong number of arguments',
504
-                                            'event_espresso'
505
-                                        ),
506
-                                        $op
507
-                                    ),
508
-                                    array(
509
-                                        'status' => 400,
510
-                                    )
511
-                                );
512
-                            }
513
-                            $translated_value = null;
514
-                        }
515
-                    } else {
516
-                        //so they didn't provide a valid operator
517
-                        if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
518
-                            throw new RestException(
519
-                                'invalid_operator',
520
-                                sprintf(
521
-                                    esc_html__(
522
-                                        'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
523
-                                        'event_espresso'
524
-                                    ),
525
-                                    $query_param_key,
526
-                                    $query_param_value
527
-                                ),
528
-                                array(
529
-                                    'status' => 400,
530
-                                )
531
-                            );
532
-                        }
533
-                        //if we aren't in debug mode, then just try our best to fulfill the user's request
534
-                        $translated_value = null;
535
-                    }
536
-                } else {
537
-                    $translated_value = ModelDataTranslator::prepareFieldValueFromJson(
538
-                        $field,
539
-                        $query_param_value,
540
-                        $requested_version,
541
-                        $timezone
542
-                    );
543
-                }
544
-                if (
545
-                    (isset($query_param_for_models[$query_param_key]) && $is_gmt_datetime_field)
546
-                    ||
547
-                    $translated_value === null
548
-                ) {
549
-                    //they have already provided a non-gmt field, ignore the gmt one. That's what WP core
550
-                    //currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
551
-                    //OR we couldn't create a translated value from their input
552
-                    continue;
553
-                }
554
-                $query_param_for_models[$query_param_key] = $translated_value;
555
-            } else {
556
-                //so this param doesn't correspond to a field eh?
557
-                if ($writing) {
558
-                    //always tell API clients about invalid parameters when they're creating data. Otherwise,
559
-                    //they are probably going to create invalid data
560
-                    throw new RestException(
561
-                        'invalid_field',
562
-                        sprintf(
563
-                            esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
564
-                            $query_param_key
565
-                        )
566
-                    );
567
-                } else {
568
-                    //so it's not for a field, is it a logic query param key?
569
-                    if (in_array(
570
-                        $query_param_sans_stars,
571
-                        $model->logic_query_param_keys()
572
-                    )) {
573
-                        $query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
574
-                            $query_param_value,
575
-                            $model,
576
-                            $requested_version
577
-                        );
578
-                    } elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
579
-                        //only tell API clients they got it wrong if we're in debug mode
580
-                        //otherwise try our best ot fulfill their request by ignoring this invalid data
581
-                        throw new RestException(
582
-                            'invalid_parameter',
583
-                            sprintf(
584
-                                esc_html__(
585
-                                    'You provided an invalid parameter, with key "%1$s"',
586
-                                    'event_espresso'
587
-                                ),
588
-                                $query_param_sans_stars
589
-                            ),
590
-                            array(
591
-                                'status' => 400,
592
-                            )
593
-                        );
594
-                    }
595
-                }
596
-            }
597
-        }
598
-        return $query_param_for_models;
599
-    }
600
-
601
-
602
-
603
-    /**
604
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
605
-     * gmt date field name
606
-     *
607
-     * @param string $field_name
608
-     * @return boolean
609
-     */
610
-    public static function isGmtDateFieldName($field_name)
611
-    {
612
-        return substr(
613
-            ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
614
-            -4,
615
-            4
616
-        ) === '_gmt';
617
-    }
618
-
619
-
620
-
621
-    /**
622
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
623
-     *
624
-     * @param string $field_name
625
-     * @return string
626
-     */
627
-    public static function removeGmtFromFieldName($field_name)
628
-    {
629
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
630
-            return $field_name;
631
-        }
632
-        $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
633
-            $field_name
634
-        );
635
-        $query_param_sans_gmt_and_sans_stars = substr(
636
-            $query_param_sans_stars,
637
-            0,
638
-            strrpos(
639
-                $field_name,
640
-                '_gmt'
641
-            )
642
-        );
643
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
644
-    }
645
-
646
-
647
-
648
-    /**
649
-     * Takes a field name from the REST API and prepares it for the model querying
650
-     *
651
-     * @param string $field_name
652
-     * @return string
653
-     */
654
-    public static function prepareFieldNameFromJson($field_name)
655
-    {
656
-        if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
657
-            return ModelDataTranslator::removeGmtFromFieldName($field_name);
658
-        }
659
-        return $field_name;
660
-    }
661
-
662
-
663
-
664
-    /**
665
-     * Takes array of field names from REST API and prepares for models
666
-     *
667
-     * @param array $field_names
668
-     * @return array of field names (possibly include model prefixes)
669
-     */
670
-    public static function prepareFieldNamesFromJson(array $field_names)
671
-    {
672
-        $new_array = array();
673
-        foreach ($field_names as $key => $field_name) {
674
-            $new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
675
-        }
676
-        return $new_array;
677
-    }
678
-
679
-
680
-
681
-    /**
682
-     * Takes array where array keys are field names (possibly with model path prefixes)
683
-     * from the REST API and prepares them for model querying
684
-     *
685
-     * @param array $field_names_as_keys
686
-     * @return array
687
-     */
688
-    public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
689
-    {
690
-        $new_array = array();
691
-        foreach ($field_names_as_keys as $field_name => $value) {
692
-            $new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value;
693
-        }
694
-        return $new_array;
695
-    }
696
-
697
-
698
-
699
-    /**
700
-     * Prepares an array of model query params for use in the REST API
701
-     *
702
-     * @param array     $model_query_params
703
-     * @param EEM_Base $model
704
-     * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
705
-     *                                     REST API
706
-     * @return array which can be passed into the EE4 REST API when querying a model resource
707
-     * @throws EE_Error
708
-     */
709
-    public static function prepareQueryParamsForRestApi(
710
-        array $model_query_params,
711
-        EEM_Base $model,
712
-        $requested_version = null
713
-    ) {
714
-        if ($requested_version === null) {
715
-            $requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
716
-        }
717
-        $rest_query_params = $model_query_params;
718
-        if (isset($model_query_params[0])) {
719
-            $rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
720
-                $model_query_params[0],
721
-                $model,
722
-                $requested_version
723
-            );
724
-            unset($rest_query_params[0]);
725
-        }
726
-        if (isset($model_query_params['having'])) {
727
-            $rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
728
-                $model_query_params['having'],
729
-                $model,
730
-                $requested_version
731
-            );
732
-        }
733
-        return apply_filters(
734
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
735
-            $rest_query_params,
736
-            $model_query_params,
737
-            $model,
738
-            $requested_version
739
-        );
740
-    }
741
-
742
-
743
-
744
-    /**
745
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
746
-     *
747
-     * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
748
-     *                                                      passed into EEM_Base::get_all()
749
-     * @param EEM_Base $model
750
-     * @param string    $requested_version                  eg "4.8.36"
751
-     * @return array ready for use in the rest api query params
752
-     * @throws EE_Error
753
-     * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
754
-     *                                     (which would be really unusual)
755
-     */
756
-    public static function prepareConditionsQueryParamsForRestApi(
757
-        $inputted_query_params_of_this_type,
758
-        EEM_Base $model,
759
-        $requested_version
760
-    ) {
761
-        $query_param_for_models = array();
762
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
763
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
764
-                ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
765
-                $model
766
-            );
767
-            if ($field instanceof EE_Model_Field_Base) {
768
-                //did they specify an operator?
769
-                if (is_array($query_param_value)) {
770
-                    $op = $query_param_value[0];
771
-                    $translated_value = array($op);
772
-                    if (isset($query_param_value[1])) {
773
-                        $value = $query_param_value[1];
774
-                        $translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
775
-                            $field,
776
-                            $value,
777
-                            $requested_version
778
-                        );
779
-                    }
780
-                } else {
781
-                    $translated_value = ModelDataTranslator::prepareFieldValueForJson(
782
-                        $field,
783
-                        $query_param_value,
784
-                        $requested_version
785
-                    );
786
-                }
787
-                $query_param_for_models[$query_param_key] = $translated_value;
788
-            } else {
789
-                //so it's not for a field, assume it's a logic query param key
790
-                $query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
791
-                    $query_param_value,
792
-                    $model,
793
-                    $requested_version
794
-                );
795
-            }
796
-        }
797
-        return $query_param_for_models;
798
-    }
799
-
800
-
801
-
802
-    /**
803
-     * @param $condition_query_param_key
804
-     * @return string
805
-     */
806
-    public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
807
-    {
808
-        $pos_of_star = strpos($condition_query_param_key, '*');
809
-        if ($pos_of_star === false) {
810
-            return $condition_query_param_key;
811
-        } else {
812
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
813
-            return $condition_query_param_sans_star;
814
-        }
815
-    }
816
-
817
-
818
-
819
-    /**
820
-     * Takes the input parameter and finds the model field that it indicates.
821
-     *
822
-     * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
823
-     * @param EEM_Base $model
824
-     * @return EE_Model_Field_Base
825
-     * @throws EE_Error
826
-     */
827
-    public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
828
-    {
829
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
830
-        //which will help us find the database table and column
831
-        $query_param_parts = explode('.', $query_param_name);
832
-        if (empty($query_param_parts)) {
833
-            throw new EE_Error(
834
-                sprintf(
835
-                    __(
836
-                        '_extract_column_name is empty when trying to extract column and table name from %s',
837
-                        'event_espresso'
838
-                    ),
839
-                    $query_param_name
840
-                )
841
-            );
842
-        }
843
-        $number_of_parts = count($query_param_parts);
844
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
845
-        if ($number_of_parts === 1) {
846
-            $field_name = $last_query_param_part;
847
-        } else {// $number_of_parts >= 2
848
-            //the last part is the column name, and there are only 2parts. therefore...
849
-            $field_name = $last_query_param_part;
850
-            $model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
851
-        }
852
-        try {
853
-            return $model->field_settings_for($field_name, false);
854
-        } catch (EE_Error $e) {
855
-            return null;
856
-        }
857
-    }
858
-
859
-
860
-
861
-    /**
862
-     * Returns true if $data can be easily represented in JSON.
863
-     * Basically, objects and resources can't be represented in JSON easily.
864
-     * @param mixed $data
865
-     * @return bool
866
-     */
867
-    protected static function isRepresentableInJson($data)
868
-    {
869
-        return is_scalar($data)
870
-               || is_array($data)
871
-               || is_null($data);
872
-    }
40
+	/**
41
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
42
+	 * fields that COULD contain -1; so we use null
43
+	 */
44
+	const EE_INF_IN_REST = null;
45
+
46
+
47
+
48
+	/**
49
+	 * Prepares a possible array of input values from JSON for use by the models
50
+	 *
51
+	 * @param EE_Model_Field_Base $field_obj
52
+	 * @param mixed                $original_value_maybe_array
53
+	 * @param string               $requested_version
54
+	 * @param string               $timezone_string treat values as being in this timezone
55
+	 * @return mixed
56
+	 * @throws RestException
57
+	 */
58
+	public static function prepareFieldValuesFromJson(
59
+		$field_obj,
60
+		$original_value_maybe_array,
61
+		$requested_version,
62
+		$timezone_string = 'UTC'
63
+	) {
64
+		if (is_array($original_value_maybe_array)
65
+			&& ! $field_obj instanceof EE_Serialized_Text_Field
66
+		) {
67
+			$new_value_maybe_array = array();
68
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
69
+				$new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson(
70
+					$field_obj,
71
+					$array_item,
72
+					$requested_version,
73
+					$timezone_string
74
+				);
75
+			}
76
+		} else {
77
+			$new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
78
+				$field_obj,
79
+				$original_value_maybe_array,
80
+				$requested_version,
81
+				$timezone_string
82
+			);
83
+		}
84
+		return $new_value_maybe_array;
85
+	}
86
+
87
+
88
+
89
+	/**
90
+	 * Prepares an array of field values FOR use in JSON/REST API
91
+	 *
92
+	 * @param EE_Model_Field_Base $field_obj
93
+	 * @param mixed                $original_value_maybe_array
94
+	 * @param string               $request_version (eg 4.8.36)
95
+	 * @return array
96
+	 */
97
+	public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
98
+	{
99
+		if (is_array($original_value_maybe_array)) {
100
+			$new_value = array();
101
+			foreach ($original_value_maybe_array as $key => $value) {
102
+				$new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson($field_obj, $value, $request_version);
103
+			}
104
+		} else {
105
+			$new_value = ModelDataTranslator::prepareFieldValueForJson(
106
+				$field_obj,
107
+				$original_value_maybe_array,
108
+				$request_version
109
+			);
110
+		}
111
+		return $new_value;
112
+	}
113
+
114
+
115
+	/**
116
+	 * Prepares incoming data from the json or $_REQUEST parameters for the models'
117
+	 * "$query_params".
118
+	 *
119
+	 * @param EE_Model_Field_Base $field_obj
120
+	 * @param mixed               $original_value
121
+	 * @param string              $requested_version
122
+	 * @param string              $timezone_string treat values as being in this timezone
123
+	 * @return mixed
124
+	 * @throws RestException
125
+	 * @throws DomainException
126
+	 * @throws EE_Error
127
+	 */
128
+	public static function prepareFieldValueFromJson(
129
+		$field_obj,
130
+		$original_value,
131
+		$requested_version,
132
+		$timezone_string = 'UTC' // UTC
133
+	) {
134
+		//check if they accidentally submitted an error value. If so throw an exception
135
+		if (is_array($original_value)
136
+			&& isset($original_value['error_code'], $original_value['error_message'])) {
137
+			throw new RestException(
138
+				'rest_submitted_error_value',
139
+				sprintf(
140
+					esc_html__(
141
+						'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
142
+						'event_espresso'
143
+					),
144
+					$field_obj->get_name()
145
+				),
146
+				array(
147
+					'status' => 400,
148
+				)
149
+			);
150
+		}
151
+		//double-check for serialized PHP. We never accept serialized PHP. No way Jose.
152
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
153
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
154
+		$new_value = null;
155
+		//walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
156
+		// way Jose.
157
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
158
+		if ($field_obj instanceof EE_Infinite_Integer_Field
159
+			&& in_array($original_value, array(null, ''), true)
160
+		) {
161
+			$new_value = EE_INF;
162
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
163
+			$new_value = rest_parse_date(
164
+				self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
165
+			);
166
+			if ($new_value === false) {
167
+				throw new RestException(
168
+					'invalid_format_for_timestamp',
169
+					sprintf(
170
+						esc_html__(
171
+							'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
172
+							'event_espresso'
173
+						),
174
+						'RFC3339',
175
+						'ISO8601',
176
+						$original_value
177
+					),
178
+					array(
179
+						'status' => 400
180
+					)
181
+				);
182
+			}
183
+		} else {
184
+			$new_value = $original_value;
185
+		}
186
+		return $new_value;
187
+	}
188
+
189
+
190
+	/**
191
+	 * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
192
+	 * information via details obtained from the host site.
193
+	 *
194
+	 * @param string            $original_timestamp
195
+	 * @param EE_Datetime_Field $datetime_field
196
+	 * @param                   $timezone_string
197
+	 * @return string
198
+	 * @throws DomainException
199
+	 */
200
+	private static function getTimestampWithTimezoneOffset(
201
+		$original_timestamp,
202
+		EE_Datetime_Field $datetime_field,
203
+		$timezone_string
204
+	) {
205
+		//already have timezone information?
206
+		if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) {
207
+			//yes, we're ignoring the timezone.
208
+			return $original_timestamp;
209
+		}
210
+		//need to append timezone
211
+		list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
212
+			$datetime_field->get_timezone_offset(
213
+				new \DateTimeZone($timezone_string),
214
+				$original_timestamp
215
+			)
216
+		);
217
+		$offset_string =
218
+			str_pad(
219
+				floor($offset_secs / HOUR_IN_SECONDS),
220
+				2,
221
+				'0',
222
+				STR_PAD_LEFT
223
+			)
224
+			. ':'
225
+			. str_pad(
226
+				($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
227
+				2,
228
+				'0',
229
+				STR_PAD_LEFT
230
+			);
231
+		return $original_timestamp . $offset_sign . $offset_string;
232
+	}
233
+
234
+
235
+
236
+	/**
237
+	 * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
238
+	 * think that can happen). If $data is an array, recurses into its keys and values
239
+	 * @param mixed $data
240
+	 * @throws RestException
241
+	 * @return void
242
+	 */
243
+	public static function throwExceptionIfContainsSerializedData($data)
244
+	{
245
+		if (is_array($data)) {
246
+			foreach ($data as $key => $value) {
247
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
248
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
249
+			}
250
+		} else {
251
+			if (is_serialized($data) || is_object($data)) {
252
+				throw new RestException(
253
+					'serialized_data_submission_prohibited',
254
+					esc_html__(
255
+						// @codingStandardsIgnoreStart
256
+						'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
257
+						// @codingStandardsIgnoreEnd
258
+						'event_espresso'
259
+					)
260
+				);
261
+			}
262
+		}
263
+	}
264
+
265
+
266
+
267
+	/**
268
+	 * determines what's going on with them timezone strings
269
+	 *
270
+	 * @param int $timezone_offset
271
+	 * @return array
272
+	 */
273
+	private static function parseTimezoneOffset($timezone_offset)
274
+	{
275
+		$first_char = substr((string)$timezone_offset, 0, 1);
276
+		if ($first_char === '+' || $first_char === '-') {
277
+			$offset_sign = $first_char;
278
+			$offset_secs = substr((string)$timezone_offset, 1);
279
+		} else {
280
+			$offset_sign = '+';
281
+			$offset_secs = $timezone_offset;
282
+		}
283
+		return array($offset_sign, $offset_secs);
284
+	}
285
+
286
+
287
+
288
+	/**
289
+	 * Prepares a field's value for display in the API
290
+	 *
291
+	 * @param EE_Model_Field_Base $field_obj
292
+	 * @param mixed                $original_value
293
+	 * @param string               $requested_version
294
+	 * @return mixed
295
+	 */
296
+	public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
297
+	{
298
+		if ($original_value === EE_INF) {
299
+			$new_value = ModelDataTranslator::EE_INF_IN_REST;
300
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
301
+			if (is_string($original_value)) {
302
+				//did they submit a string of a unix timestamp?
303
+				if (is_numeric($original_value)) {
304
+					$datetime_obj = new \DateTime();
305
+					$datetime_obj->setTimestamp((int)$original_value);
306
+				} else {
307
+					//first, check if its a MySQL timestamp in GMT
308
+					$datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
309
+				}
310
+				if (! $datetime_obj instanceof \DateTime) {
311
+					//so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
312
+					$datetime_obj = $field_obj->prepare_for_set($original_value);
313
+				}
314
+				$original_value = $datetime_obj;
315
+			}
316
+			if ($original_value instanceof \DateTime) {
317
+				$new_value = $original_value->format('Y-m-d H:i:s');
318
+			} elseif (is_int($original_value) || is_float($original_value)) {
319
+				$new_value = date('Y-m-d H:i:s', $original_value);
320
+			} elseif($original_value === null || $original_value === '') {
321
+				$new_value = null;
322
+			} else {
323
+				//so it's not a datetime object, unix timestamp (as string or int),
324
+				//MySQL timestamp, or even a string in the field object's format. So no idea what it is
325
+				throw new \EE_Error(
326
+					sprintf(
327
+						esc_html__(
328
+						// @codingStandardsIgnoreStart
329
+							'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
330
+							// @codingStandardsIgnoreEnd
331
+							'event_espressso'
332
+						),
333
+						$original_value,
334
+						$field_obj->get_name(),
335
+						$field_obj->get_model_name(),
336
+						$field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
337
+					)
338
+				);
339
+			}
340
+			$new_value = mysql_to_rfc3339($new_value);
341
+		} else {
342
+			$new_value = $original_value;
343
+		}
344
+		//are we about to send an object? just don't. We have no good way to represent it in JSON.
345
+		// can't just check using is_object() because that missed PHP incomplete objects
346
+		if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
347
+			$new_value = array(
348
+				'error_code' => 'php_object_not_return',
349
+				'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
350
+			);
351
+		}
352
+		return apply_filters(
353
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
354
+			$new_value,
355
+			$field_obj,
356
+			$original_value,
357
+			$requested_version
358
+		);
359
+	}
360
+
361
+
362
+
363
+	/**
364
+	 * Prepares condition-query-parameters (like what's in where and having) from
365
+	 * the format expected in the API to use in the models
366
+	 *
367
+	 * @param array     $inputted_query_params_of_this_type
368
+	 * @param EEM_Base $model
369
+	 * @param string    $requested_version
370
+	 * @param boolean $writing whether this data will be written to the DB, or if we're just building a query.
371
+	 *                         If we're writing to the DB, we don't expect any operators, or any logic query parameters,
372
+	 *                         and we also won't accept serialized data unless the current user has unfiltered_html.
373
+	 * @return array
374
+	 * @throws DomainException
375
+	 * @throws RestException
376
+	 * @throws EE_Error
377
+	 */
378
+	public static function prepareConditionsQueryParamsForModels(
379
+		$inputted_query_params_of_this_type,
380
+		EEM_Base $model,
381
+		$requested_version,
382
+		$writing = false
383
+	) {
384
+		$query_param_for_models = array();
385
+		$valid_operators = $model->valid_operators();
386
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
387
+			$is_gmt_datetime_field = false;
388
+			$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
389
+				$query_param_key
390
+			);
391
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
392
+				$query_param_sans_stars,
393
+				$model
394
+			);
395
+			//double-check is it a *_gmt field?
396
+			if (! $field instanceof EE_Model_Field_Base
397
+				&& ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
398
+			) {
399
+				//yep, take off '_gmt', and find the field
400
+				$query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars);
401
+				$field = ModelDataTranslator::deduceFieldFromQueryParam(
402
+					$query_param_key,
403
+					$model
404
+				);
405
+				$timezone = 'UTC';
406
+				$is_gmt_datetime_field = true;
407
+			} elseif ($field instanceof EE_Datetime_Field) {
408
+				//so it's not a GMT field. Set the timezone on the model to the default
409
+				$timezone = \EEH_DTT_Helper::get_valid_timezone_string();
410
+			} else {
411
+				//just keep using what's already set for the timezone
412
+				$timezone = $model->get_timezone();
413
+			}
414
+			if ($field instanceof EE_Model_Field_Base) {
415
+				if (! $writing && is_array($query_param_value)) {
416
+					if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
417
+						if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
418
+							throw new RestException(
419
+								'numerically_indexed_array_of_values_only',
420
+								sprintf(
421
+									esc_html__(
422
+										'The array provided for the parameter "%1$s" should be numerically indexed.',
423
+										'event_espresso'
424
+									),
425
+									$query_param_key
426
+								),
427
+								array(
428
+									'status' => 400,
429
+								)
430
+							);
431
+						}
432
+					}
433
+					//did they specify an operator?
434
+					if (isset($query_param_value[0])
435
+						&& isset($valid_operators[$query_param_value[0]])
436
+					) {
437
+						$op = $query_param_value[0];
438
+						$translated_value = array($op);
439
+						if (array_key_exists($op, $model->valid_in_style_operators())
440
+							&& isset($query_param_value[1])
441
+							&& ! isset($query_param_value[2])
442
+						) {
443
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
444
+								$field,
445
+								$query_param_value[1],
446
+								$requested_version,
447
+								$timezone
448
+							);
449
+						} elseif (array_key_exists($op, $model->valid_between_style_operators())
450
+							&& isset($query_param_value[1], $query_param_value[2])
451
+							&& !isset($query_param_value[3])
452
+						) {
453
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
454
+								$field,
455
+								$query_param_value[1],
456
+								$requested_version,
457
+								$timezone
458
+							);
459
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
460
+								$field,
461
+								$query_param_value[2],
462
+								$requested_version,
463
+								$timezone
464
+							);
465
+						} elseif (array_key_exists($op, $model->valid_like_style_operators())
466
+							&& isset($query_param_value[1])
467
+							&& ! isset($query_param_value[2])
468
+						) {
469
+							//we want to leave this value mostly-as-is (eg don't force it to be a float
470
+							//or a boolean or an enum value. Leave it as-is with wildcards etc)
471
+							//but do verify it at least doesn't have any serialized data
472
+							ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
473
+							$translated_value[] = $query_param_value[1];
474
+						} elseif (array_key_exists($op, $model->valid_null_style_operators())
475
+							&& !isset($query_param_value[1])) {
476
+							//no arguments should have been provided, so don't look for any
477
+						} elseif (isset($query_param_value[1])
478
+							&& !isset($query_param_value[2])
479
+							&& ! array_key_exists(
480
+								$op,
481
+								array_merge(
482
+									$model->valid_in_style_operators(),
483
+									$model->valid_null_style_operators(),
484
+									$model->valid_like_style_operators(),
485
+									$model->valid_between_style_operators()
486
+								)
487
+							)
488
+						) {
489
+							//it's a valid operator, but none of the exceptions. Treat it normally.
490
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
491
+								$field,
492
+								$query_param_value[1],
493
+								$requested_version,
494
+								$timezone
495
+							);
496
+						} else {
497
+							//so they provided a valid operator, but wrong number of arguments
498
+							if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
499
+								throw new RestException(
500
+									'wrong_number_of_arguments',
501
+									sprintf(
502
+										esc_html__(
503
+											'The operator you provided, "%1$s" had the wrong number of arguments',
504
+											'event_espresso'
505
+										),
506
+										$op
507
+									),
508
+									array(
509
+										'status' => 400,
510
+									)
511
+								);
512
+							}
513
+							$translated_value = null;
514
+						}
515
+					} else {
516
+						//so they didn't provide a valid operator
517
+						if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
518
+							throw new RestException(
519
+								'invalid_operator',
520
+								sprintf(
521
+									esc_html__(
522
+										'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
523
+										'event_espresso'
524
+									),
525
+									$query_param_key,
526
+									$query_param_value
527
+								),
528
+								array(
529
+									'status' => 400,
530
+								)
531
+							);
532
+						}
533
+						//if we aren't in debug mode, then just try our best to fulfill the user's request
534
+						$translated_value = null;
535
+					}
536
+				} else {
537
+					$translated_value = ModelDataTranslator::prepareFieldValueFromJson(
538
+						$field,
539
+						$query_param_value,
540
+						$requested_version,
541
+						$timezone
542
+					);
543
+				}
544
+				if (
545
+					(isset($query_param_for_models[$query_param_key]) && $is_gmt_datetime_field)
546
+					||
547
+					$translated_value === null
548
+				) {
549
+					//they have already provided a non-gmt field, ignore the gmt one. That's what WP core
550
+					//currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
551
+					//OR we couldn't create a translated value from their input
552
+					continue;
553
+				}
554
+				$query_param_for_models[$query_param_key] = $translated_value;
555
+			} else {
556
+				//so this param doesn't correspond to a field eh?
557
+				if ($writing) {
558
+					//always tell API clients about invalid parameters when they're creating data. Otherwise,
559
+					//they are probably going to create invalid data
560
+					throw new RestException(
561
+						'invalid_field',
562
+						sprintf(
563
+							esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
564
+							$query_param_key
565
+						)
566
+					);
567
+				} else {
568
+					//so it's not for a field, is it a logic query param key?
569
+					if (in_array(
570
+						$query_param_sans_stars,
571
+						$model->logic_query_param_keys()
572
+					)) {
573
+						$query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
574
+							$query_param_value,
575
+							$model,
576
+							$requested_version
577
+						);
578
+					} elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
579
+						//only tell API clients they got it wrong if we're in debug mode
580
+						//otherwise try our best ot fulfill their request by ignoring this invalid data
581
+						throw new RestException(
582
+							'invalid_parameter',
583
+							sprintf(
584
+								esc_html__(
585
+									'You provided an invalid parameter, with key "%1$s"',
586
+									'event_espresso'
587
+								),
588
+								$query_param_sans_stars
589
+							),
590
+							array(
591
+								'status' => 400,
592
+							)
593
+						);
594
+					}
595
+				}
596
+			}
597
+		}
598
+		return $query_param_for_models;
599
+	}
600
+
601
+
602
+
603
+	/**
604
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
605
+	 * gmt date field name
606
+	 *
607
+	 * @param string $field_name
608
+	 * @return boolean
609
+	 */
610
+	public static function isGmtDateFieldName($field_name)
611
+	{
612
+		return substr(
613
+			ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
614
+			-4,
615
+			4
616
+		) === '_gmt';
617
+	}
618
+
619
+
620
+
621
+	/**
622
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
623
+	 *
624
+	 * @param string $field_name
625
+	 * @return string
626
+	 */
627
+	public static function removeGmtFromFieldName($field_name)
628
+	{
629
+		if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
630
+			return $field_name;
631
+		}
632
+		$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
633
+			$field_name
634
+		);
635
+		$query_param_sans_gmt_and_sans_stars = substr(
636
+			$query_param_sans_stars,
637
+			0,
638
+			strrpos(
639
+				$field_name,
640
+				'_gmt'
641
+			)
642
+		);
643
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
644
+	}
645
+
646
+
647
+
648
+	/**
649
+	 * Takes a field name from the REST API and prepares it for the model querying
650
+	 *
651
+	 * @param string $field_name
652
+	 * @return string
653
+	 */
654
+	public static function prepareFieldNameFromJson($field_name)
655
+	{
656
+		if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
657
+			return ModelDataTranslator::removeGmtFromFieldName($field_name);
658
+		}
659
+		return $field_name;
660
+	}
661
+
662
+
663
+
664
+	/**
665
+	 * Takes array of field names from REST API and prepares for models
666
+	 *
667
+	 * @param array $field_names
668
+	 * @return array of field names (possibly include model prefixes)
669
+	 */
670
+	public static function prepareFieldNamesFromJson(array $field_names)
671
+	{
672
+		$new_array = array();
673
+		foreach ($field_names as $key => $field_name) {
674
+			$new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
675
+		}
676
+		return $new_array;
677
+	}
678
+
679
+
680
+
681
+	/**
682
+	 * Takes array where array keys are field names (possibly with model path prefixes)
683
+	 * from the REST API and prepares them for model querying
684
+	 *
685
+	 * @param array $field_names_as_keys
686
+	 * @return array
687
+	 */
688
+	public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
689
+	{
690
+		$new_array = array();
691
+		foreach ($field_names_as_keys as $field_name => $value) {
692
+			$new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value;
693
+		}
694
+		return $new_array;
695
+	}
696
+
697
+
698
+
699
+	/**
700
+	 * Prepares an array of model query params for use in the REST API
701
+	 *
702
+	 * @param array     $model_query_params
703
+	 * @param EEM_Base $model
704
+	 * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
705
+	 *                                     REST API
706
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
707
+	 * @throws EE_Error
708
+	 */
709
+	public static function prepareQueryParamsForRestApi(
710
+		array $model_query_params,
711
+		EEM_Base $model,
712
+		$requested_version = null
713
+	) {
714
+		if ($requested_version === null) {
715
+			$requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
716
+		}
717
+		$rest_query_params = $model_query_params;
718
+		if (isset($model_query_params[0])) {
719
+			$rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
720
+				$model_query_params[0],
721
+				$model,
722
+				$requested_version
723
+			);
724
+			unset($rest_query_params[0]);
725
+		}
726
+		if (isset($model_query_params['having'])) {
727
+			$rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
728
+				$model_query_params['having'],
729
+				$model,
730
+				$requested_version
731
+			);
732
+		}
733
+		return apply_filters(
734
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
735
+			$rest_query_params,
736
+			$model_query_params,
737
+			$model,
738
+			$requested_version
739
+		);
740
+	}
741
+
742
+
743
+
744
+	/**
745
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
746
+	 *
747
+	 * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
748
+	 *                                                      passed into EEM_Base::get_all()
749
+	 * @param EEM_Base $model
750
+	 * @param string    $requested_version                  eg "4.8.36"
751
+	 * @return array ready for use in the rest api query params
752
+	 * @throws EE_Error
753
+	 * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
754
+	 *                                     (which would be really unusual)
755
+	 */
756
+	public static function prepareConditionsQueryParamsForRestApi(
757
+		$inputted_query_params_of_this_type,
758
+		EEM_Base $model,
759
+		$requested_version
760
+	) {
761
+		$query_param_for_models = array();
762
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
763
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
764
+				ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
765
+				$model
766
+			);
767
+			if ($field instanceof EE_Model_Field_Base) {
768
+				//did they specify an operator?
769
+				if (is_array($query_param_value)) {
770
+					$op = $query_param_value[0];
771
+					$translated_value = array($op);
772
+					if (isset($query_param_value[1])) {
773
+						$value = $query_param_value[1];
774
+						$translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
775
+							$field,
776
+							$value,
777
+							$requested_version
778
+						);
779
+					}
780
+				} else {
781
+					$translated_value = ModelDataTranslator::prepareFieldValueForJson(
782
+						$field,
783
+						$query_param_value,
784
+						$requested_version
785
+					);
786
+				}
787
+				$query_param_for_models[$query_param_key] = $translated_value;
788
+			} else {
789
+				//so it's not for a field, assume it's a logic query param key
790
+				$query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
791
+					$query_param_value,
792
+					$model,
793
+					$requested_version
794
+				);
795
+			}
796
+		}
797
+		return $query_param_for_models;
798
+	}
799
+
800
+
801
+
802
+	/**
803
+	 * @param $condition_query_param_key
804
+	 * @return string
805
+	 */
806
+	public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
807
+	{
808
+		$pos_of_star = strpos($condition_query_param_key, '*');
809
+		if ($pos_of_star === false) {
810
+			return $condition_query_param_key;
811
+		} else {
812
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
813
+			return $condition_query_param_sans_star;
814
+		}
815
+	}
816
+
817
+
818
+
819
+	/**
820
+	 * Takes the input parameter and finds the model field that it indicates.
821
+	 *
822
+	 * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
823
+	 * @param EEM_Base $model
824
+	 * @return EE_Model_Field_Base
825
+	 * @throws EE_Error
826
+	 */
827
+	public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
828
+	{
829
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
830
+		//which will help us find the database table and column
831
+		$query_param_parts = explode('.', $query_param_name);
832
+		if (empty($query_param_parts)) {
833
+			throw new EE_Error(
834
+				sprintf(
835
+					__(
836
+						'_extract_column_name is empty when trying to extract column and table name from %s',
837
+						'event_espresso'
838
+					),
839
+					$query_param_name
840
+				)
841
+			);
842
+		}
843
+		$number_of_parts = count($query_param_parts);
844
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
845
+		if ($number_of_parts === 1) {
846
+			$field_name = $last_query_param_part;
847
+		} else {// $number_of_parts >= 2
848
+			//the last part is the column name, and there are only 2parts. therefore...
849
+			$field_name = $last_query_param_part;
850
+			$model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
851
+		}
852
+		try {
853
+			return $model->field_settings_for($field_name, false);
854
+		} catch (EE_Error $e) {
855
+			return null;
856
+		}
857
+	}
858
+
859
+
860
+
861
+	/**
862
+	 * Returns true if $data can be easily represented in JSON.
863
+	 * Basically, objects and resources can't be represented in JSON easily.
864
+	 * @param mixed $data
865
+	 * @return bool
866
+	 */
867
+	protected static function isRepresentableInJson($data)
868
+	{
869
+		return is_scalar($data)
870
+			   || is_array($data)
871
+			   || is_null($data);
872
+	}
873 873
 }
Please login to merge, or discard this patch.
Spacing   +16 added lines, -16 removed lines patch added patch discarded remove patch
@@ -11,7 +11,7 @@  discard block
 block discarded – undo
11 11
 use EE_Serialized_Text_Field;
12 12
 use EEM_Base;
13 13
 
14
-if (! defined('EVENT_ESPRESSO_VERSION')) {
14
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
15 15
     exit('No direct script access allowed');
16 16
 }
17 17
 
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
                 '0',
229 229
                 STR_PAD_LEFT
230 230
             );
231
-        return $original_timestamp . $offset_sign . $offset_string;
231
+        return $original_timestamp.$offset_sign.$offset_string;
232 232
     }
233 233
 
234 234
 
@@ -272,10 +272,10 @@  discard block
 block discarded – undo
272 272
      */
273 273
     private static function parseTimezoneOffset($timezone_offset)
274 274
     {
275
-        $first_char = substr((string)$timezone_offset, 0, 1);
275
+        $first_char = substr((string) $timezone_offset, 0, 1);
276 276
         if ($first_char === '+' || $first_char === '-') {
277 277
             $offset_sign = $first_char;
278
-            $offset_secs = substr((string)$timezone_offset, 1);
278
+            $offset_secs = substr((string) $timezone_offset, 1);
279 279
         } else {
280 280
             $offset_sign = '+';
281 281
             $offset_secs = $timezone_offset;
@@ -302,12 +302,12 @@  discard block
 block discarded – undo
302 302
                 //did they submit a string of a unix timestamp?
303 303
                 if (is_numeric($original_value)) {
304 304
                     $datetime_obj = new \DateTime();
305
-                    $datetime_obj->setTimestamp((int)$original_value);
305
+                    $datetime_obj->setTimestamp((int) $original_value);
306 306
                 } else {
307 307
                     //first, check if its a MySQL timestamp in GMT
308 308
                     $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
309 309
                 }
310
-                if (! $datetime_obj instanceof \DateTime) {
310
+                if ( ! $datetime_obj instanceof \DateTime) {
311 311
                     //so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
312 312
                     $datetime_obj = $field_obj->prepare_for_set($original_value);
313 313
                 }
@@ -317,7 +317,7 @@  discard block
 block discarded – undo
317 317
                 $new_value = $original_value->format('Y-m-d H:i:s');
318 318
             } elseif (is_int($original_value) || is_float($original_value)) {
319 319
                 $new_value = date('Y-m-d H:i:s', $original_value);
320
-            } elseif($original_value === null || $original_value === '') {
320
+            } elseif ($original_value === null || $original_value === '') {
321 321
                 $new_value = null;
322 322
             } else {
323 323
                 //so it's not a datetime object, unix timestamp (as string or int),
@@ -333,7 +333,7 @@  discard block
 block discarded – undo
333 333
                         $original_value,
334 334
                         $field_obj->get_name(),
335 335
                         $field_obj->get_model_name(),
336
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
336
+                        $field_obj->get_time_format().' '.$field_obj->get_time_format()
337 337
                     )
338 338
                 );
339 339
             }
@@ -343,7 +343,7 @@  discard block
 block discarded – undo
343 343
         }
344 344
         //are we about to send an object? just don't. We have no good way to represent it in JSON.
345 345
         // can't just check using is_object() because that missed PHP incomplete objects
346
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
346
+        if ( ! ModelDataTranslator::isRepresentableInJson($new_value)) {
347 347
             $new_value = array(
348 348
                 'error_code' => 'php_object_not_return',
349 349
                 'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
@@ -393,7 +393,7 @@  discard block
 block discarded – undo
393 393
                 $model
394 394
             );
395 395
             //double-check is it a *_gmt field?
396
-            if (! $field instanceof EE_Model_Field_Base
396
+            if ( ! $field instanceof EE_Model_Field_Base
397 397
                 && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
398 398
             ) {
399 399
                 //yep, take off '_gmt', and find the field
@@ -412,8 +412,8 @@  discard block
 block discarded – undo
412 412
                 $timezone = $model->get_timezone();
413 413
             }
414 414
             if ($field instanceof EE_Model_Field_Base) {
415
-                if (! $writing && is_array($query_param_value)) {
416
-                    if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
415
+                if ( ! $writing && is_array($query_param_value)) {
416
+                    if ( ! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
417 417
                         if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
418 418
                             throw new RestException(
419 419
                                 'numerically_indexed_array_of_values_only',
@@ -448,7 +448,7 @@  discard block
 block discarded – undo
448 448
                             );
449 449
                         } elseif (array_key_exists($op, $model->valid_between_style_operators())
450 450
                             && isset($query_param_value[1], $query_param_value[2])
451
-                            && !isset($query_param_value[3])
451
+                            && ! isset($query_param_value[3])
452 452
                         ) {
453 453
                             $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
454 454
                                 $field,
@@ -472,10 +472,10 @@  discard block
 block discarded – undo
472 472
                             ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
473 473
                             $translated_value[] = $query_param_value[1];
474 474
                         } elseif (array_key_exists($op, $model->valid_null_style_operators())
475
-                            && !isset($query_param_value[1])) {
475
+                            && ! isset($query_param_value[1])) {
476 476
                             //no arguments should have been provided, so don't look for any
477 477
                         } elseif (isset($query_param_value[1])
478
-                            && !isset($query_param_value[2])
478
+                            && ! isset($query_param_value[2])
479 479
                             && ! array_key_exists(
480 480
                                 $op,
481 481
                                 array_merge(
@@ -626,7 +626,7 @@  discard block
 block discarded – undo
626 626
      */
627 627
     public static function removeGmtFromFieldName($field_name)
628 628
     {
629
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
629
+        if ( ! ModelDataTranslator::isGmtDateFieldName($field_name)) {
630 630
             return $field_name;
631 631
         }
632 632
         $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
Please login to merge, or discard this patch.
core/helpers/EEH_DTT_Helper.helper.php 1 patch
Indentation   +955 added lines, -955 removed lines patch added patch discarded remove patch
@@ -21,1015 +21,1015 @@
 block discarded – undo
21 21
 {
22 22
 
23 23
 
24
-    /**
25
-     * return the timezone set for the WP install
26
-     *
27
-     * @return string valid timezone string for PHP DateTimeZone() class
28
-     * @throws InvalidArgumentException
29
-     * @throws InvalidDataTypeException
30
-     * @throws InvalidInterfaceException
31
-     */
32
-    public static function get_timezone()
33
-    {
34
-        return EEH_DTT_Helper::get_valid_timezone_string();
35
-    }
24
+	/**
25
+	 * return the timezone set for the WP install
26
+	 *
27
+	 * @return string valid timezone string for PHP DateTimeZone() class
28
+	 * @throws InvalidArgumentException
29
+	 * @throws InvalidDataTypeException
30
+	 * @throws InvalidInterfaceException
31
+	 */
32
+	public static function get_timezone()
33
+	{
34
+		return EEH_DTT_Helper::get_valid_timezone_string();
35
+	}
36 36
 
37 37
 
38
-    /**
39
-     * get_valid_timezone_string
40
-     *    ensures that a valid timezone string is returned
41
-     *
42
-     * @param string $timezone_string
43
-     * @return string
44
-     * @throws InvalidArgumentException
45
-     * @throws InvalidDataTypeException
46
-     * @throws InvalidInterfaceException
47
-     */
48
-    public static function get_valid_timezone_string($timezone_string = '')
49
-    {
50
-        return self::getHelperAdapter()->getValidTimezoneString($timezone_string);
51
-    }
38
+	/**
39
+	 * get_valid_timezone_string
40
+	 *    ensures that a valid timezone string is returned
41
+	 *
42
+	 * @param string $timezone_string
43
+	 * @return string
44
+	 * @throws InvalidArgumentException
45
+	 * @throws InvalidDataTypeException
46
+	 * @throws InvalidInterfaceException
47
+	 */
48
+	public static function get_valid_timezone_string($timezone_string = '')
49
+	{
50
+		return self::getHelperAdapter()->getValidTimezoneString($timezone_string);
51
+	}
52 52
 
53 53
 
54
-    /**
55
-     * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
56
-     *
57
-     * @static
58
-     * @param  string $timezone_string Timezone string to check
59
-     * @param bool    $throw_error
60
-     * @return bool
61
-     * @throws InvalidArgumentException
62
-     * @throws InvalidDataTypeException
63
-     * @throws InvalidInterfaceException
64
-     */
65
-    public static function validate_timezone($timezone_string, $throw_error = true)
66
-    {
67
-        return self::getHelperAdapter()->validateTimezone($timezone_string, $throw_error);
68
-    }
54
+	/**
55
+	 * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
56
+	 *
57
+	 * @static
58
+	 * @param  string $timezone_string Timezone string to check
59
+	 * @param bool    $throw_error
60
+	 * @return bool
61
+	 * @throws InvalidArgumentException
62
+	 * @throws InvalidDataTypeException
63
+	 * @throws InvalidInterfaceException
64
+	 */
65
+	public static function validate_timezone($timezone_string, $throw_error = true)
66
+	{
67
+		return self::getHelperAdapter()->validateTimezone($timezone_string, $throw_error);
68
+	}
69 69
 
70 70
 
71
-    /**
72
-     * This returns a string that can represent the provided gmt offset in format that can be passed into
73
-     * DateTimeZone.  This is NOT a string that can be passed as a value on the WordPress timezone_string option.
74
-     *
75
-     * @param float|string $gmt_offset
76
-     * @return string
77
-     * @throws InvalidArgumentException
78
-     * @throws InvalidDataTypeException
79
-     * @throws InvalidInterfaceException
80
-     */
81
-    public static function get_timezone_string_from_gmt_offset($gmt_offset = '')
82
-    {
83
-        return self::getHelperAdapter()->getTimezoneStringFromGmtOffset($gmt_offset);
84
-    }
71
+	/**
72
+	 * This returns a string that can represent the provided gmt offset in format that can be passed into
73
+	 * DateTimeZone.  This is NOT a string that can be passed as a value on the WordPress timezone_string option.
74
+	 *
75
+	 * @param float|string $gmt_offset
76
+	 * @return string
77
+	 * @throws InvalidArgumentException
78
+	 * @throws InvalidDataTypeException
79
+	 * @throws InvalidInterfaceException
80
+	 */
81
+	public static function get_timezone_string_from_gmt_offset($gmt_offset = '')
82
+	{
83
+		return self::getHelperAdapter()->getTimezoneStringFromGmtOffset($gmt_offset);
84
+	}
85 85
 
86 86
 
87
-    /**
88
-     * Gets the site's GMT offset based on either the timezone string
89
-     * (in which case teh gmt offset will vary depending on the location's
90
-     * observance of daylight savings time) or the gmt_offset wp option
91
-     *
92
-     * @return int seconds offset
93
-     * @throws InvalidArgumentException
94
-     * @throws InvalidDataTypeException
95
-     * @throws InvalidInterfaceException
96
-     */
97
-    public static function get_site_timezone_gmt_offset()
98
-    {
99
-        return self::getHelperAdapter()->getSiteTimezoneGmtOffset();
100
-    }
87
+	/**
88
+	 * Gets the site's GMT offset based on either the timezone string
89
+	 * (in which case teh gmt offset will vary depending on the location's
90
+	 * observance of daylight savings time) or the gmt_offset wp option
91
+	 *
92
+	 * @return int seconds offset
93
+	 * @throws InvalidArgumentException
94
+	 * @throws InvalidDataTypeException
95
+	 * @throws InvalidInterfaceException
96
+	 */
97
+	public static function get_site_timezone_gmt_offset()
98
+	{
99
+		return self::getHelperAdapter()->getSiteTimezoneGmtOffset();
100
+	}
101 101
 
102 102
 
103
-    /**
104
-     * Depending on PHP version,
105
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
106
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
107
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
108
-     *
109
-     * @deprecated 4.9.54.rc    Developers this was always meant to only be an internally used method.  This will be
110
-     *                          removed in a future version of EE.
111
-     * @param int $gmt_offset
112
-     * @return int
113
-     * @throws InvalidArgumentException
114
-     * @throws InvalidDataTypeException
115
-     * @throws InvalidInterfaceException
116
-     */
117
-    public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
118
-    {
119
-        return self::getHelperAdapter()->adjustInvalidGmtOffsets($gmt_offset);
120
-    }
103
+	/**
104
+	 * Depending on PHP version,
105
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
106
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
107
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
108
+	 *
109
+	 * @deprecated 4.9.54.rc    Developers this was always meant to only be an internally used method.  This will be
110
+	 *                          removed in a future version of EE.
111
+	 * @param int $gmt_offset
112
+	 * @return int
113
+	 * @throws InvalidArgumentException
114
+	 * @throws InvalidDataTypeException
115
+	 * @throws InvalidInterfaceException
116
+	 */
117
+	public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
118
+	{
119
+		return self::getHelperAdapter()->adjustInvalidGmtOffsets($gmt_offset);
120
+	}
121 121
 
122 122
 
123
-    /**
124
-     * get_timezone_string_from_abbreviations_list
125
-     *
126
-     * @deprecated 4.9.54.rc  Developers, this was never intended to be public.  This is a soft deprecation for now.
127
-     *                        If you are using this, you'll want to work out an alternate way of getting the value.
128
-     * @param int  $gmt_offset
129
-     * @param bool $coerce If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset.
130
-     * @return string
131
-     * @throws EE_Error
132
-     * @throws InvalidArgumentException
133
-     * @throws InvalidDataTypeException
134
-     * @throws InvalidInterfaceException
135
-     */
136
-    public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
137
-    {
138
-        $gmt_offset =  (int) $gmt_offset;
139
-        /** @var array[] $abbreviations */
140
-        $abbreviations = DateTimeZone::listAbbreviations();
141
-        foreach ($abbreviations as $abbreviation) {
142
-            foreach ($abbreviation as $timezone) {
143
-                if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
144
-                    try {
145
-                        $offset = self::get_timezone_offset(new DateTimeZone($timezone['timezone_id']));
146
-                        if ($offset !== $gmt_offset) {
147
-                            continue;
148
-                        }
149
-                        return $timezone['timezone_id'];
150
-                    } catch (Exception $e) {
151
-                        continue;
152
-                    }
153
-                }
154
-            }
155
-        }
156
-        //if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
157
-        if ($coerce === true) {
158
-            $timezone_string = self::get_timezone_string_from_abbreviations_list(
159
-                self::adjust_invalid_gmt_offsets($gmt_offset),
160
-                false
161
-            );
162
-            if ($timezone_string) {
163
-                return $timezone_string;
164
-            }
165
-        }
166
-        throw new EE_Error(
167
-            sprintf(
168
-                esc_html__(
169
-                    'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
170
-                    'event_espresso'
171
-                ),
172
-                $gmt_offset / HOUR_IN_SECONDS,
173
-                '<a href="http://www.php.net/manual/en/timezones.php">',
174
-                '</a>'
175
-            )
176
-        );
177
-    }
123
+	/**
124
+	 * get_timezone_string_from_abbreviations_list
125
+	 *
126
+	 * @deprecated 4.9.54.rc  Developers, this was never intended to be public.  This is a soft deprecation for now.
127
+	 *                        If you are using this, you'll want to work out an alternate way of getting the value.
128
+	 * @param int  $gmt_offset
129
+	 * @param bool $coerce If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset.
130
+	 * @return string
131
+	 * @throws EE_Error
132
+	 * @throws InvalidArgumentException
133
+	 * @throws InvalidDataTypeException
134
+	 * @throws InvalidInterfaceException
135
+	 */
136
+	public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
137
+	{
138
+		$gmt_offset =  (int) $gmt_offset;
139
+		/** @var array[] $abbreviations */
140
+		$abbreviations = DateTimeZone::listAbbreviations();
141
+		foreach ($abbreviations as $abbreviation) {
142
+			foreach ($abbreviation as $timezone) {
143
+				if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
144
+					try {
145
+						$offset = self::get_timezone_offset(new DateTimeZone($timezone['timezone_id']));
146
+						if ($offset !== $gmt_offset) {
147
+							continue;
148
+						}
149
+						return $timezone['timezone_id'];
150
+					} catch (Exception $e) {
151
+						continue;
152
+					}
153
+				}
154
+			}
155
+		}
156
+		//if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
157
+		if ($coerce === true) {
158
+			$timezone_string = self::get_timezone_string_from_abbreviations_list(
159
+				self::adjust_invalid_gmt_offsets($gmt_offset),
160
+				false
161
+			);
162
+			if ($timezone_string) {
163
+				return $timezone_string;
164
+			}
165
+		}
166
+		throw new EE_Error(
167
+			sprintf(
168
+				esc_html__(
169
+					'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
170
+					'event_espresso'
171
+				),
172
+				$gmt_offset / HOUR_IN_SECONDS,
173
+				'<a href="http://www.php.net/manual/en/timezones.php">',
174
+				'</a>'
175
+			)
176
+		);
177
+	}
178 178
 
179 179
 
180
-    /**
181
-     * Get Timezone Transitions
182
-     *
183
-     * @param DateTimeZone $date_time_zone
184
-     * @param int|null     $time
185
-     * @param bool         $first_only
186
-     * @return array
187
-     * @throws InvalidArgumentException
188
-     * @throws InvalidDataTypeException
189
-     * @throws InvalidInterfaceException
190
-     */
191
-    public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
192
-    {
193
-        return self::getHelperAdapter()->getTimezoneTransitions($date_time_zone, $time, $first_only);
194
-    }
180
+	/**
181
+	 * Get Timezone Transitions
182
+	 *
183
+	 * @param DateTimeZone $date_time_zone
184
+	 * @param int|null     $time
185
+	 * @param bool         $first_only
186
+	 * @return array
187
+	 * @throws InvalidArgumentException
188
+	 * @throws InvalidDataTypeException
189
+	 * @throws InvalidInterfaceException
190
+	 */
191
+	public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
192
+	{
193
+		return self::getHelperAdapter()->getTimezoneTransitions($date_time_zone, $time, $first_only);
194
+	}
195 195
 
196 196
 
197
-    /**
198
-     * Get Timezone Offset for given timezone object.
199
-     *
200
-     * @param DateTimeZone $date_time_zone
201
-     * @param null         $time
202
-     * @return mixed
203
-     * @throws InvalidArgumentException
204
-     * @throws InvalidDataTypeException
205
-     * @throws InvalidInterfaceException
206
-     */
207
-    public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
208
-    {
209
-        return self::getHelperAdapter()->getTimezoneOffset($date_time_zone, $time);
210
-    }
197
+	/**
198
+	 * Get Timezone Offset for given timezone object.
199
+	 *
200
+	 * @param DateTimeZone $date_time_zone
201
+	 * @param null         $time
202
+	 * @return mixed
203
+	 * @throws InvalidArgumentException
204
+	 * @throws InvalidDataTypeException
205
+	 * @throws InvalidInterfaceException
206
+	 */
207
+	public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
208
+	{
209
+		return self::getHelperAdapter()->getTimezoneOffset($date_time_zone, $time);
210
+	}
211 211
 
212 212
 
213
-    /**
214
-     * Prints a select input for the given timezone string.
215
-     * @param string $timezone_string
216
-     * @deprecatd 4.9.54.rc   Soft deprecation.  Consider using \EEH_DTT_Helper::wp_timezone_choice instead.
217
-     * @throws InvalidArgumentException
218
-     * @throws InvalidDataTypeException
219
-     * @throws InvalidInterfaceException
220
-     */
221
-    public static function timezone_select_input($timezone_string = '')
222
-    {
223
-        self::getHelperAdapter()->timezoneSelectInput($timezone_string);
224
-    }
213
+	/**
214
+	 * Prints a select input for the given timezone string.
215
+	 * @param string $timezone_string
216
+	 * @deprecatd 4.9.54.rc   Soft deprecation.  Consider using \EEH_DTT_Helper::wp_timezone_choice instead.
217
+	 * @throws InvalidArgumentException
218
+	 * @throws InvalidDataTypeException
219
+	 * @throws InvalidInterfaceException
220
+	 */
221
+	public static function timezone_select_input($timezone_string = '')
222
+	{
223
+		self::getHelperAdapter()->timezoneSelectInput($timezone_string);
224
+	}
225 225
 
226 226
 
227
-    /**
228
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
229
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
230
-     * the site is used.
231
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
232
-     * computed timestamp (i.e. date_i18n() )
233
-     *
234
-     * @param int    $unix_timestamp                  if 0, then time() will be used.
235
-     * @param string $timezone_string                 timezone_string. If empty, then the current set timezone for the
236
-     *                                                site will be used.
237
-     * @return int $unix_timestamp with the offset applied for the given timezone.
238
-     * @throws InvalidArgumentException
239
-     * @throws InvalidDataTypeException
240
-     * @throws InvalidInterfaceException
241
-     */
242
-    public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
243
-    {
244
-        return self::getHelperAdapter()->getTimestampWithOffset($unix_timestamp, $timezone_string);
245
-    }
227
+	/**
228
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
229
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
230
+	 * the site is used.
231
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
232
+	 * computed timestamp (i.e. date_i18n() )
233
+	 *
234
+	 * @param int    $unix_timestamp                  if 0, then time() will be used.
235
+	 * @param string $timezone_string                 timezone_string. If empty, then the current set timezone for the
236
+	 *                                                site will be used.
237
+	 * @return int $unix_timestamp with the offset applied for the given timezone.
238
+	 * @throws InvalidArgumentException
239
+	 * @throws InvalidDataTypeException
240
+	 * @throws InvalidInterfaceException
241
+	 */
242
+	public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
243
+	{
244
+		return self::getHelperAdapter()->getTimestampWithOffset($unix_timestamp, $timezone_string);
245
+	}
246 246
 
247 247
 
248
-    /**
249
-     *    _set_date_time_field
250
-     *    modifies EE_Base_Class EE_Datetime_Field objects
251
-     *
252
-     * @param  EE_Base_Class $obj                 EE_Base_Class object
253
-     * @param    DateTime    $DateTime            PHP DateTime object
254
-     * @param  string        $datetime_field_name the datetime fieldname to be manipulated
255
-     * @return EE_Base_Class
256
-     * @throws EE_Error
257
-     */
258
-    protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name)
259
-    {
260
-        // grab current datetime format
261
-        $current_format = $obj->get_format();
262
-        // set new full timestamp format
263
-        $obj->set_date_format(EE_Datetime_Field::mysql_date_format);
264
-        $obj->set_time_format(EE_Datetime_Field::mysql_time_format);
265
-        // set the new date value using a full timestamp format so that no data is lost
266
-        $obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format));
267
-        // reset datetime formats
268
-        $obj->set_date_format($current_format[0]);
269
-        $obj->set_time_format($current_format[1]);
270
-        return $obj;
271
-    }
248
+	/**
249
+	 *    _set_date_time_field
250
+	 *    modifies EE_Base_Class EE_Datetime_Field objects
251
+	 *
252
+	 * @param  EE_Base_Class $obj                 EE_Base_Class object
253
+	 * @param    DateTime    $DateTime            PHP DateTime object
254
+	 * @param  string        $datetime_field_name the datetime fieldname to be manipulated
255
+	 * @return EE_Base_Class
256
+	 * @throws EE_Error
257
+	 */
258
+	protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name)
259
+	{
260
+		// grab current datetime format
261
+		$current_format = $obj->get_format();
262
+		// set new full timestamp format
263
+		$obj->set_date_format(EE_Datetime_Field::mysql_date_format);
264
+		$obj->set_time_format(EE_Datetime_Field::mysql_time_format);
265
+		// set the new date value using a full timestamp format so that no data is lost
266
+		$obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format));
267
+		// reset datetime formats
268
+		$obj->set_date_format($current_format[0]);
269
+		$obj->set_time_format($current_format[1]);
270
+		return $obj;
271
+	}
272 272
 
273 273
 
274
-    /**
275
-     *    date_time_add
276
-     *    helper for doing simple datetime calculations on a given datetime from EE_Base_Class
277
-     *    and modifying it IN the EE_Base_Class so you don't have to do anything else.
278
-     *
279
-     * @param  EE_Base_Class $obj                 EE_Base_Class object
280
-     * @param  string        $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
281
-     * @param  string        $period              what you are adding. The options are (years, months, days, hours,
282
-     *                                            minutes, seconds) defaults to years
283
-     * @param  integer       $value               what you want to increment the time by
284
-     * @return EE_Base_Class return the EE_Base_Class object so right away you can do something with it
285
-     *                                            (chaining)
286
-     * @throws EE_Error
287
-     * @throws Exception
288
-     */
289
-    public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
290
-    {
291
-        //get the raw UTC date.
292
-        $DateTime = $obj->get_DateTime_object($datetime_field_name);
293
-        $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value);
294
-        return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
295
-    }
274
+	/**
275
+	 *    date_time_add
276
+	 *    helper for doing simple datetime calculations on a given datetime from EE_Base_Class
277
+	 *    and modifying it IN the EE_Base_Class so you don't have to do anything else.
278
+	 *
279
+	 * @param  EE_Base_Class $obj                 EE_Base_Class object
280
+	 * @param  string        $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
281
+	 * @param  string        $period              what you are adding. The options are (years, months, days, hours,
282
+	 *                                            minutes, seconds) defaults to years
283
+	 * @param  integer       $value               what you want to increment the time by
284
+	 * @return EE_Base_Class return the EE_Base_Class object so right away you can do something with it
285
+	 *                                            (chaining)
286
+	 * @throws EE_Error
287
+	 * @throws Exception
288
+	 */
289
+	public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
290
+	{
291
+		//get the raw UTC date.
292
+		$DateTime = $obj->get_DateTime_object($datetime_field_name);
293
+		$DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value);
294
+		return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
295
+	}
296 296
 
297 297
 
298
-    /**
299
-     *    date_time_subtract
300
-     *    same as date_time_add except subtracting value instead of adding.
301
-     *
302
-     * @param EE_Base_Class $obj
303
-     * @param  string       $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
304
-     * @param string        $period
305
-     * @param int           $value
306
-     * @return EE_Base_Class
307
-     * @throws EE_Error
308
-     * @throws Exception
309
-     */
310
-    public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
311
-    {
312
-        //get the raw UTC date
313
-        $DateTime = $obj->get_DateTime_object($datetime_field_name);
314
-        $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-');
315
-        return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
316
-    }
298
+	/**
299
+	 *    date_time_subtract
300
+	 *    same as date_time_add except subtracting value instead of adding.
301
+	 *
302
+	 * @param EE_Base_Class $obj
303
+	 * @param  string       $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
304
+	 * @param string        $period
305
+	 * @param int           $value
306
+	 * @return EE_Base_Class
307
+	 * @throws EE_Error
308
+	 * @throws Exception
309
+	 */
310
+	public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
311
+	{
312
+		//get the raw UTC date
313
+		$DateTime = $obj->get_DateTime_object($datetime_field_name);
314
+		$DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-');
315
+		return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
316
+	}
317 317
 
318 318
 
319
-    /**
320
-     * Simply takes an incoming DateTime object and does calculations on it based on the incoming parameters
321
-     *
322
-     * @param  DateTime   $DateTime DateTime object
323
-     * @param  string     $period   a value to indicate what interval is being used in the calculation. The options are
324
-     *                              'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
325
-     * @param  int|string $value    What you want to increment the date by
326
-     * @param  string     $operand  What operand you wish to use for the calculation
327
-     * @return DateTime return whatever type came in.
328
-     * @throws Exception
329
-     * @throws EE_Error
330
-     */
331
-    protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+')
332
-    {
333
-        if (! $DateTime instanceof DateTime) {
334
-            throw new EE_Error(
335
-                sprintf(
336
-                    esc_html__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
337
-                    print_r($DateTime, true)
338
-                )
339
-            );
340
-        }
341
-        switch ($period) {
342
-            case 'years' :
343
-                $value = 'P' . $value . 'Y';
344
-                break;
345
-            case 'months' :
346
-                $value = 'P' . $value . 'M';
347
-                break;
348
-            case 'weeks' :
349
-                $value = 'P' . $value . 'W';
350
-                break;
351
-            case 'days' :
352
-                $value = 'P' . $value . 'D';
353
-                break;
354
-            case 'hours' :
355
-                $value = 'PT' . $value . 'H';
356
-                break;
357
-            case 'minutes' :
358
-                $value = 'PT' . $value . 'M';
359
-                break;
360
-            case 'seconds' :
361
-                $value = 'PT' . $value . 'S';
362
-                break;
363
-        }
364
-        switch ($operand) {
365
-            case '+':
366
-                $DateTime->add(new DateInterval($value));
367
-                break;
368
-            case '-':
369
-                $DateTime->sub(new DateInterval($value));
370
-                break;
371
-        }
372
-        return $DateTime;
373
-    }
319
+	/**
320
+	 * Simply takes an incoming DateTime object and does calculations on it based on the incoming parameters
321
+	 *
322
+	 * @param  DateTime   $DateTime DateTime object
323
+	 * @param  string     $period   a value to indicate what interval is being used in the calculation. The options are
324
+	 *                              'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
325
+	 * @param  int|string $value    What you want to increment the date by
326
+	 * @param  string     $operand  What operand you wish to use for the calculation
327
+	 * @return DateTime return whatever type came in.
328
+	 * @throws Exception
329
+	 * @throws EE_Error
330
+	 */
331
+	protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+')
332
+	{
333
+		if (! $DateTime instanceof DateTime) {
334
+			throw new EE_Error(
335
+				sprintf(
336
+					esc_html__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
337
+					print_r($DateTime, true)
338
+				)
339
+			);
340
+		}
341
+		switch ($period) {
342
+			case 'years' :
343
+				$value = 'P' . $value . 'Y';
344
+				break;
345
+			case 'months' :
346
+				$value = 'P' . $value . 'M';
347
+				break;
348
+			case 'weeks' :
349
+				$value = 'P' . $value . 'W';
350
+				break;
351
+			case 'days' :
352
+				$value = 'P' . $value . 'D';
353
+				break;
354
+			case 'hours' :
355
+				$value = 'PT' . $value . 'H';
356
+				break;
357
+			case 'minutes' :
358
+				$value = 'PT' . $value . 'M';
359
+				break;
360
+			case 'seconds' :
361
+				$value = 'PT' . $value . 'S';
362
+				break;
363
+		}
364
+		switch ($operand) {
365
+			case '+':
366
+				$DateTime->add(new DateInterval($value));
367
+				break;
368
+			case '-':
369
+				$DateTime->sub(new DateInterval($value));
370
+				break;
371
+		}
372
+		return $DateTime;
373
+	}
374 374
 
375 375
 
376
-    /**
377
-     * Simply takes an incoming Unix timestamp and does calculations on it based on the incoming parameters
378
-     *
379
-     * @param  int     $timestamp Unix timestamp
380
-     * @param  string  $period    a value to indicate what interval is being used in the calculation. The options are
381
-     *                            'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
382
-     * @param  integer $value     What you want to increment the date by
383
-     * @param  string  $operand   What operand you wish to use for the calculation
384
-     * @return int
385
-     * @throws EE_Error
386
-     */
387
-    protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+')
388
-    {
389
-        if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
390
-            throw new EE_Error(
391
-                sprintf(
392
-                    esc_html__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
393
-                    print_r($timestamp, true)
394
-                )
395
-            );
396
-        }
397
-        switch ($period) {
398
-            case 'years' :
399
-                $value = YEAR_IN_SECONDS * $value;
400
-                break;
401
-            case 'months' :
402
-                $value = YEAR_IN_SECONDS / 12 * $value;
403
-                break;
404
-            case 'weeks' :
405
-                $value = WEEK_IN_SECONDS * $value;
406
-                break;
407
-            case 'days' :
408
-                $value = DAY_IN_SECONDS * $value;
409
-                break;
410
-            case 'hours' :
411
-                $value = HOUR_IN_SECONDS * $value;
412
-                break;
413
-            case 'minutes' :
414
-                $value = MINUTE_IN_SECONDS * $value;
415
-                break;
416
-        }
417
-        switch ($operand) {
418
-            case '+':
419
-                $timestamp += $value;
420
-                break;
421
-            case '-':
422
-                $timestamp -= $value;
423
-                break;
424
-        }
425
-        return $timestamp;
426
-    }
376
+	/**
377
+	 * Simply takes an incoming Unix timestamp and does calculations on it based on the incoming parameters
378
+	 *
379
+	 * @param  int     $timestamp Unix timestamp
380
+	 * @param  string  $period    a value to indicate what interval is being used in the calculation. The options are
381
+	 *                            'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
382
+	 * @param  integer $value     What you want to increment the date by
383
+	 * @param  string  $operand   What operand you wish to use for the calculation
384
+	 * @return int
385
+	 * @throws EE_Error
386
+	 */
387
+	protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+')
388
+	{
389
+		if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
390
+			throw new EE_Error(
391
+				sprintf(
392
+					esc_html__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
393
+					print_r($timestamp, true)
394
+				)
395
+			);
396
+		}
397
+		switch ($period) {
398
+			case 'years' :
399
+				$value = YEAR_IN_SECONDS * $value;
400
+				break;
401
+			case 'months' :
402
+				$value = YEAR_IN_SECONDS / 12 * $value;
403
+				break;
404
+			case 'weeks' :
405
+				$value = WEEK_IN_SECONDS * $value;
406
+				break;
407
+			case 'days' :
408
+				$value = DAY_IN_SECONDS * $value;
409
+				break;
410
+			case 'hours' :
411
+				$value = HOUR_IN_SECONDS * $value;
412
+				break;
413
+			case 'minutes' :
414
+				$value = MINUTE_IN_SECONDS * $value;
415
+				break;
416
+		}
417
+		switch ($operand) {
418
+			case '+':
419
+				$timestamp += $value;
420
+				break;
421
+			case '-':
422
+				$timestamp -= $value;
423
+				break;
424
+		}
425
+		return $timestamp;
426
+	}
427 427
 
428 428
 
429
-    /**
430
-     * Simply takes an incoming UTC timestamp or DateTime object and does calculations on it based on the incoming
431
-     * parameters and returns the new timestamp or DateTime.
432
-     *
433
-     * @param  int | DateTime $DateTime_or_timestamp DateTime object or Unix timestamp
434
-     * @param  string         $period                a value to indicate what interval is being used in the
435
-     *                                               calculation. The options are 'years', 'months', 'days', 'hours',
436
-     *                                               'minutes', 'seconds'. Defaults to years.
437
-     * @param  integer        $value                 What you want to increment the date by
438
-     * @param  string         $operand               What operand you wish to use for the calculation
439
-     * @return mixed string|DateTime          return whatever type came in.
440
-     * @throws Exception
441
-     * @throws EE_Error
442
-     */
443
-    public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+')
444
-    {
445
-        if ($DateTime_or_timestamp instanceof DateTime) {
446
-            return EEH_DTT_Helper::_modify_datetime_object(
447
-                $DateTime_or_timestamp,
448
-                $period,
449
-                $value,
450
-                $operand
451
-            );
452
-        }
453
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
454
-            return EEH_DTT_Helper::_modify_timestamp(
455
-                $DateTime_or_timestamp,
456
-                $period,
457
-                $value,
458
-                $operand
459
-            );
460
-        }
461
-        //error
462
-        return $DateTime_or_timestamp;
463
-    }
429
+	/**
430
+	 * Simply takes an incoming UTC timestamp or DateTime object and does calculations on it based on the incoming
431
+	 * parameters and returns the new timestamp or DateTime.
432
+	 *
433
+	 * @param  int | DateTime $DateTime_or_timestamp DateTime object or Unix timestamp
434
+	 * @param  string         $period                a value to indicate what interval is being used in the
435
+	 *                                               calculation. The options are 'years', 'months', 'days', 'hours',
436
+	 *                                               'minutes', 'seconds'. Defaults to years.
437
+	 * @param  integer        $value                 What you want to increment the date by
438
+	 * @param  string         $operand               What operand you wish to use for the calculation
439
+	 * @return mixed string|DateTime          return whatever type came in.
440
+	 * @throws Exception
441
+	 * @throws EE_Error
442
+	 */
443
+	public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+')
444
+	{
445
+		if ($DateTime_or_timestamp instanceof DateTime) {
446
+			return EEH_DTT_Helper::_modify_datetime_object(
447
+				$DateTime_or_timestamp,
448
+				$period,
449
+				$value,
450
+				$operand
451
+			);
452
+		}
453
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
454
+			return EEH_DTT_Helper::_modify_timestamp(
455
+				$DateTime_or_timestamp,
456
+				$period,
457
+				$value,
458
+				$operand
459
+			);
460
+		}
461
+		//error
462
+		return $DateTime_or_timestamp;
463
+	}
464 464
 
465 465
 
466
-    /**
467
-     * The purpose of this helper method is to receive an incoming format string in php date/time format
468
-     * and spit out the js and moment.js equivalent formats.
469
-     * Note, if no format string is given, then it is assumed the user wants what is set for WP.
470
-     * Note, js date and time formats are those used by the jquery-ui datepicker and the jquery-ui date-
471
-     * time picker.
472
-     *
473
-     * @see http://stackoverflow.com/posts/16725290/ for the code inspiration.
474
-     * @param string $date_format_string
475
-     * @param string $time_format_string
476
-     * @return array
477
-     *              array(
478
-     *              'js' => array (
479
-     *              'date' => //date format
480
-     *              'time' => //time format
481
-     *              ),
482
-     *              'moment' => //date and time format.
483
-     *              )
484
-     */
485
-    public static function convert_php_to_js_and_moment_date_formats(
486
-        $date_format_string = null,
487
-        $time_format_string = null
488
-    ) {
489
-        if ($date_format_string === null) {
490
-            $date_format_string = (string) get_option('date_format');
491
-        }
492
-        if ($time_format_string === null) {
493
-            $time_format_string = (string) get_option('time_format');
494
-        }
495
-        $date_format = self::_php_to_js_moment_converter($date_format_string);
496
-        $time_format = self::_php_to_js_moment_converter($time_format_string);
497
-        return array(
498
-            'js'     => array(
499
-                'date' => $date_format['js'],
500
-                'time' => $time_format['js'],
501
-            ),
502
-            'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
503
-        );
504
-    }
466
+	/**
467
+	 * The purpose of this helper method is to receive an incoming format string in php date/time format
468
+	 * and spit out the js and moment.js equivalent formats.
469
+	 * Note, if no format string is given, then it is assumed the user wants what is set for WP.
470
+	 * Note, js date and time formats are those used by the jquery-ui datepicker and the jquery-ui date-
471
+	 * time picker.
472
+	 *
473
+	 * @see http://stackoverflow.com/posts/16725290/ for the code inspiration.
474
+	 * @param string $date_format_string
475
+	 * @param string $time_format_string
476
+	 * @return array
477
+	 *              array(
478
+	 *              'js' => array (
479
+	 *              'date' => //date format
480
+	 *              'time' => //time format
481
+	 *              ),
482
+	 *              'moment' => //date and time format.
483
+	 *              )
484
+	 */
485
+	public static function convert_php_to_js_and_moment_date_formats(
486
+		$date_format_string = null,
487
+		$time_format_string = null
488
+	) {
489
+		if ($date_format_string === null) {
490
+			$date_format_string = (string) get_option('date_format');
491
+		}
492
+		if ($time_format_string === null) {
493
+			$time_format_string = (string) get_option('time_format');
494
+		}
495
+		$date_format = self::_php_to_js_moment_converter($date_format_string);
496
+		$time_format = self::_php_to_js_moment_converter($time_format_string);
497
+		return array(
498
+			'js'     => array(
499
+				'date' => $date_format['js'],
500
+				'time' => $time_format['js'],
501
+			),
502
+			'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
503
+		);
504
+	}
505 505
 
506 506
 
507
-    /**
508
-     * This converts incoming format string into js and moment variations.
509
-     *
510
-     * @param string $format_string incoming php format string
511
-     * @return array js and moment formats.
512
-     */
513
-    protected static function _php_to_js_moment_converter($format_string)
514
-    {
515
-        /**
516
-         * This is a map of symbols for formats.
517
-         * The index is the php symbol, the equivalent values are in the array.
518
-         *
519
-         * @var array
520
-         */
521
-        $symbols_map          = array(
522
-            // Day
523
-            //01
524
-            'd' => array(
525
-                'js'     => 'dd',
526
-                'moment' => 'DD',
527
-            ),
528
-            //Mon
529
-            'D' => array(
530
-                'js'     => 'D',
531
-                'moment' => 'ddd',
532
-            ),
533
-            //1,2,...31
534
-            'j' => array(
535
-                'js'     => 'd',
536
-                'moment' => 'D',
537
-            ),
538
-            //Monday
539
-            'l' => array(
540
-                'js'     => 'DD',
541
-                'moment' => 'dddd',
542
-            ),
543
-            //ISO numeric representation of the day of the week (1-6)
544
-            'N' => array(
545
-                'js'     => '',
546
-                'moment' => 'E',
547
-            ),
548
-            //st,nd.rd
549
-            'S' => array(
550
-                'js'     => '',
551
-                'moment' => 'o',
552
-            ),
553
-            //numeric representation of day of week (0-6)
554
-            'w' => array(
555
-                'js'     => '',
556
-                'moment' => 'd',
557
-            ),
558
-            //day of year starting from 0 (0-365)
559
-            'z' => array(
560
-                'js'     => 'o',
561
-                'moment' => 'DDD' //note moment does not start with 0 so will need to modify by subtracting 1
562
-            ),
563
-            // Week
564
-            //ISO-8601 week number of year (weeks starting on monday)
565
-            'W' => array(
566
-                'js'     => '',
567
-                'moment' => 'w',
568
-            ),
569
-            // Month
570
-            // January...December
571
-            'F' => array(
572
-                'js'     => 'MM',
573
-                'moment' => 'MMMM',
574
-            ),
575
-            //01...12
576
-            'm' => array(
577
-                'js'     => 'mm',
578
-                'moment' => 'MM',
579
-            ),
580
-            //Jan...Dec
581
-            'M' => array(
582
-                'js'     => 'M',
583
-                'moment' => 'MMM',
584
-            ),
585
-            //1-12
586
-            'n' => array(
587
-                'js'     => 'm',
588
-                'moment' => 'M',
589
-            ),
590
-            //number of days in given month
591
-            't' => array(
592
-                'js'     => '',
593
-                'moment' => '',
594
-            ),
595
-            // Year
596
-            //whether leap year or not 1/0
597
-            'L' => array(
598
-                'js'     => '',
599
-                'moment' => '',
600
-            ),
601
-            //ISO-8601 year number
602
-            'o' => array(
603
-                'js'     => '',
604
-                'moment' => 'GGGG',
605
-            ),
606
-            //1999...2003
607
-            'Y' => array(
608
-                'js'     => 'yy',
609
-                'moment' => 'YYYY',
610
-            ),
611
-            //99...03
612
-            'y' => array(
613
-                'js'     => 'y',
614
-                'moment' => 'YY',
615
-            ),
616
-            // Time
617
-            // am/pm
618
-            'a' => array(
619
-                'js'     => 'tt',
620
-                'moment' => 'a',
621
-            ),
622
-            // AM/PM
623
-            'A' => array(
624
-                'js'     => 'TT',
625
-                'moment' => 'A',
626
-            ),
627
-            // Swatch Internet Time?!?
628
-            'B' => array(
629
-                'js'     => '',
630
-                'moment' => '',
631
-            ),
632
-            //1...12
633
-            'g' => array(
634
-                'js'     => 'h',
635
-                'moment' => 'h',
636
-            ),
637
-            //0...23
638
-            'G' => array(
639
-                'js'     => 'H',
640
-                'moment' => 'H',
641
-            ),
642
-            //01...12
643
-            'h' => array(
644
-                'js'     => 'hh',
645
-                'moment' => 'hh',
646
-            ),
647
-            //00...23
648
-            'H' => array(
649
-                'js'     => 'HH',
650
-                'moment' => 'HH',
651
-            ),
652
-            //00..59
653
-            'i' => array(
654
-                'js'     => 'mm',
655
-                'moment' => 'mm',
656
-            ),
657
-            //seconds... 00...59
658
-            's' => array(
659
-                'js'     => 'ss',
660
-                'moment' => 'ss',
661
-            ),
662
-            //microseconds
663
-            'u' => array(
664
-                'js'     => '',
665
-                'moment' => '',
666
-            ),
667
-        );
668
-        $jquery_ui_format     = '';
669
-        $moment_format        = '';
670
-        $escaping             = false;
671
-        $format_string_length = strlen($format_string);
672
-        for ($i = 0; $i < $format_string_length; $i++) {
673
-            $char = $format_string[ $i ];
674
-            if ($char === '\\') { // PHP date format escaping character
675
-                $i++;
676
-                if ($escaping) {
677
-                    $jquery_ui_format .= $format_string[ $i ];
678
-                    $moment_format    .= $format_string[ $i ];
679
-                } else {
680
-                    $jquery_ui_format .= '\'' . $format_string[ $i ];
681
-                    $moment_format    .= $format_string[ $i ];
682
-                }
683
-                $escaping = true;
684
-            } else {
685
-                if ($escaping) {
686
-                    $jquery_ui_format .= "'";
687
-                    $moment_format    .= "'";
688
-                    $escaping         = false;
689
-                }
690
-                if (isset($symbols_map[ $char ])) {
691
-                    $jquery_ui_format .= $symbols_map[ $char ]['js'];
692
-                    $moment_format    .= $symbols_map[ $char ]['moment'];
693
-                } else {
694
-                    $jquery_ui_format .= $char;
695
-                    $moment_format    .= $char;
696
-                }
697
-            }
698
-        }
699
-        return array('js' => $jquery_ui_format, 'moment' => $moment_format);
700
-    }
507
+	/**
508
+	 * This converts incoming format string into js and moment variations.
509
+	 *
510
+	 * @param string $format_string incoming php format string
511
+	 * @return array js and moment formats.
512
+	 */
513
+	protected static function _php_to_js_moment_converter($format_string)
514
+	{
515
+		/**
516
+		 * This is a map of symbols for formats.
517
+		 * The index is the php symbol, the equivalent values are in the array.
518
+		 *
519
+		 * @var array
520
+		 */
521
+		$symbols_map          = array(
522
+			// Day
523
+			//01
524
+			'd' => array(
525
+				'js'     => 'dd',
526
+				'moment' => 'DD',
527
+			),
528
+			//Mon
529
+			'D' => array(
530
+				'js'     => 'D',
531
+				'moment' => 'ddd',
532
+			),
533
+			//1,2,...31
534
+			'j' => array(
535
+				'js'     => 'd',
536
+				'moment' => 'D',
537
+			),
538
+			//Monday
539
+			'l' => array(
540
+				'js'     => 'DD',
541
+				'moment' => 'dddd',
542
+			),
543
+			//ISO numeric representation of the day of the week (1-6)
544
+			'N' => array(
545
+				'js'     => '',
546
+				'moment' => 'E',
547
+			),
548
+			//st,nd.rd
549
+			'S' => array(
550
+				'js'     => '',
551
+				'moment' => 'o',
552
+			),
553
+			//numeric representation of day of week (0-6)
554
+			'w' => array(
555
+				'js'     => '',
556
+				'moment' => 'd',
557
+			),
558
+			//day of year starting from 0 (0-365)
559
+			'z' => array(
560
+				'js'     => 'o',
561
+				'moment' => 'DDD' //note moment does not start with 0 so will need to modify by subtracting 1
562
+			),
563
+			// Week
564
+			//ISO-8601 week number of year (weeks starting on monday)
565
+			'W' => array(
566
+				'js'     => '',
567
+				'moment' => 'w',
568
+			),
569
+			// Month
570
+			// January...December
571
+			'F' => array(
572
+				'js'     => 'MM',
573
+				'moment' => 'MMMM',
574
+			),
575
+			//01...12
576
+			'm' => array(
577
+				'js'     => 'mm',
578
+				'moment' => 'MM',
579
+			),
580
+			//Jan...Dec
581
+			'M' => array(
582
+				'js'     => 'M',
583
+				'moment' => 'MMM',
584
+			),
585
+			//1-12
586
+			'n' => array(
587
+				'js'     => 'm',
588
+				'moment' => 'M',
589
+			),
590
+			//number of days in given month
591
+			't' => array(
592
+				'js'     => '',
593
+				'moment' => '',
594
+			),
595
+			// Year
596
+			//whether leap year or not 1/0
597
+			'L' => array(
598
+				'js'     => '',
599
+				'moment' => '',
600
+			),
601
+			//ISO-8601 year number
602
+			'o' => array(
603
+				'js'     => '',
604
+				'moment' => 'GGGG',
605
+			),
606
+			//1999...2003
607
+			'Y' => array(
608
+				'js'     => 'yy',
609
+				'moment' => 'YYYY',
610
+			),
611
+			//99...03
612
+			'y' => array(
613
+				'js'     => 'y',
614
+				'moment' => 'YY',
615
+			),
616
+			// Time
617
+			// am/pm
618
+			'a' => array(
619
+				'js'     => 'tt',
620
+				'moment' => 'a',
621
+			),
622
+			// AM/PM
623
+			'A' => array(
624
+				'js'     => 'TT',
625
+				'moment' => 'A',
626
+			),
627
+			// Swatch Internet Time?!?
628
+			'B' => array(
629
+				'js'     => '',
630
+				'moment' => '',
631
+			),
632
+			//1...12
633
+			'g' => array(
634
+				'js'     => 'h',
635
+				'moment' => 'h',
636
+			),
637
+			//0...23
638
+			'G' => array(
639
+				'js'     => 'H',
640
+				'moment' => 'H',
641
+			),
642
+			//01...12
643
+			'h' => array(
644
+				'js'     => 'hh',
645
+				'moment' => 'hh',
646
+			),
647
+			//00...23
648
+			'H' => array(
649
+				'js'     => 'HH',
650
+				'moment' => 'HH',
651
+			),
652
+			//00..59
653
+			'i' => array(
654
+				'js'     => 'mm',
655
+				'moment' => 'mm',
656
+			),
657
+			//seconds... 00...59
658
+			's' => array(
659
+				'js'     => 'ss',
660
+				'moment' => 'ss',
661
+			),
662
+			//microseconds
663
+			'u' => array(
664
+				'js'     => '',
665
+				'moment' => '',
666
+			),
667
+		);
668
+		$jquery_ui_format     = '';
669
+		$moment_format        = '';
670
+		$escaping             = false;
671
+		$format_string_length = strlen($format_string);
672
+		for ($i = 0; $i < $format_string_length; $i++) {
673
+			$char = $format_string[ $i ];
674
+			if ($char === '\\') { // PHP date format escaping character
675
+				$i++;
676
+				if ($escaping) {
677
+					$jquery_ui_format .= $format_string[ $i ];
678
+					$moment_format    .= $format_string[ $i ];
679
+				} else {
680
+					$jquery_ui_format .= '\'' . $format_string[ $i ];
681
+					$moment_format    .= $format_string[ $i ];
682
+				}
683
+				$escaping = true;
684
+			} else {
685
+				if ($escaping) {
686
+					$jquery_ui_format .= "'";
687
+					$moment_format    .= "'";
688
+					$escaping         = false;
689
+				}
690
+				if (isset($symbols_map[ $char ])) {
691
+					$jquery_ui_format .= $symbols_map[ $char ]['js'];
692
+					$moment_format    .= $symbols_map[ $char ]['moment'];
693
+				} else {
694
+					$jquery_ui_format .= $char;
695
+					$moment_format    .= $char;
696
+				}
697
+			}
698
+		}
699
+		return array('js' => $jquery_ui_format, 'moment' => $moment_format);
700
+	}
701 701
 
702 702
 
703
-    /**
704
-     * This takes an incoming format string and validates it to ensure it will work fine with PHP.
705
-     *
706
-     * @param string $format_string   Incoming format string for php date().
707
-     * @return mixed bool|array  If all is okay then TRUE is returned.  Otherwise an array of validation
708
-     *                                errors is returned.  So for client code calling, check for is_array() to
709
-     *                                indicate failed validations.
710
-     */
711
-    public static function validate_format_string($format_string)
712
-    {
713
-        $error_msg = array();
714
-        //time format checks
715
-        switch (true) {
716
-            case   strpos($format_string, 'h') !== false  :
717
-            case   strpos($format_string, 'g') !== false :
718
-                /**
719
-                 * if the time string has a lowercase 'h' which == 12 hour time format and there
720
-                 * is not any ante meridiem format ('a' or 'A').  Then throw an error because its
721
-                 * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am.
722
-                 */
723
-                if (stripos($format_string, 'A') === false) {
724
-                    $error_msg[] = esc_html__(
725
-                        'There is a  time format for 12 hour time but no  "a" or "A" to indicate am/pm.  Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".',
726
-                        'event_espresso'
727
-                    );
728
-                }
729
-                break;
730
-        }
731
-        return empty($error_msg) ? true : $error_msg;
732
-    }
703
+	/**
704
+	 * This takes an incoming format string and validates it to ensure it will work fine with PHP.
705
+	 *
706
+	 * @param string $format_string   Incoming format string for php date().
707
+	 * @return mixed bool|array  If all is okay then TRUE is returned.  Otherwise an array of validation
708
+	 *                                errors is returned.  So for client code calling, check for is_array() to
709
+	 *                                indicate failed validations.
710
+	 */
711
+	public static function validate_format_string($format_string)
712
+	{
713
+		$error_msg = array();
714
+		//time format checks
715
+		switch (true) {
716
+			case   strpos($format_string, 'h') !== false  :
717
+			case   strpos($format_string, 'g') !== false :
718
+				/**
719
+				 * if the time string has a lowercase 'h' which == 12 hour time format and there
720
+				 * is not any ante meridiem format ('a' or 'A').  Then throw an error because its
721
+				 * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am.
722
+				 */
723
+				if (stripos($format_string, 'A') === false) {
724
+					$error_msg[] = esc_html__(
725
+						'There is a  time format for 12 hour time but no  "a" or "A" to indicate am/pm.  Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".',
726
+						'event_espresso'
727
+					);
728
+				}
729
+				break;
730
+		}
731
+		return empty($error_msg) ? true : $error_msg;
732
+	}
733 733
 
734 734
 
735
-    /**
736
-     *     If the the first date starts at midnight on one day, and the next date ends at midnight on the
737
-     *     very next day then this method will return true.
738
-     *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-16 00:00:00 then this function will return true.
739
-     *    If $date_1 = 2015-12-15 03:00:00 and $date_2 = 2015-12_16 03:00:00 then this function will return false.
740
-     *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-15 00:00:00 then this function will return true.
741
-     *
742
-     * @param mixed $date_1
743
-     * @param mixed $date_2
744
-     * @return bool
745
-     */
746
-    public static function dates_represent_one_24_hour_date($date_1, $date_2)
747
-    {
735
+	/**
736
+	 *     If the the first date starts at midnight on one day, and the next date ends at midnight on the
737
+	 *     very next day then this method will return true.
738
+	 *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-16 00:00:00 then this function will return true.
739
+	 *    If $date_1 = 2015-12-15 03:00:00 and $date_2 = 2015-12_16 03:00:00 then this function will return false.
740
+	 *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-15 00:00:00 then this function will return true.
741
+	 *
742
+	 * @param mixed $date_1
743
+	 * @param mixed $date_2
744
+	 * @return bool
745
+	 */
746
+	public static function dates_represent_one_24_hour_date($date_1, $date_2)
747
+	{
748 748
 
749
-        if (
750
-            (! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime)
751
-            || ($date_1->format(EE_Datetime_Field::mysql_time_format) !== '00:00:00'
752
-                || $date_2->format(
753
-                    EE_Datetime_Field::mysql_time_format
754
-                ) !== '00:00:00')
755
-        ) {
756
-            return false;
757
-        }
758
-        return $date_2->format('U') - $date_1->format('U') === 86400;
759
-    }
749
+		if (
750
+			(! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime)
751
+			|| ($date_1->format(EE_Datetime_Field::mysql_time_format) !== '00:00:00'
752
+				|| $date_2->format(
753
+					EE_Datetime_Field::mysql_time_format
754
+				) !== '00:00:00')
755
+		) {
756
+			return false;
757
+		}
758
+		return $date_2->format('U') - $date_1->format('U') === 86400;
759
+	}
760 760
 
761 761
 
762
-    /**
763
-     * This returns the appropriate query interval string that can be used in sql queries involving mysql Date
764
-     * Functions.
765
-     *
766
-     * @param string $timezone_string    A timezone string in a valid format to instantiate a DateTimeZone object.
767
-     * @param string $field_for_interval The Database field that is the interval is applied to in the query.
768
-     * @return string
769
-     */
770
-    public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval)
771
-    {
772
-        try {
773
-            /** need to account for timezone offset on the selects */
774
-            $DateTimeZone = new DateTimeZone($timezone_string);
775
-        } catch (Exception $e) {
776
-            $DateTimeZone = null;
777
-        }
778
-        /**
779
-         * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds.
780
-         * Hence we do the calc for DateTimeZone::getOffset.
781
-         */
782
-        $offset         = $DateTimeZone instanceof DateTimeZone
783
-            ? $DateTimeZone->getOffset(new DateTime('now')) / HOUR_IN_SECONDS
784
-            : (float) get_option('gmt_offset');
785
-        $query_interval = $offset < 0
786
-            ? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)'
787
-            : 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)';
788
-        return $query_interval;
789
-    }
762
+	/**
763
+	 * This returns the appropriate query interval string that can be used in sql queries involving mysql Date
764
+	 * Functions.
765
+	 *
766
+	 * @param string $timezone_string    A timezone string in a valid format to instantiate a DateTimeZone object.
767
+	 * @param string $field_for_interval The Database field that is the interval is applied to in the query.
768
+	 * @return string
769
+	 */
770
+	public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval)
771
+	{
772
+		try {
773
+			/** need to account for timezone offset on the selects */
774
+			$DateTimeZone = new DateTimeZone($timezone_string);
775
+		} catch (Exception $e) {
776
+			$DateTimeZone = null;
777
+		}
778
+		/**
779
+		 * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds.
780
+		 * Hence we do the calc for DateTimeZone::getOffset.
781
+		 */
782
+		$offset         = $DateTimeZone instanceof DateTimeZone
783
+			? $DateTimeZone->getOffset(new DateTime('now')) / HOUR_IN_SECONDS
784
+			: (float) get_option('gmt_offset');
785
+		$query_interval = $offset < 0
786
+			? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)'
787
+			: 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)';
788
+		return $query_interval;
789
+	}
790 790
 
791 791
 
792
-    /**
793
-     * Retrieves the site's default timezone and returns it formatted so it's ready for display
794
-     * to users. If you want to customize how its displayed feel free to fetch the 'timezone_string'
795
-     * and 'gmt_offset' WordPress options directly; or use the filter
796
-     * FHEE__EEH_DTT_Helper__get_timezone_string_for_display
797
-     * (although note that we remove any HTML that may be added)
798
-     *
799
-     * @return string
800
-     */
801
-    public static function get_timezone_string_for_display()
802
-    {
803
-        $pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
804
-        if (! empty($pretty_timezone)) {
805
-            return esc_html($pretty_timezone);
806
-        }
807
-        $timezone_string = get_option('timezone_string');
808
-        if ($timezone_string) {
809
-            static $mo_loaded = false;
810
-            // Load translations for continents and cities just like wp_timezone_choice does
811
-            if (! $mo_loaded) {
812
-                $locale = get_locale();
813
-                $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
814
-                load_textdomain('continents-cities', $mofile);
815
-                $mo_loaded = true;
816
-            }
817
-            //well that was easy.
818
-            $parts = explode('/', $timezone_string);
819
-            //remove the continent
820
-            unset($parts[0]);
821
-            $t_parts = array();
822
-            foreach ($parts as $part) {
823
-                $t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities');
824
-            }
825
-            return implode(' - ', $t_parts);
826
-        }
827
-        //they haven't set the timezone string, so let's return a string like "UTC+1"
828
-        $gmt_offset = get_option('gmt_offset');
829
-        $prefix     = (int) $gmt_offset >= 0 ? '+' : '';
830
-        $parts      = explode('.', (string) $gmt_offset);
831
-        if (count($parts) === 1) {
832
-            $parts[1] = '00';
833
-        } else {
834
-            //convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
835
-            //to minutes, eg 30 or 15, respectively
836
-            $hour_fraction = (float) ('0.' . $parts[1]);
837
-            $parts[1]      = (string) $hour_fraction * 60;
838
-        }
839
-        return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts));
840
-    }
792
+	/**
793
+	 * Retrieves the site's default timezone and returns it formatted so it's ready for display
794
+	 * to users. If you want to customize how its displayed feel free to fetch the 'timezone_string'
795
+	 * and 'gmt_offset' WordPress options directly; or use the filter
796
+	 * FHEE__EEH_DTT_Helper__get_timezone_string_for_display
797
+	 * (although note that we remove any HTML that may be added)
798
+	 *
799
+	 * @return string
800
+	 */
801
+	public static function get_timezone_string_for_display()
802
+	{
803
+		$pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
804
+		if (! empty($pretty_timezone)) {
805
+			return esc_html($pretty_timezone);
806
+		}
807
+		$timezone_string = get_option('timezone_string');
808
+		if ($timezone_string) {
809
+			static $mo_loaded = false;
810
+			// Load translations for continents and cities just like wp_timezone_choice does
811
+			if (! $mo_loaded) {
812
+				$locale = get_locale();
813
+				$mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
814
+				load_textdomain('continents-cities', $mofile);
815
+				$mo_loaded = true;
816
+			}
817
+			//well that was easy.
818
+			$parts = explode('/', $timezone_string);
819
+			//remove the continent
820
+			unset($parts[0]);
821
+			$t_parts = array();
822
+			foreach ($parts as $part) {
823
+				$t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities');
824
+			}
825
+			return implode(' - ', $t_parts);
826
+		}
827
+		//they haven't set the timezone string, so let's return a string like "UTC+1"
828
+		$gmt_offset = get_option('gmt_offset');
829
+		$prefix     = (int) $gmt_offset >= 0 ? '+' : '';
830
+		$parts      = explode('.', (string) $gmt_offset);
831
+		if (count($parts) === 1) {
832
+			$parts[1] = '00';
833
+		} else {
834
+			//convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
835
+			//to minutes, eg 30 or 15, respectively
836
+			$hour_fraction = (float) ('0.' . $parts[1]);
837
+			$parts[1]      = (string) $hour_fraction * 60;
838
+		}
839
+		return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts));
840
+	}
841 841
 
842 842
 
843 843
 
844
-    /**
845
-     * So PHP does this awesome thing where if you are trying to get a timestamp
846
-     * for a month using a string like "February" or "February 2017",
847
-     * and you don't specify a day as part of your string,
848
-     * then PHP will use whatever the current day of the month is.
849
-     * IF the current day of the month happens to be the 30th or 31st,
850
-     * then PHP gets really confused by a date like February 30,
851
-     * so instead of saying
852
-     *      "Hey February only has 28 days (this year)...
853
-     *      ...you must have meant the last day of the month!"
854
-     * PHP does the next most logical thing, and bumps the date up to March 2nd,
855
-     * because someone requesting February 30th obviously meant March 1st!
856
-     * The way around this is to always set the day to the first,
857
-     * so that the month will stay on the month you wanted.
858
-     * this method will add that "1" into your date regardless of the format.
859
-     *
860
-     * @param string $month
861
-     * @return string
862
-     */
863
-    public static function first_of_month_timestamp($month = '')
864
-    {
865
-        $month = (string) $month;
866
-        $year  = '';
867
-        // check if the incoming string has a year in it or not
868
-        if (preg_match('/\b\d{4}\b/', $month, $matches)) {
869
-            $year = $matches[0];
870
-            // ten remove that from the month string as well as any spaces
871
-            $month = trim(str_replace($year, '', $month));
872
-            // add a space before the year
873
-            $year = " {$year}";
874
-        }
875
-        // return timestamp for something like "February 1 2017"
876
-        return strtotime("{$month} 1{$year}");
877
-    }
844
+	/**
845
+	 * So PHP does this awesome thing where if you are trying to get a timestamp
846
+	 * for a month using a string like "February" or "February 2017",
847
+	 * and you don't specify a day as part of your string,
848
+	 * then PHP will use whatever the current day of the month is.
849
+	 * IF the current day of the month happens to be the 30th or 31st,
850
+	 * then PHP gets really confused by a date like February 30,
851
+	 * so instead of saying
852
+	 *      "Hey February only has 28 days (this year)...
853
+	 *      ...you must have meant the last day of the month!"
854
+	 * PHP does the next most logical thing, and bumps the date up to March 2nd,
855
+	 * because someone requesting February 30th obviously meant March 1st!
856
+	 * The way around this is to always set the day to the first,
857
+	 * so that the month will stay on the month you wanted.
858
+	 * this method will add that "1" into your date regardless of the format.
859
+	 *
860
+	 * @param string $month
861
+	 * @return string
862
+	 */
863
+	public static function first_of_month_timestamp($month = '')
864
+	{
865
+		$month = (string) $month;
866
+		$year  = '';
867
+		// check if the incoming string has a year in it or not
868
+		if (preg_match('/\b\d{4}\b/', $month, $matches)) {
869
+			$year = $matches[0];
870
+			// ten remove that from the month string as well as any spaces
871
+			$month = trim(str_replace($year, '', $month));
872
+			// add a space before the year
873
+			$year = " {$year}";
874
+		}
875
+		// return timestamp for something like "February 1 2017"
876
+		return strtotime("{$month} 1{$year}");
877
+	}
878 878
 
879 879
 
880
-    /**
881
-     * This simply returns the timestamp for tomorrow (midnight next day) in this sites timezone.  So it may be midnight
882
-     * for this sites timezone, but the timestamp could be some other time GMT.
883
-     */
884
-    public static function tomorrow()
885
-    {
886
-        //The multiplication of -1 ensures that we switch positive offsets to negative and negative offsets to positive
887
-        //before adding to the timestamp.  Why? Because we want tomorrow to be for midnight the next day in THIS timezone
888
-        //not an offset from midnight in UTC.  So if we're starting with UTC 00:00:00, then we want to make sure the
889
-        //final timestamp is equivalent to midnight in this timezone as represented in GMT.
890
-        return strtotime('tomorrow') + (self::get_site_timezone_gmt_offset() * -1);
891
-    }
880
+	/**
881
+	 * This simply returns the timestamp for tomorrow (midnight next day) in this sites timezone.  So it may be midnight
882
+	 * for this sites timezone, but the timestamp could be some other time GMT.
883
+	 */
884
+	public static function tomorrow()
885
+	{
886
+		//The multiplication of -1 ensures that we switch positive offsets to negative and negative offsets to positive
887
+		//before adding to the timestamp.  Why? Because we want tomorrow to be for midnight the next day in THIS timezone
888
+		//not an offset from midnight in UTC.  So if we're starting with UTC 00:00:00, then we want to make sure the
889
+		//final timestamp is equivalent to midnight in this timezone as represented in GMT.
890
+		return strtotime('tomorrow') + (self::get_site_timezone_gmt_offset() * -1);
891
+	}
892 892
 
893 893
 
894
-    /**
895
-     * **
896
-     * Gives a nicely-formatted list of timezone strings.
897
-     * Copied from the core wp function by the same name so we could customize to remove UTC offsets.
898
-     *
899
-     * @since     4.9.40.rc.008
900
-     * @staticvar bool $mo_loaded
901
-     * @staticvar string $locale_loaded
902
-     * @param string $selected_zone Selected timezone.
903
-     * @param string $locale        Optional. Locale to load the timezones in. Default current site locale.
904
-     * @return string
905
-     */
906
-    public static function wp_timezone_choice($selected_zone, $locale = null)
907
-    {
908
-        static $mo_loaded = false, $locale_loaded = null;
909
-        $continents = array(
910
-            'Africa',
911
-            'America',
912
-            'Antarctica',
913
-            'Arctic',
914
-            'Asia',
915
-            'Atlantic',
916
-            'Australia',
917
-            'Europe',
918
-            'Indian',
919
-            'Pacific',
920
-        );
921
-        // Load translations for continents and cities.
922
-        if (! $mo_loaded || $locale !== $locale_loaded) {
923
-            $locale_loaded = $locale ? $locale : get_locale();
924
-            $mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
925
-            unload_textdomain('continents-cities');
926
-            load_textdomain('continents-cities', $mofile);
927
-            $mo_loaded = true;
928
-        }
929
-        $zone_data = array();
930
-        foreach (timezone_identifiers_list() as $zone) {
931
-            $zone = explode('/', $zone);
932
-            if (! in_array($zone[0], $continents, true)) {
933
-                continue;
934
-            }
935
-            // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
936
-            $exists      = array(
937
-                0 => isset($zone[0]) && $zone[0],
938
-                1 => isset($zone[1]) && $zone[1],
939
-                2 => isset($zone[2]) && $zone[2],
940
-            );
941
-            $exists[3]   = $exists[0] && $zone[0] !== 'Etc';
942
-            $exists[4]   = $exists[1] && $exists[3];
943
-            $exists[5]   = $exists[2] && $exists[3];
944
-            $zone_data[] = array(
945
-                'continent'   => $exists[0] ? $zone[0] : '',
946
-                'city'        => $exists[1] ? $zone[1] : '',
947
-                'subcity'     => $exists[2] ? $zone[2] : '',
948
-                't_continent' => $exists[3]
949
-                    ? translate(str_replace('_', ' ', $zone[0]), 'continents-cities')
950
-                    : '',
951
-                't_city'      => $exists[4]
952
-                    ? translate(str_replace('_', ' ', $zone[1]), 'continents-cities')
953
-                    : '',
954
-                't_subcity'   => $exists[5]
955
-                    ? translate(str_replace('_', ' ', $zone[2]), 'continents-cities')
956
-                    : '',
957
-            );
958
-        }
959
-        usort($zone_data, '_wp_timezone_choice_usort_callback');
960
-        $structure = array();
961
-        if (empty($selected_zone)) {
962
-            $structure[] = '<option selected="selected" value="">' . __('Select a city') . '</option>';
963
-        }
964
-        foreach ($zone_data as $key => $zone) {
965
-            // Build value in an array to join later
966
-            $value = array($zone['continent']);
967
-            if (empty($zone['city'])) {
968
-                // It's at the continent level (generally won't happen)
969
-                $display = $zone['t_continent'];
970
-            } else {
971
-                // It's inside a continent group
972
-                // Continent optgroup
973
-                if (! isset($zone_data[ $key - 1 ]) || $zone_data[ $key - 1 ]['continent'] !== $zone['continent']) {
974
-                    $label       = $zone['t_continent'];
975
-                    $structure[] = '<optgroup label="' . esc_attr($label) . '">';
976
-                }
977
-                // Add the city to the value
978
-                $value[] = $zone['city'];
979
-                $display = $zone['t_city'];
980
-                if (! empty($zone['subcity'])) {
981
-                    // Add the subcity to the value
982
-                    $value[] = $zone['subcity'];
983
-                    $display .= ' - ' . $zone['t_subcity'];
984
-                }
985
-            }
986
-            // Build the value
987
-            $value       = implode('/', $value);
988
-            $selected    = $value === $selected_zone ? ' selected="selected"' : '';
989
-            $structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>'
990
-                           . esc_html($display)
991
-                           . '</option>';
992
-            // Close continent optgroup
993
-            if (! empty($zone['city'])
994
-                && (
995
-                    ! isset($zone_data[ $key + 1 ])
996
-                    || (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent'])
997
-                )
998
-            ) {
999
-                $structure[] = '</optgroup>';
1000
-            }
1001
-        }
1002
-        return implode("\n", $structure);
1003
-    }
894
+	/**
895
+	 * **
896
+	 * Gives a nicely-formatted list of timezone strings.
897
+	 * Copied from the core wp function by the same name so we could customize to remove UTC offsets.
898
+	 *
899
+	 * @since     4.9.40.rc.008
900
+	 * @staticvar bool $mo_loaded
901
+	 * @staticvar string $locale_loaded
902
+	 * @param string $selected_zone Selected timezone.
903
+	 * @param string $locale        Optional. Locale to load the timezones in. Default current site locale.
904
+	 * @return string
905
+	 */
906
+	public static function wp_timezone_choice($selected_zone, $locale = null)
907
+	{
908
+		static $mo_loaded = false, $locale_loaded = null;
909
+		$continents = array(
910
+			'Africa',
911
+			'America',
912
+			'Antarctica',
913
+			'Arctic',
914
+			'Asia',
915
+			'Atlantic',
916
+			'Australia',
917
+			'Europe',
918
+			'Indian',
919
+			'Pacific',
920
+		);
921
+		// Load translations for continents and cities.
922
+		if (! $mo_loaded || $locale !== $locale_loaded) {
923
+			$locale_loaded = $locale ? $locale : get_locale();
924
+			$mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
925
+			unload_textdomain('continents-cities');
926
+			load_textdomain('continents-cities', $mofile);
927
+			$mo_loaded = true;
928
+		}
929
+		$zone_data = array();
930
+		foreach (timezone_identifiers_list() as $zone) {
931
+			$zone = explode('/', $zone);
932
+			if (! in_array($zone[0], $continents, true)) {
933
+				continue;
934
+			}
935
+			// This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
936
+			$exists      = array(
937
+				0 => isset($zone[0]) && $zone[0],
938
+				1 => isset($zone[1]) && $zone[1],
939
+				2 => isset($zone[2]) && $zone[2],
940
+			);
941
+			$exists[3]   = $exists[0] && $zone[0] !== 'Etc';
942
+			$exists[4]   = $exists[1] && $exists[3];
943
+			$exists[5]   = $exists[2] && $exists[3];
944
+			$zone_data[] = array(
945
+				'continent'   => $exists[0] ? $zone[0] : '',
946
+				'city'        => $exists[1] ? $zone[1] : '',
947
+				'subcity'     => $exists[2] ? $zone[2] : '',
948
+				't_continent' => $exists[3]
949
+					? translate(str_replace('_', ' ', $zone[0]), 'continents-cities')
950
+					: '',
951
+				't_city'      => $exists[4]
952
+					? translate(str_replace('_', ' ', $zone[1]), 'continents-cities')
953
+					: '',
954
+				't_subcity'   => $exists[5]
955
+					? translate(str_replace('_', ' ', $zone[2]), 'continents-cities')
956
+					: '',
957
+			);
958
+		}
959
+		usort($zone_data, '_wp_timezone_choice_usort_callback');
960
+		$structure = array();
961
+		if (empty($selected_zone)) {
962
+			$structure[] = '<option selected="selected" value="">' . __('Select a city') . '</option>';
963
+		}
964
+		foreach ($zone_data as $key => $zone) {
965
+			// Build value in an array to join later
966
+			$value = array($zone['continent']);
967
+			if (empty($zone['city'])) {
968
+				// It's at the continent level (generally won't happen)
969
+				$display = $zone['t_continent'];
970
+			} else {
971
+				// It's inside a continent group
972
+				// Continent optgroup
973
+				if (! isset($zone_data[ $key - 1 ]) || $zone_data[ $key - 1 ]['continent'] !== $zone['continent']) {
974
+					$label       = $zone['t_continent'];
975
+					$structure[] = '<optgroup label="' . esc_attr($label) . '">';
976
+				}
977
+				// Add the city to the value
978
+				$value[] = $zone['city'];
979
+				$display = $zone['t_city'];
980
+				if (! empty($zone['subcity'])) {
981
+					// Add the subcity to the value
982
+					$value[] = $zone['subcity'];
983
+					$display .= ' - ' . $zone['t_subcity'];
984
+				}
985
+			}
986
+			// Build the value
987
+			$value       = implode('/', $value);
988
+			$selected    = $value === $selected_zone ? ' selected="selected"' : '';
989
+			$structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>'
990
+						   . esc_html($display)
991
+						   . '</option>';
992
+			// Close continent optgroup
993
+			if (! empty($zone['city'])
994
+				&& (
995
+					! isset($zone_data[ $key + 1 ])
996
+					|| (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent'])
997
+				)
998
+			) {
999
+				$structure[] = '</optgroup>';
1000
+			}
1001
+		}
1002
+		return implode("\n", $structure);
1003
+	}
1004 1004
 
1005 1005
 
1006
-    /**
1007
-     * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0
1008
-     *
1009
-     * @param int|WP_User $user_id
1010
-     * @return string
1011
-     */
1012
-    public static function get_user_locale($user_id = 0)
1013
-    {
1014
-        if (function_exists('get_user_locale')) {
1015
-            return get_user_locale($user_id);
1016
-        }
1017
-        return get_locale();
1018
-    }
1006
+	/**
1007
+	 * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0
1008
+	 *
1009
+	 * @param int|WP_User $user_id
1010
+	 * @return string
1011
+	 */
1012
+	public static function get_user_locale($user_id = 0)
1013
+	{
1014
+		if (function_exists('get_user_locale')) {
1015
+			return get_user_locale($user_id);
1016
+		}
1017
+		return get_locale();
1018
+	}
1019 1019
 
1020 1020
 
1021
-    /**
1022
-     * Return the appropriate helper adapter for DTT related things.
1023
-     *
1024
-     * @return HelperInterface
1025
-     * @throws InvalidArgumentException
1026
-     * @throws InvalidDataTypeException
1027
-     * @throws InvalidInterfaceException
1028
-     */
1029
-    private static function getHelperAdapter() {
1030
-        $dtt_helper_fqcn = PHP_VERSION_ID < 50600
1031
-            ? 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
1032
-            : 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper';
1033
-        return LoaderFactory::getLoader()->getShared($dtt_helper_fqcn);
1034
-    }
1021
+	/**
1022
+	 * Return the appropriate helper adapter for DTT related things.
1023
+	 *
1024
+	 * @return HelperInterface
1025
+	 * @throws InvalidArgumentException
1026
+	 * @throws InvalidDataTypeException
1027
+	 * @throws InvalidInterfaceException
1028
+	 */
1029
+	private static function getHelperAdapter() {
1030
+		$dtt_helper_fqcn = PHP_VERSION_ID < 50600
1031
+			? 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
1032
+			: 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper';
1033
+		return LoaderFactory::getLoader()->getShared($dtt_helper_fqcn);
1034
+	}
1035 1035
 }
1036 1036
\ No newline at end of file
Please login to merge, or discard this patch.
espresso.php 1 patch
Indentation   +191 added lines, -191 removed lines patch added patch discarded remove patch
@@ -38,216 +38,216 @@
 block discarded – undo
38 38
  * @since       4.0
39 39
  */
40 40
 if (function_exists('espresso_version')) {
41
-    if (! function_exists('espresso_duplicate_plugin_error')) {
42
-        /**
43
-         *    espresso_duplicate_plugin_error
44
-         *    displays if more than one version of EE is activated at the same time
45
-         */
46
-        function espresso_duplicate_plugin_error()
47
-        {
48
-            ?>
41
+	if (! function_exists('espresso_duplicate_plugin_error')) {
42
+		/**
43
+		 *    espresso_duplicate_plugin_error
44
+		 *    displays if more than one version of EE is activated at the same time
45
+		 */
46
+		function espresso_duplicate_plugin_error()
47
+		{
48
+			?>
49 49
             <div class="error">
50 50
                 <p>
51 51
                     <?php
52
-                    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
-                    ); ?>
52
+					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
+					); ?>
56 56
                 </p>
57 57
             </div>
58 58
             <?php
59
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
60
-        }
61
-    }
62
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
59
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
60
+		}
61
+	}
62
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
63 63
 
64 64
 } else {
65
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
66
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
67
-        /**
68
-         * espresso_minimum_php_version_error
69
-         * @return void
70
-         */
71
-        function espresso_minimum_php_version_error()
72
-        {
73
-            ?>
65
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
66
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
67
+		/**
68
+		 * espresso_minimum_php_version_error
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
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
97
-        /**
98
-         * espresso_version
99
-         * Returns the plugin version
100
-         *
101
-         * @return string
102
-         */
103
-        function espresso_version()
104
-        {
105
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.58.rc.010');
106
-        }
94
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
+	} else {
96
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
97
+		/**
98
+		 * espresso_version
99
+		 * Returns the plugin version
100
+		 *
101
+		 * @return string
102
+		 */
103
+		function espresso_version()
104
+		{
105
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.58.rc.010');
106
+		}
107 107
 
108
-        /**
109
-         * espresso_plugin_activation
110
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
111
-         */
112
-        function espresso_plugin_activation()
113
-        {
114
-            update_option('ee_espresso_activation', true);
115
-        }
108
+		/**
109
+		 * espresso_plugin_activation
110
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
111
+		 */
112
+		function espresso_plugin_activation()
113
+		{
114
+			update_option('ee_espresso_activation', true);
115
+		}
116 116
 
117
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
118
-        /**
119
-         *    espresso_load_error_handling
120
-         *    this function loads EE's class for handling exceptions and errors
121
-         */
122
-        function espresso_load_error_handling()
123
-        {
124
-            static $error_handling_loaded = false;
125
-            if ($error_handling_loaded) {
126
-                return;
127
-            }
128
-            // load debugging tools
129
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
130
-                require_once   EE_HELPERS . 'EEH_Debug_Tools.helper.php';
131
-                \EEH_Debug_Tools::instance();
132
-            }
133
-            // load error handling
134
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
135
-                require_once EE_CORE . 'EE_Error.core.php';
136
-            } else {
137
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
138
-            }
139
-            $error_handling_loaded = true;
140
-        }
117
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
118
+		/**
119
+		 *    espresso_load_error_handling
120
+		 *    this function loads EE's class for handling exceptions and errors
121
+		 */
122
+		function espresso_load_error_handling()
123
+		{
124
+			static $error_handling_loaded = false;
125
+			if ($error_handling_loaded) {
126
+				return;
127
+			}
128
+			// load debugging tools
129
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
130
+				require_once   EE_HELPERS . 'EEH_Debug_Tools.helper.php';
131
+				\EEH_Debug_Tools::instance();
132
+			}
133
+			// load error handling
134
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
135
+				require_once EE_CORE . 'EE_Error.core.php';
136
+			} else {
137
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
138
+			}
139
+			$error_handling_loaded = true;
140
+		}
141 141
 
142
-        /**
143
-         *    espresso_load_required
144
-         *    given a class name and path, this function will load that file or throw an exception
145
-         *
146
-         * @param    string $classname
147
-         * @param    string $full_path_to_file
148
-         * @throws    EE_Error
149
-         */
150
-        function espresso_load_required($classname, $full_path_to_file)
151
-        {
152
-            if (is_readable($full_path_to_file)) {
153
-                require_once $full_path_to_file;
154
-            } else {
155
-                throw new \EE_Error (
156
-                    sprintf(
157
-                        esc_html__(
158
-                            'The %s class file could not be located or is not readable due to file permissions.',
159
-                            'event_espresso'
160
-                        ),
161
-                        $classname
162
-                    )
163
-                );
164
-            }
165
-        }
142
+		/**
143
+		 *    espresso_load_required
144
+		 *    given a class name and path, this function will load that file or throw an exception
145
+		 *
146
+		 * @param    string $classname
147
+		 * @param    string $full_path_to_file
148
+		 * @throws    EE_Error
149
+		 */
150
+		function espresso_load_required($classname, $full_path_to_file)
151
+		{
152
+			if (is_readable($full_path_to_file)) {
153
+				require_once $full_path_to_file;
154
+			} else {
155
+				throw new \EE_Error (
156
+					sprintf(
157
+						esc_html__(
158
+							'The %s class file could not be located or is not readable due to file permissions.',
159
+							'event_espresso'
160
+						),
161
+						$classname
162
+					)
163
+				);
164
+			}
165
+		}
166 166
 
167
-        /**
168
-         * @since 4.9.27
169
-         * @throws \EE_Error
170
-         * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
171
-         * @throws \EventEspresso\core\exceptions\InvalidEntityException
172
-         * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
173
-         * @throws \EventEspresso\core\exceptions\InvalidClassException
174
-         * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
175
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
176
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
177
-         * @throws \OutOfBoundsException
178
-         */
179
-        function bootstrap_espresso()
180
-        {
181
-            require_once __DIR__ . '/core/espresso_definitions.php';
182
-            try {
183
-                espresso_load_error_handling();
184
-                espresso_load_required(
185
-                    'EEH_Base',
186
-                    EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
187
-                );
188
-                espresso_load_required(
189
-                    'EEH_File',
190
-                    EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
191
-                );
192
-                espresso_load_required(
193
-                    'EEH_File',
194
-                    EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
195
-                );
196
-                espresso_load_required(
197
-                    'EEH_Array',
198
-                    EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
199
-                );
200
-                // instantiate and configure PSR4 autoloader
201
-                espresso_load_required(
202
-                    'Psr4Autoloader',
203
-                    EE_CORE . 'Psr4Autoloader.php'
204
-                );
205
-                espresso_load_required(
206
-                    'EE_Psr4AutoloaderInit',
207
-                    EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
208
-                );
209
-                $AutoloaderInit = new EE_Psr4AutoloaderInit();
210
-                $AutoloaderInit->initializeAutoloader();
211
-                espresso_load_required(
212
-                    'EE_Request',
213
-                    EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
214
-                );
215
-                espresso_load_required(
216
-                    'EE_Response',
217
-                    EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
218
-                );
219
-                espresso_load_required(
220
-                    'EE_Bootstrap',
221
-                    EE_CORE . 'EE_Bootstrap.core.php'
222
-                );
223
-                // bootstrap EE and the request stack
224
-                new EE_Bootstrap(
225
-                    new EE_Request($_GET, $_POST, $_COOKIE),
226
-                    new EE_Response()
227
-                );
228
-            } catch (Exception $e) {
229
-                require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
230
-                new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
231
-            }
232
-        }
233
-        bootstrap_espresso();
234
-    }
167
+		/**
168
+		 * @since 4.9.27
169
+		 * @throws \EE_Error
170
+		 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
171
+		 * @throws \EventEspresso\core\exceptions\InvalidEntityException
172
+		 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
173
+		 * @throws \EventEspresso\core\exceptions\InvalidClassException
174
+		 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
175
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
176
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
177
+		 * @throws \OutOfBoundsException
178
+		 */
179
+		function bootstrap_espresso()
180
+		{
181
+			require_once __DIR__ . '/core/espresso_definitions.php';
182
+			try {
183
+				espresso_load_error_handling();
184
+				espresso_load_required(
185
+					'EEH_Base',
186
+					EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
187
+				);
188
+				espresso_load_required(
189
+					'EEH_File',
190
+					EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
191
+				);
192
+				espresso_load_required(
193
+					'EEH_File',
194
+					EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
195
+				);
196
+				espresso_load_required(
197
+					'EEH_Array',
198
+					EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
199
+				);
200
+				// instantiate and configure PSR4 autoloader
201
+				espresso_load_required(
202
+					'Psr4Autoloader',
203
+					EE_CORE . 'Psr4Autoloader.php'
204
+				);
205
+				espresso_load_required(
206
+					'EE_Psr4AutoloaderInit',
207
+					EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
208
+				);
209
+				$AutoloaderInit = new EE_Psr4AutoloaderInit();
210
+				$AutoloaderInit->initializeAutoloader();
211
+				espresso_load_required(
212
+					'EE_Request',
213
+					EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
214
+				);
215
+				espresso_load_required(
216
+					'EE_Response',
217
+					EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
218
+				);
219
+				espresso_load_required(
220
+					'EE_Bootstrap',
221
+					EE_CORE . 'EE_Bootstrap.core.php'
222
+				);
223
+				// bootstrap EE and the request stack
224
+				new EE_Bootstrap(
225
+					new EE_Request($_GET, $_POST, $_COOKIE),
226
+					new EE_Response()
227
+				);
228
+			} catch (Exception $e) {
229
+				require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
230
+				new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
231
+			}
232
+		}
233
+		bootstrap_espresso();
234
+	}
235 235
 }
236 236
 if (! function_exists('espresso_deactivate_plugin')) {
237
-    /**
238
-     *    deactivate_plugin
239
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
240
-     *
241
-     * @access public
242
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
243
-     * @return    void
244
-     */
245
-    function espresso_deactivate_plugin($plugin_basename = '')
246
-    {
247
-        if (! function_exists('deactivate_plugins')) {
248
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
249
-        }
250
-        unset($_GET['activate'], $_REQUEST['activate']);
251
-        deactivate_plugins($plugin_basename);
252
-    }
237
+	/**
238
+	 *    deactivate_plugin
239
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
240
+	 *
241
+	 * @access public
242
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
243
+	 * @return    void
244
+	 */
245
+	function espresso_deactivate_plugin($plugin_basename = '')
246
+	{
247
+		if (! function_exists('deactivate_plugins')) {
248
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
249
+		}
250
+		unset($_GET['activate'], $_REQUEST['activate']);
251
+		deactivate_plugins($plugin_basename);
252
+	}
253 253
 }
Please login to merge, or discard this patch.