Completed
Branch TASK-10784-decaf-about-page (1c0227)
by
unknown
107:05 queued 94:37
created
core/libraries/messages/EE_Messages_Generator.lib.php 3 patches
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -443,7 +443,7 @@  discard block
 block discarded – undo
443 443
      * there's a single shared message template group among all the events.  Otherwise it returns null.
444 444
      *
445 445
      * @param array $event_ids
446
-     * @return EE_Message_Template_Group|null
446
+     * @return null|EE_Base_Class
447 447
      * @throws EE_Error
448 448
      */
449 449
     protected function _get_shared_message_template_for_events(array $event_ids)
@@ -476,7 +476,7 @@  discard block
 block discarded – undo
476 476
     /**
477 477
      * Retrieves the global message template group for the current messenger and message type.
478 478
      *
479
-     * @return EE_Message_Template_Group|null
479
+     * @return null|EE_Base_Class
480 480
      * @throws EE_Error
481 481
      */
482 482
     protected function _get_global_message_template_group_for_current_messenger_and_message_type()
@@ -617,7 +617,7 @@  discard block
 block discarded – undo
617 617
      * @param EE_Messages_Addressee     $recipient
618 618
      * @param array                     $templates formatted array of templates used for parsing data.
619 619
      * @param EE_Message_Template_Group $message_template_group
620
-     * @return bool|EE_Message
620
+     * @return EE_Message
621 621
      * @throws EE_Error
622 622
      */
623 623
     protected function _setup_message_object(
Please login to merge, or discard this patch.
Indentation   +931 added lines, -931 removed lines patch added patch discarded remove patch
@@ -13,935 +13,935 @@
 block discarded – undo
13 13
 {
14 14
 
15 15
 
16
-    /**
17
-     * @type EE_Messages_Data_Handler_Collection
18
-     */
19
-    protected $_data_handler_collection;
20
-
21
-    /**
22
-     * @type  EE_Message_Template_Group_Collection
23
-     */
24
-    protected $_template_collection;
25
-
26
-    /**
27
-     * This will hold the data handler for the current EE_Message being generated.
28
-     *
29
-     * @type EE_Messages_incoming_data
30
-     */
31
-    protected $_current_data_handler;
32
-
33
-    /**
34
-     * This holds the EE_Messages_Queue that contains the messages to generate.
35
-     *
36
-     * @type EE_Messages_Queue
37
-     */
38
-    protected $_generation_queue;
39
-
40
-    /**
41
-     * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
42
-     *
43
-     * @type EE_Messages_Queue
44
-     */
45
-    protected $_ready_queue;
46
-
47
-    /**
48
-     * This is a container for any error messages that get created through the generation
49
-     * process.
50
-     *
51
-     * @type array
52
-     */
53
-    protected $_error_msg = array();
54
-
55
-    /**
56
-     * Flag used to set when the current EE_Message in the generation queue has been verified.
57
-     *
58
-     * @type bool
59
-     */
60
-    protected $_verified = false;
61
-
62
-    /**
63
-     * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
64
-     *
65
-     * @type EE_messenger
66
-     */
67
-    protected $_current_messenger;
68
-
69
-    /**
70
-     * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
71
-     *
72
-     * @type EE_message_type
73
-     */
74
-    protected $_current_message_type;
75
-
76
-    /**
77
-     * @type EEH_Parse_Shortcodes
78
-     */
79
-    protected $_shortcode_parser;
80
-
81
-
82
-    /**
83
-     * @param EE_Messages_Queue                     $generation_queue
84
-     * @param \EE_Messages_Queue                    $ready_queue
85
-     * @param \EE_Messages_Data_Handler_Collection  $data_handler_collection
86
-     * @param \EE_Message_Template_Group_Collection $template_collection
87
-     * @param \EEH_Parse_Shortcodes                 $shortcode_parser
88
-     */
89
-    public function __construct(
90
-        EE_Messages_Queue $generation_queue,
91
-        EE_Messages_Queue $ready_queue,
92
-        EE_Messages_Data_Handler_Collection $data_handler_collection,
93
-        EE_Message_Template_Group_Collection $template_collection,
94
-        EEH_Parse_Shortcodes $shortcode_parser
95
-    ) {
96
-        $this->_generation_queue        = $generation_queue;
97
-        $this->_ready_queue             = $ready_queue;
98
-        $this->_data_handler_collection = $data_handler_collection;
99
-        $this->_template_collection     = $template_collection;
100
-        $this->_shortcode_parser        = $shortcode_parser;
101
-    }
102
-
103
-
104
-    /**
105
-     * @return EE_Messages_Queue
106
-     */
107
-    public function generation_queue()
108
-    {
109
-        return $this->_generation_queue;
110
-    }
111
-
112
-
113
-    /**
114
-     *  This iterates through the provided queue and generates the EE_Message objects.
115
-     *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
116
-     *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
117
-     *  for the caller to decide what to do with it.
118
-     *
119
-     * @param   bool $save Whether to save the EE_Message objects in the new queue or just return.
120
-     * @return EE_Messages_Queue  The new queue for holding generated EE_Message objects.
121
-     */
122
-    public function generate($save = true)
123
-    {
124
-        //iterate through the messages in the queue, generate, and add to new queue.
125
-        $this->_generation_queue->get_message_repository()->rewind();
126
-        while ($this->_generation_queue->get_message_repository()->valid()) {
127
-            //reset "current" properties
128
-            $this->_reset_current_properties();
129
-
130
-            /** @type EE_Message $msg */
131
-            $msg = $this->_generation_queue->get_message_repository()->current();
132
-
133
-            /**
134
-             * need to get the next object and capture it for setting manually after deletes.  The reason is that when
135
-             * an object is removed from the repo then valid for the next object will fail.
136
-             */
137
-            $this->_generation_queue->get_message_repository()->next();
138
-            $next_msg = $this->_generation_queue->get_message_repository()->current();
139
-            //restore pointer to current item
140
-            $this->_generation_queue->get_message_repository()->set_current($msg);
141
-
142
-            //skip and delete if the current $msg is NOT incomplete (queued for generation)
143
-            if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
144
-                //we keep this item in the db just remove from the repo.
145
-                $this->_generation_queue->get_message_repository()->remove($msg);
146
-                //next item
147
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
148
-                continue;
149
-            }
150
-
151
-            if ($this->_verify()) {
152
-                //let's get generating!
153
-                $this->_generate();
154
-            }
155
-
156
-            //don't persist debug_only messages if the messages system is not in debug mode.
157
-            if ($msg->STS_ID() === EEM_Message::status_debug_only
158
-                && ! EEM_Message::debug()
159
-            ) {
160
-                do_action(
161
-                    'AHEE__EE_Messages_Generator__generate__before_debug_delete',
162
-                    $msg,
163
-                    $this->_error_msg,
164
-                    $this->_current_messenger,
165
-                    $this->_current_message_type,
166
-                    $this->_current_data_handler
167
-                );
168
-                $this->_generation_queue->get_message_repository()->delete();
169
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
170
-                continue;
171
-            }
172
-
173
-            //if there are error messages then let's set the status and the error message.
174
-            if ($this->_error_msg) {
175
-                //if the status is already debug only, then let's leave it at that.
176
-                if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
177
-                    $msg->set_STS_ID(EEM_Message::status_failed);
178
-                }
179
-                do_action(
180
-                    'AHEE__EE_Messages_Generator__generate__processing_failed_message',
181
-                    $msg,
182
-                    $this->_error_msg,
183
-                    $this->_current_messenger,
184
-                    $this->_current_message_type,
185
-                    $this->_current_data_handler
186
-                );
187
-                $msg->set_error_message(
188
-                    esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
189
-                    . "\n"
190
-                    . implode("\n", $this->_error_msg)
191
-                );
192
-                $msg->set_modified(time());
193
-            } else {
194
-                do_action(
195
-                    'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
196
-                    $msg,
197
-                    $this->_error_msg,
198
-                    $this->_current_messenger,
199
-                    $this->_current_message_type,
200
-                    $this->_current_data_handler
201
-                );
202
-                //remove from db
203
-                $this->_generation_queue->get_message_repository()->delete();
204
-            }
205
-            //next item
206
-            $this->_generation_queue->get_message_repository()->set_current($next_msg);
207
-        }
208
-
209
-        //generation queue is ALWAYS saved to record any errors in the generation process.
210
-        $this->_generation_queue->save();
211
-
212
-        /**
213
-         * save _ready_queue if flag set.
214
-         * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
215
-         * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
216
-         * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
217
-         * irrelevant.
218
-         */
219
-        if ($save) {
220
-            $this->_ready_queue->save();
221
-        }
222
-
223
-        //final reset of properties
224
-        $this->_reset_current_properties();
225
-
226
-        return $this->_ready_queue;
227
-    }
228
-
229
-
230
-    /**
231
-     * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
232
-     * in the generation queue.
233
-     */
234
-    protected function _reset_current_properties()
235
-    {
236
-        $this->_verified = false;
237
-        //make sure any _data value in the current message type is reset
238
-        if ($this->_current_message_type instanceof EE_message_type) {
239
-            $this->_current_message_type->reset_data();
240
-        }
241
-        $this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
242
-    }
243
-
244
-
245
-    /**
246
-     * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
247
-     * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
248
-     * _generating_queue.
249
-     *
250
-     * @return bool Whether the message was successfully generated or not.
251
-     * @throws EE_Error
252
-     */
253
-    protected function _generate()
254
-    {
255
-        //double check verification has run and that everything is ready to work with (saves us having to validate
256
-        // everything again).
257
-        if (! $this->_verified) {
258
-            return false; //get out because we don't have a valid setup to work with.
259
-        }
260
-
261
-
262
-        try {
263
-            $addressees = $this->_current_message_type->get_addressees(
264
-                $this->_current_data_handler,
265
-                $this->_generation_queue->get_message_repository()->current()->context()
266
-            );
267
-        } catch (EE_Error $e) {
268
-            $this->_error_msg[] = $e->getMessage();
269
-            return false;
270
-        }
271
-
272
-
273
-        //if no addressees then get out because there is nothing to generation (possible bad data).
274
-        if (! $this->_valid_addressees($addressees)) {
275
-            do_action(
276
-                'AHEE__EE_Messages_Generator___generate__invalid_addressees',
277
-                $this->_generation_queue->get_message_repository()->current(),
278
-                $addressees,
279
-                $this->_current_messenger,
280
-                $this->_current_message_type,
281
-                $this->_current_data_handler
282
-            );
283
-            $this->_generation_queue->get_message_repository()->current()->set_STS_ID(
284
-                EEM_Message::status_debug_only
285
-            );
286
-            $this->_error_msg[] = esc_html__(
287
-                'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
288
-                'event_espresso'
289
-            );
290
-            return false;
291
-        }
292
-
293
-        $message_template_group = $this->_get_message_template_group();
294
-
295
-        //in the unlikely event there is no EE_Message_Template_Group available, get out!
296
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
297
-            $this->_error_msg[] = esc_html__(
298
-                'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
299
-                'event_espresso'
300
-            );
301
-            return false;
302
-        }
303
-
304
-        //get formatted templates for using to parse and setup EE_Message objects.
305
-        $templates = $this->_get_templates($message_template_group);
306
-
307
-
308
-        //setup new EE_Message objects (and add to _ready_queue)
309
-        return $this->_assemble_messages($addressees, $templates, $message_template_group);
310
-    }
311
-
312
-
313
-    /**
314
-     * Retrieves the message template group being used for generating messages.
315
-     * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
316
-     *
317
-     * @return EE_Message_Template_Group|null
318
-     * @throws EE_Error
319
-     */
320
-    protected function _get_message_template_group()
321
-    {
322
-        //first see if there is a specific message template group requested (current message in the queue has a specific
323
-        //GRP_ID
324
-        $message_template_group = $this->_specific_message_template_group_from_queue();
325
-        if ($message_template_group instanceof EE_Message_Template_Group) {
326
-            return $message_template_group;
327
-        }
328
-
329
-        //get event_ids from the datahandler so we can check to see if there's already a message template group for them
330
-        //in the collection.
331
-        $event_ids              = $this->_get_event_ids_from_current_data_handler();
332
-        $message_template_group = $this->_template_collection->get_by_key(
333
-            $this->_template_collection->getKey(
334
-                $this->_current_messenger->name,
335
-                $this->_current_message_type->name,
336
-                $event_ids
337
-            )
338
-        );
339
-
340
-        //if we have a message template group then no need to hit the database, just return it.
341
-        if ($message_template_group instanceof EE_Message_Template_Group) {
342
-            return $message_template_group;
343
-        }
344
-
345
-        //okay made it here, so let's get the global group first for this messenger and message type to ensure
346
-        //there is no override set.
347
-        $global_message_template_group = $this->_get_global_message_template_group_for_current_messenger_and_message_type();
348
-
349
-        if ($global_message_template_group instanceof EE_Message_Template_Group
350
-            && $global_message_template_group->get('MTP_is_override')
351
-        ) {
352
-            return $global_message_template_group;
353
-        }
354
-
355
-        //if we're still here, that means there was no message template group for the events in the collection and
356
-        //the global message template group for the messenger and message type is not set for override.  So next step is
357
-        //to see if there is a common shared custom message template group for this set of events.
358
-        $message_template_group = $this->_get_shared_message_template_for_events($event_ids);
359
-        if ($message_template_group instanceof EE_Message_Template_Group) {
360
-            return $message_template_group;
361
-        }
362
-
363
-        //STILL here?  Okay that means the fallback is to just use the global message template group for this event set.
364
-        //So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this request)
365
-        //and return it.
366
-        if ($global_message_template_group instanceof EE_Message_Template_Group) {
367
-            $this->_template_collection->add(
368
-                $global_message_template_group,
369
-                $event_ids
370
-            );
371
-            return $global_message_template_group;
372
-        }
373
-
374
-        //if we land here that means there's NO active message template group for this set.
375
-        //TODO this will be a good target for some optimization down the road.  Whenever there is no active message
376
-        //template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
377
-        //this should likely bit hit rarely enough that it's not a significant issue.
378
-        return null;
379
-    }
380
-
381
-
382
-    /**
383
-     * This checks the current message in the queue and determines if there is a specific Message Template Group
384
-     * requested for that message.
385
-     *
386
-     * @return EE_Message_Template_Group|null
387
-     */
388
-    protected function _specific_message_template_group_from_queue()
389
-    {
390
-        //is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
391
-        //so let's use that.
392
-        $GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
393
-
394
-        if ($GRP_ID) {
395
-            //attempt to retrieve from repo first
396
-            $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
397
-            if ($message_template_group instanceof EE_Message_Template_Group) {
398
-                return $message_template_group;  //got it!
399
-            }
400
-
401
-            //nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
402
-            //is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
403
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
404
-            if ($message_template_group instanceof EE_Message_Template_Group) {
405
-                $this->_template_collection->add($message_template_group);
406
-                return $message_template_group;
407
-            }
408
-        }
409
-        return null;
410
-    }
411
-
412
-
413
-    /**
414
-     * Returns whether the event ids passed in all share the same message template group for the current message type
415
-     * and messenger.
416
-     *
417
-     * @param array $event_ids
418
-     * @return bool true means they DO share the same message template group, false means they don't.
419
-     * @throws EE_Error
420
-     */
421
-    protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
422
-    {
423
-        foreach ($this->_current_data_handler->events as $event) {
424
-            $event_ids[$event['ID']] = $event['ID'];
425
-        }
426
-        $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
427
-            array(
428
-                array(
429
-                    'Event.EVT_ID'           => array('IN', $event_ids),
430
-                    'MTP_messenger'    => $this->_current_messenger->name,
431
-                    'MTP_message_type' => $this->_current_message_type->name,
432
-                ),
433
-            ),
434
-            'GRP_ID',
435
-            true
436
-        );
437
-        return $count_of_message_template_groups === 1;
438
-    }
439
-
440
-
441
-    /**
442
-     * This will get the shared message template group for events that are in the current data handler but ONLY if
443
-     * there's a single shared message template group among all the events.  Otherwise it returns null.
444
-     *
445
-     * @param array $event_ids
446
-     * @return EE_Message_Template_Group|null
447
-     * @throws EE_Error
448
-     */
449
-    protected function _get_shared_message_template_for_events(array $event_ids)
450
-    {
451
-        $message_template_group = null;
452
-        if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
453
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one(
454
-                array(
455
-                    array(
456
-                        'Event.EVT_ID'           => array('IN', $event_ids),
457
-                        'MTP_messenger'    => $this->_current_messenger->name,
458
-                        'MTP_message_type' => $this->_current_message_type->name,
459
-                        'MTP_is_active'    => true,
460
-                    ),
461
-                    'group_by' => 'GRP_ID',
462
-                )
463
-            );
464
-            //store this in the collection if its valid
465
-            if ($message_template_group instanceof EE_Message_Template_Group) {
466
-                $this->_template_collection->add(
467
-                    $message_template_group,
468
-                    $event_ids
469
-                );
470
-            }
471
-        }
472
-        return $message_template_group;
473
-    }
474
-
475
-
476
-    /**
477
-     * Retrieves the global message template group for the current messenger and message type.
478
-     *
479
-     * @return EE_Message_Template_Group|null
480
-     * @throws EE_Error
481
-     */
482
-    protected function _get_global_message_template_group_for_current_messenger_and_message_type()
483
-    {
484
-        //first check the collection (we use an array with 0 in it to represent global groups).
485
-        $global_message_template_group = $this->_template_collection->get_by_key(
486
-            $this->_template_collection->getKey(
487
-                $this->_current_messenger->name,
488
-                $this->_current_message_type->name,
489
-                array(0)
490
-            )
491
-        );
492
-
493
-        //if we don't have a group lets hit the db.
494
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
495
-            $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
496
-                array(
497
-                    array(
498
-                        'MTP_messenger'    => $this->_current_messenger->name,
499
-                        'MTP_message_type' => $this->_current_message_type->name,
500
-                        'MTP_is_active'    => true,
501
-                        'MTP_is_global'    => true,
502
-                    ),
503
-                )
504
-            );
505
-            //if we have a group, add it to the collection.
506
-            if ($global_message_template_group instanceof EE_Message_Template_Group) {
507
-                $this->_template_collection->add(
508
-                    $global_message_template_group,
509
-                    array(0)
510
-                );
511
-            }
512
-        }
513
-        return $global_message_template_group;
514
-    }
515
-
516
-
517
-    /**
518
-     * Returns an array of event ids for all the events within the current data handler.
519
-     *
520
-     * @return array
521
-     */
522
-    protected function _get_event_ids_from_current_data_handler()
523
-    {
524
-        $event_ids = array();
525
-        foreach ($this->_current_data_handler->events as $event) {
526
-            $event_ids[$event['ID']] = $event['ID'];
527
-        }
528
-        return $event_ids;
529
-    }
530
-
531
-
532
-    /**
533
-     *  Retrieves formatted array of template information for each context specific to the given
534
-     *  EE_Message_Template_Group
535
-     *
536
-     * @param EE_Message_Template_Group $message_template_group
537
-     * @return array The returned array is in this structure:
538
-     *                          array(
539
-     *                          'field_name' => array(
540
-     *                          'context' => 'content'
541
-     *                          )
542
-     *                          )
543
-     * @throws EE_Error
544
-     */
545
-    protected function _get_templates(EE_Message_Template_Group $message_template_group)
546
-    {
547
-        $templates         = array();
548
-        $context_templates = $message_template_group->context_templates();
549
-        foreach ($context_templates as $context => $template_fields) {
550
-            foreach ($template_fields as $template_field => $template_obj) {
551
-                if (! $template_obj instanceof EE_Message_Template) {
552
-                    continue;
553
-                }
554
-                $templates[$template_field][$context] = $template_obj->get('MTP_content');
555
-            }
556
-        }
557
-        return $templates;
558
-    }
559
-
560
-
561
-    /**
562
-     * Assembles new fully generated EE_Message objects and adds to _ready_queue
563
-     *
564
-     * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
565
-     *                                               context.
566
-     * @param array                     $templates   formatted array of templates used for parsing data.
567
-     * @param EE_Message_Template_Group $message_template_group
568
-     * @return bool   true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
569
-     *                                               method will attempt to generate ALL EE_Message objects and add to
570
-     *                                               the _ready_queue.  Successfully generated messages get added to the
571
-     *                                               queue with EEM_Message::status_idle, unsuccessfully generated
572
-     *                                               messages will get added to the queue as EEM_Message::status_failed.
573
-     *                                               Very rarely should "false" be returned from this method.
574
-     */
575
-    protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
576
-    {
577
-
578
-        //if templates are empty then get out because we can't generate anything.
579
-        if (! $templates) {
580
-            $this->_error_msg[] = esc_html__(
581
-                'Unable to assemble messages because there are no templates retrieved for generating the messages with',
582
-                'event_espresso'
583
-            );
584
-            return false;
585
-        }
586
-
587
-        //We use this as the counter for generated messages because don't forget we may be executing this inside of a
588
-        //generation_queue.  So _ready_queue may have generated EE_Message objects already.
589
-        $generated_count = 0;
590
-        foreach ($addressees as $context => $recipients) {
591
-            foreach ($recipients as $recipient) {
592
-                $message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
593
-                if ($message instanceof EE_Message) {
594
-                    $this->_ready_queue->add(
595
-                        $message,
596
-                        array(),
597
-                        $this->_generation_queue->get_message_repository()->is_preview(),
598
-                        $this->_generation_queue->get_message_repository()->is_test_send()
599
-                    );
600
-                    $generated_count++;
601
-                }
602
-
603
-                //if the current MSG being generated is for a test send then we'll only use ONE message in the generation.
604
-                if ($this->_generation_queue->get_message_repository()->is_test_send()) {
605
-                    break 2;
606
-                }
607
-            }
608
-        }
609
-
610
-        //if there are no generated messages then something else fatal went wrong.
611
-        return $generated_count > 0;
612
-    }
613
-
614
-
615
-    /**
616
-     * @param string                    $context   The context for the generated message.
617
-     * @param EE_Messages_Addressee     $recipient
618
-     * @param array                     $templates formatted array of templates used for parsing data.
619
-     * @param EE_Message_Template_Group $message_template_group
620
-     * @return bool|EE_Message
621
-     * @throws EE_Error
622
-     */
623
-    protected function _setup_message_object(
624
-        $context,
625
-        EE_Messages_Addressee $recipient,
626
-        $templates,
627
-        EE_Message_Template_Group $message_template_group
628
-    ) {
629
-        //stuff we already know
630
-        $transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
631
-        $transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
632
-            ? $this->_current_data_handler->txn->ID()
633
-            : $transaction_id;
634
-        $message_fields = array(
635
-            'GRP_ID'           => $message_template_group->ID(),
636
-            'TXN_ID'           => $transaction_id,
637
-            'MSG_messenger'    => $this->_current_messenger->name,
638
-            'MSG_message_type' => $this->_current_message_type->name,
639
-            'MSG_context'      => $context,
640
-        );
641
-
642
-        //recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
643
-        // the info from the att_obj found in the EE_Messages_Addressee object.
644
-        if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
645
-            $message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
646
-                ? $recipient->att_obj->ID()
647
-                : 0;
648
-            $message_fields['MSG_recipient_type'] = 'Attendee';
649
-        } else {
650
-            $message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
651
-            $message_fields['MSG_recipient_type'] = $recipient->recipient_type;
652
-        }
653
-        $message = EE_Message_Factory::create($message_fields);
654
-
655
-        //grab valid shortcodes for shortcode parser
656
-        $mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
657
-        $m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
658
-
659
-        //if the 'to' field is empty (messages will ALWAYS have a "to" field, then we get out because that means this
660
-        //context is turned off) EXCEPT if we're previewing
661
-        if (empty($templates['to'][$context])
662
-            && ! $this->_generation_queue->get_message_repository()->is_preview()
663
-            && ! $this->_current_messenger->allow_empty_to_field()
664
-        ) {
665
-            //we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
666
-            //field.
667
-            return false;
668
-        }
669
-        $error_msg = array();
670
-        foreach ($templates as $field => $field_context) {
671
-            $error_msg = array();
672
-            //let's setup the valid shortcodes for the incoming context.
673
-            $valid_shortcodes = $mt_shortcodes[$context];
674
-            //merge in valid shortcodes for the field.
675
-            $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
676
-            if (isset($templates[$field][$context])) {
677
-                //prefix field.
678
-                $column_name = 'MSG_' . $field;
679
-                try {
680
-                    $content = $this->_shortcode_parser->parse_message_template(
681
-                        $templates[$field][$context],
682
-                        $recipient,
683
-                        $shortcodes,
684
-                        $this->_current_message_type,
685
-                        $this->_current_messenger,
686
-                        $message
687
-                    );
688
-                    $message->set_field_or_extra_meta($column_name, $content);
689
-                } catch (EE_Error $e) {
690
-                    $error_msg[] = sprintf(
691
-                        esc_html__(
692
-                            'There was a problem generating the content for the field %s: %s',
693
-                            'event_espresso'
694
-                        ),
695
-                        $field,
696
-                        $e->getMessage()
697
-                    );
698
-                    $message->set_STS_ID(EEM_Message::status_failed);
699
-                }
700
-            }
701
-        }
702
-
703
-        if ($message->STS_ID() === EEM_Message::status_failed) {
704
-            $error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
705
-                         . "\n"
706
-                         . implode("\n", $error_msg);
707
-            $message->set_error_message($error_msg);
708
-        } else {
709
-            $message->set_STS_ID(EEM_Message::status_idle);
710
-        }
711
-        return $message;
712
-    }
713
-
714
-
715
-    /**
716
-     * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
717
-     * error message if either is missing.
718
-     *
719
-     * @return bool         true means there were no errors, false means there were errors.
720
-     */
721
-    protected function _verify()
722
-    {
723
-        //reset error message to an empty array.
724
-        $this->_error_msg = array();
725
-        $valid            = true;
726
-        $valid            = $valid ? $this->_validate_messenger_and_message_type() : $valid;
727
-        $valid            = $valid ? $this->_validate_and_setup_data() : $valid;
728
-
729
-        //set the verified flag so we know everything has been validated.
730
-        $this->_verified = $valid;
731
-
732
-        return $valid;
733
-    }
734
-
735
-
736
-    /**
737
-     * This accepts an array and validates that it is an array indexed by context with each value being an array of
738
-     * EE_Messages_Addressee objects.
739
-     *
740
-     * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
741
-     * @return bool
742
-     */
743
-    protected function _valid_addressees($addressees)
744
-    {
745
-        if (! $addressees || ! is_array($addressees)) {
746
-            return false;
747
-        }
748
-
749
-        foreach ($addressees as $addressee_array) {
750
-            foreach ($addressee_array as $addressee) {
751
-                if (! $addressee instanceof EE_Messages_Addressee) {
752
-                    return false;
753
-                }
754
-            }
755
-        }
756
-        return true;
757
-    }
758
-
759
-
760
-    /**
761
-     * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
762
-     * queue. This process sets error messages if something is wrong.
763
-     *
764
-     * @return bool   true is if there are no errors.  false is if there is.
765
-     */
766
-    protected function _validate_messenger_and_message_type()
767
-    {
768
-
769
-        //first are there any existing error messages?  If so then return.
770
-        if ($this->_error_msg) {
771
-            return false;
772
-        }
773
-        /** @type EE_Message $message */
774
-        $message = $this->_generation_queue->get_message_repository()->current();
775
-        try {
776
-            $this->_current_messenger = $message->valid_messenger(true)
777
-                ? $message->messenger_object()
778
-                : null;
779
-        } catch (Exception $e) {
780
-            $this->_error_msg[] = $e->getMessage();
781
-        }
782
-        try {
783
-            $this->_current_message_type = $message->valid_message_type(true)
784
-                ? $message->message_type_object()
785
-                : null;
786
-        } catch (Exception $e) {
787
-            $this->_error_msg[] = $e->getMessage();
788
-        }
789
-
790
-        /**
791
-         * Check if there is any generation data, but only if this is not for a preview.
792
-         */
793
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
794
-            && (
795
-                ! $this->_generation_queue->get_message_repository()->is_preview()
796
-                && $this->_generation_queue->get_message_repository()->get_data_handler()
797
-                   !== 'EE_Messages_Preview_incoming_data'
798
-            )
799
-        ) {
800
-            $this->_error_msg[] = esc_html__(
801
-                'There is no generation data for this message. Unable to generate.',
802
-                'event_espresso'
803
-            );
804
-        }
805
-
806
-        return empty($this->_error_msg);
807
-    }
808
-
809
-
810
-    /**
811
-     * This method retrieves the expected data handler for the message type and validates the generation data for that
812
-     * data handler.
813
-     *
814
-     * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
815
-     */
816
-    protected function _validate_and_setup_data()
817
-    {
818
-
819
-        //First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
820
-        //be used anyways.
821
-        if ($this->_error_msg) {
822
-            return false;
823
-        }
824
-
825
-        $generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
826
-
827
-        /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
828
-        $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
829
-            ? $this->_generation_queue->get_message_repository()->get_data_handler()
830
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
831
-
832
-        //If this EE_Message is for a preview, then let's switch out to the preview data handler.
833
-        if ($this->_generation_queue->get_message_repository()->is_preview()) {
834
-            $data_handler_class_name = 'EE_Messages_Preview_incoming_data';
835
-        }
836
-
837
-        //First get the class name for the data handler (and also verifies it exists.
838
-        if (! class_exists($data_handler_class_name)) {
839
-            $this->_error_msg[] = sprintf(
840
-                esc_html__(
841
-                    'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
842
-                    'event_espresso'
843
-                ),
844
-                'EE_Messages_incoming_data',
845
-                $data_handler_class_name
846
-            );
847
-            return false;
848
-        }
849
-
850
-        //convert generation_data for data_handler_instantiation.
851
-        $generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
852
-
853
-        //note, this may set error messages as well.
854
-        $this->_set_data_handler($generation_data, $data_handler_class_name);
855
-
856
-        return empty($this->_error_msg);
857
-    }
858
-
859
-
860
-    /**
861
-     * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
862
-     * adds it to the _data repository.
863
-     *
864
-     * @param mixed  $generating_data           This is data expected by the instantiated data handler.
865
-     * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
866
-     *                                          instantiated.
867
-     * @return void .
868
-     * @throws EE_Error
869
-     * @throws ReflectionException
870
-     */
871
-    protected function _set_data_handler($generating_data, $data_handler_class_name)
872
-    {
873
-        //valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
874
-        //is already a ready data handler in the repository.
875
-        $this->_current_data_handler = $this->_data_handler_collection->get_by_key(
876
-            $this->_data_handler_collection->get_key(
877
-                $data_handler_class_name,
878
-                $generating_data
879
-            )
880
-        );
881
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
882
-            //no saved data_handler in the repo so let's set one up and add it to the repo.
883
-            try {
884
-                $this->_current_data_handler = new $data_handler_class_name($generating_data);
885
-                $this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
886
-            } catch (EE_Error $e) {
887
-                $this->_error_msg[] = $e->get_error();
888
-            }
889
-        }
890
-    }
891
-
892
-
893
-    /**
894
-     * The queued EE_Message for generation does not save the data used for generation as objects
895
-     * because serialization of those objects could be problematic if the data is saved to the db.
896
-     * So this method calls the static method on the associated data_handler for the given message_type
897
-     * and that preps the data for later instantiation when generating.
898
-     *
899
-     * @param EE_Message_To_Generate $message_to_generate
900
-     * @param bool                   $preview Indicate whether this is being used for a preview or not.
901
-     * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
902
-     */
903
-    protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
904
-    {
905
-        /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
906
-        $data_handler = $message_to_generate->get_data_handler_class_name($preview);
907
-        if (! $message_to_generate->valid()) {
908
-            return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
909
-        }
910
-        return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
911
-    }
912
-
913
-
914
-    /**
915
-     * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
916
-     *
917
-     * @param EE_Message_To_Generate $message_to_generate
918
-     * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
919
-     */
920
-    public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
921
-    {
922
-        //prep data
923
-        $data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
924
-
925
-        $message = $message_to_generate->get_EE_Message();
926
-
927
-        //is there a GRP_ID in the request?
928
-        if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
929
-            $message->set_GRP_ID($GRP_ID);
930
-        }
931
-
932
-        if ($data === false) {
933
-            $message->set_STS_ID(EEM_Message::status_failed);
934
-            $message->set_error_message(
935
-                esc_html__(
936
-                    'Unable to prepare data for persistence to the database.',
937
-                    'event_espresso'
938
-                )
939
-            );
940
-        } else {
941
-            //make sure that the data handler is cached on the message as well
942
-            $data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
943
-        }
944
-
945
-        $this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
946
-    }
16
+	/**
17
+	 * @type EE_Messages_Data_Handler_Collection
18
+	 */
19
+	protected $_data_handler_collection;
20
+
21
+	/**
22
+	 * @type  EE_Message_Template_Group_Collection
23
+	 */
24
+	protected $_template_collection;
25
+
26
+	/**
27
+	 * This will hold the data handler for the current EE_Message being generated.
28
+	 *
29
+	 * @type EE_Messages_incoming_data
30
+	 */
31
+	protected $_current_data_handler;
32
+
33
+	/**
34
+	 * This holds the EE_Messages_Queue that contains the messages to generate.
35
+	 *
36
+	 * @type EE_Messages_Queue
37
+	 */
38
+	protected $_generation_queue;
39
+
40
+	/**
41
+	 * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
42
+	 *
43
+	 * @type EE_Messages_Queue
44
+	 */
45
+	protected $_ready_queue;
46
+
47
+	/**
48
+	 * This is a container for any error messages that get created through the generation
49
+	 * process.
50
+	 *
51
+	 * @type array
52
+	 */
53
+	protected $_error_msg = array();
54
+
55
+	/**
56
+	 * Flag used to set when the current EE_Message in the generation queue has been verified.
57
+	 *
58
+	 * @type bool
59
+	 */
60
+	protected $_verified = false;
61
+
62
+	/**
63
+	 * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
64
+	 *
65
+	 * @type EE_messenger
66
+	 */
67
+	protected $_current_messenger;
68
+
69
+	/**
70
+	 * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
71
+	 *
72
+	 * @type EE_message_type
73
+	 */
74
+	protected $_current_message_type;
75
+
76
+	/**
77
+	 * @type EEH_Parse_Shortcodes
78
+	 */
79
+	protected $_shortcode_parser;
80
+
81
+
82
+	/**
83
+	 * @param EE_Messages_Queue                     $generation_queue
84
+	 * @param \EE_Messages_Queue                    $ready_queue
85
+	 * @param \EE_Messages_Data_Handler_Collection  $data_handler_collection
86
+	 * @param \EE_Message_Template_Group_Collection $template_collection
87
+	 * @param \EEH_Parse_Shortcodes                 $shortcode_parser
88
+	 */
89
+	public function __construct(
90
+		EE_Messages_Queue $generation_queue,
91
+		EE_Messages_Queue $ready_queue,
92
+		EE_Messages_Data_Handler_Collection $data_handler_collection,
93
+		EE_Message_Template_Group_Collection $template_collection,
94
+		EEH_Parse_Shortcodes $shortcode_parser
95
+	) {
96
+		$this->_generation_queue        = $generation_queue;
97
+		$this->_ready_queue             = $ready_queue;
98
+		$this->_data_handler_collection = $data_handler_collection;
99
+		$this->_template_collection     = $template_collection;
100
+		$this->_shortcode_parser        = $shortcode_parser;
101
+	}
102
+
103
+
104
+	/**
105
+	 * @return EE_Messages_Queue
106
+	 */
107
+	public function generation_queue()
108
+	{
109
+		return $this->_generation_queue;
110
+	}
111
+
112
+
113
+	/**
114
+	 *  This iterates through the provided queue and generates the EE_Message objects.
115
+	 *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
116
+	 *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
117
+	 *  for the caller to decide what to do with it.
118
+	 *
119
+	 * @param   bool $save Whether to save the EE_Message objects in the new queue or just return.
120
+	 * @return EE_Messages_Queue  The new queue for holding generated EE_Message objects.
121
+	 */
122
+	public function generate($save = true)
123
+	{
124
+		//iterate through the messages in the queue, generate, and add to new queue.
125
+		$this->_generation_queue->get_message_repository()->rewind();
126
+		while ($this->_generation_queue->get_message_repository()->valid()) {
127
+			//reset "current" properties
128
+			$this->_reset_current_properties();
129
+
130
+			/** @type EE_Message $msg */
131
+			$msg = $this->_generation_queue->get_message_repository()->current();
132
+
133
+			/**
134
+			 * need to get the next object and capture it for setting manually after deletes.  The reason is that when
135
+			 * an object is removed from the repo then valid for the next object will fail.
136
+			 */
137
+			$this->_generation_queue->get_message_repository()->next();
138
+			$next_msg = $this->_generation_queue->get_message_repository()->current();
139
+			//restore pointer to current item
140
+			$this->_generation_queue->get_message_repository()->set_current($msg);
141
+
142
+			//skip and delete if the current $msg is NOT incomplete (queued for generation)
143
+			if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
144
+				//we keep this item in the db just remove from the repo.
145
+				$this->_generation_queue->get_message_repository()->remove($msg);
146
+				//next item
147
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
148
+				continue;
149
+			}
150
+
151
+			if ($this->_verify()) {
152
+				//let's get generating!
153
+				$this->_generate();
154
+			}
155
+
156
+			//don't persist debug_only messages if the messages system is not in debug mode.
157
+			if ($msg->STS_ID() === EEM_Message::status_debug_only
158
+				&& ! EEM_Message::debug()
159
+			) {
160
+				do_action(
161
+					'AHEE__EE_Messages_Generator__generate__before_debug_delete',
162
+					$msg,
163
+					$this->_error_msg,
164
+					$this->_current_messenger,
165
+					$this->_current_message_type,
166
+					$this->_current_data_handler
167
+				);
168
+				$this->_generation_queue->get_message_repository()->delete();
169
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
170
+				continue;
171
+			}
172
+
173
+			//if there are error messages then let's set the status and the error message.
174
+			if ($this->_error_msg) {
175
+				//if the status is already debug only, then let's leave it at that.
176
+				if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
177
+					$msg->set_STS_ID(EEM_Message::status_failed);
178
+				}
179
+				do_action(
180
+					'AHEE__EE_Messages_Generator__generate__processing_failed_message',
181
+					$msg,
182
+					$this->_error_msg,
183
+					$this->_current_messenger,
184
+					$this->_current_message_type,
185
+					$this->_current_data_handler
186
+				);
187
+				$msg->set_error_message(
188
+					esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
189
+					. "\n"
190
+					. implode("\n", $this->_error_msg)
191
+				);
192
+				$msg->set_modified(time());
193
+			} else {
194
+				do_action(
195
+					'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
196
+					$msg,
197
+					$this->_error_msg,
198
+					$this->_current_messenger,
199
+					$this->_current_message_type,
200
+					$this->_current_data_handler
201
+				);
202
+				//remove from db
203
+				$this->_generation_queue->get_message_repository()->delete();
204
+			}
205
+			//next item
206
+			$this->_generation_queue->get_message_repository()->set_current($next_msg);
207
+		}
208
+
209
+		//generation queue is ALWAYS saved to record any errors in the generation process.
210
+		$this->_generation_queue->save();
211
+
212
+		/**
213
+		 * save _ready_queue if flag set.
214
+		 * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
215
+		 * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
216
+		 * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
217
+		 * irrelevant.
218
+		 */
219
+		if ($save) {
220
+			$this->_ready_queue->save();
221
+		}
222
+
223
+		//final reset of properties
224
+		$this->_reset_current_properties();
225
+
226
+		return $this->_ready_queue;
227
+	}
228
+
229
+
230
+	/**
231
+	 * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
232
+	 * in the generation queue.
233
+	 */
234
+	protected function _reset_current_properties()
235
+	{
236
+		$this->_verified = false;
237
+		//make sure any _data value in the current message type is reset
238
+		if ($this->_current_message_type instanceof EE_message_type) {
239
+			$this->_current_message_type->reset_data();
240
+		}
241
+		$this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
242
+	}
243
+
244
+
245
+	/**
246
+	 * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
247
+	 * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
248
+	 * _generating_queue.
249
+	 *
250
+	 * @return bool Whether the message was successfully generated or not.
251
+	 * @throws EE_Error
252
+	 */
253
+	protected function _generate()
254
+	{
255
+		//double check verification has run and that everything is ready to work with (saves us having to validate
256
+		// everything again).
257
+		if (! $this->_verified) {
258
+			return false; //get out because we don't have a valid setup to work with.
259
+		}
260
+
261
+
262
+		try {
263
+			$addressees = $this->_current_message_type->get_addressees(
264
+				$this->_current_data_handler,
265
+				$this->_generation_queue->get_message_repository()->current()->context()
266
+			);
267
+		} catch (EE_Error $e) {
268
+			$this->_error_msg[] = $e->getMessage();
269
+			return false;
270
+		}
271
+
272
+
273
+		//if no addressees then get out because there is nothing to generation (possible bad data).
274
+		if (! $this->_valid_addressees($addressees)) {
275
+			do_action(
276
+				'AHEE__EE_Messages_Generator___generate__invalid_addressees',
277
+				$this->_generation_queue->get_message_repository()->current(),
278
+				$addressees,
279
+				$this->_current_messenger,
280
+				$this->_current_message_type,
281
+				$this->_current_data_handler
282
+			);
283
+			$this->_generation_queue->get_message_repository()->current()->set_STS_ID(
284
+				EEM_Message::status_debug_only
285
+			);
286
+			$this->_error_msg[] = esc_html__(
287
+				'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
288
+				'event_espresso'
289
+			);
290
+			return false;
291
+		}
292
+
293
+		$message_template_group = $this->_get_message_template_group();
294
+
295
+		//in the unlikely event there is no EE_Message_Template_Group available, get out!
296
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
297
+			$this->_error_msg[] = esc_html__(
298
+				'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
299
+				'event_espresso'
300
+			);
301
+			return false;
302
+		}
303
+
304
+		//get formatted templates for using to parse and setup EE_Message objects.
305
+		$templates = $this->_get_templates($message_template_group);
306
+
307
+
308
+		//setup new EE_Message objects (and add to _ready_queue)
309
+		return $this->_assemble_messages($addressees, $templates, $message_template_group);
310
+	}
311
+
312
+
313
+	/**
314
+	 * Retrieves the message template group being used for generating messages.
315
+	 * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
316
+	 *
317
+	 * @return EE_Message_Template_Group|null
318
+	 * @throws EE_Error
319
+	 */
320
+	protected function _get_message_template_group()
321
+	{
322
+		//first see if there is a specific message template group requested (current message in the queue has a specific
323
+		//GRP_ID
324
+		$message_template_group = $this->_specific_message_template_group_from_queue();
325
+		if ($message_template_group instanceof EE_Message_Template_Group) {
326
+			return $message_template_group;
327
+		}
328
+
329
+		//get event_ids from the datahandler so we can check to see if there's already a message template group for them
330
+		//in the collection.
331
+		$event_ids              = $this->_get_event_ids_from_current_data_handler();
332
+		$message_template_group = $this->_template_collection->get_by_key(
333
+			$this->_template_collection->getKey(
334
+				$this->_current_messenger->name,
335
+				$this->_current_message_type->name,
336
+				$event_ids
337
+			)
338
+		);
339
+
340
+		//if we have a message template group then no need to hit the database, just return it.
341
+		if ($message_template_group instanceof EE_Message_Template_Group) {
342
+			return $message_template_group;
343
+		}
344
+
345
+		//okay made it here, so let's get the global group first for this messenger and message type to ensure
346
+		//there is no override set.
347
+		$global_message_template_group = $this->_get_global_message_template_group_for_current_messenger_and_message_type();
348
+
349
+		if ($global_message_template_group instanceof EE_Message_Template_Group
350
+			&& $global_message_template_group->get('MTP_is_override')
351
+		) {
352
+			return $global_message_template_group;
353
+		}
354
+
355
+		//if we're still here, that means there was no message template group for the events in the collection and
356
+		//the global message template group for the messenger and message type is not set for override.  So next step is
357
+		//to see if there is a common shared custom message template group for this set of events.
358
+		$message_template_group = $this->_get_shared_message_template_for_events($event_ids);
359
+		if ($message_template_group instanceof EE_Message_Template_Group) {
360
+			return $message_template_group;
361
+		}
362
+
363
+		//STILL here?  Okay that means the fallback is to just use the global message template group for this event set.
364
+		//So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this request)
365
+		//and return it.
366
+		if ($global_message_template_group instanceof EE_Message_Template_Group) {
367
+			$this->_template_collection->add(
368
+				$global_message_template_group,
369
+				$event_ids
370
+			);
371
+			return $global_message_template_group;
372
+		}
373
+
374
+		//if we land here that means there's NO active message template group for this set.
375
+		//TODO this will be a good target for some optimization down the road.  Whenever there is no active message
376
+		//template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
377
+		//this should likely bit hit rarely enough that it's not a significant issue.
378
+		return null;
379
+	}
380
+
381
+
382
+	/**
383
+	 * This checks the current message in the queue and determines if there is a specific Message Template Group
384
+	 * requested for that message.
385
+	 *
386
+	 * @return EE_Message_Template_Group|null
387
+	 */
388
+	protected function _specific_message_template_group_from_queue()
389
+	{
390
+		//is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
391
+		//so let's use that.
392
+		$GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
393
+
394
+		if ($GRP_ID) {
395
+			//attempt to retrieve from repo first
396
+			$message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
397
+			if ($message_template_group instanceof EE_Message_Template_Group) {
398
+				return $message_template_group;  //got it!
399
+			}
400
+
401
+			//nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
402
+			//is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
403
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
404
+			if ($message_template_group instanceof EE_Message_Template_Group) {
405
+				$this->_template_collection->add($message_template_group);
406
+				return $message_template_group;
407
+			}
408
+		}
409
+		return null;
410
+	}
411
+
412
+
413
+	/**
414
+	 * Returns whether the event ids passed in all share the same message template group for the current message type
415
+	 * and messenger.
416
+	 *
417
+	 * @param array $event_ids
418
+	 * @return bool true means they DO share the same message template group, false means they don't.
419
+	 * @throws EE_Error
420
+	 */
421
+	protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
422
+	{
423
+		foreach ($this->_current_data_handler->events as $event) {
424
+			$event_ids[$event['ID']] = $event['ID'];
425
+		}
426
+		$count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
427
+			array(
428
+				array(
429
+					'Event.EVT_ID'           => array('IN', $event_ids),
430
+					'MTP_messenger'    => $this->_current_messenger->name,
431
+					'MTP_message_type' => $this->_current_message_type->name,
432
+				),
433
+			),
434
+			'GRP_ID',
435
+			true
436
+		);
437
+		return $count_of_message_template_groups === 1;
438
+	}
439
+
440
+
441
+	/**
442
+	 * This will get the shared message template group for events that are in the current data handler but ONLY if
443
+	 * there's a single shared message template group among all the events.  Otherwise it returns null.
444
+	 *
445
+	 * @param array $event_ids
446
+	 * @return EE_Message_Template_Group|null
447
+	 * @throws EE_Error
448
+	 */
449
+	protected function _get_shared_message_template_for_events(array $event_ids)
450
+	{
451
+		$message_template_group = null;
452
+		if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
453
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one(
454
+				array(
455
+					array(
456
+						'Event.EVT_ID'           => array('IN', $event_ids),
457
+						'MTP_messenger'    => $this->_current_messenger->name,
458
+						'MTP_message_type' => $this->_current_message_type->name,
459
+						'MTP_is_active'    => true,
460
+					),
461
+					'group_by' => 'GRP_ID',
462
+				)
463
+			);
464
+			//store this in the collection if its valid
465
+			if ($message_template_group instanceof EE_Message_Template_Group) {
466
+				$this->_template_collection->add(
467
+					$message_template_group,
468
+					$event_ids
469
+				);
470
+			}
471
+		}
472
+		return $message_template_group;
473
+	}
474
+
475
+
476
+	/**
477
+	 * Retrieves the global message template group for the current messenger and message type.
478
+	 *
479
+	 * @return EE_Message_Template_Group|null
480
+	 * @throws EE_Error
481
+	 */
482
+	protected function _get_global_message_template_group_for_current_messenger_and_message_type()
483
+	{
484
+		//first check the collection (we use an array with 0 in it to represent global groups).
485
+		$global_message_template_group = $this->_template_collection->get_by_key(
486
+			$this->_template_collection->getKey(
487
+				$this->_current_messenger->name,
488
+				$this->_current_message_type->name,
489
+				array(0)
490
+			)
491
+		);
492
+
493
+		//if we don't have a group lets hit the db.
494
+		if (! $global_message_template_group instanceof EE_Message_Template_Group) {
495
+			$global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
496
+				array(
497
+					array(
498
+						'MTP_messenger'    => $this->_current_messenger->name,
499
+						'MTP_message_type' => $this->_current_message_type->name,
500
+						'MTP_is_active'    => true,
501
+						'MTP_is_global'    => true,
502
+					),
503
+				)
504
+			);
505
+			//if we have a group, add it to the collection.
506
+			if ($global_message_template_group instanceof EE_Message_Template_Group) {
507
+				$this->_template_collection->add(
508
+					$global_message_template_group,
509
+					array(0)
510
+				);
511
+			}
512
+		}
513
+		return $global_message_template_group;
514
+	}
515
+
516
+
517
+	/**
518
+	 * Returns an array of event ids for all the events within the current data handler.
519
+	 *
520
+	 * @return array
521
+	 */
522
+	protected function _get_event_ids_from_current_data_handler()
523
+	{
524
+		$event_ids = array();
525
+		foreach ($this->_current_data_handler->events as $event) {
526
+			$event_ids[$event['ID']] = $event['ID'];
527
+		}
528
+		return $event_ids;
529
+	}
530
+
531
+
532
+	/**
533
+	 *  Retrieves formatted array of template information for each context specific to the given
534
+	 *  EE_Message_Template_Group
535
+	 *
536
+	 * @param EE_Message_Template_Group $message_template_group
537
+	 * @return array The returned array is in this structure:
538
+	 *                          array(
539
+	 *                          'field_name' => array(
540
+	 *                          'context' => 'content'
541
+	 *                          )
542
+	 *                          )
543
+	 * @throws EE_Error
544
+	 */
545
+	protected function _get_templates(EE_Message_Template_Group $message_template_group)
546
+	{
547
+		$templates         = array();
548
+		$context_templates = $message_template_group->context_templates();
549
+		foreach ($context_templates as $context => $template_fields) {
550
+			foreach ($template_fields as $template_field => $template_obj) {
551
+				if (! $template_obj instanceof EE_Message_Template) {
552
+					continue;
553
+				}
554
+				$templates[$template_field][$context] = $template_obj->get('MTP_content');
555
+			}
556
+		}
557
+		return $templates;
558
+	}
559
+
560
+
561
+	/**
562
+	 * Assembles new fully generated EE_Message objects and adds to _ready_queue
563
+	 *
564
+	 * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
565
+	 *                                               context.
566
+	 * @param array                     $templates   formatted array of templates used for parsing data.
567
+	 * @param EE_Message_Template_Group $message_template_group
568
+	 * @return bool   true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
569
+	 *                                               method will attempt to generate ALL EE_Message objects and add to
570
+	 *                                               the _ready_queue.  Successfully generated messages get added to the
571
+	 *                                               queue with EEM_Message::status_idle, unsuccessfully generated
572
+	 *                                               messages will get added to the queue as EEM_Message::status_failed.
573
+	 *                                               Very rarely should "false" be returned from this method.
574
+	 */
575
+	protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
576
+	{
577
+
578
+		//if templates are empty then get out because we can't generate anything.
579
+		if (! $templates) {
580
+			$this->_error_msg[] = esc_html__(
581
+				'Unable to assemble messages because there are no templates retrieved for generating the messages with',
582
+				'event_espresso'
583
+			);
584
+			return false;
585
+		}
586
+
587
+		//We use this as the counter for generated messages because don't forget we may be executing this inside of a
588
+		//generation_queue.  So _ready_queue may have generated EE_Message objects already.
589
+		$generated_count = 0;
590
+		foreach ($addressees as $context => $recipients) {
591
+			foreach ($recipients as $recipient) {
592
+				$message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
593
+				if ($message instanceof EE_Message) {
594
+					$this->_ready_queue->add(
595
+						$message,
596
+						array(),
597
+						$this->_generation_queue->get_message_repository()->is_preview(),
598
+						$this->_generation_queue->get_message_repository()->is_test_send()
599
+					);
600
+					$generated_count++;
601
+				}
602
+
603
+				//if the current MSG being generated is for a test send then we'll only use ONE message in the generation.
604
+				if ($this->_generation_queue->get_message_repository()->is_test_send()) {
605
+					break 2;
606
+				}
607
+			}
608
+		}
609
+
610
+		//if there are no generated messages then something else fatal went wrong.
611
+		return $generated_count > 0;
612
+	}
613
+
614
+
615
+	/**
616
+	 * @param string                    $context   The context for the generated message.
617
+	 * @param EE_Messages_Addressee     $recipient
618
+	 * @param array                     $templates formatted array of templates used for parsing data.
619
+	 * @param EE_Message_Template_Group $message_template_group
620
+	 * @return bool|EE_Message
621
+	 * @throws EE_Error
622
+	 */
623
+	protected function _setup_message_object(
624
+		$context,
625
+		EE_Messages_Addressee $recipient,
626
+		$templates,
627
+		EE_Message_Template_Group $message_template_group
628
+	) {
629
+		//stuff we already know
630
+		$transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
631
+		$transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
632
+			? $this->_current_data_handler->txn->ID()
633
+			: $transaction_id;
634
+		$message_fields = array(
635
+			'GRP_ID'           => $message_template_group->ID(),
636
+			'TXN_ID'           => $transaction_id,
637
+			'MSG_messenger'    => $this->_current_messenger->name,
638
+			'MSG_message_type' => $this->_current_message_type->name,
639
+			'MSG_context'      => $context,
640
+		);
641
+
642
+		//recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
643
+		// the info from the att_obj found in the EE_Messages_Addressee object.
644
+		if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
645
+			$message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
646
+				? $recipient->att_obj->ID()
647
+				: 0;
648
+			$message_fields['MSG_recipient_type'] = 'Attendee';
649
+		} else {
650
+			$message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
651
+			$message_fields['MSG_recipient_type'] = $recipient->recipient_type;
652
+		}
653
+		$message = EE_Message_Factory::create($message_fields);
654
+
655
+		//grab valid shortcodes for shortcode parser
656
+		$mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
657
+		$m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
658
+
659
+		//if the 'to' field is empty (messages will ALWAYS have a "to" field, then we get out because that means this
660
+		//context is turned off) EXCEPT if we're previewing
661
+		if (empty($templates['to'][$context])
662
+			&& ! $this->_generation_queue->get_message_repository()->is_preview()
663
+			&& ! $this->_current_messenger->allow_empty_to_field()
664
+		) {
665
+			//we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
666
+			//field.
667
+			return false;
668
+		}
669
+		$error_msg = array();
670
+		foreach ($templates as $field => $field_context) {
671
+			$error_msg = array();
672
+			//let's setup the valid shortcodes for the incoming context.
673
+			$valid_shortcodes = $mt_shortcodes[$context];
674
+			//merge in valid shortcodes for the field.
675
+			$shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
676
+			if (isset($templates[$field][$context])) {
677
+				//prefix field.
678
+				$column_name = 'MSG_' . $field;
679
+				try {
680
+					$content = $this->_shortcode_parser->parse_message_template(
681
+						$templates[$field][$context],
682
+						$recipient,
683
+						$shortcodes,
684
+						$this->_current_message_type,
685
+						$this->_current_messenger,
686
+						$message
687
+					);
688
+					$message->set_field_or_extra_meta($column_name, $content);
689
+				} catch (EE_Error $e) {
690
+					$error_msg[] = sprintf(
691
+						esc_html__(
692
+							'There was a problem generating the content for the field %s: %s',
693
+							'event_espresso'
694
+						),
695
+						$field,
696
+						$e->getMessage()
697
+					);
698
+					$message->set_STS_ID(EEM_Message::status_failed);
699
+				}
700
+			}
701
+		}
702
+
703
+		if ($message->STS_ID() === EEM_Message::status_failed) {
704
+			$error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
705
+						 . "\n"
706
+						 . implode("\n", $error_msg);
707
+			$message->set_error_message($error_msg);
708
+		} else {
709
+			$message->set_STS_ID(EEM_Message::status_idle);
710
+		}
711
+		return $message;
712
+	}
713
+
714
+
715
+	/**
716
+	 * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
717
+	 * error message if either is missing.
718
+	 *
719
+	 * @return bool         true means there were no errors, false means there were errors.
720
+	 */
721
+	protected function _verify()
722
+	{
723
+		//reset error message to an empty array.
724
+		$this->_error_msg = array();
725
+		$valid            = true;
726
+		$valid            = $valid ? $this->_validate_messenger_and_message_type() : $valid;
727
+		$valid            = $valid ? $this->_validate_and_setup_data() : $valid;
728
+
729
+		//set the verified flag so we know everything has been validated.
730
+		$this->_verified = $valid;
731
+
732
+		return $valid;
733
+	}
734
+
735
+
736
+	/**
737
+	 * This accepts an array and validates that it is an array indexed by context with each value being an array of
738
+	 * EE_Messages_Addressee objects.
739
+	 *
740
+	 * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
741
+	 * @return bool
742
+	 */
743
+	protected function _valid_addressees($addressees)
744
+	{
745
+		if (! $addressees || ! is_array($addressees)) {
746
+			return false;
747
+		}
748
+
749
+		foreach ($addressees as $addressee_array) {
750
+			foreach ($addressee_array as $addressee) {
751
+				if (! $addressee instanceof EE_Messages_Addressee) {
752
+					return false;
753
+				}
754
+			}
755
+		}
756
+		return true;
757
+	}
758
+
759
+
760
+	/**
761
+	 * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
762
+	 * queue. This process sets error messages if something is wrong.
763
+	 *
764
+	 * @return bool   true is if there are no errors.  false is if there is.
765
+	 */
766
+	protected function _validate_messenger_and_message_type()
767
+	{
768
+
769
+		//first are there any existing error messages?  If so then return.
770
+		if ($this->_error_msg) {
771
+			return false;
772
+		}
773
+		/** @type EE_Message $message */
774
+		$message = $this->_generation_queue->get_message_repository()->current();
775
+		try {
776
+			$this->_current_messenger = $message->valid_messenger(true)
777
+				? $message->messenger_object()
778
+				: null;
779
+		} catch (Exception $e) {
780
+			$this->_error_msg[] = $e->getMessage();
781
+		}
782
+		try {
783
+			$this->_current_message_type = $message->valid_message_type(true)
784
+				? $message->message_type_object()
785
+				: null;
786
+		} catch (Exception $e) {
787
+			$this->_error_msg[] = $e->getMessage();
788
+		}
789
+
790
+		/**
791
+		 * Check if there is any generation data, but only if this is not for a preview.
792
+		 */
793
+		if (! $this->_generation_queue->get_message_repository()->get_generation_data()
794
+			&& (
795
+				! $this->_generation_queue->get_message_repository()->is_preview()
796
+				&& $this->_generation_queue->get_message_repository()->get_data_handler()
797
+				   !== 'EE_Messages_Preview_incoming_data'
798
+			)
799
+		) {
800
+			$this->_error_msg[] = esc_html__(
801
+				'There is no generation data for this message. Unable to generate.',
802
+				'event_espresso'
803
+			);
804
+		}
805
+
806
+		return empty($this->_error_msg);
807
+	}
808
+
809
+
810
+	/**
811
+	 * This method retrieves the expected data handler for the message type and validates the generation data for that
812
+	 * data handler.
813
+	 *
814
+	 * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
815
+	 */
816
+	protected function _validate_and_setup_data()
817
+	{
818
+
819
+		//First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
820
+		//be used anyways.
821
+		if ($this->_error_msg) {
822
+			return false;
823
+		}
824
+
825
+		$generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
826
+
827
+		/** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
828
+		$data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
829
+			? $this->_generation_queue->get_message_repository()->get_data_handler()
830
+			: 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
831
+
832
+		//If this EE_Message is for a preview, then let's switch out to the preview data handler.
833
+		if ($this->_generation_queue->get_message_repository()->is_preview()) {
834
+			$data_handler_class_name = 'EE_Messages_Preview_incoming_data';
835
+		}
836
+
837
+		//First get the class name for the data handler (and also verifies it exists.
838
+		if (! class_exists($data_handler_class_name)) {
839
+			$this->_error_msg[] = sprintf(
840
+				esc_html__(
841
+					'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
842
+					'event_espresso'
843
+				),
844
+				'EE_Messages_incoming_data',
845
+				$data_handler_class_name
846
+			);
847
+			return false;
848
+		}
849
+
850
+		//convert generation_data for data_handler_instantiation.
851
+		$generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
852
+
853
+		//note, this may set error messages as well.
854
+		$this->_set_data_handler($generation_data, $data_handler_class_name);
855
+
856
+		return empty($this->_error_msg);
857
+	}
858
+
859
+
860
+	/**
861
+	 * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
862
+	 * adds it to the _data repository.
863
+	 *
864
+	 * @param mixed  $generating_data           This is data expected by the instantiated data handler.
865
+	 * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
866
+	 *                                          instantiated.
867
+	 * @return void .
868
+	 * @throws EE_Error
869
+	 * @throws ReflectionException
870
+	 */
871
+	protected function _set_data_handler($generating_data, $data_handler_class_name)
872
+	{
873
+		//valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
874
+		//is already a ready data handler in the repository.
875
+		$this->_current_data_handler = $this->_data_handler_collection->get_by_key(
876
+			$this->_data_handler_collection->get_key(
877
+				$data_handler_class_name,
878
+				$generating_data
879
+			)
880
+		);
881
+		if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
882
+			//no saved data_handler in the repo so let's set one up and add it to the repo.
883
+			try {
884
+				$this->_current_data_handler = new $data_handler_class_name($generating_data);
885
+				$this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
886
+			} catch (EE_Error $e) {
887
+				$this->_error_msg[] = $e->get_error();
888
+			}
889
+		}
890
+	}
891
+
892
+
893
+	/**
894
+	 * The queued EE_Message for generation does not save the data used for generation as objects
895
+	 * because serialization of those objects could be problematic if the data is saved to the db.
896
+	 * So this method calls the static method on the associated data_handler for the given message_type
897
+	 * and that preps the data for later instantiation when generating.
898
+	 *
899
+	 * @param EE_Message_To_Generate $message_to_generate
900
+	 * @param bool                   $preview Indicate whether this is being used for a preview or not.
901
+	 * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
902
+	 */
903
+	protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
904
+	{
905
+		/** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
906
+		$data_handler = $message_to_generate->get_data_handler_class_name($preview);
907
+		if (! $message_to_generate->valid()) {
908
+			return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
909
+		}
910
+		return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
911
+	}
912
+
913
+
914
+	/**
915
+	 * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
916
+	 *
917
+	 * @param EE_Message_To_Generate $message_to_generate
918
+	 * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
919
+	 */
920
+	public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
921
+	{
922
+		//prep data
923
+		$data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
924
+
925
+		$message = $message_to_generate->get_EE_Message();
926
+
927
+		//is there a GRP_ID in the request?
928
+		if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
929
+			$message->set_GRP_ID($GRP_ID);
930
+		}
931
+
932
+		if ($data === false) {
933
+			$message->set_STS_ID(EEM_Message::status_failed);
934
+			$message->set_error_message(
935
+				esc_html__(
936
+					'Unable to prepare data for persistence to the database.',
937
+					'event_espresso'
938
+				)
939
+			);
940
+		} else {
941
+			//make sure that the data handler is cached on the message as well
942
+			$data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
943
+		}
944
+
945
+		$this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
946
+	}
947 947
 }
Please login to merge, or discard this patch.
Spacing   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -254,7 +254,7 @@  discard block
 block discarded – undo
254 254
     {
255 255
         //double check verification has run and that everything is ready to work with (saves us having to validate
256 256
         // everything again).
257
-        if (! $this->_verified) {
257
+        if ( ! $this->_verified) {
258 258
             return false; //get out because we don't have a valid setup to work with.
259 259
         }
260 260
 
@@ -271,7 +271,7 @@  discard block
 block discarded – undo
271 271
 
272 272
 
273 273
         //if no addressees then get out because there is nothing to generation (possible bad data).
274
-        if (! $this->_valid_addressees($addressees)) {
274
+        if ( ! $this->_valid_addressees($addressees)) {
275 275
             do_action(
276 276
                 'AHEE__EE_Messages_Generator___generate__invalid_addressees',
277 277
                 $this->_generation_queue->get_message_repository()->current(),
@@ -293,7 +293,7 @@  discard block
 block discarded – undo
293 293
         $message_template_group = $this->_get_message_template_group();
294 294
 
295 295
         //in the unlikely event there is no EE_Message_Template_Group available, get out!
296
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
296
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
297 297
             $this->_error_msg[] = esc_html__(
298 298
                 'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
299 299
                 'event_espresso'
@@ -395,7 +395,7 @@  discard block
 block discarded – undo
395 395
             //attempt to retrieve from repo first
396 396
             $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
397 397
             if ($message_template_group instanceof EE_Message_Template_Group) {
398
-                return $message_template_group;  //got it!
398
+                return $message_template_group; //got it!
399 399
             }
400 400
 
401 401
             //nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
@@ -491,7 +491,7 @@  discard block
 block discarded – undo
491 491
         );
492 492
 
493 493
         //if we don't have a group lets hit the db.
494
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
494
+        if ( ! $global_message_template_group instanceof EE_Message_Template_Group) {
495 495
             $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
496 496
                 array(
497 497
                     array(
@@ -548,7 +548,7 @@  discard block
 block discarded – undo
548 548
         $context_templates = $message_template_group->context_templates();
549 549
         foreach ($context_templates as $context => $template_fields) {
550 550
             foreach ($template_fields as $template_field => $template_obj) {
551
-                if (! $template_obj instanceof EE_Message_Template) {
551
+                if ( ! $template_obj instanceof EE_Message_Template) {
552 552
                     continue;
553 553
                 }
554 554
                 $templates[$template_field][$context] = $template_obj->get('MTP_content');
@@ -576,7 +576,7 @@  discard block
 block discarded – undo
576 576
     {
577 577
 
578 578
         //if templates are empty then get out because we can't generate anything.
579
-        if (! $templates) {
579
+        if ( ! $templates) {
580 580
             $this->_error_msg[] = esc_html__(
581 581
                 'Unable to assemble messages because there are no templates retrieved for generating the messages with',
582 582
                 'event_espresso'
@@ -675,7 +675,7 @@  discard block
 block discarded – undo
675 675
             $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
676 676
             if (isset($templates[$field][$context])) {
677 677
                 //prefix field.
678
-                $column_name = 'MSG_' . $field;
678
+                $column_name = 'MSG_'.$field;
679 679
                 try {
680 680
                     $content = $this->_shortcode_parser->parse_message_template(
681 681
                         $templates[$field][$context],
@@ -742,13 +742,13 @@  discard block
 block discarded – undo
742 742
      */
743 743
     protected function _valid_addressees($addressees)
744 744
     {
745
-        if (! $addressees || ! is_array($addressees)) {
745
+        if ( ! $addressees || ! is_array($addressees)) {
746 746
             return false;
747 747
         }
748 748
 
749 749
         foreach ($addressees as $addressee_array) {
750 750
             foreach ($addressee_array as $addressee) {
751
-                if (! $addressee instanceof EE_Messages_Addressee) {
751
+                if ( ! $addressee instanceof EE_Messages_Addressee) {
752 752
                     return false;
753 753
                 }
754 754
             }
@@ -790,7 +790,7 @@  discard block
 block discarded – undo
790 790
         /**
791 791
          * Check if there is any generation data, but only if this is not for a preview.
792 792
          */
793
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
793
+        if ( ! $this->_generation_queue->get_message_repository()->get_generation_data()
794 794
             && (
795 795
                 ! $this->_generation_queue->get_message_repository()->is_preview()
796 796
                 && $this->_generation_queue->get_message_repository()->get_data_handler()
@@ -827,7 +827,7 @@  discard block
 block discarded – undo
827 827
         /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
828 828
         $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
829 829
             ? $this->_generation_queue->get_message_repository()->get_data_handler()
830
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
830
+            : 'EE_Messages_'.$this->_current_message_type->get_data_handler($generation_data).'_incoming_data';
831 831
 
832 832
         //If this EE_Message is for a preview, then let's switch out to the preview data handler.
833 833
         if ($this->_generation_queue->get_message_repository()->is_preview()) {
@@ -835,7 +835,7 @@  discard block
 block discarded – undo
835 835
         }
836 836
 
837 837
         //First get the class name for the data handler (and also verifies it exists.
838
-        if (! class_exists($data_handler_class_name)) {
838
+        if ( ! class_exists($data_handler_class_name)) {
839 839
             $this->_error_msg[] = sprintf(
840 840
                 esc_html__(
841 841
                     'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
@@ -878,7 +878,7 @@  discard block
 block discarded – undo
878 878
                 $generating_data
879 879
             )
880 880
         );
881
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
881
+        if ( ! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
882 882
             //no saved data_handler in the repo so let's set one up and add it to the repo.
883 883
             try {
884 884
                 $this->_current_data_handler = new $data_handler_class_name($generating_data);
@@ -904,7 +904,7 @@  discard block
 block discarded – undo
904 904
     {
905 905
         /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
906 906
         $data_handler = $message_to_generate->get_data_handler_class_name($preview);
907
-        if (! $message_to_generate->valid()) {
907
+        if ( ! $message_to_generate->valid()) {
908 908
             return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
909 909
         }
910 910
         return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
Please login to merge, or discard this patch.
acceptance_tests/tests/c-TestCustomMessageTemplateCept.php 1 patch
Indentation   +27 added lines, -27 removed lines patch added patch discarded remove patch
@@ -18,14 +18,14 @@  discard block
 block discarded – undo
18 18
 $event_one_link = $event_two_link = $event_three_link = '';
19 19
 
20 20
 $I->wantTo(
21
-    'Test that when registrations for multiple events are completed, and those events share the same custom'
22
-    . 'template, that that custom template will be used.'
21
+	'Test that when registrations for multiple events are completed, and those events share the same custom'
22
+	. 'template, that that custom template will be used.'
23 23
 );
24 24
 
25 25
 //need the MER plugin active for this test (we'll deactivate it after).
26 26
 $I->ensurePluginActive(
27
-    'event-espresso-mer-multi-event-registration',
28
-    'activated'
27
+	'event-espresso-mer-multi-event-registration',
28
+	'activated'
29 29
 );
30 30
 
31 31
 $I->loginAsAdmin();
@@ -83,9 +83,9 @@  discard block
 block discarded – undo
83 83
 
84 84
 
85 85
 $test_registration_details = array(
86
-    'fname' => 'CTGuy',
87
-    'lname' => 'Dude',
88
-    'email' => '[email protected]'
86
+	'fname' => 'CTGuy',
87
+	'lname' => 'Dude',
88
+	'email' => '[email protected]'
89 89
 );
90 90
 
91 91
 $I->amGoingTo('Register for Event One and Event Two and verify Custom Template A was used.');
@@ -111,24 +111,24 @@  discard block
 block discarded – undo
111 111
 $I->loginAsAdmin();
112 112
 $I->amOnMessagesActivityListTablePage();
113 113
 $I->viewMessageInMessagesListTableFor(
114
-    'Registration Approved',
115
-    MessagesAdmin::MESSAGE_STATUS_SENT,
116
-    'Email',
117
-    'Registrant'
114
+	'Registration Approved',
115
+	MessagesAdmin::MESSAGE_STATUS_SENT,
116
+	'Email',
117
+	'Registrant'
118 118
 );
119 119
 $I->seeTextInViewMessageModal($custom_template_a_label);
120 120
 //closes view window
121 121
 $I->click('#espresso-admin-page-overlay-dv');
122 122
 $I->deleteMessageInMessagesListTableFor(
123
-    'Registration Approved',
124
-    MessagesAdmin::MESSAGE_STATUS_SENT,
125
-    'Email',
126
-    'Registrant'
123
+	'Registration Approved',
124
+	MessagesAdmin::MESSAGE_STATUS_SENT,
125
+	'Email',
126
+	'Registrant'
127 127
 );
128 128
 
129 129
 //verify admin context
130 130
 $I->viewMessageInMessagesListTableFor(
131
-    'Registration Approved'
131
+	'Registration Approved'
132 132
 );
133 133
 $I->seeTextInViewMessageModal($custom_template_a_label);
134 134
 $I->click('#espresso-admin-page-overlay-dv');
@@ -157,10 +157,10 @@  discard block
 block discarded – undo
157 157
 $I->loginAsAdmin();
158 158
 $I->amOnMessagesActivityListTablePage();
159 159
 $I->viewMessageInMessagesListTableFor(
160
-    'Registration Approved',
161
-    MessagesAdmin::MESSAGE_STATUS_SENT,
162
-    'Email',
163
-    'Registrant'
160
+	'Registration Approved',
161
+	MessagesAdmin::MESSAGE_STATUS_SENT,
162
+	'Email',
163
+	'Registrant'
164 164
 );
165 165
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
166 166
 $I->dontSeeTextInViewMessageModal($custom_template_a_label);
@@ -168,15 +168,15 @@  discard block
 block discarded – undo
168 168
 //closes view window
169 169
 $I->click('#espresso-admin-page-overlay-dv');
170 170
 $I->deleteMessageInMessagesListTableFor(
171
-    'Registration Approved',
172
-    MessagesAdmin::MESSAGE_STATUS_SENT,
173
-    'Email',
174
-    'Registrant'
171
+	'Registration Approved',
172
+	MessagesAdmin::MESSAGE_STATUS_SENT,
173
+	'Email',
174
+	'Registrant'
175 175
 );
176 176
 
177 177
 //verify admin context
178 178
 $I->viewMessageInMessagesListTableFor(
179
-    'Registration Approved'
179
+	'Registration Approved'
180 180
 );
181 181
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
182 182
 $I->dontSee($custom_template_a_label);
@@ -188,6 +188,6 @@  discard block
 block discarded – undo
188 188
 
189 189
 //deactivate MER plugin so its not active for future tests
190 190
 $I->ensurePluginDeactivated(
191
-    'event-espresso-mer-multi-event-registration',
192
-    'Plugin deactivated'
191
+	'event-espresso-mer-multi-event-registration',
192
+	'Plugin deactivated'
193 193
 );
194 194
\ No newline at end of file
Please login to merge, or discard this patch.
core/libraries/messages/EE_Message_Template_Group_Collection.lib.php 2 patches
Indentation   +100 added lines, -100 removed lines patch added patch discarded remove patch
@@ -14,115 +14,115 @@
 block discarded – undo
14 14
 {
15 15
 
16 16
 
17
-    /**
18
-     * EE_Message_Template_Group_Collection constructor.
19
-     */
20
-    public function __construct()
21
-    {
22
-        $this->interface = 'EE_Message_Template_Group';
23
-    }
17
+	/**
18
+	 * EE_Message_Template_Group_Collection constructor.
19
+	 */
20
+	public function __construct()
21
+	{
22
+		$this->interface = 'EE_Message_Template_Group';
23
+	}
24 24
 
25 25
 
26
-    /**
27
-     * Adds the Message Template Group object to the repository.
28
-     *
29
-     * @param           $message_template_group
30
-     * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
31
-     *                         indexing the template by key.  If this template is shared among multiple events then
32
-     *                         include the events as an array.
33
-     * @return bool
34
-     */
35
-    public function add($message_template_group, $EVT_ID = array())
36
-    {
37
-        $EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
38
-        if ($message_template_group instanceof $this->interface) {
39
-            $data['key'] = $this->getKey(
40
-                $message_template_group->messenger(),
41
-                $message_template_group->message_type(),
42
-                $EVT_ID
43
-            );
44
-            return parent::add($message_template_group, $data);
45
-        }
46
-        return false;
47
-    }
26
+	/**
27
+	 * Adds the Message Template Group object to the repository.
28
+	 *
29
+	 * @param           $message_template_group
30
+	 * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
31
+	 *                         indexing the template by key.  If this template is shared among multiple events then
32
+	 *                         include the events as an array.
33
+	 * @return bool
34
+	 */
35
+	public function add($message_template_group, $EVT_ID = array())
36
+	{
37
+		$EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
38
+		if ($message_template_group instanceof $this->interface) {
39
+			$data['key'] = $this->getKey(
40
+				$message_template_group->messenger(),
41
+				$message_template_group->message_type(),
42
+				$EVT_ID
43
+			);
44
+			return parent::add($message_template_group, $data);
45
+		}
46
+		return false;
47
+	}
48 48
 
49 49
 
50
-    /**
51
-     * This retrieves any EE_Message_Template_Group in the repo by its ID.
52
-     *
53
-     * @param $GRP_ID
54
-     * @return EE_Message_Template_Group | null
55
-     */
56
-    public function get_by_ID($GRP_ID)
57
-    {
58
-        $this->rewind();
59
-        while ($this->valid()) {
60
-            if ($this->current()->ID() === $GRP_ID) {
61
-                /** @var EE_Message_Template_Group $message_template_group */
62
-                $message_template_group = $this->current();
63
-                $this->rewind();
64
-                return $message_template_group;
65
-            }
66
-            $this->next();
67
-        }
68
-        return null;
69
-    }
50
+	/**
51
+	 * This retrieves any EE_Message_Template_Group in the repo by its ID.
52
+	 *
53
+	 * @param $GRP_ID
54
+	 * @return EE_Message_Template_Group | null
55
+	 */
56
+	public function get_by_ID($GRP_ID)
57
+	{
58
+		$this->rewind();
59
+		while ($this->valid()) {
60
+			if ($this->current()->ID() === $GRP_ID) {
61
+				/** @var EE_Message_Template_Group $message_template_group */
62
+				$message_template_group = $this->current();
63
+				$this->rewind();
64
+				return $message_template_group;
65
+			}
66
+			$this->next();
67
+		}
68
+		return null;
69
+	}
70 70
 
71 71
 
72
-    /**
73
-     * Generates a hash used to identify a given Message Template Group.
74
-     *
75
-     * @param string $messenger    The EE_messenger->name
76
-     * @param string $message_type The EE_message_type->name
77
-     * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
78
-     * @deprecated 4.9.40.rc.017  Use getKey instead.
79
-     * @return string
80
-     */
81
-    public function get_key($messenger, $message_type, $EVT_ID = 0)
82
-    {
83
-        $EVT_ID = (array) $EVT_ID;
84
-        return $this->getKey($messenger, $message_type, $EVT_ID);
85
-    }
72
+	/**
73
+	 * Generates a hash used to identify a given Message Template Group.
74
+	 *
75
+	 * @param string $messenger    The EE_messenger->name
76
+	 * @param string $message_type The EE_message_type->name
77
+	 * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
78
+	 * @deprecated 4.9.40.rc.017  Use getKey instead.
79
+	 * @return string
80
+	 */
81
+	public function get_key($messenger, $message_type, $EVT_ID = 0)
82
+	{
83
+		$EVT_ID = (array) $EVT_ID;
84
+		return $this->getKey($messenger, $message_type, $EVT_ID);
85
+	}
86 86
 
87 87
 
88
-    /**
89
-     * Generates a hash used to identify a given Message Template Group
90
-     * @param string    $messenger      The EE_messenger->name
91
-     * @param string    $message_type   The EE_message_type->name
92
-     * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
93
-     *                                  be included.
94
-     * @since 4.9.40.rc.017
95
-     * @return string
96
-     */
97
-    public function getKey($messenger, $message_type, array $EVT_ID = array())
98
-    {
99
-        sort($EVT_ID);
100
-        $EVT_ID = implode(',', array_unique($EVT_ID));
101
-        return md5($messenger . $message_type . $EVT_ID);
102
-    }
88
+	/**
89
+	 * Generates a hash used to identify a given Message Template Group
90
+	 * @param string    $messenger      The EE_messenger->name
91
+	 * @param string    $message_type   The EE_message_type->name
92
+	 * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
93
+	 *                                  be included.
94
+	 * @since 4.9.40.rc.017
95
+	 * @return string
96
+	 */
97
+	public function getKey($messenger, $message_type, array $EVT_ID = array())
98
+	{
99
+		sort($EVT_ID);
100
+		$EVT_ID = implode(',', array_unique($EVT_ID));
101
+		return md5($messenger . $message_type . $EVT_ID);
102
+	}
103 103
 
104 104
 
105
-    /**
106
-     * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
107
-     * the given string.
108
-     *
109
-     * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
110
-     * @return null|EE_Message_Template_Group
111
-     */
112
-    public function get_by_key($key)
113
-    {
114
-        $this->rewind();
115
-        while ($this->valid()) {
116
-            $data = $this->getInfo();
117
-            if (isset($data['key']) && $data['key'] === $key) {
118
-                /** @var EE_Message_Template_Group $message_template_group */
119
-                $message_template_group = $this->current();
120
-                $this->rewind();
121
-                return $message_template_group;
122
-            }
123
-            $this->next();
124
-        }
125
-        return null;
126
-    }
105
+	/**
106
+	 * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
107
+	 * the given string.
108
+	 *
109
+	 * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
110
+	 * @return null|EE_Message_Template_Group
111
+	 */
112
+	public function get_by_key($key)
113
+	{
114
+		$this->rewind();
115
+		while ($this->valid()) {
116
+			$data = $this->getInfo();
117
+			if (isset($data['key']) && $data['key'] === $key) {
118
+				/** @var EE_Message_Template_Group $message_template_group */
119
+				$message_template_group = $this->current();
120
+				$this->rewind();
121
+				return $message_template_group;
122
+			}
123
+			$this->next();
124
+		}
125
+		return null;
126
+	}
127 127
 
128 128
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -98,7 +98,7 @@
 block discarded – undo
98 98
     {
99 99
         sort($EVT_ID);
100 100
         $EVT_ID = implode(',', array_unique($EVT_ID));
101
-        return md5($messenger . $message_type . $EVT_ID);
101
+        return md5($messenger.$message_type.$EVT_ID);
102 102
     }
103 103
 
104 104
 
Please login to merge, or discard this patch.
espresso.php 1 patch
Indentation   +219 added lines, -219 removed lines patch added patch discarded remove patch
@@ -1,5 +1,5 @@  discard block
 block discarded – undo
1 1
 <?php if ( ! defined('ABSPATH')) {
2
-    exit('No direct script access allowed');
2
+	exit('No direct script access allowed');
3 3
 }
4 4
 /*
5 5
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@  discard block
 block discarded – undo
40 40
  * @since            4.0
41 41
  */
42 42
 if (function_exists('espresso_version')) {
43
-    /**
44
-     *    espresso_duplicate_plugin_error
45
-     *    displays if more than one version of EE is activated at the same time
46
-     */
47
-    function espresso_duplicate_plugin_error()
48
-    {
49
-        ?>
43
+	/**
44
+	 *    espresso_duplicate_plugin_error
45
+	 *    displays if more than one version of EE is activated at the same time
46
+	 */
47
+	function espresso_duplicate_plugin_error()
48
+	{
49
+		?>
50 50
         <div class="error">
51 51
             <p>
52 52
                 <?php echo esc_html__(
53
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
-                        'event_espresso'
55
-                ); ?>
53
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
54
+						'event_espresso'
55
+				); ?>
56 56
             </p>
57 57
         </div>
58 58
         <?php
59
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
60
-    }
59
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
60
+	}
61 61
 
62
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
62
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
63 63
 } else {
64
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
65
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
-        /**
67
-         * espresso_minimum_php_version_error
68
-         *
69
-         * @return void
70
-         */
71
-        function espresso_minimum_php_version_error()
72
-        {
73
-            ?>
64
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
65
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
66
+		/**
67
+		 * espresso_minimum_php_version_error
68
+		 *
69
+		 * @return void
70
+		 */
71
+		function espresso_minimum_php_version_error()
72
+		{
73
+			?>
74 74
             <div class="error">
75 75
                 <p>
76 76
                     <?php
77
-                    printf(
78
-                            esc_html__(
79
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
-                                    'event_espresso'
81
-                            ),
82
-                            EE_MIN_PHP_VER_REQUIRED,
83
-                            PHP_VERSION,
84
-                            '<br/>',
85
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
-                    );
87
-                    ?>
77
+					printf(
78
+							esc_html__(
79
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
80
+									'event_espresso'
81
+							),
82
+							EE_MIN_PHP_VER_REQUIRED,
83
+							PHP_VERSION,
84
+							'<br/>',
85
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
86
+					);
87
+					?>
88 88
                 </p>
89 89
             </div>
90 90
             <?php
91
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
92
-        }
91
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
92
+		}
93 93
 
94
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
-    } else {
96
-        /**
97
-         * espresso_version
98
-         * Returns the plugin version
99
-         *
100
-         * @return string
101
-         */
102
-        function espresso_version()
103
-        {
104
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.42.rc.002');
105
-        }
94
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
95
+	} else {
96
+		/**
97
+		 * espresso_version
98
+		 * Returns the plugin version
99
+		 *
100
+		 * @return string
101
+		 */
102
+		function espresso_version()
103
+		{
104
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.42.rc.002');
105
+		}
106 106
 
107
-        // define versions
108
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
109
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
110
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
111
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
112
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
113
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
114
-        if ( ! defined('DS')) {
115
-            define('DS', '/');
116
-        }
117
-        if ( ! defined('PS')) {
118
-            define('PS', PATH_SEPARATOR);
119
-        }
120
-        if ( ! defined('SP')) {
121
-            define('SP', ' ');
122
-        }
123
-        if ( ! defined('EENL')) {
124
-            define('EENL', "\n");
125
-        }
126
-        define('EE_SUPPORT_EMAIL', '[email protected]');
127
-        // define the plugin directory and URL
128
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
129
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
130
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
131
-        // main root folder paths
132
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
133
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
134
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
135
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
136
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
137
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
138
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
139
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
140
-        // core system paths
141
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
142
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
143
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
144
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
145
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
146
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
147
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
148
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
149
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
150
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
151
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
152
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
153
-        // gateways
154
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
155
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
156
-        // asset URL paths
157
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
158
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
159
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
160
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
161
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
162
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
163
-        // define upload paths
164
-        $uploads = wp_upload_dir();
165
-        // define the uploads directory and URL
166
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
167
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
168
-        // define the templates directory and URL
169
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
170
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
171
-        // define the gateway directory and URL
172
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
173
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
174
-        // languages folder/path
175
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
176
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
177
-        //check for dompdf fonts in uploads
178
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
179
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
180
-        }
181
-        //ajax constants
182
-        define(
183
-                'EE_FRONT_AJAX',
184
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
185
-        );
186
-        define(
187
-                'EE_ADMIN_AJAX',
188
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
189
-        );
190
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
191
-        //you're better to use this than its straight value (currently -1) in case you ever
192
-        //want to change its default value! or find when -1 means infinity
193
-        define('EE_INF_IN_DB', -1);
194
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
195
-        define('EE_DEBUG', false);
196
-        // for older WP versions
197
-        if ( ! defined('MONTH_IN_SECONDS')) {
198
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
199
-        }
200
-        /**
201
-         *    espresso_plugin_activation
202
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
203
-         */
204
-        function espresso_plugin_activation()
205
-        {
206
-            update_option('ee_espresso_activation', true);
207
-        }
107
+		// define versions
108
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
109
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
110
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
111
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
112
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
113
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
114
+		if ( ! defined('DS')) {
115
+			define('DS', '/');
116
+		}
117
+		if ( ! defined('PS')) {
118
+			define('PS', PATH_SEPARATOR);
119
+		}
120
+		if ( ! defined('SP')) {
121
+			define('SP', ' ');
122
+		}
123
+		if ( ! defined('EENL')) {
124
+			define('EENL', "\n");
125
+		}
126
+		define('EE_SUPPORT_EMAIL', '[email protected]');
127
+		// define the plugin directory and URL
128
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
129
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
130
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
131
+		// main root folder paths
132
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
133
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
134
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
135
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
136
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
137
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
138
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
139
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
140
+		// core system paths
141
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
142
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
143
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
144
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
145
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
146
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
147
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
148
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
149
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
150
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
151
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
152
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
153
+		// gateways
154
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
155
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
156
+		// asset URL paths
157
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
158
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
159
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
160
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
161
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
162
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
163
+		// define upload paths
164
+		$uploads = wp_upload_dir();
165
+		// define the uploads directory and URL
166
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
167
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
168
+		// define the templates directory and URL
169
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
170
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
171
+		// define the gateway directory and URL
172
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
173
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
174
+		// languages folder/path
175
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
176
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
177
+		//check for dompdf fonts in uploads
178
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
179
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
180
+		}
181
+		//ajax constants
182
+		define(
183
+				'EE_FRONT_AJAX',
184
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
185
+		);
186
+		define(
187
+				'EE_ADMIN_AJAX',
188
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
189
+		);
190
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
191
+		//you're better to use this than its straight value (currently -1) in case you ever
192
+		//want to change its default value! or find when -1 means infinity
193
+		define('EE_INF_IN_DB', -1);
194
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
195
+		define('EE_DEBUG', false);
196
+		// for older WP versions
197
+		if ( ! defined('MONTH_IN_SECONDS')) {
198
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
199
+		}
200
+		/**
201
+		 *    espresso_plugin_activation
202
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
203
+		 */
204
+		function espresso_plugin_activation()
205
+		{
206
+			update_option('ee_espresso_activation', true);
207
+		}
208 208
 
209
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
210
-        /**
211
-         *    espresso_load_error_handling
212
-         *    this function loads EE's class for handling exceptions and errors
213
-         */
214
-        function espresso_load_error_handling()
215
-        {
216
-            // load debugging tools
217
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
218
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
219
-                EEH_Debug_Tools::instance();
220
-            }
221
-            // load error handling
222
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
223
-                require_once(EE_CORE . 'EE_Error.core.php');
224
-            } else {
225
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
226
-            }
227
-        }
209
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
210
+		/**
211
+		 *    espresso_load_error_handling
212
+		 *    this function loads EE's class for handling exceptions and errors
213
+		 */
214
+		function espresso_load_error_handling()
215
+		{
216
+			// load debugging tools
217
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
218
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
219
+				EEH_Debug_Tools::instance();
220
+			}
221
+			// load error handling
222
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
223
+				require_once(EE_CORE . 'EE_Error.core.php');
224
+			} else {
225
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
226
+			}
227
+		}
228 228
 
229
-        /**
230
-         *    espresso_load_required
231
-         *    given a class name and path, this function will load that file or throw an exception
232
-         *
233
-         * @param    string $classname
234
-         * @param    string $full_path_to_file
235
-         * @throws    EE_Error
236
-         */
237
-        function espresso_load_required($classname, $full_path_to_file)
238
-        {
239
-            static $error_handling_loaded = false;
240
-            if ( ! $error_handling_loaded) {
241
-                espresso_load_error_handling();
242
-                $error_handling_loaded = true;
243
-            }
244
-            if (is_readable($full_path_to_file)) {
245
-                require_once($full_path_to_file);
246
-            } else {
247
-                throw new EE_Error (
248
-                        sprintf(
249
-                                esc_html__(
250
-                                        'The %s class file could not be located or is not readable due to file permissions.',
251
-                                        'event_espresso'
252
-                                ),
253
-                                $classname
254
-                        )
255
-                );
256
-            }
257
-        }
229
+		/**
230
+		 *    espresso_load_required
231
+		 *    given a class name and path, this function will load that file or throw an exception
232
+		 *
233
+		 * @param    string $classname
234
+		 * @param    string $full_path_to_file
235
+		 * @throws    EE_Error
236
+		 */
237
+		function espresso_load_required($classname, $full_path_to_file)
238
+		{
239
+			static $error_handling_loaded = false;
240
+			if ( ! $error_handling_loaded) {
241
+				espresso_load_error_handling();
242
+				$error_handling_loaded = true;
243
+			}
244
+			if (is_readable($full_path_to_file)) {
245
+				require_once($full_path_to_file);
246
+			} else {
247
+				throw new EE_Error (
248
+						sprintf(
249
+								esc_html__(
250
+										'The %s class file could not be located or is not readable due to file permissions.',
251
+										'event_espresso'
252
+								),
253
+								$classname
254
+						)
255
+				);
256
+			}
257
+		}
258 258
 
259
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
260
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
261
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
262
-        new EE_Bootstrap();
263
-    }
259
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
260
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
261
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
262
+		new EE_Bootstrap();
263
+	}
264 264
 }
265 265
 if ( ! function_exists('espresso_deactivate_plugin')) {
266
-    /**
267
-     *    deactivate_plugin
268
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
269
-     *
270
-     * @access public
271
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
272
-     * @return    void
273
-     */
274
-    function espresso_deactivate_plugin($plugin_basename = '')
275
-    {
276
-        if ( ! function_exists('deactivate_plugins')) {
277
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
278
-        }
279
-        unset($_GET['activate'], $_REQUEST['activate']);
280
-        deactivate_plugins($plugin_basename);
281
-    }
266
+	/**
267
+	 *    deactivate_plugin
268
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
269
+	 *
270
+	 * @access public
271
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
272
+	 * @return    void
273
+	 */
274
+	function espresso_deactivate_plugin($plugin_basename = '')
275
+	{
276
+		if ( ! function_exists('deactivate_plugins')) {
277
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
278
+		}
279
+		unset($_GET['activate'], $_REQUEST['activate']);
280
+		deactivate_plugins($plugin_basename);
281
+	}
282 282
 }
283 283
\ No newline at end of file
Please login to merge, or discard this patch.