Completed
Branch GDPR/consent (c6029e)
by
unknown
44:48 queued 29:41
created
core/libraries/payment_methods/EE_Gateway.lib.php 1 patch
Indentation   +488 added lines, -488 removed lines patch added patch discarded remove patch
@@ -23,492 +23,492 @@
 block discarded – undo
23 23
  */
24 24
 abstract class EE_Gateway
25 25
 {
26
-    /**
27
-     * a constant used as a possible value for $_currencies_supported to indicate
28
-     * that ALL currencies are supported by this gateway
29
-     */
30
-    const all_currencies_supported = 'all_currencies_supported';
31
-    /**
32
-     * Where values are 3-letter currency codes
33
-     *
34
-     * @var array
35
-     */
36
-    protected $_currencies_supported = array();
37
-    /**
38
-     * Whether or not this gateway can support SENDING a refund request (ie, initiated by
39
-     * admin in EE's wp-admin page)
40
-     *
41
-     * @var boolean
42
-     */
43
-    protected $_supports_sending_refunds = false;
44
-
45
-    /**
46
-     * Whether or not this gateway can support RECEIVING a refund request from the payment
47
-     * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
48
-     *
49
-     * @var boolean
50
-     */
51
-    protected $_supports_receiving_refunds = false;
52
-    /**
53
-     * Model for querying for existing payments
54
-     *
55
-     * @var EEMI_Payment
56
-     */
57
-    protected $_pay_model;
58
-
59
-    /**
60
-     * Model used for adding to the payments log
61
-     *
62
-     * @var EEMI_Payment_Log
63
-     */
64
-    protected $_pay_log;
65
-
66
-    /**
67
-     * Used for formatting some input to gateways
68
-     *
69
-     * @var EEHI_Template
70
-     */
71
-    protected $_template;
72
-
73
-    /**
74
-     * Concrete class that implements EEHI_Money, used by most gateways
75
-     *
76
-     * @var EEHI_Money
77
-     */
78
-    protected $_money;
79
-
80
-    /**
81
-     * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
82
-     *
83
-     * @var EEHI_Line_Item
84
-     */
85
-    protected $_line_item;
86
-
87
-    /**
88
-     * @var GatewayDataFormatterInterface
89
-     */
90
-    protected $_gateway_data_formatter;
91
-
92
-    /**
93
-     * @var FormatterInterface
94
-     */
95
-    protected $_unsupported_character_remover;
96
-
97
-    /**
98
-     * The ID of the payment method using this gateway
99
-     *
100
-     * @var int
101
-     */
102
-    protected $_ID;
103
-
104
-    /**
105
-     * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
106
-     */
107
-    protected $_debug_mode;
108
-    /**
109
-     *
110
-     * @var string $_name name to show for this payment method
111
-     */
112
-    protected $_name;
113
-    /**
114
-     *
115
-     * @var string name to show fir this payment method to admin-type users
116
-     */
117
-    protected $_admin_name;
118
-
119
-    /**
120
-     * @return EE_Gateway
121
-     */
122
-    public function __construct()
123
-    {
124
-    }
125
-
126
-    /**
127
-     * We don't want to serialize models as they often have circular structures
128
-     * (eg a payment model has a reference to each payment model object; and most
129
-     * payments have a transaction, most transactions have a payment method;
130
-     * most payment methods have a payment method type; most payment method types
131
-     * have a gateway. And if a gateway serializes its models, we start at the
132
-     * beginning again)
133
-     *
134
-     * @return array
135
-     */
136
-    public function __sleep()
137
-    {
138
-        $properties = get_object_vars($this);
139
-        unset($properties['_pay_model'], $properties['_pay_log']);
140
-        return array_keys($properties);
141
-    }
142
-
143
-    /**
144
-     * Returns whether or not this gateway should support SENDING refunds
145
-     * see $_supports_sending_refunds
146
-     *
147
-     * @return boolean
148
-     */
149
-    public function supports_sending_refunds()
150
-    {
151
-        return $this->_supports_sending_refunds;
152
-    }
153
-
154
-    /**
155
-     * Returns whether or not this gateway should support RECEIVING refunds
156
-     * see $_supports_receiving_refunds
157
-     *
158
-     * @return boolean
159
-     */
160
-    public function supports_receiving_refunds()
161
-    {
162
-        return $this->_supports_receiving_refunds;
163
-    }
164
-
165
-
166
-    /**
167
-     * Tries to refund the payment specified, taking into account the extra
168
-     * refund info. Note that if the gateway's _supports_sending_refunds is false,
169
-     * this should just throw an exception.
170
-     *
171
-     * @param EE_Payment $payment
172
-     * @param array      $refund_info
173
-     * @return EE_Payment for the refund
174
-     * @throws EE_Error
175
-     */
176
-    public function do_direct_refund(EE_Payment $payment, $refund_info = null)
177
-    {
178
-        return null;
179
-    }
180
-
181
-
182
-    /**
183
-     * Sets the payment method's settings so the gateway knows where to send the request
184
-     * etc
185
-     *
186
-     * @param array $settings_array
187
-     */
188
-    public function set_settings($settings_array)
189
-    {
190
-        foreach ($settings_array as $name => $value) {
191
-            $property_name = "_" . $name;
192
-            $this->{$property_name} = $value;
193
-        }
194
-    }
195
-
196
-    /**
197
-     * See this class description
198
-     *
199
-     * @param EEMI_Payment $payment_model
200
-     */
201
-    public function set_payment_model($payment_model)
202
-    {
203
-        $this->_pay_model = $payment_model;
204
-    }
205
-
206
-    /**
207
-     * See this class description
208
-     *
209
-     * @param EEMI_Payment_Log $payment_log_model
210
-     */
211
-    public function set_payment_log($payment_log_model)
212
-    {
213
-        $this->_pay_log = $payment_log_model;
214
-    }
215
-
216
-    /**
217
-     * See this class description
218
-     *
219
-     * @param EEHI_Template $template_helper
220
-     */
221
-    public function set_template_helper($template_helper)
222
-    {
223
-        $this->_template = $template_helper;
224
-    }
225
-
226
-    /**
227
-     * See this class description
228
-     *
229
-     * @param EEHI_Line_Item $line_item_helper
230
-     */
231
-    public function set_line_item_helper($line_item_helper)
232
-    {
233
-        $this->_line_item = $line_item_helper;
234
-    }
235
-
236
-    /**
237
-     * See this class description
238
-     *
239
-     * @param EEHI_Money $money_helper
240
-     */
241
-    public function set_money_helper($money_helper)
242
-    {
243
-        $this->_money = $money_helper;
244
-    }
245
-
246
-
247
-    /**
248
-     * Sets the gateway data formatter helper
249
-     *
250
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
251
-     * @throws InvalidEntityException if it's not set properly
252
-     */
253
-    public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
254
-    {
255
-        if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
256
-            throw new InvalidEntityException(
257
-                is_object($gateway_data_formatter)
258
-                    ? get_class($gateway_data_formatter)
259
-                    : esc_html__('Not an object', 'event_espresso'),
260
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
261
-            );
262
-        }
263
-        $this->_gateway_data_formatter = $gateway_data_formatter;
264
-    }
265
-
266
-    /**
267
-     * Gets the gateway data formatter
268
-     *
269
-     * @return GatewayDataFormatterInterface
270
-     * @throws InvalidEntityException if it's not set properly
271
-     */
272
-    protected function _get_gateway_formatter()
273
-    {
274
-        if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
275
-            throw new InvalidEntityException(
276
-                is_object($this->_gateway_data_formatter)
277
-                    ? get_class($this->_gateway_data_formatter)
278
-                    : esc_html__('Not an object', 'event_espresso'),
279
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
280
-            );
281
-        }
282
-        return $this->_gateway_data_formatter;
283
-    }
284
-
285
-
286
-    /**
287
-     * Sets the helper which will remove unsupported characters for most gateways
288
-     *
289
-     * @param FormatterInterface $formatter
290
-     * @return FormatterInterface
291
-     * @throws InvalidEntityException
292
-     */
293
-    public function set_unsupported_character_remover(FormatterInterface $formatter)
294
-    {
295
-        if (! $formatter instanceof FormatterInterface) {
296
-            throw new InvalidEntityException(
297
-                is_object($formatter)
298
-                    ? get_class($formatter)
299
-                    : esc_html__('Not an object', 'event_espresso'),
300
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
301
-            );
302
-        }
303
-        $this->_unsupported_character_remover = $formatter;
304
-    }
305
-
306
-    /**
307
-     * Gets the helper which removes characters which gateways might not support, like emojis etc.
308
-     *
309
-     * @return FormatterInterface
310
-     * @throws InvalidEntityException
311
-     */
312
-    protected function _get_unsupported_character_remover()
313
-    {
314
-        if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
315
-            throw new InvalidEntityException(
316
-                is_object($this->_unsupported_character_remover)
317
-                    ? get_class($this->_unsupported_character_remover)
318
-                    : esc_html__('Not an object', 'event_espresso'),
319
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
320
-            );
321
-        }
322
-        return $this->_unsupported_character_remover;
323
-    }
324
-
325
-
326
-    /**
327
-     * @param $message
328
-     * @param $payment
329
-     */
330
-    public function log($message, $payment)
331
-    {
332
-        if ($payment instanceof EEI_Payment) {
333
-            $type = 'Payment';
334
-            $id = $payment->ID();
335
-        } else {
336
-            $type = 'Payment_Method';
337
-            $id = $this->_ID;
338
-        }
339
-        // only log if we're going to store it for longer than the minimum time
340
-        $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
341
-        if ($reg_config->gateway_log_lifespan !== '1 second') {
342
-            $this->_pay_log->gateway_log($message, $id, $type);
343
-        }
344
-    }
345
-
346
-    /**
347
-     * Formats the amount so it can generally be sent to gateways
348
-     *
349
-     * @param float $amount
350
-     * @return string
351
-     * @deprecated since 4.9.31 insetad use
352
-     *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
353
-     */
354
-    public function format_currency($amount)
355
-    {
356
-        return $this->_get_gateway_formatter()->formatCurrency($amount);
357
-    }
358
-
359
-    /**
360
-     * Returns either an array of all the currency codes supported,
361
-     * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
362
-     *
363
-     * @return mixed array or string
364
-     */
365
-    public function currencies_supported()
366
-    {
367
-        return $this->_currencies_supported;
368
-    }
369
-
370
-    /**
371
-     * Returns what a simple summing of items and taxes for this transaction. This
372
-     * can be used to determine if some more complex line items, like promotions,
373
-     * surcharges, or cancellations occurred (in which case we might want to forget
374
-     * about creating an itemized list of purchases and instead only send the total due)
375
-     *
376
-     * @param EE_Transaction $transaction
377
-     * @return float
378
-     */
379
-    protected function _sum_items_and_taxes(EE_Transaction $transaction)
380
-    {
381
-        $total_line_item = $transaction->total_line_item();
382
-        $total = 0;
383
-        foreach ($total_line_item->get_items() as $item_line_item) {
384
-            $total += max($item_line_item->total(), 0);
385
-        }
386
-        foreach ($total_line_item->tax_descendants() as $tax_line_item) {
387
-            $total += max($tax_line_item->total(), 0);
388
-        }
389
-        return $total;
390
-    }
391
-
392
-    /**
393
-     * Determines whether or not we can easily itemize the transaction using only
394
-     * items and taxes (ie, no promotions or surcharges or cancellations needed)
395
-     *
396
-     * @param EEI_Payment $payment
397
-     * @return boolean
398
-     */
399
-    protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
400
-    {
401
-        return $this->_money->compare_floats(
402
-            $this->_sum_items_and_taxes($payment->transaction()),
403
-            $payment->transaction()->total()
404
-        )
405
-               && $this->_money->compare_floats(
406
-                   $payment->amount(),
407
-                   $payment->transaction()->total()
408
-               );
409
-    }
410
-
411
-    /**
412
-     * Handles updating the transaction and any other related data based on the payment.
413
-     * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
414
-     * but doing so on those functions might be too early. It's possible that the changes
415
-     * you make to teh transaction or registration or line items may just get overwritten
416
-     * at that point. Instead, you should store any info you need on the payment during those
417
-     * functions, and use that information at this step, which client code will decide
418
-     * for you when it should be called.
419
-     *
420
-     * @param EE_Payment $payment
421
-     * @return void
422
-     */
423
-    public function update_txn_based_on_payment($payment)
424
-    {
425
-        // maybe update the transaction or line items or registrations
426
-        // but most gateways don't need to do this, because they only update the payment
427
-    }
428
-
429
-    /**
430
-     * Gets the first event for this payment (it's possible that it could be for multiple)
431
-     *
432
-     * @param EEI_Payment $payment
433
-     * @return EEI_Event|null
434
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
435
-     */
436
-    protected function _get_first_event_for_payment(EEI_Payment $payment)
437
-    {
438
-        return $payment->get_first_event();
439
-    }
440
-
441
-    /**
442
-     * Gets the name of the first event for which is being paid
443
-     *
444
-     * @param EEI_Payment $payment
445
-     * @return string
446
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
447
-     */
448
-    protected function _get_first_event_name_for_payment(EEI_Payment $payment)
449
-    {
450
-        return $payment->get_first_event_name();
451
-    }
452
-
453
-    /**
454
-     * Gets the text to use for a gateway's line item name when this is a partial payment
455
-     *
456
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
457
-     * @param EE_Payment $payment
458
-     * @return string
459
-     */
460
-    protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
461
-    {
462
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
463
-    }
464
-
465
-    /**
466
-     * Gets the text to use for a gateway's line item description when this is a partial payment
467
-     *
468
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
469
-     * @param EEI_Payment $payment
470
-     * @return string
471
-     */
472
-    protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
473
-    {
474
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
475
-    }
476
-
477
-    /**
478
-     * Gets the name to use for a line item when sending line items to the gateway
479
-     *
480
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
481
-     * @param EEI_Line_Item $line_item
482
-     * @param EEI_Payment   $payment
483
-     * @return string
484
-     */
485
-    protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
486
-    {
487
-        return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
488
-    }
489
-
490
-    /**
491
-     * Gets the description to use for a line item when sending line items to the gateway
492
-     *
493
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
494
-     * @param EEI_Line_Item $line_item
495
-     * @param EEI_Payment   $payment
496
-     * @return string
497
-     */
498
-    protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
499
-    {
500
-        return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
501
-    }
502
-
503
-    /**
504
-     * Gets the order description that should generlly be sent to gateways
505
-     *
506
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
507
-     * @param EEI_Payment $payment
508
-     * @return type
509
-     */
510
-    protected function _format_order_description(EEI_Payment $payment)
511
-    {
512
-        return $this->_get_gateway_formatter()->formatOrderDescription($payment);
513
-    }
26
+	/**
27
+	 * a constant used as a possible value for $_currencies_supported to indicate
28
+	 * that ALL currencies are supported by this gateway
29
+	 */
30
+	const all_currencies_supported = 'all_currencies_supported';
31
+	/**
32
+	 * Where values are 3-letter currency codes
33
+	 *
34
+	 * @var array
35
+	 */
36
+	protected $_currencies_supported = array();
37
+	/**
38
+	 * Whether or not this gateway can support SENDING a refund request (ie, initiated by
39
+	 * admin in EE's wp-admin page)
40
+	 *
41
+	 * @var boolean
42
+	 */
43
+	protected $_supports_sending_refunds = false;
44
+
45
+	/**
46
+	 * Whether or not this gateway can support RECEIVING a refund request from the payment
47
+	 * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
48
+	 *
49
+	 * @var boolean
50
+	 */
51
+	protected $_supports_receiving_refunds = false;
52
+	/**
53
+	 * Model for querying for existing payments
54
+	 *
55
+	 * @var EEMI_Payment
56
+	 */
57
+	protected $_pay_model;
58
+
59
+	/**
60
+	 * Model used for adding to the payments log
61
+	 *
62
+	 * @var EEMI_Payment_Log
63
+	 */
64
+	protected $_pay_log;
65
+
66
+	/**
67
+	 * Used for formatting some input to gateways
68
+	 *
69
+	 * @var EEHI_Template
70
+	 */
71
+	protected $_template;
72
+
73
+	/**
74
+	 * Concrete class that implements EEHI_Money, used by most gateways
75
+	 *
76
+	 * @var EEHI_Money
77
+	 */
78
+	protected $_money;
79
+
80
+	/**
81
+	 * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
82
+	 *
83
+	 * @var EEHI_Line_Item
84
+	 */
85
+	protected $_line_item;
86
+
87
+	/**
88
+	 * @var GatewayDataFormatterInterface
89
+	 */
90
+	protected $_gateway_data_formatter;
91
+
92
+	/**
93
+	 * @var FormatterInterface
94
+	 */
95
+	protected $_unsupported_character_remover;
96
+
97
+	/**
98
+	 * The ID of the payment method using this gateway
99
+	 *
100
+	 * @var int
101
+	 */
102
+	protected $_ID;
103
+
104
+	/**
105
+	 * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
106
+	 */
107
+	protected $_debug_mode;
108
+	/**
109
+	 *
110
+	 * @var string $_name name to show for this payment method
111
+	 */
112
+	protected $_name;
113
+	/**
114
+	 *
115
+	 * @var string name to show fir this payment method to admin-type users
116
+	 */
117
+	protected $_admin_name;
118
+
119
+	/**
120
+	 * @return EE_Gateway
121
+	 */
122
+	public function __construct()
123
+	{
124
+	}
125
+
126
+	/**
127
+	 * We don't want to serialize models as they often have circular structures
128
+	 * (eg a payment model has a reference to each payment model object; and most
129
+	 * payments have a transaction, most transactions have a payment method;
130
+	 * most payment methods have a payment method type; most payment method types
131
+	 * have a gateway. And if a gateway serializes its models, we start at the
132
+	 * beginning again)
133
+	 *
134
+	 * @return array
135
+	 */
136
+	public function __sleep()
137
+	{
138
+		$properties = get_object_vars($this);
139
+		unset($properties['_pay_model'], $properties['_pay_log']);
140
+		return array_keys($properties);
141
+	}
142
+
143
+	/**
144
+	 * Returns whether or not this gateway should support SENDING refunds
145
+	 * see $_supports_sending_refunds
146
+	 *
147
+	 * @return boolean
148
+	 */
149
+	public function supports_sending_refunds()
150
+	{
151
+		return $this->_supports_sending_refunds;
152
+	}
153
+
154
+	/**
155
+	 * Returns whether or not this gateway should support RECEIVING refunds
156
+	 * see $_supports_receiving_refunds
157
+	 *
158
+	 * @return boolean
159
+	 */
160
+	public function supports_receiving_refunds()
161
+	{
162
+		return $this->_supports_receiving_refunds;
163
+	}
164
+
165
+
166
+	/**
167
+	 * Tries to refund the payment specified, taking into account the extra
168
+	 * refund info. Note that if the gateway's _supports_sending_refunds is false,
169
+	 * this should just throw an exception.
170
+	 *
171
+	 * @param EE_Payment $payment
172
+	 * @param array      $refund_info
173
+	 * @return EE_Payment for the refund
174
+	 * @throws EE_Error
175
+	 */
176
+	public function do_direct_refund(EE_Payment $payment, $refund_info = null)
177
+	{
178
+		return null;
179
+	}
180
+
181
+
182
+	/**
183
+	 * Sets the payment method's settings so the gateway knows where to send the request
184
+	 * etc
185
+	 *
186
+	 * @param array $settings_array
187
+	 */
188
+	public function set_settings($settings_array)
189
+	{
190
+		foreach ($settings_array as $name => $value) {
191
+			$property_name = "_" . $name;
192
+			$this->{$property_name} = $value;
193
+		}
194
+	}
195
+
196
+	/**
197
+	 * See this class description
198
+	 *
199
+	 * @param EEMI_Payment $payment_model
200
+	 */
201
+	public function set_payment_model($payment_model)
202
+	{
203
+		$this->_pay_model = $payment_model;
204
+	}
205
+
206
+	/**
207
+	 * See this class description
208
+	 *
209
+	 * @param EEMI_Payment_Log $payment_log_model
210
+	 */
211
+	public function set_payment_log($payment_log_model)
212
+	{
213
+		$this->_pay_log = $payment_log_model;
214
+	}
215
+
216
+	/**
217
+	 * See this class description
218
+	 *
219
+	 * @param EEHI_Template $template_helper
220
+	 */
221
+	public function set_template_helper($template_helper)
222
+	{
223
+		$this->_template = $template_helper;
224
+	}
225
+
226
+	/**
227
+	 * See this class description
228
+	 *
229
+	 * @param EEHI_Line_Item $line_item_helper
230
+	 */
231
+	public function set_line_item_helper($line_item_helper)
232
+	{
233
+		$this->_line_item = $line_item_helper;
234
+	}
235
+
236
+	/**
237
+	 * See this class description
238
+	 *
239
+	 * @param EEHI_Money $money_helper
240
+	 */
241
+	public function set_money_helper($money_helper)
242
+	{
243
+		$this->_money = $money_helper;
244
+	}
245
+
246
+
247
+	/**
248
+	 * Sets the gateway data formatter helper
249
+	 *
250
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
251
+	 * @throws InvalidEntityException if it's not set properly
252
+	 */
253
+	public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
254
+	{
255
+		if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
256
+			throw new InvalidEntityException(
257
+				is_object($gateway_data_formatter)
258
+					? get_class($gateway_data_formatter)
259
+					: esc_html__('Not an object', 'event_espresso'),
260
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
261
+			);
262
+		}
263
+		$this->_gateway_data_formatter = $gateway_data_formatter;
264
+	}
265
+
266
+	/**
267
+	 * Gets the gateway data formatter
268
+	 *
269
+	 * @return GatewayDataFormatterInterface
270
+	 * @throws InvalidEntityException if it's not set properly
271
+	 */
272
+	protected function _get_gateway_formatter()
273
+	{
274
+		if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
275
+			throw new InvalidEntityException(
276
+				is_object($this->_gateway_data_formatter)
277
+					? get_class($this->_gateway_data_formatter)
278
+					: esc_html__('Not an object', 'event_espresso'),
279
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
280
+			);
281
+		}
282
+		return $this->_gateway_data_formatter;
283
+	}
284
+
285
+
286
+	/**
287
+	 * Sets the helper which will remove unsupported characters for most gateways
288
+	 *
289
+	 * @param FormatterInterface $formatter
290
+	 * @return FormatterInterface
291
+	 * @throws InvalidEntityException
292
+	 */
293
+	public function set_unsupported_character_remover(FormatterInterface $formatter)
294
+	{
295
+		if (! $formatter instanceof FormatterInterface) {
296
+			throw new InvalidEntityException(
297
+				is_object($formatter)
298
+					? get_class($formatter)
299
+					: esc_html__('Not an object', 'event_espresso'),
300
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
301
+			);
302
+		}
303
+		$this->_unsupported_character_remover = $formatter;
304
+	}
305
+
306
+	/**
307
+	 * Gets the helper which removes characters which gateways might not support, like emojis etc.
308
+	 *
309
+	 * @return FormatterInterface
310
+	 * @throws InvalidEntityException
311
+	 */
312
+	protected function _get_unsupported_character_remover()
313
+	{
314
+		if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
315
+			throw new InvalidEntityException(
316
+				is_object($this->_unsupported_character_remover)
317
+					? get_class($this->_unsupported_character_remover)
318
+					: esc_html__('Not an object', 'event_espresso'),
319
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
320
+			);
321
+		}
322
+		return $this->_unsupported_character_remover;
323
+	}
324
+
325
+
326
+	/**
327
+	 * @param $message
328
+	 * @param $payment
329
+	 */
330
+	public function log($message, $payment)
331
+	{
332
+		if ($payment instanceof EEI_Payment) {
333
+			$type = 'Payment';
334
+			$id = $payment->ID();
335
+		} else {
336
+			$type = 'Payment_Method';
337
+			$id = $this->_ID;
338
+		}
339
+		// only log if we're going to store it for longer than the minimum time
340
+		$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
341
+		if ($reg_config->gateway_log_lifespan !== '1 second') {
342
+			$this->_pay_log->gateway_log($message, $id, $type);
343
+		}
344
+	}
345
+
346
+	/**
347
+	 * Formats the amount so it can generally be sent to gateways
348
+	 *
349
+	 * @param float $amount
350
+	 * @return string
351
+	 * @deprecated since 4.9.31 insetad use
352
+	 *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
353
+	 */
354
+	public function format_currency($amount)
355
+	{
356
+		return $this->_get_gateway_formatter()->formatCurrency($amount);
357
+	}
358
+
359
+	/**
360
+	 * Returns either an array of all the currency codes supported,
361
+	 * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
362
+	 *
363
+	 * @return mixed array or string
364
+	 */
365
+	public function currencies_supported()
366
+	{
367
+		return $this->_currencies_supported;
368
+	}
369
+
370
+	/**
371
+	 * Returns what a simple summing of items and taxes for this transaction. This
372
+	 * can be used to determine if some more complex line items, like promotions,
373
+	 * surcharges, or cancellations occurred (in which case we might want to forget
374
+	 * about creating an itemized list of purchases and instead only send the total due)
375
+	 *
376
+	 * @param EE_Transaction $transaction
377
+	 * @return float
378
+	 */
379
+	protected function _sum_items_and_taxes(EE_Transaction $transaction)
380
+	{
381
+		$total_line_item = $transaction->total_line_item();
382
+		$total = 0;
383
+		foreach ($total_line_item->get_items() as $item_line_item) {
384
+			$total += max($item_line_item->total(), 0);
385
+		}
386
+		foreach ($total_line_item->tax_descendants() as $tax_line_item) {
387
+			$total += max($tax_line_item->total(), 0);
388
+		}
389
+		return $total;
390
+	}
391
+
392
+	/**
393
+	 * Determines whether or not we can easily itemize the transaction using only
394
+	 * items and taxes (ie, no promotions or surcharges or cancellations needed)
395
+	 *
396
+	 * @param EEI_Payment $payment
397
+	 * @return boolean
398
+	 */
399
+	protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
400
+	{
401
+		return $this->_money->compare_floats(
402
+			$this->_sum_items_and_taxes($payment->transaction()),
403
+			$payment->transaction()->total()
404
+		)
405
+			   && $this->_money->compare_floats(
406
+				   $payment->amount(),
407
+				   $payment->transaction()->total()
408
+			   );
409
+	}
410
+
411
+	/**
412
+	 * Handles updating the transaction and any other related data based on the payment.
413
+	 * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
414
+	 * but doing so on those functions might be too early. It's possible that the changes
415
+	 * you make to teh transaction or registration or line items may just get overwritten
416
+	 * at that point. Instead, you should store any info you need on the payment during those
417
+	 * functions, and use that information at this step, which client code will decide
418
+	 * for you when it should be called.
419
+	 *
420
+	 * @param EE_Payment $payment
421
+	 * @return void
422
+	 */
423
+	public function update_txn_based_on_payment($payment)
424
+	{
425
+		// maybe update the transaction or line items or registrations
426
+		// but most gateways don't need to do this, because they only update the payment
427
+	}
428
+
429
+	/**
430
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
431
+	 *
432
+	 * @param EEI_Payment $payment
433
+	 * @return EEI_Event|null
434
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
435
+	 */
436
+	protected function _get_first_event_for_payment(EEI_Payment $payment)
437
+	{
438
+		return $payment->get_first_event();
439
+	}
440
+
441
+	/**
442
+	 * Gets the name of the first event for which is being paid
443
+	 *
444
+	 * @param EEI_Payment $payment
445
+	 * @return string
446
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
447
+	 */
448
+	protected function _get_first_event_name_for_payment(EEI_Payment $payment)
449
+	{
450
+		return $payment->get_first_event_name();
451
+	}
452
+
453
+	/**
454
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
455
+	 *
456
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
457
+	 * @param EE_Payment $payment
458
+	 * @return string
459
+	 */
460
+	protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
461
+	{
462
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
463
+	}
464
+
465
+	/**
466
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
467
+	 *
468
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
469
+	 * @param EEI_Payment $payment
470
+	 * @return string
471
+	 */
472
+	protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
473
+	{
474
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
475
+	}
476
+
477
+	/**
478
+	 * Gets the name to use for a line item when sending line items to the gateway
479
+	 *
480
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
481
+	 * @param EEI_Line_Item $line_item
482
+	 * @param EEI_Payment   $payment
483
+	 * @return string
484
+	 */
485
+	protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
486
+	{
487
+		return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
488
+	}
489
+
490
+	/**
491
+	 * Gets the description to use for a line item when sending line items to the gateway
492
+	 *
493
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
494
+	 * @param EEI_Line_Item $line_item
495
+	 * @param EEI_Payment   $payment
496
+	 * @return string
497
+	 */
498
+	protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
499
+	{
500
+		return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
501
+	}
502
+
503
+	/**
504
+	 * Gets the order description that should generlly be sent to gateways
505
+	 *
506
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
507
+	 * @param EEI_Payment $payment
508
+	 * @return type
509
+	 */
510
+	protected function _format_order_description(EEI_Payment $payment)
511
+	{
512
+		return $this->_get_gateway_formatter()->formatOrderDescription($payment);
513
+	}
514 514
 }
Please login to merge, or discard this patch.
admin_pages/payments/Payments_Admin_Page.core.php 2 patches
Indentation   +1121 added lines, -1121 removed lines patch added patch discarded remove patch
@@ -14,1125 +14,1125 @@
 block discarded – undo
14 14
 class Payments_Admin_Page extends EE_Admin_Page
15 15
 {
16 16
 
17
-    /**
18
-     * Variables used for when we're re-sorting the logs results, in case
19
-     * we needed to do two queries and we need to resort
20
-     *
21
-     * @var string
22
-     */
23
-    private $_sort_logs_again_direction;
24
-
25
-
26
-    /**
27
-     * @Constructor
28
-     * @access public
29
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
30
-     * @return \Payments_Admin_Page
31
-     */
32
-    public function __construct($routing = true)
33
-    {
34
-        parent::__construct($routing);
35
-    }
36
-
37
-
38
-    protected function _init_page_props()
39
-    {
40
-        $this->page_slug = EE_PAYMENTS_PG_SLUG;
41
-        $this->page_label = __('Payment Methods', 'event_espresso');
42
-        $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
43
-        $this->_admin_base_path = EE_PAYMENTS_ADMIN;
44
-    }
45
-
46
-
47
-    protected function _ajax_hooks()
48
-    {
49
-        // todo: all hooks for ajax goes here.
50
-    }
51
-
52
-
53
-    protected function _define_page_props()
54
-    {
55
-        $this->_admin_page_title = $this->page_label;
56
-        $this->_labels = array(
57
-            'publishbox' => __('Update Settings', 'event_espresso'),
58
-        );
59
-    }
60
-
61
-
62
-    protected function _set_page_routes()
63
-    {
64
-        /**
65
-         * note that with payment method capabilities, although we've implemented
66
-         * capability mapping which will be used for accessing payment methods owned by
67
-         * other users.  This is not fully implemented yet in the payment method ui.
68
-         * Currently only the "plural" caps are in active use.
69
-         * When cap mapping is implemented, some routes will need to use the singular form of
70
-         * capability method and also include the $id of the payment method for the route.
71
-         **/
72
-        $this->_page_routes = array(
73
-            'default'                   => array(
74
-                'func'       => '_payment_methods_list',
75
-                'capability' => 'ee_edit_payment_methods',
76
-            ),
77
-            'payment_settings'          => array(
78
-                'func'       => '_payment_settings',
79
-                'capability' => 'ee_manage_gateways',
80
-            ),
81
-            'activate_payment_method'   => array(
82
-                'func'       => '_activate_payment_method',
83
-                'noheader'   => true,
84
-                'capability' => 'ee_edit_payment_methods',
85
-            ),
86
-            'deactivate_payment_method' => array(
87
-                'func'       => '_deactivate_payment_method',
88
-                'noheader'   => true,
89
-                'capability' => 'ee_delete_payment_methods',
90
-            ),
91
-            'update_payment_method'     => array(
92
-                'func'               => '_update_payment_method',
93
-                'noheader'           => true,
94
-                'headers_sent_route' => 'default',
95
-                'capability'         => 'ee_edit_payment_methods',
96
-            ),
97
-            'update_payment_settings'   => array(
98
-                'func'       => '_update_payment_settings',
99
-                'noheader'   => true,
100
-                'capability' => 'ee_manage_gateways',
101
-            ),
102
-            'payment_log'               => array(
103
-                'func'       => '_payment_log_overview_list_table',
104
-                'capability' => 'ee_read_payment_methods',
105
-            ),
106
-            'payment_log_details'       => array(
107
-                'func'       => '_payment_log_details',
108
-                'capability' => 'ee_read_payment_methods',
109
-            ),
110
-        );
111
-    }
112
-
113
-
114
-    protected function _set_page_config()
115
-    {
116
-        $payment_method_list_config = array(
117
-            'nav'           => array(
118
-                'label' => __('Payment Methods', 'event_espresso'),
119
-                'order' => 10,
120
-            ),
121
-            'metaboxes'     => $this->_default_espresso_metaboxes,
122
-            'help_tabs'     => array_merge(
123
-                array(
124
-                    'payment_methods_overview_help_tab' => array(
125
-                        'title'    => __('Payment Methods Overview', 'event_espresso'),
126
-                        'filename' => 'payment_methods_overview',
127
-                    ),
128
-                ),
129
-                $this->_add_payment_method_help_tabs()
130
-            ),
131
-            'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
132
-            'require_nonce' => false,
133
-        );
134
-        $this->_page_config = array(
135
-            'default'          => $payment_method_list_config,
136
-            'payment_settings' => array(
137
-                'nav'           => array(
138
-                    'label' => __('Settings', 'event_espresso'),
139
-                    'order' => 20,
140
-                ),
141
-                'help_tabs'     => array(
142
-                    'payment_methods_settings_help_tab' => array(
143
-                        'title'    => __('Payment Method Settings', 'event_espresso'),
144
-                        'filename' => 'payment_methods_settings',
145
-                    ),
146
-                ),
147
-                // 'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
148
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
149
-                'require_nonce' => false,
150
-            ),
151
-            'payment_log'      => array(
152
-                'nav'           => array(
153
-                    'label' => __("Logs", 'event_espresso'),
154
-                    'order' => 30,
155
-                ),
156
-                'list_table'    => 'Payment_Log_Admin_List_Table',
157
-                'metaboxes'     => $this->_default_espresso_metaboxes,
158
-                'require_nonce' => false,
159
-            ),
160
-        );
161
-    }
162
-
163
-
164
-    /**
165
-     * @return array
166
-     */
167
-    protected function _add_payment_method_help_tabs()
168
-    {
169
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
170
-        $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
171
-        $all_pmt_help_tabs_config = array();
172
-        foreach ($payment_method_types as $payment_method_type) {
173
-            if (! EE_Registry::instance()->CAP->current_user_can(
174
-                $payment_method_type->cap_name(),
175
-                'specific_payment_method_type_access'
176
-            )
177
-            ) {
178
-                continue;
179
-            }
180
-            foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
181
-                $template_args = isset($config['template_args']) ? $config['template_args'] : array();
182
-                $template_args['admin_page_obj'] = $this;
183
-                $all_pmt_help_tabs_config[ $help_tab_name ] = array(
184
-                    'title'   => $config['title'],
185
-                    'content' => EEH_Template::display_template(
186
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
187
-                        $template_args,
188
-                        true
189
-                    ),
190
-                );
191
-            }
192
-        }
193
-        return $all_pmt_help_tabs_config;
194
-    }
195
-
196
-
197
-    // none of the below group are currently used for Gateway Settings
198
-    protected function _add_screen_options()
199
-    {
200
-    }
201
-
202
-
203
-    protected function _add_feature_pointers()
204
-    {
205
-    }
206
-
207
-
208
-    public function admin_init()
209
-    {
210
-    }
211
-
212
-
213
-    public function admin_notices()
214
-    {
215
-    }
216
-
217
-
218
-    public function admin_footer_scripts()
219
-    {
220
-    }
221
-
222
-
223
-    public function load_scripts_styles()
224
-    {
225
-        wp_enqueue_script('ee_admin_js');
226
-        wp_enqueue_script('ee-text-links');
227
-        wp_enqueue_script(
228
-            'espresso_payments',
229
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
230
-            array('espresso-ui-theme', 'ee-datepicker'),
231
-            EVENT_ESPRESSO_VERSION,
232
-            true
233
-        );
234
-    }
235
-
236
-
237
-    public function load_scripts_styles_default()
238
-    {
239
-        // styles
240
-        wp_register_style(
241
-            'espresso_payments',
242
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
243
-            array(),
244
-            EVENT_ESPRESSO_VERSION
245
-        );
246
-        wp_enqueue_style('espresso_payments');
247
-        wp_enqueue_style('ee-text-links');
248
-        // scripts
249
-    }
250
-
251
-
252
-    protected function _payment_methods_list()
253
-    {
254
-        /**
255
-         * first let's ensure payment methods have been setup. We do this here because when people activate a
256
-         * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
257
-         * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
258
-         * recheck here.
259
-         */
260
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
261
-        EEM_Payment_Method::instance()->verify_button_urls();
262
-        // setup tabs, one for each payment method type
263
-        $tabs = array();
264
-        $payment_methods = array();
265
-        foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
266
-            // we don't want to show admin-only PMTs for now
267
-            if ($pmt_obj instanceof EE_PMT_Admin_Only) {
268
-                continue;
269
-            }
270
-            // check access
271
-            if (! EE_Registry::instance()->CAP->current_user_can(
272
-                $pmt_obj->cap_name(),
273
-                'specific_payment_method_type_access'
274
-            )
275
-            ) {
276
-                continue;
277
-            }
278
-            // check for any active pms of that type
279
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
280
-            if (! $payment_method instanceof EE_Payment_Method) {
281
-                $payment_method = EE_Payment_Method::new_instance(
282
-                    array(
283
-                        'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
284
-                        'PMD_type'       => $pmt_obj->system_name(),
285
-                        'PMD_name'       => $pmt_obj->pretty_name(),
286
-                        'PMD_admin_name' => $pmt_obj->pretty_name(),
287
-                    )
288
-                );
289
-            }
290
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
291
-        }
292
-        $payment_methods = apply_filters(
293
-            'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
294
-            $payment_methods
295
-        );
296
-        foreach ($payment_methods as $payment_method) {
297
-            if ($payment_method instanceof EE_Payment_Method) {
298
-                add_meta_box(
299
-                    // html id
300
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
301
-                    // title
302
-                    sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
303
-                    // callback
304
-                    array($this, 'payment_method_settings_meta_box'),
305
-                    // post type
306
-                    null,
307
-                    // context
308
-                    'normal',
309
-                    // priority
310
-                    'default',
311
-                    // callback args
312
-                    array('payment_method' => $payment_method)
313
-                );
314
-                // setup for tabbed content
315
-                $tabs[ $payment_method->slug() ] = array(
316
-                    'label' => $payment_method->admin_name(),
317
-                    'class' => $payment_method->active() ? 'gateway-active' : '',
318
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
319
-                    'title' => __('Modify this Payment Method', 'event_espresso'),
320
-                    'slug'  => $payment_method->slug(),
321
-                );
322
-            }
323
-        }
324
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
325
-            $tabs,
326
-            'payment_method_links',
327
-            '|',
328
-            $this->_get_active_payment_method_slug()
329
-        );
330
-        $this->display_admin_page_with_sidebar();
331
-    }
332
-
333
-
334
-    /**
335
-     *   _get_active_payment_method_slug
336
-     *
337
-     * @return string
338
-     */
339
-    protected function _get_active_payment_method_slug()
340
-    {
341
-        $payment_method_slug = false;
342
-        // decide which payment method tab to open first, as dictated by the request's 'payment_method'
343
-        if (isset($this->_req_data['payment_method'])) {
344
-            // if they provided the current payment method, use it
345
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
346
-        }
347
-        $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
348
-        // if that didn't work or wasn't provided, find another way to select the current pm
349
-        if (! $this->_verify_payment_method($payment_method)) {
350
-            // like, looking for an active one
351
-            $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
352
-            // test that one as well
353
-            if ($this->_verify_payment_method($payment_method)) {
354
-                $payment_method_slug = $payment_method->slug();
355
-            } else {
356
-                $payment_method_slug = 'paypal_standard';
357
-            }
358
-        }
359
-        return $payment_method_slug;
360
-    }
361
-
362
-
363
-    /**
364
-     *    payment_method_settings_meta_box
365
-     *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
366
-     *    capabilities to access it
367
-     *
368
-     * @param \EE_Payment_Method $payment_method
369
-     * @return boolean
370
-     */
371
-    protected function _verify_payment_method($payment_method)
372
-    {
373
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
374
-            && EE_Registry::instance()->CAP->current_user_can(
375
-                $payment_method->type_obj()->cap_name(),
376
-                'specific_payment_method_type_access'
377
-            )
378
-        ) {
379
-            return true;
380
-        }
381
-        return false;
382
-    }
383
-
384
-
385
-    /**
386
-     *    payment_method_settings_meta_box
387
-     *
388
-     * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
389
-     * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
390
-     *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
391
-     * @return string
392
-     * @throws EE_Error
393
-     */
394
-    public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
395
-    {
396
-        $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
397
-            ? $metabox['args']['payment_method'] : null;
398
-        if (! $payment_method instanceof EE_Payment_Method) {
399
-            throw new EE_Error(
400
-                sprintf(
401
-                    __(
402
-                        'Payment method metabox setup incorrectly. No Payment method object was supplied',
403
-                        'event_espresso'
404
-                    )
405
-                )
406
-            );
407
-        }
408
-        $payment_method_scopes = $payment_method->active();
409
-        // if the payment method really exists show its form, otherwise the activation template
410
-        if ($payment_method->ID() && ! empty($payment_method_scopes)) {
411
-            $form = $this->_generate_payment_method_settings_form($payment_method);
412
-            if ($form->form_data_present_in($this->_req_data)) {
413
-                $form->receive_form_submission($this->_req_data);
414
-            }
415
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
416
-        } else {
417
-            echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
418
-        }
419
-    }
420
-
421
-
422
-    /**
423
-     * Gets the form for all the settings related to this payment method type
424
-     *
425
-     * @access protected
426
-     * @param \EE_Payment_Method $payment_method
427
-     * @return \EE_Form_Section_Proper
428
-     */
429
-    protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
430
-    {
431
-        if (! $payment_method instanceof EE_Payment_Method) {
432
-            return new EE_Form_Section_Proper();
433
-        }
434
-        return new EE_Form_Section_Proper(
435
-            array(
436
-                'name'            => $payment_method->slug() . '_settings_form',
437
-                'html_id'         => $payment_method->slug() . '_settings_form',
438
-                'action'          => EE_Admin_Page::add_query_args_and_nonce(
439
-                    array(
440
-                        'action'         => 'update_payment_method',
441
-                        'payment_method' => $payment_method->slug(),
442
-                    ),
443
-                    EE_PAYMENTS_ADMIN_URL
444
-                ),
445
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
446
-                'subsections'     => apply_filters(
447
-                    'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
448
-                    array(
449
-                        'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
450
-                        'currency_support'        => $this->_currency_support($payment_method),
451
-                        'payment_method_settings' => $this->_payment_method_settings($payment_method),
452
-                        'update'                  => $this->_update_payment_method_button($payment_method),
453
-                        'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
454
-                        'fine_print'              => $this->_fine_print(),
455
-                    ),
456
-                    $payment_method
457
-                ),
458
-            )
459
-        );
460
-    }
461
-
462
-
463
-    /**
464
-     * _pci_dss_compliance
465
-     *
466
-     * @access protected
467
-     * @param \EE_Payment_Method $payment_method
468
-     * @return \EE_Form_Section_Proper
469
-     */
470
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
471
-    {
472
-        if ($payment_method->type_obj()->requires_https()) {
473
-            return new EE_Form_Section_HTML(
474
-                EEH_HTML::tr(
475
-                    EEH_HTML::th(
476
-                        EEH_HTML::label(
477
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
478
-                        )
479
-                    ) .
480
-                    EEH_HTML::td(
481
-                        EEH_HTML::strong(
482
-                            __(
483
-                                'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
484
-                                'event_espresso'
485
-                            )
486
-                        )
487
-                        .
488
-                        EEH_HTML::br()
489
-                        .
490
-                        __('Learn more about ', 'event_espresso')
491
-                        . EEH_HTML::link(
492
-                            'https://www.pcisecuritystandards.org/merchants/index.php',
493
-                            __('PCI DSS compliance', 'event_espresso')
494
-                        )
495
-                    )
496
-                )
497
-            );
498
-        } else {
499
-            return new EE_Form_Section_HTML('');
500
-        }
501
-    }
502
-
503
-
504
-    /**
505
-     * _currency_support
506
-     *
507
-     * @access protected
508
-     * @param \EE_Payment_Method $payment_method
509
-     * @return \EE_Form_Section_Proper
510
-     */
511
-    protected function _currency_support(EE_Payment_Method $payment_method)
512
-    {
513
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
514
-            return new EE_Form_Section_HTML(
515
-                EEH_HTML::tr(
516
-                    EEH_HTML::th(
517
-                        EEH_HTML::label(
518
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
519
-                        )
520
-                    ) .
521
-                    EEH_HTML::td(
522
-                        EEH_HTML::strong(
523
-                            sprintf(
524
-                                __(
525
-                                    'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
526
-                                    'event_espresso'
527
-                                ),
528
-                                EE_Config::instance()->currency->code
529
-                            )
530
-                        )
531
-                    )
532
-                )
533
-            );
534
-        } else {
535
-            return new EE_Form_Section_HTML('');
536
-        }
537
-    }
538
-
539
-
540
-    /**
541
-     * _update_payment_method_button
542
-     *
543
-     * @access protected
544
-     * @param \EE_Payment_Method $payment_method
545
-     * @return \EE_Form_Section_HTML
546
-     */
547
-    protected function _payment_method_settings(EE_Payment_Method $payment_method)
548
-    {
549
-        // modify the form so we only have/show fields that will be implemented for this version
550
-        return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
551
-    }
552
-
553
-
554
-    /**
555
-     * Simplifies the form to merely reproduce 4.1's gateway settings functionality
556
-     *
557
-     * @param EE_Form_Section_Proper $form_section
558
-     * @param string                 $payment_method_name
559
-     * @return \EE_Payment_Method_Form
560
-     * @throws \EE_Error
561
-     */
562
-    protected function _simplify_form($form_section, $payment_method_name = '')
563
-    {
564
-        if ($form_section instanceof EE_Payment_Method_Form) {
565
-            $form_section->exclude(
566
-                array(
567
-                    'PMD_type', // dont want them changing the type
568
-                    'PMD_slug', // or the slug (probably never)
569
-                    'PMD_wp_user', // or the user's ID
570
-                    'Currency' // or the currency, until the rest of EE supports simultaneous currencies
571
-                )
572
-            );
573
-            return $form_section;
574
-        } else {
575
-            throw new EE_Error(
576
-                sprintf(
577
-                    __(
578
-                        'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
579
-                        'event_espresso'
580
-                    ),
581
-                    $payment_method_name
582
-                )
583
-            );
584
-        }
585
-    }
586
-
587
-
588
-    /**
589
-     * _update_payment_method_button
590
-     *
591
-     * @access protected
592
-     * @param \EE_Payment_Method $payment_method
593
-     * @return \EE_Form_Section_HTML
594
-     */
595
-    protected function _update_payment_method_button(EE_Payment_Method $payment_method)
596
-    {
597
-        $update_button = new EE_Submit_Input(
598
-            array(
599
-                'name'       => 'submit',
600
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
601
-                'default'    => sprintf(
602
-                    __('Update %s Payment Settings', 'event_espresso'),
603
-                    $payment_method->admin_name()
604
-                ),
605
-                'html_label' => EEH_HTML::nbsp(),
606
-            )
607
-        );
608
-        return new EE_Form_Section_HTML(
609
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
610
-            EEH_HTML::tr(
611
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
612
-                EEH_HTML::td(
613
-                    $update_button->get_html_for_input()
614
-                )
615
-            )
616
-        );
617
-    }
618
-
619
-
620
-    /**
621
-     * _deactivate_payment_method_button
622
-     *
623
-     * @access protected
624
-     * @param \EE_Payment_Method $payment_method
625
-     * @return \EE_Form_Section_Proper
626
-     */
627
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
628
-    {
629
-        $link_text_and_title = sprintf(
630
-            __('Deactivate %1$s Payments?', 'event_espresso'),
631
-            $payment_method->admin_name()
632
-        );
633
-        return new EE_Form_Section_HTML(
634
-            EEH_HTML::tr(
635
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
636
-                EEH_HTML::td(
637
-                    EEH_HTML::link(
638
-                        EE_Admin_Page::add_query_args_and_nonce(
639
-                            array(
640
-                                'action'         => 'deactivate_payment_method',
641
-                                'payment_method' => $payment_method->slug(),
642
-                            ),
643
-                            EE_PAYMENTS_ADMIN_URL
644
-                        ),
645
-                        $link_text_and_title,
646
-                        $link_text_and_title,
647
-                        'deactivate_' . $payment_method->slug(),
648
-                        'espresso-button button-secondary'
649
-                    )
650
-                )
651
-            )
652
-        );
653
-    }
654
-
655
-
656
-    /**
657
-     * _activate_payment_method_button
658
-     *
659
-     * @access protected
660
-     * @param \EE_Payment_Method $payment_method
661
-     * @return \EE_Form_Section_Proper
662
-     */
663
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
664
-    {
665
-        $link_text_and_title = sprintf(
666
-            __('Activate %1$s Payment Method?', 'event_espresso'),
667
-            $payment_method->admin_name()
668
-        );
669
-        return new EE_Form_Section_Proper(
670
-            array(
671
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
672
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
673
-                'action'          => '#',
674
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
675
-                'subsections'     => apply_filters(
676
-                    'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
677
-                    array(
678
-                        new EE_Form_Section_HTML(
679
-                            EEH_HTML::tr(
680
-                                EEH_HTML::td(
681
-                                    $payment_method->type_obj()->introductory_html(),
682
-                                    '',
683
-                                    '',
684
-                                    '',
685
-                                    'colspan="2"'
686
-                                )
687
-                            ) .
688
-                            EEH_HTML::tr(
689
-                                EEH_HTML::th(
690
-                                    EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
691
-                                ) .
692
-                                EEH_HTML::td(
693
-                                    EEH_HTML::link(
694
-                                        EE_Admin_Page::add_query_args_and_nonce(
695
-                                            array(
696
-                                                'action'              => 'activate_payment_method',
697
-                                                'payment_method_type' => $payment_method->type(),
698
-                                            ),
699
-                                            EE_PAYMENTS_ADMIN_URL
700
-                                        ),
701
-                                        $link_text_and_title,
702
-                                        $link_text_and_title,
703
-                                        'activate_' . $payment_method->slug(),
704
-                                        'espresso-button-green button-primary'
705
-                                    )
706
-                                )
707
-                            )
708
-                        ),
709
-                    ),
710
-                    $payment_method
711
-                ),
712
-            )
713
-        );
714
-    }
715
-
716
-
717
-    /**
718
-     * _fine_print
719
-     *
720
-     * @access protected
721
-     * @return \EE_Form_Section_HTML
722
-     */
723
-    protected function _fine_print()
724
-    {
725
-        return new EE_Form_Section_HTML(
726
-            EEH_HTML::tr(
727
-                EEH_HTML::th() .
728
-                EEH_HTML::td(
729
-                    EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
730
-                )
731
-            )
732
-        );
733
-    }
734
-
735
-
736
-    /**
737
-     * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
738
-     *
739
-     * @global WP_User $current_user
740
-     */
741
-    protected function _activate_payment_method()
742
-    {
743
-        if (isset($this->_req_data['payment_method_type'])) {
744
-            $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
745
-            // see if one exists
746
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
747
-            $payment_method = EE_Payment_Method_Manager::instance()
748
-                                                       ->activate_a_payment_method_of_type($payment_method_type);
749
-            $this->_redirect_after_action(
750
-                1,
751
-                'Payment Method',
752
-                'activated',
753
-                array('action' => 'default', 'payment_method' => $payment_method->slug())
754
-            );
755
-        } else {
756
-            $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
757
-        }
758
-    }
759
-
760
-
761
-    /**
762
-     * Deactivates the payment method with the specified slug, and redirects.
763
-     */
764
-    protected function _deactivate_payment_method()
765
-    {
766
-        if (isset($this->_req_data['payment_method'])) {
767
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
768
-            // deactivate it
769
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
770
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
771
-            $this->_redirect_after_action(
772
-                $count_updated,
773
-                'Payment Method',
774
-                'deactivated',
775
-                array('action' => 'default', 'payment_method' => $payment_method_slug)
776
-            );
777
-        } else {
778
-            $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
779
-        }
780
-    }
781
-
782
-
783
-    /**
784
-     * Processes the payment method form that was submitted. This is slightly trickier than usual form
785
-     * processing because we first need to identify WHICH form was processed and which payment method
786
-     * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
787
-     * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
788
-     * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
789
-     * subsequently called 'headers_sent_func' which is _payment_methods_list)
790
-     *
791
-     * @return void
792
-     */
793
-    protected function _update_payment_method()
794
-    {
795
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
796
-            // ok let's find which gateway form to use based on the form input
797
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
798
-            /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
799
-            $correct_pmt_form_to_use = null;
800
-            $payment_method = null;
801
-            foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
802
-                // get the form and simplify it, like what we do when we display it
803
-                $pmt_form = $this->_generate_payment_method_settings_form($payment_method);
804
-                if ($pmt_form->form_data_present_in($this->_req_data)) {
805
-                    $correct_pmt_form_to_use = $pmt_form;
806
-                    break;
807
-                }
808
-            }
809
-            // if we couldn't find the correct payment method type...
810
-            if (! $correct_pmt_form_to_use) {
811
-                EE_Error::add_error(
812
-                    __(
813
-                        "We could not find which payment method type your form submission related to. Please contact support",
814
-                        'event_espresso'
815
-                    ),
816
-                    __FILE__,
817
-                    __FUNCTION__,
818
-                    __LINE__
819
-                );
820
-                $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
821
-            }
822
-            $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
823
-            if ($correct_pmt_form_to_use->is_valid()) {
824
-                $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
825
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
826
-                    throw new EE_Error(
827
-                        sprintf(
828
-                            __(
829
-                                'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
830
-                                'event_espresso'
831
-                            ),
832
-                            'payment_method_settings'
833
-                        )
834
-                    );
835
-                }
836
-                $payment_settings_subform->save();
837
-                /** @var $pm EE_Payment_Method */
838
-                $this->_redirect_after_action(
839
-                    true,
840
-                    'Payment Method',
841
-                    'updated',
842
-                    array('action' => 'default', 'payment_method' => $payment_method->slug())
843
-                );
844
-            } else {
845
-                EE_Error::add_error(
846
-                    sprintf(
847
-                        __(
848
-                            'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
849
-                            'event_espresso'
850
-                        ),
851
-                        $payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
852
-                            : __('"(unknown)"', 'event_espresso')
853
-                    ),
854
-                    __FILE__,
855
-                    __FUNCTION__,
856
-                    __LINE__
857
-                );
858
-            }
859
-        }
860
-        return;
861
-    }
862
-
863
-
864
-    /**
865
-     * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
866
-     * @throws DomainException
867
-     * @throws EE_Error
868
-     * @throws InvalidArgumentException
869
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
870
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
871
-     */
872
-    protected function _payment_settings()
873
-    {
874
-        $form = $this->getPaymentSettingsForm();
875
-        $this->_set_add_edit_form_tags('update_payment_settings');
876
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
877
-        $this->_template_args['admin_page_content'] =  $form->get_html_and_js();
878
-        $this->display_admin_page_with_sidebar();
879
-    }
880
-
881
-
882
-    /**
883
-     *        _update_payment_settings
884
-     *
885
-     * @access protected
886
-     * @return void
887
-     * @throws EE_Error
888
-     * @throws InvalidArgumentException
889
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
890
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
891
-     */
892
-    protected function _update_payment_settings()
893
-    {
894
-        $form = $this->getPaymentSettingsForm();
895
-        if ($form->was_submitted($this->_req_data)) {
896
-            $form->receive_form_submission($this->_req_data);
897
-            if ($form->is_valid()) {
898
-                /**
899
-                 * @var $reg_config EE_Registration_Config
900
-                 */
901
-                $loader = LoaderFactory::getLoader();
902
-                $reg_config = $loader->getShared('EE_Registration_Config');
903
-                $valid_data = $form->valid_data();
904
-                $reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
905
-                $reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
906
-            }
907
-        }
908
-        EE_Registry::instance()->CFG = apply_filters(
909
-            'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
910
-            EE_Registry::instance()->CFG
911
-        );
912
-
913
-        $cfg =  EE_Registry::instance()->CFG ;
914
-
915
-        $what = __('Payment Settings', 'event_espresso');
916
-        $success = $this->_update_espresso_configuration(
917
-            $what,
918
-            EE_Registry::instance()->CFG,
919
-            __FILE__,
920
-            __FUNCTION__,
921
-            __LINE__
922
-        );
923
-        $this->_redirect_after_action(
924
-            $success,
925
-            $what,
926
-            __('updated', 'event_espresso'),
927
-            array('action' => 'payment_settings')
928
-        );
929
-    }
930
-
931
-
932
-    /**
933
-     * Gets the form used for updating payment settings
934
-     *
935
-     * @return EE_Form_Section_Proper
936
-     * @throws EE_Error
937
-     * @throws InvalidArgumentException
938
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
939
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
940
-     */
941
-    protected function getPaymentSettingsForm()
942
-    {
943
-        /**
944
-         * @var $reg_config EE_Registration_Config
945
-         */
946
-        $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
947
-        return new EE_Form_Section_Proper(
948
-            array(
949
-                'name' => 'payment-settings',
950
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
951
-                'subsections' => array(
952
-                    'show_pending_payment_options' => new EE_Yes_No_Input(
953
-                        array(
954
-                            'html_name' => 'show_pending_payment_options',
955
-                            'default' => $reg_config->show_pending_payment_options,
956
-                            'html_help_text' => esc_html__(
957
-                                "If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
958
-                                'event_espresso'
959
-                            )
960
-                        )
961
-                    ),
962
-                    'gateway_log_lifespan' => new \EE_Select_Input(
963
-                        $reg_config->gatewayLogLifespanOptions(),
964
-                        array(
965
-                            'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
966
-                            'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
967
-                            'default' => $reg_config->gateway_log_lifespan,
968
-                        )
969
-                    )
970
-                )
971
-            )
972
-        );
973
-    }
974
-
975
-
976
-    protected function _payment_log_overview_list_table()
977
-    {
978
-        $this->display_admin_list_table_page_with_sidebar();
979
-    }
980
-
981
-
982
-    protected function _set_list_table_views_payment_log()
983
-    {
984
-        $this->_views = array(
985
-            'all' => array(
986
-                'slug'  => 'all',
987
-                'label' => __('View All Logs', 'event_espresso'),
988
-                'count' => 0,
989
-            ),
990
-        );
991
-    }
992
-
993
-
994
-    /**
995
-     * @param int  $per_page
996
-     * @param int  $current_page
997
-     * @param bool $count
998
-     * @return array
999
-     */
1000
-    public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
1001
-    {
1002
-        EE_Registry::instance()->load_model('Change_Log');
1003
-        // we may need to do multiple queries (joining differently), so we actually wan tan array of query params
1004
-        $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
1005
-        // check if they've selected a specific payment method
1006
-        if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
1007
-            $query_params[0]['OR*pm_or_pay_pm'] = array(
1008
-                'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
1009
-                'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
1010
-            );
1011
-        }
1012
-        // take into account search
1013
-        if (isset($this->_req_data['s']) && $this->_req_data['s']) {
1014
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
1015
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
1016
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
1017
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
1018
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
1019
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
1020
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
1021
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
1022
-            $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
1023
-            $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
1024
-            $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
1025
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
1026
-        }
1027
-        if (isset($this->_req_data['payment-filter-start-date'])
1028
-            && isset($this->_req_data['payment-filter-end-date'])
1029
-        ) {
1030
-            // add date
1031
-            $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
1032
-            $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
1033
-            // make sure our timestamps start and end right at the boundaries for each day
1034
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
1035
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
1036
-            // convert to timestamps
1037
-            $start_date = strtotime($start_date);
1038
-            $end_date = strtotime($end_date);
1039
-            // makes sure start date is the lowest value and vice versa
1040
-            $start_date = min($start_date, $end_date);
1041
-            $end_date = max($start_date, $end_date);
1042
-            // convert for query
1043
-            $start_date = EEM_Change_Log::instance()
1044
-                                        ->convert_datetime_for_query(
1045
-                                            'LOG_time',
1046
-                                            date('Y-m-d H:i:s', $start_date),
1047
-                                            'Y-m-d H:i:s'
1048
-                                        );
1049
-            $end_date = EEM_Change_Log::instance()
1050
-                                      ->convert_datetime_for_query(
1051
-                                          'LOG_time',
1052
-                                          date('Y-m-d H:i:s', $end_date),
1053
-                                          'Y-m-d H:i:s'
1054
-                                      );
1055
-            $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
1056
-        }
1057
-        if ($count) {
1058
-            return EEM_Change_Log::instance()->count($query_params);
1059
-        }
1060
-        if (isset($this->_req_data['order'])) {
1061
-            $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
1062
-                : 'DESC';
1063
-            $query_params['order_by'] = array('LOG_time' => $sort);
1064
-        } else {
1065
-            $query_params['order_by'] = array('LOG_time' => 'DESC');
1066
-        }
1067
-        $offset = ($current_page - 1) * $per_page;
1068
-        if (! isset($this->_req_data['download_results'])) {
1069
-            $query_params['limit'] = array($offset, $per_page);
1070
-        }
1071
-        // now they've requested to instead just download the file instead of viewing it.
1072
-        if (isset($this->_req_data['download_results'])) {
1073
-            $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
1074
-            header('Content-Disposition: attachment');
1075
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
1076
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
1077
-            echo "<h3>Query:</h3>";
1078
-            var_dump($query_params);
1079
-            echo "<h3>Results:</h3>";
1080
-            var_dump($wpdb_results);
1081
-            die;
1082
-        }
1083
-        $results = EEM_Change_Log::instance()->get_all($query_params);
1084
-        return $results;
1085
-    }
1086
-
1087
-
1088
-    /**
1089
-     * Used by usort to RE-sort log query results, because we lose the ordering
1090
-     * because we're possibly combining the results from two queries
1091
-     *
1092
-     * @param EE_Change_Log $logA
1093
-     * @param EE_Change_Log $logB
1094
-     * @return int
1095
-     */
1096
-    protected function _sort_logs_again($logA, $logB)
1097
-    {
1098
-        $timeA = $logA->get_raw('LOG_time');
1099
-        $timeB = $logB->get_raw('LOG_time');
1100
-        if ($timeA == $timeB) {
1101
-            return 0;
1102
-        }
1103
-        $comparison = $timeA < $timeB ? -1 : 1;
1104
-        if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
1105
-            return $comparison * -1;
1106
-        } else {
1107
-            return $comparison;
1108
-        }
1109
-    }
1110
-
1111
-
1112
-    protected function _payment_log_details()
1113
-    {
1114
-        EE_Registry::instance()->load_model('Change_Log');
1115
-        /** @var $payment_log EE_Change_Log */
1116
-        $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
1117
-        $payment_method = null;
1118
-        $transaction = null;
1119
-        if ($payment_log instanceof EE_Change_Log) {
1120
-            if ($payment_log->object() instanceof EE_Payment) {
1121
-                $payment_method = $payment_log->object()->payment_method();
1122
-                $transaction = $payment_log->object()->transaction();
1123
-            } elseif ($payment_log->object() instanceof EE_Payment_Method) {
1124
-                $payment_method = $payment_log->object();
1125
-            }
1126
-        }
1127
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
1128
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
1129
-            array(
1130
-                'payment_log'    => $payment_log,
1131
-                'payment_method' => $payment_method,
1132
-                'transaction'    => $transaction,
1133
-            ),
1134
-            true
1135
-        );
1136
-        $this->display_admin_page_with_sidebar();
1137
-    }
17
+	/**
18
+	 * Variables used for when we're re-sorting the logs results, in case
19
+	 * we needed to do two queries and we need to resort
20
+	 *
21
+	 * @var string
22
+	 */
23
+	private $_sort_logs_again_direction;
24
+
25
+
26
+	/**
27
+	 * @Constructor
28
+	 * @access public
29
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
30
+	 * @return \Payments_Admin_Page
31
+	 */
32
+	public function __construct($routing = true)
33
+	{
34
+		parent::__construct($routing);
35
+	}
36
+
37
+
38
+	protected function _init_page_props()
39
+	{
40
+		$this->page_slug = EE_PAYMENTS_PG_SLUG;
41
+		$this->page_label = __('Payment Methods', 'event_espresso');
42
+		$this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
43
+		$this->_admin_base_path = EE_PAYMENTS_ADMIN;
44
+	}
45
+
46
+
47
+	protected function _ajax_hooks()
48
+	{
49
+		// todo: all hooks for ajax goes here.
50
+	}
51
+
52
+
53
+	protected function _define_page_props()
54
+	{
55
+		$this->_admin_page_title = $this->page_label;
56
+		$this->_labels = array(
57
+			'publishbox' => __('Update Settings', 'event_espresso'),
58
+		);
59
+	}
60
+
61
+
62
+	protected function _set_page_routes()
63
+	{
64
+		/**
65
+		 * note that with payment method capabilities, although we've implemented
66
+		 * capability mapping which will be used for accessing payment methods owned by
67
+		 * other users.  This is not fully implemented yet in the payment method ui.
68
+		 * Currently only the "plural" caps are in active use.
69
+		 * When cap mapping is implemented, some routes will need to use the singular form of
70
+		 * capability method and also include the $id of the payment method for the route.
71
+		 **/
72
+		$this->_page_routes = array(
73
+			'default'                   => array(
74
+				'func'       => '_payment_methods_list',
75
+				'capability' => 'ee_edit_payment_methods',
76
+			),
77
+			'payment_settings'          => array(
78
+				'func'       => '_payment_settings',
79
+				'capability' => 'ee_manage_gateways',
80
+			),
81
+			'activate_payment_method'   => array(
82
+				'func'       => '_activate_payment_method',
83
+				'noheader'   => true,
84
+				'capability' => 'ee_edit_payment_methods',
85
+			),
86
+			'deactivate_payment_method' => array(
87
+				'func'       => '_deactivate_payment_method',
88
+				'noheader'   => true,
89
+				'capability' => 'ee_delete_payment_methods',
90
+			),
91
+			'update_payment_method'     => array(
92
+				'func'               => '_update_payment_method',
93
+				'noheader'           => true,
94
+				'headers_sent_route' => 'default',
95
+				'capability'         => 'ee_edit_payment_methods',
96
+			),
97
+			'update_payment_settings'   => array(
98
+				'func'       => '_update_payment_settings',
99
+				'noheader'   => true,
100
+				'capability' => 'ee_manage_gateways',
101
+			),
102
+			'payment_log'               => array(
103
+				'func'       => '_payment_log_overview_list_table',
104
+				'capability' => 'ee_read_payment_methods',
105
+			),
106
+			'payment_log_details'       => array(
107
+				'func'       => '_payment_log_details',
108
+				'capability' => 'ee_read_payment_methods',
109
+			),
110
+		);
111
+	}
112
+
113
+
114
+	protected function _set_page_config()
115
+	{
116
+		$payment_method_list_config = array(
117
+			'nav'           => array(
118
+				'label' => __('Payment Methods', 'event_espresso'),
119
+				'order' => 10,
120
+			),
121
+			'metaboxes'     => $this->_default_espresso_metaboxes,
122
+			'help_tabs'     => array_merge(
123
+				array(
124
+					'payment_methods_overview_help_tab' => array(
125
+						'title'    => __('Payment Methods Overview', 'event_espresso'),
126
+						'filename' => 'payment_methods_overview',
127
+					),
128
+				),
129
+				$this->_add_payment_method_help_tabs()
130
+			),
131
+			'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
132
+			'require_nonce' => false,
133
+		);
134
+		$this->_page_config = array(
135
+			'default'          => $payment_method_list_config,
136
+			'payment_settings' => array(
137
+				'nav'           => array(
138
+					'label' => __('Settings', 'event_espresso'),
139
+					'order' => 20,
140
+				),
141
+				'help_tabs'     => array(
142
+					'payment_methods_settings_help_tab' => array(
143
+						'title'    => __('Payment Method Settings', 'event_espresso'),
144
+						'filename' => 'payment_methods_settings',
145
+					),
146
+				),
147
+				// 'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
148
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
149
+				'require_nonce' => false,
150
+			),
151
+			'payment_log'      => array(
152
+				'nav'           => array(
153
+					'label' => __("Logs", 'event_espresso'),
154
+					'order' => 30,
155
+				),
156
+				'list_table'    => 'Payment_Log_Admin_List_Table',
157
+				'metaboxes'     => $this->_default_espresso_metaboxes,
158
+				'require_nonce' => false,
159
+			),
160
+		);
161
+	}
162
+
163
+
164
+	/**
165
+	 * @return array
166
+	 */
167
+	protected function _add_payment_method_help_tabs()
168
+	{
169
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
170
+		$payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
171
+		$all_pmt_help_tabs_config = array();
172
+		foreach ($payment_method_types as $payment_method_type) {
173
+			if (! EE_Registry::instance()->CAP->current_user_can(
174
+				$payment_method_type->cap_name(),
175
+				'specific_payment_method_type_access'
176
+			)
177
+			) {
178
+				continue;
179
+			}
180
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
181
+				$template_args = isset($config['template_args']) ? $config['template_args'] : array();
182
+				$template_args['admin_page_obj'] = $this;
183
+				$all_pmt_help_tabs_config[ $help_tab_name ] = array(
184
+					'title'   => $config['title'],
185
+					'content' => EEH_Template::display_template(
186
+						$payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
187
+						$template_args,
188
+						true
189
+					),
190
+				);
191
+			}
192
+		}
193
+		return $all_pmt_help_tabs_config;
194
+	}
195
+
196
+
197
+	// none of the below group are currently used for Gateway Settings
198
+	protected function _add_screen_options()
199
+	{
200
+	}
201
+
202
+
203
+	protected function _add_feature_pointers()
204
+	{
205
+	}
206
+
207
+
208
+	public function admin_init()
209
+	{
210
+	}
211
+
212
+
213
+	public function admin_notices()
214
+	{
215
+	}
216
+
217
+
218
+	public function admin_footer_scripts()
219
+	{
220
+	}
221
+
222
+
223
+	public function load_scripts_styles()
224
+	{
225
+		wp_enqueue_script('ee_admin_js');
226
+		wp_enqueue_script('ee-text-links');
227
+		wp_enqueue_script(
228
+			'espresso_payments',
229
+			EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
230
+			array('espresso-ui-theme', 'ee-datepicker'),
231
+			EVENT_ESPRESSO_VERSION,
232
+			true
233
+		);
234
+	}
235
+
236
+
237
+	public function load_scripts_styles_default()
238
+	{
239
+		// styles
240
+		wp_register_style(
241
+			'espresso_payments',
242
+			EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
243
+			array(),
244
+			EVENT_ESPRESSO_VERSION
245
+		);
246
+		wp_enqueue_style('espresso_payments');
247
+		wp_enqueue_style('ee-text-links');
248
+		// scripts
249
+	}
250
+
251
+
252
+	protected function _payment_methods_list()
253
+	{
254
+		/**
255
+		 * first let's ensure payment methods have been setup. We do this here because when people activate a
256
+		 * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
257
+		 * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
258
+		 * recheck here.
259
+		 */
260
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
261
+		EEM_Payment_Method::instance()->verify_button_urls();
262
+		// setup tabs, one for each payment method type
263
+		$tabs = array();
264
+		$payment_methods = array();
265
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
266
+			// we don't want to show admin-only PMTs for now
267
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
268
+				continue;
269
+			}
270
+			// check access
271
+			if (! EE_Registry::instance()->CAP->current_user_can(
272
+				$pmt_obj->cap_name(),
273
+				'specific_payment_method_type_access'
274
+			)
275
+			) {
276
+				continue;
277
+			}
278
+			// check for any active pms of that type
279
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
280
+			if (! $payment_method instanceof EE_Payment_Method) {
281
+				$payment_method = EE_Payment_Method::new_instance(
282
+					array(
283
+						'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
284
+						'PMD_type'       => $pmt_obj->system_name(),
285
+						'PMD_name'       => $pmt_obj->pretty_name(),
286
+						'PMD_admin_name' => $pmt_obj->pretty_name(),
287
+					)
288
+				);
289
+			}
290
+			$payment_methods[ $payment_method->slug() ] = $payment_method;
291
+		}
292
+		$payment_methods = apply_filters(
293
+			'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
294
+			$payment_methods
295
+		);
296
+		foreach ($payment_methods as $payment_method) {
297
+			if ($payment_method instanceof EE_Payment_Method) {
298
+				add_meta_box(
299
+					// html id
300
+					'espresso_' . $payment_method->slug() . '_payment_settings',
301
+					// title
302
+					sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
303
+					// callback
304
+					array($this, 'payment_method_settings_meta_box'),
305
+					// post type
306
+					null,
307
+					// context
308
+					'normal',
309
+					// priority
310
+					'default',
311
+					// callback args
312
+					array('payment_method' => $payment_method)
313
+				);
314
+				// setup for tabbed content
315
+				$tabs[ $payment_method->slug() ] = array(
316
+					'label' => $payment_method->admin_name(),
317
+					'class' => $payment_method->active() ? 'gateway-active' : '',
318
+					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
319
+					'title' => __('Modify this Payment Method', 'event_espresso'),
320
+					'slug'  => $payment_method->slug(),
321
+				);
322
+			}
323
+		}
324
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
325
+			$tabs,
326
+			'payment_method_links',
327
+			'|',
328
+			$this->_get_active_payment_method_slug()
329
+		);
330
+		$this->display_admin_page_with_sidebar();
331
+	}
332
+
333
+
334
+	/**
335
+	 *   _get_active_payment_method_slug
336
+	 *
337
+	 * @return string
338
+	 */
339
+	protected function _get_active_payment_method_slug()
340
+	{
341
+		$payment_method_slug = false;
342
+		// decide which payment method tab to open first, as dictated by the request's 'payment_method'
343
+		if (isset($this->_req_data['payment_method'])) {
344
+			// if they provided the current payment method, use it
345
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
346
+		}
347
+		$payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
348
+		// if that didn't work or wasn't provided, find another way to select the current pm
349
+		if (! $this->_verify_payment_method($payment_method)) {
350
+			// like, looking for an active one
351
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
352
+			// test that one as well
353
+			if ($this->_verify_payment_method($payment_method)) {
354
+				$payment_method_slug = $payment_method->slug();
355
+			} else {
356
+				$payment_method_slug = 'paypal_standard';
357
+			}
358
+		}
359
+		return $payment_method_slug;
360
+	}
361
+
362
+
363
+	/**
364
+	 *    payment_method_settings_meta_box
365
+	 *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
366
+	 *    capabilities to access it
367
+	 *
368
+	 * @param \EE_Payment_Method $payment_method
369
+	 * @return boolean
370
+	 */
371
+	protected function _verify_payment_method($payment_method)
372
+	{
373
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
374
+			&& EE_Registry::instance()->CAP->current_user_can(
375
+				$payment_method->type_obj()->cap_name(),
376
+				'specific_payment_method_type_access'
377
+			)
378
+		) {
379
+			return true;
380
+		}
381
+		return false;
382
+	}
383
+
384
+
385
+	/**
386
+	 *    payment_method_settings_meta_box
387
+	 *
388
+	 * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
389
+	 * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
390
+	 *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
391
+	 * @return string
392
+	 * @throws EE_Error
393
+	 */
394
+	public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
395
+	{
396
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
397
+			? $metabox['args']['payment_method'] : null;
398
+		if (! $payment_method instanceof EE_Payment_Method) {
399
+			throw new EE_Error(
400
+				sprintf(
401
+					__(
402
+						'Payment method metabox setup incorrectly. No Payment method object was supplied',
403
+						'event_espresso'
404
+					)
405
+				)
406
+			);
407
+		}
408
+		$payment_method_scopes = $payment_method->active();
409
+		// if the payment method really exists show its form, otherwise the activation template
410
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
411
+			$form = $this->_generate_payment_method_settings_form($payment_method);
412
+			if ($form->form_data_present_in($this->_req_data)) {
413
+				$form->receive_form_submission($this->_req_data);
414
+			}
415
+			echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
416
+		} else {
417
+			echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
418
+		}
419
+	}
420
+
421
+
422
+	/**
423
+	 * Gets the form for all the settings related to this payment method type
424
+	 *
425
+	 * @access protected
426
+	 * @param \EE_Payment_Method $payment_method
427
+	 * @return \EE_Form_Section_Proper
428
+	 */
429
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
430
+	{
431
+		if (! $payment_method instanceof EE_Payment_Method) {
432
+			return new EE_Form_Section_Proper();
433
+		}
434
+		return new EE_Form_Section_Proper(
435
+			array(
436
+				'name'            => $payment_method->slug() . '_settings_form',
437
+				'html_id'         => $payment_method->slug() . '_settings_form',
438
+				'action'          => EE_Admin_Page::add_query_args_and_nonce(
439
+					array(
440
+						'action'         => 'update_payment_method',
441
+						'payment_method' => $payment_method->slug(),
442
+					),
443
+					EE_PAYMENTS_ADMIN_URL
444
+				),
445
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
446
+				'subsections'     => apply_filters(
447
+					'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
448
+					array(
449
+						'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
450
+						'currency_support'        => $this->_currency_support($payment_method),
451
+						'payment_method_settings' => $this->_payment_method_settings($payment_method),
452
+						'update'                  => $this->_update_payment_method_button($payment_method),
453
+						'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
454
+						'fine_print'              => $this->_fine_print(),
455
+					),
456
+					$payment_method
457
+				),
458
+			)
459
+		);
460
+	}
461
+
462
+
463
+	/**
464
+	 * _pci_dss_compliance
465
+	 *
466
+	 * @access protected
467
+	 * @param \EE_Payment_Method $payment_method
468
+	 * @return \EE_Form_Section_Proper
469
+	 */
470
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
471
+	{
472
+		if ($payment_method->type_obj()->requires_https()) {
473
+			return new EE_Form_Section_HTML(
474
+				EEH_HTML::tr(
475
+					EEH_HTML::th(
476
+						EEH_HTML::label(
477
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
478
+						)
479
+					) .
480
+					EEH_HTML::td(
481
+						EEH_HTML::strong(
482
+							__(
483
+								'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
484
+								'event_espresso'
485
+							)
486
+						)
487
+						.
488
+						EEH_HTML::br()
489
+						.
490
+						__('Learn more about ', 'event_espresso')
491
+						. EEH_HTML::link(
492
+							'https://www.pcisecuritystandards.org/merchants/index.php',
493
+							__('PCI DSS compliance', 'event_espresso')
494
+						)
495
+					)
496
+				)
497
+			);
498
+		} else {
499
+			return new EE_Form_Section_HTML('');
500
+		}
501
+	}
502
+
503
+
504
+	/**
505
+	 * _currency_support
506
+	 *
507
+	 * @access protected
508
+	 * @param \EE_Payment_Method $payment_method
509
+	 * @return \EE_Form_Section_Proper
510
+	 */
511
+	protected function _currency_support(EE_Payment_Method $payment_method)
512
+	{
513
+		if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
514
+			return new EE_Form_Section_HTML(
515
+				EEH_HTML::tr(
516
+					EEH_HTML::th(
517
+						EEH_HTML::label(
518
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
519
+						)
520
+					) .
521
+					EEH_HTML::td(
522
+						EEH_HTML::strong(
523
+							sprintf(
524
+								__(
525
+									'This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.',
526
+									'event_espresso'
527
+								),
528
+								EE_Config::instance()->currency->code
529
+							)
530
+						)
531
+					)
532
+				)
533
+			);
534
+		} else {
535
+			return new EE_Form_Section_HTML('');
536
+		}
537
+	}
538
+
539
+
540
+	/**
541
+	 * _update_payment_method_button
542
+	 *
543
+	 * @access protected
544
+	 * @param \EE_Payment_Method $payment_method
545
+	 * @return \EE_Form_Section_HTML
546
+	 */
547
+	protected function _payment_method_settings(EE_Payment_Method $payment_method)
548
+	{
549
+		// modify the form so we only have/show fields that will be implemented for this version
550
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
551
+	}
552
+
553
+
554
+	/**
555
+	 * Simplifies the form to merely reproduce 4.1's gateway settings functionality
556
+	 *
557
+	 * @param EE_Form_Section_Proper $form_section
558
+	 * @param string                 $payment_method_name
559
+	 * @return \EE_Payment_Method_Form
560
+	 * @throws \EE_Error
561
+	 */
562
+	protected function _simplify_form($form_section, $payment_method_name = '')
563
+	{
564
+		if ($form_section instanceof EE_Payment_Method_Form) {
565
+			$form_section->exclude(
566
+				array(
567
+					'PMD_type', // dont want them changing the type
568
+					'PMD_slug', // or the slug (probably never)
569
+					'PMD_wp_user', // or the user's ID
570
+					'Currency' // or the currency, until the rest of EE supports simultaneous currencies
571
+				)
572
+			);
573
+			return $form_section;
574
+		} else {
575
+			throw new EE_Error(
576
+				sprintf(
577
+					__(
578
+						'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
579
+						'event_espresso'
580
+					),
581
+					$payment_method_name
582
+				)
583
+			);
584
+		}
585
+	}
586
+
587
+
588
+	/**
589
+	 * _update_payment_method_button
590
+	 *
591
+	 * @access protected
592
+	 * @param \EE_Payment_Method $payment_method
593
+	 * @return \EE_Form_Section_HTML
594
+	 */
595
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method)
596
+	{
597
+		$update_button = new EE_Submit_Input(
598
+			array(
599
+				'name'       => 'submit',
600
+				'html_id'    => 'save_' . $payment_method->slug() . '_settings',
601
+				'default'    => sprintf(
602
+					__('Update %s Payment Settings', 'event_espresso'),
603
+					$payment_method->admin_name()
604
+				),
605
+				'html_label' => EEH_HTML::nbsp(),
606
+			)
607
+		);
608
+		return new EE_Form_Section_HTML(
609
+			EEH_HTML::no_row(EEH_HTML::br(2)) .
610
+			EEH_HTML::tr(
611
+				EEH_HTML::th(__('Update Settings', 'event_espresso')) .
612
+				EEH_HTML::td(
613
+					$update_button->get_html_for_input()
614
+				)
615
+			)
616
+		);
617
+	}
618
+
619
+
620
+	/**
621
+	 * _deactivate_payment_method_button
622
+	 *
623
+	 * @access protected
624
+	 * @param \EE_Payment_Method $payment_method
625
+	 * @return \EE_Form_Section_Proper
626
+	 */
627
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
628
+	{
629
+		$link_text_and_title = sprintf(
630
+			__('Deactivate %1$s Payments?', 'event_espresso'),
631
+			$payment_method->admin_name()
632
+		);
633
+		return new EE_Form_Section_HTML(
634
+			EEH_HTML::tr(
635
+				EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
636
+				EEH_HTML::td(
637
+					EEH_HTML::link(
638
+						EE_Admin_Page::add_query_args_and_nonce(
639
+							array(
640
+								'action'         => 'deactivate_payment_method',
641
+								'payment_method' => $payment_method->slug(),
642
+							),
643
+							EE_PAYMENTS_ADMIN_URL
644
+						),
645
+						$link_text_and_title,
646
+						$link_text_and_title,
647
+						'deactivate_' . $payment_method->slug(),
648
+						'espresso-button button-secondary'
649
+					)
650
+				)
651
+			)
652
+		);
653
+	}
654
+
655
+
656
+	/**
657
+	 * _activate_payment_method_button
658
+	 *
659
+	 * @access protected
660
+	 * @param \EE_Payment_Method $payment_method
661
+	 * @return \EE_Form_Section_Proper
662
+	 */
663
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
664
+	{
665
+		$link_text_and_title = sprintf(
666
+			__('Activate %1$s Payment Method?', 'event_espresso'),
667
+			$payment_method->admin_name()
668
+		);
669
+		return new EE_Form_Section_Proper(
670
+			array(
671
+				'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
672
+				'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
673
+				'action'          => '#',
674
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
675
+				'subsections'     => apply_filters(
676
+					'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
677
+					array(
678
+						new EE_Form_Section_HTML(
679
+							EEH_HTML::tr(
680
+								EEH_HTML::td(
681
+									$payment_method->type_obj()->introductory_html(),
682
+									'',
683
+									'',
684
+									'',
685
+									'colspan="2"'
686
+								)
687
+							) .
688
+							EEH_HTML::tr(
689
+								EEH_HTML::th(
690
+									EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
691
+								) .
692
+								EEH_HTML::td(
693
+									EEH_HTML::link(
694
+										EE_Admin_Page::add_query_args_and_nonce(
695
+											array(
696
+												'action'              => 'activate_payment_method',
697
+												'payment_method_type' => $payment_method->type(),
698
+											),
699
+											EE_PAYMENTS_ADMIN_URL
700
+										),
701
+										$link_text_and_title,
702
+										$link_text_and_title,
703
+										'activate_' . $payment_method->slug(),
704
+										'espresso-button-green button-primary'
705
+									)
706
+								)
707
+							)
708
+						),
709
+					),
710
+					$payment_method
711
+				),
712
+			)
713
+		);
714
+	}
715
+
716
+
717
+	/**
718
+	 * _fine_print
719
+	 *
720
+	 * @access protected
721
+	 * @return \EE_Form_Section_HTML
722
+	 */
723
+	protected function _fine_print()
724
+	{
725
+		return new EE_Form_Section_HTML(
726
+			EEH_HTML::tr(
727
+				EEH_HTML::th() .
728
+				EEH_HTML::td(
729
+					EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
730
+				)
731
+			)
732
+		);
733
+	}
734
+
735
+
736
+	/**
737
+	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
738
+	 *
739
+	 * @global WP_User $current_user
740
+	 */
741
+	protected function _activate_payment_method()
742
+	{
743
+		if (isset($this->_req_data['payment_method_type'])) {
744
+			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
745
+			// see if one exists
746
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
747
+			$payment_method = EE_Payment_Method_Manager::instance()
748
+													   ->activate_a_payment_method_of_type($payment_method_type);
749
+			$this->_redirect_after_action(
750
+				1,
751
+				'Payment Method',
752
+				'activated',
753
+				array('action' => 'default', 'payment_method' => $payment_method->slug())
754
+			);
755
+		} else {
756
+			$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
757
+		}
758
+	}
759
+
760
+
761
+	/**
762
+	 * Deactivates the payment method with the specified slug, and redirects.
763
+	 */
764
+	protected function _deactivate_payment_method()
765
+	{
766
+		if (isset($this->_req_data['payment_method'])) {
767
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
768
+			// deactivate it
769
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
770
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
771
+			$this->_redirect_after_action(
772
+				$count_updated,
773
+				'Payment Method',
774
+				'deactivated',
775
+				array('action' => 'default', 'payment_method' => $payment_method_slug)
776
+			);
777
+		} else {
778
+			$this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
779
+		}
780
+	}
781
+
782
+
783
+	/**
784
+	 * Processes the payment method form that was submitted. This is slightly trickier than usual form
785
+	 * processing because we first need to identify WHICH form was processed and which payment method
786
+	 * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
787
+	 * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
788
+	 * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
789
+	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
790
+	 *
791
+	 * @return void
792
+	 */
793
+	protected function _update_payment_method()
794
+	{
795
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
796
+			// ok let's find which gateway form to use based on the form input
797
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
798
+			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
799
+			$correct_pmt_form_to_use = null;
800
+			$payment_method = null;
801
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
802
+				// get the form and simplify it, like what we do when we display it
803
+				$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
804
+				if ($pmt_form->form_data_present_in($this->_req_data)) {
805
+					$correct_pmt_form_to_use = $pmt_form;
806
+					break;
807
+				}
808
+			}
809
+			// if we couldn't find the correct payment method type...
810
+			if (! $correct_pmt_form_to_use) {
811
+				EE_Error::add_error(
812
+					__(
813
+						"We could not find which payment method type your form submission related to. Please contact support",
814
+						'event_espresso'
815
+					),
816
+					__FILE__,
817
+					__FUNCTION__,
818
+					__LINE__
819
+				);
820
+				$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
821
+			}
822
+			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
823
+			if ($correct_pmt_form_to_use->is_valid()) {
824
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
825
+				if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
826
+					throw new EE_Error(
827
+						sprintf(
828
+							__(
829
+								'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
830
+								'event_espresso'
831
+							),
832
+							'payment_method_settings'
833
+						)
834
+					);
835
+				}
836
+				$payment_settings_subform->save();
837
+				/** @var $pm EE_Payment_Method */
838
+				$this->_redirect_after_action(
839
+					true,
840
+					'Payment Method',
841
+					'updated',
842
+					array('action' => 'default', 'payment_method' => $payment_method->slug())
843
+				);
844
+			} else {
845
+				EE_Error::add_error(
846
+					sprintf(
847
+						__(
848
+							'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
849
+							'event_espresso'
850
+						),
851
+						$payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
852
+							: __('"(unknown)"', 'event_espresso')
853
+					),
854
+					__FILE__,
855
+					__FUNCTION__,
856
+					__LINE__
857
+				);
858
+			}
859
+		}
860
+		return;
861
+	}
862
+
863
+
864
+	/**
865
+	 * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
866
+	 * @throws DomainException
867
+	 * @throws EE_Error
868
+	 * @throws InvalidArgumentException
869
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
870
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
871
+	 */
872
+	protected function _payment_settings()
873
+	{
874
+		$form = $this->getPaymentSettingsForm();
875
+		$this->_set_add_edit_form_tags('update_payment_settings');
876
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
877
+		$this->_template_args['admin_page_content'] =  $form->get_html_and_js();
878
+		$this->display_admin_page_with_sidebar();
879
+	}
880
+
881
+
882
+	/**
883
+	 *        _update_payment_settings
884
+	 *
885
+	 * @access protected
886
+	 * @return void
887
+	 * @throws EE_Error
888
+	 * @throws InvalidArgumentException
889
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
890
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
891
+	 */
892
+	protected function _update_payment_settings()
893
+	{
894
+		$form = $this->getPaymentSettingsForm();
895
+		if ($form->was_submitted($this->_req_data)) {
896
+			$form->receive_form_submission($this->_req_data);
897
+			if ($form->is_valid()) {
898
+				/**
899
+				 * @var $reg_config EE_Registration_Config
900
+				 */
901
+				$loader = LoaderFactory::getLoader();
902
+				$reg_config = $loader->getShared('EE_Registration_Config');
903
+				$valid_data = $form->valid_data();
904
+				$reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
905
+				$reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
906
+			}
907
+		}
908
+		EE_Registry::instance()->CFG = apply_filters(
909
+			'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
910
+			EE_Registry::instance()->CFG
911
+		);
912
+
913
+		$cfg =  EE_Registry::instance()->CFG ;
914
+
915
+		$what = __('Payment Settings', 'event_espresso');
916
+		$success = $this->_update_espresso_configuration(
917
+			$what,
918
+			EE_Registry::instance()->CFG,
919
+			__FILE__,
920
+			__FUNCTION__,
921
+			__LINE__
922
+		);
923
+		$this->_redirect_after_action(
924
+			$success,
925
+			$what,
926
+			__('updated', 'event_espresso'),
927
+			array('action' => 'payment_settings')
928
+		);
929
+	}
930
+
931
+
932
+	/**
933
+	 * Gets the form used for updating payment settings
934
+	 *
935
+	 * @return EE_Form_Section_Proper
936
+	 * @throws EE_Error
937
+	 * @throws InvalidArgumentException
938
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
939
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
940
+	 */
941
+	protected function getPaymentSettingsForm()
942
+	{
943
+		/**
944
+		 * @var $reg_config EE_Registration_Config
945
+		 */
946
+		$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
947
+		return new EE_Form_Section_Proper(
948
+			array(
949
+				'name' => 'payment-settings',
950
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
951
+				'subsections' => array(
952
+					'show_pending_payment_options' => new EE_Yes_No_Input(
953
+						array(
954
+							'html_name' => 'show_pending_payment_options',
955
+							'default' => $reg_config->show_pending_payment_options,
956
+							'html_help_text' => esc_html__(
957
+								"If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
958
+								'event_espresso'
959
+							)
960
+						)
961
+					),
962
+					'gateway_log_lifespan' => new \EE_Select_Input(
963
+						$reg_config->gatewayLogLifespanOptions(),
964
+						array(
965
+							'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
966
+							'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
967
+							'default' => $reg_config->gateway_log_lifespan,
968
+						)
969
+					)
970
+				)
971
+			)
972
+		);
973
+	}
974
+
975
+
976
+	protected function _payment_log_overview_list_table()
977
+	{
978
+		$this->display_admin_list_table_page_with_sidebar();
979
+	}
980
+
981
+
982
+	protected function _set_list_table_views_payment_log()
983
+	{
984
+		$this->_views = array(
985
+			'all' => array(
986
+				'slug'  => 'all',
987
+				'label' => __('View All Logs', 'event_espresso'),
988
+				'count' => 0,
989
+			),
990
+		);
991
+	}
992
+
993
+
994
+	/**
995
+	 * @param int  $per_page
996
+	 * @param int  $current_page
997
+	 * @param bool $count
998
+	 * @return array
999
+	 */
1000
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
1001
+	{
1002
+		EE_Registry::instance()->load_model('Change_Log');
1003
+		// we may need to do multiple queries (joining differently), so we actually wan tan array of query params
1004
+		$query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
1005
+		// check if they've selected a specific payment method
1006
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
1007
+			$query_params[0]['OR*pm_or_pay_pm'] = array(
1008
+				'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
1009
+				'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
1010
+			);
1011
+		}
1012
+		// take into account search
1013
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
1014
+			$similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
1015
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
1016
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
1017
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
1018
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
1019
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
1020
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
1021
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
1022
+			$query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
1023
+			$query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
1024
+			$query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
1025
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
1026
+		}
1027
+		if (isset($this->_req_data['payment-filter-start-date'])
1028
+			&& isset($this->_req_data['payment-filter-end-date'])
1029
+		) {
1030
+			// add date
1031
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
1032
+			$end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
1033
+			// make sure our timestamps start and end right at the boundaries for each day
1034
+			$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
1035
+			$end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
1036
+			// convert to timestamps
1037
+			$start_date = strtotime($start_date);
1038
+			$end_date = strtotime($end_date);
1039
+			// makes sure start date is the lowest value and vice versa
1040
+			$start_date = min($start_date, $end_date);
1041
+			$end_date = max($start_date, $end_date);
1042
+			// convert for query
1043
+			$start_date = EEM_Change_Log::instance()
1044
+										->convert_datetime_for_query(
1045
+											'LOG_time',
1046
+											date('Y-m-d H:i:s', $start_date),
1047
+											'Y-m-d H:i:s'
1048
+										);
1049
+			$end_date = EEM_Change_Log::instance()
1050
+									  ->convert_datetime_for_query(
1051
+										  'LOG_time',
1052
+										  date('Y-m-d H:i:s', $end_date),
1053
+										  'Y-m-d H:i:s'
1054
+									  );
1055
+			$query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
1056
+		}
1057
+		if ($count) {
1058
+			return EEM_Change_Log::instance()->count($query_params);
1059
+		}
1060
+		if (isset($this->_req_data['order'])) {
1061
+			$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
1062
+				: 'DESC';
1063
+			$query_params['order_by'] = array('LOG_time' => $sort);
1064
+		} else {
1065
+			$query_params['order_by'] = array('LOG_time' => 'DESC');
1066
+		}
1067
+		$offset = ($current_page - 1) * $per_page;
1068
+		if (! isset($this->_req_data['download_results'])) {
1069
+			$query_params['limit'] = array($offset, $per_page);
1070
+		}
1071
+		// now they've requested to instead just download the file instead of viewing it.
1072
+		if (isset($this->_req_data['download_results'])) {
1073
+			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
1074
+			header('Content-Disposition: attachment');
1075
+			header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
1076
+			echo "<h1>Payment Logs for " . site_url() . "</h1>";
1077
+			echo "<h3>Query:</h3>";
1078
+			var_dump($query_params);
1079
+			echo "<h3>Results:</h3>";
1080
+			var_dump($wpdb_results);
1081
+			die;
1082
+		}
1083
+		$results = EEM_Change_Log::instance()->get_all($query_params);
1084
+		return $results;
1085
+	}
1086
+
1087
+
1088
+	/**
1089
+	 * Used by usort to RE-sort log query results, because we lose the ordering
1090
+	 * because we're possibly combining the results from two queries
1091
+	 *
1092
+	 * @param EE_Change_Log $logA
1093
+	 * @param EE_Change_Log $logB
1094
+	 * @return int
1095
+	 */
1096
+	protected function _sort_logs_again($logA, $logB)
1097
+	{
1098
+		$timeA = $logA->get_raw('LOG_time');
1099
+		$timeB = $logB->get_raw('LOG_time');
1100
+		if ($timeA == $timeB) {
1101
+			return 0;
1102
+		}
1103
+		$comparison = $timeA < $timeB ? -1 : 1;
1104
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
1105
+			return $comparison * -1;
1106
+		} else {
1107
+			return $comparison;
1108
+		}
1109
+	}
1110
+
1111
+
1112
+	protected function _payment_log_details()
1113
+	{
1114
+		EE_Registry::instance()->load_model('Change_Log');
1115
+		/** @var $payment_log EE_Change_Log */
1116
+		$payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
1117
+		$payment_method = null;
1118
+		$transaction = null;
1119
+		if ($payment_log instanceof EE_Change_Log) {
1120
+			if ($payment_log->object() instanceof EE_Payment) {
1121
+				$payment_method = $payment_log->object()->payment_method();
1122
+				$transaction = $payment_log->object()->transaction();
1123
+			} elseif ($payment_log->object() instanceof EE_Payment_Method) {
1124
+				$payment_method = $payment_log->object();
1125
+			}
1126
+		}
1127
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
1128
+			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
1129
+			array(
1130
+				'payment_log'    => $payment_log,
1131
+				'payment_method' => $payment_method,
1132
+				'transaction'    => $transaction,
1133
+			),
1134
+			true
1135
+		);
1136
+		$this->display_admin_page_with_sidebar();
1137
+	}
1138 1138
 }
Please login to merge, or discard this patch.
Spacing   +42 added lines, -42 removed lines patch added patch discarded remove patch
@@ -170,7 +170,7 @@  discard block
 block discarded – undo
170 170
         $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
171 171
         $all_pmt_help_tabs_config = array();
172 172
         foreach ($payment_method_types as $payment_method_type) {
173
-            if (! EE_Registry::instance()->CAP->current_user_can(
173
+            if ( ! EE_Registry::instance()->CAP->current_user_can(
174 174
                 $payment_method_type->cap_name(),
175 175
                 'specific_payment_method_type_access'
176 176
             )
@@ -180,10 +180,10 @@  discard block
 block discarded – undo
180 180
             foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
181 181
                 $template_args = isset($config['template_args']) ? $config['template_args'] : array();
182 182
                 $template_args['admin_page_obj'] = $this;
183
-                $all_pmt_help_tabs_config[ $help_tab_name ] = array(
183
+                $all_pmt_help_tabs_config[$help_tab_name] = array(
184 184
                     'title'   => $config['title'],
185 185
                     'content' => EEH_Template::display_template(
186
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
186
+                        $payment_method_type->file_folder().'help_tabs'.DS.$config['filename'].'.help_tab.php',
187 187
                         $template_args,
188 188
                         true
189 189
                     ),
@@ -226,7 +226,7 @@  discard block
 block discarded – undo
226 226
         wp_enqueue_script('ee-text-links');
227 227
         wp_enqueue_script(
228 228
             'espresso_payments',
229
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
229
+            EE_PAYMENTS_ASSETS_URL.'espresso_payments_admin.js',
230 230
             array('espresso-ui-theme', 'ee-datepicker'),
231 231
             EVENT_ESPRESSO_VERSION,
232 232
             true
@@ -239,7 +239,7 @@  discard block
 block discarded – undo
239 239
         // styles
240 240
         wp_register_style(
241 241
             'espresso_payments',
242
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
242
+            EE_PAYMENTS_ASSETS_URL.'ee-payments.css',
243 243
             array(),
244 244
             EVENT_ESPRESSO_VERSION
245 245
         );
@@ -268,7 +268,7 @@  discard block
 block discarded – undo
268 268
                 continue;
269 269
             }
270 270
             // check access
271
-            if (! EE_Registry::instance()->CAP->current_user_can(
271
+            if ( ! EE_Registry::instance()->CAP->current_user_can(
272 272
                 $pmt_obj->cap_name(),
273 273
                 'specific_payment_method_type_access'
274 274
             )
@@ -277,7 +277,7 @@  discard block
 block discarded – undo
277 277
             }
278 278
             // check for any active pms of that type
279 279
             $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
280
-            if (! $payment_method instanceof EE_Payment_Method) {
280
+            if ( ! $payment_method instanceof EE_Payment_Method) {
281 281
                 $payment_method = EE_Payment_Method::new_instance(
282 282
                     array(
283 283
                         'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
@@ -287,7 +287,7 @@  discard block
 block discarded – undo
287 287
                     )
288 288
                 );
289 289
             }
290
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
290
+            $payment_methods[$payment_method->slug()] = $payment_method;
291 291
         }
292 292
         $payment_methods = apply_filters(
293 293
             'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
@@ -297,7 +297,7 @@  discard block
 block discarded – undo
297 297
             if ($payment_method instanceof EE_Payment_Method) {
298 298
                 add_meta_box(
299 299
                     // html id
300
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
300
+                    'espresso_'.$payment_method->slug().'_payment_settings',
301 301
                     // title
302 302
                     sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
303 303
                     // callback
@@ -312,10 +312,10 @@  discard block
 block discarded – undo
312 312
                     array('payment_method' => $payment_method)
313 313
                 );
314 314
                 // setup for tabbed content
315
-                $tabs[ $payment_method->slug() ] = array(
315
+                $tabs[$payment_method->slug()] = array(
316 316
                     'label' => $payment_method->admin_name(),
317 317
                     'class' => $payment_method->active() ? 'gateway-active' : '',
318
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
318
+                    'href'  => 'espresso_'.$payment_method->slug().'_payment_settings',
319 319
                     'title' => __('Modify this Payment Method', 'event_espresso'),
320 320
                     'slug'  => $payment_method->slug(),
321 321
                 );
@@ -346,7 +346,7 @@  discard block
 block discarded – undo
346 346
         }
347 347
         $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
348 348
         // if that didn't work or wasn't provided, find another way to select the current pm
349
-        if (! $this->_verify_payment_method($payment_method)) {
349
+        if ( ! $this->_verify_payment_method($payment_method)) {
350 350
             // like, looking for an active one
351 351
             $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
352 352
             // test that one as well
@@ -395,7 +395,7 @@  discard block
 block discarded – undo
395 395
     {
396 396
         $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
397 397
             ? $metabox['args']['payment_method'] : null;
398
-        if (! $payment_method instanceof EE_Payment_Method) {
398
+        if ( ! $payment_method instanceof EE_Payment_Method) {
399 399
             throw new EE_Error(
400 400
                 sprintf(
401 401
                     __(
@@ -412,7 +412,7 @@  discard block
 block discarded – undo
412 412
             if ($form->form_data_present_in($this->_req_data)) {
413 413
                 $form->receive_form_submission($this->_req_data);
414 414
             }
415
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
415
+            echo $form->form_open().$form->get_html_and_js().$form->form_close();
416 416
         } else {
417 417
             echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
418 418
         }
@@ -428,13 +428,13 @@  discard block
 block discarded – undo
428 428
      */
429 429
     protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
430 430
     {
431
-        if (! $payment_method instanceof EE_Payment_Method) {
431
+        if ( ! $payment_method instanceof EE_Payment_Method) {
432 432
             return new EE_Form_Section_Proper();
433 433
         }
434 434
         return new EE_Form_Section_Proper(
435 435
             array(
436
-                'name'            => $payment_method->slug() . '_settings_form',
437
-                'html_id'         => $payment_method->slug() . '_settings_form',
436
+                'name'            => $payment_method->slug().'_settings_form',
437
+                'html_id'         => $payment_method->slug().'_settings_form',
438 438
                 'action'          => EE_Admin_Page::add_query_args_and_nonce(
439 439
                     array(
440 440
                         'action'         => 'update_payment_method',
@@ -476,7 +476,7 @@  discard block
 block discarded – undo
476 476
                         EEH_HTML::label(
477 477
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
478 478
                         )
479
-                    ) .
479
+                    ).
480 480
                     EEH_HTML::td(
481 481
                         EEH_HTML::strong(
482 482
                             __(
@@ -510,14 +510,14 @@  discard block
 block discarded – undo
510 510
      */
511 511
     protected function _currency_support(EE_Payment_Method $payment_method)
512 512
     {
513
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
513
+        if ( ! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
514 514
             return new EE_Form_Section_HTML(
515 515
                 EEH_HTML::tr(
516 516
                     EEH_HTML::th(
517 517
                         EEH_HTML::label(
518 518
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
519 519
                         )
520
-                    ) .
520
+                    ).
521 521
                     EEH_HTML::td(
522 522
                         EEH_HTML::strong(
523 523
                             sprintf(
@@ -597,7 +597,7 @@  discard block
 block discarded – undo
597 597
         $update_button = new EE_Submit_Input(
598 598
             array(
599 599
                 'name'       => 'submit',
600
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
600
+                'html_id'    => 'save_'.$payment_method->slug().'_settings',
601 601
                 'default'    => sprintf(
602 602
                     __('Update %s Payment Settings', 'event_espresso'),
603 603
                     $payment_method->admin_name()
@@ -606,9 +606,9 @@  discard block
 block discarded – undo
606 606
             )
607 607
         );
608 608
         return new EE_Form_Section_HTML(
609
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
609
+            EEH_HTML::no_row(EEH_HTML::br(2)).
610 610
             EEH_HTML::tr(
611
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
611
+                EEH_HTML::th(__('Update Settings', 'event_espresso')).
612 612
                 EEH_HTML::td(
613 613
                     $update_button->get_html_for_input()
614 614
                 )
@@ -632,7 +632,7 @@  discard block
 block discarded – undo
632 632
         );
633 633
         return new EE_Form_Section_HTML(
634 634
             EEH_HTML::tr(
635
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
635
+                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')).
636 636
                 EEH_HTML::td(
637 637
                     EEH_HTML::link(
638 638
                         EE_Admin_Page::add_query_args_and_nonce(
@@ -644,7 +644,7 @@  discard block
 block discarded – undo
644 644
                         ),
645 645
                         $link_text_and_title,
646 646
                         $link_text_and_title,
647
-                        'deactivate_' . $payment_method->slug(),
647
+                        'deactivate_'.$payment_method->slug(),
648 648
                         'espresso-button button-secondary'
649 649
                     )
650 650
                 )
@@ -668,8 +668,8 @@  discard block
 block discarded – undo
668 668
         );
669 669
         return new EE_Form_Section_Proper(
670 670
             array(
671
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
672
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
671
+                'name'            => 'activate_'.$payment_method->slug().'_settings_form',
672
+                'html_id'         => 'activate_'.$payment_method->slug().'_settings_form',
673 673
                 'action'          => '#',
674 674
                 'layout_strategy' => new EE_Admin_Two_Column_Layout(),
675 675
                 'subsections'     => apply_filters(
@@ -684,11 +684,11 @@  discard block
 block discarded – undo
684 684
                                     '',
685 685
                                     'colspan="2"'
686 686
                                 )
687
-                            ) .
687
+                            ).
688 688
                             EEH_HTML::tr(
689 689
                                 EEH_HTML::th(
690 690
                                     EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
691
-                                ) .
691
+                                ).
692 692
                                 EEH_HTML::td(
693 693
                                     EEH_HTML::link(
694 694
                                         EE_Admin_Page::add_query_args_and_nonce(
@@ -700,7 +700,7 @@  discard block
 block discarded – undo
700 700
                                         ),
701 701
                                         $link_text_and_title,
702 702
                                         $link_text_and_title,
703
-                                        'activate_' . $payment_method->slug(),
703
+                                        'activate_'.$payment_method->slug(),
704 704
                                         'espresso-button-green button-primary'
705 705
                                     )
706 706
                                 )
@@ -724,7 +724,7 @@  discard block
 block discarded – undo
724 724
     {
725 725
         return new EE_Form_Section_HTML(
726 726
             EEH_HTML::tr(
727
-                EEH_HTML::th() .
727
+                EEH_HTML::th().
728 728
                 EEH_HTML::td(
729 729
                     EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
730 730
                 )
@@ -807,7 +807,7 @@  discard block
 block discarded – undo
807 807
                 }
808 808
             }
809 809
             // if we couldn't find the correct payment method type...
810
-            if (! $correct_pmt_form_to_use) {
810
+            if ( ! $correct_pmt_form_to_use) {
811 811
                 EE_Error::add_error(
812 812
                     __(
813 813
                         "We could not find which payment method type your form submission related to. Please contact support",
@@ -822,7 +822,7 @@  discard block
 block discarded – undo
822 822
             $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
823 823
             if ($correct_pmt_form_to_use->is_valid()) {
824 824
                 $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
825
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
825
+                if ( ! $payment_settings_subform instanceof EE_Payment_Method_Form) {
826 826
                     throw new EE_Error(
827 827
                         sprintf(
828 828
                             __(
@@ -874,7 +874,7 @@  discard block
 block discarded – undo
874 874
         $form = $this->getPaymentSettingsForm();
875 875
         $this->_set_add_edit_form_tags('update_payment_settings');
876 876
         $this->_set_publish_post_box_vars(null, false, false, null, false);
877
-        $this->_template_args['admin_page_content'] =  $form->get_html_and_js();
877
+        $this->_template_args['admin_page_content'] = $form->get_html_and_js();
878 878
         $this->display_admin_page_with_sidebar();
879 879
     }
880 880
 
@@ -910,7 +910,7 @@  discard block
 block discarded – undo
910 910
             EE_Registry::instance()->CFG
911 911
         );
912 912
 
913
-        $cfg =  EE_Registry::instance()->CFG ;
913
+        $cfg = EE_Registry::instance()->CFG;
914 914
 
915 915
         $what = __('Payment Settings', 'event_espresso');
916 916
         $success = $this->_update_espresso_configuration(
@@ -1011,7 +1011,7 @@  discard block
 block discarded – undo
1011 1011
         }
1012 1012
         // take into account search
1013 1013
         if (isset($this->_req_data['s']) && $this->_req_data['s']) {
1014
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
1014
+            $similarity_string = array('LIKE', '%'.str_replace("", "%", $this->_req_data['s']).'%');
1015 1015
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
1016 1016
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
1017 1017
             $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
@@ -1031,8 +1031,8 @@  discard block
 block discarded – undo
1031 1031
             $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
1032 1032
             $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
1033 1033
             // make sure our timestamps start and end right at the boundaries for each day
1034
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
1035
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
1034
+            $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
1035
+            $end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59';
1036 1036
             // convert to timestamps
1037 1037
             $start_date = strtotime($start_date);
1038 1038
             $end_date = strtotime($end_date);
@@ -1065,15 +1065,15 @@  discard block
 block discarded – undo
1065 1065
             $query_params['order_by'] = array('LOG_time' => 'DESC');
1066 1066
         }
1067 1067
         $offset = ($current_page - 1) * $per_page;
1068
-        if (! isset($this->_req_data['download_results'])) {
1068
+        if ( ! isset($this->_req_data['download_results'])) {
1069 1069
             $query_params['limit'] = array($offset, $per_page);
1070 1070
         }
1071 1071
         // now they've requested to instead just download the file instead of viewing it.
1072 1072
         if (isset($this->_req_data['download_results'])) {
1073 1073
             $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
1074 1074
             header('Content-Disposition: attachment');
1075
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
1076
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
1075
+            header("Content-Disposition: attachment; filename=ee_payment_logs_for_".sanitize_key(site_url()));
1076
+            echo "<h1>Payment Logs for ".site_url()."</h1>";
1077 1077
             echo "<h3>Query:</h3>";
1078 1078
             var_dump($query_params);
1079 1079
             echo "<h3>Results:</h3>";
@@ -1125,7 +1125,7 @@  discard block
 block discarded – undo
1125 1125
             }
1126 1126
         }
1127 1127
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
1128
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
1128
+            EE_PAYMENTS_TEMPLATE_PATH.'payment_log_details.template.php',
1129 1129
             array(
1130 1130
                 'payment_log'    => $payment_log,
1131 1131
                 'payment_method' => $payment_method,
Please login to merge, or discard this patch.
espresso.php 1 patch
Indentation   +80 added lines, -80 removed lines patch added patch discarded remove patch
@@ -38,103 +38,103 @@
 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
 } else {
64
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
65
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
-        /**
67
-         * espresso_minimum_php_version_error
68
-         *
69
-         * @return void
70
-         */
71
-        function espresso_minimum_php_version_error()
72
-        {
73
-            ?>
64
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
65
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
+		/**
67
+		 * espresso_minimum_php_version_error
68
+		 *
69
+		 * @return void
70
+		 */
71
+		function espresso_minimum_php_version_error()
72
+		{
73
+			?>
74 74
             <div class="error">
75 75
                 <p>
76 76
                     <?php
77
-                    printf(
78
-                        esc_html__(
79
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
-                            'event_espresso'
81
-                        ),
82
-                        EE_MIN_PHP_VER_REQUIRED,
83
-                        PHP_VERSION,
84
-                        '<br/>',
85
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
-                    );
87
-                    ?>
77
+					printf(
78
+						esc_html__(
79
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
+							'event_espresso'
81
+						),
82
+						EE_MIN_PHP_VER_REQUIRED,
83
+						PHP_VERSION,
84
+						'<br/>',
85
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
+					);
87
+					?>
88 88
                 </p>
89 89
             </div>
90 90
             <?php
91
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
92
-        }
91
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
92
+		}
93 93
 
94
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
-    } else {
96
-        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.63.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.63.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');
117
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
118 118
 
119
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
120
-        bootstrap_espresso();
121
-    }
119
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
120
+		bootstrap_espresso();
121
+	}
122 122
 }
123 123
 if (! function_exists('espresso_deactivate_plugin')) {
124
-    /**
125
-     *    deactivate_plugin
126
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
127
-     *
128
-     * @access public
129
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
130
-     * @return    void
131
-     */
132
-    function espresso_deactivate_plugin($plugin_basename = '')
133
-    {
134
-        if (! function_exists('deactivate_plugins')) {
135
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
136
-        }
137
-        unset($_GET['activate'], $_REQUEST['activate']);
138
-        deactivate_plugins($plugin_basename);
139
-    }
124
+	/**
125
+	 *    deactivate_plugin
126
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
127
+	 *
128
+	 * @access public
129
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
130
+	 * @return    void
131
+	 */
132
+	function espresso_deactivate_plugin($plugin_basename = '')
133
+	{
134
+		if (! function_exists('deactivate_plugins')) {
135
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
136
+		}
137
+		unset($_GET['activate'], $_REQUEST['activate']);
138
+		deactivate_plugins($plugin_basename);
139
+	}
140 140
 }
Please login to merge, or discard this patch.
core/domain/services/admin/privacy/forms/PrivacySettingsFormHandler.php 2 patches
Unused Use Statements   -1 removed lines patch added patch discarded remove patch
@@ -13,7 +13,6 @@
 block discarded – undo
13 13
 use EEH_HTML;
14 14
 use EventEspresso\core\exceptions\InvalidFormSubmissionException;
15 15
 use EventEspresso\core\libraries\form_sections\form_handlers\FormHandler;
16
-use EventEspresso\core\services\loaders\LoaderFactory;
17 16
 
18 17
 /**
19 18
  * Class PrivacySettingsFormHandler
Please login to merge, or discard this patch.
Indentation   +97 added lines, -97 removed lines patch added patch discarded remove patch
@@ -28,109 +28,109 @@
 block discarded – undo
28 28
 class PrivacySettingsFormHandler extends FormHandler
29 29
 {
30 30
 
31
-    /**
32
-     * @var EE_Config
33
-     */
34
-    protected $config;
31
+	/**
32
+	 * @var EE_Config
33
+	 */
34
+	protected $config;
35 35
 
36 36
 
37
-    /**
38
-     * PrivacySettingsFormHandler constructor.
39
-     *
40
-     * @param EE_Registry $registry
41
-     * @param EE_Config   $config
42
-     */
43
-    public function __construct(EE_Registry $registry, EE_Config $config)
44
-    {
45
-        $this->config = $config;
46
-        parent::__construct(
47
-            esc_html__('Privacy Settings', 'event_espresso'),
48
-            esc_html__('Privacy Settings', 'event_espresso'),
49
-            'privacy-settings',
50
-            '',
51
-            FormHandler::DO_NOT_SETUP_FORM,
52
-            $registry
53
-        );
54
-    }
37
+	/**
38
+	 * PrivacySettingsFormHandler constructor.
39
+	 *
40
+	 * @param EE_Registry $registry
41
+	 * @param EE_Config   $config
42
+	 */
43
+	public function __construct(EE_Registry $registry, EE_Config $config)
44
+	{
45
+		$this->config = $config;
46
+		parent::__construct(
47
+			esc_html__('Privacy Settings', 'event_espresso'),
48
+			esc_html__('Privacy Settings', 'event_espresso'),
49
+			'privacy-settings',
50
+			'',
51
+			FormHandler::DO_NOT_SETUP_FORM,
52
+			$registry
53
+		);
54
+	}
55 55
 
56 56
 
57
-    /**
58
-     * creates and returns the actual form
59
-     *
60
-     * @return EE_Form_Section_Proper
61
-     */
62
-    public function generate()
63
-    {
64
-        /**
65
-         * @var $reg_config EE_Registration_Config
66
-         */
67
-        $reg_config = $this->config->registration;
68
-        return new EE_Form_Section_Proper(
69
-            array(
70
-                'name'        => 'privacy_consent_settings',
71
-                'subsections' => array(
72
-                    'privacy_consent_form_hdr' => new EE_Form_Section_HTML(
73
-                        EEH_HTML::h2(esc_html__('Privacy Policy Consent Settings', 'event_espresso'))
74
-                    ),
75
-                    'enable'                   => new EE_Select_Reveal_Input(
76
-                        array(
77
-                            'enable-privacy-consent' => esc_html__('Enabled', 'event_espresso'),
78
-                            'disable'                => esc_html__('Disabled', 'event_espresso'),
79
-                        ),
80
-                        array(
81
-                            'default'         => $reg_config->isConsentCheckboxEnabled() ? 'enable-privacy-consent'
82
-                                : 'disable',
83
-                            'html_label_text' => esc_html__('Privacy Consent Checkbox', 'event_espresso'),
84
-                            'html_help_text'  => esc_html__(
85
-                                'When enabled, a checkbox appears in the registration form requiring users to consent to your site\'s privacy policy.',
86
-                                'event_espresso'
87
-                            ),
88
-                        )
89
-                    ),
90
-                    'enable-privacy-consent'   => new EE_Form_Section_Proper(
91
-                        array(
92
-                            'subsections' => array(
93
-                                'consent_assertion' => new EE_Text_Area_Input(
94
-                                    array(
95
-                                        'default'               => $reg_config->getConsentCheckboxLabelText(),
96
-                                        'html_label_text'       => esc_html__('Consent Text', 'event_espresso'),
97
-                                        'html_help_text'        => esc_html__(
98
-                                            'Text describing what the registrant is consenting to by submitting their personal data in the registration form.',
99
-                                            'event_espresso'
100
-                                        ),
101
-                                        'validation_strategies' => array(new EE_Full_HTML_Validation_Strategy()),
102
-                                    )
103
-                                ),
104
-                            ),
105
-                        )
106
-                    ),
107
-                ),
108
-            )
109
-        );
110
-    }
57
+	/**
58
+	 * creates and returns the actual form
59
+	 *
60
+	 * @return EE_Form_Section_Proper
61
+	 */
62
+	public function generate()
63
+	{
64
+		/**
65
+		 * @var $reg_config EE_Registration_Config
66
+		 */
67
+		$reg_config = $this->config->registration;
68
+		return new EE_Form_Section_Proper(
69
+			array(
70
+				'name'        => 'privacy_consent_settings',
71
+				'subsections' => array(
72
+					'privacy_consent_form_hdr' => new EE_Form_Section_HTML(
73
+						EEH_HTML::h2(esc_html__('Privacy Policy Consent Settings', 'event_espresso'))
74
+					),
75
+					'enable'                   => new EE_Select_Reveal_Input(
76
+						array(
77
+							'enable-privacy-consent' => esc_html__('Enabled', 'event_espresso'),
78
+							'disable'                => esc_html__('Disabled', 'event_espresso'),
79
+						),
80
+						array(
81
+							'default'         => $reg_config->isConsentCheckboxEnabled() ? 'enable-privacy-consent'
82
+								: 'disable',
83
+							'html_label_text' => esc_html__('Privacy Consent Checkbox', 'event_espresso'),
84
+							'html_help_text'  => esc_html__(
85
+								'When enabled, a checkbox appears in the registration form requiring users to consent to your site\'s privacy policy.',
86
+								'event_espresso'
87
+							),
88
+						)
89
+					),
90
+					'enable-privacy-consent'   => new EE_Form_Section_Proper(
91
+						array(
92
+							'subsections' => array(
93
+								'consent_assertion' => new EE_Text_Area_Input(
94
+									array(
95
+										'default'               => $reg_config->getConsentCheckboxLabelText(),
96
+										'html_label_text'       => esc_html__('Consent Text', 'event_espresso'),
97
+										'html_help_text'        => esc_html__(
98
+											'Text describing what the registrant is consenting to by submitting their personal data in the registration form.',
99
+											'event_espresso'
100
+										),
101
+										'validation_strategies' => array(new EE_Full_HTML_Validation_Strategy()),
102
+									)
103
+								),
104
+							),
105
+						)
106
+					),
107
+				),
108
+			)
109
+		);
110
+	}
111 111
 
112 112
 
113
-    /**
114
-     * After validating the form data, update the registration config
115
-     *
116
-     * @param array $submitted_form_data
117
-     * @return bool
118
-     */
119
-    public function process($submitted_form_data = array())
120
-    {
121
-        try {
122
-            $valid_data = parent::process($submitted_form_data);
123
-            $reg_config = $this->config->registration;
124
-            $reg_config->setConsentCheckboxEnabled($valid_data['enable'] === 'enable-privacy-consent');
125
-            $reg_config->setConsentCheckboxLabelText(
126
-                $valid_data['enable-privacy-consent']['consent_assertion']
127
-            );
128
-            return $this->config->update_espresso_config(false, false);
129
-        } catch (InvalidFormSubmissionException $e) {
130
-            //the form was invalid, it show be re-displayed with errors
131
-            return false;
132
-        }
133
-    }
113
+	/**
114
+	 * After validating the form data, update the registration config
115
+	 *
116
+	 * @param array $submitted_form_data
117
+	 * @return bool
118
+	 */
119
+	public function process($submitted_form_data = array())
120
+	{
121
+		try {
122
+			$valid_data = parent::process($submitted_form_data);
123
+			$reg_config = $this->config->registration;
124
+			$reg_config->setConsentCheckboxEnabled($valid_data['enable'] === 'enable-privacy-consent');
125
+			$reg_config->setConsentCheckboxLabelText(
126
+				$valid_data['enable-privacy-consent']['consent_assertion']
127
+			);
128
+			return $this->config->update_espresso_config(false, false);
129
+		} catch (InvalidFormSubmissionException $e) {
130
+			//the form was invalid, it show be re-displayed with errors
131
+			return false;
132
+		}
133
+	}
134 134
 }
135 135
 // End of file PrivacySettingsFormHandler.php
136 136
 // Location: EventEspresso\core\domain\services\admin\privacy\forms/PrivacySettingsFormHandler.php
Please login to merge, or discard this patch.
admin_pages/general_settings/General_Settings_Admin_Page.core.php 1 patch
Indentation   +1446 added lines, -1446 removed lines patch added patch discarded remove patch
@@ -18,1462 +18,1462 @@
 block discarded – undo
18 18
 {
19 19
 
20 20
 
21
-    /**
22
-     * _question_group
23
-     * holds the specific question group object for the question group details screen
24
-     *
25
-     * @var object
26
-     */
27
-    protected $_question_group;
28
-
29
-
30
-    /**
31
-     * Initialize basic properties.
32
-     */
33
-    protected function _init_page_props()
34
-    {
35
-        $this->page_slug = GEN_SET_PG_SLUG;
36
-        $this->page_label = GEN_SET_LABEL;
37
-        $this->_admin_base_url = GEN_SET_ADMIN_URL;
38
-        $this->_admin_base_path = GEN_SET_ADMIN;
39
-    }
40
-
41
-
42
-    /**
43
-     * Set ajax hooks
44
-     */
45
-    protected function _ajax_hooks()
46
-    {
47
-        add_action('wp_ajax_espresso_display_country_settings', array($this, 'display_country_settings'));
48
-        add_action('wp_ajax_espresso_display_country_states', array($this, 'display_country_states'));
49
-        add_action('wp_ajax_espresso_delete_state', array($this, 'delete_state'), 10, 3);
50
-        add_action('wp_ajax_espresso_add_new_state', array($this, 'add_new_state'));
51
-    }
52
-
53
-
54
-    /**
55
-     * More page properties initialization.
56
-     */
57
-    protected function _define_page_props()
58
-    {
59
-        $this->_admin_page_title = GEN_SET_LABEL;
60
-        $this->_labels = array(
61
-            'publishbox' => __('Update Settings', 'event_espresso'),
62
-        );
63
-    }
64
-
65
-
66
-    /**
67
-     * Set page routes property.
68
-     */
69
-    protected function _set_page_routes()
70
-    {
71
-        $this->_page_routes = array(
72
-
73
-            'critical_pages'                => array(
74
-                'func'       => '_espresso_page_settings',
75
-                'capability' => 'manage_options',
76
-            ),
77
-            'update_espresso_page_settings' => array(
78
-                'func'       => '_update_espresso_page_settings',
79
-                'capability' => 'manage_options',
80
-                'noheader'   => true,
81
-            ),
82
-            'default'                       => array(
83
-                'func'       => '_your_organization_settings',
84
-                'capability' => 'manage_options',
85
-            ),
86
-
87
-            'update_your_organization_settings' => array(
88
-                'func'       => '_update_your_organization_settings',
89
-                'capability' => 'manage_options',
90
-                'noheader'   => true,
91
-            ),
92
-
93
-            'admin_option_settings' => array(
94
-                'func'       => '_admin_option_settings',
95
-                'capability' => 'manage_options',
96
-            ),
97
-
98
-            'update_admin_option_settings' => array(
99
-                'func'       => '_update_admin_option_settings',
100
-                'capability' => 'manage_options',
101
-                'noheader'   => true,
102
-            ),
103
-
104
-            'country_settings' => array(
105
-                'func'       => '_country_settings',
106
-                'capability' => 'manage_options',
107
-            ),
108
-
109
-            'update_country_settings' => array(
110
-                'func'       => '_update_country_settings',
111
-                'capability' => 'manage_options',
112
-                'noheader'   => true,
113
-            ),
114
-
115
-            'display_country_settings' => array(
116
-                'func'       => 'display_country_settings',
117
-                'capability' => 'manage_options',
118
-                'noheader'   => true,
119
-            ),
120
-
121
-            'add_new_state' => array(
122
-                'func'       => 'add_new_state',
123
-                'capability' => 'manage_options',
124
-                'noheader'   => true,
125
-            ),
126
-
127
-            'delete_state' => array(
128
-                'func'       => 'delete_state',
129
-                'capability' => 'manage_options',
130
-                'noheader'   => true,
131
-            ),
132
-            'privacy_settings' => array(
133
-                'func' => 'privacySettings',
134
-                'capability' => 'manage_options',
135
-            ),
136
-            'update_privacy_settings' => array(
137
-                'func' => 'updatePrivacySettings',
138
-                'capability' => 'manage_options',
139
-                'noheader' => true,
140
-                'headers_sent_route' => 'privacy_settings'
141
-            )
142
-        );
143
-    }
144
-
145
-
146
-    /**
147
-     * Set page configuration property
148
-     */
149
-    protected function _set_page_config()
150
-    {
151
-        $this->_page_config = array(
152
-            'critical_pages'        => array(
153
-                'nav'           => array(
154
-                    'label' => __('Critical Pages', 'event_espresso'),
155
-                    'order' => 50,
156
-                ),
157
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
158
-                'help_tabs'     => array(
159
-                    'general_settings_critical_pages_help_tab' => array(
160
-                        'title'    => __('Critical Pages', 'event_espresso'),
161
-                        'filename' => 'general_settings_critical_pages',
162
-                    ),
163
-                ),
164
-                'help_tour'     => array('Critical_Pages_Help_Tour'),
165
-                'require_nonce' => false,
166
-            ),
167
-            'default'               => array(
168
-                'nav'           => array(
169
-                    'label' => __('Your Organization', 'event_espresso'),
170
-                    'order' => 20,
171
-                ),
172
-                'help_tabs'     => array(
173
-                    'general_settings_your_organization_help_tab' => array(
174
-                        'title'    => __('Your Organization', 'event_espresso'),
175
-                        'filename' => 'general_settings_your_organization',
176
-                    ),
177
-                ),
178
-                'help_tour'     => array('Your_Organization_Help_Tour'),
179
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
180
-                'require_nonce' => false,
181
-            ),
182
-            'admin_option_settings' => array(
183
-                'nav'           => array(
184
-                    'label' => __('Admin Options', 'event_espresso'),
185
-                    'order' => 60,
186
-                ),
187
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
188
-                'help_tabs'     => array(
189
-                    'general_settings_admin_options_help_tab' => array(
190
-                        'title'    => __('Admin Options', 'event_espresso'),
191
-                        'filename' => 'general_settings_admin_options',
192
-                    ),
193
-                ),
194
-                'help_tour'     => array('Admin_Options_Help_Tour'),
195
-                'require_nonce' => false,
196
-            ),
197
-            'country_settings'      => array(
198
-                'nav'           => array(
199
-                    'label' => __('Countries', 'event_espresso'),
200
-                    'order' => 70,
201
-                ),
202
-                'help_tabs'     => array(
203
-                    'general_settings_countries_help_tab' => array(
204
-                        'title'    => __('Countries', 'event_espresso'),
205
-                        'filename' => 'general_settings_countries',
206
-                    ),
207
-                ),
208
-                'help_tour'     => array('Countries_Help_Tour'),
209
-                'require_nonce' => false,
210
-            ),
211
-            'privacy_settings' => array(
212
-                'nav' => array(
213
-                    'label' => esc_html__('Privacy', 'event_espresso'),
214
-                    'order' => 80
215
-                ),
216
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
217
-                'require_nonce' => false
218
-            )
219
-        );
220
-    }
221
-
222
-
223
-    protected function _add_screen_options()
224
-    {
225
-    }
226
-
227
-    protected function _add_feature_pointers()
228
-    {
229
-    }
230
-
231
-
232
-    /**
233
-     * Enqueue global scripts and styles for all routes in the General Settings Admin Pages.
234
-     */
235
-    public function load_scripts_styles()
236
-    {
237
-        // styles
238
-        wp_enqueue_style('espresso-ui-theme');
239
-        // scripts
240
-        wp_enqueue_script('ee_admin_js');
241
-    }
242
-
243
-
244
-    /**
245
-     * Execute logic running on `admin_init`
246
-     */
247
-    public function admin_init()
248
-    {
249
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = __(
250
-            'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
251
-            'event_espresso'
252
-        );
253
-        EE_Registry::$i18n_js_strings['error_occurred'] = __(
254
-            'An error occurred! Please refresh the page and try again.',
255
-            'event_espresso'
256
-        );
257
-        EE_Registry::$i18n_js_strings['confirm_delete_state'] = __(
258
-            'Are you sure you want to delete this State / Province?',
259
-            'event_espresso'
260
-        );
261
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
262
-        EE_Registry::$i18n_js_strings['ajax_url'] = admin_url(
263
-            'admin-ajax.php?page=espresso_general_settings',
264
-            $protocol
265
-        );
266
-    }
267
-
268
-    public function admin_notices()
269
-    {
270
-    }
271
-
272
-    public function admin_footer_scripts()
273
-    {
274
-    }
275
-
276
-
277
-    /**
278
-     * Enqueue scripts and styles for the default route.
279
-     */
280
-    public function load_scripts_styles_default()
281
-    {
282
-        // styles
283
-        wp_enqueue_style('thickbox');
284
-        // scripts
285
-        wp_enqueue_script('media-upload');
286
-        wp_enqueue_script('thickbox');
287
-        wp_register_script(
288
-            'organization_settings',
289
-            GEN_SET_ASSETS_URL . 'your_organization_settings.js',
290
-            array('jquery', 'media-upload', 'thickbox'),
291
-            EVENT_ESPRESSO_VERSION,
292
-            true
293
-        );
294
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', array(), EVENT_ESPRESSO_VERSION);
295
-        wp_enqueue_script('organization_settings');
296
-        wp_enqueue_style('organization-css');
297
-        $confirm_image_delete = array(
298
-            'text' => __(
299
-                'Do you really want to delete this image? Please remember to save your settings to complete the removal.',
300
-                'event_espresso'
301
-            ),
302
-        );
303
-        wp_localize_script('organization_settings', 'confirm_image_delete', $confirm_image_delete);
304
-    }
305
-
306
-
307
-    /**
308
-     * Enqueue scripts and styles for the country settings route.
309
-     */
310
-    public function load_scripts_styles_country_settings()
311
-    {
312
-        // scripts
313
-        wp_register_script(
314
-            'gen_settings_countries',
315
-            GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
316
-            array('ee_admin_js'),
317
-            EVENT_ESPRESSO_VERSION,
318
-            true
319
-        );
320
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', array(), EVENT_ESPRESSO_VERSION);
321
-        wp_enqueue_script('gen_settings_countries');
322
-        wp_enqueue_style('organization-css');
323
-    }
324
-
325
-
326
-    /*************        Espresso Pages        *************/
327
-    /**
328
-     * _espresso_page_settings
329
-     *
330
-     * @throws \EE_Error
331
-     */
332
-    protected function _espresso_page_settings()
333
-    {
334
-        // Check to make sure all of the main pages are setup properly,
335
-        // if not create the default pages and display an admin notice
336
-        EEH_Activation::verify_default_pages_exist();
337
-        $this->_transient_garbage_collection();
338
-        $this->_template_args['values'] = $this->_yes_no_values;
339
-        $this->_template_args['reg_page_id'] = isset(EE_Registry::instance()->CFG->core->reg_page_id)
340
-            ? EE_Registry::instance()->CFG->core->reg_page_id
341
-            : null;
342
-        $this->_template_args['reg_page_obj'] = isset(EE_Registry::instance()->CFG->core->reg_page_id)
343
-            ? get_page(EE_Registry::instance()->CFG->core->reg_page_id)
344
-            : false;
345
-        $this->_template_args['txn_page_id'] = isset(EE_Registry::instance()->CFG->core->txn_page_id)
346
-            ? EE_Registry::instance()->CFG->core->txn_page_id
347
-            : null;
348
-        $this->_template_args['txn_page_obj'] = isset(EE_Registry::instance()->CFG->core->txn_page_id)
349
-            ? get_page(EE_Registry::instance()->CFG->core->txn_page_id)
350
-            : false;
351
-        $this->_template_args['thank_you_page_id'] = isset(EE_Registry::instance()->CFG->core->thank_you_page_id)
352
-            ? EE_Registry::instance()->CFG->core->thank_you_page_id
353
-            : null;
354
-        $this->_template_args['thank_you_page_obj'] = isset(EE_Registry::instance()->CFG->core->thank_you_page_id)
355
-            ? get_page(EE_Registry::instance()->CFG->core->thank_you_page_id)
356
-            : false;
357
-        $this->_template_args['cancel_page_id'] = isset(EE_Registry::instance()->CFG->core->cancel_page_id)
358
-            ? EE_Registry::instance()->CFG->core->cancel_page_id
359
-            : null;
360
-        $this->_template_args['cancel_page_obj'] = isset(EE_Registry::instance()->CFG->core->cancel_page_id)
361
-            ? get_page(EE_Registry::instance()->CFG->core->cancel_page_id)
362
-            : false;
363
-        $this->_set_add_edit_form_tags('update_espresso_page_settings');
364
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
365
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
366
-            GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
367
-            $this->_template_args,
368
-            true
369
-        );
370
-        $this->display_admin_page_with_sidebar();
371
-    }
372
-
373
-
374
-    /**
375
-     * Handler for updating espresso page settings.
376
-     */
377
-    protected function _update_espresso_page_settings()
378
-    {
379
-        // capture incoming request data && set page IDs
380
-        EE_Registry::instance()->CFG->core->reg_page_id = isset($this->_req_data['reg_page_id'])
381
-            ? absint($this->_req_data['reg_page_id'])
382
-            : EE_Registry::instance()->CFG->core->reg_page_id;
383
-        EE_Registry::instance()->CFG->core->txn_page_id = isset($this->_req_data['txn_page_id'])
384
-            ? absint($this->_req_data['txn_page_id'])
385
-            : EE_Registry::instance()->CFG->core->txn_page_id;
386
-        EE_Registry::instance()->CFG->core->thank_you_page_id = isset($this->_req_data['thank_you_page_id'])
387
-            ? absint($this->_req_data['thank_you_page_id'])
388
-            : EE_Registry::instance()->CFG->core->thank_you_page_id;
389
-        EE_Registry::instance()->CFG->core->cancel_page_id = isset($this->_req_data['cancel_page_id'])
390
-            ? absint($this->_req_data['cancel_page_id'])
391
-            : EE_Registry::instance()->CFG->core->cancel_page_id;
392
-
393
-        EE_Registry::instance()->CFG->core = apply_filters(
394
-            'FHEE__General_Settings_Admin_Page___update_espresso_page_settings__CFG_core',
395
-            EE_Registry::instance()->CFG->core,
396
-            $this->_req_data
397
-        );
398
-        $what = __('Critical Pages & Shortcodes', 'event_espresso');
399
-        $this->_redirect_after_action(
400
-            $this->_update_espresso_configuration(
401
-                $what,
402
-                EE_Registry::instance()->CFG->core,
403
-                __FILE__,
404
-                __FUNCTION__,
405
-                __LINE__
406
-            ),
407
-            $what,
408
-            '',
409
-            array(
410
-                'action' => 'critical_pages',
411
-            ),
412
-            true
413
-        );
414
-    }
415
-
416
-
417
-    /*************        Your Organization        *************/
418
-
419
-
420
-    /**
421
-     * Output for the Your Organization settings route.
422
-     *
423
-     * @throws DomainException
424
-     * @throws EE_Error
425
-     */
426
-    protected function _your_organization_settings()
427
-    {
428
-
429
-        $this->_template_args['site_license_key'] = isset(
430
-            EE_Registry::instance()->NET_CFG->core->site_license_key
431
-        )
432
-            ? EE_Registry::instance()->NET_CFG->core->get_pretty('site_license_key')
433
-            : '';
434
-        $this->_template_args['organization_name'] = isset(EE_Registry::instance()->CFG->organization->name)
435
-            ? EE_Registry::instance()->CFG->organization->get_pretty('name')
436
-            : '';
437
-        $this->_template_args['organization_address_1'] = isset(EE_Registry::instance()->CFG->organization->address_1)
438
-            ? EE_Registry::instance()->CFG->organization->get_pretty('address_1')
439
-            : '';
440
-        $this->_template_args['organization_address_2'] = isset(EE_Registry::instance()->CFG->organization->address_2)
441
-            ? EE_Registry::instance()->CFG->organization->get_pretty('address_2')
442
-            : '';
443
-        $this->_template_args['organization_city'] = isset(EE_Registry::instance()->CFG->organization->city)
444
-            ? EE_Registry::instance()->CFG->organization->get_pretty('city')
445
-            : '';
446
-        $this->_template_args['organization_zip'] = isset(EE_Registry::instance()->CFG->organization->zip)
447
-            ? EE_Registry::instance()->CFG->organization->get_pretty('zip')
448
-            : '';
449
-        $this->_template_args['organization_email'] = isset(EE_Registry::instance()->CFG->organization->email)
450
-            ? EE_Registry::instance()->CFG->organization->get_pretty('email')
451
-            : '';
452
-        $this->_template_args['organization_phone'] = isset(EE_Registry::instance()->CFG->organization->phone)
453
-            ? EE_Registry::instance()->CFG->organization->get_pretty('phone')
454
-            : '';
455
-        $this->_template_args['organization_vat'] = isset(EE_Registry::instance()->CFG->organization->vat)
456
-            ? EE_Registry::instance()->CFG->organization->get_pretty('vat')
457
-            : '';
458
-        $this->_template_args['currency_sign'] = isset(EE_Registry::instance()->CFG->currency->sign)
459
-            ? EE_Registry::instance()->CFG->currency->get_pretty('sign')
460
-            : '$';
461
-        $this->_template_args['organization_logo_url'] = isset(EE_Registry::instance()->CFG->organization->logo_url)
462
-            ? EE_Registry::instance()->CFG->organization->get_pretty('logo_url')
463
-            : false;
464
-        $this->_template_args['organization_facebook'] = isset(EE_Registry::instance()->CFG->organization->facebook)
465
-            ? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
466
-            : '';
467
-        $this->_template_args['organization_twitter'] = isset(EE_Registry::instance()->CFG->organization->twitter)
468
-            ? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
469
-            : '';
470
-        $this->_template_args['organization_linkedin'] = isset(EE_Registry::instance()->CFG->organization->linkedin)
471
-            ? EE_Registry::instance()->CFG->organization->get_pretty('linkedin')
472
-            : '';
473
-        $this->_template_args['organization_pinterest'] = isset(EE_Registry::instance()->CFG->organization->pinterest)
474
-            ? EE_Registry::instance()->CFG->organization->get_pretty('pinterest')
475
-            : '';
476
-        $this->_template_args['organization_google'] = isset(EE_Registry::instance()->CFG->organization->google)
477
-            ? EE_Registry::instance()->CFG->organization->get_pretty('google')
478
-            : '';
479
-        $this->_template_args['organization_instagram'] = isset(EE_Registry::instance()->CFG->organization->instagram)
480
-            ? EE_Registry::instance()->CFG->organization->get_pretty('instagram')
481
-            : '';
482
-        // UXIP settings
483
-        $this->_template_args['ee_ueip_optin'] = isset(EE_Registry::instance()->CFG->core->ee_ueip_optin)
484
-            ? EE_Registry::instance()->CFG->core->get_pretty('ee_ueip_optin')
485
-            : 'yes';
486
-
487
-        $STA_ID = isset(EE_Registry::instance()->CFG->organization->STA_ID)
488
-            ? EE_Registry::instance()->CFG->organization->STA_ID
489
-            : 4;
490
-        $this->_template_args['states'] = new EE_Question_Form_Input(
491
-            EE_Question::new_instance(
492
-                array(
493
-                    'QST_ID'           => 0,
494
-                    'QST_display_text' => __('State/Province', 'event_espresso'),
495
-                    'QST_system'       => 'admin-state',
496
-                )
497
-            ),
498
-            EE_Answer::new_instance(
499
-                array(
500
-                    'ANS_ID'    => 0,
501
-                    'ANS_value' => $STA_ID,
502
-                )
503
-            ),
504
-            array(
505
-                'input_id'       => 'organization_state',
506
-                'input_name'     => 'organization_state',
507
-                'input_prefix'   => '',
508
-                'append_qstn_id' => false,
509
-            )
510
-        );
511
-
512
-        $CNT_ISO = isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
513
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
514
-            : 'US';
515
-        $this->_template_args['countries'] = new EE_Question_Form_Input(
516
-            EE_Question::new_instance(
517
-                array(
518
-                    'QST_ID'           => 0,
519
-                    'QST_display_text' => __('Country', 'event_espresso'),
520
-                    'QST_system'       => 'admin-country',
521
-                )
522
-            ),
523
-            EE_Answer::new_instance(
524
-                array(
525
-                    'ANS_ID'    => 0,
526
-                    'ANS_value' => $CNT_ISO,
527
-                )
528
-            ),
529
-            array(
530
-                'input_id'       => 'organization_country',
531
-                'input_name'     => 'organization_country',
532
-                'input_prefix'   => '',
533
-                'append_qstn_id' => false,
534
-            )
535
-        );
536
-
537
-        add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
538
-        add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
539
-
540
-        // PUE verification stuff
541
-        $ver_option_key = 'puvererr_' . basename(EE_PLUGIN_BASENAME);
542
-        $verify_fail = get_option($ver_option_key);
543
-        $this->_template_args['site_license_key_verified'] = $verify_fail
544
-                                                             || ! empty($verify_fail)
545
-                                                             || (empty($this->_template_args['site_license_key'])
546
-                                                                 && empty($verify_fail)
547
-                                                             )
548
-            ? '<span class="dashicons dashicons-admin-network ee-icon-color-ee-red ee-icon-size-20"></span>'
549
-            : '<span class="dashicons dashicons-admin-network ee-icon-color-ee-green ee-icon-size-20"></span>';
550
-
551
-        $this->_set_add_edit_form_tags('update_your_organization_settings');
552
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
553
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
554
-            GEN_SET_TEMPLATE_PATH . 'your_organization_settings.template.php',
555
-            $this->_template_args,
556
-            true
557
-        );
558
-
559
-        $this->display_admin_page_with_sidebar();
560
-    }
561
-
562
-
563
-    /**
564
-     * Handler for updating organziation settings.
565
-     */
566
-    protected function _update_your_organization_settings()
567
-    {
568
-        if (is_main_site()) {
569
-            EE_Registry::instance()->NET_CFG->core->site_license_key = isset($this->_req_data['site_license_key'])
570
-                ? sanitize_text_field($this->_req_data['site_license_key'])
571
-                : EE_Registry::instance()->NET_CFG->core->site_license_key;
572
-        }
573
-        EE_Registry::instance()->CFG->organization->name = isset($this->_req_data['organization_name'])
574
-            ? sanitize_text_field($this->_req_data['organization_name'])
575
-            : EE_Registry::instance()->CFG->organization->name;
576
-        EE_Registry::instance()->CFG->organization->address_1 = isset($this->_req_data['organization_address_1'])
577
-            ? sanitize_text_field($this->_req_data['organization_address_1'])
578
-            : EE_Registry::instance()->CFG->organization->address_1;
579
-        EE_Registry::instance()->CFG->organization->address_2 = isset($this->_req_data['organization_address_2'])
580
-            ? sanitize_text_field($this->_req_data['organization_address_2'])
581
-            : EE_Registry::instance()->CFG->organization->address_2;
582
-        EE_Registry::instance()->CFG->organization->city = isset($this->_req_data['organization_city'])
583
-            ? sanitize_text_field($this->_req_data['organization_city'])
584
-            : EE_Registry::instance()->CFG->organization->city;
585
-        EE_Registry::instance()->CFG->organization->STA_ID = isset($this->_req_data['organization_state'])
586
-            ? absint($this->_req_data['organization_state'])
587
-            : EE_Registry::instance()->CFG->organization->STA_ID;
588
-        EE_Registry::instance()->CFG->organization->CNT_ISO = isset($this->_req_data['organization_country'])
589
-            ? sanitize_text_field($this->_req_data['organization_country'])
590
-            : EE_Registry::instance()->CFG->organization->CNT_ISO;
591
-        EE_Registry::instance()->CFG->organization->zip = isset($this->_req_data['organization_zip'])
592
-            ? sanitize_text_field($this->_req_data['organization_zip'])
593
-            : EE_Registry::instance()->CFG->organization->zip;
594
-        EE_Registry::instance()->CFG->organization->email = isset($this->_req_data['organization_email'])
595
-            ? sanitize_email($this->_req_data['organization_email'])
596
-            : EE_Registry::instance()->CFG->organization->email;
597
-        EE_Registry::instance()->CFG->organization->vat = isset($this->_req_data['organization_vat'])
598
-            ? sanitize_text_field($this->_req_data['organization_vat'])
599
-            : EE_Registry::instance()->CFG->organization->vat;
600
-        EE_Registry::instance()->CFG->organization->phone = isset($this->_req_data['organization_phone'])
601
-            ? sanitize_text_field($this->_req_data['organization_phone'])
602
-            : EE_Registry::instance()->CFG->organization->phone;
603
-        EE_Registry::instance()->CFG->organization->logo_url = isset($this->_req_data['organization_logo_url'])
604
-            ? esc_url_raw($this->_req_data['organization_logo_url'])
605
-            : EE_Registry::instance()->CFG->organization->logo_url;
606
-        EE_Registry::instance()->CFG->organization->facebook = isset($this->_req_data['organization_facebook'])
607
-            ? esc_url_raw($this->_req_data['organization_facebook'])
608
-            : EE_Registry::instance()->CFG->organization->facebook;
609
-        EE_Registry::instance()->CFG->organization->twitter = isset($this->_req_data['organization_twitter'])
610
-            ? esc_url_raw($this->_req_data['organization_twitter'])
611
-            : EE_Registry::instance()->CFG->organization->twitter;
612
-        EE_Registry::instance()->CFG->organization->linkedin = isset($this->_req_data['organization_linkedin'])
613
-            ? esc_url_raw($this->_req_data['organization_linkedin'])
614
-            : EE_Registry::instance()->CFG->organization->linkedin;
615
-        EE_Registry::instance()->CFG->organization->pinterest = isset($this->_req_data['organization_pinterest'])
616
-            ? esc_url_raw($this->_req_data['organization_pinterest'])
617
-            : EE_Registry::instance()->CFG->organization->pinterest;
618
-        EE_Registry::instance()->CFG->organization->google = isset($this->_req_data['organization_google'])
619
-            ? esc_url_raw($this->_req_data['organization_google'])
620
-            : EE_Registry::instance()->CFG->organization->google;
621
-        EE_Registry::instance()->CFG->organization->instagram = isset($this->_req_data['organization_instagram'])
622
-            ? esc_url_raw($this->_req_data['organization_instagram'])
623
-            : EE_Registry::instance()->CFG->organization->instagram;
624
-        EE_Registry::instance()->CFG->core->ee_ueip_optin = isset($this->_req_data['ueip_optin'])
625
-                                                            && ! empty($this->_req_data['ueip_optin'])
626
-            ? filter_var($this->_req_data['ueip_optin'], FILTER_VALIDATE_BOOLEAN)
627
-            : EE_Registry::instance()->CFG->core->ee_ueip_optin;
628
-
629
-        EE_Registry::instance()->CFG->currency = new EE_Currency_Config(
630
-            EE_Registry::instance()->CFG->organization->CNT_ISO
631
-        );
632
-
633
-        EE_Registry::instance()->CFG = apply_filters(
634
-            'FHEE__General_Settings_Admin_Page___update_your_organization_settings__CFG',
635
-            EE_Registry::instance()->CFG
636
-        );
637
-
638
-        $what = 'Your Organization Settings';
639
-        $success = $this->_update_espresso_configuration(
640
-            $what,
641
-            EE_Registry::instance()->CFG,
642
-            __FILE__,
643
-            __FUNCTION__,
644
-            __LINE__
645
-        );
646
-
647
-        $this->_redirect_after_action($success, $what, 'updated', array('action' => 'default'));
648
-    }
649
-
650
-
651
-
652
-    /*************        Admin Options        *************/
653
-
654
-
655
-    /**
656
-     * _admin_option_settings
657
-     *
658
-     * @throws \EE_Error
659
-     * @throws \LogicException
660
-     */
661
-    protected function _admin_option_settings()
662
-    {
663
-        $this->_template_args['admin_page_content'] = '';
664
-        try {
665
-            $admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
666
-            // still need this for the old school form in Extend_General_Settings_Admin_Page
667
-            $this->_template_args['values'] = $this->_yes_no_values;
668
-            // also need to account for the do_action that was in the old template
669
-            $admin_options_settings_form->setTemplateArgs($this->_template_args);
670
-            $this->_template_args['admin_page_content'] = $admin_options_settings_form->display();
671
-        } catch (Exception $e) {
672
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
673
-        }
674
-        $this->_set_add_edit_form_tags('update_admin_option_settings');
675
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
676
-        $this->display_admin_page_with_sidebar();
677
-    }
678
-
679
-
680
-    /**
681
-     * _update_admin_option_settings
682
-     *
683
-     * @throws \EE_Error
684
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
685
-     * @throws \EventEspresso\core\exceptions\InvalidFormSubmissionException
686
-     * @throws \InvalidArgumentException
687
-     * @throws \LogicException
688
-     */
689
-    protected function _update_admin_option_settings()
690
-    {
691
-        try {
692
-            $admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
693
-            $admin_options_settings_form->process($this->_req_data[ $admin_options_settings_form->slug() ]);
694
-            EE_Registry::instance()->CFG->admin = apply_filters(
695
-                'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin',
696
-                EE_Registry::instance()->CFG->admin
697
-            );
698
-        } catch (Exception $e) {
699
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
700
-        }
701
-        $this->_redirect_after_action(
702
-            apply_filters(
703
-                'FHEE__General_Settings_Admin_Page___update_admin_option_settings__success',
704
-                $this->_update_espresso_configuration(
705
-                    'Admin Options',
706
-                    EE_Registry::instance()->CFG->admin,
707
-                    __FILE__,
708
-                    __FUNCTION__,
709
-                    __LINE__
710
-                )
711
-            ),
712
-            'Admin Options',
713
-            'updated',
714
-            array('action' => 'admin_option_settings')
715
-        );
716
-    }
717
-
718
-
719
-    /*************        Countries        *************/
720
-
721
-
722
-    /**
723
-     * Output Country Settings view.
724
-     *
725
-     * @throws DomainException
726
-     * @throws EE_Error
727
-     */
728
-    protected function _country_settings()
729
-    {
730
-        $CNT_ISO = isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
731
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
732
-            : 'US';
733
-        $CNT_ISO = isset($this->_req_data['country'])
734
-            ? strtoupper(sanitize_text_field($this->_req_data['country']))
735
-            : $CNT_ISO;
736
-
737
-        // load field generator helper
738
-
739
-        $this->_template_args['values'] = $this->_yes_no_values;
740
-
741
-        $this->_template_args['countries'] = new EE_Question_Form_Input(
742
-            EE_Question::new_instance(
743
-                array(
744
-                    'QST_ID'           => 0,
745
-                    'QST_display_text' => __('Select Country', 'event_espresso'),
746
-                    'QST_system'       => 'admin-country',
747
-                )
748
-            ),
749
-            EE_Answer::new_instance(
750
-                array(
751
-                    'ANS_ID'    => 0,
752
-                    'ANS_value' => $CNT_ISO,
753
-                )
754
-            ),
755
-            array(
756
-                'input_id'       => 'country',
757
-                'input_name'     => 'country',
758
-                'input_prefix'   => '',
759
-                'append_qstn_id' => false,
760
-            )
761
-        );
762
-
763
-        add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
764
-        add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
765
-        $this->_template_args['country_details_settings'] = $this->display_country_settings();
766
-        $this->_template_args['country_states_settings'] = $this->display_country_states();
767
-
768
-        $this->_set_add_edit_form_tags('update_country_settings');
769
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
770
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
771
-            GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
772
-            $this->_template_args,
773
-            true
774
-        );
775
-        $this->display_admin_page_with_no_sidebar();
776
-    }
777
-
778
-
779
-    /**
780
-     *        display_country_settings
781
-     *
782
-     * @access    public
783
-     * @param    string $CNT_ISO
784
-     * @return mixed string | array
785
-     * @throws DomainException
786
-     */
787
-    public function display_country_settings($CNT_ISO = '')
788
-    {
789
-
790
-        $CNT_ISO = isset($this->_req_data['country'])
791
-            ? strtoupper(sanitize_text_field($this->_req_data['country']))
792
-            : $CNT_ISO;
793
-        if (! $CNT_ISO) {
794
-            return '';
795
-        }
796
-
797
-        // for ajax
798
-        remove_all_filters('FHEE__EEH_Form_Fields__label_html');
799
-        remove_all_filters('FHEE__EEH_Form_Fields__input_html');
800
-        add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
801
-        add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
802
-        $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
803
-
804
-        $country_input_types = array(
805
-            'CNT_active'      => array(
806
-                'type'             => 'RADIO_BTN',
807
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
808
-                'class'            => '',
809
-                'options'          => $this->_yes_no_values,
810
-                'use_desc_4_label' => true,
811
-            ),
812
-            'CNT_ISO'         => array(
813
-                'type'       => 'TEXT',
814
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
815
-                'class'      => 'small-text',
816
-            ),
817
-            'CNT_ISO3'        => array(
818
-                'type'       => 'TEXT',
819
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
820
-                'class'      => 'small-text',
821
-            ),
822
-            'RGN_ID'          => array(
823
-                'type'       => 'TEXT',
824
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
825
-                'class'      => 'small-text',
826
-            ),
827
-            'CNT_name'        => array(
828
-                'type'       => 'TEXT',
829
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
830
-                'class'      => 'regular-text',
831
-            ),
832
-            'CNT_cur_code'    => array(
833
-                'type'       => 'TEXT',
834
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
835
-                'class'      => 'small-text',
836
-            ),
837
-            'CNT_cur_single'  => array(
838
-                'type'       => 'TEXT',
839
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
840
-                'class'      => 'medium-text',
841
-            ),
842
-            'CNT_cur_plural'  => array(
843
-                'type'       => 'TEXT',
844
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
845
-                'class'      => 'medium-text',
846
-            ),
847
-            'CNT_cur_sign'    => array(
848
-                'type'         => 'TEXT',
849
-                'input_name'   => 'cntry[' . $CNT_ISO . ']',
850
-                'class'        => 'small-text',
851
-                'htmlentities' => false,
852
-            ),
853
-            'CNT_cur_sign_b4' => array(
854
-                'type'             => 'RADIO_BTN',
855
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
856
-                'class'            => '',
857
-                'options'          => $this->_yes_no_values,
858
-                'use_desc_4_label' => true,
859
-            ),
860
-            'CNT_cur_dec_plc' => array(
861
-                'type'       => 'RADIO_BTN',
862
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
863
-                'class'      => '',
864
-                'options'    => array(
865
-                    array('id' => 0, 'text' => ''),
866
-                    array('id' => 1, 'text' => ''),
867
-                    array('id' => 2, 'text' => ''),
868
-                    array('id' => 3, 'text' => ''),
869
-                ),
870
-            ),
871
-            'CNT_cur_dec_mrk' => array(
872
-                'type'             => 'RADIO_BTN',
873
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
874
-                'class'            => '',
875
-                'options'          => array(
876
-                    array(
877
-                        'id'   => ',',
878
-                        'text' => __(', (comma)', 'event_espresso'),
879
-                    ),
880
-                    array('id' => '.', 'text' => __('. (decimal)', 'event_espresso')),
881
-                ),
882
-                'use_desc_4_label' => true,
883
-            ),
884
-            'CNT_cur_thsnds'  => array(
885
-                'type'             => 'RADIO_BTN',
886
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
887
-                'class'            => '',
888
-                'options'          => array(
889
-                    array(
890
-                        'id'   => ',',
891
-                        'text' => __(', (comma)', 'event_espresso'),
892
-                    ),
893
-                    array('id' => '.', 'text' => __('. (decimal)', 'event_espresso')),
894
-                ),
895
-                'use_desc_4_label' => true,
896
-            ),
897
-            'CNT_tel_code'    => array(
898
-                'type'       => 'TEXT',
899
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
900
-                'class'      => 'small-text',
901
-            ),
902
-            'CNT_is_EU'       => array(
903
-                'type'             => 'RADIO_BTN',
904
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
905
-                'class'            => '',
906
-                'options'          => $this->_yes_no_values,
907
-                'use_desc_4_label' => true,
908
-            ),
909
-        );
910
-        $this->_template_args['inputs'] = EE_Question_Form_Input::generate_question_form_inputs_for_object(
911
-            $country,
912
-            $country_input_types
913
-        );
914
-        $country_details_settings = EEH_Template::display_template(
915
-            GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
916
-            $this->_template_args,
917
-            true
918
-        );
919
-
920
-        if (defined('DOING_AJAX')) {
921
-            $notices = EE_Error::get_notices(false, false, false);
922
-            echo wp_json_encode(
923
-                array(
924
-                    'return_data' => $country_details_settings,
925
-                    'success'     => $notices['success'],
926
-                    'errors'      => $notices['errors'],
927
-                )
928
-            );
929
-            die();
930
-        } else {
931
-            return $country_details_settings;
932
-        }
933
-    }
934
-
935
-
936
-    /**
937
-     *        display_country_states
938
-     *
939
-     * @access    public
940
-     * @param    string $CNT_ISO
941
-     * @return string
942
-     * @throws DomainException
943
-     */
944
-    public function display_country_states($CNT_ISO = '')
945
-    {
946
-
947
-        $CNT_ISO = isset($this->_req_data['country']) ? sanitize_text_field($this->_req_data['country']) : $CNT_ISO;
948
-
949
-        if (! $CNT_ISO) {
950
-            return '';
951
-        }
952
-        // for ajax
953
-        remove_all_filters('FHEE__EEH_Form_Fields__label_html');
954
-        remove_all_filters('FHEE__EEH_Form_Fields__input_html');
955
-        add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'state_form_field_label_wrap'), 10, 2);
956
-        add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'state_form_field_input__wrap'), 10, 2);
957
-        $states = EEM_State::instance()->get_all_states_for_these_countries(array($CNT_ISO => $CNT_ISO));
958
-
959
-        if ($states) {
960
-            foreach ($states as $STA_ID => $state) {
961
-                if ($state instanceof EE_State) {
962
-                    // STA_abbrev    STA_name    STA_active
963
-                    $state_input_types = array(
964
-                        'STA_abbrev' => array(
965
-                            'type'       => 'TEXT',
966
-                            'input_name' => 'states[' . $STA_ID . ']',
967
-                            'class'      => 'mid-text',
968
-                        ),
969
-                        'STA_name'   => array(
970
-                            'type'       => 'TEXT',
971
-                            'input_name' => 'states[' . $STA_ID . ']',
972
-                            'class'      => 'regular-text',
973
-                        ),
974
-                        'STA_active' => array(
975
-                            'type'             => 'RADIO_BTN',
976
-                            'input_name'       => 'states[' . $STA_ID . ']',
977
-                            'options'          => $this->_yes_no_values,
978
-                            'use_desc_4_label' => true,
979
-                        ),
980
-                    );
981
-                    $this->_template_args['states'][ $STA_ID ]['inputs'] =
982
-                        EE_Question_Form_Input::generate_question_form_inputs_for_object(
983
-                            $state,
984
-                            $state_input_types
985
-                        );
986
-                    $query_args = array(
987
-                        'action'     => 'delete_state',
988
-                        'STA_ID'     => $STA_ID,
989
-                        'CNT_ISO'    => $CNT_ISO,
990
-                        'STA_abbrev' => $state->abbrev(),
991
-                    );
992
-                    $this->_template_args['states'][ $STA_ID ]['delete_state_url'] =
993
-                        EE_Admin_Page::add_query_args_and_nonce(
994
-                            $query_args,
995
-                            GEN_SET_ADMIN_URL
996
-                        );
997
-                }
998
-            }
999
-        } else {
1000
-            $this->_template_args['states'] = false;
1001
-        }
1002
-
1003
-        $this->_template_args['add_new_state_url'] = EE_Admin_Page::add_query_args_and_nonce(
1004
-            array('action' => 'add_new_state'),
1005
-            GEN_SET_ADMIN_URL
1006
-        );
1007
-
1008
-        $state_details_settings = EEH_Template::display_template(
1009
-            GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
1010
-            $this->_template_args,
1011
-            true
1012
-        );
1013
-
1014
-        if (defined('DOING_AJAX')) {
1015
-            $notices = EE_Error::get_notices(false, false, false);
1016
-            echo wp_json_encode(
1017
-                array(
1018
-                    'return_data' => $state_details_settings,
1019
-                    'success'     => $notices['success'],
1020
-                    'errors'      => $notices['errors'],
1021
-                )
1022
-            );
1023
-            die();
1024
-        } else {
1025
-            return $state_details_settings;
1026
-        }
1027
-    }
1028
-
1029
-
1030
-    /**
1031
-     *        add_new_state
1032
-     *
1033
-     * @access    public
1034
-     * @return void
1035
-     * @throws EE_Error
1036
-     */
1037
-    public function add_new_state()
1038
-    {
1039
-
1040
-        $success = true;
1041
-
1042
-        $CNT_ISO = isset($this->_req_data['CNT_ISO'])
1043
-            ? strtoupper(sanitize_text_field($this->_req_data['CNT_ISO']))
1044
-            : false;
1045
-        if (! $CNT_ISO) {
1046
-            EE_Error::add_error(
1047
-                __('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
1048
-                __FILE__,
1049
-                __FUNCTION__,
1050
-                __LINE__
1051
-            );
1052
-            $success = false;
1053
-        }
1054
-        $STA_abbrev = isset($this->_req_data['STA_abbrev'])
1055
-            ? sanitize_text_field($this->_req_data['STA_abbrev'])
1056
-            : false;
1057
-        if (! $STA_abbrev) {
1058
-            EE_Error::add_error(
1059
-                __('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
1060
-                __FILE__,
1061
-                __FUNCTION__,
1062
-                __LINE__
1063
-            );
1064
-            $success = false;
1065
-        }
1066
-        $STA_name = isset($this->_req_data['STA_name'])
1067
-            ? sanitize_text_field($this->_req_data['STA_name'])
1068
-            : false;
1069
-        if (! $STA_name) {
1070
-            EE_Error::add_error(
1071
-                __('No State name or an invalid State name was received.', 'event_espresso'),
1072
-                __FILE__,
1073
-                __FUNCTION__,
1074
-                __LINE__
1075
-            );
1076
-            $success = false;
1077
-        }
1078
-
1079
-        if ($success) {
1080
-            $cols_n_values = array(
1081
-                'CNT_ISO'    => $CNT_ISO,
1082
-                'STA_abbrev' => $STA_abbrev,
1083
-                'STA_name'   => $STA_name,
1084
-                'STA_active' => true,
1085
-            );
1086
-            $success = EEM_State::instance()->insert($cols_n_values);
1087
-            EE_Error::add_success(__('The State was added successfully.', 'event_espresso'));
1088
-        }
1089
-
1090
-        if (defined('DOING_AJAX')) {
1091
-            $notices = EE_Error::get_notices(false, false, false);
1092
-            echo wp_json_encode(array_merge($notices, array('return_data' => $CNT_ISO)));
1093
-            die();
1094
-        } else {
1095
-            $this->_redirect_after_action($success, 'State', 'added', array('action' => 'country_settings'));
1096
-        }
1097
-    }
1098
-
1099
-
1100
-    /**
1101
-     *        delete_state
1102
-     *
1103
-     * @access    public
1104
-     * @return        boolean
1105
-     */
1106
-    public function delete_state()
1107
-    {
1108
-        $CNT_ISO = isset($this->_req_data['CNT_ISO'])
1109
-            ? strtoupper(sanitize_text_field($this->_req_data['CNT_ISO']))
1110
-            : false;
1111
-        $STA_ID = isset($this->_req_data['STA_ID'])
1112
-            ? sanitize_text_field($this->_req_data['STA_ID'])
1113
-            : false;
1114
-        $STA_abbrev = isset($this->_req_data['STA_abbrev'])
1115
-            ? sanitize_text_field($this->_req_data['STA_abbrev'])
1116
-            : false;
1117
-        if (! $STA_ID) {
1118
-            EE_Error::add_error(
1119
-                __('No State ID or an invalid State ID was received.', 'event_espresso'),
1120
-                __FILE__,
1121
-                __FUNCTION__,
1122
-                __LINE__
1123
-            );
1124
-            return false;
1125
-        }
1126
-
1127
-        $success = EEM_State::instance()->delete_by_ID($STA_ID);
1128
-        if ($success !== false) {
1129
-            do_action(
1130
-                'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
1131
-                $CNT_ISO,
1132
-                $STA_ID,
1133
-                array('STA_abbrev' => $STA_abbrev)
1134
-            );
1135
-            EE_Error::add_success(__('The State was deleted successfully.', 'event_espresso'));
1136
-        }
1137
-        if (defined('DOING_AJAX')) {
1138
-            $notices = EE_Error::get_notices(false, false);
1139
-            $notices['return_data'] = true;
1140
-            echo wp_json_encode($notices);
1141
-            die();
1142
-        } else {
1143
-            $this->_redirect_after_action(
1144
-                $success,
1145
-                'State',
1146
-                'deleted',
1147
-                array('action' => 'country_settings')
1148
-            );
1149
-        }
1150
-    }
1151
-
1152
-
1153
-    /**
1154
-     *        _update_country_settings
1155
-     *
1156
-     * @access    protected
1157
-     * @return void
1158
-     * @throws EE_Error
1159
-     */
1160
-    protected function _update_country_settings()
1161
-    {
1162
-        // grab the country ISO code
1163
-        $CNT_ISO = isset($this->_req_data['country'])
1164
-            ? strtoupper(sanitize_text_field($this->_req_data['country']))
1165
-            : false;
1166
-        if (! $CNT_ISO) {
1167
-            EE_Error::add_error(
1168
-                __('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
1169
-                __FILE__,
1170
-                __FUNCTION__,
1171
-                __LINE__
1172
-            );
1173
-
1174
-            return;
1175
-        }
1176
-        $cols_n_values = array();
1177
-        $cols_n_values['CNT_ISO3'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_ISO3'])
1178
-            ? strtoupper(sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_ISO3']))
1179
-            : false;
1180
-        $cols_n_values['RGN_ID'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['RGN_ID'])
1181
-            ? absint($this->_req_data['cntry'][ $CNT_ISO ]['RGN_ID'])
1182
-            : null;
1183
-        $cols_n_values['CNT_name'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_name'])
1184
-            ? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_name'])
1185
-            : null;
1186
-        $cols_n_values['CNT_cur_code'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_code'])
1187
-            ? strtoupper(sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_code']))
1188
-            : 'USD';
1189
-        $cols_n_values['CNT_cur_single'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_single'])
1190
-            ? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_single'])
1191
-            : 'dollar';
1192
-        $cols_n_values['CNT_cur_plural'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_plural'])
1193
-            ? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_plural'])
1194
-            : 'dollars';
1195
-        $cols_n_values['CNT_cur_sign'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_sign'])
1196
-            ? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_sign'])
1197
-            : '$';
1198
-        $cols_n_values['CNT_cur_sign_b4'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_sign_b4'])
1199
-            ? absint($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_sign_b4'])
1200
-            : true;
1201
-        $cols_n_values['CNT_cur_dec_plc'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_dec_plc'])
1202
-            ? absint($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_dec_plc'])
1203
-            : 2;
1204
-        $cols_n_values['CNT_cur_dec_mrk'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_dec_mrk'])
1205
-            ? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_dec_mrk'])
1206
-            : '.';
1207
-        $cols_n_values['CNT_cur_thsnds'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_thsnds'])
1208
-            ? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_thsnds'])
1209
-            : ',';
1210
-        $cols_n_values['CNT_tel_code'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_tel_code'])
1211
-            ? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_tel_code'])
1212
-            : null;
1213
-        $cols_n_values['CNT_is_EU'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_is_EU'])
1214
-            ? absint($this->_req_data['cntry'][ $CNT_ISO ]['CNT_is_EU'])
1215
-            : false;
1216
-        $cols_n_values['CNT_active'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_active'])
1217
-            ? absint($this->_req_data['cntry'][ $CNT_ISO ]['CNT_active'])
1218
-            : false;
1219
-        // allow filtering of country data
1220
-        $cols_n_values = apply_filters(
1221
-            'FHEE__General_Settings_Admin_Page___update_country_settings__cols_n_values',
1222
-            $cols_n_values
1223
-        );
1224
-
1225
-        // where values
1226
-        $where_cols_n_values = array(array('CNT_ISO' => $CNT_ISO));
1227
-        // run the update
1228
-        $success = EEM_Country::instance()->update($cols_n_values, $where_cols_n_values);
1229
-
1230
-        if (isset($this->_req_data['states']) && is_array($this->_req_data['states']) && $success !== false) {
1231
-            // allow filtering of states data
1232
-            $states = apply_filters(
1233
-                'FHEE__General_Settings_Admin_Page___update_country_settings__states',
1234
-                $this->_req_data['states']
1235
-            );
1236
-
1237
-            // loop thru state data ( looks like : states[75][STA_name] )
1238
-            foreach ($states as $STA_ID => $state) {
1239
-                $cols_n_values = array(
1240
-                    'CNT_ISO'    => $CNT_ISO,
1241
-                    'STA_abbrev' => sanitize_text_field($state['STA_abbrev']),
1242
-                    'STA_name'   => sanitize_text_field($state['STA_name']),
1243
-                    'STA_active' => (bool) absint($state['STA_active']),
1244
-                );
1245
-                // where values
1246
-                $where_cols_n_values = array(array('STA_ID' => $STA_ID));
1247
-                // run the update
1248
-                $success = EEM_State::instance()->update($cols_n_values, $where_cols_n_values);
1249
-                if ($success !== false) {
1250
-                    do_action(
1251
-                        'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
1252
-                        $CNT_ISO,
1253
-                        $STA_ID,
1254
-                        $cols_n_values
1255
-                    );
1256
-                }
1257
-            }
1258
-        }
1259
-        // check if country being edited matches org option country, and if so, then  update EE_Config with new settings
1260
-        if (isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
1261
-            && $CNT_ISO == EE_Registry::instance()->CFG->organization->CNT_ISO
1262
-        ) {
1263
-            EE_Registry::instance()->CFG->currency = new EE_Currency_Config($CNT_ISO);
1264
-            EE_Registry::instance()->CFG->update_espresso_config();
1265
-        }
1266
-
1267
-        if ($success !== false) {
1268
-            EE_Error::add_success(
1269
-                esc_html__('Country Settings updated successfully.', 'event_espresso')
1270
-            );
1271
-        }
1272
-        $this->_redirect_after_action(
1273
-            $success,
1274
-            '',
1275
-            '',
1276
-            array('action' => 'country_settings', 'country' => $CNT_ISO),
1277
-            true
1278
-        );
1279
-    }
1280
-
1281
-
1282
-    /**
1283
-     *        form_form_field_label_wrap
1284
-     *
1285
-     * @access        public
1286
-     * @param        string $label
1287
-     * @return        string
1288
-     */
1289
-    public function country_form_field_label_wrap($label, $required_text)
1290
-    {
1291
-        return '
21
+	/**
22
+	 * _question_group
23
+	 * holds the specific question group object for the question group details screen
24
+	 *
25
+	 * @var object
26
+	 */
27
+	protected $_question_group;
28
+
29
+
30
+	/**
31
+	 * Initialize basic properties.
32
+	 */
33
+	protected function _init_page_props()
34
+	{
35
+		$this->page_slug = GEN_SET_PG_SLUG;
36
+		$this->page_label = GEN_SET_LABEL;
37
+		$this->_admin_base_url = GEN_SET_ADMIN_URL;
38
+		$this->_admin_base_path = GEN_SET_ADMIN;
39
+	}
40
+
41
+
42
+	/**
43
+	 * Set ajax hooks
44
+	 */
45
+	protected function _ajax_hooks()
46
+	{
47
+		add_action('wp_ajax_espresso_display_country_settings', array($this, 'display_country_settings'));
48
+		add_action('wp_ajax_espresso_display_country_states', array($this, 'display_country_states'));
49
+		add_action('wp_ajax_espresso_delete_state', array($this, 'delete_state'), 10, 3);
50
+		add_action('wp_ajax_espresso_add_new_state', array($this, 'add_new_state'));
51
+	}
52
+
53
+
54
+	/**
55
+	 * More page properties initialization.
56
+	 */
57
+	protected function _define_page_props()
58
+	{
59
+		$this->_admin_page_title = GEN_SET_LABEL;
60
+		$this->_labels = array(
61
+			'publishbox' => __('Update Settings', 'event_espresso'),
62
+		);
63
+	}
64
+
65
+
66
+	/**
67
+	 * Set page routes property.
68
+	 */
69
+	protected function _set_page_routes()
70
+	{
71
+		$this->_page_routes = array(
72
+
73
+			'critical_pages'                => array(
74
+				'func'       => '_espresso_page_settings',
75
+				'capability' => 'manage_options',
76
+			),
77
+			'update_espresso_page_settings' => array(
78
+				'func'       => '_update_espresso_page_settings',
79
+				'capability' => 'manage_options',
80
+				'noheader'   => true,
81
+			),
82
+			'default'                       => array(
83
+				'func'       => '_your_organization_settings',
84
+				'capability' => 'manage_options',
85
+			),
86
+
87
+			'update_your_organization_settings' => array(
88
+				'func'       => '_update_your_organization_settings',
89
+				'capability' => 'manage_options',
90
+				'noheader'   => true,
91
+			),
92
+
93
+			'admin_option_settings' => array(
94
+				'func'       => '_admin_option_settings',
95
+				'capability' => 'manage_options',
96
+			),
97
+
98
+			'update_admin_option_settings' => array(
99
+				'func'       => '_update_admin_option_settings',
100
+				'capability' => 'manage_options',
101
+				'noheader'   => true,
102
+			),
103
+
104
+			'country_settings' => array(
105
+				'func'       => '_country_settings',
106
+				'capability' => 'manage_options',
107
+			),
108
+
109
+			'update_country_settings' => array(
110
+				'func'       => '_update_country_settings',
111
+				'capability' => 'manage_options',
112
+				'noheader'   => true,
113
+			),
114
+
115
+			'display_country_settings' => array(
116
+				'func'       => 'display_country_settings',
117
+				'capability' => 'manage_options',
118
+				'noheader'   => true,
119
+			),
120
+
121
+			'add_new_state' => array(
122
+				'func'       => 'add_new_state',
123
+				'capability' => 'manage_options',
124
+				'noheader'   => true,
125
+			),
126
+
127
+			'delete_state' => array(
128
+				'func'       => 'delete_state',
129
+				'capability' => 'manage_options',
130
+				'noheader'   => true,
131
+			),
132
+			'privacy_settings' => array(
133
+				'func' => 'privacySettings',
134
+				'capability' => 'manage_options',
135
+			),
136
+			'update_privacy_settings' => array(
137
+				'func' => 'updatePrivacySettings',
138
+				'capability' => 'manage_options',
139
+				'noheader' => true,
140
+				'headers_sent_route' => 'privacy_settings'
141
+			)
142
+		);
143
+	}
144
+
145
+
146
+	/**
147
+	 * Set page configuration property
148
+	 */
149
+	protected function _set_page_config()
150
+	{
151
+		$this->_page_config = array(
152
+			'critical_pages'        => array(
153
+				'nav'           => array(
154
+					'label' => __('Critical Pages', 'event_espresso'),
155
+					'order' => 50,
156
+				),
157
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
158
+				'help_tabs'     => array(
159
+					'general_settings_critical_pages_help_tab' => array(
160
+						'title'    => __('Critical Pages', 'event_espresso'),
161
+						'filename' => 'general_settings_critical_pages',
162
+					),
163
+				),
164
+				'help_tour'     => array('Critical_Pages_Help_Tour'),
165
+				'require_nonce' => false,
166
+			),
167
+			'default'               => array(
168
+				'nav'           => array(
169
+					'label' => __('Your Organization', 'event_espresso'),
170
+					'order' => 20,
171
+				),
172
+				'help_tabs'     => array(
173
+					'general_settings_your_organization_help_tab' => array(
174
+						'title'    => __('Your Organization', 'event_espresso'),
175
+						'filename' => 'general_settings_your_organization',
176
+					),
177
+				),
178
+				'help_tour'     => array('Your_Organization_Help_Tour'),
179
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
180
+				'require_nonce' => false,
181
+			),
182
+			'admin_option_settings' => array(
183
+				'nav'           => array(
184
+					'label' => __('Admin Options', 'event_espresso'),
185
+					'order' => 60,
186
+				),
187
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
188
+				'help_tabs'     => array(
189
+					'general_settings_admin_options_help_tab' => array(
190
+						'title'    => __('Admin Options', 'event_espresso'),
191
+						'filename' => 'general_settings_admin_options',
192
+					),
193
+				),
194
+				'help_tour'     => array('Admin_Options_Help_Tour'),
195
+				'require_nonce' => false,
196
+			),
197
+			'country_settings'      => array(
198
+				'nav'           => array(
199
+					'label' => __('Countries', 'event_espresso'),
200
+					'order' => 70,
201
+				),
202
+				'help_tabs'     => array(
203
+					'general_settings_countries_help_tab' => array(
204
+						'title'    => __('Countries', 'event_espresso'),
205
+						'filename' => 'general_settings_countries',
206
+					),
207
+				),
208
+				'help_tour'     => array('Countries_Help_Tour'),
209
+				'require_nonce' => false,
210
+			),
211
+			'privacy_settings' => array(
212
+				'nav' => array(
213
+					'label' => esc_html__('Privacy', 'event_espresso'),
214
+					'order' => 80
215
+				),
216
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
217
+				'require_nonce' => false
218
+			)
219
+		);
220
+	}
221
+
222
+
223
+	protected function _add_screen_options()
224
+	{
225
+	}
226
+
227
+	protected function _add_feature_pointers()
228
+	{
229
+	}
230
+
231
+
232
+	/**
233
+	 * Enqueue global scripts and styles for all routes in the General Settings Admin Pages.
234
+	 */
235
+	public function load_scripts_styles()
236
+	{
237
+		// styles
238
+		wp_enqueue_style('espresso-ui-theme');
239
+		// scripts
240
+		wp_enqueue_script('ee_admin_js');
241
+	}
242
+
243
+
244
+	/**
245
+	 * Execute logic running on `admin_init`
246
+	 */
247
+	public function admin_init()
248
+	{
249
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = __(
250
+			'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
251
+			'event_espresso'
252
+		);
253
+		EE_Registry::$i18n_js_strings['error_occurred'] = __(
254
+			'An error occurred! Please refresh the page and try again.',
255
+			'event_espresso'
256
+		);
257
+		EE_Registry::$i18n_js_strings['confirm_delete_state'] = __(
258
+			'Are you sure you want to delete this State / Province?',
259
+			'event_espresso'
260
+		);
261
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
262
+		EE_Registry::$i18n_js_strings['ajax_url'] = admin_url(
263
+			'admin-ajax.php?page=espresso_general_settings',
264
+			$protocol
265
+		);
266
+	}
267
+
268
+	public function admin_notices()
269
+	{
270
+	}
271
+
272
+	public function admin_footer_scripts()
273
+	{
274
+	}
275
+
276
+
277
+	/**
278
+	 * Enqueue scripts and styles for the default route.
279
+	 */
280
+	public function load_scripts_styles_default()
281
+	{
282
+		// styles
283
+		wp_enqueue_style('thickbox');
284
+		// scripts
285
+		wp_enqueue_script('media-upload');
286
+		wp_enqueue_script('thickbox');
287
+		wp_register_script(
288
+			'organization_settings',
289
+			GEN_SET_ASSETS_URL . 'your_organization_settings.js',
290
+			array('jquery', 'media-upload', 'thickbox'),
291
+			EVENT_ESPRESSO_VERSION,
292
+			true
293
+		);
294
+		wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', array(), EVENT_ESPRESSO_VERSION);
295
+		wp_enqueue_script('organization_settings');
296
+		wp_enqueue_style('organization-css');
297
+		$confirm_image_delete = array(
298
+			'text' => __(
299
+				'Do you really want to delete this image? Please remember to save your settings to complete the removal.',
300
+				'event_espresso'
301
+			),
302
+		);
303
+		wp_localize_script('organization_settings', 'confirm_image_delete', $confirm_image_delete);
304
+	}
305
+
306
+
307
+	/**
308
+	 * Enqueue scripts and styles for the country settings route.
309
+	 */
310
+	public function load_scripts_styles_country_settings()
311
+	{
312
+		// scripts
313
+		wp_register_script(
314
+			'gen_settings_countries',
315
+			GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
316
+			array('ee_admin_js'),
317
+			EVENT_ESPRESSO_VERSION,
318
+			true
319
+		);
320
+		wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', array(), EVENT_ESPRESSO_VERSION);
321
+		wp_enqueue_script('gen_settings_countries');
322
+		wp_enqueue_style('organization-css');
323
+	}
324
+
325
+
326
+	/*************        Espresso Pages        *************/
327
+	/**
328
+	 * _espresso_page_settings
329
+	 *
330
+	 * @throws \EE_Error
331
+	 */
332
+	protected function _espresso_page_settings()
333
+	{
334
+		// Check to make sure all of the main pages are setup properly,
335
+		// if not create the default pages and display an admin notice
336
+		EEH_Activation::verify_default_pages_exist();
337
+		$this->_transient_garbage_collection();
338
+		$this->_template_args['values'] = $this->_yes_no_values;
339
+		$this->_template_args['reg_page_id'] = isset(EE_Registry::instance()->CFG->core->reg_page_id)
340
+			? EE_Registry::instance()->CFG->core->reg_page_id
341
+			: null;
342
+		$this->_template_args['reg_page_obj'] = isset(EE_Registry::instance()->CFG->core->reg_page_id)
343
+			? get_page(EE_Registry::instance()->CFG->core->reg_page_id)
344
+			: false;
345
+		$this->_template_args['txn_page_id'] = isset(EE_Registry::instance()->CFG->core->txn_page_id)
346
+			? EE_Registry::instance()->CFG->core->txn_page_id
347
+			: null;
348
+		$this->_template_args['txn_page_obj'] = isset(EE_Registry::instance()->CFG->core->txn_page_id)
349
+			? get_page(EE_Registry::instance()->CFG->core->txn_page_id)
350
+			: false;
351
+		$this->_template_args['thank_you_page_id'] = isset(EE_Registry::instance()->CFG->core->thank_you_page_id)
352
+			? EE_Registry::instance()->CFG->core->thank_you_page_id
353
+			: null;
354
+		$this->_template_args['thank_you_page_obj'] = isset(EE_Registry::instance()->CFG->core->thank_you_page_id)
355
+			? get_page(EE_Registry::instance()->CFG->core->thank_you_page_id)
356
+			: false;
357
+		$this->_template_args['cancel_page_id'] = isset(EE_Registry::instance()->CFG->core->cancel_page_id)
358
+			? EE_Registry::instance()->CFG->core->cancel_page_id
359
+			: null;
360
+		$this->_template_args['cancel_page_obj'] = isset(EE_Registry::instance()->CFG->core->cancel_page_id)
361
+			? get_page(EE_Registry::instance()->CFG->core->cancel_page_id)
362
+			: false;
363
+		$this->_set_add_edit_form_tags('update_espresso_page_settings');
364
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
365
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
366
+			GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
367
+			$this->_template_args,
368
+			true
369
+		);
370
+		$this->display_admin_page_with_sidebar();
371
+	}
372
+
373
+
374
+	/**
375
+	 * Handler for updating espresso page settings.
376
+	 */
377
+	protected function _update_espresso_page_settings()
378
+	{
379
+		// capture incoming request data && set page IDs
380
+		EE_Registry::instance()->CFG->core->reg_page_id = isset($this->_req_data['reg_page_id'])
381
+			? absint($this->_req_data['reg_page_id'])
382
+			: EE_Registry::instance()->CFG->core->reg_page_id;
383
+		EE_Registry::instance()->CFG->core->txn_page_id = isset($this->_req_data['txn_page_id'])
384
+			? absint($this->_req_data['txn_page_id'])
385
+			: EE_Registry::instance()->CFG->core->txn_page_id;
386
+		EE_Registry::instance()->CFG->core->thank_you_page_id = isset($this->_req_data['thank_you_page_id'])
387
+			? absint($this->_req_data['thank_you_page_id'])
388
+			: EE_Registry::instance()->CFG->core->thank_you_page_id;
389
+		EE_Registry::instance()->CFG->core->cancel_page_id = isset($this->_req_data['cancel_page_id'])
390
+			? absint($this->_req_data['cancel_page_id'])
391
+			: EE_Registry::instance()->CFG->core->cancel_page_id;
392
+
393
+		EE_Registry::instance()->CFG->core = apply_filters(
394
+			'FHEE__General_Settings_Admin_Page___update_espresso_page_settings__CFG_core',
395
+			EE_Registry::instance()->CFG->core,
396
+			$this->_req_data
397
+		);
398
+		$what = __('Critical Pages & Shortcodes', 'event_espresso');
399
+		$this->_redirect_after_action(
400
+			$this->_update_espresso_configuration(
401
+				$what,
402
+				EE_Registry::instance()->CFG->core,
403
+				__FILE__,
404
+				__FUNCTION__,
405
+				__LINE__
406
+			),
407
+			$what,
408
+			'',
409
+			array(
410
+				'action' => 'critical_pages',
411
+			),
412
+			true
413
+		);
414
+	}
415
+
416
+
417
+	/*************        Your Organization        *************/
418
+
419
+
420
+	/**
421
+	 * Output for the Your Organization settings route.
422
+	 *
423
+	 * @throws DomainException
424
+	 * @throws EE_Error
425
+	 */
426
+	protected function _your_organization_settings()
427
+	{
428
+
429
+		$this->_template_args['site_license_key'] = isset(
430
+			EE_Registry::instance()->NET_CFG->core->site_license_key
431
+		)
432
+			? EE_Registry::instance()->NET_CFG->core->get_pretty('site_license_key')
433
+			: '';
434
+		$this->_template_args['organization_name'] = isset(EE_Registry::instance()->CFG->organization->name)
435
+			? EE_Registry::instance()->CFG->organization->get_pretty('name')
436
+			: '';
437
+		$this->_template_args['organization_address_1'] = isset(EE_Registry::instance()->CFG->organization->address_1)
438
+			? EE_Registry::instance()->CFG->organization->get_pretty('address_1')
439
+			: '';
440
+		$this->_template_args['organization_address_2'] = isset(EE_Registry::instance()->CFG->organization->address_2)
441
+			? EE_Registry::instance()->CFG->organization->get_pretty('address_2')
442
+			: '';
443
+		$this->_template_args['organization_city'] = isset(EE_Registry::instance()->CFG->organization->city)
444
+			? EE_Registry::instance()->CFG->organization->get_pretty('city')
445
+			: '';
446
+		$this->_template_args['organization_zip'] = isset(EE_Registry::instance()->CFG->organization->zip)
447
+			? EE_Registry::instance()->CFG->organization->get_pretty('zip')
448
+			: '';
449
+		$this->_template_args['organization_email'] = isset(EE_Registry::instance()->CFG->organization->email)
450
+			? EE_Registry::instance()->CFG->organization->get_pretty('email')
451
+			: '';
452
+		$this->_template_args['organization_phone'] = isset(EE_Registry::instance()->CFG->organization->phone)
453
+			? EE_Registry::instance()->CFG->organization->get_pretty('phone')
454
+			: '';
455
+		$this->_template_args['organization_vat'] = isset(EE_Registry::instance()->CFG->organization->vat)
456
+			? EE_Registry::instance()->CFG->organization->get_pretty('vat')
457
+			: '';
458
+		$this->_template_args['currency_sign'] = isset(EE_Registry::instance()->CFG->currency->sign)
459
+			? EE_Registry::instance()->CFG->currency->get_pretty('sign')
460
+			: '$';
461
+		$this->_template_args['organization_logo_url'] = isset(EE_Registry::instance()->CFG->organization->logo_url)
462
+			? EE_Registry::instance()->CFG->organization->get_pretty('logo_url')
463
+			: false;
464
+		$this->_template_args['organization_facebook'] = isset(EE_Registry::instance()->CFG->organization->facebook)
465
+			? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
466
+			: '';
467
+		$this->_template_args['organization_twitter'] = isset(EE_Registry::instance()->CFG->organization->twitter)
468
+			? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
469
+			: '';
470
+		$this->_template_args['organization_linkedin'] = isset(EE_Registry::instance()->CFG->organization->linkedin)
471
+			? EE_Registry::instance()->CFG->organization->get_pretty('linkedin')
472
+			: '';
473
+		$this->_template_args['organization_pinterest'] = isset(EE_Registry::instance()->CFG->organization->pinterest)
474
+			? EE_Registry::instance()->CFG->organization->get_pretty('pinterest')
475
+			: '';
476
+		$this->_template_args['organization_google'] = isset(EE_Registry::instance()->CFG->organization->google)
477
+			? EE_Registry::instance()->CFG->organization->get_pretty('google')
478
+			: '';
479
+		$this->_template_args['organization_instagram'] = isset(EE_Registry::instance()->CFG->organization->instagram)
480
+			? EE_Registry::instance()->CFG->organization->get_pretty('instagram')
481
+			: '';
482
+		// UXIP settings
483
+		$this->_template_args['ee_ueip_optin'] = isset(EE_Registry::instance()->CFG->core->ee_ueip_optin)
484
+			? EE_Registry::instance()->CFG->core->get_pretty('ee_ueip_optin')
485
+			: 'yes';
486
+
487
+		$STA_ID = isset(EE_Registry::instance()->CFG->organization->STA_ID)
488
+			? EE_Registry::instance()->CFG->organization->STA_ID
489
+			: 4;
490
+		$this->_template_args['states'] = new EE_Question_Form_Input(
491
+			EE_Question::new_instance(
492
+				array(
493
+					'QST_ID'           => 0,
494
+					'QST_display_text' => __('State/Province', 'event_espresso'),
495
+					'QST_system'       => 'admin-state',
496
+				)
497
+			),
498
+			EE_Answer::new_instance(
499
+				array(
500
+					'ANS_ID'    => 0,
501
+					'ANS_value' => $STA_ID,
502
+				)
503
+			),
504
+			array(
505
+				'input_id'       => 'organization_state',
506
+				'input_name'     => 'organization_state',
507
+				'input_prefix'   => '',
508
+				'append_qstn_id' => false,
509
+			)
510
+		);
511
+
512
+		$CNT_ISO = isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
513
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
514
+			: 'US';
515
+		$this->_template_args['countries'] = new EE_Question_Form_Input(
516
+			EE_Question::new_instance(
517
+				array(
518
+					'QST_ID'           => 0,
519
+					'QST_display_text' => __('Country', 'event_espresso'),
520
+					'QST_system'       => 'admin-country',
521
+				)
522
+			),
523
+			EE_Answer::new_instance(
524
+				array(
525
+					'ANS_ID'    => 0,
526
+					'ANS_value' => $CNT_ISO,
527
+				)
528
+			),
529
+			array(
530
+				'input_id'       => 'organization_country',
531
+				'input_name'     => 'organization_country',
532
+				'input_prefix'   => '',
533
+				'append_qstn_id' => false,
534
+			)
535
+		);
536
+
537
+		add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
538
+		add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
539
+
540
+		// PUE verification stuff
541
+		$ver_option_key = 'puvererr_' . basename(EE_PLUGIN_BASENAME);
542
+		$verify_fail = get_option($ver_option_key);
543
+		$this->_template_args['site_license_key_verified'] = $verify_fail
544
+															 || ! empty($verify_fail)
545
+															 || (empty($this->_template_args['site_license_key'])
546
+																 && empty($verify_fail)
547
+															 )
548
+			? '<span class="dashicons dashicons-admin-network ee-icon-color-ee-red ee-icon-size-20"></span>'
549
+			: '<span class="dashicons dashicons-admin-network ee-icon-color-ee-green ee-icon-size-20"></span>';
550
+
551
+		$this->_set_add_edit_form_tags('update_your_organization_settings');
552
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
553
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
554
+			GEN_SET_TEMPLATE_PATH . 'your_organization_settings.template.php',
555
+			$this->_template_args,
556
+			true
557
+		);
558
+
559
+		$this->display_admin_page_with_sidebar();
560
+	}
561
+
562
+
563
+	/**
564
+	 * Handler for updating organziation settings.
565
+	 */
566
+	protected function _update_your_organization_settings()
567
+	{
568
+		if (is_main_site()) {
569
+			EE_Registry::instance()->NET_CFG->core->site_license_key = isset($this->_req_data['site_license_key'])
570
+				? sanitize_text_field($this->_req_data['site_license_key'])
571
+				: EE_Registry::instance()->NET_CFG->core->site_license_key;
572
+		}
573
+		EE_Registry::instance()->CFG->organization->name = isset($this->_req_data['organization_name'])
574
+			? sanitize_text_field($this->_req_data['organization_name'])
575
+			: EE_Registry::instance()->CFG->organization->name;
576
+		EE_Registry::instance()->CFG->organization->address_1 = isset($this->_req_data['organization_address_1'])
577
+			? sanitize_text_field($this->_req_data['organization_address_1'])
578
+			: EE_Registry::instance()->CFG->organization->address_1;
579
+		EE_Registry::instance()->CFG->organization->address_2 = isset($this->_req_data['organization_address_2'])
580
+			? sanitize_text_field($this->_req_data['organization_address_2'])
581
+			: EE_Registry::instance()->CFG->organization->address_2;
582
+		EE_Registry::instance()->CFG->organization->city = isset($this->_req_data['organization_city'])
583
+			? sanitize_text_field($this->_req_data['organization_city'])
584
+			: EE_Registry::instance()->CFG->organization->city;
585
+		EE_Registry::instance()->CFG->organization->STA_ID = isset($this->_req_data['organization_state'])
586
+			? absint($this->_req_data['organization_state'])
587
+			: EE_Registry::instance()->CFG->organization->STA_ID;
588
+		EE_Registry::instance()->CFG->organization->CNT_ISO = isset($this->_req_data['organization_country'])
589
+			? sanitize_text_field($this->_req_data['organization_country'])
590
+			: EE_Registry::instance()->CFG->organization->CNT_ISO;
591
+		EE_Registry::instance()->CFG->organization->zip = isset($this->_req_data['organization_zip'])
592
+			? sanitize_text_field($this->_req_data['organization_zip'])
593
+			: EE_Registry::instance()->CFG->organization->zip;
594
+		EE_Registry::instance()->CFG->organization->email = isset($this->_req_data['organization_email'])
595
+			? sanitize_email($this->_req_data['organization_email'])
596
+			: EE_Registry::instance()->CFG->organization->email;
597
+		EE_Registry::instance()->CFG->organization->vat = isset($this->_req_data['organization_vat'])
598
+			? sanitize_text_field($this->_req_data['organization_vat'])
599
+			: EE_Registry::instance()->CFG->organization->vat;
600
+		EE_Registry::instance()->CFG->organization->phone = isset($this->_req_data['organization_phone'])
601
+			? sanitize_text_field($this->_req_data['organization_phone'])
602
+			: EE_Registry::instance()->CFG->organization->phone;
603
+		EE_Registry::instance()->CFG->organization->logo_url = isset($this->_req_data['organization_logo_url'])
604
+			? esc_url_raw($this->_req_data['organization_logo_url'])
605
+			: EE_Registry::instance()->CFG->organization->logo_url;
606
+		EE_Registry::instance()->CFG->organization->facebook = isset($this->_req_data['organization_facebook'])
607
+			? esc_url_raw($this->_req_data['organization_facebook'])
608
+			: EE_Registry::instance()->CFG->organization->facebook;
609
+		EE_Registry::instance()->CFG->organization->twitter = isset($this->_req_data['organization_twitter'])
610
+			? esc_url_raw($this->_req_data['organization_twitter'])
611
+			: EE_Registry::instance()->CFG->organization->twitter;
612
+		EE_Registry::instance()->CFG->organization->linkedin = isset($this->_req_data['organization_linkedin'])
613
+			? esc_url_raw($this->_req_data['organization_linkedin'])
614
+			: EE_Registry::instance()->CFG->organization->linkedin;
615
+		EE_Registry::instance()->CFG->organization->pinterest = isset($this->_req_data['organization_pinterest'])
616
+			? esc_url_raw($this->_req_data['organization_pinterest'])
617
+			: EE_Registry::instance()->CFG->organization->pinterest;
618
+		EE_Registry::instance()->CFG->organization->google = isset($this->_req_data['organization_google'])
619
+			? esc_url_raw($this->_req_data['organization_google'])
620
+			: EE_Registry::instance()->CFG->organization->google;
621
+		EE_Registry::instance()->CFG->organization->instagram = isset($this->_req_data['organization_instagram'])
622
+			? esc_url_raw($this->_req_data['organization_instagram'])
623
+			: EE_Registry::instance()->CFG->organization->instagram;
624
+		EE_Registry::instance()->CFG->core->ee_ueip_optin = isset($this->_req_data['ueip_optin'])
625
+															&& ! empty($this->_req_data['ueip_optin'])
626
+			? filter_var($this->_req_data['ueip_optin'], FILTER_VALIDATE_BOOLEAN)
627
+			: EE_Registry::instance()->CFG->core->ee_ueip_optin;
628
+
629
+		EE_Registry::instance()->CFG->currency = new EE_Currency_Config(
630
+			EE_Registry::instance()->CFG->organization->CNT_ISO
631
+		);
632
+
633
+		EE_Registry::instance()->CFG = apply_filters(
634
+			'FHEE__General_Settings_Admin_Page___update_your_organization_settings__CFG',
635
+			EE_Registry::instance()->CFG
636
+		);
637
+
638
+		$what = 'Your Organization Settings';
639
+		$success = $this->_update_espresso_configuration(
640
+			$what,
641
+			EE_Registry::instance()->CFG,
642
+			__FILE__,
643
+			__FUNCTION__,
644
+			__LINE__
645
+		);
646
+
647
+		$this->_redirect_after_action($success, $what, 'updated', array('action' => 'default'));
648
+	}
649
+
650
+
651
+
652
+	/*************        Admin Options        *************/
653
+
654
+
655
+	/**
656
+	 * _admin_option_settings
657
+	 *
658
+	 * @throws \EE_Error
659
+	 * @throws \LogicException
660
+	 */
661
+	protected function _admin_option_settings()
662
+	{
663
+		$this->_template_args['admin_page_content'] = '';
664
+		try {
665
+			$admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
666
+			// still need this for the old school form in Extend_General_Settings_Admin_Page
667
+			$this->_template_args['values'] = $this->_yes_no_values;
668
+			// also need to account for the do_action that was in the old template
669
+			$admin_options_settings_form->setTemplateArgs($this->_template_args);
670
+			$this->_template_args['admin_page_content'] = $admin_options_settings_form->display();
671
+		} catch (Exception $e) {
672
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
673
+		}
674
+		$this->_set_add_edit_form_tags('update_admin_option_settings');
675
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
676
+		$this->display_admin_page_with_sidebar();
677
+	}
678
+
679
+
680
+	/**
681
+	 * _update_admin_option_settings
682
+	 *
683
+	 * @throws \EE_Error
684
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
685
+	 * @throws \EventEspresso\core\exceptions\InvalidFormSubmissionException
686
+	 * @throws \InvalidArgumentException
687
+	 * @throws \LogicException
688
+	 */
689
+	protected function _update_admin_option_settings()
690
+	{
691
+		try {
692
+			$admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
693
+			$admin_options_settings_form->process($this->_req_data[ $admin_options_settings_form->slug() ]);
694
+			EE_Registry::instance()->CFG->admin = apply_filters(
695
+				'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin',
696
+				EE_Registry::instance()->CFG->admin
697
+			);
698
+		} catch (Exception $e) {
699
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
700
+		}
701
+		$this->_redirect_after_action(
702
+			apply_filters(
703
+				'FHEE__General_Settings_Admin_Page___update_admin_option_settings__success',
704
+				$this->_update_espresso_configuration(
705
+					'Admin Options',
706
+					EE_Registry::instance()->CFG->admin,
707
+					__FILE__,
708
+					__FUNCTION__,
709
+					__LINE__
710
+				)
711
+			),
712
+			'Admin Options',
713
+			'updated',
714
+			array('action' => 'admin_option_settings')
715
+		);
716
+	}
717
+
718
+
719
+	/*************        Countries        *************/
720
+
721
+
722
+	/**
723
+	 * Output Country Settings view.
724
+	 *
725
+	 * @throws DomainException
726
+	 * @throws EE_Error
727
+	 */
728
+	protected function _country_settings()
729
+	{
730
+		$CNT_ISO = isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
731
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
732
+			: 'US';
733
+		$CNT_ISO = isset($this->_req_data['country'])
734
+			? strtoupper(sanitize_text_field($this->_req_data['country']))
735
+			: $CNT_ISO;
736
+
737
+		// load field generator helper
738
+
739
+		$this->_template_args['values'] = $this->_yes_no_values;
740
+
741
+		$this->_template_args['countries'] = new EE_Question_Form_Input(
742
+			EE_Question::new_instance(
743
+				array(
744
+					'QST_ID'           => 0,
745
+					'QST_display_text' => __('Select Country', 'event_espresso'),
746
+					'QST_system'       => 'admin-country',
747
+				)
748
+			),
749
+			EE_Answer::new_instance(
750
+				array(
751
+					'ANS_ID'    => 0,
752
+					'ANS_value' => $CNT_ISO,
753
+				)
754
+			),
755
+			array(
756
+				'input_id'       => 'country',
757
+				'input_name'     => 'country',
758
+				'input_prefix'   => '',
759
+				'append_qstn_id' => false,
760
+			)
761
+		);
762
+
763
+		add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
764
+		add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
765
+		$this->_template_args['country_details_settings'] = $this->display_country_settings();
766
+		$this->_template_args['country_states_settings'] = $this->display_country_states();
767
+
768
+		$this->_set_add_edit_form_tags('update_country_settings');
769
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
770
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
771
+			GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
772
+			$this->_template_args,
773
+			true
774
+		);
775
+		$this->display_admin_page_with_no_sidebar();
776
+	}
777
+
778
+
779
+	/**
780
+	 *        display_country_settings
781
+	 *
782
+	 * @access    public
783
+	 * @param    string $CNT_ISO
784
+	 * @return mixed string | array
785
+	 * @throws DomainException
786
+	 */
787
+	public function display_country_settings($CNT_ISO = '')
788
+	{
789
+
790
+		$CNT_ISO = isset($this->_req_data['country'])
791
+			? strtoupper(sanitize_text_field($this->_req_data['country']))
792
+			: $CNT_ISO;
793
+		if (! $CNT_ISO) {
794
+			return '';
795
+		}
796
+
797
+		// for ajax
798
+		remove_all_filters('FHEE__EEH_Form_Fields__label_html');
799
+		remove_all_filters('FHEE__EEH_Form_Fields__input_html');
800
+		add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
801
+		add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
802
+		$country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
803
+
804
+		$country_input_types = array(
805
+			'CNT_active'      => array(
806
+				'type'             => 'RADIO_BTN',
807
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
808
+				'class'            => '',
809
+				'options'          => $this->_yes_no_values,
810
+				'use_desc_4_label' => true,
811
+			),
812
+			'CNT_ISO'         => array(
813
+				'type'       => 'TEXT',
814
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
815
+				'class'      => 'small-text',
816
+			),
817
+			'CNT_ISO3'        => array(
818
+				'type'       => 'TEXT',
819
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
820
+				'class'      => 'small-text',
821
+			),
822
+			'RGN_ID'          => array(
823
+				'type'       => 'TEXT',
824
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
825
+				'class'      => 'small-text',
826
+			),
827
+			'CNT_name'        => array(
828
+				'type'       => 'TEXT',
829
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
830
+				'class'      => 'regular-text',
831
+			),
832
+			'CNT_cur_code'    => array(
833
+				'type'       => 'TEXT',
834
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
835
+				'class'      => 'small-text',
836
+			),
837
+			'CNT_cur_single'  => array(
838
+				'type'       => 'TEXT',
839
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
840
+				'class'      => 'medium-text',
841
+			),
842
+			'CNT_cur_plural'  => array(
843
+				'type'       => 'TEXT',
844
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
845
+				'class'      => 'medium-text',
846
+			),
847
+			'CNT_cur_sign'    => array(
848
+				'type'         => 'TEXT',
849
+				'input_name'   => 'cntry[' . $CNT_ISO . ']',
850
+				'class'        => 'small-text',
851
+				'htmlentities' => false,
852
+			),
853
+			'CNT_cur_sign_b4' => array(
854
+				'type'             => 'RADIO_BTN',
855
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
856
+				'class'            => '',
857
+				'options'          => $this->_yes_no_values,
858
+				'use_desc_4_label' => true,
859
+			),
860
+			'CNT_cur_dec_plc' => array(
861
+				'type'       => 'RADIO_BTN',
862
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
863
+				'class'      => '',
864
+				'options'    => array(
865
+					array('id' => 0, 'text' => ''),
866
+					array('id' => 1, 'text' => ''),
867
+					array('id' => 2, 'text' => ''),
868
+					array('id' => 3, 'text' => ''),
869
+				),
870
+			),
871
+			'CNT_cur_dec_mrk' => array(
872
+				'type'             => 'RADIO_BTN',
873
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
874
+				'class'            => '',
875
+				'options'          => array(
876
+					array(
877
+						'id'   => ',',
878
+						'text' => __(', (comma)', 'event_espresso'),
879
+					),
880
+					array('id' => '.', 'text' => __('. (decimal)', 'event_espresso')),
881
+				),
882
+				'use_desc_4_label' => true,
883
+			),
884
+			'CNT_cur_thsnds'  => array(
885
+				'type'             => 'RADIO_BTN',
886
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
887
+				'class'            => '',
888
+				'options'          => array(
889
+					array(
890
+						'id'   => ',',
891
+						'text' => __(', (comma)', 'event_espresso'),
892
+					),
893
+					array('id' => '.', 'text' => __('. (decimal)', 'event_espresso')),
894
+				),
895
+				'use_desc_4_label' => true,
896
+			),
897
+			'CNT_tel_code'    => array(
898
+				'type'       => 'TEXT',
899
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
900
+				'class'      => 'small-text',
901
+			),
902
+			'CNT_is_EU'       => array(
903
+				'type'             => 'RADIO_BTN',
904
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
905
+				'class'            => '',
906
+				'options'          => $this->_yes_no_values,
907
+				'use_desc_4_label' => true,
908
+			),
909
+		);
910
+		$this->_template_args['inputs'] = EE_Question_Form_Input::generate_question_form_inputs_for_object(
911
+			$country,
912
+			$country_input_types
913
+		);
914
+		$country_details_settings = EEH_Template::display_template(
915
+			GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
916
+			$this->_template_args,
917
+			true
918
+		);
919
+
920
+		if (defined('DOING_AJAX')) {
921
+			$notices = EE_Error::get_notices(false, false, false);
922
+			echo wp_json_encode(
923
+				array(
924
+					'return_data' => $country_details_settings,
925
+					'success'     => $notices['success'],
926
+					'errors'      => $notices['errors'],
927
+				)
928
+			);
929
+			die();
930
+		} else {
931
+			return $country_details_settings;
932
+		}
933
+	}
934
+
935
+
936
+	/**
937
+	 *        display_country_states
938
+	 *
939
+	 * @access    public
940
+	 * @param    string $CNT_ISO
941
+	 * @return string
942
+	 * @throws DomainException
943
+	 */
944
+	public function display_country_states($CNT_ISO = '')
945
+	{
946
+
947
+		$CNT_ISO = isset($this->_req_data['country']) ? sanitize_text_field($this->_req_data['country']) : $CNT_ISO;
948
+
949
+		if (! $CNT_ISO) {
950
+			return '';
951
+		}
952
+		// for ajax
953
+		remove_all_filters('FHEE__EEH_Form_Fields__label_html');
954
+		remove_all_filters('FHEE__EEH_Form_Fields__input_html');
955
+		add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'state_form_field_label_wrap'), 10, 2);
956
+		add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'state_form_field_input__wrap'), 10, 2);
957
+		$states = EEM_State::instance()->get_all_states_for_these_countries(array($CNT_ISO => $CNT_ISO));
958
+
959
+		if ($states) {
960
+			foreach ($states as $STA_ID => $state) {
961
+				if ($state instanceof EE_State) {
962
+					// STA_abbrev    STA_name    STA_active
963
+					$state_input_types = array(
964
+						'STA_abbrev' => array(
965
+							'type'       => 'TEXT',
966
+							'input_name' => 'states[' . $STA_ID . ']',
967
+							'class'      => 'mid-text',
968
+						),
969
+						'STA_name'   => array(
970
+							'type'       => 'TEXT',
971
+							'input_name' => 'states[' . $STA_ID . ']',
972
+							'class'      => 'regular-text',
973
+						),
974
+						'STA_active' => array(
975
+							'type'             => 'RADIO_BTN',
976
+							'input_name'       => 'states[' . $STA_ID . ']',
977
+							'options'          => $this->_yes_no_values,
978
+							'use_desc_4_label' => true,
979
+						),
980
+					);
981
+					$this->_template_args['states'][ $STA_ID ]['inputs'] =
982
+						EE_Question_Form_Input::generate_question_form_inputs_for_object(
983
+							$state,
984
+							$state_input_types
985
+						);
986
+					$query_args = array(
987
+						'action'     => 'delete_state',
988
+						'STA_ID'     => $STA_ID,
989
+						'CNT_ISO'    => $CNT_ISO,
990
+						'STA_abbrev' => $state->abbrev(),
991
+					);
992
+					$this->_template_args['states'][ $STA_ID ]['delete_state_url'] =
993
+						EE_Admin_Page::add_query_args_and_nonce(
994
+							$query_args,
995
+							GEN_SET_ADMIN_URL
996
+						);
997
+				}
998
+			}
999
+		} else {
1000
+			$this->_template_args['states'] = false;
1001
+		}
1002
+
1003
+		$this->_template_args['add_new_state_url'] = EE_Admin_Page::add_query_args_and_nonce(
1004
+			array('action' => 'add_new_state'),
1005
+			GEN_SET_ADMIN_URL
1006
+		);
1007
+
1008
+		$state_details_settings = EEH_Template::display_template(
1009
+			GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
1010
+			$this->_template_args,
1011
+			true
1012
+		);
1013
+
1014
+		if (defined('DOING_AJAX')) {
1015
+			$notices = EE_Error::get_notices(false, false, false);
1016
+			echo wp_json_encode(
1017
+				array(
1018
+					'return_data' => $state_details_settings,
1019
+					'success'     => $notices['success'],
1020
+					'errors'      => $notices['errors'],
1021
+				)
1022
+			);
1023
+			die();
1024
+		} else {
1025
+			return $state_details_settings;
1026
+		}
1027
+	}
1028
+
1029
+
1030
+	/**
1031
+	 *        add_new_state
1032
+	 *
1033
+	 * @access    public
1034
+	 * @return void
1035
+	 * @throws EE_Error
1036
+	 */
1037
+	public function add_new_state()
1038
+	{
1039
+
1040
+		$success = true;
1041
+
1042
+		$CNT_ISO = isset($this->_req_data['CNT_ISO'])
1043
+			? strtoupper(sanitize_text_field($this->_req_data['CNT_ISO']))
1044
+			: false;
1045
+		if (! $CNT_ISO) {
1046
+			EE_Error::add_error(
1047
+				__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
1048
+				__FILE__,
1049
+				__FUNCTION__,
1050
+				__LINE__
1051
+			);
1052
+			$success = false;
1053
+		}
1054
+		$STA_abbrev = isset($this->_req_data['STA_abbrev'])
1055
+			? sanitize_text_field($this->_req_data['STA_abbrev'])
1056
+			: false;
1057
+		if (! $STA_abbrev) {
1058
+			EE_Error::add_error(
1059
+				__('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
1060
+				__FILE__,
1061
+				__FUNCTION__,
1062
+				__LINE__
1063
+			);
1064
+			$success = false;
1065
+		}
1066
+		$STA_name = isset($this->_req_data['STA_name'])
1067
+			? sanitize_text_field($this->_req_data['STA_name'])
1068
+			: false;
1069
+		if (! $STA_name) {
1070
+			EE_Error::add_error(
1071
+				__('No State name or an invalid State name was received.', 'event_espresso'),
1072
+				__FILE__,
1073
+				__FUNCTION__,
1074
+				__LINE__
1075
+			);
1076
+			$success = false;
1077
+		}
1078
+
1079
+		if ($success) {
1080
+			$cols_n_values = array(
1081
+				'CNT_ISO'    => $CNT_ISO,
1082
+				'STA_abbrev' => $STA_abbrev,
1083
+				'STA_name'   => $STA_name,
1084
+				'STA_active' => true,
1085
+			);
1086
+			$success = EEM_State::instance()->insert($cols_n_values);
1087
+			EE_Error::add_success(__('The State was added successfully.', 'event_espresso'));
1088
+		}
1089
+
1090
+		if (defined('DOING_AJAX')) {
1091
+			$notices = EE_Error::get_notices(false, false, false);
1092
+			echo wp_json_encode(array_merge($notices, array('return_data' => $CNT_ISO)));
1093
+			die();
1094
+		} else {
1095
+			$this->_redirect_after_action($success, 'State', 'added', array('action' => 'country_settings'));
1096
+		}
1097
+	}
1098
+
1099
+
1100
+	/**
1101
+	 *        delete_state
1102
+	 *
1103
+	 * @access    public
1104
+	 * @return        boolean
1105
+	 */
1106
+	public function delete_state()
1107
+	{
1108
+		$CNT_ISO = isset($this->_req_data['CNT_ISO'])
1109
+			? strtoupper(sanitize_text_field($this->_req_data['CNT_ISO']))
1110
+			: false;
1111
+		$STA_ID = isset($this->_req_data['STA_ID'])
1112
+			? sanitize_text_field($this->_req_data['STA_ID'])
1113
+			: false;
1114
+		$STA_abbrev = isset($this->_req_data['STA_abbrev'])
1115
+			? sanitize_text_field($this->_req_data['STA_abbrev'])
1116
+			: false;
1117
+		if (! $STA_ID) {
1118
+			EE_Error::add_error(
1119
+				__('No State ID or an invalid State ID was received.', 'event_espresso'),
1120
+				__FILE__,
1121
+				__FUNCTION__,
1122
+				__LINE__
1123
+			);
1124
+			return false;
1125
+		}
1126
+
1127
+		$success = EEM_State::instance()->delete_by_ID($STA_ID);
1128
+		if ($success !== false) {
1129
+			do_action(
1130
+				'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
1131
+				$CNT_ISO,
1132
+				$STA_ID,
1133
+				array('STA_abbrev' => $STA_abbrev)
1134
+			);
1135
+			EE_Error::add_success(__('The State was deleted successfully.', 'event_espresso'));
1136
+		}
1137
+		if (defined('DOING_AJAX')) {
1138
+			$notices = EE_Error::get_notices(false, false);
1139
+			$notices['return_data'] = true;
1140
+			echo wp_json_encode($notices);
1141
+			die();
1142
+		} else {
1143
+			$this->_redirect_after_action(
1144
+				$success,
1145
+				'State',
1146
+				'deleted',
1147
+				array('action' => 'country_settings')
1148
+			);
1149
+		}
1150
+	}
1151
+
1152
+
1153
+	/**
1154
+	 *        _update_country_settings
1155
+	 *
1156
+	 * @access    protected
1157
+	 * @return void
1158
+	 * @throws EE_Error
1159
+	 */
1160
+	protected function _update_country_settings()
1161
+	{
1162
+		// grab the country ISO code
1163
+		$CNT_ISO = isset($this->_req_data['country'])
1164
+			? strtoupper(sanitize_text_field($this->_req_data['country']))
1165
+			: false;
1166
+		if (! $CNT_ISO) {
1167
+			EE_Error::add_error(
1168
+				__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
1169
+				__FILE__,
1170
+				__FUNCTION__,
1171
+				__LINE__
1172
+			);
1173
+
1174
+			return;
1175
+		}
1176
+		$cols_n_values = array();
1177
+		$cols_n_values['CNT_ISO3'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_ISO3'])
1178
+			? strtoupper(sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_ISO3']))
1179
+			: false;
1180
+		$cols_n_values['RGN_ID'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['RGN_ID'])
1181
+			? absint($this->_req_data['cntry'][ $CNT_ISO ]['RGN_ID'])
1182
+			: null;
1183
+		$cols_n_values['CNT_name'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_name'])
1184
+			? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_name'])
1185
+			: null;
1186
+		$cols_n_values['CNT_cur_code'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_code'])
1187
+			? strtoupper(sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_code']))
1188
+			: 'USD';
1189
+		$cols_n_values['CNT_cur_single'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_single'])
1190
+			? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_single'])
1191
+			: 'dollar';
1192
+		$cols_n_values['CNT_cur_plural'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_plural'])
1193
+			? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_plural'])
1194
+			: 'dollars';
1195
+		$cols_n_values['CNT_cur_sign'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_sign'])
1196
+			? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_sign'])
1197
+			: '$';
1198
+		$cols_n_values['CNT_cur_sign_b4'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_sign_b4'])
1199
+			? absint($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_sign_b4'])
1200
+			: true;
1201
+		$cols_n_values['CNT_cur_dec_plc'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_dec_plc'])
1202
+			? absint($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_dec_plc'])
1203
+			: 2;
1204
+		$cols_n_values['CNT_cur_dec_mrk'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_dec_mrk'])
1205
+			? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_dec_mrk'])
1206
+			: '.';
1207
+		$cols_n_values['CNT_cur_thsnds'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_thsnds'])
1208
+			? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_cur_thsnds'])
1209
+			: ',';
1210
+		$cols_n_values['CNT_tel_code'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_tel_code'])
1211
+			? sanitize_text_field($this->_req_data['cntry'][ $CNT_ISO ]['CNT_tel_code'])
1212
+			: null;
1213
+		$cols_n_values['CNT_is_EU'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_is_EU'])
1214
+			? absint($this->_req_data['cntry'][ $CNT_ISO ]['CNT_is_EU'])
1215
+			: false;
1216
+		$cols_n_values['CNT_active'] = isset($this->_req_data['cntry'][ $CNT_ISO ]['CNT_active'])
1217
+			? absint($this->_req_data['cntry'][ $CNT_ISO ]['CNT_active'])
1218
+			: false;
1219
+		// allow filtering of country data
1220
+		$cols_n_values = apply_filters(
1221
+			'FHEE__General_Settings_Admin_Page___update_country_settings__cols_n_values',
1222
+			$cols_n_values
1223
+		);
1224
+
1225
+		// where values
1226
+		$where_cols_n_values = array(array('CNT_ISO' => $CNT_ISO));
1227
+		// run the update
1228
+		$success = EEM_Country::instance()->update($cols_n_values, $where_cols_n_values);
1229
+
1230
+		if (isset($this->_req_data['states']) && is_array($this->_req_data['states']) && $success !== false) {
1231
+			// allow filtering of states data
1232
+			$states = apply_filters(
1233
+				'FHEE__General_Settings_Admin_Page___update_country_settings__states',
1234
+				$this->_req_data['states']
1235
+			);
1236
+
1237
+			// loop thru state data ( looks like : states[75][STA_name] )
1238
+			foreach ($states as $STA_ID => $state) {
1239
+				$cols_n_values = array(
1240
+					'CNT_ISO'    => $CNT_ISO,
1241
+					'STA_abbrev' => sanitize_text_field($state['STA_abbrev']),
1242
+					'STA_name'   => sanitize_text_field($state['STA_name']),
1243
+					'STA_active' => (bool) absint($state['STA_active']),
1244
+				);
1245
+				// where values
1246
+				$where_cols_n_values = array(array('STA_ID' => $STA_ID));
1247
+				// run the update
1248
+				$success = EEM_State::instance()->update($cols_n_values, $where_cols_n_values);
1249
+				if ($success !== false) {
1250
+					do_action(
1251
+						'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
1252
+						$CNT_ISO,
1253
+						$STA_ID,
1254
+						$cols_n_values
1255
+					);
1256
+				}
1257
+			}
1258
+		}
1259
+		// check if country being edited matches org option country, and if so, then  update EE_Config with new settings
1260
+		if (isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
1261
+			&& $CNT_ISO == EE_Registry::instance()->CFG->organization->CNT_ISO
1262
+		) {
1263
+			EE_Registry::instance()->CFG->currency = new EE_Currency_Config($CNT_ISO);
1264
+			EE_Registry::instance()->CFG->update_espresso_config();
1265
+		}
1266
+
1267
+		if ($success !== false) {
1268
+			EE_Error::add_success(
1269
+				esc_html__('Country Settings updated successfully.', 'event_espresso')
1270
+			);
1271
+		}
1272
+		$this->_redirect_after_action(
1273
+			$success,
1274
+			'',
1275
+			'',
1276
+			array('action' => 'country_settings', 'country' => $CNT_ISO),
1277
+			true
1278
+		);
1279
+	}
1280
+
1281
+
1282
+	/**
1283
+	 *        form_form_field_label_wrap
1284
+	 *
1285
+	 * @access        public
1286
+	 * @param        string $label
1287
+	 * @return        string
1288
+	 */
1289
+	public function country_form_field_label_wrap($label, $required_text)
1290
+	{
1291
+		return '
1292 1292
 			<tr>
1293 1293
 				<th>
1294 1294
 					' . $label . '
1295 1295
 				</th>';
1296
-    }
1297
-
1298
-
1299
-    /**
1300
-     *        form_form_field_input__wrap
1301
-     *
1302
-     * @access        public
1303
-     * @param        string $label
1304
-     * @return        string
1305
-     */
1306
-    public function country_form_field_input__wrap($input, $label)
1307
-    {
1308
-        return '
1296
+	}
1297
+
1298
+
1299
+	/**
1300
+	 *        form_form_field_input__wrap
1301
+	 *
1302
+	 * @access        public
1303
+	 * @param        string $label
1304
+	 * @return        string
1305
+	 */
1306
+	public function country_form_field_input__wrap($input, $label)
1307
+	{
1308
+		return '
1309 1309
 				<td class="general-settings-country-input-td">
1310 1310
 					' . $input . '
1311 1311
 				</td>
1312 1312
 			</tr>';
1313
-    }
1314
-
1315
-
1316
-    /**
1317
-     *        form_form_field_label_wrap
1318
-     *
1319
-     * @access        public
1320
-     * @param        string $label
1321
-     * @param        string $required_text
1322
-     * @return        string
1323
-     */
1324
-    public function state_form_field_label_wrap($label, $required_text)
1325
-    {
1326
-        return $required_text;
1327
-    }
1328
-
1329
-
1330
-    /**
1331
-     *        form_form_field_input__wrap
1332
-     *
1333
-     * @access        public
1334
-     * @param        string $label
1335
-     * @return        string
1336
-     */
1337
-    public function state_form_field_input__wrap($input, $label)
1338
-    {
1339
-        return '
1313
+	}
1314
+
1315
+
1316
+	/**
1317
+	 *        form_form_field_label_wrap
1318
+	 *
1319
+	 * @access        public
1320
+	 * @param        string $label
1321
+	 * @param        string $required_text
1322
+	 * @return        string
1323
+	 */
1324
+	public function state_form_field_label_wrap($label, $required_text)
1325
+	{
1326
+		return $required_text;
1327
+	}
1328
+
1329
+
1330
+	/**
1331
+	 *        form_form_field_input__wrap
1332
+	 *
1333
+	 * @access        public
1334
+	 * @param        string $label
1335
+	 * @return        string
1336
+	 */
1337
+	public function state_form_field_input__wrap($input, $label)
1338
+	{
1339
+		return '
1340 1340
 				<td class="general-settings-country-state-input-td">
1341 1341
 					' . $input . '
1342 1342
 				</td>';
1343
-    }
1344
-
1345
-
1346
-    /***********/
1347
-
1348
-
1349
-    /**
1350
-     * displays edit and view links for critical EE pages
1351
-     *
1352
-     * @access public
1353
-     * @param int $ee_page_id
1354
-     * @return string
1355
-     */
1356
-    public static function edit_view_links($ee_page_id)
1357
-    {
1358
-        $links = '<a href="'
1359
-                 . add_query_arg(
1360
-                     array('post' => $ee_page_id, 'action' => 'edit'),
1361
-                     admin_url('post.php')
1362
-                 )
1363
-                 . '" >'
1364
-                 . __('Edit', 'event_espresso')
1365
-                 . '</a>';
1366
-        $links .= ' &nbsp;|&nbsp; ';
1367
-        $links .= '<a href="' . get_permalink($ee_page_id) . '" >' . __('View', 'event_espresso') . '</a>';
1368
-
1369
-        return $links;
1370
-    }
1371
-
1372
-
1373
-    /**
1374
-     * displays page and shortcode status for critical EE pages
1375
-     *
1376
-     * @param WP page object $ee_page
1377
-     * @return string
1378
-     */
1379
-    public static function page_and_shortcode_status($ee_page, $shortcode)
1380
-    {
1381
-
1382
-        // page status
1383
-        if (isset($ee_page->post_status) && $ee_page->post_status == 'publish') {
1384
-            $pg_colour = 'green';
1385
-            $pg_status = sprintf(__('Page%sStatus%sOK', 'event_espresso'), '&nbsp;', '&nbsp;');
1386
-        } else {
1387
-            $pg_colour = 'red';
1388
-            $pg_status = sprintf(__('Page%sVisibility%sProblem', 'event_espresso'), '&nbsp;', '&nbsp;');
1389
-        }
1390
-
1391
-        // shortcode status
1392
-        if (isset($ee_page->post_content) && strpos($ee_page->post_content, $shortcode) !== false) {
1393
-            $sc_colour = 'green';
1394
-            $sc_status = sprintf(__('Shortcode%sOK', 'event_espresso'), '&nbsp;');
1395
-        } else {
1396
-            $sc_colour = 'red';
1397
-            $sc_status = sprintf(__('Shortcode%sProblem', 'event_espresso'), '&nbsp;');
1398
-        }
1399
-
1400
-        return '<span style="color:' . $pg_colour . '; margin-right:2em;"><strong>'
1401
-               . $pg_status
1402
-               . '</strong></span><span style="color:' . $sc_colour . '"><strong>' . $sc_status . '</strong></span>';
1403
-    }
1404
-
1405
-
1406
-    /**
1407
-     * generates a dropdown of all parent pages - copied from WP core
1408
-     *
1409
-     * @param int $default
1410
-     * @param int $parent
1411
-     * @param int $level
1412
-     */
1413
-    public static function page_settings_dropdown($default = 0, $parent = 0, $level = 0)
1414
-    {
1415
-        global $wpdb;
1416
-        $items = $wpdb->get_results(
1417
-            $wpdb->prepare(
1418
-                "SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
1419
-                $parent
1420
-            )
1421
-        );
1422
-
1423
-        if ($items) {
1424
-            foreach ($items as $item) {
1425
-                $pad = str_repeat('&nbsp;', $level * 3);
1426
-                if ($item->ID == $default) {
1427
-                    $current = ' selected="selected"';
1428
-                } else {
1429
-                    $current = '';
1430
-                }
1431
-
1432
-                echo "\n\t<option class='level-$level' value='$item->ID'$current>$pad "
1433
-                     . esc_html($item->post_title)
1434
-                     . "</option>";
1435
-                parent_dropdown($default, $item->ID, $level + 1);
1436
-            }
1437
-        }
1438
-    }
1439
-
1440
-
1441
-    /**
1442
-     * Loads the scripts for the privacy settings form
1443
-     */
1444
-    public function load_scripts_styles_privacy_settings()
1445
-    {
1446
-        $form_handler = LoaderFactory::getLoader()->getShared('EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler');
1447
-        $form_handler->enqueueStylesAndScripts();
1448
-    }
1449
-
1450
-
1451
-    /**
1452
-     * display the privacy settings form
1453
-     */
1454
-    public function privacySettings()
1455
-    {
1456
-        $this->_set_add_edit_form_tags('update_privacy_settings');
1457
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
1458
-        $form_handler = LoaderFactory::getLoader()->getShared('EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler');
1459
-        $this->_template_args['admin_page_content'] = $form_handler->display();
1460
-        $this->display_admin_page_with_sidebar();
1461
-    }
1462
-
1463
-
1464
-    /**
1465
-     * Update the privacy settings from form data
1466
-     */
1467
-    public function updatePrivacySettings()
1468
-    {
1469
-        $form_handler = LoaderFactory::getLoader()->getShared('EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler');
1470
-        $success = $form_handler->process($this->get_request_data());
1471
-        $this->_redirect_after_action(
1472
-            $success,
1473
-            esc_html__('Registration Form Options', 'event_espresso'),
1474
-            'updated',
1475
-            array('action' => 'privacy_settings')
1476
-        );
1477
-    }
1343
+	}
1344
+
1345
+
1346
+	/***********/
1347
+
1348
+
1349
+	/**
1350
+	 * displays edit and view links for critical EE pages
1351
+	 *
1352
+	 * @access public
1353
+	 * @param int $ee_page_id
1354
+	 * @return string
1355
+	 */
1356
+	public static function edit_view_links($ee_page_id)
1357
+	{
1358
+		$links = '<a href="'
1359
+				 . add_query_arg(
1360
+					 array('post' => $ee_page_id, 'action' => 'edit'),
1361
+					 admin_url('post.php')
1362
+				 )
1363
+				 . '" >'
1364
+				 . __('Edit', 'event_espresso')
1365
+				 . '</a>';
1366
+		$links .= ' &nbsp;|&nbsp; ';
1367
+		$links .= '<a href="' . get_permalink($ee_page_id) . '" >' . __('View', 'event_espresso') . '</a>';
1368
+
1369
+		return $links;
1370
+	}
1371
+
1372
+
1373
+	/**
1374
+	 * displays page and shortcode status for critical EE pages
1375
+	 *
1376
+	 * @param WP page object $ee_page
1377
+	 * @return string
1378
+	 */
1379
+	public static function page_and_shortcode_status($ee_page, $shortcode)
1380
+	{
1381
+
1382
+		// page status
1383
+		if (isset($ee_page->post_status) && $ee_page->post_status == 'publish') {
1384
+			$pg_colour = 'green';
1385
+			$pg_status = sprintf(__('Page%sStatus%sOK', 'event_espresso'), '&nbsp;', '&nbsp;');
1386
+		} else {
1387
+			$pg_colour = 'red';
1388
+			$pg_status = sprintf(__('Page%sVisibility%sProblem', 'event_espresso'), '&nbsp;', '&nbsp;');
1389
+		}
1390
+
1391
+		// shortcode status
1392
+		if (isset($ee_page->post_content) && strpos($ee_page->post_content, $shortcode) !== false) {
1393
+			$sc_colour = 'green';
1394
+			$sc_status = sprintf(__('Shortcode%sOK', 'event_espresso'), '&nbsp;');
1395
+		} else {
1396
+			$sc_colour = 'red';
1397
+			$sc_status = sprintf(__('Shortcode%sProblem', 'event_espresso'), '&nbsp;');
1398
+		}
1399
+
1400
+		return '<span style="color:' . $pg_colour . '; margin-right:2em;"><strong>'
1401
+			   . $pg_status
1402
+			   . '</strong></span><span style="color:' . $sc_colour . '"><strong>' . $sc_status . '</strong></span>';
1403
+	}
1404
+
1405
+
1406
+	/**
1407
+	 * generates a dropdown of all parent pages - copied from WP core
1408
+	 *
1409
+	 * @param int $default
1410
+	 * @param int $parent
1411
+	 * @param int $level
1412
+	 */
1413
+	public static function page_settings_dropdown($default = 0, $parent = 0, $level = 0)
1414
+	{
1415
+		global $wpdb;
1416
+		$items = $wpdb->get_results(
1417
+			$wpdb->prepare(
1418
+				"SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
1419
+				$parent
1420
+			)
1421
+		);
1422
+
1423
+		if ($items) {
1424
+			foreach ($items as $item) {
1425
+				$pad = str_repeat('&nbsp;', $level * 3);
1426
+				if ($item->ID == $default) {
1427
+					$current = ' selected="selected"';
1428
+				} else {
1429
+					$current = '';
1430
+				}
1431
+
1432
+				echo "\n\t<option class='level-$level' value='$item->ID'$current>$pad "
1433
+					 . esc_html($item->post_title)
1434
+					 . "</option>";
1435
+				parent_dropdown($default, $item->ID, $level + 1);
1436
+			}
1437
+		}
1438
+	}
1439
+
1440
+
1441
+	/**
1442
+	 * Loads the scripts for the privacy settings form
1443
+	 */
1444
+	public function load_scripts_styles_privacy_settings()
1445
+	{
1446
+		$form_handler = LoaderFactory::getLoader()->getShared('EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler');
1447
+		$form_handler->enqueueStylesAndScripts();
1448
+	}
1449
+
1450
+
1451
+	/**
1452
+	 * display the privacy settings form
1453
+	 */
1454
+	public function privacySettings()
1455
+	{
1456
+		$this->_set_add_edit_form_tags('update_privacy_settings');
1457
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
1458
+		$form_handler = LoaderFactory::getLoader()->getShared('EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler');
1459
+		$this->_template_args['admin_page_content'] = $form_handler->display();
1460
+		$this->display_admin_page_with_sidebar();
1461
+	}
1462
+
1463
+
1464
+	/**
1465
+	 * Update the privacy settings from form data
1466
+	 */
1467
+	public function updatePrivacySettings()
1468
+	{
1469
+		$form_handler = LoaderFactory::getLoader()->getShared('EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler');
1470
+		$success = $form_handler->process($this->get_request_data());
1471
+		$this->_redirect_after_action(
1472
+			$success,
1473
+			esc_html__('Registration Form Options', 'event_espresso'),
1474
+			'updated',
1475
+			array('action' => 'privacy_settings')
1476
+		);
1477
+	}
1478 1478
 
1479 1479
 }
Please login to merge, or discard this patch.
core/EE_Config.core.php 1 patch
Indentation   +3131 added lines, -3131 removed lines patch added patch discarded remove patch
@@ -14,2520 +14,2520 @@  discard block
 block discarded – undo
14 14
 final class EE_Config implements ResettableInterface
15 15
 {
16 16
 
17
-    const OPTION_NAME = 'ee_config';
18
-
19
-    const LOG_NAME = 'ee_config_log';
20
-
21
-    const LOG_LENGTH = 100;
22
-
23
-    const ADDON_OPTION_NAMES = 'ee_config_option_names';
24
-
25
-    /**
26
-     *    instance of the EE_Config object
27
-     *
28
-     * @var    EE_Config $_instance
29
-     * @access    private
30
-     */
31
-    private static $_instance;
32
-
33
-    /**
34
-     * @var boolean $_logging_enabled
35
-     */
36
-    private static $_logging_enabled = false;
37
-
38
-    /**
39
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
40
-     */
41
-    private $legacy_shortcodes_manager;
42
-
43
-    /**
44
-     * An StdClass whose property names are addon slugs,
45
-     * and values are their config classes
46
-     *
47
-     * @var StdClass
48
-     */
49
-    public $addons;
50
-
51
-    /**
52
-     * @var EE_Admin_Config
53
-     */
54
-    public $admin;
55
-
56
-    /**
57
-     * @var EE_Core_Config
58
-     */
59
-    public $core;
60
-
61
-    /**
62
-     * @var EE_Currency_Config
63
-     */
64
-    public $currency;
65
-
66
-    /**
67
-     * @var EE_Organization_Config
68
-     */
69
-    public $organization;
70
-
71
-    /**
72
-     * @var EE_Registration_Config
73
-     */
74
-    public $registration;
75
-
76
-    /**
77
-     * @var EE_Template_Config
78
-     */
79
-    public $template_settings;
80
-
81
-    /**
82
-     * Holds EE environment values.
83
-     *
84
-     * @var EE_Environment_Config
85
-     */
86
-    public $environment;
87
-
88
-    /**
89
-     * settings pertaining to Google maps
90
-     *
91
-     * @var EE_Map_Config
92
-     */
93
-    public $map_settings;
94
-
95
-    /**
96
-     * settings pertaining to Taxes
97
-     *
98
-     * @var EE_Tax_Config
99
-     */
100
-    public $tax_settings;
101
-
102
-    /**
103
-     * Settings pertaining to global messages settings.
104
-     *
105
-     * @var EE_Messages_Config
106
-     */
107
-    public $messages;
108
-
109
-    /**
110
-     * @deprecated
111
-     * @var EE_Gateway_Config
112
-     */
113
-    public $gateway;
114
-
115
-    /**
116
-     * @var    array $_addon_option_names
117
-     * @access    private
118
-     */
119
-    private $_addon_option_names = array();
120
-
121
-    /**
122
-     * @var    array $_module_route_map
123
-     * @access    private
124
-     */
125
-    private static $_module_route_map = array();
126
-
127
-    /**
128
-     * @var    array $_module_forward_map
129
-     * @access    private
130
-     */
131
-    private static $_module_forward_map = array();
132
-
133
-    /**
134
-     * @var    array $_module_view_map
135
-     * @access    private
136
-     */
137
-    private static $_module_view_map = array();
138
-
139
-
140
-    /**
141
-     * @singleton method used to instantiate class object
142
-     * @access    public
143
-     * @return EE_Config instance
144
-     */
145
-    public static function instance()
146
-    {
147
-        // check if class object is instantiated, and instantiated properly
148
-        if (! self::$_instance instanceof EE_Config) {
149
-            self::$_instance = new self();
150
-        }
151
-        return self::$_instance;
152
-    }
153
-
154
-
155
-    /**
156
-     * Resets the config
157
-     *
158
-     * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
159
-     *                               (default) leaves the database alone, and merely resets the EE_Config object to
160
-     *                               reflect its state in the database
161
-     * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
162
-     *                               $_instance as NULL. Useful in case you want to forget about the old instance on
163
-     *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
164
-     *                               site was put into maintenance mode)
165
-     * @return EE_Config
166
-     */
167
-    public static function reset($hard_reset = false, $reinstantiate = true)
168
-    {
169
-        if (self::$_instance instanceof EE_Config) {
170
-            if ($hard_reset) {
171
-                self::$_instance->legacy_shortcodes_manager = null;
172
-                self::$_instance->_addon_option_names = array();
173
-                self::$_instance->_initialize_config();
174
-                self::$_instance->update_espresso_config();
175
-            }
176
-            self::$_instance->update_addon_option_names();
177
-        }
178
-        self::$_instance = null;
179
-        // we don't need to reset the static properties imo because those should
180
-        // only change when a module is added or removed. Currently we don't
181
-        // support removing a module during a request when it previously existed
182
-        if ($reinstantiate) {
183
-            return self::instance();
184
-        } else {
185
-            return null;
186
-        }
187
-    }
188
-
189
-
190
-    /**
191
-     *    class constructor
192
-     *
193
-     * @access    private
194
-     */
195
-    private function __construct()
196
-    {
197
-        do_action('AHEE__EE_Config__construct__begin', $this);
198
-        EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
199
-        // setup empty config classes
200
-        $this->_initialize_config();
201
-        // load existing EE site settings
202
-        $this->_load_core_config();
203
-        // confirm everything loaded correctly and set filtered defaults if not
204
-        $this->_verify_config();
205
-        //  register shortcodes and modules
206
-        add_action(
207
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
208
-            array($this, 'register_shortcodes_and_modules'),
209
-            999
210
-        );
211
-        //  initialize shortcodes and modules
212
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
213
-        // register widgets
214
-        add_action('widgets_init', array($this, 'widgets_init'), 10);
215
-        // shutdown
216
-        add_action('shutdown', array($this, 'shutdown'), 10);
217
-        // construct__end hook
218
-        do_action('AHEE__EE_Config__construct__end', $this);
219
-        // hardcoded hack
220
-        $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
221
-    }
222
-
223
-
224
-    /**
225
-     * @return boolean
226
-     */
227
-    public static function logging_enabled()
228
-    {
229
-        return self::$_logging_enabled;
230
-    }
231
-
232
-
233
-    /**
234
-     * use to get the current theme if needed from static context
235
-     *
236
-     * @return string current theme set.
237
-     */
238
-    public static function get_current_theme()
239
-    {
240
-        return isset(self::$_instance->template_settings->current_espresso_theme)
241
-            ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
242
-    }
243
-
244
-
245
-    /**
246
-     *        _initialize_config
247
-     *
248
-     * @access private
249
-     * @return void
250
-     */
251
-    private function _initialize_config()
252
-    {
253
-        EE_Config::trim_log();
254
-        // set defaults
255
-        $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
256
-        $this->addons = new stdClass();
257
-        // set _module_route_map
258
-        EE_Config::$_module_route_map = array();
259
-        // set _module_forward_map
260
-        EE_Config::$_module_forward_map = array();
261
-        // set _module_view_map
262
-        EE_Config::$_module_view_map = array();
263
-    }
264
-
265
-
266
-    /**
267
-     *        load core plugin configuration
268
-     *
269
-     * @access private
270
-     * @return void
271
-     */
272
-    private function _load_core_config()
273
-    {
274
-        // load_core_config__start hook
275
-        do_action('AHEE__EE_Config___load_core_config__start', $this);
276
-        $espresso_config = $this->get_espresso_config();
277
-        foreach ($espresso_config as $config => $settings) {
278
-            // load_core_config__start hook
279
-            $settings = apply_filters(
280
-                'FHEE__EE_Config___load_core_config__config_settings',
281
-                $settings,
282
-                $config,
283
-                $this
284
-            );
285
-            if (is_object($settings) && property_exists($this, $config)) {
286
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
287
-                // call configs populate method to ensure any defaults are set for empty values.
288
-                if (method_exists($settings, 'populate')) {
289
-                    $this->{$config}->populate();
290
-                }
291
-                if (method_exists($settings, 'do_hooks')) {
292
-                    $this->{$config}->do_hooks();
293
-                }
294
-            }
295
-        }
296
-        if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
297
-            $this->update_espresso_config();
298
-        }
299
-        // load_core_config__end hook
300
-        do_action('AHEE__EE_Config___load_core_config__end', $this);
301
-    }
302
-
303
-
304
-    /**
305
-     *    _verify_config
306
-     *
307
-     * @access    protected
308
-     * @return    void
309
-     */
310
-    protected function _verify_config()
311
-    {
312
-        $this->core = $this->core instanceof EE_Core_Config
313
-            ? $this->core
314
-            : new EE_Core_Config();
315
-        $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
316
-        $this->organization = $this->organization instanceof EE_Organization_Config
317
-            ? $this->organization
318
-            : new EE_Organization_Config();
319
-        $this->organization = apply_filters(
320
-            'FHEE__EE_Config___initialize_config__organization',
321
-            $this->organization
322
-        );
323
-        $this->currency = $this->currency instanceof EE_Currency_Config
324
-            ? $this->currency
325
-            : new EE_Currency_Config();
326
-        $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
327
-        $this->registration = $this->registration instanceof EE_Registration_Config
328
-            ? $this->registration
329
-            : new EE_Registration_Config();
330
-        $this->registration = apply_filters(
331
-            'FHEE__EE_Config___initialize_config__registration',
332
-            $this->registration
333
-        );
334
-        $this->admin = $this->admin instanceof EE_Admin_Config
335
-            ? $this->admin
336
-            : new EE_Admin_Config();
337
-        $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
338
-        $this->template_settings = $this->template_settings instanceof EE_Template_Config
339
-            ? $this->template_settings
340
-            : new EE_Template_Config();
341
-        $this->template_settings = apply_filters(
342
-            'FHEE__EE_Config___initialize_config__template_settings',
343
-            $this->template_settings
344
-        );
345
-        $this->map_settings = $this->map_settings instanceof EE_Map_Config
346
-            ? $this->map_settings
347
-            : new EE_Map_Config();
348
-        $this->map_settings = apply_filters(
349
-            'FHEE__EE_Config___initialize_config__map_settings',
350
-            $this->map_settings
351
-        );
352
-        $this->environment = $this->environment instanceof EE_Environment_Config
353
-            ? $this->environment
354
-            : new EE_Environment_Config();
355
-        $this->environment = apply_filters(
356
-            'FHEE__EE_Config___initialize_config__environment',
357
-            $this->environment
358
-        );
359
-        $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
360
-            ? $this->tax_settings
361
-            : new EE_Tax_Config();
362
-        $this->tax_settings = apply_filters(
363
-            'FHEE__EE_Config___initialize_config__tax_settings',
364
-            $this->tax_settings
365
-        );
366
-        $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
367
-        $this->messages = $this->messages instanceof EE_Messages_Config
368
-            ? $this->messages
369
-            : new EE_Messages_Config();
370
-        $this->gateway = $this->gateway instanceof EE_Gateway_Config
371
-            ? $this->gateway
372
-            : new EE_Gateway_Config();
373
-        $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
374
-        $this->legacy_shortcodes_manager = null;
375
-    }
376
-
377
-
378
-    /**
379
-     *    get_espresso_config
380
-     *
381
-     * @access    public
382
-     * @return    array of espresso config stuff
383
-     */
384
-    public function get_espresso_config()
385
-    {
386
-        // grab espresso configuration
387
-        return apply_filters(
388
-            'FHEE__EE_Config__get_espresso_config__CFG',
389
-            get_option(EE_Config::OPTION_NAME, array())
390
-        );
391
-    }
392
-
393
-
394
-    /**
395
-     *    double_check_config_comparison
396
-     *
397
-     * @access    public
398
-     * @param string $option
399
-     * @param        $old_value
400
-     * @param        $value
401
-     */
402
-    public function double_check_config_comparison($option = '', $old_value, $value)
403
-    {
404
-        // make sure we're checking the ee config
405
-        if ($option === EE_Config::OPTION_NAME) {
406
-            // run a loose comparison of the old value against the new value for type and properties,
407
-            // but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
408
-            if ($value != $old_value) {
409
-                // if they are NOT the same, then remove the hook,
410
-                // which means the subsequent update results will be based solely on the update query results
411
-                // the reason we do this is because, as stated above,
412
-                // WP update_option performs an exact instance comparison (===) on any update values passed to it
413
-                // this happens PRIOR to serialization and any subsequent update.
414
-                // If values are found to match their previous old value,
415
-                // then WP bails before performing any update.
416
-                // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
417
-                // it just pulled from the db, with the one being passed to it (which will not match).
418
-                // HOWEVER, once the object is serialized and passed off to MySQL to update,
419
-                // MySQL MAY ALSO NOT perform the update because
420
-                // the string it sees in the db looks the same as the new one it has been passed!!!
421
-                // This results in the query returning an "affected rows" value of ZERO,
422
-                // which gets returned immediately by WP update_option and looks like an error.
423
-                remove_action('update_option', array($this, 'check_config_updated'));
424
-            }
425
-        }
426
-    }
427
-
428
-
429
-    /**
430
-     *    update_espresso_config
431
-     *
432
-     * @access   public
433
-     */
434
-    protected function _reset_espresso_addon_config()
435
-    {
436
-        $this->_addon_option_names = array();
437
-        foreach ($this->addons as $addon_name => $addon_config_obj) {
438
-            $addon_config_obj = maybe_unserialize($addon_config_obj);
439
-            if ($addon_config_obj instanceof EE_Config_Base) {
440
-                $this->update_config('addons', $addon_name, $addon_config_obj, false);
441
-            }
442
-            $this->addons->{$addon_name} = null;
443
-        }
444
-    }
445
-
446
-
447
-    /**
448
-     *    update_espresso_config
449
-     *
450
-     * @access   public
451
-     * @param   bool $add_success
452
-     * @param   bool $add_error
453
-     * @return   bool
454
-     */
455
-    public function update_espresso_config($add_success = false, $add_error = true)
456
-    {
457
-        // don't allow config updates during WP heartbeats
458
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
459
-            return false;
460
-        }
461
-        // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
462
-        // $clone = clone( self::$_instance );
463
-        // self::$_instance = NULL;
464
-        do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
465
-        $this->_reset_espresso_addon_config();
466
-        // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
467
-        // but BEFORE the actual update occurs
468
-        add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
469
-        // don't want to persist legacy_shortcodes_manager, but don't want to lose it either
470
-        $legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
471
-        $this->legacy_shortcodes_manager = null;
472
-        // now update "ee_config"
473
-        $saved = update_option(EE_Config::OPTION_NAME, $this);
474
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
475
-        EE_Config::log(EE_Config::OPTION_NAME);
476
-        // if not saved... check if the hook we just added still exists;
477
-        // if it does, it means one of two things:
478
-        // that update_option bailed at the($value === $old_value) conditional,
479
-        // or...
480
-        // the db update query returned 0 rows affected
481
-        // (probably because the data  value was the same from it's perspective)
482
-        // so the existence of the hook means that a negative result from update_option is NOT an error,
483
-        // but just means no update occurred, so don't display an error to the user.
484
-        // BUT... if update_option returns FALSE, AND the hook is missing,
485
-        // then it means that something truly went wrong
486
-        $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
487
-        // remove our action since we don't want it in the system anymore
488
-        remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
489
-        do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
490
-        // self::$_instance = $clone;
491
-        // unset( $clone );
492
-        // if config remains the same or was updated successfully
493
-        if ($saved) {
494
-            if ($add_success) {
495
-                EE_Error::add_success(
496
-                    __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
497
-                    __FILE__,
498
-                    __FUNCTION__,
499
-                    __LINE__
500
-                );
501
-            }
502
-            return true;
503
-        } else {
504
-            if ($add_error) {
505
-                EE_Error::add_error(
506
-                    __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
507
-                    __FILE__,
508
-                    __FUNCTION__,
509
-                    __LINE__
510
-                );
511
-            }
512
-            return false;
513
-        }
514
-    }
515
-
516
-
517
-    /**
518
-     *    _verify_config_params
519
-     *
520
-     * @access    private
521
-     * @param    string         $section
522
-     * @param    string         $name
523
-     * @param    string         $config_class
524
-     * @param    EE_Config_Base $config_obj
525
-     * @param    array          $tests_to_run
526
-     * @param    bool           $display_errors
527
-     * @return    bool    TRUE on success, FALSE on fail
528
-     */
529
-    private function _verify_config_params(
530
-        $section = '',
531
-        $name = '',
532
-        $config_class = '',
533
-        $config_obj = null,
534
-        $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
535
-        $display_errors = true
536
-    ) {
537
-        try {
538
-            foreach ($tests_to_run as $test) {
539
-                switch ($test) {
540
-                    // TEST #1 : check that section was set
541
-                    case 1:
542
-                        if (empty($section)) {
543
-                            if ($display_errors) {
544
-                                throw new EE_Error(
545
-                                    sprintf(
546
-                                        __(
547
-                                            'No configuration section has been provided while attempting to save "%s".',
548
-                                            'event_espresso'
549
-                                        ),
550
-                                        $config_class
551
-                                    )
552
-                                );
553
-                            }
554
-                            return false;
555
-                        }
556
-                        break;
557
-                    // TEST #2 : check that settings section exists
558
-                    case 2:
559
-                        if (! isset($this->{$section})) {
560
-                            if ($display_errors) {
561
-                                throw new EE_Error(
562
-                                    sprintf(
563
-                                        __('The "%s" configuration section does not exist.', 'event_espresso'),
564
-                                        $section
565
-                                    )
566
-                                );
567
-                            }
568
-                            return false;
569
-                        }
570
-                        break;
571
-                    // TEST #3 : check that section is the proper format
572
-                    case 3:
573
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
574
-                        ) {
575
-                            if ($display_errors) {
576
-                                throw new EE_Error(
577
-                                    sprintf(
578
-                                        __(
579
-                                            'The "%s" configuration settings have not been formatted correctly.',
580
-                                            'event_espresso'
581
-                                        ),
582
-                                        $section
583
-                                    )
584
-                                );
585
-                            }
586
-                            return false;
587
-                        }
588
-                        break;
589
-                    // TEST #4 : check that config section name has been set
590
-                    case 4:
591
-                        if (empty($name)) {
592
-                            if ($display_errors) {
593
-                                throw new EE_Error(
594
-                                    __(
595
-                                        'No name has been provided for the specific configuration section.',
596
-                                        'event_espresso'
597
-                                    )
598
-                                );
599
-                            }
600
-                            return false;
601
-                        }
602
-                        break;
603
-                    // TEST #5 : check that a config class name has been set
604
-                    case 5:
605
-                        if (empty($config_class)) {
606
-                            if ($display_errors) {
607
-                                throw new EE_Error(
608
-                                    __(
609
-                                        'No class name has been provided for the specific configuration section.',
610
-                                        'event_espresso'
611
-                                    )
612
-                                );
613
-                            }
614
-                            return false;
615
-                        }
616
-                        break;
617
-                    // TEST #6 : verify config class is accessible
618
-                    case 6:
619
-                        if (! class_exists($config_class)) {
620
-                            if ($display_errors) {
621
-                                throw new EE_Error(
622
-                                    sprintf(
623
-                                        __(
624
-                                            'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
625
-                                            'event_espresso'
626
-                                        ),
627
-                                        $config_class
628
-                                    )
629
-                                );
630
-                            }
631
-                            return false;
632
-                        }
633
-                        break;
634
-                    // TEST #7 : check that config has even been set
635
-                    case 7:
636
-                        if (! isset($this->{$section}->{$name})) {
637
-                            if ($display_errors) {
638
-                                throw new EE_Error(
639
-                                    sprintf(
640
-                                        __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
641
-                                        $section,
642
-                                        $name
643
-                                    )
644
-                                );
645
-                            }
646
-                            return false;
647
-                        } else {
648
-                            // and make sure it's not serialized
649
-                            $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
650
-                        }
651
-                        break;
652
-                    // TEST #8 : check that config is the requested type
653
-                    case 8:
654
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
655
-                            if ($display_errors) {
656
-                                throw new EE_Error(
657
-                                    sprintf(
658
-                                        __(
659
-                                            'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
660
-                                            'event_espresso'
661
-                                        ),
662
-                                        $section,
663
-                                        $name,
664
-                                        $config_class
665
-                                    )
666
-                                );
667
-                            }
668
-                            return false;
669
-                        }
670
-                        break;
671
-                    // TEST #9 : verify config object
672
-                    case 9:
673
-                        if (! $config_obj instanceof EE_Config_Base) {
674
-                            if ($display_errors) {
675
-                                throw new EE_Error(
676
-                                    sprintf(
677
-                                        __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
678
-                                        print_r($config_obj, true)
679
-                                    )
680
-                                );
681
-                            }
682
-                            return false;
683
-                        }
684
-                        break;
685
-                }
686
-            }
687
-        } catch (EE_Error $e) {
688
-            $e->get_error();
689
-        }
690
-        // you have successfully run the gauntlet
691
-        return true;
692
-    }
693
-
694
-
695
-    /**
696
-     *    _generate_config_option_name
697
-     *
698
-     * @access        protected
699
-     * @param        string $section
700
-     * @param        string $name
701
-     * @return        string
702
-     */
703
-    private function _generate_config_option_name($section = '', $name = '')
704
-    {
705
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
706
-    }
707
-
708
-
709
-    /**
710
-     *    _set_config_class
711
-     * ensures that a config class is set, either from a passed config class or one generated from the config name
712
-     *
713
-     * @access    private
714
-     * @param    string $config_class
715
-     * @param    string $name
716
-     * @return    string
717
-     */
718
-    private function _set_config_class($config_class = '', $name = '')
719
-    {
720
-        return ! empty($config_class)
721
-            ? $config_class
722
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
723
-    }
724
-
725
-
726
-    /**
727
-     *    set_config
728
-     *
729
-     * @access    protected
730
-     * @param    string         $section
731
-     * @param    string         $name
732
-     * @param    string         $config_class
733
-     * @param    EE_Config_Base $config_obj
734
-     * @return    EE_Config_Base
735
-     */
736
-    public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
737
-    {
738
-        // ensure config class is set to something
739
-        $config_class = $this->_set_config_class($config_class, $name);
740
-        // run tests 1-4, 6, and 7 to verify all config params are set and valid
741
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
742
-            return null;
743
-        }
744
-        $config_option_name = $this->_generate_config_option_name($section, $name);
745
-        // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
746
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
747
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
748
-            $this->update_addon_option_names();
749
-        }
750
-        // verify the incoming config object but suppress errors
751
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
752
-            $config_obj = new $config_class();
753
-        }
754
-        if (get_option($config_option_name)) {
755
-            EE_Config::log($config_option_name);
756
-            update_option($config_option_name, $config_obj);
757
-            $this->{$section}->{$name} = $config_obj;
758
-            return $this->{$section}->{$name};
759
-        } else {
760
-            // create a wp-option for this config
761
-            if (add_option($config_option_name, $config_obj, '', 'no')) {
762
-                $this->{$section}->{$name} = maybe_unserialize($config_obj);
763
-                return $this->{$section}->{$name};
764
-            } else {
765
-                EE_Error::add_error(
766
-                    sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
767
-                    __FILE__,
768
-                    __FUNCTION__,
769
-                    __LINE__
770
-                );
771
-                return null;
772
-            }
773
-        }
774
-    }
775
-
776
-
777
-    /**
778
-     *    update_config
779
-     * Important: the config object must ALREADY be set, otherwise this will produce an error.
780
-     *
781
-     * @access    public
782
-     * @param    string                $section
783
-     * @param    string                $name
784
-     * @param    EE_Config_Base|string $config_obj
785
-     * @param    bool                  $throw_errors
786
-     * @return    bool
787
-     */
788
-    public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
789
-    {
790
-        // don't allow config updates during WP heartbeats
791
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
792
-            return false;
793
-        }
794
-        $config_obj = maybe_unserialize($config_obj);
795
-        // get class name of the incoming object
796
-        $config_class = get_class($config_obj);
797
-        // run tests 1-5 and 9 to verify config
798
-        if (! $this->_verify_config_params(
799
-            $section,
800
-            $name,
801
-            $config_class,
802
-            $config_obj,
803
-            array(1, 2, 3, 4, 7, 9)
804
-        )
805
-        ) {
806
-            return false;
807
-        }
808
-        $config_option_name = $this->_generate_config_option_name($section, $name);
809
-        // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
810
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
811
-            // save new config to db
812
-            if ($this->set_config($section, $name, $config_class, $config_obj)) {
813
-                return true;
814
-            }
815
-        } else {
816
-            // first check if the record already exists
817
-            $existing_config = get_option($config_option_name);
818
-            $config_obj = serialize($config_obj);
819
-            // just return if db record is already up to date (NOT type safe comparison)
820
-            if ($existing_config == $config_obj) {
821
-                $this->{$section}->{$name} = $config_obj;
822
-                return true;
823
-            } elseif (update_option($config_option_name, $config_obj)) {
824
-                EE_Config::log($config_option_name);
825
-                // update wp-option for this config class
826
-                $this->{$section}->{$name} = $config_obj;
827
-                return true;
828
-            } elseif ($throw_errors) {
829
-                EE_Error::add_error(
830
-                    sprintf(
831
-                        __(
832
-                            'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
833
-                            'event_espresso'
834
-                        ),
835
-                        $config_class,
836
-                        'EE_Config->' . $section . '->' . $name
837
-                    ),
838
-                    __FILE__,
839
-                    __FUNCTION__,
840
-                    __LINE__
841
-                );
842
-            }
843
-        }
844
-        return false;
845
-    }
846
-
847
-
848
-    /**
849
-     *    get_config
850
-     *
851
-     * @access    public
852
-     * @param    string $section
853
-     * @param    string $name
854
-     * @param    string $config_class
855
-     * @return    mixed EE_Config_Base | NULL
856
-     */
857
-    public function get_config($section = '', $name = '', $config_class = '')
858
-    {
859
-        // ensure config class is set to something
860
-        $config_class = $this->_set_config_class($config_class, $name);
861
-        // run tests 1-4, 6 and 7 to verify that all params have been set
862
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
863
-            return null;
864
-        }
865
-        // now test if the requested config object exists, but suppress errors
866
-        if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
867
-            // config already exists, so pass it back
868
-            return $this->{$section}->{$name};
869
-        }
870
-        // load config option from db if it exists
871
-        $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
872
-        // verify the newly retrieved config object, but suppress errors
873
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
874
-            // config is good, so set it and pass it back
875
-            $this->{$section}->{$name} = $config_obj;
876
-            return $this->{$section}->{$name};
877
-        }
878
-        // oops! $config_obj is not already set and does not exist in the db, so create a new one
879
-        $config_obj = $this->set_config($section, $name, $config_class);
880
-        // verify the newly created config object
881
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
882
-            return $this->{$section}->{$name};
883
-        } else {
884
-            EE_Error::add_error(
885
-                sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
886
-                __FILE__,
887
-                __FUNCTION__,
888
-                __LINE__
889
-            );
890
-        }
891
-        return null;
892
-    }
893
-
894
-
895
-    /**
896
-     *    get_config_option
897
-     *
898
-     * @access    public
899
-     * @param    string $config_option_name
900
-     * @return    mixed EE_Config_Base | FALSE
901
-     */
902
-    public function get_config_option($config_option_name = '')
903
-    {
904
-        // retrieve the wp-option for this config class.
905
-        $config_option = maybe_unserialize(get_option($config_option_name, array()));
906
-        if (empty($config_option)) {
907
-            EE_Config::log($config_option_name . '-NOT-FOUND');
908
-        }
909
-        return $config_option;
910
-    }
911
-
912
-
913
-    /**
914
-     * log
915
-     *
916
-     * @param string $config_option_name
917
-     */
918
-    public static function log($config_option_name = '')
919
-    {
920
-        if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
921
-            $config_log = get_option(EE_Config::LOG_NAME, array());
922
-            // copy incoming $_REQUEST and sanitize it so we can save it
923
-            $_request = $_REQUEST;
924
-            array_walk_recursive($_request, 'sanitize_text_field');
925
-            $config_log[ (string) microtime(true) ] = array(
926
-                'config_name' => $config_option_name,
927
-                'request'     => $_request,
928
-            );
929
-            update_option(EE_Config::LOG_NAME, $config_log);
930
-        }
931
-    }
932
-
933
-
934
-    /**
935
-     * trim_log
936
-     * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
937
-     */
938
-    public static function trim_log()
939
-    {
940
-        if (! EE_Config::logging_enabled()) {
941
-            return;
942
-        }
943
-        $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
944
-        $log_length = count($config_log);
945
-        if ($log_length > EE_Config::LOG_LENGTH) {
946
-            ksort($config_log);
947
-            $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
948
-            update_option(EE_Config::LOG_NAME, $config_log);
949
-        }
950
-    }
951
-
952
-
953
-    /**
954
-     *    get_page_for_posts
955
-     *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
956
-     *    wp-option "page_for_posts", or "posts" if no page is selected
957
-     *
958
-     * @access    public
959
-     * @return    string
960
-     */
961
-    public static function get_page_for_posts()
962
-    {
963
-        $page_for_posts = get_option('page_for_posts');
964
-        if (! $page_for_posts) {
965
-            return 'posts';
966
-        }
967
-        /** @type WPDB $wpdb */
968
-        global $wpdb;
969
-        $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
970
-        return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
971
-    }
972
-
973
-
974
-    /**
975
-     *    register_shortcodes_and_modules.
976
-     *    At this point, it's too early to tell if we're maintenance mode or not.
977
-     *    In fact, this is where we give modules a chance to let core know they exist
978
-     *    so they can help trigger maintenance mode if it's needed
979
-     *
980
-     * @access    public
981
-     * @return    void
982
-     */
983
-    public function register_shortcodes_and_modules()
984
-    {
985
-        // allow modules to set hooks for the rest of the system
986
-        EE_Registry::instance()->modules = $this->_register_modules();
987
-    }
988
-
989
-
990
-    /**
991
-     *    initialize_shortcodes_and_modules
992
-     *    meaning they can start adding their hooks to get stuff done
993
-     *
994
-     * @access    public
995
-     * @return    void
996
-     */
997
-    public function initialize_shortcodes_and_modules()
998
-    {
999
-        // allow modules to set hooks for the rest of the system
1000
-        $this->_initialize_modules();
1001
-    }
1002
-
1003
-
1004
-    /**
1005
-     *    widgets_init
1006
-     *
1007
-     * @access private
1008
-     * @return void
1009
-     */
1010
-    public function widgets_init()
1011
-    {
1012
-        // only init widgets on admin pages when not in complete maintenance, and
1013
-        // on frontend when not in any maintenance mode
1014
-        if (! EE_Maintenance_Mode::instance()->level()
1015
-            || (
1016
-                is_admin()
1017
-                && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
1018
-            )
1019
-        ) {
1020
-            // grab list of installed widgets
1021
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
1022
-            // filter list of modules to register
1023
-            $widgets_to_register = apply_filters(
1024
-                'FHEE__EE_Config__register_widgets__widgets_to_register',
1025
-                $widgets_to_register
1026
-            );
1027
-            if (! empty($widgets_to_register)) {
1028
-                // cycle thru widget folders
1029
-                foreach ($widgets_to_register as $widget_path) {
1030
-                    // add to list of installed widget modules
1031
-                    EE_Config::register_ee_widget($widget_path);
1032
-                }
1033
-            }
1034
-            // filter list of installed modules
1035
-            EE_Registry::instance()->widgets = apply_filters(
1036
-                'FHEE__EE_Config__register_widgets__installed_widgets',
1037
-                EE_Registry::instance()->widgets
1038
-            );
1039
-        }
1040
-    }
1041
-
1042
-
1043
-    /**
1044
-     *    register_ee_widget - makes core aware of this widget
1045
-     *
1046
-     * @access    public
1047
-     * @param    string $widget_path - full path up to and including widget folder
1048
-     * @return    void
1049
-     */
1050
-    public static function register_ee_widget($widget_path = null)
1051
-    {
1052
-        do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
1053
-        $widget_ext = '.widget.php';
1054
-        // make all separators match
1055
-        $widget_path = rtrim(str_replace('/\\', DS, $widget_path), DS);
1056
-        // does the file path INCLUDE the actual file name as part of the path ?
1057
-        if (strpos($widget_path, $widget_ext) !== false) {
1058
-            // grab and shortcode file name from directory name and break apart at dots
1059
-            $file_name = explode('.', basename($widget_path));
1060
-            // take first segment from file name pieces and remove class prefix if it exists
1061
-            $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
1062
-            // sanitize shortcode directory name
1063
-            $widget = sanitize_key($widget);
1064
-            // now we need to rebuild the shortcode path
1065
-            $widget_path = explode(DS, $widget_path);
1066
-            // remove last segment
1067
-            array_pop($widget_path);
1068
-            // glue it back together
1069
-            $widget_path = implode(DS, $widget_path);
1070
-        } else {
1071
-            // grab and sanitize widget directory name
1072
-            $widget = sanitize_key(basename($widget_path));
1073
-        }
1074
-        // create classname from widget directory name
1075
-        $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
1076
-        // add class prefix
1077
-        $widget_class = 'EEW_' . $widget;
1078
-        // does the widget exist ?
1079
-        if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
1080
-            $msg = sprintf(
1081
-                __(
1082
-                    'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
1083
-                    'event_espresso'
1084
-                ),
1085
-                $widget_class,
1086
-                $widget_path . DS . $widget_class . $widget_ext
1087
-            );
1088
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1089
-            return;
1090
-        }
1091
-        // load the widget class file
1092
-        require_once($widget_path . DS . $widget_class . $widget_ext);
1093
-        // verify that class exists
1094
-        if (! class_exists($widget_class)) {
1095
-            $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
1096
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1097
-            return;
1098
-        }
1099
-        register_widget($widget_class);
1100
-        // add to array of registered widgets
1101
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
1102
-    }
1103
-
1104
-
1105
-    /**
1106
-     *        _register_modules
1107
-     *
1108
-     * @access private
1109
-     * @return array
1110
-     */
1111
-    private function _register_modules()
1112
-    {
1113
-        // grab list of installed modules
1114
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
1115
-        // filter list of modules to register
1116
-        $modules_to_register = apply_filters(
1117
-            'FHEE__EE_Config__register_modules__modules_to_register',
1118
-            $modules_to_register
1119
-        );
1120
-        if (! empty($modules_to_register)) {
1121
-            // loop through folders
1122
-            foreach ($modules_to_register as $module_path) {
1123
-                /**TEMPORARILY EXCLUDE gateways from modules for time being**/
1124
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
1125
-                    && $module_path !== EE_MODULES . 'gateways'
1126
-                ) {
1127
-                    // add to list of installed modules
1128
-                    EE_Config::register_module($module_path);
1129
-                }
1130
-            }
1131
-        }
1132
-        // filter list of installed modules
1133
-        return apply_filters(
1134
-            'FHEE__EE_Config___register_modules__installed_modules',
1135
-            EE_Registry::instance()->modules
1136
-        );
1137
-    }
1138
-
1139
-
1140
-    /**
1141
-     *    register_module - makes core aware of this module
1142
-     *
1143
-     * @access    public
1144
-     * @param    string $module_path - full path up to and including module folder
1145
-     * @return    bool
1146
-     */
1147
-    public static function register_module($module_path = null)
1148
-    {
1149
-        do_action('AHEE__EE_Config__register_module__begin', $module_path);
1150
-        $module_ext = '.module.php';
1151
-        // make all separators match
1152
-        $module_path = str_replace(array('\\', '/'), DS, $module_path);
1153
-        // does the file path INCLUDE the actual file name as part of the path ?
1154
-        if (strpos($module_path, $module_ext) !== false) {
1155
-            // grab and shortcode file name from directory name and break apart at dots
1156
-            $module_file = explode('.', basename($module_path));
1157
-            // now we need to rebuild the shortcode path
1158
-            $module_path = explode(DS, $module_path);
1159
-            // remove last segment
1160
-            array_pop($module_path);
1161
-            // glue it back together
1162
-            $module_path = implode(DS, $module_path) . DS;
1163
-            // take first segment from file name pieces and sanitize it
1164
-            $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
1165
-            // ensure class prefix is added
1166
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
1167
-        } else {
1168
-            // we need to generate the filename based off of the folder name
1169
-            // grab and sanitize module name
1170
-            $module = strtolower(basename($module_path));
1171
-            $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
1172
-            // like trailingslashit()
1173
-            $module_path = rtrim($module_path, DS) . DS;
1174
-            // create classname from module directory name
1175
-            $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
1176
-            // add class prefix
1177
-            $module_class = 'EED_' . $module;
1178
-        }
1179
-        // does the module exist ?
1180
-        if (! is_readable($module_path . DS . $module_class . $module_ext)) {
1181
-            $msg = sprintf(
1182
-                __(
1183
-                    'The requested %s module file could not be found or is not readable due to file permissions.',
1184
-                    'event_espresso'
1185
-                ),
1186
-                $module
1187
-            );
1188
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1189
-            return false;
1190
-        }
1191
-        // load the module class file
1192
-        require_once($module_path . $module_class . $module_ext);
1193
-        // verify that class exists
1194
-        if (! class_exists($module_class)) {
1195
-            $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
1196
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1197
-            return false;
1198
-        }
1199
-        // add to array of registered modules
1200
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
1201
-        do_action(
1202
-            'AHEE__EE_Config__register_module__complete',
1203
-            $module_class,
1204
-            EE_Registry::instance()->modules->{$module_class}
1205
-        );
1206
-        return true;
1207
-    }
1208
-
1209
-
1210
-    /**
1211
-     *    _initialize_modules
1212
-     *    allow modules to set hooks for the rest of the system
1213
-     *
1214
-     * @access private
1215
-     * @return void
1216
-     */
1217
-    private function _initialize_modules()
1218
-    {
1219
-        // cycle thru shortcode folders
1220
-        foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
1221
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
1222
-            // which set hooks ?
1223
-            if (is_admin()) {
1224
-                // fire immediately
1225
-                call_user_func(array($module_class, 'set_hooks_admin'));
1226
-            } else {
1227
-                // delay until other systems are online
1228
-                add_action(
1229
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
1230
-                    array($module_class, 'set_hooks')
1231
-                );
1232
-            }
1233
-        }
1234
-    }
1235
-
1236
-
1237
-    /**
1238
-     *    register_route - adds module method routes to route_map
1239
-     *
1240
-     * @access    public
1241
-     * @param    string $route       - "pretty" public alias for module method
1242
-     * @param    string $module      - module name (classname without EED_ prefix)
1243
-     * @param    string $method_name - the actual module method to be routed to
1244
-     * @param    string $key         - url param key indicating a route is being called
1245
-     * @return    bool
1246
-     */
1247
-    public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
1248
-    {
1249
-        do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
1250
-        $module = str_replace('EED_', '', $module);
1251
-        $module_class = 'EED_' . $module;
1252
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
1253
-            $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
1254
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1255
-            return false;
1256
-        }
1257
-        if (empty($route)) {
1258
-            $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
1259
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1260
-            return false;
1261
-        }
1262
-        if (! method_exists('EED_' . $module, $method_name)) {
1263
-            $msg = sprintf(
1264
-                __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
1265
-                $route
1266
-            );
1267
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1268
-            return false;
1269
-        }
1270
-        EE_Config::$_module_route_map[ $key ][ $route ] = array('EED_' . $module, $method_name);
1271
-        return true;
1272
-    }
1273
-
1274
-
1275
-    /**
1276
-     *    get_route - get module method route
1277
-     *
1278
-     * @access    public
1279
-     * @param    string $route - "pretty" public alias for module method
1280
-     * @param    string $key   - url param key indicating a route is being called
1281
-     * @return    string
1282
-     */
1283
-    public static function get_route($route = null, $key = 'ee')
1284
-    {
1285
-        do_action('AHEE__EE_Config__get_route__begin', $route);
1286
-        $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
1287
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
1288
-            return EE_Config::$_module_route_map[ $key ][ $route ];
1289
-        }
1290
-        return null;
1291
-    }
1292
-
1293
-
1294
-    /**
1295
-     *    get_routes - get ALL module method routes
1296
-     *
1297
-     * @access    public
1298
-     * @return    array
1299
-     */
1300
-    public static function get_routes()
1301
-    {
1302
-        return EE_Config::$_module_route_map;
1303
-    }
1304
-
1305
-
1306
-    /**
1307
-     *    register_forward - allows modules to forward request to another module for further processing
1308
-     *
1309
-     * @access    public
1310
-     * @param    string       $route   - "pretty" public alias for module method
1311
-     * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
1312
-     *                                 class, allows different forwards to be served based on status
1313
-     * @param    array|string $forward - function name or array( class, method )
1314
-     * @param    string       $key     - url param key indicating a route is being called
1315
-     * @return    bool
1316
-     */
1317
-    public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
1318
-    {
1319
-        do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
1320
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1321
-            $msg = sprintf(
1322
-                __('The module route %s for this forward has not been registered.', 'event_espresso'),
1323
-                $route
1324
-            );
1325
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1326
-            return false;
1327
-        }
1328
-        if (empty($forward)) {
1329
-            $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
1330
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1331
-            return false;
1332
-        }
1333
-        if (is_array($forward)) {
1334
-            if (! isset($forward[1])) {
1335
-                $msg = sprintf(
1336
-                    __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
1337
-                    $route
1338
-                );
1339
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1340
-                return false;
1341
-            }
1342
-            if (! method_exists($forward[0], $forward[1])) {
1343
-                $msg = sprintf(
1344
-                    __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
1345
-                    $forward[1],
1346
-                    $route
1347
-                );
1348
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1349
-                return false;
1350
-            }
1351
-        } elseif (! function_exists($forward)) {
1352
-            $msg = sprintf(
1353
-                __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
1354
-                $forward,
1355
-                $route
1356
-            );
1357
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1358
-            return false;
1359
-        }
1360
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
1361
-        return true;
1362
-    }
1363
-
1364
-
1365
-    /**
1366
-     *    get_forward - get forwarding route
1367
-     *
1368
-     * @access    public
1369
-     * @param    string  $route  - "pretty" public alias for module method
1370
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1371
-     *                           allows different forwards to be served based on status
1372
-     * @param    string  $key    - url param key indicating a route is being called
1373
-     * @return    string
1374
-     */
1375
-    public static function get_forward($route = null, $status = 0, $key = 'ee')
1376
-    {
1377
-        do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
1378
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
1379
-            return apply_filters(
1380
-                'FHEE__EE_Config__get_forward',
1381
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
1382
-                $route,
1383
-                $status
1384
-            );
1385
-        }
1386
-        return null;
1387
-    }
1388
-
1389
-
1390
-    /**
1391
-     *    register_forward - allows modules to specify different view templates for different method routes and status
1392
-     *    results
1393
-     *
1394
-     * @access    public
1395
-     * @param    string  $route  - "pretty" public alias for module method
1396
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1397
-     *                           allows different views to be served based on status
1398
-     * @param    string  $view
1399
-     * @param    string  $key    - url param key indicating a route is being called
1400
-     * @return    bool
1401
-     */
1402
-    public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
1403
-    {
1404
-        do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
1405
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1406
-            $msg = sprintf(
1407
-                __('The module route %s for this view has not been registered.', 'event_espresso'),
1408
-                $route
1409
-            );
1410
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1411
-            return false;
1412
-        }
1413
-        if (! is_readable($view)) {
1414
-            $msg = sprintf(
1415
-                __(
1416
-                    'The %s view file could not be found or is not readable due to file permissions.',
1417
-                    'event_espresso'
1418
-                ),
1419
-                $view
1420
-            );
1421
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1422
-            return false;
1423
-        }
1424
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
1425
-        return true;
1426
-    }
1427
-
1428
-
1429
-    /**
1430
-     *    get_view - get view for route and status
1431
-     *
1432
-     * @access    public
1433
-     * @param    string  $route  - "pretty" public alias for module method
1434
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1435
-     *                           allows different views to be served based on status
1436
-     * @param    string  $key    - url param key indicating a route is being called
1437
-     * @return    string
1438
-     */
1439
-    public static function get_view($route = null, $status = 0, $key = 'ee')
1440
-    {
1441
-        do_action('AHEE__EE_Config__get_view__begin', $route, $status);
1442
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
1443
-            return apply_filters(
1444
-                'FHEE__EE_Config__get_view',
1445
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
1446
-                $route,
1447
-                $status
1448
-            );
1449
-        }
1450
-        return null;
1451
-    }
1452
-
1453
-
1454
-    public function update_addon_option_names()
1455
-    {
1456
-        update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
1457
-    }
1458
-
1459
-
1460
-    public function shutdown()
1461
-    {
1462
-        $this->update_addon_option_names();
1463
-    }
1464
-
1465
-
1466
-    /**
1467
-     * @return LegacyShortcodesManager
1468
-     */
1469
-    public static function getLegacyShortcodesManager()
1470
-    {
1471
-
1472
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
1473
-            EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
1474
-                EE_Registry::instance()
1475
-            );
1476
-        }
1477
-        return EE_Config::instance()->legacy_shortcodes_manager;
1478
-    }
1479
-
1480
-
1481
-    /**
1482
-     * register_shortcode - makes core aware of this shortcode
1483
-     *
1484
-     * @deprecated 4.9.26
1485
-     * @param    string $shortcode_path - full path up to and including shortcode folder
1486
-     * @return    bool
1487
-     */
1488
-    public static function register_shortcode($shortcode_path = null)
1489
-    {
1490
-        EE_Error::doing_it_wrong(
1491
-            __METHOD__,
1492
-            __(
1493
-                'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
1494
-                'event_espresso'
1495
-            ),
1496
-            '4.9.26'
1497
-        );
1498
-        return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
1499
-    }
1500
-}
1501
-
1502
-/**
1503
- * Base class used for config classes. These classes should generally not have
1504
- * magic functions in use, except we'll allow them to magically set and get stuff...
1505
- * basically, they should just be well-defined stdClasses
1506
- */
1507
-class EE_Config_Base
1508
-{
1509
-
1510
-    /**
1511
-     * Utility function for escaping the value of a property and returning.
1512
-     *
1513
-     * @param string $property property name (checks to see if exists).
1514
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
1515
-     * @throws \EE_Error
1516
-     */
1517
-    public function get_pretty($property)
1518
-    {
1519
-        if (! property_exists($this, $property)) {
1520
-            throw new EE_Error(
1521
-                sprintf(
1522
-                    __(
1523
-                        '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
1524
-                        'event_espresso'
1525
-                    ),
1526
-                    get_class($this),
1527
-                    $property
1528
-                )
1529
-            );
1530
-        }
1531
-        // just handling escaping of strings for now.
1532
-        if (is_string($this->{$property})) {
1533
-            return stripslashes($this->{$property});
1534
-        }
1535
-        return $this->{$property};
1536
-    }
1537
-
1538
-
1539
-    public function populate()
1540
-    {
1541
-        // grab defaults via a new instance of this class.
1542
-        $class_name = get_class($this);
1543
-        $defaults = new $class_name;
1544
-        // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
1545
-        // default from our $defaults object.
1546
-        foreach (get_object_vars($defaults) as $property => $value) {
1547
-            if ($this->{$property} === null) {
1548
-                $this->{$property} = $value;
1549
-            }
1550
-        }
1551
-        // cleanup
1552
-        unset($defaults);
1553
-    }
1554
-
1555
-
1556
-    /**
1557
-     *        __isset
1558
-     *
1559
-     * @param $a
1560
-     * @return bool
1561
-     */
1562
-    public function __isset($a)
1563
-    {
1564
-        return false;
1565
-    }
1566
-
1567
-
1568
-    /**
1569
-     *        __unset
1570
-     *
1571
-     * @param $a
1572
-     * @return bool
1573
-     */
1574
-    public function __unset($a)
1575
-    {
1576
-        return false;
1577
-    }
1578
-
1579
-
1580
-    /**
1581
-     *        __clone
1582
-     */
1583
-    public function __clone()
1584
-    {
1585
-    }
1586
-
1587
-
1588
-    /**
1589
-     *        __wakeup
1590
-     */
1591
-    public function __wakeup()
1592
-    {
1593
-    }
1594
-
1595
-
1596
-    /**
1597
-     *        __destruct
1598
-     */
1599
-    public function __destruct()
1600
-    {
1601
-    }
1602
-}
1603
-
1604
-/**
1605
- * Class for defining what's in the EE_Config relating to registration settings
1606
- */
1607
-class EE_Core_Config extends EE_Config_Base
1608
-{
1609
-
1610
-    public $current_blog_id;
1611
-
1612
-    public $ee_ueip_optin;
1613
-
1614
-    public $ee_ueip_has_notified;
1615
-
1616
-    /**
1617
-     * Not to be confused with the 4 critical page variables (See
1618
-     * get_critical_pages_array()), this is just an array of wp posts that have EE
1619
-     * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
1620
-     * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
1621
-     *
1622
-     * @var array
1623
-     */
1624
-    public $post_shortcodes;
1625
-
1626
-    public $module_route_map;
1627
-
1628
-    public $module_forward_map;
1629
-
1630
-    public $module_view_map;
1631
-
1632
-    /**
1633
-     * The next 4 vars are the IDs of critical EE pages.
1634
-     *
1635
-     * @var int
1636
-     */
1637
-    public $reg_page_id;
1638
-
1639
-    public $txn_page_id;
1640
-
1641
-    public $thank_you_page_id;
1642
-
1643
-    public $cancel_page_id;
1644
-
1645
-    /**
1646
-     * The next 4 vars are the URLs of critical EE pages.
1647
-     *
1648
-     * @var int
1649
-     */
1650
-    public $reg_page_url;
1651
-
1652
-    public $txn_page_url;
1653
-
1654
-    public $thank_you_page_url;
1655
-
1656
-    public $cancel_page_url;
1657
-
1658
-    /**
1659
-     * The next vars relate to the custom slugs for EE CPT routes
1660
-     */
1661
-    public $event_cpt_slug;
1662
-
1663
-    /**
1664
-     * This caches the _ee_ueip_option in case this config is reset in the same
1665
-     * request across blog switches in a multisite context.
1666
-     * Avoids extra queries to the db for this option.
1667
-     *
1668
-     * @var bool
1669
-     */
1670
-    public static $ee_ueip_option;
1671
-
1672
-
1673
-    /**
1674
-     *    class constructor
1675
-     *
1676
-     * @access    public
1677
-     */
1678
-    public function __construct()
1679
-    {
1680
-        // set default organization settings
1681
-        $this->current_blog_id = get_current_blog_id();
1682
-        $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
1683
-        $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
1684
-        $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
1685
-        $this->post_shortcodes = array();
1686
-        $this->module_route_map = array();
1687
-        $this->module_forward_map = array();
1688
-        $this->module_view_map = array();
1689
-        // critical EE page IDs
1690
-        $this->reg_page_id = 0;
1691
-        $this->txn_page_id = 0;
1692
-        $this->thank_you_page_id = 0;
1693
-        $this->cancel_page_id = 0;
1694
-        // critical EE page URLs
1695
-        $this->reg_page_url = '';
1696
-        $this->txn_page_url = '';
1697
-        $this->thank_you_page_url = '';
1698
-        $this->cancel_page_url = '';
1699
-        // cpt slugs
1700
-        $this->event_cpt_slug = __('events', 'event_espresso');
1701
-        // ueip constant check
1702
-        if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
1703
-            $this->ee_ueip_optin = false;
1704
-            $this->ee_ueip_has_notified = true;
1705
-        }
1706
-    }
1707
-
1708
-
1709
-    /**
1710
-     * @return array
1711
-     */
1712
-    public function get_critical_pages_array()
1713
-    {
1714
-        return array(
1715
-            $this->reg_page_id,
1716
-            $this->txn_page_id,
1717
-            $this->thank_you_page_id,
1718
-            $this->cancel_page_id,
1719
-        );
1720
-    }
1721
-
1722
-
1723
-    /**
1724
-     * @return array
1725
-     */
1726
-    public function get_critical_pages_shortcodes_array()
1727
-    {
1728
-        return array(
1729
-            $this->reg_page_id       => 'ESPRESSO_CHECKOUT',
1730
-            $this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
1731
-            $this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
1732
-            $this->cancel_page_id    => 'ESPRESSO_CANCELLED',
1733
-        );
1734
-    }
1735
-
1736
-
1737
-    /**
1738
-     *  gets/returns URL for EE reg_page
1739
-     *
1740
-     * @access    public
1741
-     * @return    string
1742
-     */
1743
-    public function reg_page_url()
1744
-    {
1745
-        if (! $this->reg_page_url) {
1746
-            $this->reg_page_url = add_query_arg(
1747
-                array('uts' => time()),
1748
-                get_permalink($this->reg_page_id)
1749
-            ) . '#checkout';
1750
-        }
1751
-        return $this->reg_page_url;
1752
-    }
1753
-
1754
-
1755
-    /**
1756
-     *  gets/returns URL for EE txn_page
1757
-     *
1758
-     * @param array $query_args like what gets passed to
1759
-     *                          add_query_arg() as the first argument
1760
-     * @access    public
1761
-     * @return    string
1762
-     */
1763
-    public function txn_page_url($query_args = array())
1764
-    {
1765
-        if (! $this->txn_page_url) {
1766
-            $this->txn_page_url = get_permalink($this->txn_page_id);
1767
-        }
1768
-        if ($query_args) {
1769
-            return add_query_arg($query_args, $this->txn_page_url);
1770
-        } else {
1771
-            return $this->txn_page_url;
1772
-        }
1773
-    }
1774
-
1775
-
1776
-    /**
1777
-     *  gets/returns URL for EE thank_you_page
1778
-     *
1779
-     * @param array $query_args like what gets passed to
1780
-     *                          add_query_arg() as the first argument
1781
-     * @access    public
1782
-     * @return    string
1783
-     */
1784
-    public function thank_you_page_url($query_args = array())
1785
-    {
1786
-        if (! $this->thank_you_page_url) {
1787
-            $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
1788
-        }
1789
-        if ($query_args) {
1790
-            return add_query_arg($query_args, $this->thank_you_page_url);
1791
-        } else {
1792
-            return $this->thank_you_page_url;
1793
-        }
1794
-    }
1795
-
1796
-
1797
-    /**
1798
-     *  gets/returns URL for EE cancel_page
1799
-     *
1800
-     * @access    public
1801
-     * @return    string
1802
-     */
1803
-    public function cancel_page_url()
1804
-    {
1805
-        if (! $this->cancel_page_url) {
1806
-            $this->cancel_page_url = get_permalink($this->cancel_page_id);
1807
-        }
1808
-        return $this->cancel_page_url;
1809
-    }
1810
-
1811
-
1812
-    /**
1813
-     * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
1814
-     *
1815
-     * @since 4.7.5
1816
-     */
1817
-    protected function _reset_urls()
1818
-    {
1819
-        $this->reg_page_url = '';
1820
-        $this->txn_page_url = '';
1821
-        $this->cancel_page_url = '';
1822
-        $this->thank_you_page_url = '';
1823
-    }
1824
-
1825
-
1826
-    /**
1827
-     * Used to return what the optin value is set for the EE User Experience Program.
1828
-     * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
1829
-     * on the main site only.
1830
-     *
1831
-     * @return mixed|void
1832
-     */
1833
-    protected function _get_main_ee_ueip_optin()
1834
-    {
1835
-        // if this is the main site then we can just bypass our direct query.
1836
-        if (is_main_site()) {
1837
-            return get_option('ee_ueip_optin', false);
1838
-        }
1839
-        // is this already cached for this request?  If so use it.
1840
-        if (! empty(EE_Core_Config::$ee_ueip_option)) {
1841
-            return EE_Core_Config::$ee_ueip_option;
1842
-        }
1843
-        global $wpdb;
1844
-        $current_network_main_site = is_multisite() ? get_current_site() : null;
1845
-        $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
1846
-        $option = 'ee_ueip_optin';
1847
-        // set correct table for query
1848
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
1849
-        // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
1850
-        // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
1851
-        // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
1852
-        // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
1853
-        // for the purpose of caching.
1854
-        $pre = apply_filters('pre_option_' . $option, false, $option);
1855
-        if (false !== $pre) {
1856
-            EE_Core_Config::$ee_ueip_option = $pre;
1857
-            return EE_Core_Config::$ee_ueip_option;
1858
-        }
1859
-        $row = $wpdb->get_row(
1860
-            $wpdb->prepare(
1861
-                "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
1862
-                $option
1863
-            )
1864
-        );
1865
-        if (is_object($row)) {
1866
-            $value = $row->option_value;
1867
-        } else { // option does not exist so use default.
1868
-            return apply_filters('default_option_' . $option, false, $option);
1869
-        }
1870
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
1871
-        return EE_Core_Config::$ee_ueip_option;
1872
-    }
1873
-
1874
-
1875
-    /**
1876
-     * Utility function for escaping the value of a property and returning.
1877
-     *
1878
-     * @param string $property property name (checks to see if exists).
1879
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
1880
-     * @throws \EE_Error
1881
-     */
1882
-    public function get_pretty($property)
1883
-    {
1884
-        if ($property === 'ee_ueip_optin') {
1885
-            return $this->ee_ueip_optin ? 'yes' : 'no';
1886
-        }
1887
-        return parent::get_pretty($property);
1888
-    }
1889
-
1890
-
1891
-    /**
1892
-     * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
1893
-     * on the object.
1894
-     *
1895
-     * @return array
1896
-     */
1897
-    public function __sleep()
1898
-    {
1899
-        // reset all url properties
1900
-        $this->_reset_urls();
1901
-        // return what to save to db
1902
-        return array_keys(get_object_vars($this));
1903
-    }
1904
-}
1905
-
1906
-/**
1907
- * Config class for storing info on the Organization
1908
- */
1909
-class EE_Organization_Config extends EE_Config_Base
1910
-{
1911
-
1912
-    /**
1913
-     * @var string $name
1914
-     * eg EE4.1
1915
-     */
1916
-    public $name;
1917
-
1918
-    /**
1919
-     * @var string $address_1
1920
-     * eg 123 Onna Road
1921
-     */
1922
-    public $address_1;
1923
-
1924
-    /**
1925
-     * @var string $address_2
1926
-     * eg PO Box 123
1927
-     */
1928
-    public $address_2;
1929
-
1930
-    /**
1931
-     * @var string $city
1932
-     * eg Inna City
1933
-     */
1934
-    public $city;
1935
-
1936
-    /**
1937
-     * @var int $STA_ID
1938
-     * eg 4
1939
-     */
1940
-    public $STA_ID;
1941
-
1942
-    /**
1943
-     * @var string $CNT_ISO
1944
-     * eg US
1945
-     */
1946
-    public $CNT_ISO;
1947
-
1948
-    /**
1949
-     * @var string $zip
1950
-     * eg 12345  or V1A 2B3
1951
-     */
1952
-    public $zip;
1953
-
1954
-    /**
1955
-     * @var string $email
1956
-     * eg [email protected]
1957
-     */
1958
-    public $email;
1959
-
1960
-    /**
1961
-     * @var string $phone
1962
-     * eg. 111-111-1111
1963
-     */
1964
-    public $phone;
1965
-
1966
-    /**
1967
-     * @var string $vat
1968
-     * VAT/Tax Number
1969
-     */
1970
-    public $vat;
1971
-
1972
-    /**
1973
-     * @var string $logo_url
1974
-     * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
1975
-     */
1976
-    public $logo_url;
1977
-
1978
-    /**
1979
-     * The below are all various properties for holding links to organization social network profiles
1980
-     *
1981
-     * @var string
1982
-     */
1983
-    /**
1984
-     * facebook (facebook.com/profile.name)
1985
-     *
1986
-     * @var string
1987
-     */
1988
-    public $facebook;
1989
-
1990
-    /**
1991
-     * twitter (twitter.com/twitter_handle)
1992
-     *
1993
-     * @var string
1994
-     */
1995
-    public $twitter;
1996
-
1997
-    /**
1998
-     * linkedin (linkedin.com/in/profile_name)
1999
-     *
2000
-     * @var string
2001
-     */
2002
-    public $linkedin;
2003
-
2004
-    /**
2005
-     * pinterest (www.pinterest.com/profile_name)
2006
-     *
2007
-     * @var string
2008
-     */
2009
-    public $pinterest;
2010
-
2011
-    /**
2012
-     * google+ (google.com/+profileName)
2013
-     *
2014
-     * @var string
2015
-     */
2016
-    public $google;
2017
-
2018
-    /**
2019
-     * instagram (instagram.com/handle)
2020
-     *
2021
-     * @var string
2022
-     */
2023
-    public $instagram;
2024
-
2025
-
2026
-    /**
2027
-     *    class constructor
2028
-     *
2029
-     * @access    public
2030
-     */
2031
-    public function __construct()
2032
-    {
2033
-        // set default organization settings
2034
-        // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
2035
-        $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
2036
-        $this->address_1 = '123 Onna Road';
2037
-        $this->address_2 = 'PO Box 123';
2038
-        $this->city = 'Inna City';
2039
-        $this->STA_ID = 4;
2040
-        $this->CNT_ISO = 'US';
2041
-        $this->zip = '12345';
2042
-        $this->email = get_bloginfo('admin_email');
2043
-        $this->phone = '';
2044
-        $this->vat = '123456789';
2045
-        $this->logo_url = '';
2046
-        $this->facebook = '';
2047
-        $this->twitter = '';
2048
-        $this->linkedin = '';
2049
-        $this->pinterest = '';
2050
-        $this->google = '';
2051
-        $this->instagram = '';
2052
-    }
2053
-}
2054
-
2055
-/**
2056
- * Class for defining what's in the EE_Config relating to currency
2057
- */
2058
-class EE_Currency_Config extends EE_Config_Base
2059
-{
2060
-
2061
-    /**
2062
-     * @var string $code
2063
-     * eg 'US'
2064
-     */
2065
-    public $code;
2066
-
2067
-    /**
2068
-     * @var string $name
2069
-     * eg 'Dollar'
2070
-     */
2071
-    public $name;
2072
-
2073
-    /**
2074
-     * plural name
2075
-     *
2076
-     * @var string $plural
2077
-     * eg 'Dollars'
2078
-     */
2079
-    public $plural;
2080
-
2081
-    /**
2082
-     * currency sign
2083
-     *
2084
-     * @var string $sign
2085
-     * eg '$'
2086
-     */
2087
-    public $sign;
2088
-
2089
-    /**
2090
-     * Whether the currency sign should come before the number or not
2091
-     *
2092
-     * @var boolean $sign_b4
2093
-     */
2094
-    public $sign_b4;
2095
-
2096
-    /**
2097
-     * How many digits should come after the decimal place
2098
-     *
2099
-     * @var int $dec_plc
2100
-     */
2101
-    public $dec_plc;
2102
-
2103
-    /**
2104
-     * Symbol to use for decimal mark
2105
-     *
2106
-     * @var string $dec_mrk
2107
-     * eg '.'
2108
-     */
2109
-    public $dec_mrk;
2110
-
2111
-    /**
2112
-     * Symbol to use for thousands
2113
-     *
2114
-     * @var string $thsnds
2115
-     * eg ','
2116
-     */
2117
-    public $thsnds;
2118
-
2119
-
2120
-    /**
2121
-     *    class constructor
2122
-     *
2123
-     * @access    public
2124
-     * @param string $CNT_ISO
2125
-     * @throws \EE_Error
2126
-     */
2127
-    public function __construct($CNT_ISO = '')
2128
-    {
2129
-        /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
2130
-        $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
2131
-        // get country code from organization settings or use default
2132
-        $ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
2133
-                   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
2134
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
2135
-            : '';
2136
-        // but override if requested
2137
-        $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
2138
-        // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
2139
-        if (! empty($CNT_ISO)
2140
-            && EE_Maintenance_Mode::instance()->models_can_query()
2141
-            && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
2142
-        ) {
2143
-            // retrieve the country settings from the db, just in case they have been customized
2144
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
2145
-            if ($country instanceof EE_Country) {
2146
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
2147
-                $this->name = $country->currency_name_single();    // Dollar
2148
-                $this->plural = $country->currency_name_plural();    // Dollars
2149
-                $this->sign = $country->currency_sign();            // currency sign: $
2150
-                $this->sign_b4 = $country->currency_sign_before(
2151
-                );        // currency sign before or after: $TRUE  or  FALSE$
2152
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
2153
-                $this->dec_mrk = $country->currency_decimal_mark(
2154
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2155
-                $this->thsnds = $country->currency_thousands_separator(
2156
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2157
-            }
2158
-        }
2159
-        // fallback to hardcoded defaults, in case the above failed
2160
-        if (empty($this->code)) {
2161
-            // set default currency settings
2162
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
2163
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
2164
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
2165
-            $this->sign = '$';    // currency sign: $
2166
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
2167
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
2168
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2169
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2170
-        }
2171
-    }
2172
-}
2173
-
2174
-/**
2175
- * Class for defining what's in the EE_Config relating to registration settings
2176
- */
2177
-class EE_Registration_Config extends EE_Config_Base
2178
-{
2179
-
2180
-    /**
2181
-     * Default registration status
2182
-     *
2183
-     * @var string $default_STS_ID
2184
-     * eg 'RPP'
2185
-     */
2186
-    public $default_STS_ID;
2187
-
2188
-    /**
2189
-     * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
2190
-     * registrations)
2191
-     *
2192
-     * @var int
2193
-     */
2194
-    public $default_maximum_number_of_tickets;
2195
-
2196
-    /**
2197
-     * level of validation to apply to email addresses
2198
-     *
2199
-     * @var string $email_validation_level
2200
-     * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
2201
-     */
2202
-    public $email_validation_level;
2203
-
2204
-    /**
2205
-     *    whether or not to show alternate payment options during the reg process if payment status is pending
2206
-     *
2207
-     * @var boolean $show_pending_payment_options
2208
-     */
2209
-    public $show_pending_payment_options;
2210
-
2211
-    /**
2212
-     * Whether to skip the registration confirmation page
2213
-     *
2214
-     * @var boolean $skip_reg_confirmation
2215
-     */
2216
-    public $skip_reg_confirmation;
2217
-
2218
-    /**
2219
-     * an array of SPCO reg steps where:
2220
-     *        the keys denotes the reg step order
2221
-     *        each element consists of an array with the following elements:
2222
-     *            "file_path" => the file path to the EE_SPCO_Reg_Step class
2223
-     *            "class_name" => the specific EE_SPCO_Reg_Step child class name
2224
-     *            "slug" => the URL param used to trigger the reg step
2225
-     *
2226
-     * @var array $reg_steps
2227
-     */
2228
-    public $reg_steps;
2229
-
2230
-    /**
2231
-     * Whether registration confirmation should be the last page of SPCO
2232
-     *
2233
-     * @var boolean $reg_confirmation_last
2234
-     */
2235
-    public $reg_confirmation_last;
2236
-
2237
-    /**
2238
-     * Whether or not to enable the EE Bot Trap
2239
-     *
2240
-     * @var boolean $use_bot_trap
2241
-     */
2242
-    public $use_bot_trap;
2243
-
2244
-    /**
2245
-     * Whether or not to encrypt some data sent by the EE Bot Trap
2246
-     *
2247
-     * @var boolean $use_encryption
2248
-     */
2249
-    public $use_encryption;
2250
-
2251
-    /**
2252
-     * Whether or not to use ReCaptcha
2253
-     *
2254
-     * @var boolean $use_captcha
2255
-     */
2256
-    public $use_captcha;
2257
-
2258
-    /**
2259
-     * ReCaptcha Theme
2260
-     *
2261
-     * @var string $recaptcha_theme
2262
-     *    options: 'dark', 'light', 'invisible'
2263
-     */
2264
-    public $recaptcha_theme;
2265
-
2266
-    /**
2267
-     * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
2268
-     *
2269
-     * @var string $recaptcha_badge
2270
-     *    options: 'bottomright', 'bottomleft', 'inline'
2271
-     */
2272
-    public $recaptcha_badge;
17
+	const OPTION_NAME = 'ee_config';
18
+
19
+	const LOG_NAME = 'ee_config_log';
20
+
21
+	const LOG_LENGTH = 100;
22
+
23
+	const ADDON_OPTION_NAMES = 'ee_config_option_names';
24
+
25
+	/**
26
+	 *    instance of the EE_Config object
27
+	 *
28
+	 * @var    EE_Config $_instance
29
+	 * @access    private
30
+	 */
31
+	private static $_instance;
32
+
33
+	/**
34
+	 * @var boolean $_logging_enabled
35
+	 */
36
+	private static $_logging_enabled = false;
37
+
38
+	/**
39
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
40
+	 */
41
+	private $legacy_shortcodes_manager;
42
+
43
+	/**
44
+	 * An StdClass whose property names are addon slugs,
45
+	 * and values are their config classes
46
+	 *
47
+	 * @var StdClass
48
+	 */
49
+	public $addons;
50
+
51
+	/**
52
+	 * @var EE_Admin_Config
53
+	 */
54
+	public $admin;
55
+
56
+	/**
57
+	 * @var EE_Core_Config
58
+	 */
59
+	public $core;
60
+
61
+	/**
62
+	 * @var EE_Currency_Config
63
+	 */
64
+	public $currency;
65
+
66
+	/**
67
+	 * @var EE_Organization_Config
68
+	 */
69
+	public $organization;
70
+
71
+	/**
72
+	 * @var EE_Registration_Config
73
+	 */
74
+	public $registration;
75
+
76
+	/**
77
+	 * @var EE_Template_Config
78
+	 */
79
+	public $template_settings;
80
+
81
+	/**
82
+	 * Holds EE environment values.
83
+	 *
84
+	 * @var EE_Environment_Config
85
+	 */
86
+	public $environment;
87
+
88
+	/**
89
+	 * settings pertaining to Google maps
90
+	 *
91
+	 * @var EE_Map_Config
92
+	 */
93
+	public $map_settings;
94
+
95
+	/**
96
+	 * settings pertaining to Taxes
97
+	 *
98
+	 * @var EE_Tax_Config
99
+	 */
100
+	public $tax_settings;
101
+
102
+	/**
103
+	 * Settings pertaining to global messages settings.
104
+	 *
105
+	 * @var EE_Messages_Config
106
+	 */
107
+	public $messages;
108
+
109
+	/**
110
+	 * @deprecated
111
+	 * @var EE_Gateway_Config
112
+	 */
113
+	public $gateway;
114
+
115
+	/**
116
+	 * @var    array $_addon_option_names
117
+	 * @access    private
118
+	 */
119
+	private $_addon_option_names = array();
120
+
121
+	/**
122
+	 * @var    array $_module_route_map
123
+	 * @access    private
124
+	 */
125
+	private static $_module_route_map = array();
126
+
127
+	/**
128
+	 * @var    array $_module_forward_map
129
+	 * @access    private
130
+	 */
131
+	private static $_module_forward_map = array();
132
+
133
+	/**
134
+	 * @var    array $_module_view_map
135
+	 * @access    private
136
+	 */
137
+	private static $_module_view_map = array();
138
+
139
+
140
+	/**
141
+	 * @singleton method used to instantiate class object
142
+	 * @access    public
143
+	 * @return EE_Config instance
144
+	 */
145
+	public static function instance()
146
+	{
147
+		// check if class object is instantiated, and instantiated properly
148
+		if (! self::$_instance instanceof EE_Config) {
149
+			self::$_instance = new self();
150
+		}
151
+		return self::$_instance;
152
+	}
153
+
154
+
155
+	/**
156
+	 * Resets the config
157
+	 *
158
+	 * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
159
+	 *                               (default) leaves the database alone, and merely resets the EE_Config object to
160
+	 *                               reflect its state in the database
161
+	 * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
162
+	 *                               $_instance as NULL. Useful in case you want to forget about the old instance on
163
+	 *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
164
+	 *                               site was put into maintenance mode)
165
+	 * @return EE_Config
166
+	 */
167
+	public static function reset($hard_reset = false, $reinstantiate = true)
168
+	{
169
+		if (self::$_instance instanceof EE_Config) {
170
+			if ($hard_reset) {
171
+				self::$_instance->legacy_shortcodes_manager = null;
172
+				self::$_instance->_addon_option_names = array();
173
+				self::$_instance->_initialize_config();
174
+				self::$_instance->update_espresso_config();
175
+			}
176
+			self::$_instance->update_addon_option_names();
177
+		}
178
+		self::$_instance = null;
179
+		// we don't need to reset the static properties imo because those should
180
+		// only change when a module is added or removed. Currently we don't
181
+		// support removing a module during a request when it previously existed
182
+		if ($reinstantiate) {
183
+			return self::instance();
184
+		} else {
185
+			return null;
186
+		}
187
+	}
188
+
189
+
190
+	/**
191
+	 *    class constructor
192
+	 *
193
+	 * @access    private
194
+	 */
195
+	private function __construct()
196
+	{
197
+		do_action('AHEE__EE_Config__construct__begin', $this);
198
+		EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
199
+		// setup empty config classes
200
+		$this->_initialize_config();
201
+		// load existing EE site settings
202
+		$this->_load_core_config();
203
+		// confirm everything loaded correctly and set filtered defaults if not
204
+		$this->_verify_config();
205
+		//  register shortcodes and modules
206
+		add_action(
207
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
208
+			array($this, 'register_shortcodes_and_modules'),
209
+			999
210
+		);
211
+		//  initialize shortcodes and modules
212
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
213
+		// register widgets
214
+		add_action('widgets_init', array($this, 'widgets_init'), 10);
215
+		// shutdown
216
+		add_action('shutdown', array($this, 'shutdown'), 10);
217
+		// construct__end hook
218
+		do_action('AHEE__EE_Config__construct__end', $this);
219
+		// hardcoded hack
220
+		$this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
221
+	}
222
+
223
+
224
+	/**
225
+	 * @return boolean
226
+	 */
227
+	public static function logging_enabled()
228
+	{
229
+		return self::$_logging_enabled;
230
+	}
231
+
232
+
233
+	/**
234
+	 * use to get the current theme if needed from static context
235
+	 *
236
+	 * @return string current theme set.
237
+	 */
238
+	public static function get_current_theme()
239
+	{
240
+		return isset(self::$_instance->template_settings->current_espresso_theme)
241
+			? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
242
+	}
243
+
244
+
245
+	/**
246
+	 *        _initialize_config
247
+	 *
248
+	 * @access private
249
+	 * @return void
250
+	 */
251
+	private function _initialize_config()
252
+	{
253
+		EE_Config::trim_log();
254
+		// set defaults
255
+		$this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
256
+		$this->addons = new stdClass();
257
+		// set _module_route_map
258
+		EE_Config::$_module_route_map = array();
259
+		// set _module_forward_map
260
+		EE_Config::$_module_forward_map = array();
261
+		// set _module_view_map
262
+		EE_Config::$_module_view_map = array();
263
+	}
264
+
265
+
266
+	/**
267
+	 *        load core plugin configuration
268
+	 *
269
+	 * @access private
270
+	 * @return void
271
+	 */
272
+	private function _load_core_config()
273
+	{
274
+		// load_core_config__start hook
275
+		do_action('AHEE__EE_Config___load_core_config__start', $this);
276
+		$espresso_config = $this->get_espresso_config();
277
+		foreach ($espresso_config as $config => $settings) {
278
+			// load_core_config__start hook
279
+			$settings = apply_filters(
280
+				'FHEE__EE_Config___load_core_config__config_settings',
281
+				$settings,
282
+				$config,
283
+				$this
284
+			);
285
+			if (is_object($settings) && property_exists($this, $config)) {
286
+				$this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
287
+				// call configs populate method to ensure any defaults are set for empty values.
288
+				if (method_exists($settings, 'populate')) {
289
+					$this->{$config}->populate();
290
+				}
291
+				if (method_exists($settings, 'do_hooks')) {
292
+					$this->{$config}->do_hooks();
293
+				}
294
+			}
295
+		}
296
+		if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
297
+			$this->update_espresso_config();
298
+		}
299
+		// load_core_config__end hook
300
+		do_action('AHEE__EE_Config___load_core_config__end', $this);
301
+	}
302
+
303
+
304
+	/**
305
+	 *    _verify_config
306
+	 *
307
+	 * @access    protected
308
+	 * @return    void
309
+	 */
310
+	protected function _verify_config()
311
+	{
312
+		$this->core = $this->core instanceof EE_Core_Config
313
+			? $this->core
314
+			: new EE_Core_Config();
315
+		$this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
316
+		$this->organization = $this->organization instanceof EE_Organization_Config
317
+			? $this->organization
318
+			: new EE_Organization_Config();
319
+		$this->organization = apply_filters(
320
+			'FHEE__EE_Config___initialize_config__organization',
321
+			$this->organization
322
+		);
323
+		$this->currency = $this->currency instanceof EE_Currency_Config
324
+			? $this->currency
325
+			: new EE_Currency_Config();
326
+		$this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
327
+		$this->registration = $this->registration instanceof EE_Registration_Config
328
+			? $this->registration
329
+			: new EE_Registration_Config();
330
+		$this->registration = apply_filters(
331
+			'FHEE__EE_Config___initialize_config__registration',
332
+			$this->registration
333
+		);
334
+		$this->admin = $this->admin instanceof EE_Admin_Config
335
+			? $this->admin
336
+			: new EE_Admin_Config();
337
+		$this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
338
+		$this->template_settings = $this->template_settings instanceof EE_Template_Config
339
+			? $this->template_settings
340
+			: new EE_Template_Config();
341
+		$this->template_settings = apply_filters(
342
+			'FHEE__EE_Config___initialize_config__template_settings',
343
+			$this->template_settings
344
+		);
345
+		$this->map_settings = $this->map_settings instanceof EE_Map_Config
346
+			? $this->map_settings
347
+			: new EE_Map_Config();
348
+		$this->map_settings = apply_filters(
349
+			'FHEE__EE_Config___initialize_config__map_settings',
350
+			$this->map_settings
351
+		);
352
+		$this->environment = $this->environment instanceof EE_Environment_Config
353
+			? $this->environment
354
+			: new EE_Environment_Config();
355
+		$this->environment = apply_filters(
356
+			'FHEE__EE_Config___initialize_config__environment',
357
+			$this->environment
358
+		);
359
+		$this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
360
+			? $this->tax_settings
361
+			: new EE_Tax_Config();
362
+		$this->tax_settings = apply_filters(
363
+			'FHEE__EE_Config___initialize_config__tax_settings',
364
+			$this->tax_settings
365
+		);
366
+		$this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
367
+		$this->messages = $this->messages instanceof EE_Messages_Config
368
+			? $this->messages
369
+			: new EE_Messages_Config();
370
+		$this->gateway = $this->gateway instanceof EE_Gateway_Config
371
+			? $this->gateway
372
+			: new EE_Gateway_Config();
373
+		$this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
374
+		$this->legacy_shortcodes_manager = null;
375
+	}
376
+
377
+
378
+	/**
379
+	 *    get_espresso_config
380
+	 *
381
+	 * @access    public
382
+	 * @return    array of espresso config stuff
383
+	 */
384
+	public function get_espresso_config()
385
+	{
386
+		// grab espresso configuration
387
+		return apply_filters(
388
+			'FHEE__EE_Config__get_espresso_config__CFG',
389
+			get_option(EE_Config::OPTION_NAME, array())
390
+		);
391
+	}
392
+
393
+
394
+	/**
395
+	 *    double_check_config_comparison
396
+	 *
397
+	 * @access    public
398
+	 * @param string $option
399
+	 * @param        $old_value
400
+	 * @param        $value
401
+	 */
402
+	public function double_check_config_comparison($option = '', $old_value, $value)
403
+	{
404
+		// make sure we're checking the ee config
405
+		if ($option === EE_Config::OPTION_NAME) {
406
+			// run a loose comparison of the old value against the new value for type and properties,
407
+			// but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
408
+			if ($value != $old_value) {
409
+				// if they are NOT the same, then remove the hook,
410
+				// which means the subsequent update results will be based solely on the update query results
411
+				// the reason we do this is because, as stated above,
412
+				// WP update_option performs an exact instance comparison (===) on any update values passed to it
413
+				// this happens PRIOR to serialization and any subsequent update.
414
+				// If values are found to match their previous old value,
415
+				// then WP bails before performing any update.
416
+				// Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
417
+				// it just pulled from the db, with the one being passed to it (which will not match).
418
+				// HOWEVER, once the object is serialized and passed off to MySQL to update,
419
+				// MySQL MAY ALSO NOT perform the update because
420
+				// the string it sees in the db looks the same as the new one it has been passed!!!
421
+				// This results in the query returning an "affected rows" value of ZERO,
422
+				// which gets returned immediately by WP update_option and looks like an error.
423
+				remove_action('update_option', array($this, 'check_config_updated'));
424
+			}
425
+		}
426
+	}
427
+
428
+
429
+	/**
430
+	 *    update_espresso_config
431
+	 *
432
+	 * @access   public
433
+	 */
434
+	protected function _reset_espresso_addon_config()
435
+	{
436
+		$this->_addon_option_names = array();
437
+		foreach ($this->addons as $addon_name => $addon_config_obj) {
438
+			$addon_config_obj = maybe_unserialize($addon_config_obj);
439
+			if ($addon_config_obj instanceof EE_Config_Base) {
440
+				$this->update_config('addons', $addon_name, $addon_config_obj, false);
441
+			}
442
+			$this->addons->{$addon_name} = null;
443
+		}
444
+	}
445
+
446
+
447
+	/**
448
+	 *    update_espresso_config
449
+	 *
450
+	 * @access   public
451
+	 * @param   bool $add_success
452
+	 * @param   bool $add_error
453
+	 * @return   bool
454
+	 */
455
+	public function update_espresso_config($add_success = false, $add_error = true)
456
+	{
457
+		// don't allow config updates during WP heartbeats
458
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
459
+			return false;
460
+		}
461
+		// commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
462
+		// $clone = clone( self::$_instance );
463
+		// self::$_instance = NULL;
464
+		do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
465
+		$this->_reset_espresso_addon_config();
466
+		// hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
467
+		// but BEFORE the actual update occurs
468
+		add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
469
+		// don't want to persist legacy_shortcodes_manager, but don't want to lose it either
470
+		$legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
471
+		$this->legacy_shortcodes_manager = null;
472
+		// now update "ee_config"
473
+		$saved = update_option(EE_Config::OPTION_NAME, $this);
474
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
475
+		EE_Config::log(EE_Config::OPTION_NAME);
476
+		// if not saved... check if the hook we just added still exists;
477
+		// if it does, it means one of two things:
478
+		// that update_option bailed at the($value === $old_value) conditional,
479
+		// or...
480
+		// the db update query returned 0 rows affected
481
+		// (probably because the data  value was the same from it's perspective)
482
+		// so the existence of the hook means that a negative result from update_option is NOT an error,
483
+		// but just means no update occurred, so don't display an error to the user.
484
+		// BUT... if update_option returns FALSE, AND the hook is missing,
485
+		// then it means that something truly went wrong
486
+		$saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
487
+		// remove our action since we don't want it in the system anymore
488
+		remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
489
+		do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
490
+		// self::$_instance = $clone;
491
+		// unset( $clone );
492
+		// if config remains the same or was updated successfully
493
+		if ($saved) {
494
+			if ($add_success) {
495
+				EE_Error::add_success(
496
+					__('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
497
+					__FILE__,
498
+					__FUNCTION__,
499
+					__LINE__
500
+				);
501
+			}
502
+			return true;
503
+		} else {
504
+			if ($add_error) {
505
+				EE_Error::add_error(
506
+					__('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
507
+					__FILE__,
508
+					__FUNCTION__,
509
+					__LINE__
510
+				);
511
+			}
512
+			return false;
513
+		}
514
+	}
515
+
516
+
517
+	/**
518
+	 *    _verify_config_params
519
+	 *
520
+	 * @access    private
521
+	 * @param    string         $section
522
+	 * @param    string         $name
523
+	 * @param    string         $config_class
524
+	 * @param    EE_Config_Base $config_obj
525
+	 * @param    array          $tests_to_run
526
+	 * @param    bool           $display_errors
527
+	 * @return    bool    TRUE on success, FALSE on fail
528
+	 */
529
+	private function _verify_config_params(
530
+		$section = '',
531
+		$name = '',
532
+		$config_class = '',
533
+		$config_obj = null,
534
+		$tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
535
+		$display_errors = true
536
+	) {
537
+		try {
538
+			foreach ($tests_to_run as $test) {
539
+				switch ($test) {
540
+					// TEST #1 : check that section was set
541
+					case 1:
542
+						if (empty($section)) {
543
+							if ($display_errors) {
544
+								throw new EE_Error(
545
+									sprintf(
546
+										__(
547
+											'No configuration section has been provided while attempting to save "%s".',
548
+											'event_espresso'
549
+										),
550
+										$config_class
551
+									)
552
+								);
553
+							}
554
+							return false;
555
+						}
556
+						break;
557
+					// TEST #2 : check that settings section exists
558
+					case 2:
559
+						if (! isset($this->{$section})) {
560
+							if ($display_errors) {
561
+								throw new EE_Error(
562
+									sprintf(
563
+										__('The "%s" configuration section does not exist.', 'event_espresso'),
564
+										$section
565
+									)
566
+								);
567
+							}
568
+							return false;
569
+						}
570
+						break;
571
+					// TEST #3 : check that section is the proper format
572
+					case 3:
573
+						if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
574
+						) {
575
+							if ($display_errors) {
576
+								throw new EE_Error(
577
+									sprintf(
578
+										__(
579
+											'The "%s" configuration settings have not been formatted correctly.',
580
+											'event_espresso'
581
+										),
582
+										$section
583
+									)
584
+								);
585
+							}
586
+							return false;
587
+						}
588
+						break;
589
+					// TEST #4 : check that config section name has been set
590
+					case 4:
591
+						if (empty($name)) {
592
+							if ($display_errors) {
593
+								throw new EE_Error(
594
+									__(
595
+										'No name has been provided for the specific configuration section.',
596
+										'event_espresso'
597
+									)
598
+								);
599
+							}
600
+							return false;
601
+						}
602
+						break;
603
+					// TEST #5 : check that a config class name has been set
604
+					case 5:
605
+						if (empty($config_class)) {
606
+							if ($display_errors) {
607
+								throw new EE_Error(
608
+									__(
609
+										'No class name has been provided for the specific configuration section.',
610
+										'event_espresso'
611
+									)
612
+								);
613
+							}
614
+							return false;
615
+						}
616
+						break;
617
+					// TEST #6 : verify config class is accessible
618
+					case 6:
619
+						if (! class_exists($config_class)) {
620
+							if ($display_errors) {
621
+								throw new EE_Error(
622
+									sprintf(
623
+										__(
624
+											'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
625
+											'event_espresso'
626
+										),
627
+										$config_class
628
+									)
629
+								);
630
+							}
631
+							return false;
632
+						}
633
+						break;
634
+					// TEST #7 : check that config has even been set
635
+					case 7:
636
+						if (! isset($this->{$section}->{$name})) {
637
+							if ($display_errors) {
638
+								throw new EE_Error(
639
+									sprintf(
640
+										__('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
641
+										$section,
642
+										$name
643
+									)
644
+								);
645
+							}
646
+							return false;
647
+						} else {
648
+							// and make sure it's not serialized
649
+							$this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
650
+						}
651
+						break;
652
+					// TEST #8 : check that config is the requested type
653
+					case 8:
654
+						if (! $this->{$section}->{$name} instanceof $config_class) {
655
+							if ($display_errors) {
656
+								throw new EE_Error(
657
+									sprintf(
658
+										__(
659
+											'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
660
+											'event_espresso'
661
+										),
662
+										$section,
663
+										$name,
664
+										$config_class
665
+									)
666
+								);
667
+							}
668
+							return false;
669
+						}
670
+						break;
671
+					// TEST #9 : verify config object
672
+					case 9:
673
+						if (! $config_obj instanceof EE_Config_Base) {
674
+							if ($display_errors) {
675
+								throw new EE_Error(
676
+									sprintf(
677
+										__('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
678
+										print_r($config_obj, true)
679
+									)
680
+								);
681
+							}
682
+							return false;
683
+						}
684
+						break;
685
+				}
686
+			}
687
+		} catch (EE_Error $e) {
688
+			$e->get_error();
689
+		}
690
+		// you have successfully run the gauntlet
691
+		return true;
692
+	}
693
+
694
+
695
+	/**
696
+	 *    _generate_config_option_name
697
+	 *
698
+	 * @access        protected
699
+	 * @param        string $section
700
+	 * @param        string $name
701
+	 * @return        string
702
+	 */
703
+	private function _generate_config_option_name($section = '', $name = '')
704
+	{
705
+		return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
706
+	}
707
+
708
+
709
+	/**
710
+	 *    _set_config_class
711
+	 * ensures that a config class is set, either from a passed config class or one generated from the config name
712
+	 *
713
+	 * @access    private
714
+	 * @param    string $config_class
715
+	 * @param    string $name
716
+	 * @return    string
717
+	 */
718
+	private function _set_config_class($config_class = '', $name = '')
719
+	{
720
+		return ! empty($config_class)
721
+			? $config_class
722
+			: str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
723
+	}
724
+
725
+
726
+	/**
727
+	 *    set_config
728
+	 *
729
+	 * @access    protected
730
+	 * @param    string         $section
731
+	 * @param    string         $name
732
+	 * @param    string         $config_class
733
+	 * @param    EE_Config_Base $config_obj
734
+	 * @return    EE_Config_Base
735
+	 */
736
+	public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
737
+	{
738
+		// ensure config class is set to something
739
+		$config_class = $this->_set_config_class($config_class, $name);
740
+		// run tests 1-4, 6, and 7 to verify all config params are set and valid
741
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
742
+			return null;
743
+		}
744
+		$config_option_name = $this->_generate_config_option_name($section, $name);
745
+		// if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
746
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
747
+			$this->_addon_option_names[ $config_option_name ] = $config_class;
748
+			$this->update_addon_option_names();
749
+		}
750
+		// verify the incoming config object but suppress errors
751
+		if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
752
+			$config_obj = new $config_class();
753
+		}
754
+		if (get_option($config_option_name)) {
755
+			EE_Config::log($config_option_name);
756
+			update_option($config_option_name, $config_obj);
757
+			$this->{$section}->{$name} = $config_obj;
758
+			return $this->{$section}->{$name};
759
+		} else {
760
+			// create a wp-option for this config
761
+			if (add_option($config_option_name, $config_obj, '', 'no')) {
762
+				$this->{$section}->{$name} = maybe_unserialize($config_obj);
763
+				return $this->{$section}->{$name};
764
+			} else {
765
+				EE_Error::add_error(
766
+					sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
767
+					__FILE__,
768
+					__FUNCTION__,
769
+					__LINE__
770
+				);
771
+				return null;
772
+			}
773
+		}
774
+	}
775
+
776
+
777
+	/**
778
+	 *    update_config
779
+	 * Important: the config object must ALREADY be set, otherwise this will produce an error.
780
+	 *
781
+	 * @access    public
782
+	 * @param    string                $section
783
+	 * @param    string                $name
784
+	 * @param    EE_Config_Base|string $config_obj
785
+	 * @param    bool                  $throw_errors
786
+	 * @return    bool
787
+	 */
788
+	public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
789
+	{
790
+		// don't allow config updates during WP heartbeats
791
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
792
+			return false;
793
+		}
794
+		$config_obj = maybe_unserialize($config_obj);
795
+		// get class name of the incoming object
796
+		$config_class = get_class($config_obj);
797
+		// run tests 1-5 and 9 to verify config
798
+		if (! $this->_verify_config_params(
799
+			$section,
800
+			$name,
801
+			$config_class,
802
+			$config_obj,
803
+			array(1, 2, 3, 4, 7, 9)
804
+		)
805
+		) {
806
+			return false;
807
+		}
808
+		$config_option_name = $this->_generate_config_option_name($section, $name);
809
+		// check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
810
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
811
+			// save new config to db
812
+			if ($this->set_config($section, $name, $config_class, $config_obj)) {
813
+				return true;
814
+			}
815
+		} else {
816
+			// first check if the record already exists
817
+			$existing_config = get_option($config_option_name);
818
+			$config_obj = serialize($config_obj);
819
+			// just return if db record is already up to date (NOT type safe comparison)
820
+			if ($existing_config == $config_obj) {
821
+				$this->{$section}->{$name} = $config_obj;
822
+				return true;
823
+			} elseif (update_option($config_option_name, $config_obj)) {
824
+				EE_Config::log($config_option_name);
825
+				// update wp-option for this config class
826
+				$this->{$section}->{$name} = $config_obj;
827
+				return true;
828
+			} elseif ($throw_errors) {
829
+				EE_Error::add_error(
830
+					sprintf(
831
+						__(
832
+							'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
833
+							'event_espresso'
834
+						),
835
+						$config_class,
836
+						'EE_Config->' . $section . '->' . $name
837
+					),
838
+					__FILE__,
839
+					__FUNCTION__,
840
+					__LINE__
841
+				);
842
+			}
843
+		}
844
+		return false;
845
+	}
846
+
847
+
848
+	/**
849
+	 *    get_config
850
+	 *
851
+	 * @access    public
852
+	 * @param    string $section
853
+	 * @param    string $name
854
+	 * @param    string $config_class
855
+	 * @return    mixed EE_Config_Base | NULL
856
+	 */
857
+	public function get_config($section = '', $name = '', $config_class = '')
858
+	{
859
+		// ensure config class is set to something
860
+		$config_class = $this->_set_config_class($config_class, $name);
861
+		// run tests 1-4, 6 and 7 to verify that all params have been set
862
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
863
+			return null;
864
+		}
865
+		// now test if the requested config object exists, but suppress errors
866
+		if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
867
+			// config already exists, so pass it back
868
+			return $this->{$section}->{$name};
869
+		}
870
+		// load config option from db if it exists
871
+		$config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
872
+		// verify the newly retrieved config object, but suppress errors
873
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
874
+			// config is good, so set it and pass it back
875
+			$this->{$section}->{$name} = $config_obj;
876
+			return $this->{$section}->{$name};
877
+		}
878
+		// oops! $config_obj is not already set and does not exist in the db, so create a new one
879
+		$config_obj = $this->set_config($section, $name, $config_class);
880
+		// verify the newly created config object
881
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
882
+			return $this->{$section}->{$name};
883
+		} else {
884
+			EE_Error::add_error(
885
+				sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
886
+				__FILE__,
887
+				__FUNCTION__,
888
+				__LINE__
889
+			);
890
+		}
891
+		return null;
892
+	}
893
+
894
+
895
+	/**
896
+	 *    get_config_option
897
+	 *
898
+	 * @access    public
899
+	 * @param    string $config_option_name
900
+	 * @return    mixed EE_Config_Base | FALSE
901
+	 */
902
+	public function get_config_option($config_option_name = '')
903
+	{
904
+		// retrieve the wp-option for this config class.
905
+		$config_option = maybe_unserialize(get_option($config_option_name, array()));
906
+		if (empty($config_option)) {
907
+			EE_Config::log($config_option_name . '-NOT-FOUND');
908
+		}
909
+		return $config_option;
910
+	}
911
+
912
+
913
+	/**
914
+	 * log
915
+	 *
916
+	 * @param string $config_option_name
917
+	 */
918
+	public static function log($config_option_name = '')
919
+	{
920
+		if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
921
+			$config_log = get_option(EE_Config::LOG_NAME, array());
922
+			// copy incoming $_REQUEST and sanitize it so we can save it
923
+			$_request = $_REQUEST;
924
+			array_walk_recursive($_request, 'sanitize_text_field');
925
+			$config_log[ (string) microtime(true) ] = array(
926
+				'config_name' => $config_option_name,
927
+				'request'     => $_request,
928
+			);
929
+			update_option(EE_Config::LOG_NAME, $config_log);
930
+		}
931
+	}
932
+
933
+
934
+	/**
935
+	 * trim_log
936
+	 * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
937
+	 */
938
+	public static function trim_log()
939
+	{
940
+		if (! EE_Config::logging_enabled()) {
941
+			return;
942
+		}
943
+		$config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
944
+		$log_length = count($config_log);
945
+		if ($log_length > EE_Config::LOG_LENGTH) {
946
+			ksort($config_log);
947
+			$config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
948
+			update_option(EE_Config::LOG_NAME, $config_log);
949
+		}
950
+	}
951
+
952
+
953
+	/**
954
+	 *    get_page_for_posts
955
+	 *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
956
+	 *    wp-option "page_for_posts", or "posts" if no page is selected
957
+	 *
958
+	 * @access    public
959
+	 * @return    string
960
+	 */
961
+	public static function get_page_for_posts()
962
+	{
963
+		$page_for_posts = get_option('page_for_posts');
964
+		if (! $page_for_posts) {
965
+			return 'posts';
966
+		}
967
+		/** @type WPDB $wpdb */
968
+		global $wpdb;
969
+		$SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
970
+		return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
971
+	}
972
+
973
+
974
+	/**
975
+	 *    register_shortcodes_and_modules.
976
+	 *    At this point, it's too early to tell if we're maintenance mode or not.
977
+	 *    In fact, this is where we give modules a chance to let core know they exist
978
+	 *    so they can help trigger maintenance mode if it's needed
979
+	 *
980
+	 * @access    public
981
+	 * @return    void
982
+	 */
983
+	public function register_shortcodes_and_modules()
984
+	{
985
+		// allow modules to set hooks for the rest of the system
986
+		EE_Registry::instance()->modules = $this->_register_modules();
987
+	}
988
+
989
+
990
+	/**
991
+	 *    initialize_shortcodes_and_modules
992
+	 *    meaning they can start adding their hooks to get stuff done
993
+	 *
994
+	 * @access    public
995
+	 * @return    void
996
+	 */
997
+	public function initialize_shortcodes_and_modules()
998
+	{
999
+		// allow modules to set hooks for the rest of the system
1000
+		$this->_initialize_modules();
1001
+	}
1002
+
1003
+
1004
+	/**
1005
+	 *    widgets_init
1006
+	 *
1007
+	 * @access private
1008
+	 * @return void
1009
+	 */
1010
+	public function widgets_init()
1011
+	{
1012
+		// only init widgets on admin pages when not in complete maintenance, and
1013
+		// on frontend when not in any maintenance mode
1014
+		if (! EE_Maintenance_Mode::instance()->level()
1015
+			|| (
1016
+				is_admin()
1017
+				&& EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
1018
+			)
1019
+		) {
1020
+			// grab list of installed widgets
1021
+			$widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
1022
+			// filter list of modules to register
1023
+			$widgets_to_register = apply_filters(
1024
+				'FHEE__EE_Config__register_widgets__widgets_to_register',
1025
+				$widgets_to_register
1026
+			);
1027
+			if (! empty($widgets_to_register)) {
1028
+				// cycle thru widget folders
1029
+				foreach ($widgets_to_register as $widget_path) {
1030
+					// add to list of installed widget modules
1031
+					EE_Config::register_ee_widget($widget_path);
1032
+				}
1033
+			}
1034
+			// filter list of installed modules
1035
+			EE_Registry::instance()->widgets = apply_filters(
1036
+				'FHEE__EE_Config__register_widgets__installed_widgets',
1037
+				EE_Registry::instance()->widgets
1038
+			);
1039
+		}
1040
+	}
1041
+
1042
+
1043
+	/**
1044
+	 *    register_ee_widget - makes core aware of this widget
1045
+	 *
1046
+	 * @access    public
1047
+	 * @param    string $widget_path - full path up to and including widget folder
1048
+	 * @return    void
1049
+	 */
1050
+	public static function register_ee_widget($widget_path = null)
1051
+	{
1052
+		do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
1053
+		$widget_ext = '.widget.php';
1054
+		// make all separators match
1055
+		$widget_path = rtrim(str_replace('/\\', DS, $widget_path), DS);
1056
+		// does the file path INCLUDE the actual file name as part of the path ?
1057
+		if (strpos($widget_path, $widget_ext) !== false) {
1058
+			// grab and shortcode file name from directory name and break apart at dots
1059
+			$file_name = explode('.', basename($widget_path));
1060
+			// take first segment from file name pieces and remove class prefix if it exists
1061
+			$widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
1062
+			// sanitize shortcode directory name
1063
+			$widget = sanitize_key($widget);
1064
+			// now we need to rebuild the shortcode path
1065
+			$widget_path = explode(DS, $widget_path);
1066
+			// remove last segment
1067
+			array_pop($widget_path);
1068
+			// glue it back together
1069
+			$widget_path = implode(DS, $widget_path);
1070
+		} else {
1071
+			// grab and sanitize widget directory name
1072
+			$widget = sanitize_key(basename($widget_path));
1073
+		}
1074
+		// create classname from widget directory name
1075
+		$widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
1076
+		// add class prefix
1077
+		$widget_class = 'EEW_' . $widget;
1078
+		// does the widget exist ?
1079
+		if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
1080
+			$msg = sprintf(
1081
+				__(
1082
+					'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
1083
+					'event_espresso'
1084
+				),
1085
+				$widget_class,
1086
+				$widget_path . DS . $widget_class . $widget_ext
1087
+			);
1088
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1089
+			return;
1090
+		}
1091
+		// load the widget class file
1092
+		require_once($widget_path . DS . $widget_class . $widget_ext);
1093
+		// verify that class exists
1094
+		if (! class_exists($widget_class)) {
1095
+			$msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
1096
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1097
+			return;
1098
+		}
1099
+		register_widget($widget_class);
1100
+		// add to array of registered widgets
1101
+		EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
1102
+	}
1103
+
1104
+
1105
+	/**
1106
+	 *        _register_modules
1107
+	 *
1108
+	 * @access private
1109
+	 * @return array
1110
+	 */
1111
+	private function _register_modules()
1112
+	{
1113
+		// grab list of installed modules
1114
+		$modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
1115
+		// filter list of modules to register
1116
+		$modules_to_register = apply_filters(
1117
+			'FHEE__EE_Config__register_modules__modules_to_register',
1118
+			$modules_to_register
1119
+		);
1120
+		if (! empty($modules_to_register)) {
1121
+			// loop through folders
1122
+			foreach ($modules_to_register as $module_path) {
1123
+				/**TEMPORARILY EXCLUDE gateways from modules for time being**/
1124
+				if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
1125
+					&& $module_path !== EE_MODULES . 'gateways'
1126
+				) {
1127
+					// add to list of installed modules
1128
+					EE_Config::register_module($module_path);
1129
+				}
1130
+			}
1131
+		}
1132
+		// filter list of installed modules
1133
+		return apply_filters(
1134
+			'FHEE__EE_Config___register_modules__installed_modules',
1135
+			EE_Registry::instance()->modules
1136
+		);
1137
+	}
1138
+
1139
+
1140
+	/**
1141
+	 *    register_module - makes core aware of this module
1142
+	 *
1143
+	 * @access    public
1144
+	 * @param    string $module_path - full path up to and including module folder
1145
+	 * @return    bool
1146
+	 */
1147
+	public static function register_module($module_path = null)
1148
+	{
1149
+		do_action('AHEE__EE_Config__register_module__begin', $module_path);
1150
+		$module_ext = '.module.php';
1151
+		// make all separators match
1152
+		$module_path = str_replace(array('\\', '/'), DS, $module_path);
1153
+		// does the file path INCLUDE the actual file name as part of the path ?
1154
+		if (strpos($module_path, $module_ext) !== false) {
1155
+			// grab and shortcode file name from directory name and break apart at dots
1156
+			$module_file = explode('.', basename($module_path));
1157
+			// now we need to rebuild the shortcode path
1158
+			$module_path = explode(DS, $module_path);
1159
+			// remove last segment
1160
+			array_pop($module_path);
1161
+			// glue it back together
1162
+			$module_path = implode(DS, $module_path) . DS;
1163
+			// take first segment from file name pieces and sanitize it
1164
+			$module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
1165
+			// ensure class prefix is added
1166
+			$module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
1167
+		} else {
1168
+			// we need to generate the filename based off of the folder name
1169
+			// grab and sanitize module name
1170
+			$module = strtolower(basename($module_path));
1171
+			$module = preg_replace('/[^a-z0-9_\-]/', '', $module);
1172
+			// like trailingslashit()
1173
+			$module_path = rtrim($module_path, DS) . DS;
1174
+			// create classname from module directory name
1175
+			$module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
1176
+			// add class prefix
1177
+			$module_class = 'EED_' . $module;
1178
+		}
1179
+		// does the module exist ?
1180
+		if (! is_readable($module_path . DS . $module_class . $module_ext)) {
1181
+			$msg = sprintf(
1182
+				__(
1183
+					'The requested %s module file could not be found or is not readable due to file permissions.',
1184
+					'event_espresso'
1185
+				),
1186
+				$module
1187
+			);
1188
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1189
+			return false;
1190
+		}
1191
+		// load the module class file
1192
+		require_once($module_path . $module_class . $module_ext);
1193
+		// verify that class exists
1194
+		if (! class_exists($module_class)) {
1195
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
1196
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1197
+			return false;
1198
+		}
1199
+		// add to array of registered modules
1200
+		EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
1201
+		do_action(
1202
+			'AHEE__EE_Config__register_module__complete',
1203
+			$module_class,
1204
+			EE_Registry::instance()->modules->{$module_class}
1205
+		);
1206
+		return true;
1207
+	}
1208
+
1209
+
1210
+	/**
1211
+	 *    _initialize_modules
1212
+	 *    allow modules to set hooks for the rest of the system
1213
+	 *
1214
+	 * @access private
1215
+	 * @return void
1216
+	 */
1217
+	private function _initialize_modules()
1218
+	{
1219
+		// cycle thru shortcode folders
1220
+		foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
1221
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
1222
+			// which set hooks ?
1223
+			if (is_admin()) {
1224
+				// fire immediately
1225
+				call_user_func(array($module_class, 'set_hooks_admin'));
1226
+			} else {
1227
+				// delay until other systems are online
1228
+				add_action(
1229
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
1230
+					array($module_class, 'set_hooks')
1231
+				);
1232
+			}
1233
+		}
1234
+	}
1235
+
1236
+
1237
+	/**
1238
+	 *    register_route - adds module method routes to route_map
1239
+	 *
1240
+	 * @access    public
1241
+	 * @param    string $route       - "pretty" public alias for module method
1242
+	 * @param    string $module      - module name (classname without EED_ prefix)
1243
+	 * @param    string $method_name - the actual module method to be routed to
1244
+	 * @param    string $key         - url param key indicating a route is being called
1245
+	 * @return    bool
1246
+	 */
1247
+	public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
1248
+	{
1249
+		do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
1250
+		$module = str_replace('EED_', '', $module);
1251
+		$module_class = 'EED_' . $module;
1252
+		if (! isset(EE_Registry::instance()->modules->{$module_class})) {
1253
+			$msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
1254
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1255
+			return false;
1256
+		}
1257
+		if (empty($route)) {
1258
+			$msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
1259
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1260
+			return false;
1261
+		}
1262
+		if (! method_exists('EED_' . $module, $method_name)) {
1263
+			$msg = sprintf(
1264
+				__('A valid class method for the %s route has not been supplied.', 'event_espresso'),
1265
+				$route
1266
+			);
1267
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1268
+			return false;
1269
+		}
1270
+		EE_Config::$_module_route_map[ $key ][ $route ] = array('EED_' . $module, $method_name);
1271
+		return true;
1272
+	}
1273
+
1274
+
1275
+	/**
1276
+	 *    get_route - get module method route
1277
+	 *
1278
+	 * @access    public
1279
+	 * @param    string $route - "pretty" public alias for module method
1280
+	 * @param    string $key   - url param key indicating a route is being called
1281
+	 * @return    string
1282
+	 */
1283
+	public static function get_route($route = null, $key = 'ee')
1284
+	{
1285
+		do_action('AHEE__EE_Config__get_route__begin', $route);
1286
+		$route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
1287
+		if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
1288
+			return EE_Config::$_module_route_map[ $key ][ $route ];
1289
+		}
1290
+		return null;
1291
+	}
1292
+
1293
+
1294
+	/**
1295
+	 *    get_routes - get ALL module method routes
1296
+	 *
1297
+	 * @access    public
1298
+	 * @return    array
1299
+	 */
1300
+	public static function get_routes()
1301
+	{
1302
+		return EE_Config::$_module_route_map;
1303
+	}
1304
+
1305
+
1306
+	/**
1307
+	 *    register_forward - allows modules to forward request to another module for further processing
1308
+	 *
1309
+	 * @access    public
1310
+	 * @param    string       $route   - "pretty" public alias for module method
1311
+	 * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
1312
+	 *                                 class, allows different forwards to be served based on status
1313
+	 * @param    array|string $forward - function name or array( class, method )
1314
+	 * @param    string       $key     - url param key indicating a route is being called
1315
+	 * @return    bool
1316
+	 */
1317
+	public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
1318
+	{
1319
+		do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
1320
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1321
+			$msg = sprintf(
1322
+				__('The module route %s for this forward has not been registered.', 'event_espresso'),
1323
+				$route
1324
+			);
1325
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1326
+			return false;
1327
+		}
1328
+		if (empty($forward)) {
1329
+			$msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
1330
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1331
+			return false;
1332
+		}
1333
+		if (is_array($forward)) {
1334
+			if (! isset($forward[1])) {
1335
+				$msg = sprintf(
1336
+					__('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
1337
+					$route
1338
+				);
1339
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1340
+				return false;
1341
+			}
1342
+			if (! method_exists($forward[0], $forward[1])) {
1343
+				$msg = sprintf(
1344
+					__('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
1345
+					$forward[1],
1346
+					$route
1347
+				);
1348
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1349
+				return false;
1350
+			}
1351
+		} elseif (! function_exists($forward)) {
1352
+			$msg = sprintf(
1353
+				__('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
1354
+				$forward,
1355
+				$route
1356
+			);
1357
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1358
+			return false;
1359
+		}
1360
+		EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
1361
+		return true;
1362
+	}
1363
+
1364
+
1365
+	/**
1366
+	 *    get_forward - get forwarding route
1367
+	 *
1368
+	 * @access    public
1369
+	 * @param    string  $route  - "pretty" public alias for module method
1370
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1371
+	 *                           allows different forwards to be served based on status
1372
+	 * @param    string  $key    - url param key indicating a route is being called
1373
+	 * @return    string
1374
+	 */
1375
+	public static function get_forward($route = null, $status = 0, $key = 'ee')
1376
+	{
1377
+		do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
1378
+		if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
1379
+			return apply_filters(
1380
+				'FHEE__EE_Config__get_forward',
1381
+				EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
1382
+				$route,
1383
+				$status
1384
+			);
1385
+		}
1386
+		return null;
1387
+	}
1388
+
1389
+
1390
+	/**
1391
+	 *    register_forward - allows modules to specify different view templates for different method routes and status
1392
+	 *    results
1393
+	 *
1394
+	 * @access    public
1395
+	 * @param    string  $route  - "pretty" public alias for module method
1396
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1397
+	 *                           allows different views to be served based on status
1398
+	 * @param    string  $view
1399
+	 * @param    string  $key    - url param key indicating a route is being called
1400
+	 * @return    bool
1401
+	 */
1402
+	public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
1403
+	{
1404
+		do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
1405
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1406
+			$msg = sprintf(
1407
+				__('The module route %s for this view has not been registered.', 'event_espresso'),
1408
+				$route
1409
+			);
1410
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1411
+			return false;
1412
+		}
1413
+		if (! is_readable($view)) {
1414
+			$msg = sprintf(
1415
+				__(
1416
+					'The %s view file could not be found or is not readable due to file permissions.',
1417
+					'event_espresso'
1418
+				),
1419
+				$view
1420
+			);
1421
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1422
+			return false;
1423
+		}
1424
+		EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
1425
+		return true;
1426
+	}
1427
+
1428
+
1429
+	/**
1430
+	 *    get_view - get view for route and status
1431
+	 *
1432
+	 * @access    public
1433
+	 * @param    string  $route  - "pretty" public alias for module method
1434
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1435
+	 *                           allows different views to be served based on status
1436
+	 * @param    string  $key    - url param key indicating a route is being called
1437
+	 * @return    string
1438
+	 */
1439
+	public static function get_view($route = null, $status = 0, $key = 'ee')
1440
+	{
1441
+		do_action('AHEE__EE_Config__get_view__begin', $route, $status);
1442
+		if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
1443
+			return apply_filters(
1444
+				'FHEE__EE_Config__get_view',
1445
+				EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
1446
+				$route,
1447
+				$status
1448
+			);
1449
+		}
1450
+		return null;
1451
+	}
1452
+
1453
+
1454
+	public function update_addon_option_names()
1455
+	{
1456
+		update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
1457
+	}
1458
+
1459
+
1460
+	public function shutdown()
1461
+	{
1462
+		$this->update_addon_option_names();
1463
+	}
1464
+
1465
+
1466
+	/**
1467
+	 * @return LegacyShortcodesManager
1468
+	 */
1469
+	public static function getLegacyShortcodesManager()
1470
+	{
1471
+
1472
+		if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
1473
+			EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
1474
+				EE_Registry::instance()
1475
+			);
1476
+		}
1477
+		return EE_Config::instance()->legacy_shortcodes_manager;
1478
+	}
1479
+
1480
+
1481
+	/**
1482
+	 * register_shortcode - makes core aware of this shortcode
1483
+	 *
1484
+	 * @deprecated 4.9.26
1485
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
1486
+	 * @return    bool
1487
+	 */
1488
+	public static function register_shortcode($shortcode_path = null)
1489
+	{
1490
+		EE_Error::doing_it_wrong(
1491
+			__METHOD__,
1492
+			__(
1493
+				'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
1494
+				'event_espresso'
1495
+			),
1496
+			'4.9.26'
1497
+		);
1498
+		return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
1499
+	}
1500
+}
2273 1501
 
2274
-    /**
2275
-     * ReCaptcha Type
2276
-     *
2277
-     * @var string $recaptcha_type
2278
-     *    options: 'audio', 'image'
2279
-     */
2280
-    public $recaptcha_type;
1502
+/**
1503
+ * Base class used for config classes. These classes should generally not have
1504
+ * magic functions in use, except we'll allow them to magically set and get stuff...
1505
+ * basically, they should just be well-defined stdClasses
1506
+ */
1507
+class EE_Config_Base
1508
+{
2281 1509
 
2282
-    /**
2283
-     * ReCaptcha language
2284
-     *
2285
-     * @var string $recaptcha_language
2286
-     * eg 'en'
2287
-     */
2288
-    public $recaptcha_language;
1510
+	/**
1511
+	 * Utility function for escaping the value of a property and returning.
1512
+	 *
1513
+	 * @param string $property property name (checks to see if exists).
1514
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
1515
+	 * @throws \EE_Error
1516
+	 */
1517
+	public function get_pretty($property)
1518
+	{
1519
+		if (! property_exists($this, $property)) {
1520
+			throw new EE_Error(
1521
+				sprintf(
1522
+					__(
1523
+						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
1524
+						'event_espresso'
1525
+					),
1526
+					get_class($this),
1527
+					$property
1528
+				)
1529
+			);
1530
+		}
1531
+		// just handling escaping of strings for now.
1532
+		if (is_string($this->{$property})) {
1533
+			return stripslashes($this->{$property});
1534
+		}
1535
+		return $this->{$property};
1536
+	}
1537
+
1538
+
1539
+	public function populate()
1540
+	{
1541
+		// grab defaults via a new instance of this class.
1542
+		$class_name = get_class($this);
1543
+		$defaults = new $class_name;
1544
+		// loop through the properties for this class and see if they are set.  If they are NOT, then grab the
1545
+		// default from our $defaults object.
1546
+		foreach (get_object_vars($defaults) as $property => $value) {
1547
+			if ($this->{$property} === null) {
1548
+				$this->{$property} = $value;
1549
+			}
1550
+		}
1551
+		// cleanup
1552
+		unset($defaults);
1553
+	}
1554
+
1555
+
1556
+	/**
1557
+	 *        __isset
1558
+	 *
1559
+	 * @param $a
1560
+	 * @return bool
1561
+	 */
1562
+	public function __isset($a)
1563
+	{
1564
+		return false;
1565
+	}
1566
+
1567
+
1568
+	/**
1569
+	 *        __unset
1570
+	 *
1571
+	 * @param $a
1572
+	 * @return bool
1573
+	 */
1574
+	public function __unset($a)
1575
+	{
1576
+		return false;
1577
+	}
1578
+
1579
+
1580
+	/**
1581
+	 *        __clone
1582
+	 */
1583
+	public function __clone()
1584
+	{
1585
+	}
1586
+
1587
+
1588
+	/**
1589
+	 *        __wakeup
1590
+	 */
1591
+	public function __wakeup()
1592
+	{
1593
+	}
1594
+
1595
+
1596
+	/**
1597
+	 *        __destruct
1598
+	 */
1599
+	public function __destruct()
1600
+	{
1601
+	}
1602
+}
2289 1603
 
2290
-    /**
2291
-     * ReCaptcha public key
2292
-     *
2293
-     * @var string $recaptcha_publickey
2294
-     */
2295
-    public $recaptcha_publickey;
1604
+/**
1605
+ * Class for defining what's in the EE_Config relating to registration settings
1606
+ */
1607
+class EE_Core_Config extends EE_Config_Base
1608
+{
2296 1609
 
2297
-    /**
2298
-     * ReCaptcha private key
2299
-     *
2300
-     * @var string $recaptcha_privatekey
2301
-     */
2302
-    public $recaptcha_privatekey;
1610
+	public $current_blog_id;
1611
+
1612
+	public $ee_ueip_optin;
1613
+
1614
+	public $ee_ueip_has_notified;
1615
+
1616
+	/**
1617
+	 * Not to be confused with the 4 critical page variables (See
1618
+	 * get_critical_pages_array()), this is just an array of wp posts that have EE
1619
+	 * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
1620
+	 * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
1621
+	 *
1622
+	 * @var array
1623
+	 */
1624
+	public $post_shortcodes;
1625
+
1626
+	public $module_route_map;
1627
+
1628
+	public $module_forward_map;
1629
+
1630
+	public $module_view_map;
1631
+
1632
+	/**
1633
+	 * The next 4 vars are the IDs of critical EE pages.
1634
+	 *
1635
+	 * @var int
1636
+	 */
1637
+	public $reg_page_id;
1638
+
1639
+	public $txn_page_id;
1640
+
1641
+	public $thank_you_page_id;
1642
+
1643
+	public $cancel_page_id;
1644
+
1645
+	/**
1646
+	 * The next 4 vars are the URLs of critical EE pages.
1647
+	 *
1648
+	 * @var int
1649
+	 */
1650
+	public $reg_page_url;
1651
+
1652
+	public $txn_page_url;
1653
+
1654
+	public $thank_you_page_url;
1655
+
1656
+	public $cancel_page_url;
1657
+
1658
+	/**
1659
+	 * The next vars relate to the custom slugs for EE CPT routes
1660
+	 */
1661
+	public $event_cpt_slug;
1662
+
1663
+	/**
1664
+	 * This caches the _ee_ueip_option in case this config is reset in the same
1665
+	 * request across blog switches in a multisite context.
1666
+	 * Avoids extra queries to the db for this option.
1667
+	 *
1668
+	 * @var bool
1669
+	 */
1670
+	public static $ee_ueip_option;
1671
+
1672
+
1673
+	/**
1674
+	 *    class constructor
1675
+	 *
1676
+	 * @access    public
1677
+	 */
1678
+	public function __construct()
1679
+	{
1680
+		// set default organization settings
1681
+		$this->current_blog_id = get_current_blog_id();
1682
+		$this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
1683
+		$this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
1684
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
1685
+		$this->post_shortcodes = array();
1686
+		$this->module_route_map = array();
1687
+		$this->module_forward_map = array();
1688
+		$this->module_view_map = array();
1689
+		// critical EE page IDs
1690
+		$this->reg_page_id = 0;
1691
+		$this->txn_page_id = 0;
1692
+		$this->thank_you_page_id = 0;
1693
+		$this->cancel_page_id = 0;
1694
+		// critical EE page URLs
1695
+		$this->reg_page_url = '';
1696
+		$this->txn_page_url = '';
1697
+		$this->thank_you_page_url = '';
1698
+		$this->cancel_page_url = '';
1699
+		// cpt slugs
1700
+		$this->event_cpt_slug = __('events', 'event_espresso');
1701
+		// ueip constant check
1702
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
1703
+			$this->ee_ueip_optin = false;
1704
+			$this->ee_ueip_has_notified = true;
1705
+		}
1706
+	}
1707
+
1708
+
1709
+	/**
1710
+	 * @return array
1711
+	 */
1712
+	public function get_critical_pages_array()
1713
+	{
1714
+		return array(
1715
+			$this->reg_page_id,
1716
+			$this->txn_page_id,
1717
+			$this->thank_you_page_id,
1718
+			$this->cancel_page_id,
1719
+		);
1720
+	}
1721
+
1722
+
1723
+	/**
1724
+	 * @return array
1725
+	 */
1726
+	public function get_critical_pages_shortcodes_array()
1727
+	{
1728
+		return array(
1729
+			$this->reg_page_id       => 'ESPRESSO_CHECKOUT',
1730
+			$this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
1731
+			$this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
1732
+			$this->cancel_page_id    => 'ESPRESSO_CANCELLED',
1733
+		);
1734
+	}
1735
+
1736
+
1737
+	/**
1738
+	 *  gets/returns URL for EE reg_page
1739
+	 *
1740
+	 * @access    public
1741
+	 * @return    string
1742
+	 */
1743
+	public function reg_page_url()
1744
+	{
1745
+		if (! $this->reg_page_url) {
1746
+			$this->reg_page_url = add_query_arg(
1747
+				array('uts' => time()),
1748
+				get_permalink($this->reg_page_id)
1749
+			) . '#checkout';
1750
+		}
1751
+		return $this->reg_page_url;
1752
+	}
1753
+
1754
+
1755
+	/**
1756
+	 *  gets/returns URL for EE txn_page
1757
+	 *
1758
+	 * @param array $query_args like what gets passed to
1759
+	 *                          add_query_arg() as the first argument
1760
+	 * @access    public
1761
+	 * @return    string
1762
+	 */
1763
+	public function txn_page_url($query_args = array())
1764
+	{
1765
+		if (! $this->txn_page_url) {
1766
+			$this->txn_page_url = get_permalink($this->txn_page_id);
1767
+		}
1768
+		if ($query_args) {
1769
+			return add_query_arg($query_args, $this->txn_page_url);
1770
+		} else {
1771
+			return $this->txn_page_url;
1772
+		}
1773
+	}
1774
+
1775
+
1776
+	/**
1777
+	 *  gets/returns URL for EE thank_you_page
1778
+	 *
1779
+	 * @param array $query_args like what gets passed to
1780
+	 *                          add_query_arg() as the first argument
1781
+	 * @access    public
1782
+	 * @return    string
1783
+	 */
1784
+	public function thank_you_page_url($query_args = array())
1785
+	{
1786
+		if (! $this->thank_you_page_url) {
1787
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
1788
+		}
1789
+		if ($query_args) {
1790
+			return add_query_arg($query_args, $this->thank_you_page_url);
1791
+		} else {
1792
+			return $this->thank_you_page_url;
1793
+		}
1794
+	}
1795
+
1796
+
1797
+	/**
1798
+	 *  gets/returns URL for EE cancel_page
1799
+	 *
1800
+	 * @access    public
1801
+	 * @return    string
1802
+	 */
1803
+	public function cancel_page_url()
1804
+	{
1805
+		if (! $this->cancel_page_url) {
1806
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
1807
+		}
1808
+		return $this->cancel_page_url;
1809
+	}
1810
+
1811
+
1812
+	/**
1813
+	 * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
1814
+	 *
1815
+	 * @since 4.7.5
1816
+	 */
1817
+	protected function _reset_urls()
1818
+	{
1819
+		$this->reg_page_url = '';
1820
+		$this->txn_page_url = '';
1821
+		$this->cancel_page_url = '';
1822
+		$this->thank_you_page_url = '';
1823
+	}
1824
+
1825
+
1826
+	/**
1827
+	 * Used to return what the optin value is set for the EE User Experience Program.
1828
+	 * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
1829
+	 * on the main site only.
1830
+	 *
1831
+	 * @return mixed|void
1832
+	 */
1833
+	protected function _get_main_ee_ueip_optin()
1834
+	{
1835
+		// if this is the main site then we can just bypass our direct query.
1836
+		if (is_main_site()) {
1837
+			return get_option('ee_ueip_optin', false);
1838
+		}
1839
+		// is this already cached for this request?  If so use it.
1840
+		if (! empty(EE_Core_Config::$ee_ueip_option)) {
1841
+			return EE_Core_Config::$ee_ueip_option;
1842
+		}
1843
+		global $wpdb;
1844
+		$current_network_main_site = is_multisite() ? get_current_site() : null;
1845
+		$current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
1846
+		$option = 'ee_ueip_optin';
1847
+		// set correct table for query
1848
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
1849
+		// rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
1850
+		// get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
1851
+		// re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
1852
+		// this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
1853
+		// for the purpose of caching.
1854
+		$pre = apply_filters('pre_option_' . $option, false, $option);
1855
+		if (false !== $pre) {
1856
+			EE_Core_Config::$ee_ueip_option = $pre;
1857
+			return EE_Core_Config::$ee_ueip_option;
1858
+		}
1859
+		$row = $wpdb->get_row(
1860
+			$wpdb->prepare(
1861
+				"SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
1862
+				$option
1863
+			)
1864
+		);
1865
+		if (is_object($row)) {
1866
+			$value = $row->option_value;
1867
+		} else { // option does not exist so use default.
1868
+			return apply_filters('default_option_' . $option, false, $option);
1869
+		}
1870
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
1871
+		return EE_Core_Config::$ee_ueip_option;
1872
+	}
1873
+
1874
+
1875
+	/**
1876
+	 * Utility function for escaping the value of a property and returning.
1877
+	 *
1878
+	 * @param string $property property name (checks to see if exists).
1879
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
1880
+	 * @throws \EE_Error
1881
+	 */
1882
+	public function get_pretty($property)
1883
+	{
1884
+		if ($property === 'ee_ueip_optin') {
1885
+			return $this->ee_ueip_optin ? 'yes' : 'no';
1886
+		}
1887
+		return parent::get_pretty($property);
1888
+	}
1889
+
1890
+
1891
+	/**
1892
+	 * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
1893
+	 * on the object.
1894
+	 *
1895
+	 * @return array
1896
+	 */
1897
+	public function __sleep()
1898
+	{
1899
+		// reset all url properties
1900
+		$this->_reset_urls();
1901
+		// return what to save to db
1902
+		return array_keys(get_object_vars($this));
1903
+	}
1904
+}
2303 1905
 
2304
-    /**
2305
-     * array of form names protected by ReCaptcha
2306
-     *
2307
-     * @var array $recaptcha_protected_forms
2308
-     */
2309
-    public $recaptcha_protected_forms;
1906
+/**
1907
+ * Config class for storing info on the Organization
1908
+ */
1909
+class EE_Organization_Config extends EE_Config_Base
1910
+{
2310 1911
 
2311
-    /**
2312
-     * ReCaptcha width
2313
-     *
2314
-     * @var int $recaptcha_width
2315
-     * @deprecated
2316
-     */
2317
-    public $recaptcha_width;
1912
+	/**
1913
+	 * @var string $name
1914
+	 * eg EE4.1
1915
+	 */
1916
+	public $name;
1917
+
1918
+	/**
1919
+	 * @var string $address_1
1920
+	 * eg 123 Onna Road
1921
+	 */
1922
+	public $address_1;
1923
+
1924
+	/**
1925
+	 * @var string $address_2
1926
+	 * eg PO Box 123
1927
+	 */
1928
+	public $address_2;
1929
+
1930
+	/**
1931
+	 * @var string $city
1932
+	 * eg Inna City
1933
+	 */
1934
+	public $city;
1935
+
1936
+	/**
1937
+	 * @var int $STA_ID
1938
+	 * eg 4
1939
+	 */
1940
+	public $STA_ID;
1941
+
1942
+	/**
1943
+	 * @var string $CNT_ISO
1944
+	 * eg US
1945
+	 */
1946
+	public $CNT_ISO;
1947
+
1948
+	/**
1949
+	 * @var string $zip
1950
+	 * eg 12345  or V1A 2B3
1951
+	 */
1952
+	public $zip;
1953
+
1954
+	/**
1955
+	 * @var string $email
1956
+	 * eg [email protected]
1957
+	 */
1958
+	public $email;
1959
+
1960
+	/**
1961
+	 * @var string $phone
1962
+	 * eg. 111-111-1111
1963
+	 */
1964
+	public $phone;
1965
+
1966
+	/**
1967
+	 * @var string $vat
1968
+	 * VAT/Tax Number
1969
+	 */
1970
+	public $vat;
1971
+
1972
+	/**
1973
+	 * @var string $logo_url
1974
+	 * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
1975
+	 */
1976
+	public $logo_url;
1977
+
1978
+	/**
1979
+	 * The below are all various properties for holding links to organization social network profiles
1980
+	 *
1981
+	 * @var string
1982
+	 */
1983
+	/**
1984
+	 * facebook (facebook.com/profile.name)
1985
+	 *
1986
+	 * @var string
1987
+	 */
1988
+	public $facebook;
1989
+
1990
+	/**
1991
+	 * twitter (twitter.com/twitter_handle)
1992
+	 *
1993
+	 * @var string
1994
+	 */
1995
+	public $twitter;
1996
+
1997
+	/**
1998
+	 * linkedin (linkedin.com/in/profile_name)
1999
+	 *
2000
+	 * @var string
2001
+	 */
2002
+	public $linkedin;
2003
+
2004
+	/**
2005
+	 * pinterest (www.pinterest.com/profile_name)
2006
+	 *
2007
+	 * @var string
2008
+	 */
2009
+	public $pinterest;
2010
+
2011
+	/**
2012
+	 * google+ (google.com/+profileName)
2013
+	 *
2014
+	 * @var string
2015
+	 */
2016
+	public $google;
2017
+
2018
+	/**
2019
+	 * instagram (instagram.com/handle)
2020
+	 *
2021
+	 * @var string
2022
+	 */
2023
+	public $instagram;
2024
+
2025
+
2026
+	/**
2027
+	 *    class constructor
2028
+	 *
2029
+	 * @access    public
2030
+	 */
2031
+	public function __construct()
2032
+	{
2033
+		// set default organization settings
2034
+		// decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
2035
+		$this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
2036
+		$this->address_1 = '123 Onna Road';
2037
+		$this->address_2 = 'PO Box 123';
2038
+		$this->city = 'Inna City';
2039
+		$this->STA_ID = 4;
2040
+		$this->CNT_ISO = 'US';
2041
+		$this->zip = '12345';
2042
+		$this->email = get_bloginfo('admin_email');
2043
+		$this->phone = '';
2044
+		$this->vat = '123456789';
2045
+		$this->logo_url = '';
2046
+		$this->facebook = '';
2047
+		$this->twitter = '';
2048
+		$this->linkedin = '';
2049
+		$this->pinterest = '';
2050
+		$this->google = '';
2051
+		$this->instagram = '';
2052
+	}
2053
+}
2318 2054
 
2319
-    /**
2320
-     * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
2321
-     *
2322
-     * @var boolean $track_invalid_checkout_access
2323
-     */
2324
-    protected $track_invalid_checkout_access = true;
2055
+/**
2056
+ * Class for defining what's in the EE_Config relating to currency
2057
+ */
2058
+class EE_Currency_Config extends EE_Config_Base
2059
+{
2325 2060
 
2326
-    /**
2327
-     * Whether or not to show the privacy policy consent checkbox
2328
-     *
2329
-     * @var bool
2330
-     */
2331
-    public $consent_checkbox_enabled;
2061
+	/**
2062
+	 * @var string $code
2063
+	 * eg 'US'
2064
+	 */
2065
+	public $code;
2066
+
2067
+	/**
2068
+	 * @var string $name
2069
+	 * eg 'Dollar'
2070
+	 */
2071
+	public $name;
2072
+
2073
+	/**
2074
+	 * plural name
2075
+	 *
2076
+	 * @var string $plural
2077
+	 * eg 'Dollars'
2078
+	 */
2079
+	public $plural;
2080
+
2081
+	/**
2082
+	 * currency sign
2083
+	 *
2084
+	 * @var string $sign
2085
+	 * eg '$'
2086
+	 */
2087
+	public $sign;
2088
+
2089
+	/**
2090
+	 * Whether the currency sign should come before the number or not
2091
+	 *
2092
+	 * @var boolean $sign_b4
2093
+	 */
2094
+	public $sign_b4;
2095
+
2096
+	/**
2097
+	 * How many digits should come after the decimal place
2098
+	 *
2099
+	 * @var int $dec_plc
2100
+	 */
2101
+	public $dec_plc;
2102
+
2103
+	/**
2104
+	 * Symbol to use for decimal mark
2105
+	 *
2106
+	 * @var string $dec_mrk
2107
+	 * eg '.'
2108
+	 */
2109
+	public $dec_mrk;
2110
+
2111
+	/**
2112
+	 * Symbol to use for thousands
2113
+	 *
2114
+	 * @var string $thsnds
2115
+	 * eg ','
2116
+	 */
2117
+	public $thsnds;
2118
+
2119
+
2120
+	/**
2121
+	 *    class constructor
2122
+	 *
2123
+	 * @access    public
2124
+	 * @param string $CNT_ISO
2125
+	 * @throws \EE_Error
2126
+	 */
2127
+	public function __construct($CNT_ISO = '')
2128
+	{
2129
+		/** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
2130
+		$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
2131
+		// get country code from organization settings or use default
2132
+		$ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
2133
+				   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
2134
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
2135
+			: '';
2136
+		// but override if requested
2137
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
2138
+		// so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
2139
+		if (! empty($CNT_ISO)
2140
+			&& EE_Maintenance_Mode::instance()->models_can_query()
2141
+			&& $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
2142
+		) {
2143
+			// retrieve the country settings from the db, just in case they have been customized
2144
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
2145
+			if ($country instanceof EE_Country) {
2146
+				$this->code = $country->currency_code();    // currency code: USD, CAD, EUR
2147
+				$this->name = $country->currency_name_single();    // Dollar
2148
+				$this->plural = $country->currency_name_plural();    // Dollars
2149
+				$this->sign = $country->currency_sign();            // currency sign: $
2150
+				$this->sign_b4 = $country->currency_sign_before(
2151
+				);        // currency sign before or after: $TRUE  or  FALSE$
2152
+				$this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
2153
+				$this->dec_mrk = $country->currency_decimal_mark(
2154
+				);    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2155
+				$this->thsnds = $country->currency_thousands_separator(
2156
+				);    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2157
+			}
2158
+		}
2159
+		// fallback to hardcoded defaults, in case the above failed
2160
+		if (empty($this->code)) {
2161
+			// set default currency settings
2162
+			$this->code = 'USD';    // currency code: USD, CAD, EUR
2163
+			$this->name = __('Dollar', 'event_espresso');    // Dollar
2164
+			$this->plural = __('Dollars', 'event_espresso');    // Dollars
2165
+			$this->sign = '$';    // currency sign: $
2166
+			$this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
2167
+			$this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
2168
+			$this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2169
+			$this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2170
+		}
2171
+	}
2172
+}
2332 2173
 
2333
-    /**
2334
-     * Label text to show on the checkbox
2335
-     *
2336
-     * @var string
2337
-     */
2338
-    public $consent_checkbox_label_text;
2174
+/**
2175
+ * Class for defining what's in the EE_Config relating to registration settings
2176
+ */
2177
+class EE_Registration_Config extends EE_Config_Base
2178
+{
2339 2179
 
2340
-    /*
2180
+	/**
2181
+	 * Default registration status
2182
+	 *
2183
+	 * @var string $default_STS_ID
2184
+	 * eg 'RPP'
2185
+	 */
2186
+	public $default_STS_ID;
2187
+
2188
+	/**
2189
+	 * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
2190
+	 * registrations)
2191
+	 *
2192
+	 * @var int
2193
+	 */
2194
+	public $default_maximum_number_of_tickets;
2195
+
2196
+	/**
2197
+	 * level of validation to apply to email addresses
2198
+	 *
2199
+	 * @var string $email_validation_level
2200
+	 * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
2201
+	 */
2202
+	public $email_validation_level;
2203
+
2204
+	/**
2205
+	 *    whether or not to show alternate payment options during the reg process if payment status is pending
2206
+	 *
2207
+	 * @var boolean $show_pending_payment_options
2208
+	 */
2209
+	public $show_pending_payment_options;
2210
+
2211
+	/**
2212
+	 * Whether to skip the registration confirmation page
2213
+	 *
2214
+	 * @var boolean $skip_reg_confirmation
2215
+	 */
2216
+	public $skip_reg_confirmation;
2217
+
2218
+	/**
2219
+	 * an array of SPCO reg steps where:
2220
+	 *        the keys denotes the reg step order
2221
+	 *        each element consists of an array with the following elements:
2222
+	 *            "file_path" => the file path to the EE_SPCO_Reg_Step class
2223
+	 *            "class_name" => the specific EE_SPCO_Reg_Step child class name
2224
+	 *            "slug" => the URL param used to trigger the reg step
2225
+	 *
2226
+	 * @var array $reg_steps
2227
+	 */
2228
+	public $reg_steps;
2229
+
2230
+	/**
2231
+	 * Whether registration confirmation should be the last page of SPCO
2232
+	 *
2233
+	 * @var boolean $reg_confirmation_last
2234
+	 */
2235
+	public $reg_confirmation_last;
2236
+
2237
+	/**
2238
+	 * Whether or not to enable the EE Bot Trap
2239
+	 *
2240
+	 * @var boolean $use_bot_trap
2241
+	 */
2242
+	public $use_bot_trap;
2243
+
2244
+	/**
2245
+	 * Whether or not to encrypt some data sent by the EE Bot Trap
2246
+	 *
2247
+	 * @var boolean $use_encryption
2248
+	 */
2249
+	public $use_encryption;
2250
+
2251
+	/**
2252
+	 * Whether or not to use ReCaptcha
2253
+	 *
2254
+	 * @var boolean $use_captcha
2255
+	 */
2256
+	public $use_captcha;
2257
+
2258
+	/**
2259
+	 * ReCaptcha Theme
2260
+	 *
2261
+	 * @var string $recaptcha_theme
2262
+	 *    options: 'dark', 'light', 'invisible'
2263
+	 */
2264
+	public $recaptcha_theme;
2265
+
2266
+	/**
2267
+	 * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
2268
+	 *
2269
+	 * @var string $recaptcha_badge
2270
+	 *    options: 'bottomright', 'bottomleft', 'inline'
2271
+	 */
2272
+	public $recaptcha_badge;
2273
+
2274
+	/**
2275
+	 * ReCaptcha Type
2276
+	 *
2277
+	 * @var string $recaptcha_type
2278
+	 *    options: 'audio', 'image'
2279
+	 */
2280
+	public $recaptcha_type;
2281
+
2282
+	/**
2283
+	 * ReCaptcha language
2284
+	 *
2285
+	 * @var string $recaptcha_language
2286
+	 * eg 'en'
2287
+	 */
2288
+	public $recaptcha_language;
2289
+
2290
+	/**
2291
+	 * ReCaptcha public key
2292
+	 *
2293
+	 * @var string $recaptcha_publickey
2294
+	 */
2295
+	public $recaptcha_publickey;
2296
+
2297
+	/**
2298
+	 * ReCaptcha private key
2299
+	 *
2300
+	 * @var string $recaptcha_privatekey
2301
+	 */
2302
+	public $recaptcha_privatekey;
2303
+
2304
+	/**
2305
+	 * array of form names protected by ReCaptcha
2306
+	 *
2307
+	 * @var array $recaptcha_protected_forms
2308
+	 */
2309
+	public $recaptcha_protected_forms;
2310
+
2311
+	/**
2312
+	 * ReCaptcha width
2313
+	 *
2314
+	 * @var int $recaptcha_width
2315
+	 * @deprecated
2316
+	 */
2317
+	public $recaptcha_width;
2318
+
2319
+	/**
2320
+	 * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
2321
+	 *
2322
+	 * @var boolean $track_invalid_checkout_access
2323
+	 */
2324
+	protected $track_invalid_checkout_access = true;
2325
+
2326
+	/**
2327
+	 * Whether or not to show the privacy policy consent checkbox
2328
+	 *
2329
+	 * @var bool
2330
+	 */
2331
+	public $consent_checkbox_enabled;
2332
+
2333
+	/**
2334
+	 * Label text to show on the checkbox
2335
+	 *
2336
+	 * @var string
2337
+	 */
2338
+	public $consent_checkbox_label_text;
2339
+
2340
+	/*
2341 2341
      * String describing how long to keep payment logs. Passed into DateTime constructor
2342 2342
      * @var string
2343 2343
      */
2344
-    public $gateway_log_lifespan = '1 week';
2345
-
2346
-
2347
-    /**
2348
-     *    class constructor
2349
-     *
2350
-     * @access    public
2351
-     */
2352
-    public function __construct()
2353
-    {
2354
-        // set default registration settings
2355
-        $this->default_STS_ID = EEM_Registration::status_id_pending_payment;
2356
-        $this->email_validation_level = 'wp_default';
2357
-        $this->show_pending_payment_options = true;
2358
-        $this->skip_reg_confirmation = true;
2359
-        $this->reg_steps = array();
2360
-        $this->reg_confirmation_last = false;
2361
-        $this->use_bot_trap = true;
2362
-        $this->use_encryption = true;
2363
-        $this->use_captcha = false;
2364
-        $this->recaptcha_theme = 'light';
2365
-        $this->recaptcha_badge = 'bottomleft';
2366
-        $this->recaptcha_type = 'image';
2367
-        $this->recaptcha_language = 'en';
2368
-        $this->recaptcha_publickey = null;
2369
-        $this->recaptcha_privatekey = null;
2370
-        $this->recaptcha_protected_forms = array();
2371
-        $this->recaptcha_width = 500;
2372
-        $this->default_maximum_number_of_tickets = 10;
2373
-        $this->consent_checkbox_enabled = true;
2374
-        $this->consent_checkbox_label_text = esc_html__('I Consent to Privacy Policy', 'event_espresso');
2375
-        $this->gateway_log_lifespan = '7 days';
2376
-    }
2377
-
2378
-
2379
-    /**
2380
-     * This is called by the config loader and hooks are initialized AFTER the config has been populated.
2381
-     *
2382
-     * @since 4.8.8.rc.019
2383
-     */
2384
-    public function do_hooks()
2385
-    {
2386
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
2387
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
2388
-        add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
2389
-    }
2390
-
2391
-
2392
-    /**
2393
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
2394
-     * EVT_default_registration_status field matches the config setting for default_STS_ID.
2395
-     */
2396
-    public function set_default_reg_status_on_EEM_Event()
2397
-    {
2398
-        EEM_Event::set_default_reg_status($this->default_STS_ID);
2399
-    }
2400
-
2401
-
2402
-    /**
2403
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
2404
-     * for Events matches the config setting for default_maximum_number_of_tickets
2405
-     */
2406
-    public function set_default_max_ticket_on_EEM_Event()
2407
-    {
2408
-        EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
2409
-    }
2410
-
2411
-
2412
-    /**
2413
-     * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
2414
-     * constructed because that happens before we can get the privacy policy page's permalink.
2415
-     *
2416
-     * @throws InvalidArgumentException
2417
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2418
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2419
-     */
2420
-    public function setDefaultCheckboxLabelText()
2421
-    {
2422
-        if ($this->getConsentCheckboxLabelText() === null
2423
-            || $this->getConsentCheckboxLabelText() === '') {
2424
-            $opening_a_tag = '';
2425
-            $closing_a_tag = '';
2426
-            if (function_exists('get_privacy_policy_url')) {
2427
-                $privacy_page_url = get_privacy_policy_url();
2428
-                if (! empty($privacy_page_url)) {
2429
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
2430
-                    $closing_a_tag = '</a>';
2431
-                }
2432
-            }
2433
-            $loader = LoaderFactory::getLoader();
2434
-            $org_config = $loader->getShared('EE_Organization_Config');
2435
-            /**
2436
-             * @var $org_config EE_Organization_Config
2437
-             */
2438
-
2439
-            $this->setConsentCheckboxLabelText(
2440
-                sprintf(
2441
-                    esc_html__(
2442
-                        'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
2443
-                        'event_espresso'
2444
-                    ),
2445
-                    $org_config->name,
2446
-                    $opening_a_tag,
2447
-                    $closing_a_tag
2448
-                )
2449
-            );
2450
-        }
2451
-    }
2452
-
2453
-
2454
-    /**
2455
-     * @return boolean
2456
-     */
2457
-    public function track_invalid_checkout_access()
2458
-    {
2459
-        return $this->track_invalid_checkout_access;
2460
-    }
2461
-
2462
-
2463
-    /**
2464
-     * @param boolean $track_invalid_checkout_access
2465
-     */
2466
-    public function set_track_invalid_checkout_access($track_invalid_checkout_access)
2467
-    {
2468
-        $this->track_invalid_checkout_access = filter_var(
2469
-            $track_invalid_checkout_access,
2470
-            FILTER_VALIDATE_BOOLEAN
2471
-        );
2472
-    }
2473
-
2474
-
2475
-    /**
2476
-     * Gets the options to make availalbe for the gateway log lifespan
2477
-     * @return array
2478
-     */
2479
-    public function gatewayLogLifespanOptions()
2480
-    {
2481
-        return (array) apply_filters(
2482
-            'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
2483
-            array(
2484
-                '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
2485
-                '1 day' => esc_html__('1 Day', 'event_espresso'),
2486
-                '7 days' => esc_html__('7 Days', 'event_espresso'),
2487
-                '14 days' => esc_html__('14 Days', 'event_espresso'),
2488
-                '30 days' => esc_html__('30 Days', 'event_espresso')
2489
-            )
2490
-        );
2491
-    }
2492
-
2493
-
2494
-    /**
2495
-     * @return bool
2496
-     */
2497
-    public function isConsentCheckboxEnabled()
2498
-    {
2499
-        return $this->consent_checkbox_enabled;
2500
-    }
2501
-
2502
-
2503
-    /**
2504
-     * @param bool $consent_checkbox_enabled
2505
-     */
2506
-    public function setConsentCheckboxEnabled($consent_checkbox_enabled)
2507
-    {
2508
-        $this->consent_checkbox_enabled = filter_var(
2509
-            $consent_checkbox_enabled,
2510
-            FILTER_VALIDATE_BOOLEAN
2511
-        );
2512
-    }
2513
-
2514
-
2515
-    /**
2516
-     * @return string
2517
-     */
2518
-    public function getConsentCheckboxLabelText()
2519
-    {
2520
-        return $this->consent_checkbox_label_text;
2521
-    }
2522
-
2523
-
2524
-    /**
2525
-     * @param string $consent_checkbox_label_text
2526
-     */
2527
-    public function setConsentCheckboxLabelText($consent_checkbox_label_text)
2528
-    {
2529
-        $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
2530
-    }
2344
+	public $gateway_log_lifespan = '1 week';
2345
+
2346
+
2347
+	/**
2348
+	 *    class constructor
2349
+	 *
2350
+	 * @access    public
2351
+	 */
2352
+	public function __construct()
2353
+	{
2354
+		// set default registration settings
2355
+		$this->default_STS_ID = EEM_Registration::status_id_pending_payment;
2356
+		$this->email_validation_level = 'wp_default';
2357
+		$this->show_pending_payment_options = true;
2358
+		$this->skip_reg_confirmation = true;
2359
+		$this->reg_steps = array();
2360
+		$this->reg_confirmation_last = false;
2361
+		$this->use_bot_trap = true;
2362
+		$this->use_encryption = true;
2363
+		$this->use_captcha = false;
2364
+		$this->recaptcha_theme = 'light';
2365
+		$this->recaptcha_badge = 'bottomleft';
2366
+		$this->recaptcha_type = 'image';
2367
+		$this->recaptcha_language = 'en';
2368
+		$this->recaptcha_publickey = null;
2369
+		$this->recaptcha_privatekey = null;
2370
+		$this->recaptcha_protected_forms = array();
2371
+		$this->recaptcha_width = 500;
2372
+		$this->default_maximum_number_of_tickets = 10;
2373
+		$this->consent_checkbox_enabled = true;
2374
+		$this->consent_checkbox_label_text = esc_html__('I Consent to Privacy Policy', 'event_espresso');
2375
+		$this->gateway_log_lifespan = '7 days';
2376
+	}
2377
+
2378
+
2379
+	/**
2380
+	 * This is called by the config loader and hooks are initialized AFTER the config has been populated.
2381
+	 *
2382
+	 * @since 4.8.8.rc.019
2383
+	 */
2384
+	public function do_hooks()
2385
+	{
2386
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
2387
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
2388
+		add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
2389
+	}
2390
+
2391
+
2392
+	/**
2393
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
2394
+	 * EVT_default_registration_status field matches the config setting for default_STS_ID.
2395
+	 */
2396
+	public function set_default_reg_status_on_EEM_Event()
2397
+	{
2398
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
2399
+	}
2400
+
2401
+
2402
+	/**
2403
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
2404
+	 * for Events matches the config setting for default_maximum_number_of_tickets
2405
+	 */
2406
+	public function set_default_max_ticket_on_EEM_Event()
2407
+	{
2408
+		EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
2409
+	}
2410
+
2411
+
2412
+	/**
2413
+	 * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
2414
+	 * constructed because that happens before we can get the privacy policy page's permalink.
2415
+	 *
2416
+	 * @throws InvalidArgumentException
2417
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2418
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2419
+	 */
2420
+	public function setDefaultCheckboxLabelText()
2421
+	{
2422
+		if ($this->getConsentCheckboxLabelText() === null
2423
+			|| $this->getConsentCheckboxLabelText() === '') {
2424
+			$opening_a_tag = '';
2425
+			$closing_a_tag = '';
2426
+			if (function_exists('get_privacy_policy_url')) {
2427
+				$privacy_page_url = get_privacy_policy_url();
2428
+				if (! empty($privacy_page_url)) {
2429
+					$opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
2430
+					$closing_a_tag = '</a>';
2431
+				}
2432
+			}
2433
+			$loader = LoaderFactory::getLoader();
2434
+			$org_config = $loader->getShared('EE_Organization_Config');
2435
+			/**
2436
+			 * @var $org_config EE_Organization_Config
2437
+			 */
2438
+
2439
+			$this->setConsentCheckboxLabelText(
2440
+				sprintf(
2441
+					esc_html__(
2442
+						'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
2443
+						'event_espresso'
2444
+					),
2445
+					$org_config->name,
2446
+					$opening_a_tag,
2447
+					$closing_a_tag
2448
+				)
2449
+			);
2450
+		}
2451
+	}
2452
+
2453
+
2454
+	/**
2455
+	 * @return boolean
2456
+	 */
2457
+	public function track_invalid_checkout_access()
2458
+	{
2459
+		return $this->track_invalid_checkout_access;
2460
+	}
2461
+
2462
+
2463
+	/**
2464
+	 * @param boolean $track_invalid_checkout_access
2465
+	 */
2466
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access)
2467
+	{
2468
+		$this->track_invalid_checkout_access = filter_var(
2469
+			$track_invalid_checkout_access,
2470
+			FILTER_VALIDATE_BOOLEAN
2471
+		);
2472
+	}
2473
+
2474
+
2475
+	/**
2476
+	 * Gets the options to make availalbe for the gateway log lifespan
2477
+	 * @return array
2478
+	 */
2479
+	public function gatewayLogLifespanOptions()
2480
+	{
2481
+		return (array) apply_filters(
2482
+			'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
2483
+			array(
2484
+				'1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
2485
+				'1 day' => esc_html__('1 Day', 'event_espresso'),
2486
+				'7 days' => esc_html__('7 Days', 'event_espresso'),
2487
+				'14 days' => esc_html__('14 Days', 'event_espresso'),
2488
+				'30 days' => esc_html__('30 Days', 'event_espresso')
2489
+			)
2490
+		);
2491
+	}
2492
+
2493
+
2494
+	/**
2495
+	 * @return bool
2496
+	 */
2497
+	public function isConsentCheckboxEnabled()
2498
+	{
2499
+		return $this->consent_checkbox_enabled;
2500
+	}
2501
+
2502
+
2503
+	/**
2504
+	 * @param bool $consent_checkbox_enabled
2505
+	 */
2506
+	public function setConsentCheckboxEnabled($consent_checkbox_enabled)
2507
+	{
2508
+		$this->consent_checkbox_enabled = filter_var(
2509
+			$consent_checkbox_enabled,
2510
+			FILTER_VALIDATE_BOOLEAN
2511
+		);
2512
+	}
2513
+
2514
+
2515
+	/**
2516
+	 * @return string
2517
+	 */
2518
+	public function getConsentCheckboxLabelText()
2519
+	{
2520
+		return $this->consent_checkbox_label_text;
2521
+	}
2522
+
2523
+
2524
+	/**
2525
+	 * @param string $consent_checkbox_label_text
2526
+	 */
2527
+	public function setConsentCheckboxLabelText($consent_checkbox_label_text)
2528
+	{
2529
+		$this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
2530
+	}
2531 2531
 }
2532 2532
 
2533 2533
 /**
@@ -2536,154 +2536,154 @@  discard block
 block discarded – undo
2536 2536
 class EE_Admin_Config extends EE_Config_Base
2537 2537
 {
2538 2538
 
2539
-    /**
2540
-     * @var boolean $use_personnel_manager
2541
-     */
2542
-    public $use_personnel_manager;
2543
-
2544
-    /**
2545
-     * @var boolean $use_dashboard_widget
2546
-     */
2547
-    public $use_dashboard_widget;
2548
-
2549
-    /**
2550
-     * @var int $events_in_dashboard
2551
-     */
2552
-    public $events_in_dashboard;
2553
-
2554
-    /**
2555
-     * @var boolean $use_event_timezones
2556
-     */
2557
-    public $use_event_timezones;
2558
-
2559
-    /**
2560
-     * @var boolean $use_full_logging
2561
-     */
2562
-    public $use_full_logging;
2563
-
2564
-    /**
2565
-     * @var string $log_file_name
2566
-     */
2567
-    public $log_file_name;
2568
-
2569
-    /**
2570
-     * @var string $debug_file_name
2571
-     */
2572
-    public $debug_file_name;
2573
-
2574
-    /**
2575
-     * @var boolean $use_remote_logging
2576
-     */
2577
-    public $use_remote_logging;
2578
-
2579
-    /**
2580
-     * @var string $remote_logging_url
2581
-     */
2582
-    public $remote_logging_url;
2583
-
2584
-    /**
2585
-     * @var boolean $show_reg_footer
2586
-     */
2587
-    public $show_reg_footer;
2588
-
2589
-    /**
2590
-     * @var string $affiliate_id
2591
-     */
2592
-    public $affiliate_id;
2593
-
2594
-    /**
2595
-     * help tours on or off (global setting)
2596
-     *
2597
-     * @var boolean
2598
-     */
2599
-    public $help_tour_activation;
2600
-
2601
-    /**
2602
-     * adds extra layer of encoding to session data to prevent serialization errors
2603
-     * but is incompatible with some server configuration errors
2604
-     * if you get "500 internal server errors" during registration, try turning this on
2605
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
2606
-     *
2607
-     * @var boolean $encode_session_data
2608
-     */
2609
-    private $encode_session_data = false;
2610
-
2611
-
2612
-    /**
2613
-     *    class constructor
2614
-     *
2615
-     * @access    public
2616
-     */
2617
-    public function __construct()
2618
-    {
2619
-        // set default general admin settings
2620
-        $this->use_personnel_manager = true;
2621
-        $this->use_dashboard_widget = true;
2622
-        $this->events_in_dashboard = 30;
2623
-        $this->use_event_timezones = false;
2624
-        $this->use_full_logging = false;
2625
-        $this->use_remote_logging = false;
2626
-        $this->remote_logging_url = null;
2627
-        $this->show_reg_footer = true;
2628
-        $this->affiliate_id = 'default';
2629
-        $this->help_tour_activation = true;
2630
-        $this->encode_session_data = false;
2631
-    }
2632
-
2633
-
2634
-    /**
2635
-     * @param bool $reset
2636
-     * @return string
2637
-     */
2638
-    public function log_file_name($reset = false)
2639
-    {
2640
-        if (empty($this->log_file_name) || $reset) {
2641
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
2642
-            EE_Config::instance()->update_espresso_config(false, false);
2643
-        }
2644
-        return $this->log_file_name;
2645
-    }
2646
-
2647
-
2648
-    /**
2649
-     * @param bool $reset
2650
-     * @return string
2651
-     */
2652
-    public function debug_file_name($reset = false)
2653
-    {
2654
-        if (empty($this->debug_file_name) || $reset) {
2655
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
2656
-            EE_Config::instance()->update_espresso_config(false, false);
2657
-        }
2658
-        return $this->debug_file_name;
2659
-    }
2660
-
2661
-
2662
-    /**
2663
-     * @return string
2664
-     */
2665
-    public function affiliate_id()
2666
-    {
2667
-        return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
2668
-    }
2669
-
2670
-
2671
-    /**
2672
-     * @return boolean
2673
-     */
2674
-    public function encode_session_data()
2675
-    {
2676
-        return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
2677
-    }
2678
-
2679
-
2680
-    /**
2681
-     * @param boolean $encode_session_data
2682
-     */
2683
-    public function set_encode_session_data($encode_session_data)
2684
-    {
2685
-        $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
2686
-    }
2539
+	/**
2540
+	 * @var boolean $use_personnel_manager
2541
+	 */
2542
+	public $use_personnel_manager;
2543
+
2544
+	/**
2545
+	 * @var boolean $use_dashboard_widget
2546
+	 */
2547
+	public $use_dashboard_widget;
2548
+
2549
+	/**
2550
+	 * @var int $events_in_dashboard
2551
+	 */
2552
+	public $events_in_dashboard;
2553
+
2554
+	/**
2555
+	 * @var boolean $use_event_timezones
2556
+	 */
2557
+	public $use_event_timezones;
2558
+
2559
+	/**
2560
+	 * @var boolean $use_full_logging
2561
+	 */
2562
+	public $use_full_logging;
2563
+
2564
+	/**
2565
+	 * @var string $log_file_name
2566
+	 */
2567
+	public $log_file_name;
2568
+
2569
+	/**
2570
+	 * @var string $debug_file_name
2571
+	 */
2572
+	public $debug_file_name;
2573
+
2574
+	/**
2575
+	 * @var boolean $use_remote_logging
2576
+	 */
2577
+	public $use_remote_logging;
2578
+
2579
+	/**
2580
+	 * @var string $remote_logging_url
2581
+	 */
2582
+	public $remote_logging_url;
2583
+
2584
+	/**
2585
+	 * @var boolean $show_reg_footer
2586
+	 */
2587
+	public $show_reg_footer;
2588
+
2589
+	/**
2590
+	 * @var string $affiliate_id
2591
+	 */
2592
+	public $affiliate_id;
2593
+
2594
+	/**
2595
+	 * help tours on or off (global setting)
2596
+	 *
2597
+	 * @var boolean
2598
+	 */
2599
+	public $help_tour_activation;
2600
+
2601
+	/**
2602
+	 * adds extra layer of encoding to session data to prevent serialization errors
2603
+	 * but is incompatible with some server configuration errors
2604
+	 * if you get "500 internal server errors" during registration, try turning this on
2605
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
2606
+	 *
2607
+	 * @var boolean $encode_session_data
2608
+	 */
2609
+	private $encode_session_data = false;
2610
+
2611
+
2612
+	/**
2613
+	 *    class constructor
2614
+	 *
2615
+	 * @access    public
2616
+	 */
2617
+	public function __construct()
2618
+	{
2619
+		// set default general admin settings
2620
+		$this->use_personnel_manager = true;
2621
+		$this->use_dashboard_widget = true;
2622
+		$this->events_in_dashboard = 30;
2623
+		$this->use_event_timezones = false;
2624
+		$this->use_full_logging = false;
2625
+		$this->use_remote_logging = false;
2626
+		$this->remote_logging_url = null;
2627
+		$this->show_reg_footer = true;
2628
+		$this->affiliate_id = 'default';
2629
+		$this->help_tour_activation = true;
2630
+		$this->encode_session_data = false;
2631
+	}
2632
+
2633
+
2634
+	/**
2635
+	 * @param bool $reset
2636
+	 * @return string
2637
+	 */
2638
+	public function log_file_name($reset = false)
2639
+	{
2640
+		if (empty($this->log_file_name) || $reset) {
2641
+			$this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
2642
+			EE_Config::instance()->update_espresso_config(false, false);
2643
+		}
2644
+		return $this->log_file_name;
2645
+	}
2646
+
2647
+
2648
+	/**
2649
+	 * @param bool $reset
2650
+	 * @return string
2651
+	 */
2652
+	public function debug_file_name($reset = false)
2653
+	{
2654
+		if (empty($this->debug_file_name) || $reset) {
2655
+			$this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
2656
+			EE_Config::instance()->update_espresso_config(false, false);
2657
+		}
2658
+		return $this->debug_file_name;
2659
+	}
2660
+
2661
+
2662
+	/**
2663
+	 * @return string
2664
+	 */
2665
+	public function affiliate_id()
2666
+	{
2667
+		return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
2668
+	}
2669
+
2670
+
2671
+	/**
2672
+	 * @return boolean
2673
+	 */
2674
+	public function encode_session_data()
2675
+	{
2676
+		return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
2677
+	}
2678
+
2679
+
2680
+	/**
2681
+	 * @param boolean $encode_session_data
2682
+	 */
2683
+	public function set_encode_session_data($encode_session_data)
2684
+	{
2685
+		$this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
2686
+	}
2687 2687
 }
2688 2688
 
2689 2689
 /**
@@ -2692,70 +2692,70 @@  discard block
 block discarded – undo
2692 2692
 class EE_Template_Config extends EE_Config_Base
2693 2693
 {
2694 2694
 
2695
-    /**
2696
-     * @var boolean $enable_default_style
2697
-     */
2698
-    public $enable_default_style;
2699
-
2700
-    /**
2701
-     * @var string $custom_style_sheet
2702
-     */
2703
-    public $custom_style_sheet;
2704
-
2705
-    /**
2706
-     * @var boolean $display_address_in_regform
2707
-     */
2708
-    public $display_address_in_regform;
2709
-
2710
-    /**
2711
-     * @var int $display_description_on_multi_reg_page
2712
-     */
2713
-    public $display_description_on_multi_reg_page;
2714
-
2715
-    /**
2716
-     * @var boolean $use_custom_templates
2717
-     */
2718
-    public $use_custom_templates;
2719
-
2720
-    /**
2721
-     * @var string $current_espresso_theme
2722
-     */
2723
-    public $current_espresso_theme;
2724
-
2725
-    /**
2726
-     * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
2727
-     */
2728
-    public $EED_Ticket_Selector;
2729
-
2730
-    /**
2731
-     * @var EE_Event_Single_Config $EED_Event_Single
2732
-     */
2733
-    public $EED_Event_Single;
2734
-
2735
-    /**
2736
-     * @var EE_Events_Archive_Config $EED_Events_Archive
2737
-     */
2738
-    public $EED_Events_Archive;
2739
-
2740
-
2741
-    /**
2742
-     *    class constructor
2743
-     *
2744
-     * @access    public
2745
-     */
2746
-    public function __construct()
2747
-    {
2748
-        // set default template settings
2749
-        $this->enable_default_style = true;
2750
-        $this->custom_style_sheet = null;
2751
-        $this->display_address_in_regform = true;
2752
-        $this->display_description_on_multi_reg_page = false;
2753
-        $this->use_custom_templates = false;
2754
-        $this->current_espresso_theme = 'Espresso_Arabica_2014';
2755
-        $this->EED_Event_Single = null;
2756
-        $this->EED_Events_Archive = null;
2757
-        $this->EED_Ticket_Selector = null;
2758
-    }
2695
+	/**
2696
+	 * @var boolean $enable_default_style
2697
+	 */
2698
+	public $enable_default_style;
2699
+
2700
+	/**
2701
+	 * @var string $custom_style_sheet
2702
+	 */
2703
+	public $custom_style_sheet;
2704
+
2705
+	/**
2706
+	 * @var boolean $display_address_in_regform
2707
+	 */
2708
+	public $display_address_in_regform;
2709
+
2710
+	/**
2711
+	 * @var int $display_description_on_multi_reg_page
2712
+	 */
2713
+	public $display_description_on_multi_reg_page;
2714
+
2715
+	/**
2716
+	 * @var boolean $use_custom_templates
2717
+	 */
2718
+	public $use_custom_templates;
2719
+
2720
+	/**
2721
+	 * @var string $current_espresso_theme
2722
+	 */
2723
+	public $current_espresso_theme;
2724
+
2725
+	/**
2726
+	 * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
2727
+	 */
2728
+	public $EED_Ticket_Selector;
2729
+
2730
+	/**
2731
+	 * @var EE_Event_Single_Config $EED_Event_Single
2732
+	 */
2733
+	public $EED_Event_Single;
2734
+
2735
+	/**
2736
+	 * @var EE_Events_Archive_Config $EED_Events_Archive
2737
+	 */
2738
+	public $EED_Events_Archive;
2739
+
2740
+
2741
+	/**
2742
+	 *    class constructor
2743
+	 *
2744
+	 * @access    public
2745
+	 */
2746
+	public function __construct()
2747
+	{
2748
+		// set default template settings
2749
+		$this->enable_default_style = true;
2750
+		$this->custom_style_sheet = null;
2751
+		$this->display_address_in_regform = true;
2752
+		$this->display_description_on_multi_reg_page = false;
2753
+		$this->use_custom_templates = false;
2754
+		$this->current_espresso_theme = 'Espresso_Arabica_2014';
2755
+		$this->EED_Event_Single = null;
2756
+		$this->EED_Events_Archive = null;
2757
+		$this->EED_Ticket_Selector = null;
2758
+	}
2759 2759
 }
2760 2760
 
2761 2761
 /**
@@ -2764,114 +2764,114 @@  discard block
 block discarded – undo
2764 2764
 class EE_Map_Config extends EE_Config_Base
2765 2765
 {
2766 2766
 
2767
-    /**
2768
-     * @var boolean $use_google_maps
2769
-     */
2770
-    public $use_google_maps;
2771
-
2772
-    /**
2773
-     * @var string $api_key
2774
-     */
2775
-    public $google_map_api_key;
2776
-
2777
-    /**
2778
-     * @var int $event_details_map_width
2779
-     */
2780
-    public $event_details_map_width;
2781
-
2782
-    /**
2783
-     * @var int $event_details_map_height
2784
-     */
2785
-    public $event_details_map_height;
2786
-
2787
-    /**
2788
-     * @var int $event_details_map_zoom
2789
-     */
2790
-    public $event_details_map_zoom;
2791
-
2792
-    /**
2793
-     * @var boolean $event_details_display_nav
2794
-     */
2795
-    public $event_details_display_nav;
2796
-
2797
-    /**
2798
-     * @var boolean $event_details_nav_size
2799
-     */
2800
-    public $event_details_nav_size;
2801
-
2802
-    /**
2803
-     * @var string $event_details_control_type
2804
-     */
2805
-    public $event_details_control_type;
2806
-
2807
-    /**
2808
-     * @var string $event_details_map_align
2809
-     */
2810
-    public $event_details_map_align;
2811
-
2812
-    /**
2813
-     * @var int $event_list_map_width
2814
-     */
2815
-    public $event_list_map_width;
2816
-
2817
-    /**
2818
-     * @var int $event_list_map_height
2819
-     */
2820
-    public $event_list_map_height;
2821
-
2822
-    /**
2823
-     * @var int $event_list_map_zoom
2824
-     */
2825
-    public $event_list_map_zoom;
2826
-
2827
-    /**
2828
-     * @var boolean $event_list_display_nav
2829
-     */
2830
-    public $event_list_display_nav;
2831
-
2832
-    /**
2833
-     * @var boolean $event_list_nav_size
2834
-     */
2835
-    public $event_list_nav_size;
2836
-
2837
-    /**
2838
-     * @var string $event_list_control_type
2839
-     */
2840
-    public $event_list_control_type;
2841
-
2842
-    /**
2843
-     * @var string $event_list_map_align
2844
-     */
2845
-    public $event_list_map_align;
2846
-
2847
-
2848
-    /**
2849
-     *    class constructor
2850
-     *
2851
-     * @access    public
2852
-     */
2853
-    public function __construct()
2854
-    {
2855
-        // set default map settings
2856
-        $this->use_google_maps = true;
2857
-        $this->google_map_api_key = '';
2858
-        // for event details pages (reg page)
2859
-        $this->event_details_map_width = 585;            // ee_map_width_single
2860
-        $this->event_details_map_height = 362;            // ee_map_height_single
2861
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
2862
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
2863
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
2864
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
2865
-        $this->event_details_map_align = 'center';            // ee_map_align_single
2866
-        // for event list pages
2867
-        $this->event_list_map_width = 300;            // ee_map_width
2868
-        $this->event_list_map_height = 185;        // ee_map_height
2869
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
2870
-        $this->event_list_display_nav = false;        // ee_map_nav_display
2871
-        $this->event_list_nav_size = true;            // ee_map_nav_size
2872
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
2873
-        $this->event_list_map_align = 'center';            // ee_map_align
2874
-    }
2767
+	/**
2768
+	 * @var boolean $use_google_maps
2769
+	 */
2770
+	public $use_google_maps;
2771
+
2772
+	/**
2773
+	 * @var string $api_key
2774
+	 */
2775
+	public $google_map_api_key;
2776
+
2777
+	/**
2778
+	 * @var int $event_details_map_width
2779
+	 */
2780
+	public $event_details_map_width;
2781
+
2782
+	/**
2783
+	 * @var int $event_details_map_height
2784
+	 */
2785
+	public $event_details_map_height;
2786
+
2787
+	/**
2788
+	 * @var int $event_details_map_zoom
2789
+	 */
2790
+	public $event_details_map_zoom;
2791
+
2792
+	/**
2793
+	 * @var boolean $event_details_display_nav
2794
+	 */
2795
+	public $event_details_display_nav;
2796
+
2797
+	/**
2798
+	 * @var boolean $event_details_nav_size
2799
+	 */
2800
+	public $event_details_nav_size;
2801
+
2802
+	/**
2803
+	 * @var string $event_details_control_type
2804
+	 */
2805
+	public $event_details_control_type;
2806
+
2807
+	/**
2808
+	 * @var string $event_details_map_align
2809
+	 */
2810
+	public $event_details_map_align;
2811
+
2812
+	/**
2813
+	 * @var int $event_list_map_width
2814
+	 */
2815
+	public $event_list_map_width;
2816
+
2817
+	/**
2818
+	 * @var int $event_list_map_height
2819
+	 */
2820
+	public $event_list_map_height;
2821
+
2822
+	/**
2823
+	 * @var int $event_list_map_zoom
2824
+	 */
2825
+	public $event_list_map_zoom;
2826
+
2827
+	/**
2828
+	 * @var boolean $event_list_display_nav
2829
+	 */
2830
+	public $event_list_display_nav;
2831
+
2832
+	/**
2833
+	 * @var boolean $event_list_nav_size
2834
+	 */
2835
+	public $event_list_nav_size;
2836
+
2837
+	/**
2838
+	 * @var string $event_list_control_type
2839
+	 */
2840
+	public $event_list_control_type;
2841
+
2842
+	/**
2843
+	 * @var string $event_list_map_align
2844
+	 */
2845
+	public $event_list_map_align;
2846
+
2847
+
2848
+	/**
2849
+	 *    class constructor
2850
+	 *
2851
+	 * @access    public
2852
+	 */
2853
+	public function __construct()
2854
+	{
2855
+		// set default map settings
2856
+		$this->use_google_maps = true;
2857
+		$this->google_map_api_key = '';
2858
+		// for event details pages (reg page)
2859
+		$this->event_details_map_width = 585;            // ee_map_width_single
2860
+		$this->event_details_map_height = 362;            // ee_map_height_single
2861
+		$this->event_details_map_zoom = 14;            // ee_map_zoom_single
2862
+		$this->event_details_display_nav = true;            // ee_map_nav_display_single
2863
+		$this->event_details_nav_size = false;            // ee_map_nav_size_single
2864
+		$this->event_details_control_type = 'default';        // ee_map_type_control_single
2865
+		$this->event_details_map_align = 'center';            // ee_map_align_single
2866
+		// for event list pages
2867
+		$this->event_list_map_width = 300;            // ee_map_width
2868
+		$this->event_list_map_height = 185;        // ee_map_height
2869
+		$this->event_list_map_zoom = 12;            // ee_map_zoom
2870
+		$this->event_list_display_nav = false;        // ee_map_nav_display
2871
+		$this->event_list_nav_size = true;            // ee_map_nav_size
2872
+		$this->event_list_control_type = 'dropdown';        // ee_map_type_control
2873
+		$this->event_list_map_align = 'center';            // ee_map_align
2874
+	}
2875 2875
 }
2876 2876
 
2877 2877
 /**
@@ -2880,46 +2880,46 @@  discard block
 block discarded – undo
2880 2880
 class EE_Events_Archive_Config extends EE_Config_Base
2881 2881
 {
2882 2882
 
2883
-    public $display_status_banner;
2883
+	public $display_status_banner;
2884 2884
 
2885
-    public $display_description;
2885
+	public $display_description;
2886 2886
 
2887
-    public $display_ticket_selector;
2887
+	public $display_ticket_selector;
2888 2888
 
2889
-    public $display_datetimes;
2889
+	public $display_datetimes;
2890 2890
 
2891
-    public $display_venue;
2891
+	public $display_venue;
2892 2892
 
2893
-    public $display_expired_events;
2893
+	public $display_expired_events;
2894 2894
 
2895
-    public $use_sortable_display_order;
2895
+	public $use_sortable_display_order;
2896 2896
 
2897
-    public $display_order_tickets;
2897
+	public $display_order_tickets;
2898 2898
 
2899
-    public $display_order_datetimes;
2899
+	public $display_order_datetimes;
2900 2900
 
2901
-    public $display_order_event;
2901
+	public $display_order_event;
2902 2902
 
2903
-    public $display_order_venue;
2903
+	public $display_order_venue;
2904 2904
 
2905 2905
 
2906
-    /**
2907
-     *    class constructor
2908
-     */
2909
-    public function __construct()
2910
-    {
2911
-        $this->display_status_banner = 0;
2912
-        $this->display_description = 1;
2913
-        $this->display_ticket_selector = 0;
2914
-        $this->display_datetimes = 1;
2915
-        $this->display_venue = 0;
2916
-        $this->display_expired_events = 0;
2917
-        $this->use_sortable_display_order = false;
2918
-        $this->display_order_tickets = 100;
2919
-        $this->display_order_datetimes = 110;
2920
-        $this->display_order_event = 120;
2921
-        $this->display_order_venue = 130;
2922
-    }
2906
+	/**
2907
+	 *    class constructor
2908
+	 */
2909
+	public function __construct()
2910
+	{
2911
+		$this->display_status_banner = 0;
2912
+		$this->display_description = 1;
2913
+		$this->display_ticket_selector = 0;
2914
+		$this->display_datetimes = 1;
2915
+		$this->display_venue = 0;
2916
+		$this->display_expired_events = 0;
2917
+		$this->use_sortable_display_order = false;
2918
+		$this->display_order_tickets = 100;
2919
+		$this->display_order_datetimes = 110;
2920
+		$this->display_order_event = 120;
2921
+		$this->display_order_venue = 130;
2922
+	}
2923 2923
 }
2924 2924
 
2925 2925
 /**
@@ -2928,34 +2928,34 @@  discard block
 block discarded – undo
2928 2928
 class EE_Event_Single_Config extends EE_Config_Base
2929 2929
 {
2930 2930
 
2931
-    public $display_status_banner_single;
2931
+	public $display_status_banner_single;
2932 2932
 
2933
-    public $display_venue;
2933
+	public $display_venue;
2934 2934
 
2935
-    public $use_sortable_display_order;
2935
+	public $use_sortable_display_order;
2936 2936
 
2937
-    public $display_order_tickets;
2937
+	public $display_order_tickets;
2938 2938
 
2939
-    public $display_order_datetimes;
2939
+	public $display_order_datetimes;
2940 2940
 
2941
-    public $display_order_event;
2941
+	public $display_order_event;
2942 2942
 
2943
-    public $display_order_venue;
2943
+	public $display_order_venue;
2944 2944
 
2945 2945
 
2946
-    /**
2947
-     *    class constructor
2948
-     */
2949
-    public function __construct()
2950
-    {
2951
-        $this->display_status_banner_single = 0;
2952
-        $this->display_venue = 1;
2953
-        $this->use_sortable_display_order = false;
2954
-        $this->display_order_tickets = 100;
2955
-        $this->display_order_datetimes = 110;
2956
-        $this->display_order_event = 120;
2957
-        $this->display_order_venue = 130;
2958
-    }
2946
+	/**
2947
+	 *    class constructor
2948
+	 */
2949
+	public function __construct()
2950
+	{
2951
+		$this->display_status_banner_single = 0;
2952
+		$this->display_venue = 1;
2953
+		$this->use_sortable_display_order = false;
2954
+		$this->display_order_tickets = 100;
2955
+		$this->display_order_datetimes = 110;
2956
+		$this->display_order_event = 120;
2957
+		$this->display_order_venue = 130;
2958
+	}
2959 2959
 }
2960 2960
 
2961 2961
 /**
@@ -2964,146 +2964,146 @@  discard block
 block discarded – undo
2964 2964
 class EE_Ticket_Selector_Config extends EE_Config_Base
2965 2965
 {
2966 2966
 
2967
-    /**
2968
-     * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
2969
-     */
2970
-    const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
2971
-
2972
-    /**
2973
-     * constant to indicate that a datetime selector should only be shown for ticket selectors
2974
-     * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
2975
-     */
2976
-    const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
2977
-
2978
-    /**
2979
-     * @var boolean $show_ticket_sale_columns
2980
-     */
2981
-    public $show_ticket_sale_columns;
2982
-
2983
-    /**
2984
-     * @var boolean $show_ticket_details
2985
-     */
2986
-    public $show_ticket_details;
2987
-
2988
-    /**
2989
-     * @var boolean $show_expired_tickets
2990
-     */
2991
-    public $show_expired_tickets;
2992
-
2993
-    /**
2994
-     * whether or not to display a dropdown box populated with event datetimes
2995
-     * that toggles which tickets are displayed for a ticket selector.
2996
-     * uses one of the *_DATETIME_SELECTOR constants defined above
2997
-     *
2998
-     * @var string $show_datetime_selector
2999
-     */
3000
-    private $show_datetime_selector = 'no_datetime_selector';
3001
-
3002
-    /**
3003
-     * the number of datetimes an event has to have before conditionally displaying a datetime selector
3004
-     *
3005
-     * @var int $datetime_selector_threshold
3006
-     */
3007
-    private $datetime_selector_threshold = 3;
3008
-
3009
-
3010
-    /**
3011
-     *    class constructor
3012
-     */
3013
-    public function __construct()
3014
-    {
3015
-        $this->show_ticket_sale_columns = true;
3016
-        $this->show_ticket_details = true;
3017
-        $this->show_expired_tickets = true;
3018
-        $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
3019
-        $this->datetime_selector_threshold = 3;
3020
-    }
3021
-
3022
-
3023
-    /**
3024
-     * returns true if a datetime selector should be displayed
3025
-     *
3026
-     * @param array $datetimes
3027
-     * @return bool
3028
-     */
3029
-    public function showDatetimeSelector(array $datetimes)
3030
-    {
3031
-        // if the settings are NOT: don't show OR below threshold, THEN active = true
3032
-        return ! (
3033
-            $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
3034
-            || (
3035
-                $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
3036
-                && count($datetimes) < $this->getDatetimeSelectorThreshold()
3037
-            )
3038
-        );
3039
-    }
3040
-
3041
-
3042
-    /**
3043
-     * @return string
3044
-     */
3045
-    public function getShowDatetimeSelector()
3046
-    {
3047
-        return $this->show_datetime_selector;
3048
-    }
3049
-
3050
-
3051
-    /**
3052
-     * @param bool $keys_only
3053
-     * @return array
3054
-     */
3055
-    public function getShowDatetimeSelectorOptions($keys_only = true)
3056
-    {
3057
-        return $keys_only
3058
-            ? array(
3059
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
3060
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
3061
-            )
3062
-            : array(
3063
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
3064
-                    'Do not show date & time filter',
3065
-                    'event_espresso'
3066
-                ),
3067
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
3068
-                    'Maybe show date & time filter',
3069
-                    'event_espresso'
3070
-                ),
3071
-            );
3072
-    }
3073
-
3074
-
3075
-    /**
3076
-     * @param string $show_datetime_selector
3077
-     */
3078
-    public function setShowDatetimeSelector($show_datetime_selector)
3079
-    {
3080
-        $this->show_datetime_selector = in_array(
3081
-            $show_datetime_selector,
3082
-            $this->getShowDatetimeSelectorOptions(),
3083
-            true
3084
-        )
3085
-            ? $show_datetime_selector
3086
-            : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
3087
-    }
3088
-
3089
-
3090
-    /**
3091
-     * @return int
3092
-     */
3093
-    public function getDatetimeSelectorThreshold()
3094
-    {
3095
-        return $this->datetime_selector_threshold;
3096
-    }
3097
-
3098
-
3099
-    /**
3100
-     * @param int $datetime_selector_threshold
3101
-     */
3102
-    public function setDatetimeSelectorThreshold($datetime_selector_threshold)
3103
-    {
3104
-        $datetime_selector_threshold = absint($datetime_selector_threshold);
3105
-        $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
3106
-    }
2967
+	/**
2968
+	 * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
2969
+	 */
2970
+	const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
2971
+
2972
+	/**
2973
+	 * constant to indicate that a datetime selector should only be shown for ticket selectors
2974
+	 * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
2975
+	 */
2976
+	const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
2977
+
2978
+	/**
2979
+	 * @var boolean $show_ticket_sale_columns
2980
+	 */
2981
+	public $show_ticket_sale_columns;
2982
+
2983
+	/**
2984
+	 * @var boolean $show_ticket_details
2985
+	 */
2986
+	public $show_ticket_details;
2987
+
2988
+	/**
2989
+	 * @var boolean $show_expired_tickets
2990
+	 */
2991
+	public $show_expired_tickets;
2992
+
2993
+	/**
2994
+	 * whether or not to display a dropdown box populated with event datetimes
2995
+	 * that toggles which tickets are displayed for a ticket selector.
2996
+	 * uses one of the *_DATETIME_SELECTOR constants defined above
2997
+	 *
2998
+	 * @var string $show_datetime_selector
2999
+	 */
3000
+	private $show_datetime_selector = 'no_datetime_selector';
3001
+
3002
+	/**
3003
+	 * the number of datetimes an event has to have before conditionally displaying a datetime selector
3004
+	 *
3005
+	 * @var int $datetime_selector_threshold
3006
+	 */
3007
+	private $datetime_selector_threshold = 3;
3008
+
3009
+
3010
+	/**
3011
+	 *    class constructor
3012
+	 */
3013
+	public function __construct()
3014
+	{
3015
+		$this->show_ticket_sale_columns = true;
3016
+		$this->show_ticket_details = true;
3017
+		$this->show_expired_tickets = true;
3018
+		$this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
3019
+		$this->datetime_selector_threshold = 3;
3020
+	}
3021
+
3022
+
3023
+	/**
3024
+	 * returns true if a datetime selector should be displayed
3025
+	 *
3026
+	 * @param array $datetimes
3027
+	 * @return bool
3028
+	 */
3029
+	public function showDatetimeSelector(array $datetimes)
3030
+	{
3031
+		// if the settings are NOT: don't show OR below threshold, THEN active = true
3032
+		return ! (
3033
+			$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
3034
+			|| (
3035
+				$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
3036
+				&& count($datetimes) < $this->getDatetimeSelectorThreshold()
3037
+			)
3038
+		);
3039
+	}
3040
+
3041
+
3042
+	/**
3043
+	 * @return string
3044
+	 */
3045
+	public function getShowDatetimeSelector()
3046
+	{
3047
+		return $this->show_datetime_selector;
3048
+	}
3049
+
3050
+
3051
+	/**
3052
+	 * @param bool $keys_only
3053
+	 * @return array
3054
+	 */
3055
+	public function getShowDatetimeSelectorOptions($keys_only = true)
3056
+	{
3057
+		return $keys_only
3058
+			? array(
3059
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
3060
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
3061
+			)
3062
+			: array(
3063
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
3064
+					'Do not show date & time filter',
3065
+					'event_espresso'
3066
+				),
3067
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
3068
+					'Maybe show date & time filter',
3069
+					'event_espresso'
3070
+				),
3071
+			);
3072
+	}
3073
+
3074
+
3075
+	/**
3076
+	 * @param string $show_datetime_selector
3077
+	 */
3078
+	public function setShowDatetimeSelector($show_datetime_selector)
3079
+	{
3080
+		$this->show_datetime_selector = in_array(
3081
+			$show_datetime_selector,
3082
+			$this->getShowDatetimeSelectorOptions(),
3083
+			true
3084
+		)
3085
+			? $show_datetime_selector
3086
+			: \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
3087
+	}
3088
+
3089
+
3090
+	/**
3091
+	 * @return int
3092
+	 */
3093
+	public function getDatetimeSelectorThreshold()
3094
+	{
3095
+		return $this->datetime_selector_threshold;
3096
+	}
3097
+
3098
+
3099
+	/**
3100
+	 * @param int $datetime_selector_threshold
3101
+	 */
3102
+	public function setDatetimeSelectorThreshold($datetime_selector_threshold)
3103
+	{
3104
+		$datetime_selector_threshold = absint($datetime_selector_threshold);
3105
+		$this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
3106
+	}
3107 3107
 }
3108 3108
 
3109 3109
 /**
@@ -3116,81 +3116,81 @@  discard block
 block discarded – undo
3116 3116
 class EE_Environment_Config extends EE_Config_Base
3117 3117
 {
3118 3118
 
3119
-    /**
3120
-     * Hold any php environment variables that we want to track.
3121
-     *
3122
-     * @var stdClass;
3123
-     */
3124
-    public $php;
3125
-
3126
-
3127
-    /**
3128
-     *    constructor
3129
-     */
3130
-    public function __construct()
3131
-    {
3132
-        $this->php = new stdClass();
3133
-        $this->_set_php_values();
3134
-    }
3135
-
3136
-
3137
-    /**
3138
-     * This sets the php environment variables.
3139
-     *
3140
-     * @since 4.4.0
3141
-     * @return void
3142
-     */
3143
-    protected function _set_php_values()
3144
-    {
3145
-        $this->php->max_input_vars = ini_get('max_input_vars');
3146
-        $this->php->version = phpversion();
3147
-    }
3148
-
3149
-
3150
-    /**
3151
-     * helper method for determining whether input_count is
3152
-     * reaching the potential maximum the server can handle
3153
-     * according to max_input_vars
3154
-     *
3155
-     * @param int   $input_count the count of input vars.
3156
-     * @return array {
3157
-     *                           An array that represents whether available space and if no available space the error
3158
-     *                           message.
3159
-     * @type bool   $has_space   whether more inputs can be added.
3160
-     * @type string $msg         Any message to be displayed.
3161
-     *                           }
3162
-     */
3163
-    public function max_input_vars_limit_check($input_count = 0)
3164
-    {
3165
-        if (! empty($this->php->max_input_vars)
3166
-            && ($input_count >= $this->php->max_input_vars)
3167
-            && (PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9)
3168
-        ) {
3169
-            return sprintf(
3170
-                __(
3171
-                    'The maximum number of inputs on this page has been exceeded.  You cannot add anymore items (i.e. tickets, datetimes, custom fields) on this page because of your servers PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.',
3172
-                    'event_espresso'
3173
-                ),
3174
-                '<br>',
3175
-                $input_count,
3176
-                $this->php->max_input_vars
3177
-            );
3178
-        } else {
3179
-            return '';
3180
-        }
3181
-    }
3182
-
3183
-
3184
-    /**
3185
-     * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
3186
-     *
3187
-     * @since 4.4.1
3188
-     * @return void
3189
-     */
3190
-    public function recheck_values()
3191
-    {
3192
-        $this->_set_php_values();
3193
-    }
3119
+	/**
3120
+	 * Hold any php environment variables that we want to track.
3121
+	 *
3122
+	 * @var stdClass;
3123
+	 */
3124
+	public $php;
3125
+
3126
+
3127
+	/**
3128
+	 *    constructor
3129
+	 */
3130
+	public function __construct()
3131
+	{
3132
+		$this->php = new stdClass();
3133
+		$this->_set_php_values();
3134
+	}
3135
+
3136
+
3137
+	/**
3138
+	 * This sets the php environment variables.
3139
+	 *
3140
+	 * @since 4.4.0
3141
+	 * @return void
3142
+	 */
3143
+	protected function _set_php_values()
3144
+	{
3145
+		$this->php->max_input_vars = ini_get('max_input_vars');
3146
+		$this->php->version = phpversion();
3147
+	}
3148
+
3149
+
3150
+	/**
3151
+	 * helper method for determining whether input_count is
3152
+	 * reaching the potential maximum the server can handle
3153
+	 * according to max_input_vars
3154
+	 *
3155
+	 * @param int   $input_count the count of input vars.
3156
+	 * @return array {
3157
+	 *                           An array that represents whether available space and if no available space the error
3158
+	 *                           message.
3159
+	 * @type bool   $has_space   whether more inputs can be added.
3160
+	 * @type string $msg         Any message to be displayed.
3161
+	 *                           }
3162
+	 */
3163
+	public function max_input_vars_limit_check($input_count = 0)
3164
+	{
3165
+		if (! empty($this->php->max_input_vars)
3166
+			&& ($input_count >= $this->php->max_input_vars)
3167
+			&& (PHP_MAJOR_VERSION >= 5 && PHP_MINOR_VERSION >= 3 && PHP_RELEASE_VERSION >= 9)
3168
+		) {
3169
+			return sprintf(
3170
+				__(
3171
+					'The maximum number of inputs on this page has been exceeded.  You cannot add anymore items (i.e. tickets, datetimes, custom fields) on this page because of your servers PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.',
3172
+					'event_espresso'
3173
+				),
3174
+				'<br>',
3175
+				$input_count,
3176
+				$this->php->max_input_vars
3177
+			);
3178
+		} else {
3179
+			return '';
3180
+		}
3181
+	}
3182
+
3183
+
3184
+	/**
3185
+	 * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
3186
+	 *
3187
+	 * @since 4.4.1
3188
+	 * @return void
3189
+	 */
3190
+	public function recheck_values()
3191
+	{
3192
+		$this->_set_php_values();
3193
+	}
3194 3194
 }
3195 3195
 
3196 3196
 /**
@@ -3203,21 +3203,21 @@  discard block
 block discarded – undo
3203 3203
 class EE_Tax_Config extends EE_Config_Base
3204 3204
 {
3205 3205
 
3206
-    /*
3206
+	/*
3207 3207
      * flag to indicate whether or not to display ticket prices with the taxes included
3208 3208
      *
3209 3209
      * @var boolean $prices_displayed_including_taxes
3210 3210
      */
3211
-    public $prices_displayed_including_taxes;
3211
+	public $prices_displayed_including_taxes;
3212 3212
 
3213 3213
 
3214
-    /**
3215
-     *    class constructor
3216
-     */
3217
-    public function __construct()
3218
-    {
3219
-        $this->prices_displayed_including_taxes = true;
3220
-    }
3214
+	/**
3215
+	 *    class constructor
3216
+	 */
3217
+	public function __construct()
3218
+	{
3219
+		$this->prices_displayed_including_taxes = true;
3220
+	}
3221 3221
 }
3222 3222
 
3223 3223
 /**
@@ -3231,19 +3231,19 @@  discard block
 block discarded – undo
3231 3231
 class EE_Messages_Config extends EE_Config_Base
3232 3232
 {
3233 3233
 
3234
-    /**
3235
-     * This is an integer representing the deletion threshold in months for when old messages will get deleted.
3236
-     * A value of 0 represents never deleting.  Default is 0.
3237
-     *
3238
-     * @var integer
3239
-     */
3240
-    public $delete_threshold;
3234
+	/**
3235
+	 * This is an integer representing the deletion threshold in months for when old messages will get deleted.
3236
+	 * A value of 0 represents never deleting.  Default is 0.
3237
+	 *
3238
+	 * @var integer
3239
+	 */
3240
+	public $delete_threshold;
3241 3241
 
3242 3242
 
3243
-    public function __construct()
3244
-    {
3245
-        $this->delete_threshold = 0;
3246
-    }
3243
+	public function __construct()
3244
+	{
3245
+		$this->delete_threshold = 0;
3246
+	}
3247 3247
 }
3248 3248
 
3249 3249
 /**
@@ -3254,31 +3254,31 @@  discard block
 block discarded – undo
3254 3254
 class EE_Gateway_Config extends EE_Config_Base
3255 3255
 {
3256 3256
 
3257
-    /**
3258
-     * Array with keys that are payment gateways slugs, and values are arrays
3259
-     * with any config info the gateway wants to store
3260
-     *
3261
-     * @var array
3262
-     */
3263
-    public $payment_settings;
3264
-
3265
-    /**
3266
-     * Where keys are gateway slugs, and values are booleans indicating whether or not
3267
-     * the gateway is stored in the uploads directory
3268
-     *
3269
-     * @var array
3270
-     */
3271
-    public $active_gateways;
3272
-
3273
-
3274
-    /**
3275
-     *    class constructor
3276
-     *
3277
-     * @deprecated
3278
-     */
3279
-    public function __construct()
3280
-    {
3281
-        $this->payment_settings = array();
3282
-        $this->active_gateways = array('Invoice' => false);
3283
-    }
3257
+	/**
3258
+	 * Array with keys that are payment gateways slugs, and values are arrays
3259
+	 * with any config info the gateway wants to store
3260
+	 *
3261
+	 * @var array
3262
+	 */
3263
+	public $payment_settings;
3264
+
3265
+	/**
3266
+	 * Where keys are gateway slugs, and values are booleans indicating whether or not
3267
+	 * the gateway is stored in the uploads directory
3268
+	 *
3269
+	 * @var array
3270
+	 */
3271
+	public $active_gateways;
3272
+
3273
+
3274
+	/**
3275
+	 *    class constructor
3276
+	 *
3277
+	 * @deprecated
3278
+	 */
3279
+	public function __construct()
3280
+	{
3281
+		$this->payment_settings = array();
3282
+		$this->active_gateways = array('Invoice' => false);
3283
+	}
3284 3284
 }
Please login to merge, or discard this patch.