PluginProbe
Double Opt-In for Contact Form 7 – Secure, GDPR-Compliant Email Verification / 5.6.2
Double Opt-In for Contact Form 7 – Secure, GDPR-Compliant Email Verification v5.6.2
5.6.2 5.6.3 5.6.1 5.6.0 5.5.0 5.4.0 5.3.2 5.3.1 5.1.6 5.1.5 trunk 2.1.5 2.11 2.12 2.13 2.15 3.0.0 3.0.1 3.0.2 3.0.3 3.0.5 3.0.51 3.0.60 3.0.61 3.0.62 All 38 releases
← All changes | core/OptIn.class.php +819 -865 2.15 → 5.6.2 View file →
@@ -1,865 +1,819 @@
1 -<?php
2 -
3 -namespace forge12\contactform7\CF7DoubleOptIn {
4 - if (!defined('ABSPATH')) {
5 - exit;
6 - }
7 -
8 - /**
9 - * Class Frontend
10 - * Responsible to handle the frontend of the Double OptIn
11 - *
12 - * @package forge12\contactform7\CF7DoubleOptIn
13 - */
14 - class OptIn
15 - {
16 - /**
17 - * Stores the DB ID for the entry
18 - *
19 - * @var int
20 - */
21 - private $id = 0;
22 -
23 - /**
24 - * Stores the ID of the contact form 7 form.
25 - *
26 - * @var int
27 - */
28 - private $cf_form_id = 0;
29 - /**
30 - * Stores if the optin has been confirmed (1) or not (0)
31 - *
32 - * @var int
33 - */
34 - private $doubleoptin = 0;
35 - /**
36 - * Stores the content of the contact form 7 form content as a serialized string.
37 - *
38 - * @var string
39 - */
40 - private $content = "";
41 - /**
42 - * Stores the unique hash used to identify the opt-ins
43 - *
44 - * @var string
45 - */
46 - private $hash = "";
47 - /**
48 - * Stores the timestamp the opt-in mail has been sent to the user.
49 - *
50 - * @var string
51 - */
52 - private $createtime = "";
53 - /**
54 - * Stores the timestamp the opt-in has been confirmed by the user.
55 - */
56 - private $updatetime = "";
57 - /**
58 - * IP Address used to trigger the opt-in mail.
59 - *
60 - * @var string
61 - */
62 - private $ipaddr_register = "";
63 - /**
64 - * IP Address used to confirm the opt-in mail.
65 - */
66 - private $ipaddr_confirmation = "";
67 - /**
68 - * Stores the files used within this form as a serialized string.
69 - */
70 - private $files = "";
71 - /**
72 - * Store the Category ID
73 - */
74 - private $category = 0;
75 - /**
76 - * Stores the form as html
77 - */
78 - private $form = '';
79 - /**
80 - * Stores the Mail send for the optin
81 - *
82 - * @var string
83 - */
84 - private $mail_optin = '';
85 - /**
86 - * Stores the E-Mail
87 - *
88 - * @var string
89 - */
90 - private $email = '';
91 -
92 - /**
93 - * The constructor
94 - */
95 - public function __construct(array $properties)
96 - {
97 - foreach ($properties as $name => $value) {
98 - if (isset($this->{$name})) {
99 - $this->{$name} = $value;
100 - }
101 - }
102 - }
103 -
104 - /**
105 - * @param int $cf_form_id
106 - */
107 - public function set_cf_form_id($cf_form_id)
108 - {
109 - $this->cf_form_id = (int)$cf_form_id;
110 - }
111 -
112 - /**
113 - * @return int
114 - */
115 - public function get_cf_form_id()
116 - {
117 - return $this->cf_form_id;
118 - }
119 -
120 - /**
121 - * Return the ID of the Optin
122 - *
123 - * @return int
124 - */
125 - public function get_id()
126 - {
127 - return $this->id;
128 - }
129 -
130 - /**
131 - * Return the hash of the optin.
132 - *
133 - * @return string
134 - */
135 - public function get_hash()
136 - {
137 - return $this->hash;
138 - }
139 -
140 - /**
141 - * Return true|false depending on confirm status
142 - *
143 - * @return bool
144 - */
145 - public function is_confirmed()
146 - {
147 - return (bool)$this->get_doubleoptin();
148 - }
149 -
150 - /**
151 - * update the optin value
152 - *
153 - * @param int $confirmed
154 - */
155 - public function set_doubleoptin($confirmed)
156 - {
157 - $this->doubleoptin = (int)$confirmed;
158 - }
159 -
160 - /**
161 - * Return the optin value for the form.
162 - *
163 - * @return int
164 - */
165 - public function get_doubleoptin()
166 - {
167 - return $this->doubleoptin;
168 - }
169 -
170 - /**
171 - * @param string $timestamp
172 - */
173 - public function set_createtime($timestamp)
174 - {
175 - $this->createtime = $timestamp;
176 - }
177 -
178 - /**
179 - * Return the Date how long the opt in will be valid
180 - * @return string
181 - */
182 - public function get_valid_until(){
183 - $settings = CF7DoubleOptIn::getInstance()->getSettings();
184 -
185 - $createtime = $this->get_createtime();
186 - $dt = new \DateTime();
187 - $dt->setTimestamp($createtime);
188 -
189 - if($this->is_confirmed()){
190 - $month = (int)$settings['delete'];
191 - $period = $settings['delete_period'];
192 - }else{
193 - $month = (int)$settings['delete_unconfirmed'];
194 - $period = $settings['delete_unconfirmed_period'];
195 - }
196 -
197 - $dt->modify('+'.(int)$month.' '.$period);
198 - $dt->modify('+1 day');
199 -
200 - return $dt->format('d.m.Y');
201 - }
202 -
203 - /**
204 - * Return a timestamp
205 - *
206 - * @param string $view Select how to return the content. raw is the stored db value. use formatted to return a
207 - * formatted string.
208 - *
209 - * @return string
210 - */
211 - public function get_createtime($view = "raw")
212 - {
213 - if ($view != "raw") {
214 - if (!is_numeric($this->createtime)) {
215 - $date = date('d.m.Y', strtotime($this->createtime));
216 - $time = date('H:i:s', strtotime($this->createtime));
217 - } else {
218 - $date = date('d.m.Y', $this->createtime);
219 - $time = date('H:i:s', $this->createtime);
220 - }
221 -
222 - return $date . ' ' . __('/', 'double-opt-in') . ' ' . $time;
223 - } else {
224 - return $this->createtime;
225 - }
226 - }
227 -
228 - /**
229 - * @param string $timestamp
230 - */
231 - public function set_updatetime($timestamp)
232 - {
233 - $this->updatetime = $timestamp;
234 - }
235 -
236 - /**
237 - * Return a timestamp
238 - *
239 - * @param string $view Select how to return the content. raw is the stored db value. use formatted to return a
240 - * formatted string.
241 - *
242 - * @return string
243 - */
244 - public function get_updatetime($view = 'raw')
245 - {
246 - if ($view != "raw") {
247 - if (!is_numeric($this->updatetime)) {
248 - $date = date('d.m.Y', strtotime($this->updatetime));
249 - $time = date('H:i:s', strtotime($this->updatetime));
250 - } else {
251 - $date = date('d.m.Y', $this->updatetime);
252 - $time = date('H:i:s', $this->updatetime);
253 - }
254 - return $date . ' ' . __('/', 'double-opt-in') . ' ' . $time;
255 - } else {
256 - return $this->updatetime;
257 - }
258 - }
259 -
260 - /**
261 - * @param string $ip_addr
262 - */
263 - public function set_ipaddr_register($ip_addr)
264 - {
265 - $this->ipaddr_register = $ip_addr;
266 - }
267 -
268 - /**
269 - * @return string
270 - */
271 - public function get_ipaddr_register()
272 - {
273 - return $this->ipaddr_register;
274 - }
275 -
276 - /**
277 - * @param string $ip_addr
278 - */
279 - public function set_ipaddr_confirmation($ip_addr)
280 - {
281 - $this->ipaddr_confirmation = $ip_addr;
282 - }
283 -
284 - /**
285 - * @return string
286 - */
287 - public function get_ipaddr_confirmation()
288 - {
289 - return $this->ipaddr_confirmation;
290 - }
291 -
292 - /**
293 - * Return a serialized string
294 - *
295 - * @return mixed
296 - */
297 - public function get_content()
298 - {
299 - return $this->content;
300 - }
301 -
302 - /**
303 - * @param string - a serialized string
304 - */
305 - public function set_content($content)
306 - {
307 - $this->content = $content;
308 - }
309 -
310 - /**
311 - * @param string - a serialized string
312 - */
313 - public function set_files($files)
314 - {
315 - $this->files = $files;
316 - }
317 -
318 - /**
319 - * @return string use maybe_unserialize to deserialize the string
320 - */
321 - public function get_files()
322 - {
323 - return $this->files;
324 - }
325 -
326 - /**
327 - * Return the assigned Category ID
328 - *
329 - * @return int
330 - */
331 - public function get_category()
332 - {
333 - if (!is_numeric($this->category)) {
334 - return 0;
335 - }
336 - return $this->category;
337 - }
338 -
339 - /**
340 - * Assign a ID to the category
341 - *
342 - * @param int $id
343 - *
344 - * @return void
345 - */
346 - public function set_category($id)
347 - {
348 - $this->category = $id;
349 - }
350 -
351 - /**
352 - * Check if the given Opt In was created by Contact Form 7
353 - *
354 - * @return bool
355 - */
356 - public function isTypeCF7()
357 - {
358 - $form_id = $this->get_cf_form_id();
359 - if (class_exists('\WPCF7_ContactForm')) {
360 - $form = \WPCF7_ContactForm::get_instance($form_id);
361 -
362 - if ($form) {
363 - return true;
364 - }
365 - }
366 - return false;
367 - }
368 -
369 - /**
370 - * Check if the given Opt In was created by Avada
371 - *
372 - * @return bool|void
373 - */
374 - public function isTypeAvada()
375 - {
376 - $form_id = $this->get_cf_form_id();
377 - if (function_exists('Avada')) {
378 - $form = get_post($form_id);
379 - if ($form) {
380 - return true;
381 - }
382 - }
383 - }
384 -
385 - /**
386 - * Check if the Opt In was created by 'cf7' or 'avada'.
387 - *
388 - * @param string $type use either 'cf7' or 'avada'
389 - *
390 - * @return bool
391 - */
392 - public function isType($type)
393 - {
394 - if ($type == 'cf7') {
395 - return $this->isTypeCF7();
396 - } else {
397 - return (!$this->isTypeCF7() && $this->isTypeAvada());
398 - }
399 - }
400 -
401 - /**
402 - * Load an OptIn by the given hash code. Returns either an Object of Type OptIn or null if not found.
403 - *
404 - * @param string $hash
405 - *
406 - * @return OptIn|null
407 - */
408 - public static function get_by_hash(string $hash)
409 - {
410 - global $wpdb;
411 - $table = $wpdb->prefix . 'f12_cf7_doubleoptin';
412 -
413 - if (null == $wpdb) {
414 - return null;
415 - }
416 -
417 - $row = $wpdb->get_row('SELECT * FROM ' . $table . ' WHERE hash="' . $hash . '"', ARRAY_A);
418 -
419 - if (null == $row) {
420 - return null;
421 - }
422 -
423 - return new OptIn($row);
424 - }
425 -
426 - /**
427 - * Get number of optins for the given post.
428 - *
429 - * @param $post_id
430 - *
431 - * @return int
432 - */
433 - public static function get_count($post_id)
434 - {
435 - global $wpdb;
436 -
437 - if (!$wpdb) {
438 - return 0;
439 - }
440 -
441 - $tableName = $wpdb->prefix . 'f12_cf7_doubleoptin';
442 - $result = $wpdb->get_results($wpdb->prepare('SELECT count(*) AS counter FROM ' . $tableName . ' WHERE cf_form_id=%d ', $post_id));
443 -
444 - if (is_array($result)) {
445 - return $result[0]->counter;
446 - }
447 - return 0;
448 - }
449 -
450 - /**
451 - * Return a list of opt ins stored in the database.
452 - *
453 - * @param int $category_id
454 - *
455 - * @param array $atts array (
456 - * 'perPage' => 10, // Posts per page
457 - * 'page' => 0, // Current page
458 - * 'order' => DESC, // Order (ASC/DESC)
459 - * );
460 - *
461 - * @param null $numberOfPages - Stores the number of pages found if limited
462 - *
463 - * @return array
464 - */
465 - public static function get_list_by_category_id($category_id, $atts = array(), &$numberOfPages = null)
466 - {
467 - global $wpdb;
468 -
469 - $attr = array(
470 - 'perPage' => 10,
471 - 'page' => 1,
472 - 'order' => 'DESC',
473 - 'keyword' => ''
474 - );
475 -
476 - /**
477 - * Parameter
478 - */
479 - foreach ($atts as $key => $value) {
480 - if (isset($attr[$key])) {
481 - $attr[$key] = $atts[$key];
482 - }
483 - }
484 -
485 - /*
486 - * Update keyword
487 - */
488 - $where = '';
489 - if (!empty($attr['keyword'])) {
490 - $where = ' AND content LIKE "%%' . $attr['keyword'] . '%%"';
491 - }
492 -
493 -
494 - $tableName = $wpdb->prefix . 'f12_cf7_doubleoptin';
495 - $pageNum = (int)$attr['page'] - 1;
496 -
497 - if ($numberOfPages !== null) {
498 - $result = $wpdb->get_results($wpdb->prepare('SELECT count(*) AS counter FROM ' . $tableName . ' WHERE category=%d ' . $where, $category_id));
499 -
500 - $itemCounter = 0;
501 -
502 - if (is_array($result)) {
503 - $itemCounter = $result[0]->counter;
504 - }
505 -
506 - $numberOfPages = 0;
507 -
508 - if ($itemCounter != 0) {
509 - $numberOfPages = ceil($itemCounter / (int)$attr['perPage']);
510 - }
511 - }
512 -
513 - $list = array();
514 -
515 - if ($numberOfPages == 0) {
516 - return $list;
517 - }
518 -
519 - $offset = $pageNum * (int)$attr['perPage'];
520 -
521 - $rows = $wpdb->get_results($wpdb->prepare('SELECT * FROM ' . $tableName . ' WHERE category=%d ' . $where . ' ORDER BY ID ' . $attr['order'] . ' LIMIT ' . $attr['perPage'] . ' OFFSET %d', $category_id, $offset), ARRAY_A);
522 -
523 - foreach ($rows as $row) {
524 - $list[] = new OptIn($row);
525 - }
526 - return $list;
527 - }
528 -
529 - /**
530 - * Return a list of opt ins stored in the database.
531 - *
532 - * @param string $email
533 - * @param int $confirmed Either recieve confirmed or unconfirmed only
534 - *
535 - * @return array
536 - */
537 - public static function get_list_by_email($email)
538 - {
539 - global $wpdb;
540 -
541 - $tableName = $wpdb->prefix . 'f12_cf7_doubleoptin';
542 -
543 - $list = array();
544 -
545 - $rows = $wpdb->get_results($wpdb->prepare('SELECT * FROM ' . $tableName . ' WHERE email=%s', $email), ARRAY_A);
546 -
547 - foreach ($rows as $row) {
548 - $list[] = new OptIn($row);
549 - }
550 - return $list;
551 - }
552 -
553 - /**
554 - * Return a list of opt ins stored in the database.
555 - *
556 - * @param $atts array (
557 - * 'perPage' => 10, // Posts per page
558 - * 'page' => 0, // Current page
559 - * 'order' => DESC, // Order (ASC/DESC)
560 - * );
561 - *
562 - * @param null $numberOfPages - Stores the number of pages found if limited
563 - *
564 - * @return array
565 - */
566 - public static function get_list($atts = array(), &$numberOfPages = null)
567 - {
568 - global $wpdb;
569 -
570 - $attr = array(
571 - 'perPage' => 10,
572 - 'page' => 1,
573 - 'order' => 'DESC',
574 - 'keyword' => '',
575 - 'cf_form_id' => '',
576 - );
577 -
578 - /*
579 - * Update atts
580 - */
581 - foreach ($atts as $key => $value) {
582 - if (isset($attr[$key])) {
583 - $attr[$key] = $atts[$key];
584 - }
585 - }
586 -
587 - /*
588 - * Update WHERE for Query
589 - */
590 - $where = '';
591 - $where_condition = [];
592 -
593 - /*
594 - * Add Keyword
595 - */
596 - if (!empty($attr['keyword'])) {
597 - $where_condition[] = 'content LIKE "%%' . $attr['keyword'] . '%%"';
598 - }
599 -
600 - /*
601 - * Add Form ID
602 - */
603 - if (!empty($attr['cf_form_id'])) {
604 - $where_condition[] = 'cf_form_id="' . $attr['cf_form_id'] . '"';
605 - }
606 -
607 - /*
608 - * build where string
609 - */
610 - if (!empty($where_condition)) {
611 - $where = ' WHERE ' . implode(' AND ', $where_condition);
612 - }
613 -
614 - /*
615 - * set table
616 - */
617 - $tableName = $wpdb->prefix . 'f12_cf7_doubleoptin';
618 - $pageNum = (int)$attr['page'] - 1;
619 -
620 - if ($numberOfPages !== null) {
621 - $result = $wpdb->get_results('SELECT count(*) as counter FROM ' . $tableName . $where);
622 -
623 - $itemCounter = 0;
624 -
625 - if (is_array($result)) {
626 - $itemCounter = $result[0]->counter;
627 - }
628 -
629 - $numberOfPages = 0;
630 -
631 - if ($itemCounter != 0) {
632 - $numberOfPages = ceil($itemCounter / (int)$attr['perPage']);
633 - }
634 - }
635 -
636 - $list = array();
637 -
638 - if ($numberOfPages == 0) {
639 - return $list;
640 - }
641 -
642 - $offset = $pageNum * (int)$attr['perPage'];
643 -
644 - $rows = $wpdb->get_results($wpdb->prepare('SELECT * FROM ' . $tableName . $where . ' ORDER BY ID ' . $attr['order'] . ' LIMIT ' . $attr['perPage'] . ' OFFSET % d', $offset), ARRAY_A);
645 -
646 - foreach ($rows as $row) {
647 - $list[] = new OptIn($row);
648 - }
649 - return $list;
650 - }
651 -
652 - /**
653 - * This will update all categories from A to B, e.g.: All Opt-Ins with id 1 to category id 2.
654 - *
655 - * @param int $from_id The origin Category ID
656 - * @param int $to_id The new Category ID
657 - *
658 - * @return bool|int|\mysqli_result|resource|null Return the number of rows affected by the query.
659 - */
660 - public static function bulk_update_category($from_id, $to_id)
661 - {
662 - global $wpdb;
663 - $table = $wpdb->prefix . 'f12_cf7_doubleoptin';
664 -
665 - return $wpdb->query($wpdb->prepare('UPDATE ' . $table . ' SET category =%d WHERE category =%d', $to_id, $from_id));
666 - }
667 -
668 - /**
669 - * Update the category of the given opt in id.
670 - *
671 - * @param int $optin_id The ID of the OptIn
672 - * @param int $category_id The ID of the Category
673 - *
674 - * @return bool|int|\mysqli_result|resource|null
675 - */
676 - public static function update_category_by_id($optin_id, $category_id)
677 - {
678 - global $wpdb;
679 - $table = $wpdb->prefix . 'f12_cf7_doubleoptin';
680 -
681 - return $wpdb->query($wpdb->prepare('UPDATE ' . $table . ' SET category =%d WHERE id =%d', $category_id, $optin_id));
682 - }
683 -
684 - /**
685 - * Update or create the given Object
686 - */
687 - public function save()
688 - {
689 - global $wpdb;
690 - $table = $wpdb->prefix . 'f12_cf7_doubleoptin';
691 -
692 - if (!empty($this->get_hash())) {
693 - return $wpdb->update($table, array(
694 - 'doubleoptin' => $this->get_doubleoptin(),
695 - 'createtime' => $this->get_createtime(),
696 - 'updatetime' => $this->get_updatetime(),
697 - 'ipaddr_confirmation' => $this->get_ipaddr_confirmation(),
698 - 'ipaddr_register' => $this->get_ipaddr_register(),
699 - 'cf_form_id' => $this->get_cf_form_id(),
700 - 'content' => $this->get_content(),
701 - 'files' => $this->get_files(),
702 - 'category' => $this->get_category(),
703 - 'mail_optin' => $this->get_mail_optin(),
704 - ), array(
705 - 'hash' => $this->get_hash()
706 - ));
707 - } else {
708 - $result = $wpdb->insert($table, array(
709 - 'cf_form_id' => $this->get_cf_form_id(),
710 - 'doubleoptin' => $this->get_doubleoptin(),
711 - 'createtime' => $this->get_createtime(),
712 - 'updatetime' => $this->get_updatetime(),
713 - 'ipaddr_confirmation' => $this->get_ipaddr_confirmation(),
714 - 'ipaddr_register' => $this->get_ipaddr_register(),
715 - 'content' => $this->get_content(),
716 - 'files' => $this->get_files(),
717 - 'category' => $this->get_category(),
718 - 'form' => $this->get_form(),
719 - 'mail_optin' => $this->get_mail_optin(),
720 - 'email' => $this->get_email()
721 - ));
722 -
723 - if ($result > 0) {
724 - $this->id = $wpdb->insert_id;
725 - return $this->createHash();
726 - }
727 - }
728 - return false;
729 - }
730 -
731 - /**
732 - * Creates a unique hash code and adds it to the current OptIn Object
733 - */
734 - private function createHash()
735 - {
736 - global $wpdb;
737 -
738 - if (null == $wpdb) {
739 - return false;
740 - }
741 -
742 - $table = $wpdb->prefix . 'f12_cf7_doubleoptin';
743 -
744 - // add the hash to the element
745 -
746 - $this->hash = base64_encode($this->get_createtime() . $this->get_id() . $this->get_cf_form_id());
747 -
748 - return $wpdb->update($table, array(
749 - 'hash' => $this->hash,
750 - ), array(
751 - 'id' => $this->get_id()
752 - ));
753 - }
754 -
755 - /**
756 - * Return the Form
757 - *
758 - * @return string
759 - */
760 - public function get_form()
761 - {
762 - return $this->form;
763 - }
764 -
765 - /**
766 - * Set the Form as HTML
767 - *
768 - * @param string $form
769 - *
770 - * @return void
771 - */
772 - public function set_form($form)
773 - {
774 - $this->form = $form;
775 - }
776 -
777 - /**
778 - * Return the Form
779 - *
780 - * @return string
781 - */
782 - public function get_mail_optin()
783 - {
784 - return $this->mail_optin;
785 - }
786 -
787 - /**
788 - * Return the E-mail
789 - *
790 - * @return string
791 - */
792 - public function get_email()
793 - {
794 - return $this->email;
795 - }
796 -
797 - /**
798 - * Store the email
799 - *
800 - * @param string $email
801 - *
802 - * @return void
803 - */
804 - public function set_email($email)
805 - {
806 - $this->email = $email;
807 - }
808 -
809 - /**
810 - * Set the Form as HTML
811 - *
812 - * @param string $form
813 - *
814 - * @return void
815 - */
816 - public function set_mail_optin($mail_html)
817 - {
818 - $this->mail_optin = $mail_html;
819 - }
820 -
821 - /**
822 - * Return the link to the detail view
823 - *
824 - * @return string
825 - */
826 - public function get_link_ui()
827 - {
828 - return admin_url('admin.php?page=f12-cf7-doubleoptin_optin_view&hash=' . $this->get_hash());
829 - }
830 -
831 - /**
832 - * Return the link to delete
833 - *
834 - * @return string
835 - */
836 - public function get_link_delete()
837 - {
838 - return admin_url('admin.php?page=f12-cf7-doubleoptin&option=delete&hash=' . $this->get_hash());
839 - }
840 -
841 - /**
842 - * Return the link to the optin
843 - *
844 - * @return string
845 - */
846 - public function get_link_optin()
847 - {
848 - if ($this->get_cf_form_id() == 0) {
849 - return get_home_url() . '?optin=' . $this->get_hash();
850 - }
851 -
852 - $parameter = CF7DoubleOptIn::getInstance()->getParameter($this->get_cf_form_id());
853 -
854 - $page_id = $parameter['page'];
855 -
856 - if ($page_id == -1 || !$page_id || $page_id == 0) {
857 - $link = get_home_url() . '?optin=' . $this->get_hash();
858 - } else {
859 - $link = get_permalink($page_id) . '?optin=' . $this->get_hash();
860 - }
861 -
862 - return $link;
863 - }
864 - }
865 -}
1 +<?php
2 +/**
3 + * OptIn Facade
4 + *
5 + * Backward-compatible facade for the legacy OptIn API.
6 + * Internally uses the new Repository pattern.
7 + *
8 + * @package forge12\contactform7\CF7DoubleOptIn
9 + * @since 4.0.0
10 + */
11 +
12 +namespace forge12\contactform7\CF7DoubleOptIn;
13 +
14 +use Forge12\DoubleOptIn\Container\Container;
15 +use Forge12\DoubleOptIn\Entity\OptIn as OptInEntity;
16 +use Forge12\DoubleOptIn\Repository\OptInRepositoryInterface;
17 +use Forge12\Shared\Logger;
18 +use Forge12\Shared\LoggerInterface;
19 +
20 +if ( ! defined( 'ABSPATH' ) ) {
21 + exit;
22 +}
23 +
24 +/**
25 + * Class OptIn
26 + *
27 + * This class provides backward compatibility with the legacy API
28 + * while using the new Repository pattern internally.
29 + */
30 +class OptIn {
31 +
32 + private LoggerInterface $logger;
33 + private OptInEntity $entity;
34 +
35 + /**
36 + * Constructor.
37 + *
38 + * @param LoggerInterface $logger The logger instance.
39 + * @param array $properties Optional properties to initialize.
40 + */
41 + public function __construct( LoggerInterface $logger, array $properties = [] ) {
42 + $this->logger = $logger;
43 +
44 + if ( ! empty( $properties ) ) {
45 + $this->entity = OptInEntity::fromArray( $this->mapToEntityArray( $properties ) );
46 + } else {
47 + $this->entity = OptInEntity::create();
48 + }
49 +
50 + $this->logger->debug( 'OptIn facade initialized', [
51 + 'plugin' => 'double-opt-in',
52 + 'id' => $this->entity->getId(),
53 + ] );
54 + }
55 +
56 + /**
57 + * Get the logger instance.
58 + *
59 + * @return LoggerInterface
60 + */
61 + public function get_logger(): LoggerInterface {
62 + return $this->logger;
63 + }
64 +
65 + /**
66 + * Get the underlying entity.
67 + *
68 + * @return OptInEntity
69 + */
70 + public function getEntity(): OptInEntity {
71 + return $this->entity;
72 + }
73 +
74 + // =========================================================================
75 + // STATIC FACTORY METHODS
76 + // =========================================================================
77 +
78 + /**
79 + * Get OptIn by hash.
80 + *
81 + * @param string $hash The hash.
82 + *
83 + * @return OptIn|null
84 + */
85 + public static function get_by_hash( string $hash ): ?OptIn {
86 + $logger = Logger::getInstance();
87 + $logger->debug( 'get_by_hash called', [
88 + 'plugin' => 'double-opt-in',
89 + 'hash' => $hash,
90 + ] );
91 +
92 + try {
93 + $repository = self::getRepository();
94 + $entity = $repository->findByHash( $hash );
95 +
96 + if ( ! $entity ) {
97 + return null;
98 + }
99 +
100 + $optIn = new self( $logger );
101 + $optIn->entity = $entity;
102 +
103 + return $optIn;
104 + } catch ( \Exception $e ) {
105 + $logger->error( 'Failed to get OptIn by hash', [
106 + 'plugin' => 'double-opt-in',
107 + 'hash' => $hash,
108 + 'error' => $e->getMessage(),
109 + ] );
110 + return null;
111 + }
112 + }
113 +
114 + /**
115 + * Get OptIn by its database id.
116 + *
117 + * Server-side use only (cron, admin REST). Public links always
118 + * address an opt-in by its random hash, never by id.
119 + *
120 + * @param int $id The opt-in id.
121 + *
122 + * @return OptIn|null
123 + *
124 + * @since 5.6.0
125 + */
126 + public static function get_by_id( int $id ): ?OptIn {
127 + if ( $id <= 0 ) {
128 + return null;
129 + }
130 +
131 + $logger = Logger::getInstance();
132 +
133 + try {
134 + $entity = self::getRepository()->findById( $id );
135 +
136 + if ( ! $entity ) {
137 + return null;
138 + }
139 +
140 + $optIn = new self( $logger );
141 + $optIn->entity = $entity;
142 +
143 + return $optIn;
144 + } catch ( \Exception $e ) {
145 + $logger->error( 'Failed to get OptIn by id', [
146 + 'plugin' => 'double-opt-in',
147 + 'optin_id' => $id,
148 + 'error' => $e->getMessage(),
149 + ] );
150 + return null;
151 + }
152 + }
153 +
154 + /**
155 + * Get count by form ID.
156 + *
157 + * @param int $formId The form ID.
158 + *
159 + * @return int
160 + */
161 + public static function get_count( int $formId ): int {
162 + try {
163 + return self::getRepository()->countByFormId( $formId );
164 + } catch ( \Exception $e ) {
165 + return 0;
166 + }
167 + }
168 +
169 + /**
170 + * Get list of OptIns with pagination.
171 + *
172 + * @param array $atts Query attributes.
173 + * @param int|null $numberOfPages Reference to store page count.
174 + *
175 + * @return array<OptIn>
176 + */
177 + public static function get_list( array $atts = [], ?int &$numberOfPages = null ): array {
178 + $logger = Logger::getInstance();
179 +
180 + try {
181 + $repository = self::getRepository();
182 + $entities = $repository->findAll( $atts, $numberOfPages );
183 +
184 + return array_map( function ( OptInEntity $entity ) use ( $logger ) {
185 + $optIn = new self( $logger );
186 + $optIn->entity = $entity;
187 + return $optIn;
188 + }, $entities );
189 + } catch ( \Exception $e ) {
190 + $logger->error( 'Failed to get OptIn list', [
191 + 'plugin' => 'double-opt-in',
192 + 'error' => $e->getMessage(),
193 + ] );
194 + return [];
195 + }
196 + }
197 +
198 + /**
199 + * Get list by category ID.
200 + *
201 + * @param int $categoryId The category ID.
202 + * @param array $atts Query attributes.
203 + * @param int|null $numberOfPages Reference to store page count.
204 + *
205 + * @return array<OptIn>
206 + */
207 + public static function get_list_by_category_id( int $categoryId, array $atts = [], ?int &$numberOfPages = null ): array {
208 + $logger = Logger::getInstance();
209 +
210 + try {
211 + $repository = self::getRepository();
212 +
213 + // Get total count for pagination
214 + if ( $numberOfPages !== null ) {
215 + $keyword = $atts['keyword'] ?? '';
216 + $perPage = max( 1, (int) ( $atts['perPage'] ?? 10 ) );
217 + $total = $repository->countByCategory( $categoryId, $keyword );
218 + $numberOfPages = $total > 0 ? (int) ceil( $total / $perPage ) : 0;
219 +
220 + if ( $numberOfPages === 0 ) {
221 + return [];
222 + }
223 + }
224 +
225 + $entities = $repository->findByCategory( $categoryId, $atts );
226 +
227 + return array_map( function ( OptInEntity $entity ) use ( $logger ) {
228 + $optIn = new self( $logger );
229 + $optIn->entity = $entity;
230 + return $optIn;
231 + }, $entities );
232 + } catch ( \Exception $e ) {
233 + $logger->error( 'Failed to get OptIn list by category', [
234 + 'plugin' => 'double-opt-in',
235 + 'category' => $categoryId,
236 + 'error' => $e->getMessage(),
237 + ] );
238 + return [];
239 + }
240 + }
241 +
242 + /**
243 + * Get list by email.
244 + *
245 + * @param string $email The email address.
246 + *
247 + * @return array<OptIn>
248 + */
249 + public static function get_list_by_email( string $email ): array {
250 + $logger = Logger::getInstance();
251 +
252 + try {
253 + $repository = self::getRepository();
254 + $entities = $repository->findByEmail( $email );
255 +
256 + return array_map( function ( OptInEntity $entity ) use ( $logger ) {
257 + $optIn = new self( $logger );
258 + $optIn->entity = $entity;
259 + return $optIn;
260 + }, $entities );
261 + } catch ( \Exception $e ) {
262 + return [];
263 + }
264 + }
265 +
266 + /**
267 + * Get confirmed list by email.
268 + *
269 + * @param string $email The email address.
270 + *
271 + * @return array<OptIn>
272 + */
273 + public static function get_list_by_email_confirmed( string $email ): array {
274 + $logger = Logger::getInstance();
275 +
276 + try {
277 + $repository = self::getRepository();
278 + $entities = $repository->findConfirmedByEmail( $email );
279 +
280 + return array_map( function ( OptInEntity $entity ) use ( $logger ) {
281 + $optIn = new self( $logger );
282 + $optIn->entity = $entity;
283 + return $optIn;
284 + }, $entities );
285 + } catch ( \Exception $e ) {
286 + return [];
287 + }
288 + }
289 +
290 + /**
291 + * Get unconfirmed list by email.
292 + *
293 + * @param string $email The email address.
294 + *
295 + * @return array<OptIn>
296 + */
297 + public static function get_list_by_email_unconfirmed( string $email ): array {
298 + $logger = Logger::getInstance();
299 +
300 + try {
301 + $repository = self::getRepository();
302 + $entities = $repository->findUnconfirmedByEmail( $email );
303 +
304 + return array_map( function ( OptInEntity $entity ) use ( $logger ) {
305 + $optIn = new self( $logger );
306 + $optIn->entity = $entity;
307 + return $optIn;
308 + }, $entities );
309 + } catch ( \Exception $e ) {
310 + return [];
311 + }
312 + }
313 +
314 + /**
315 + * Bulk update category.
316 + *
317 + * @param int $fromId The source category ID.
318 + * @param int $toId The target category ID.
319 + *
320 + * @return int
321 + */
322 + public static function bulk_update_category( int $fromId, int $toId ): int {
323 + try {
324 + return self::getRepository()->bulkUpdateCategory( $fromId, $toId );
325 + } catch ( \Exception $e ) {
326 + return 0;
327 + }
328 + }
329 +
330 + /**
331 + * Update category by OptIn ID.
332 + *
333 + * @param int $optInId The OptIn ID.
334 + * @param int $categoryId The new category ID.
335 + *
336 + * @return bool
337 + */
338 + public static function update_category_by_id( int $optInId, int $categoryId ): bool {
339 + try {
340 + return self::getRepository()->updateCategoryById( $optInId, $categoryId );
341 + } catch ( \Exception $e ) {
342 + return false;
343 + }
344 + }
345 +
346 + // =========================================================================
347 + // GETTERS
348 + // =========================================================================
349 +
350 + public function get_id(): int {
351 + return $this->entity->getId();
352 + }
353 +
354 + public function get_hash(): string {
355 + return $this->entity->getHash();
356 + }
357 +
358 + public function get_cf_form_id(): int {
359 + return $this->entity->getFormId();
360 + }
361 +
362 + public function is_confirmed(): bool {
363 + return $this->entity->isConfirmed();
364 + }
365 +
366 + public function get_doubleoptin(): int {
367 + return $this->entity->isConfirmed() ? 1 : 0;
368 + }
369 +
370 + public function is_optout(): bool {
371 + return $this->entity->isOptedOut();
372 + }
373 +
374 + public function get_content(): string {
375 + return $this->entity->getContent();
376 + }
377 +
378 + public function get_createtime( string $view = 'raw' ): string {
379 + if ( $view !== 'raw' ) {
380 + return $this->entity->getCreateTimeFormatted( 'd.m.Y / H:i:s' );
381 + }
382 + return (string) $this->entity->getCreateTime();
383 + }
384 +
385 + public function get_updatetime( string $view = 'raw' ): string {
386 + if ( $view !== 'raw' ) {
387 + return $this->entity->getUpdateTimeFormatted( 'd.m.Y / H:i:s' );
388 + }
389 + return (string) $this->entity->getUpdateTime();
390 + }
391 +
392 + public function get_optouttime( string $view = 'raw' ): string {
393 + $time = $this->entity->getOptOutTime();
394 + if ( $view !== 'raw' && $time > 0 ) {
395 + return wp_date( 'd.m.Y / H:i:s', $time );
396 + }
397 + return (string) $time;
398 + }
399 +
400 + /**
401 + * Get create time as ISO 8601 string.
402 + *
403 + * @return string
404 + */
405 + public function get_createtime_iso(): string {
406 + return $this->entity->getCreateTimeISO();
407 + }
408 +
409 + /**
410 + * Get update time as ISO 8601 string.
411 + *
412 + * @return string
413 + */
414 + public function get_updatetime_iso(): string {
415 + return $this->entity->getUpdateTimeISO();
416 + }
417 +
418 + /**
419 + * Get opt-out time as ISO 8601 string.
420 + *
421 + * @return string
422 + */
423 + public function get_optouttime_iso(): string {
424 + return $this->entity->getOptOutTimeISO();
425 + }
426 +
427 + public function get_ipaddr_register(): string {
428 + return $this->entity->getIpRegister();
429 + }
430 +
431 + public function get_ipaddr_confirmation(): string {
432 + return $this->entity->getIpConfirmation();
433 + }
434 +
435 + public function get_ipaddr_optout(): string {
436 + return $this->entity->getIpOptOut();
437 + }
438 +
439 + public function get_files(): string {
440 + return $this->entity->getFiles();
441 + }
442 +
443 + public function get_category(): int {
444 + return $this->entity->getCategory();
445 + }
446 +
447 + public function get_email(): string {
448 + return $this->entity->getEmail();
449 + }
450 +
451 + public function get_mail_optin(): string {
452 + return $this->entity->getMailOptIn();
453 + }
454 +
455 + public function get_consent_text(): string {
456 + return $this->entity->getConsentText();
457 + }
458 +
459 + public function get_form( bool $encoded = false ): string {
460 + $form = $this->entity->getForm();
461 + if ( $encoded ) {
462 + return base64_encode( $form );
463 + }
464 + return $form;
465 + }
466 +
467 + /**
468 + * Get the validity end date.
469 + *
470 + * @return string
471 + */
472 + public function get_valid_until(): string {
473 + $settings = CF7DoubleOptIn::getInstance()->getSettings();
474 + $dt = new \DateTime();
475 + $dt->setTimestamp( $this->entity->getCreateTime() );
476 +
477 + if ( $this->is_confirmed() ) {
478 + $amount = (int) ( $settings['delete'] ?? 0 );
479 + $period = $settings['delete_period'] ?? 'months';
480 + } else {
481 + $amount = (int) ( $settings['delete_unconfirmed'] ?? 0 );
482 + $period = $settings['delete_unconfirmed_period'] ?? 'months';
483 + }
484 +
485 + $dt->modify( '+' . $amount . ' ' . $period );
486 + $dt->modify( '+1 day' );
487 +
488 + return $dt->format( 'd.m.Y' );
489 + }
490 +
491 + // =========================================================================
492 + // SETTERS
493 + // =========================================================================
494 +
495 + public function set_cf_form_id( int $formId ): void {
496 + $this->entity = $this->entity->withFormId( $formId );
497 + }
498 +
499 + public function set_doubleoptin( int $confirmed ): void {
500 + $this->entity->setConfirmed( (bool) $confirmed );
501 + }
502 +
503 + public function set_createtime( $timestamp ): void {
504 + $this->entity = $this->entity->withCreateTime( (int) $timestamp );
505 + }
506 +
507 + public function set_updatetime( $timestamp ): void {
508 + $this->entity->setUpdateTime( (int) $timestamp );
509 + }
510 +
511 + public function set_optouttime( $timestamp ): void {
512 + $this->entity = $this->entity->withOptOutTime( (int) $timestamp );
513 + }
514 +
515 + public function set_ipaddr_register( string $ip ): void {
516 + $this->entity = $this->entity->withIpRegister( $ip );
517 + }
518 +
519 + public function set_ipaddr_confirmation( string $ip ): void {
520 + $this->entity->setIpConfirmation( $ip );
521 + }
522 +
523 + public function set_ipaddr_optout( string $ip ): void {
524 + $this->entity = $this->entity->withIpOptOut( $ip );
525 + }
526 +
527 + public function set_content( string $content ): void {
528 + $this->entity = $this->entity->withContent( $content );
529 + }
530 +
531 + public function set_files( string $files ): void {
532 + $this->entity = $this->entity->withFiles( $files );
533 + }
534 +
535 + public function set_category( int $categoryId ): void {
536 + $this->entity = $this->entity->withCategory( $categoryId );
537 + }
538 +
539 + public function set_form( string $form ): void {
540 + $this->entity = $this->entity->withForm( $form );
541 + }
542 +
543 + public function set_email( string $email ): void {
544 + $this->entity = $this->entity->withEmail( $email );
545 + }
546 +
547 + public function set_mail_optin( string $mail ): void {
548 + $this->entity = $this->entity->withMailOptIn( $mail );
549 + }
550 +
551 + public function set_consent_text( string $text ): void {
552 + $this->entity = $this->entity->withConsentText( $text );
553 + }
554 +
555 + // =========================================================================
556 + // TYPE CHECKS
557 + // =========================================================================
558 +
559 + public function isTypeCF7(): bool {
560 + return $this->isType( 'cf7' );
561 + }
562 +
563 + public function isTypeAvada(): bool {
564 + return $this->isType( 'avada' );
565 + }
566 +
567 + public function isTypeElementor(): bool {
568 + return $this->isType( 'elementor' );
569 + }
570 +
571 + public function isTypeWPForms(): bool {
572 + return $this->isType( 'wpforms' );
573 + }
574 +
575 + public function isTypeGravityForms(): bool {
576 + return $this->isType( 'gravityforms' );
577 + }
578 +
579 + public function isType( string $type ): bool {
580 + $formId = $this->get_cf_form_id();
581 +
582 + switch ( $type ) {
583 + case 'cf7':
584 + return get_post_type( $formId ) === 'wpcf7_contact_form';
585 + case 'avada':
586 + return get_post_type( $formId ) === 'fusion_form';
587 + case 'elementor':
588 + // Elementor forms are embedded in pages/posts, not stored as separate post types.
589 + // Check if the post has Elementor data AND DOI settings configured.
590 + $hasElementorData = ! empty( get_post_meta( $formId, '_elementor_data', true ) );
591 + $hasDoiSettings = ! empty( get_post_meta( $formId, 'f12-cf7-doubleoptin', true ) );
592 + return $hasElementorData && $hasDoiSettings;
593 + case 'wpforms':
594 + return get_post_type( $formId ) === 'wpforms';
595 + case 'gravityforms':
596 + // Gravity Forms stores forms in a custom table, not as posts.
597 + // Check if the form ID exists in the GF forms table.
598 + if ( class_exists( 'GFAPI' ) ) {
599 + $form = \GFAPI::get_form( $formId );
600 + return $form !== false && ! is_wp_error( $form );
601 + }
602 + return false;
603 + default:
604 + return false;
605 + }
606 + }
607 +
608 + // =========================================================================
609 + // PERSISTENCE
610 + // =========================================================================
611 +
612 + /**
613 + * Save the OptIn to the database.
614 + *
615 + * @return bool|int
616 + */
617 + public function save() {
618 + $this->logger->info( 'Saving OptIn', [
619 + 'plugin' => 'double-opt-in',
620 + 'id' => $this->entity->getId(),
621 + 'hash' => $this->entity->getHash(),
622 + ] );
623 +
624 + try {
625 + $repository = self::getRepository();
626 + $this->entity = $repository->save( $this->entity );
627 +
628 + $this->logger->info( 'OptIn saved successfully', [
629 + 'plugin' => 'double-opt-in',
630 + 'id' => $this->entity->getId(),
631 + 'hash' => $this->entity->getHash(),
632 + ] );
633 +
634 + return true;
635 + } catch ( \Exception $e ) {
636 + $this->logger->error( 'Failed to save OptIn', [
637 + 'plugin' => 'double-opt-in',
638 + 'error' => $e->getMessage(),
639 + ] );
640 + return false;
641 + }
642 + }
643 +
644 + // =========================================================================
645 + // LINK GENERATION
646 + // =========================================================================
647 +
648 + /**
649 + * Get the opt-in confirmation link.
650 + *
651 + * @param array $parameter Additional parameters.
652 + * @param int $formId Optional form ID override.
653 + *
654 + * @return string
655 + */
656 + public function get_link_optin( array $parameter = [], int $formId = 0 ): string {
657 + $formId = $formId > 0 ? $formId : $this->get_cf_form_id();
658 +
659 + $formParameter = CF7DoubleOptIn::getInstance()->getParameter( $formId );
660 + $pageId = (int) ( $formParameter['page'] ?? 0 );
661 +
662 + if ( $pageId <= 0 ) {
663 + return home_url( '?optin=' . $this->get_hash() );
664 + }
665 +
666 + $pageUrl = get_permalink( $pageId );
667 + if ( ! $pageUrl ) {
668 + return home_url( '?optin=' . $this->get_hash() );
669 + }
670 +
671 + $separator = strpos( $pageUrl, '?' ) !== false ? '&' : '?';
672 +
673 + return $pageUrl . $separator . 'optin=' . $this->get_hash();
674 + }
675 +
676 + /**
677 + * Get the opt-out link.
678 + *
679 + * @return string
680 + */
681 + public function get_link_optout(): string {
682 + $settings = CF7DoubleOptIn::getInstance()->getSettings();
683 + $pageId = (int) ( $settings['optout_page'] ?? 0 );
684 +
685 + if ( $pageId <= 0 ) {
686 + return home_url( '?optout=' . $this->get_hash() );
687 + }
688 +
689 + $pageUrl = get_permalink( $pageId );
690 + if ( ! $pageUrl ) {
691 + return home_url( '?optout=' . $this->get_hash() );
692 + }
693 +
694 + $separator = strpos( $pageUrl, '?' ) !== false ? '&' : '?';
695 +
696 + return $pageUrl . $separator . 'optout=' . $this->get_hash();
697 + }
698 +
699 + /**
700 + * Get the UI edit link.
701 + *
702 + * @return string
703 + */
704 + public function get_link_ui(): string {
705 + return admin_url( 'admin.php?page=' . FORGE12_OPTIN_SLUG . '&view=single&hash=' . $this->get_hash() );
706 + }
707 +
708 + /**
709 + * Get the delete link.
710 + *
711 + * @return string
712 + */
713 + public function get_link_delete(): string {
714 + $nonce = wp_create_nonce( 'delete_optin_' . $this->get_hash() );
715 + return admin_url( 'admin.php?page=' . FORGE12_OPTIN_SLUG . '&action=delete&hash=' . $this->get_hash() . '&_wpnonce=' . $nonce );
716 + }
717 +
718 + /**
719 + * Get the form name.
720 + *
721 + * @return string
722 + */
723 + public function get_form_name(): string {
724 + $formId = $this->get_cf_form_id();
725 +
726 + if ( $formId <= 0 ) {
727 + return __( 'Unknown', 'double-opt-in' );
728 + }
729 +
730 + $post = get_post( $formId );
731 + if ( ! $post ) {
732 + return __( 'Deleted Form', 'double-opt-in' ) . ' (ID: ' . $formId . ')';
733 + }
734 +
735 + return $post->post_title ?: __( 'Untitled Form', 'double-opt-in' );
736 + }
737 +
738 + /**
739 + * Get the form edit link.
740 + *
741 + * @return string
742 + */
743 + public function get_form_link(): string {
744 + $formId = $this->get_cf_form_id();
745 + $postType = get_post_type( $formId );
746 +
747 + if ( $postType === 'wpcf7_contact_form' ) {
748 + return admin_url( 'admin.php?page=wpcf7&post=' . $formId . '&action=edit' );
749 + }
750 +
751 + if ( $postType === 'fusion_form' ) {
752 + return admin_url( 'post.php?post=' . $formId . '&action=edit' );
753 + }
754 +
755 + return admin_url( 'post.php?post=' . $formId . '&action=edit' );
756 + }
757 +
758 + /**
759 + * Get form settings.
760 + *
761 + * @return array
762 + */
763 + public function get_form_settings(): array {
764 + return CF7DoubleOptIn::getInstance()->getParameter( $this->get_cf_form_id() );
765 + }
766 +
767 + // =========================================================================
768 + // HELPERS
769 + // =========================================================================
770 +
771 + /**
772 + * Get the repository instance.
773 + *
774 + * @return OptInRepositoryInterface
775 + */
776 + private static function getRepository(): OptInRepositoryInterface {
777 + $container = Container::getInstance();
778 + return $container->get( OptInRepositoryInterface::class );
779 + }
780 +
781 + /**
782 + * Map legacy property names to entity array keys.
783 + *
784 + * @param array $properties Legacy properties.
785 + *
786 + * @return array
787 + */
788 + private function mapToEntityArray( array $properties ): array {
789 + $mapping = [
790 + 'cf_form_id' => 'cf_form_id',
791 + 'doubleoptin' => 'doubleoptin',
792 + 'content' => 'content',
793 + 'hash' => 'hash',
794 + 'createtime' => 'createtime',
795 + 'updatetime' => 'updatetime',
796 + 'optouttime' => 'optouttime',
797 + 'ipaddr_register' => 'ipaddr_register',
798 + 'ipaddr_confirmation' => 'ipaddr_confirmation',
799 + 'ipaddr_optout' => 'ipaddr_optout',
800 + 'files' => 'files',
801 + 'category' => 'category',
802 + 'form' => 'form',
803 + 'mail_optin' => 'mail_optin',
804 + 'email' => 'email',
805 + 'id' => 'id',
806 + 'consent_text' => 'consent_text',
807 + 'consent_field' => 'consent_field',
808 + ];
809 +
810 + $result = [];
811 + foreach ( $mapping as $legacy => $entity ) {
812 + if ( isset( $properties[ $legacy ] ) ) {
813 + $result[ $entity ] = $properties[ $legacy ];
814 + }
815 + }
816 +
817 + return $result;
818 + }
819 +}