Completed
Branch tweak-status-change-notice (50cb96)
by
unknown
45:30 queued 36:14
created
core/interfaces/EEI_Request_Decorator.interface.php 1 patch
Indentation   +18 added lines, -18 removed lines patch added patch discarded remove patch
@@ -9,24 +9,24 @@
 block discarded – undo
9 9
 interface EEI_Request_Decorator
10 10
 {
11 11
 
12
-    /**
13
-     * converts a Request to a Response
14
-     * can perform their logic either before or after the core application has run like so:
15
-     *    public function handle_request( EE_Request $request, EE_Response $response ) {
16
-     *        $this->request = $request;
17
-     *        $this->response = $response;
18
-     *      // logic performed BEFORE core app has run
19
-     *      $this->process_request_stack( $this->request, $this->response );
20
-     *      // logic performed AFTER core app has run
21
-     *      return $response;
22
-     *    }
23
-     *
24
-     * @deprecated 4.9.53
25
-     * @param    EE_Request $request
26
-     * @param    EE_Response   $response
27
-     * @return    EE_Response
28
-     */
29
-    public function handle_request(EE_Request $request, EE_Response $response);
12
+	/**
13
+	 * converts a Request to a Response
14
+	 * can perform their logic either before or after the core application has run like so:
15
+	 *    public function handle_request( EE_Request $request, EE_Response $response ) {
16
+	 *        $this->request = $request;
17
+	 *        $this->response = $response;
18
+	 *      // logic performed BEFORE core app has run
19
+	 *      $this->process_request_stack( $this->request, $this->response );
20
+	 *      // logic performed AFTER core app has run
21
+	 *      return $response;
22
+	 *    }
23
+	 *
24
+	 * @deprecated 4.9.53
25
+	 * @param    EE_Request $request
26
+	 * @param    EE_Response   $response
27
+	 * @return    EE_Response
28
+	 */
29
+	public function handle_request(EE_Request $request, EE_Response $response);
30 30
 
31 31
 
32 32
 }
Please login to merge, or discard this patch.
core/services/request/LegacyRequestInterface.php 1 patch
Indentation   +87 added lines, -87 removed lines patch added patch discarded remove patch
@@ -15,125 +15,125 @@
 block discarded – undo
15 15
 interface LegacyRequestInterface
16 16
 {
17 17
 
18
-    /**
19
-     * @return array
20
-     */
21
-    public function get_params();
18
+	/**
19
+	 * @return array
20
+	 */
21
+	public function get_params();
22 22
 
23 23
 
24
-    /**
25
-     * @return array
26
-     */
27
-    public function post_params();
24
+	/**
25
+	 * @return array
26
+	 */
27
+	public function post_params();
28 28
 
29 29
 
30
-    /**
31
-     * @return array
32
-     */
33
-    public function cookie_params();
30
+	/**
31
+	 * @return array
32
+	 */
33
+	public function cookie_params();
34 34
 
35 35
 
36
-    /**
37
-     * @return array
38
-     */
39
-    public function server_params();
36
+	/**
37
+	 * @return array
38
+	 */
39
+	public function server_params();
40 40
 
41 41
 
42
-    /**
43
-     * returns contents of $_REQUEST
44
-     *
45
-     * @return array
46
-     */
47
-    public function params();
42
+	/**
43
+	 * returns contents of $_REQUEST
44
+	 *
45
+	 * @return array
46
+	 */
47
+	public function params();
48 48
 
49 49
 
50
-    /**
51
-     * @param      $key
52
-     * @param      $value
53
-     * @param bool $override_ee
54
-     * @return    void
55
-     */
56
-    public function set($key, $value, $override_ee = false);
50
+	/**
51
+	 * @param      $key
52
+	 * @param      $value
53
+	 * @param bool $override_ee
54
+	 * @return    void
55
+	 */
56
+	public function set($key, $value, $override_ee = false);
57 57
 
58 58
 
59
-    /**
60
-     * returns   the value for a request param if the given key exists
61
-     *
62
-     * @param       $key
63
-     * @param null  $default
64
-     * @return mixed
65
-     */
66
-    public function get($key, $default = null);
59
+	/**
60
+	 * returns   the value for a request param if the given key exists
61
+	 *
62
+	 * @param       $key
63
+	 * @param null  $default
64
+	 * @return mixed
65
+	 */
66
+	public function get($key, $default = null);
67 67
 
68 68
 
69
-    /**
70
-     * check if param exists
71
-     *
72
-     * @param       $key
73
-     * @return bool
74
-     */
75
-    public function is_set($key);
69
+	/**
70
+	 * check if param exists
71
+	 *
72
+	 * @param       $key
73
+	 * @return bool
74
+	 */
75
+	public function is_set($key);
76 76
 
77 77
 
78
-    /**
79
-     * remove param
80
-     *
81
-     * @param      $key
82
-     * @param bool $unset_from_global_too
83
-     */
84
-    public function un_set($key, $unset_from_global_too = false);
78
+	/**
79
+	 * remove param
80
+	 *
81
+	 * @param      $key
82
+	 * @param bool $unset_from_global_too
83
+	 */
84
+	public function un_set($key, $unset_from_global_too = false);
85 85
 
86 86
 
87
-    /**
88
-     * @return string
89
-     */
90
-    public function ip_address();
87
+	/**
88
+	 * @return string
89
+	 */
90
+	public function ip_address();
91 91
 
92 92
 
93
-    /**
94
-     * @return bool
95
-     */
96
-    public function isAdmin();
93
+	/**
94
+	 * @return bool
95
+	 */
96
+	public function isAdmin();
97 97
 
98 98
 
99
-    /**
100
-     * @return mixed
101
-     */
102
-    public function isAjax();
99
+	/**
100
+	 * @return mixed
101
+	 */
102
+	public function isAjax();
103 103
 
104 104
 
105
-    /**
106
-     * @return mixed
107
-     */
108
-    public function isFrontAjax();
105
+	/**
106
+	 * @return mixed
107
+	 */
108
+	public function isFrontAjax();
109 109
 
110 110
 
111
-    /**
112
-     * @return mixed|string
113
-     */
114
-    public function requestUri();
111
+	/**
112
+	 * @return mixed|string
113
+	 */
114
+	public function requestUri();
115 115
 
116 116
 
117
-    /**
118
-     * @return string
119
-     */
120
-    public function userAgent();
117
+	/**
118
+	 * @return string
119
+	 */
120
+	public function userAgent();
121 121
 
122 122
 
123
-    /**
124
-     * @param string $user_agent
125
-     */
126
-    public function setUserAgent($user_agent = '');
123
+	/**
124
+	 * @param string $user_agent
125
+	 */
126
+	public function setUserAgent($user_agent = '');
127 127
 
128 128
 
129
-    /**
130
-     * @return bool
131
-     */
132
-    public function isBot();
129
+	/**
130
+	 * @return bool
131
+	 */
132
+	public function isBot();
133 133
 
134 134
 
135
-    /**
136
-     * @param bool $is_bot
137
-     */
138
-    public function setIsBot($is_bot);
135
+	/**
136
+	 * @param bool $is_bot
137
+	 */
138
+	public function setIsBot($is_bot);
139 139
 }
Please login to merge, or discard this patch.
core/services/request/Response.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -58,7 +58,7 @@  discard block
 block discarded – undo
58 58
      */
59 59
     public function setNotice($key, $value)
60 60
     {
61
-        $this->notice[ $key ] = $value;
61
+        $this->notice[$key] = $value;
62 62
     }
63 63
 
64 64
 
@@ -69,7 +69,7 @@  discard block
 block discarded – undo
69 69
      */
70 70
     public function getNotice($key)
71 71
     {
72
-        return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
72
+        return isset($this->notice[$key]) ? $this->notice[$key] : null;
73 73
     }
74 74
 
75 75
 
@@ -90,7 +90,7 @@  discard block
 block discarded – undo
90 90
      */
91 91
     public function addOutput($string, $append = true)
92 92
     {
93
-        $this->output = $append ? $this->output . $string : $string . $this->output;
93
+        $this->output = $append ? $this->output.$string : $string.$this->output;
94 94
     }
95 95
 
96 96
 
Please login to merge, or discard this patch.
Indentation   +115 added lines, -115 removed lines patch added patch discarded remove patch
@@ -16,119 +16,119 @@
 block discarded – undo
16 16
 class Response implements ResponseInterface, ReservedInstanceInterface
17 17
 {
18 18
 
19
-    /**
20
-     * @var array $notice
21
-     */
22
-    protected $notice = array();
23
-
24
-    /**
25
-     * rendered output to be returned to WP
26
-     *
27
-     * @var string $output
28
-     */
29
-    protected $output = '';
30
-
31
-    /**
32
-     * @var bool
33
-     */
34
-    protected $request_terminated = false;
35
-
36
-    /**
37
-     * @var bool $deactivate_plugin
38
-     */
39
-    protected $deactivate_plugin = false;
40
-
41
-
42
-    /**
43
-     * EE_Response constructor.
44
-     */
45
-    public function __construct()
46
-    {
47
-        $this->terminateRequest(false);
48
-    }
49
-
50
-
51
-    /**
52
-     * @param $key
53
-     * @param $value
54
-     * @return    void
55
-     */
56
-    public function setNotice($key, $value)
57
-    {
58
-        $this->notice[ $key ] = $value;
59
-    }
60
-
61
-
62
-    /**
63
-     * @param $key
64
-     * @return    mixed
65
-     */
66
-    public function getNotice($key)
67
-    {
68
-        return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
69
-    }
70
-
71
-
72
-    /**
73
-     * @return array
74
-     */
75
-    public function getNotices()
76
-    {
77
-        return $this->notice;
78
-    }
79
-
80
-
81
-    /**
82
-     * @param string $string
83
-     * @param bool   $append
84
-     */
85
-    public function addOutput($string, $append = true)
86
-    {
87
-        $this->output = $append ? $this->output . $string : $string . $this->output;
88
-    }
89
-
90
-
91
-    /**
92
-     * @return string
93
-     */
94
-    public function getOutput()
95
-    {
96
-        return $this->output;
97
-    }
98
-
99
-
100
-    /**
101
-     * @return boolean
102
-     */
103
-    public function requestTerminated()
104
-    {
105
-        return $this->request_terminated;
106
-    }
107
-
108
-
109
-    /**
110
-     * @param boolean $request_terminated
111
-     */
112
-    public function terminateRequest($request_terminated = true)
113
-    {
114
-        $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
115
-    }
116
-
117
-
118
-    /**
119
-     * @return boolean
120
-     */
121
-    public function pluginDeactivated()
122
-    {
123
-        return $this->deactivate_plugin;
124
-    }
125
-
126
-
127
-    /**
128
-     * sets $deactivate_plugin to true
129
-     */
130
-    public function deactivatePlugin()
131
-    {
132
-        $this->deactivate_plugin = true;
133
-    }
19
+	/**
20
+	 * @var array $notice
21
+	 */
22
+	protected $notice = array();
23
+
24
+	/**
25
+	 * rendered output to be returned to WP
26
+	 *
27
+	 * @var string $output
28
+	 */
29
+	protected $output = '';
30
+
31
+	/**
32
+	 * @var bool
33
+	 */
34
+	protected $request_terminated = false;
35
+
36
+	/**
37
+	 * @var bool $deactivate_plugin
38
+	 */
39
+	protected $deactivate_plugin = false;
40
+
41
+
42
+	/**
43
+	 * EE_Response constructor.
44
+	 */
45
+	public function __construct()
46
+	{
47
+		$this->terminateRequest(false);
48
+	}
49
+
50
+
51
+	/**
52
+	 * @param $key
53
+	 * @param $value
54
+	 * @return    void
55
+	 */
56
+	public function setNotice($key, $value)
57
+	{
58
+		$this->notice[ $key ] = $value;
59
+	}
60
+
61
+
62
+	/**
63
+	 * @param $key
64
+	 * @return    mixed
65
+	 */
66
+	public function getNotice($key)
67
+	{
68
+		return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
69
+	}
70
+
71
+
72
+	/**
73
+	 * @return array
74
+	 */
75
+	public function getNotices()
76
+	{
77
+		return $this->notice;
78
+	}
79
+
80
+
81
+	/**
82
+	 * @param string $string
83
+	 * @param bool   $append
84
+	 */
85
+	public function addOutput($string, $append = true)
86
+	{
87
+		$this->output = $append ? $this->output . $string : $string . $this->output;
88
+	}
89
+
90
+
91
+	/**
92
+	 * @return string
93
+	 */
94
+	public function getOutput()
95
+	{
96
+		return $this->output;
97
+	}
98
+
99
+
100
+	/**
101
+	 * @return boolean
102
+	 */
103
+	public function requestTerminated()
104
+	{
105
+		return $this->request_terminated;
106
+	}
107
+
108
+
109
+	/**
110
+	 * @param boolean $request_terminated
111
+	 */
112
+	public function terminateRequest($request_terminated = true)
113
+	{
114
+		$this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
115
+	}
116
+
117
+
118
+	/**
119
+	 * @return boolean
120
+	 */
121
+	public function pluginDeactivated()
122
+	{
123
+		return $this->deactivate_plugin;
124
+	}
125
+
126
+
127
+	/**
128
+	 * sets $deactivate_plugin to true
129
+	 */
130
+	public function deactivatePlugin()
131
+	{
132
+		$this->deactivate_plugin = true;
133
+	}
134 134
 }
Please login to merge, or discard this patch.
core/services/request/middleware/PreProductionVersionWarning.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -78,7 +78,7 @@
 block discarded – undo
78 78
     public function preProductionVersionAdminNotice()
79 79
     {
80 80
         new PersistentAdminNotice(
81
-            'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION,
81
+            'preProductionVersionAdminNotice_'.EVENT_ESPRESSO_VERSION,
82 82
             $this->warningNotice()
83 83
         );
84 84
     }
Please login to merge, or discard this patch.
Indentation   +79 added lines, -79 removed lines patch added patch discarded remove patch
@@ -18,91 +18,91 @@
 block discarded – undo
18 18
 class PreProductionVersionWarning extends Middleware
19 19
 {
20 20
 
21
-    /**
22
-     * converts a Request to a Response
23
-     *
24
-     * @param RequestInterface  $request
25
-     * @param ResponseInterface $response
26
-     * @return ResponseInterface
27
-     */
28
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
29
-    {
30
-        $this->request = $request;
31
-        $this->response = $response;
32
-        $this->displayPreProductionVersionWarning();
33
-        $this->response = $this->processRequestStack($this->request, $this->response);
34
-        return $this->response;
35
-    }
21
+	/**
22
+	 * converts a Request to a Response
23
+	 *
24
+	 * @param RequestInterface  $request
25
+	 * @param ResponseInterface $response
26
+	 * @return ResponseInterface
27
+	 */
28
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
29
+	{
30
+		$this->request = $request;
31
+		$this->response = $response;
32
+		$this->displayPreProductionVersionWarning();
33
+		$this->response = $this->processRequestStack($this->request, $this->response);
34
+		return $this->response;
35
+	}
36 36
 
37 37
 
38
-    /**
39
-     * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
40
-     *
41
-     * @return void
42
-     */
43
-    public function displayPreProductionVersionWarning()
44
-    {
45
-        // skip AJAX requests
46
-        if ($this->request->isAjax()) {
47
-            return;
48
-        }
49
-        // skip stable releases
50
-        if (substr(EVENT_ESPRESSO_VERSION, -5) !== '.beta') {
51
-            return;
52
-        }
53
-        // site admin has authorized use of non-stable release candidate for production
54
-        if (defined('ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE') && ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE) {
55
-            return;
56
-        }
57
-        // post release candidate warning
58
-        if ($this->request->isAdmin()) {
59
-            add_action('admin_notices', array($this, 'preProductionVersionAdminNotice'), -999);
60
-        } else {
61
-            add_action('shutdown', array($this, 'preProductionVersionWarningNotice'), 10);
62
-        }
63
-    }
38
+	/**
39
+	 * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
40
+	 *
41
+	 * @return void
42
+	 */
43
+	public function displayPreProductionVersionWarning()
44
+	{
45
+		// skip AJAX requests
46
+		if ($this->request->isAjax()) {
47
+			return;
48
+		}
49
+		// skip stable releases
50
+		if (substr(EVENT_ESPRESSO_VERSION, -5) !== '.beta') {
51
+			return;
52
+		}
53
+		// site admin has authorized use of non-stable release candidate for production
54
+		if (defined('ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE') && ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE) {
55
+			return;
56
+		}
57
+		// post release candidate warning
58
+		if ($this->request->isAdmin()) {
59
+			add_action('admin_notices', array($this, 'preProductionVersionAdminNotice'), -999);
60
+		} else {
61
+			add_action('shutdown', array($this, 'preProductionVersionWarningNotice'), 10);
62
+		}
63
+	}
64 64
 
65 65
 
66
-    /**
67
-     * displays admin notice that current version of EE is not a stable release
68
-     *
69
-     * @return void
70
-     * @throws InvalidDataTypeException
71
-     */
72
-    public function preProductionVersionAdminNotice()
73
-    {
74
-        new PersistentAdminNotice(
75
-            'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION,
76
-            $this->warningNotice()
77
-        );
78
-    }
66
+	/**
67
+	 * displays admin notice that current version of EE is not a stable release
68
+	 *
69
+	 * @return void
70
+	 * @throws InvalidDataTypeException
71
+	 */
72
+	public function preProductionVersionAdminNotice()
73
+	{
74
+		new PersistentAdminNotice(
75
+			'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION,
76
+			$this->warningNotice()
77
+		);
78
+	}
79 79
 
80 80
 
81
-    /**
82
-     * displays message on frontend of site notifying admin that current version of EE is not a stable release
83
-     *
84
-     * @return void
85
-     */
86
-    public function preProductionVersionWarningNotice()
87
-    {
88
-        echo '<div id="ee-release-candidate-notice-dv" class="ee-really-important-notice-dv"><p>';
89
-        echo $this->warningNotice();
90
-        echo '</p></div>';
91
-    }
81
+	/**
82
+	 * displays message on frontend of site notifying admin that current version of EE is not a stable release
83
+	 *
84
+	 * @return void
85
+	 */
86
+	public function preProductionVersionWarningNotice()
87
+	{
88
+		echo '<div id="ee-release-candidate-notice-dv" class="ee-really-important-notice-dv"><p>';
89
+		echo $this->warningNotice();
90
+		echo '</p></div>';
91
+	}
92 92
 
93 93
 
94
-    /**
95
-     * @return string
96
-     */
97
-    private function warningNotice()
98
-    {
99
-        return sprintf(
100
-            esc_html__(
101
-                'This version of Event Espresso is for testing and/or evaluation purposes only. It is %1$snot%2$s considered a stable release and should therefore %1$snot%2$s be activated on a live or production website.',
102
-                'event_espresso'
103
-            ),
104
-            '<strong>',
105
-            '</strong>'
106
-        );
107
-    }
94
+	/**
95
+	 * @return string
96
+	 */
97
+	private function warningNotice()
98
+	{
99
+		return sprintf(
100
+			esc_html__(
101
+				'This version of Event Espresso is for testing and/or evaluation purposes only. It is %1$snot%2$s considered a stable release and should therefore %1$snot%2$s be activated on a live or production website.',
102
+				'event_espresso'
103
+			),
104
+			'<strong>',
105
+			'</strong>'
106
+		);
107
+	}
108 108
 }
Please login to merge, or discard this patch.
core/request_stack/EE_Request.core.php 2 patches
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -181,7 +181,7 @@  discard block
 block discarded – undo
181 181
      *
182 182
      * @deprecated 4.9.53
183 183
      * @param      $key
184
-     * @param null $default
184
+     * @param null|string $default
185 185
      * @return mixed
186 186
      * @throws InvalidArgumentException
187 187
      * @throws InvalidDataTypeException
@@ -256,7 +256,7 @@  discard block
 block discarded – undo
256 256
 
257 257
     /**
258 258
      * @deprecated 4.9.53
259
-     * @return mixed
259
+     * @return boolean
260 260
      * @throws InvalidArgumentException
261 261
      * @throws InvalidDataTypeException
262 262
      * @throws InvalidInterfaceException
@@ -269,7 +269,7 @@  discard block
 block discarded – undo
269 269
 
270 270
     /**
271 271
      * @deprecated 4.9.53
272
-     * @return mixed
272
+     * @return boolean
273 273
      * @throws InvalidArgumentException
274 274
      * @throws InvalidDataTypeException
275 275
      * @throws InvalidInterfaceException
@@ -282,7 +282,7 @@  discard block
 block discarded – undo
282 282
 
283 283
     /**
284 284
      * @deprecated 4.9.53
285
-     * @return mixed|string
285
+     * @return string
286 286
      * @throws InvalidArgumentException
287 287
      * @throws InvalidDataTypeException
288 288
      * @throws InvalidInterfaceException
Please login to merge, or discard this patch.
Indentation   +355 added lines, -355 removed lines patch added patch discarded remove patch
@@ -18,359 +18,359 @@
 block discarded – undo
18 18
 class EE_Request implements LegacyRequestInterface, InterminableInterface
19 19
 {
20 20
 
21
-    /**
22
-     * @var RequestInterface $request
23
-     */
24
-    private $request;
25
-
26
-    /**
27
-     * whether current request is for the admin but NOT via AJAX
28
-     *
29
-     * @var boolean $admin
30
-     */
31
-    public $admin = false;
32
-
33
-    /**
34
-     * whether current request is via AJAX
35
-     *
36
-     * @var boolean $ajax
37
-     */
38
-    public $ajax = false;
39
-
40
-    /**
41
-     * whether current request is via AJAX from the frontend of the site
42
-     *
43
-     * @var boolean $front_ajax
44
-     */
45
-    public $front_ajax = false;
46
-
47
-
48
-    /**
49
-     * @deprecated 4.9.53
50
-     * @param array $get
51
-     * @param array $post
52
-     * @param array $cookie
53
-     * @param array $server
54
-     */
55
-    public function __construct(
56
-        array $get = array(),
57
-        array $post = array(),
58
-        array $cookie = array(),
59
-        array $server = array()
60
-    ) {
61
-    }
62
-
63
-
64
-    /**
65
-     * @return RequestInterface
66
-     * @throws InvalidArgumentException
67
-     * @throws InvalidInterfaceException
68
-     * @throws InvalidDataTypeException
69
-     */
70
-    private function request()
71
-    {
72
-        if ($this->request instanceof RequestInterface) {
73
-            return $this->request;
74
-        }
75
-        $loader = LoaderFactory::getLoader();
76
-        $this->request = $loader->getShared('EventEspresso\core\services\request\RequestInterface');
77
-        return $this->request;
78
-    }
79
-
80
-
81
-    /**
82
-     * @param RequestInterface $request
83
-     */
84
-    public function setRequest(RequestInterface $request)
85
-    {
86
-        $this->request = $request;
87
-    }
88
-
89
-
90
-    /**
91
-     * @deprecated 4.9.53
92
-     * @return array
93
-     * @throws InvalidArgumentException
94
-     * @throws InvalidDataTypeException
95
-     * @throws InvalidInterfaceException
96
-     */
97
-    public function get_params()
98
-    {
99
-        return $this->request()->getParams();
100
-    }
101
-
102
-
103
-    /**
104
-     * @deprecated 4.9.53
105
-     * @return array
106
-     * @throws InvalidArgumentException
107
-     * @throws InvalidDataTypeException
108
-     * @throws InvalidInterfaceException
109
-     */
110
-    public function post_params()
111
-    {
112
-        return $this->request()->postParams();
113
-    }
114
-
115
-
116
-    /**
117
-     * @deprecated 4.9.53
118
-     * @return array
119
-     * @throws InvalidArgumentException
120
-     * @throws InvalidDataTypeException
121
-     * @throws InvalidInterfaceException
122
-     */
123
-    public function cookie_params()
124
-    {
125
-        return $this->request()->cookieParams();
126
-    }
127
-
128
-
129
-    /**
130
-     * @deprecated 4.9.53
131
-     * @return array
132
-     * @throws InvalidArgumentException
133
-     * @throws InvalidDataTypeException
134
-     * @throws InvalidInterfaceException
135
-     */
136
-    public function server_params()
137
-    {
138
-        return $this->request()->serverParams();
139
-    }
140
-
141
-
142
-    /**
143
-     * returns contents of $_REQUEST
144
-     *
145
-     * @deprecated 4.9.53
146
-     * @return array
147
-     * @throws InvalidArgumentException
148
-     * @throws InvalidDataTypeException
149
-     * @throws InvalidInterfaceException
150
-     */
151
-    public function params()
152
-    {
153
-        return $this->request()->requestParams();
154
-    }
155
-
156
-
157
-    /**
158
-     * @deprecated 4.9.53
159
-     * @param      $key
160
-     * @param      $value
161
-     * @param bool $override_ee
162
-     * @return void
163
-     * @throws InvalidArgumentException
164
-     * @throws InvalidDataTypeException
165
-     * @throws InvalidInterfaceException
166
-     */
167
-    public function set($key, $value, $override_ee = false)
168
-    {
169
-        $this->request()->setRequestParam($key, $value, $override_ee);
170
-    }
171
-
172
-
173
-    /**
174
-     * returns   the value for a request param if the given key exists
175
-     *
176
-     * @deprecated 4.9.53
177
-     * @param      $key
178
-     * @param null $default
179
-     * @return mixed
180
-     * @throws InvalidArgumentException
181
-     * @throws InvalidDataTypeException
182
-     * @throws InvalidInterfaceException
183
-     */
184
-    public function get($key, $default = null)
185
-    {
186
-        return $this->request()->getRequestParam($key, $default);
187
-    }
188
-
189
-
190
-    /**
191
-     * check if param exists
192
-     *
193
-     * @deprecated 4.9.53
194
-     * @param $key
195
-     * @return bool
196
-     * @throws InvalidArgumentException
197
-     * @throws InvalidDataTypeException
198
-     * @throws InvalidInterfaceException
199
-     */
200
-    public function is_set($key)
201
-    {
202
-        return $this->request()->requestParamIsSet($key);
203
-    }
204
-
205
-
206
-    /**
207
-     * remove param
208
-     *
209
-     * @deprecated 4.9.53
210
-     * @param      $key
211
-     * @param bool $unset_from_global_too
212
-     * @throws InvalidArgumentException
213
-     * @throws InvalidDataTypeException
214
-     * @throws InvalidInterfaceException
215
-     */
216
-    public function un_set($key, $unset_from_global_too = false)
217
-    {
218
-        $this->request()->unSetRequestParam($key, $unset_from_global_too);
219
-    }
220
-
221
-
222
-    /**
223
-     * @deprecated 4.9.53
224
-     * @return string
225
-     * @throws InvalidArgumentException
226
-     * @throws InvalidDataTypeException
227
-     * @throws InvalidInterfaceException
228
-     */
229
-    public function ip_address()
230
-    {
231
-        return $this->request()->ipAddress();
232
-    }
233
-
234
-
235
-    /**
236
-     * @deprecated 4.9.53
237
-     * @return bool
238
-     * @throws InvalidArgumentException
239
-     * @throws InvalidDataTypeException
240
-     * @throws InvalidInterfaceException
241
-     */
242
-    public function isAdmin()
243
-    {
244
-        return $this->request()->isAdmin();
245
-    }
246
-
247
-
248
-    /**
249
-     * @deprecated 4.9.53
250
-     * @return mixed
251
-     * @throws InvalidArgumentException
252
-     * @throws InvalidDataTypeException
253
-     * @throws InvalidInterfaceException
254
-     */
255
-    public function isAjax()
256
-    {
257
-        return $this->request()->isAjax();
258
-    }
259
-
260
-
261
-    /**
262
-     * @deprecated 4.9.53
263
-     * @return mixed
264
-     * @throws InvalidArgumentException
265
-     * @throws InvalidDataTypeException
266
-     * @throws InvalidInterfaceException
267
-     */
268
-    public function isFrontAjax()
269
-    {
270
-        return $this->request()->isFrontAjax();
271
-    }
272
-
273
-
274
-    /**
275
-     * @deprecated 4.9.53
276
-     * @return mixed|string
277
-     * @throws InvalidArgumentException
278
-     * @throws InvalidDataTypeException
279
-     * @throws InvalidInterfaceException
280
-     */
281
-    public function requestUri()
282
-    {
283
-        return $this->request()->requestUri();
284
-    }
285
-
286
-
287
-    /**
288
-     * @deprecated 4.9.53
289
-     * @return string
290
-     * @throws InvalidArgumentException
291
-     * @throws InvalidDataTypeException
292
-     * @throws InvalidInterfaceException
293
-     */
294
-    public function userAgent()
295
-    {
296
-        return $this->request()->userAgent();
297
-    }
298
-
299
-
300
-    /**
301
-     * @deprecated 4.9.53
302
-     * @param string $user_agent
303
-     * @throws InvalidArgumentException
304
-     * @throws InvalidDataTypeException
305
-     * @throws InvalidInterfaceException
306
-     */
307
-    public function setUserAgent($user_agent = '')
308
-    {
309
-        $this->request()->setUserAgent($user_agent);
310
-    }
311
-
312
-
313
-    /**
314
-     * @deprecated 4.9.53
315
-     * @return bool
316
-     * @throws InvalidArgumentException
317
-     * @throws InvalidDataTypeException
318
-     * @throws InvalidInterfaceException
319
-     */
320
-    public function isBot()
321
-    {
322
-        return $this->request()->isBot();
323
-    }
324
-
325
-
326
-    /**
327
-     * @deprecated 4.9.53
328
-     * @param bool $is_bot
329
-     * @throws InvalidArgumentException
330
-     * @throws InvalidDataTypeException
331
-     * @throws InvalidInterfaceException
332
-     */
333
-    public function setIsBot($is_bot)
334
-    {
335
-        $this->request()->setIsBot($is_bot);
336
-    }
337
-
338
-
339
-    /**
340
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
341
-     * and return the value for the first match found
342
-     * wildcards can be either of the following:
343
-     *      ? to represent a single character of any type
344
-     *      * to represent one or more characters of any type
345
-     *
346
-     * @param string     $pattern
347
-     * @param null|mixed $default
348
-     * @return false|int
349
-     * @throws InvalidArgumentException
350
-     * @throws InvalidInterfaceException
351
-     * @throws InvalidDataTypeException
352
-     */
353
-    public function getMatch($pattern, $default = null)
354
-    {
355
-        return $this->request()->getMatch($pattern, $default);
356
-    }
357
-
358
-
359
-    /**
360
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
361
-     * wildcards can be either of the following:
362
-     *      ? to represent a single character of any type
363
-     *      * to represent one or more characters of any type
364
-     * returns true if a match is found or false if not
365
-     *
366
-     * @param string $pattern
367
-     * @return false|int
368
-     * @throws InvalidArgumentException
369
-     * @throws InvalidInterfaceException
370
-     * @throws InvalidDataTypeException
371
-     */
372
-    public function matches($pattern)
373
-    {
374
-        return $this->request()->matches($pattern);
375
-    }
21
+	/**
22
+	 * @var RequestInterface $request
23
+	 */
24
+	private $request;
25
+
26
+	/**
27
+	 * whether current request is for the admin but NOT via AJAX
28
+	 *
29
+	 * @var boolean $admin
30
+	 */
31
+	public $admin = false;
32
+
33
+	/**
34
+	 * whether current request is via AJAX
35
+	 *
36
+	 * @var boolean $ajax
37
+	 */
38
+	public $ajax = false;
39
+
40
+	/**
41
+	 * whether current request is via AJAX from the frontend of the site
42
+	 *
43
+	 * @var boolean $front_ajax
44
+	 */
45
+	public $front_ajax = false;
46
+
47
+
48
+	/**
49
+	 * @deprecated 4.9.53
50
+	 * @param array $get
51
+	 * @param array $post
52
+	 * @param array $cookie
53
+	 * @param array $server
54
+	 */
55
+	public function __construct(
56
+		array $get = array(),
57
+		array $post = array(),
58
+		array $cookie = array(),
59
+		array $server = array()
60
+	) {
61
+	}
62
+
63
+
64
+	/**
65
+	 * @return RequestInterface
66
+	 * @throws InvalidArgumentException
67
+	 * @throws InvalidInterfaceException
68
+	 * @throws InvalidDataTypeException
69
+	 */
70
+	private function request()
71
+	{
72
+		if ($this->request instanceof RequestInterface) {
73
+			return $this->request;
74
+		}
75
+		$loader = LoaderFactory::getLoader();
76
+		$this->request = $loader->getShared('EventEspresso\core\services\request\RequestInterface');
77
+		return $this->request;
78
+	}
79
+
80
+
81
+	/**
82
+	 * @param RequestInterface $request
83
+	 */
84
+	public function setRequest(RequestInterface $request)
85
+	{
86
+		$this->request = $request;
87
+	}
88
+
89
+
90
+	/**
91
+	 * @deprecated 4.9.53
92
+	 * @return array
93
+	 * @throws InvalidArgumentException
94
+	 * @throws InvalidDataTypeException
95
+	 * @throws InvalidInterfaceException
96
+	 */
97
+	public function get_params()
98
+	{
99
+		return $this->request()->getParams();
100
+	}
101
+
102
+
103
+	/**
104
+	 * @deprecated 4.9.53
105
+	 * @return array
106
+	 * @throws InvalidArgumentException
107
+	 * @throws InvalidDataTypeException
108
+	 * @throws InvalidInterfaceException
109
+	 */
110
+	public function post_params()
111
+	{
112
+		return $this->request()->postParams();
113
+	}
114
+
115
+
116
+	/**
117
+	 * @deprecated 4.9.53
118
+	 * @return array
119
+	 * @throws InvalidArgumentException
120
+	 * @throws InvalidDataTypeException
121
+	 * @throws InvalidInterfaceException
122
+	 */
123
+	public function cookie_params()
124
+	{
125
+		return $this->request()->cookieParams();
126
+	}
127
+
128
+
129
+	/**
130
+	 * @deprecated 4.9.53
131
+	 * @return array
132
+	 * @throws InvalidArgumentException
133
+	 * @throws InvalidDataTypeException
134
+	 * @throws InvalidInterfaceException
135
+	 */
136
+	public function server_params()
137
+	{
138
+		return $this->request()->serverParams();
139
+	}
140
+
141
+
142
+	/**
143
+	 * returns contents of $_REQUEST
144
+	 *
145
+	 * @deprecated 4.9.53
146
+	 * @return array
147
+	 * @throws InvalidArgumentException
148
+	 * @throws InvalidDataTypeException
149
+	 * @throws InvalidInterfaceException
150
+	 */
151
+	public function params()
152
+	{
153
+		return $this->request()->requestParams();
154
+	}
155
+
156
+
157
+	/**
158
+	 * @deprecated 4.9.53
159
+	 * @param      $key
160
+	 * @param      $value
161
+	 * @param bool $override_ee
162
+	 * @return void
163
+	 * @throws InvalidArgumentException
164
+	 * @throws InvalidDataTypeException
165
+	 * @throws InvalidInterfaceException
166
+	 */
167
+	public function set($key, $value, $override_ee = false)
168
+	{
169
+		$this->request()->setRequestParam($key, $value, $override_ee);
170
+	}
171
+
172
+
173
+	/**
174
+	 * returns   the value for a request param if the given key exists
175
+	 *
176
+	 * @deprecated 4.9.53
177
+	 * @param      $key
178
+	 * @param null $default
179
+	 * @return mixed
180
+	 * @throws InvalidArgumentException
181
+	 * @throws InvalidDataTypeException
182
+	 * @throws InvalidInterfaceException
183
+	 */
184
+	public function get($key, $default = null)
185
+	{
186
+		return $this->request()->getRequestParam($key, $default);
187
+	}
188
+
189
+
190
+	/**
191
+	 * check if param exists
192
+	 *
193
+	 * @deprecated 4.9.53
194
+	 * @param $key
195
+	 * @return bool
196
+	 * @throws InvalidArgumentException
197
+	 * @throws InvalidDataTypeException
198
+	 * @throws InvalidInterfaceException
199
+	 */
200
+	public function is_set($key)
201
+	{
202
+		return $this->request()->requestParamIsSet($key);
203
+	}
204
+
205
+
206
+	/**
207
+	 * remove param
208
+	 *
209
+	 * @deprecated 4.9.53
210
+	 * @param      $key
211
+	 * @param bool $unset_from_global_too
212
+	 * @throws InvalidArgumentException
213
+	 * @throws InvalidDataTypeException
214
+	 * @throws InvalidInterfaceException
215
+	 */
216
+	public function un_set($key, $unset_from_global_too = false)
217
+	{
218
+		$this->request()->unSetRequestParam($key, $unset_from_global_too);
219
+	}
220
+
221
+
222
+	/**
223
+	 * @deprecated 4.9.53
224
+	 * @return string
225
+	 * @throws InvalidArgumentException
226
+	 * @throws InvalidDataTypeException
227
+	 * @throws InvalidInterfaceException
228
+	 */
229
+	public function ip_address()
230
+	{
231
+		return $this->request()->ipAddress();
232
+	}
233
+
234
+
235
+	/**
236
+	 * @deprecated 4.9.53
237
+	 * @return bool
238
+	 * @throws InvalidArgumentException
239
+	 * @throws InvalidDataTypeException
240
+	 * @throws InvalidInterfaceException
241
+	 */
242
+	public function isAdmin()
243
+	{
244
+		return $this->request()->isAdmin();
245
+	}
246
+
247
+
248
+	/**
249
+	 * @deprecated 4.9.53
250
+	 * @return mixed
251
+	 * @throws InvalidArgumentException
252
+	 * @throws InvalidDataTypeException
253
+	 * @throws InvalidInterfaceException
254
+	 */
255
+	public function isAjax()
256
+	{
257
+		return $this->request()->isAjax();
258
+	}
259
+
260
+
261
+	/**
262
+	 * @deprecated 4.9.53
263
+	 * @return mixed
264
+	 * @throws InvalidArgumentException
265
+	 * @throws InvalidDataTypeException
266
+	 * @throws InvalidInterfaceException
267
+	 */
268
+	public function isFrontAjax()
269
+	{
270
+		return $this->request()->isFrontAjax();
271
+	}
272
+
273
+
274
+	/**
275
+	 * @deprecated 4.9.53
276
+	 * @return mixed|string
277
+	 * @throws InvalidArgumentException
278
+	 * @throws InvalidDataTypeException
279
+	 * @throws InvalidInterfaceException
280
+	 */
281
+	public function requestUri()
282
+	{
283
+		return $this->request()->requestUri();
284
+	}
285
+
286
+
287
+	/**
288
+	 * @deprecated 4.9.53
289
+	 * @return string
290
+	 * @throws InvalidArgumentException
291
+	 * @throws InvalidDataTypeException
292
+	 * @throws InvalidInterfaceException
293
+	 */
294
+	public function userAgent()
295
+	{
296
+		return $this->request()->userAgent();
297
+	}
298
+
299
+
300
+	/**
301
+	 * @deprecated 4.9.53
302
+	 * @param string $user_agent
303
+	 * @throws InvalidArgumentException
304
+	 * @throws InvalidDataTypeException
305
+	 * @throws InvalidInterfaceException
306
+	 */
307
+	public function setUserAgent($user_agent = '')
308
+	{
309
+		$this->request()->setUserAgent($user_agent);
310
+	}
311
+
312
+
313
+	/**
314
+	 * @deprecated 4.9.53
315
+	 * @return bool
316
+	 * @throws InvalidArgumentException
317
+	 * @throws InvalidDataTypeException
318
+	 * @throws InvalidInterfaceException
319
+	 */
320
+	public function isBot()
321
+	{
322
+		return $this->request()->isBot();
323
+	}
324
+
325
+
326
+	/**
327
+	 * @deprecated 4.9.53
328
+	 * @param bool $is_bot
329
+	 * @throws InvalidArgumentException
330
+	 * @throws InvalidDataTypeException
331
+	 * @throws InvalidInterfaceException
332
+	 */
333
+	public function setIsBot($is_bot)
334
+	{
335
+		$this->request()->setIsBot($is_bot);
336
+	}
337
+
338
+
339
+	/**
340
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
341
+	 * and return the value for the first match found
342
+	 * wildcards can be either of the following:
343
+	 *      ? to represent a single character of any type
344
+	 *      * to represent one or more characters of any type
345
+	 *
346
+	 * @param string     $pattern
347
+	 * @param null|mixed $default
348
+	 * @return false|int
349
+	 * @throws InvalidArgumentException
350
+	 * @throws InvalidInterfaceException
351
+	 * @throws InvalidDataTypeException
352
+	 */
353
+	public function getMatch($pattern, $default = null)
354
+	{
355
+		return $this->request()->getMatch($pattern, $default);
356
+	}
357
+
358
+
359
+	/**
360
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
361
+	 * wildcards can be either of the following:
362
+	 *      ? to represent a single character of any type
363
+	 *      * to represent one or more characters of any type
364
+	 * returns true if a match is found or false if not
365
+	 *
366
+	 * @param string $pattern
367
+	 * @return false|int
368
+	 * @throws InvalidArgumentException
369
+	 * @throws InvalidInterfaceException
370
+	 * @throws InvalidDataTypeException
371
+	 */
372
+	public function matches($pattern)
373
+	{
374
+		return $this->request()->matches($pattern);
375
+	}
376 376
 }
Please login to merge, or discard this patch.
core/services/request/RequestStack.php 2 patches
Indentation   +45 added lines, -45 removed lines patch added patch discarded remove patch
@@ -19,59 +19,59 @@
 block discarded – undo
19 19
 class RequestStack
20 20
 {
21 21
 
22
-    /**
23
-     * @var RequestDecoratorInterface $request_stack_app
24
-     */
25
-    protected $request_stack_app;
22
+	/**
23
+	 * @var RequestDecoratorInterface $request_stack_app
24
+	 */
25
+	protected $request_stack_app;
26 26
 
27
-    /**
28
-     * @var RequestStackCoreAppInterface $core_app
29
-     */
30
-    protected $core_app;
27
+	/**
28
+	 * @var RequestStackCoreAppInterface $core_app
29
+	 */
30
+	protected $core_app;
31 31
 
32
-    /**
33
-     * @var RequestInterface $request
34
-     */
35
-    protected $request;
32
+	/**
33
+	 * @var RequestInterface $request
34
+	 */
35
+	protected $request;
36 36
 
37
-    /**
38
-     * @var ResponseInterface $response
39
-     */
40
-    protected $response;
37
+	/**
38
+	 * @var ResponseInterface $response
39
+	 */
40
+	protected $response;
41 41
 
42 42
 
43
-    /**
44
-     * @param RequestDecoratorInterface    $request_stack_app
45
-     * @param RequestStackCoreAppInterface $core_app
46
-     */
47
-    public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app)
48
-    {
49
-        $this->request_stack_app = $request_stack_app;
50
-        $this->core_app      = $core_app;
51
-    }
43
+	/**
44
+	 * @param RequestDecoratorInterface    $request_stack_app
45
+	 * @param RequestStackCoreAppInterface $core_app
46
+	 */
47
+	public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app)
48
+	{
49
+		$this->request_stack_app = $request_stack_app;
50
+		$this->core_app      = $core_app;
51
+	}
52 52
 
53 53
 
54
-    /**
55
-     * @param RequestInterface  $request
56
-     * @param ResponseInterface $response
57
-     * @return ResponseInterface
58
-     */
59
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
60
-    {
61
-        $this->request  = $request;
62
-        $this->response = $response;
63
-        return $this->request_stack_app->handleRequest($request, $response);
64
-    }
54
+	/**
55
+	 * @param RequestInterface  $request
56
+	 * @param ResponseInterface $response
57
+	 * @return ResponseInterface
58
+	 */
59
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
60
+	{
61
+		$this->request  = $request;
62
+		$this->response = $response;
63
+		return $this->request_stack_app->handleRequest($request, $response);
64
+	}
65 65
 
66 66
 
67
-    /**
68
-     * handle_response
69
-     * executes the handle_response() method on the RequestStackCoreAppInterface object
70
-     * after the request stack has been fully processed
71
-     */
72
-    public function handleResponse()
73
-    {
74
-        $this->core_app->handleResponse($this->request, $this->response);
75
-    }
67
+	/**
68
+	 * handle_response
69
+	 * executes the handle_response() method on the RequestStackCoreAppInterface object
70
+	 * after the request stack has been fully processed
71
+	 */
72
+	public function handleResponse()
73
+	{
74
+		$this->core_app->handleResponse($this->request, $this->response);
75
+	}
76 76
 }
77 77
 // Location: RequestStack.php
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -47,7 +47,7 @@
 block discarded – undo
47 47
     public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app)
48 48
     {
49 49
         $this->request_stack_app = $request_stack_app;
50
-        $this->core_app      = $core_app;
50
+        $this->core_app = $core_app;
51 51
     }
52 52
 
53 53
 
Please login to merge, or discard this patch.
core/services/collections/iterators/CollectionFilterCallbackIterator.php 1 patch
Indentation   +47 added lines, -47 removed lines patch added patch discarded remove patch
@@ -9,51 +9,51 @@
 block discarded – undo
9 9
 class CollectionFilterCallbackIterator extends FilterIterator
10 10
 {
11 11
 
12
-    /**
13
-     * Used for determining whether the iterated object in the Collection is "valid" or not.
14
-     * @var Closure
15
-     */
16
-    private $acceptance_callback;
17
-
18
-
19
-    /**
20
-     * CollectionFilterCallbackIterator constructor.
21
-     *
22
-     * @param Collection $collection
23
-     * @param Closure    $acceptance_callback  The closure will receive an instance of whatever object is stored on the
24
-     *                                         collection when iterating over the collection and should return boolean.
25
-     */
26
-    public function __construct(Collection $collection, Closure $acceptance_callback)
27
-    {
28
-        $this->acceptance_callback = $acceptance_callback;
29
-        parent::__construct($collection);
30
-    }
31
-
32
-    /**
33
-     * Check whether the current element of the iterator is acceptable
34
-     *
35
-     * @link  http://php.net/manual/en/filteriterator.accept.php
36
-     * @return bool true if the current element is acceptable, otherwise false.
37
-     */
38
-    public function accept()
39
-    {
40
-        $acceptance_callback = $this->acceptance_callback;
41
-        return $acceptance_callback($this->getInnerIterator()->current());
42
-    }
43
-
44
-
45
-
46
-    /**
47
-     * Returns a filtered array of objects from the collection using the provided acceptance callback
48
-     * @return array
49
-     */
50
-    public function getFiltered()
51
-    {
52
-        $filtered_array = array();
53
-        $this->rewind();
54
-        foreach ($this as $filtered_object) {
55
-            $filtered_array[] = $filtered_object;
56
-        }
57
-        return $filtered_array;
58
-    }
12
+	/**
13
+	 * Used for determining whether the iterated object in the Collection is "valid" or not.
14
+	 * @var Closure
15
+	 */
16
+	private $acceptance_callback;
17
+
18
+
19
+	/**
20
+	 * CollectionFilterCallbackIterator constructor.
21
+	 *
22
+	 * @param Collection $collection
23
+	 * @param Closure    $acceptance_callback  The closure will receive an instance of whatever object is stored on the
24
+	 *                                         collection when iterating over the collection and should return boolean.
25
+	 */
26
+	public function __construct(Collection $collection, Closure $acceptance_callback)
27
+	{
28
+		$this->acceptance_callback = $acceptance_callback;
29
+		parent::__construct($collection);
30
+	}
31
+
32
+	/**
33
+	 * Check whether the current element of the iterator is acceptable
34
+	 *
35
+	 * @link  http://php.net/manual/en/filteriterator.accept.php
36
+	 * @return bool true if the current element is acceptable, otherwise false.
37
+	 */
38
+	public function accept()
39
+	{
40
+		$acceptance_callback = $this->acceptance_callback;
41
+		return $acceptance_callback($this->getInnerIterator()->current());
42
+	}
43
+
44
+
45
+
46
+	/**
47
+	 * Returns a filtered array of objects from the collection using the provided acceptance callback
48
+	 * @return array
49
+	 */
50
+	public function getFiltered()
51
+	{
52
+		$filtered_array = array();
53
+		$this->rewind();
54
+		foreach ($this as $filtered_object) {
55
+			$filtered_array[] = $filtered_object;
56
+		}
57
+		return $filtered_array;
58
+	}
59 59
 }
Please login to merge, or discard this patch.
core/EE_Load_Espresso_Core.core.php 2 patches
Unused Use Statements   -5 removed lines patch added patch discarded remove patch
@@ -1,12 +1,7 @@
 block discarded – undo
1 1
 <?php
2 2
 
3
-use EventEspresso\core\domain\DomainFactory;
4
-use EventEspresso\core\domain\values\FilePath;
5
-use EventEspresso\core\domain\values\FullyQualifiedName;
6
-use EventEspresso\core\domain\values\Version;
7 3
 use EventEspresso\core\exceptions\InvalidDataTypeException;
8 4
 use EventEspresso\core\exceptions\InvalidInterfaceException;
9
-use EventEspresso\core\services\loaders\LoaderFactory;
10 5
 use EventEspresso\core\services\request\RequestDecoratorInterface;
11 6
 use EventEspresso\core\services\request\RequestInterface;
12 7
 use EventEspresso\core\services\request\RequestStackCoreAppInterface;
Please login to merge, or discard this patch.
Indentation   +110 added lines, -110 removed lines patch added patch discarded remove patch
@@ -27,114 +27,114 @@
 block discarded – undo
27 27
 class EE_Load_Espresso_Core implements RequestDecoratorInterface, RequestStackCoreAppInterface
28 28
 {
29 29
 
30
-    /**
31
-     * @var RequestInterface $request
32
-     */
33
-    protected $request;
34
-
35
-    /**
36
-     * @var ResponseInterface $response
37
-     */
38
-    protected $response;
39
-
40
-    /**
41
-     * @var EE_Dependency_Map $dependency_map
42
-     */
43
-    protected $dependency_map;
44
-
45
-    /**
46
-     * @var EE_Registry $registry
47
-     */
48
-    protected $registry;
49
-
50
-
51
-    /**
52
-     * EE_Load_Espresso_Core constructor
53
-     *
54
-     * @param EE_Registry       $registry
55
-     * @param EE_Dependency_Map $dependency_map
56
-     * @throws EE_Error
57
-     */
58
-    public function __construct(EE_Registry $registry, EE_Dependency_Map $dependency_map)
59
-    {
60
-        EE_Error::doing_it_wrong(
61
-            __METHOD__,
62
-            sprintf(
63
-                esc_html__(
64
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
65
-                    'event_espresso'
66
-                ),
67
-                'EventEspresso\core\services\request\RequestStackCoreApp',
68
-                '\core\services\request',
69
-                'EventEspresso\core\services\request'
70
-            ),
71
-            '4.9.53'
72
-        );
73
-    }
74
-
75
-
76
-    /**
77
-     * handle
78
-     * sets hooks for running rest of system
79
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
80
-     * starting EE Addons from any other point may lead to problems
81
-     *
82
-     * @param RequestInterface  $request
83
-     * @param ResponseInterface $response
84
-     * @return ResponseInterface
85
-     * @throws EE_Error
86
-     * @throws InvalidDataTypeException
87
-     * @throws InvalidInterfaceException
88
-     * @throws InvalidArgumentException
89
-     * @throws DomainException
90
-     */
91
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
92
-    {
93
-    }
94
-
95
-
96
-    /**
97
-     * @return RequestInterface
98
-     */
99
-    public function request()
100
-    {
101
-    }
102
-
103
-
104
-    /**
105
-     * @return ResponseInterface
106
-     */
107
-    public function response()
108
-    {
109
-    }
110
-
111
-
112
-    /**
113
-     * @return EE_Dependency_Map
114
-     * @throws EE_Error
115
-     */
116
-    public function dependency_map()
117
-    {
118
-    }
119
-
120
-
121
-    /**
122
-     * @return EE_Registry
123
-     * @throws EE_Error
124
-     */
125
-    public function registry()
126
-    {
127
-    }
128
-
129
-
130
-    /**
131
-     * called after the request stack has been fully processed
132
-     * if any of the middleware apps has requested the plugin be deactivated, then we do that now
133
-     *
134
-     * @param RequestInterface  $request
135
-     * @param ResponseInterface $response
136
-     */
137
-    public function handleResponse(RequestInterface $request, ResponseInterface $response)
138
-    {
139
-    }
30
+	/**
31
+	 * @var RequestInterface $request
32
+	 */
33
+	protected $request;
34
+
35
+	/**
36
+	 * @var ResponseInterface $response
37
+	 */
38
+	protected $response;
39
+
40
+	/**
41
+	 * @var EE_Dependency_Map $dependency_map
42
+	 */
43
+	protected $dependency_map;
44
+
45
+	/**
46
+	 * @var EE_Registry $registry
47
+	 */
48
+	protected $registry;
49
+
50
+
51
+	/**
52
+	 * EE_Load_Espresso_Core constructor
53
+	 *
54
+	 * @param EE_Registry       $registry
55
+	 * @param EE_Dependency_Map $dependency_map
56
+	 * @throws EE_Error
57
+	 */
58
+	public function __construct(EE_Registry $registry, EE_Dependency_Map $dependency_map)
59
+	{
60
+		EE_Error::doing_it_wrong(
61
+			__METHOD__,
62
+			sprintf(
63
+				esc_html__(
64
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
65
+					'event_espresso'
66
+				),
67
+				'EventEspresso\core\services\request\RequestStackCoreApp',
68
+				'\core\services\request',
69
+				'EventEspresso\core\services\request'
70
+			),
71
+			'4.9.53'
72
+		);
73
+	}
74
+
75
+
76
+	/**
77
+	 * handle
78
+	 * sets hooks for running rest of system
79
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
80
+	 * starting EE Addons from any other point may lead to problems
81
+	 *
82
+	 * @param RequestInterface  $request
83
+	 * @param ResponseInterface $response
84
+	 * @return ResponseInterface
85
+	 * @throws EE_Error
86
+	 * @throws InvalidDataTypeException
87
+	 * @throws InvalidInterfaceException
88
+	 * @throws InvalidArgumentException
89
+	 * @throws DomainException
90
+	 */
91
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
92
+	{
93
+	}
94
+
95
+
96
+	/**
97
+	 * @return RequestInterface
98
+	 */
99
+	public function request()
100
+	{
101
+	}
102
+
103
+
104
+	/**
105
+	 * @return ResponseInterface
106
+	 */
107
+	public function response()
108
+	{
109
+	}
110
+
111
+
112
+	/**
113
+	 * @return EE_Dependency_Map
114
+	 * @throws EE_Error
115
+	 */
116
+	public function dependency_map()
117
+	{
118
+	}
119
+
120
+
121
+	/**
122
+	 * @return EE_Registry
123
+	 * @throws EE_Error
124
+	 */
125
+	public function registry()
126
+	{
127
+	}
128
+
129
+
130
+	/**
131
+	 * called after the request stack has been fully processed
132
+	 * if any of the middleware apps has requested the plugin be deactivated, then we do that now
133
+	 *
134
+	 * @param RequestInterface  $request
135
+	 * @param ResponseInterface $response
136
+	 */
137
+	public function handleResponse(RequestInterface $request, ResponseInterface $response)
138
+	{
139
+	}
140 140
 }
Please login to merge, or discard this patch.
admin_pages/messages/Messages_Admin_Page.core.php 3 patches
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -2597,7 +2597,7 @@  discard block
 block discarded – undo
2597 2597
      *
2598 2598
      * @param int $index This helps us know which template field to select from the request array.
2599 2599
      *
2600
-     * @return array
2600
+     * @return string
2601 2601
      */
2602 2602
     protected function _set_message_template_column_values($index)
2603 2603
     {
@@ -3088,7 +3088,7 @@  discard block
 block discarded – undo
3088 3088
      *
3089 3089
      * @param  int  $GRP_ID        The group being deleted
3090 3090
      * @param  bool $include_group whether to delete the Message Template Group as well.
3091
-     * @return bool boolean to indicate the success of the deletes or not.
3091
+     * @return integer boolean to indicate the success of the deletes or not.
3092 3092
      * @throws EE_Error
3093 3093
      * @throws InvalidArgumentException
3094 3094
      * @throws InvalidDataTypeException
Please login to merge, or discard this patch.
Spacing   +210 added lines, -210 removed lines patch added patch discarded remove patch
@@ -141,8 +141,8 @@  discard block
 block discarded – undo
141 141
         $i = 1;
142 142
         foreach ($active_messengers as $active_messenger) {
143 143
             if ($active_messenger instanceof EE_Message) {
144
-                $m_values[ $i ]['id'] = $active_messenger->messenger();
145
-                $m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
144
+                $m_values[$i]['id'] = $active_messenger->messenger();
145
+                $m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
146 146
                 $i++;
147 147
             }
148 148
         }
@@ -178,8 +178,8 @@  discard block
 block discarded – undo
178 178
         $i = 1;
179 179
         foreach ($active_messages as $active_message) {
180 180
             if ($active_message instanceof EE_Message) {
181
-                $mt_values[ $i ]['id'] = $active_message->message_type();
182
-                $mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
181
+                $mt_values[$i]['id'] = $active_message->message_type();
182
+                $mt_values[$i]['text'] = ucwords($active_message->message_type_label());
183 183
                 $i++;
184 184
             }
185 185
         }
@@ -218,7 +218,7 @@  discard block
 block discarded – undo
218 218
                 if ($message_type instanceof EE_message_type) {
219 219
                     $message_type_contexts = $message_type->get_contexts();
220 220
                     foreach ($message_type_contexts as $context => $context_details) {
221
-                        $contexts[ $context ] = $context_details['label'];
221
+                        $contexts[$context] = $context_details['label'];
222 222
                     }
223 223
                 }
224 224
             }
@@ -709,53 +709,53 @@  discard block
 block discarded – undo
709 709
 
710 710
     public function messages_help_tab()
711 711
     {
712
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
712
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_help_tab.template.php');
713 713
     }
714 714
 
715 715
 
716 716
     public function messengers_help_tab()
717 717
     {
718
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
718
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messenger_help_tab.template.php');
719 719
     }
720 720
 
721 721
 
722 722
     public function message_types_help_tab()
723 723
     {
724
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
724
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_message_type_help_tab.template.php');
725 725
     }
726 726
 
727 727
 
728 728
     public function messages_overview_help_tab()
729 729
     {
730
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
730
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_overview_help_tab.template.php');
731 731
     }
732 732
 
733 733
 
734 734
     public function message_templates_help_tab()
735 735
     {
736
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
736
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_message_templates_help_tab.template.php');
737 737
     }
738 738
 
739 739
 
740 740
     public function edit_message_template_help_tab()
741 741
     {
742
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
742
+        $args['img1'] = '<img src="'.EE_MSG_ASSETS_URL.'images/editor.png'.'" alt="'
743 743
                         . esc_attr__('Editor Title', 'event_espresso')
744 744
                         . '" />';
745
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
745
+        $args['img2'] = '<img src="'.EE_MSG_ASSETS_URL.'images/switch-context.png'.'" alt="'
746 746
                         . esc_attr__('Context Switcher and Preview', 'event_espresso')
747 747
                         . '" />';
748
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
748
+        $args['img3'] = '<img class="left" src="'.EE_MSG_ASSETS_URL.'images/form-fields.png'.'" alt="'
749 749
                         . esc_attr__('Message Template Form Fields', 'event_espresso')
750 750
                         . '" />';
751
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
751
+        $args['img4'] = '<img class="right" src="'.EE_MSG_ASSETS_URL.'images/shortcodes-metabox.png'.'" alt="'
752 752
                         . esc_attr__('Shortcodes Metabox', 'event_espresso')
753 753
                         . '" />';
754
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
754
+        $args['img5'] = '<img class="right" src="'.EE_MSG_ASSETS_URL.'images/publish-meta-box.png'.'" alt="'
755 755
                         . esc_attr__('Publish Metabox', 'event_espresso')
756 756
                         . '" />';
757 757
         EEH_Template::display_template(
758
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
758
+            EE_MSG_TEMPLATE_PATH.'ee_msg_messages_templates_editor_help_tab.template.php',
759 759
             $args
760 760
         );
761 761
     }
@@ -766,7 +766,7 @@  discard block
 block discarded – undo
766 766
         $this->_set_shortcodes();
767 767
         $args['shortcodes'] = $this->_shortcodes;
768 768
         EEH_Template::display_template(
769
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
769
+            EE_MSG_TEMPLATE_PATH.'ee_msg_messages_shortcodes_help_tab.template.php',
770 770
             $args
771 771
         );
772 772
     }
@@ -774,16 +774,16 @@  discard block
 block discarded – undo
774 774
 
775 775
     public function preview_message_help_tab()
776 776
     {
777
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
777
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_preview_help_tab.template.php');
778 778
     }
779 779
 
780 780
 
781 781
     public function settings_help_tab()
782 782
     {
783
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
784
-                        . '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
785
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
786
-                        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
783
+        $args['img1'] = '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-active.png'
784
+                        . '" alt="'.esc_attr__('Active Email Tab', 'event_espresso').'" />';
785
+        $args['img2'] = '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-inactive.png'
786
+                        . '" alt="'.esc_attr__('Inactive Email Tab', 'event_espresso').'" />';
787 787
         $args['img3'] = '<div class="switch">'
788 788
                         . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
789 789
                         . ' type="checkbox" checked="checked">'
@@ -794,25 +794,25 @@  discard block
 block discarded – undo
794 794
                         . ' type="checkbox">'
795 795
                         . '<label for="ee-on-off-toggle-on"></label>'
796 796
                         . '</div>';
797
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
797
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_settings_help_tab.template.php', $args);
798 798
     }
799 799
 
800 800
 
801 801
     public function load_scripts_styles()
802 802
     {
803
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
803
+        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL.'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
804 804
         wp_enqueue_style('espresso_ee_msg');
805 805
 
806 806
         wp_register_script(
807 807
             'ee-messages-settings',
808
-            EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
808
+            EE_MSG_ASSETS_URL.'ee-messages-settings.js',
809 809
             array('jquery-ui-droppable', 'ee-serialize-full-array'),
810 810
             EVENT_ESPRESSO_VERSION,
811 811
             true
812 812
         );
813 813
         wp_register_script(
814 814
             'ee-msg-list-table-js',
815
-            EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
815
+            EE_MSG_ASSETS_URL.'ee_message_admin_list_table.js',
816 816
             array('ee-dialog'),
817 817
             EVENT_ESPRESSO_VERSION
818 818
         );
@@ -870,7 +870,7 @@  discard block
 block discarded – undo
870 870
 
871 871
         wp_register_script(
872 872
             'ee_msgs_edit_js',
873
-            EE_MSG_ASSETS_URL . 'ee_message_editor.js',
873
+            EE_MSG_ASSETS_URL.'ee_message_editor.js',
874 874
             array('jquery'),
875 875
             EVENT_ESPRESSO_VERSION
876 876
         );
@@ -914,7 +914,7 @@  discard block
 block discarded – undo
914 914
     {
915 915
         wp_register_style(
916 916
             'ee-message-settings',
917
-            EE_MSG_ASSETS_URL . 'ee_message_settings.css',
917
+            EE_MSG_ASSETS_URL.'ee_message_settings.css',
918 918
             array(),
919 919
             EVENT_ESPRESSO_VERSION
920 920
         );
@@ -1000,7 +1000,7 @@  discard block
 block discarded – undo
1000 1000
             }
1001 1001
             $status_bulk_actions = $common_bulk_actions;
1002 1002
             // unset bulk actions not applying to status
1003
-            if (! empty($status_bulk_actions)) {
1003
+            if ( ! empty($status_bulk_actions)) {
1004 1004
                 switch ($status) {
1005 1005
                     case EEM_Message::status_idle:
1006 1006
                     case EEM_Message::status_resend:
@@ -1029,7 +1029,7 @@  discard block
 block discarded – undo
1029 1029
                 continue;
1030 1030
             }
1031 1031
 
1032
-            $this->_views[ strtolower($status) ] = array(
1032
+            $this->_views[strtolower($status)] = array(
1033 1033
                 'slug'        => strtolower($status),
1034 1034
                 'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
1035 1035
                 'count'       => 0,
@@ -1068,7 +1068,7 @@  discard block
 block discarded – undo
1068 1068
             if ($action_item === 'see_notifications_for') {
1069 1069
                 continue;
1070 1070
             }
1071
-            $action_items[ $action_item ] = array(
1071
+            $action_items[$action_item] = array(
1072 1072
                 'class' => $action_details['css_class'],
1073 1073
                 'desc'  => $action_details['label'],
1074 1074
             );
@@ -1077,37 +1077,37 @@  discard block
 block discarded – undo
1077 1077
         /** @type array $status_items status legend setup */
1078 1078
         $status_items = array(
1079 1079
             'incomplete_status'          => array(
1080
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
1080
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_incomplete,
1081 1081
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
1082 1082
             ),
1083 1083
             'idle_status'                => array(
1084
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
1084
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_idle,
1085 1085
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
1086 1086
             ),
1087 1087
             'resend_status'              => array(
1088
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
1088
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_resend,
1089 1089
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
1090 1090
             ),
1091 1091
             'messenger_executing_status' => array(
1092
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
1092
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_messenger_executing,
1093 1093
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
1094 1094
             ),
1095 1095
             'sent_status'                => array(
1096
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
1096
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_sent,
1097 1097
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
1098 1098
             ),
1099 1099
             'retry_status'               => array(
1100
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
1100
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_retry,
1101 1101
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
1102 1102
             ),
1103 1103
             'failed_status'              => array(
1104
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
1104
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_failed,
1105 1105
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
1106 1106
             ),
1107 1107
         );
1108 1108
         if (EEM_Message::debug()) {
1109 1109
             $status_items['debug_only_status'] = array(
1110
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
1110
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_debug_only,
1111 1111
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
1112 1112
             );
1113 1113
         }
@@ -1119,11 +1119,11 @@  discard block
 block discarded – undo
1119 1119
     protected function _custom_mtps_preview()
1120 1120
     {
1121 1121
         $this->_admin_page_title = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
1122
-        $this->_template_args['preview_img'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
1123
-                                               . ' alt="' . esc_attr__(
1122
+        $this->_template_args['preview_img'] = '<img src="'.EE_MSG_ASSETS_URL.'images/custom_mtps_preview.png"'
1123
+                                               . ' alt="'.esc_attr__(
1124 1124
                                                    'Preview Custom Message Templates screenshot',
1125 1125
                                                    'event_espresso'
1126
-                                               ) . '" />';
1126
+                                               ).'" />';
1127 1127
         $this->_template_args['preview_text'] = '<strong>'
1128 1128
                                                 . esc_html__(
1129 1129
                                                     'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
@@ -1203,7 +1203,7 @@  discard block
 block discarded – undo
1203 1203
         $installed = array();
1204 1204
 
1205 1205
         foreach ($installed_message_types as $message_type) {
1206
-            $installed[ $message_type->name ] = $message_type;
1206
+            $installed[$message_type->name] = $message_type;
1207 1207
         }
1208 1208
 
1209 1209
         return $installed;
@@ -1352,7 +1352,7 @@  discard block
 block discarded – undo
1352 1352
         // we need to assemble the title from Various details
1353 1353
         $context_label = sprintf(
1354 1354
             esc_html__('(%s %s)', 'event_espresso'),
1355
-            $c_config[ $context ]['label'],
1355
+            $c_config[$context]['label'],
1356 1356
             ucwords($c_label['label'])
1357 1357
         );
1358 1358
 
@@ -1374,7 +1374,7 @@  discard block
 block discarded – undo
1374 1374
             $message_template_group->message_type()
1375 1375
         );
1376 1376
 
1377
-        if (! $template_field_structure) {
1377
+        if ( ! $template_field_structure) {
1378 1378
             $template_field_structure = false;
1379 1379
             $template_fields = esc_html__(
1380 1380
                 'There was an error in assembling the fields for this display (you should see an error message)',
@@ -1388,21 +1388,21 @@  discard block
 block discarded – undo
1388 1388
 
1389 1389
         // if we have the extra key.. then we need to remove the content index from the template_field_structure as it
1390 1390
         // will get handled in the "extra" array.
1391
-        if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
1392
-            foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
1393
-                unset($template_field_structure[ $context ][ $reference_field ]);
1391
+        if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
1392
+            foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
1393
+                unset($template_field_structure[$context][$reference_field]);
1394 1394
             }
1395 1395
         }
1396 1396
 
1397 1397
         // let's loop through the template_field_structure and actually assemble the input fields!
1398
-        if (! empty($template_field_structure)) {
1399
-            foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
1398
+        if ( ! empty($template_field_structure)) {
1399
+            foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
1400 1400
                 // if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
1401 1401
                 // the extra array and reset them.
1402 1402
                 if ($template_field === 'extra') {
1403 1403
                     $this->_template_args['is_extra_fields'] = true;
1404 1404
                     foreach ($field_setup_array as $reference_field => $new_fields_array) {
1405
-                        $message_template = $message_templates[ $context ][ $reference_field ];
1405
+                        $message_template = $message_templates[$context][$reference_field];
1406 1406
                         $content = $message_template instanceof EE_Message_Template
1407 1407
                             ? $message_template->get('MTP_content')
1408 1408
                             : '';
@@ -1411,7 +1411,7 @@  discard block
 block discarded – undo
1411 1411
                             $continue = false;
1412 1412
                             if (isset($extra_array['shortcodes_required'])) {
1413 1413
                                 foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
1414
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
1414
+                                    if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
1415 1415
                                         $continue = true;
1416 1416
                                     }
1417 1417
                                 }
@@ -1424,57 +1424,57 @@  discard block
 block discarded – undo
1424 1424
                                         . '-'
1425 1425
                                         . $extra_field
1426 1426
                                         . '-content';
1427
-                            $template_form_fields[ $field_id ] = $extra_array;
1428
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
1427
+                            $template_form_fields[$field_id] = $extra_array;
1428
+                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields['
1429 1429
                                                                          . $reference_field
1430 1430
                                                                          . '][content]['
1431
-                                                                         . $extra_field . ']';
1431
+                                                                         . $extra_field.']';
1432 1432
                             $css_class = isset($extra_array['css_class'])
1433 1433
                                 ? $extra_array['css_class']
1434 1434
                                 : '';
1435 1435
 
1436
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1436
+                            $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
1437 1437
                                                                               && in_array($extra_field, $v_fields, true)
1438 1438
                                                                               &&
1439 1439
                                                                               (
1440
-                                                                                  is_array($validators[ $extra_field ])
1441
-                                                                                  && isset($validators[ $extra_field ]['msg'])
1440
+                                                                                  is_array($validators[$extra_field])
1441
+                                                                                  && isset($validators[$extra_field]['msg'])
1442 1442
                                                                               )
1443
-                                ? 'validate-error ' . $css_class
1443
+                                ? 'validate-error '.$css_class
1444 1444
                                 : $css_class;
1445 1445
 
1446
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1447
-                                                                          && isset($content[ $extra_field ])
1448
-                                ? $content[ $extra_field ]
1446
+                            $template_form_fields[$field_id]['value'] = ! empty($message_templates)
1447
+                                                                          && isset($content[$extra_field])
1448
+                                ? $content[$extra_field]
1449 1449
                                 : '';
1450 1450
 
1451 1451
                             // do we have a validation error?  if we do then let's use that value instead
1452
-                            $template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
1453
-                                ? $validators[ $extra_field ]['value']
1454
-                                : $template_form_fields[ $field_id ]['value'];
1452
+                            $template_form_fields[$field_id]['value'] = isset($validators[$extra_field])
1453
+                                ? $validators[$extra_field]['value']
1454
+                                : $template_form_fields[$field_id]['value'];
1455 1455
 
1456 1456
 
1457
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1457
+                            $template_form_fields[$field_id]['db-col'] = 'MTP_content';
1458 1458
 
1459 1459
                             // shortcode selector
1460 1460
                             $field_name_to_use = $extra_field === 'main'
1461 1461
                                 ? 'content'
1462 1462
                                 : $extra_field;
1463
-                            $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1463
+                            $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
1464 1464
                                 $field_name_to_use,
1465 1465
                                 $field_id
1466 1466
                             );
1467 1467
 
1468 1468
                             if (isset($extra_array['input']) && $extra_array['input'] === 'wp_editor') {
1469 1469
                                 // we want to decode the entities
1470
-                                $template_form_fields[ $field_id ]['value'] = $template_form_fields[ $field_id ]['value'];
1470
+                                $template_form_fields[$field_id]['value'] = $template_form_fields[$field_id]['value'];
1471 1471
                             }/**/
1472 1472
                         }
1473
-                        $templatefield_MTP_id = $reference_field . '-MTP_ID';
1474
-                        $templatefield_templatename_id = $reference_field . '-name';
1473
+                        $templatefield_MTP_id = $reference_field.'-MTP_ID';
1474
+                        $templatefield_templatename_id = $reference_field.'-name';
1475 1475
 
1476
-                        $template_form_fields[ $templatefield_MTP_id ] = array(
1477
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
1476
+                        $template_form_fields[$templatefield_MTP_id] = array(
1477
+                            'name'       => 'MTP_template_fields['.$reference_field.'][MTP_ID]',
1478 1478
                             'label'      => null,
1479 1479
                             'input'      => 'hidden',
1480 1480
                             'type'       => 'int',
@@ -1486,8 +1486,8 @@  discard block
 block discarded – undo
1486 1486
                             'db-col'     => 'MTP_ID',
1487 1487
                         );
1488 1488
 
1489
-                        $template_form_fields[ $templatefield_templatename_id ] = array(
1490
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
1489
+                        $template_form_fields[$templatefield_templatename_id] = array(
1490
+                            'name'       => 'MTP_template_fields['.$reference_field.'][name]',
1491 1491
                             'label'      => null,
1492 1492
                             'input'      => 'hidden',
1493 1493
                             'type'       => 'string',
@@ -1501,36 +1501,36 @@  discard block
 block discarded – undo
1501 1501
                     }
1502 1502
                     continue; // skip the next stuff, we got the necessary fields here for this dataset.
1503 1503
                 } else {
1504
-                    $field_id = $template_field . '-content';
1505
-                    $template_form_fields[ $field_id ] = $field_setup_array;
1506
-                    $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields[' . $template_field . '][content]';
1507
-                    $message_template = isset($message_templates[ $context ][ $template_field ])
1508
-                        ? $message_templates[ $context ][ $template_field ]
1504
+                    $field_id = $template_field.'-content';
1505
+                    $template_form_fields[$field_id] = $field_setup_array;
1506
+                    $template_form_fields[$field_id]['name'] = 'MTP_template_fields['.$template_field.'][content]';
1507
+                    $message_template = isset($message_templates[$context][$template_field])
1508
+                        ? $message_templates[$context][$template_field]
1509 1509
                         : null;
1510
-                    $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1511
-                                                                  && is_array($message_templates[ $context ])
1510
+                    $template_form_fields[$field_id]['value'] = ! empty($message_templates)
1511
+                                                                  && is_array($message_templates[$context])
1512 1512
                                                                   && $message_template instanceof EE_Message_Template
1513 1513
                         ? $message_template->get('MTP_content')
1514 1514
                         : '';
1515 1515
 
1516 1516
                     // do we have a validator error for this field?  if we do then we'll use that value instead
1517
-                    $template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
1518
-                        ? $validators[ $template_field ]['value']
1519
-                        : $template_form_fields[ $field_id ]['value'];
1517
+                    $template_form_fields[$field_id]['value'] = isset($validators[$template_field])
1518
+                        ? $validators[$template_field]['value']
1519
+                        : $template_form_fields[$field_id]['value'];
1520 1520
 
1521 1521
 
1522
-                    $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1522
+                    $template_form_fields[$field_id]['db-col'] = 'MTP_content';
1523 1523
                     $css_class = isset($field_setup_array['css_class'])
1524 1524
                         ? $field_setup_array['css_class']
1525 1525
                         : '';
1526
-                    $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1526
+                    $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
1527 1527
                                                                       && in_array($template_field, $v_fields, true)
1528
-                                                                      && isset($validators[ $template_field ]['msg'])
1529
-                        ? 'validate-error ' . $css_class
1528
+                                                                      && isset($validators[$template_field]['msg'])
1529
+                        ? 'validate-error '.$css_class
1530 1530
                         : $css_class;
1531 1531
 
1532 1532
                     // shortcode selector
1533
-                    $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1533
+                    $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
1534 1534
                         $template_field,
1535 1535
                         $field_id
1536 1536
                     );
@@ -1538,12 +1538,12 @@  discard block
 block discarded – undo
1538 1538
 
1539 1539
                 // k took care of content field(s) now let's take care of others.
1540 1540
 
1541
-                $templatefield_MTP_id = $template_field . '-MTP_ID';
1542
-                $templatefield_field_templatename_id = $template_field . '-name';
1541
+                $templatefield_MTP_id = $template_field.'-MTP_ID';
1542
+                $templatefield_field_templatename_id = $template_field.'-name';
1543 1543
 
1544 1544
                 // foreach template field there are actually two form fields created
1545
-                $template_form_fields[ $templatefield_MTP_id ] = array(
1546
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
1545
+                $template_form_fields[$templatefield_MTP_id] = array(
1546
+                    'name'       => 'MTP_template_fields['.$template_field.'][MTP_ID]',
1547 1547
                     'label'      => null,
1548 1548
                     'input'      => 'hidden',
1549 1549
                     'type'       => 'int',
@@ -1555,8 +1555,8 @@  discard block
 block discarded – undo
1555 1555
                     'db-col'     => 'MTP_ID',
1556 1556
                 );
1557 1557
 
1558
-                $template_form_fields[ $templatefield_field_templatename_id ] = array(
1559
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
1558
+                $template_form_fields[$templatefield_field_templatename_id] = array(
1559
+                    'name'       => 'MTP_template_fields['.$template_field.'][name]',
1560 1560
                     'label'      => null,
1561 1561
                     'input'      => 'hidden',
1562 1562
                     'type'       => 'string',
@@ -1699,10 +1699,10 @@  discard block
 block discarded – undo
1699 1699
                 'value' => $GRP_ID,
1700 1700
             );
1701 1701
             $sidebar_form_fields['ee-msg-evt-nonce'] = array(
1702
-                'name'  => $action . '_nonce',
1702
+                'name'  => $action.'_nonce',
1703 1703
                 'input' => 'hidden',
1704 1704
                 'type'  => 'string',
1705
-                'value' => wp_create_nonce($action . '_nonce'),
1705
+                'value' => wp_create_nonce($action.'_nonce'),
1706 1706
             );
1707 1707
 
1708 1708
             if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
@@ -1743,7 +1743,7 @@  discard block
 block discarded – undo
1743 1743
             ),
1744 1744
             $this->_admin_base_url
1745 1745
         );
1746
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
1746
+        $preview_button = '<a href="'.$preview_url.'" class="button-secondary messages-preview-button">'
1747 1747
                           . esc_html__('Preview', 'event_espresso')
1748 1748
                           . '</a>';
1749 1749
 
@@ -1781,7 +1781,7 @@  discard block
 block discarded – undo
1781 1781
 
1782 1782
         $this->_template_path = $this->_template_args['GRP_ID']
1783 1783
             ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
1784
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
1784
+            : EE_MSG_TEMPLATE_PATH.'ee_msg_details_main_add_meta_box.template.php';
1785 1785
 
1786 1786
         // send along EE_Message_Template_Group object for further template use.
1787 1787
         $this->_template_args['MTP'] = $message_template_group;
@@ -1836,7 +1836,7 @@  discard block
 block discarded – undo
1836 1836
     ) {
1837 1837
         $template_args = array(
1838 1838
             'context'                   => $context,
1839
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
1839
+            'nonce'                     => wp_create_nonce('activate_'.$context.'_toggle_nonce'),
1840 1840
             'is_active'                 => $message_template_group->is_context_active($context),
1841 1841
             'on_off_action'             => $message_template_group->is_context_active($context)
1842 1842
                 ? 'context-off'
@@ -1845,7 +1845,7 @@  discard block
 block discarded – undo
1845 1845
             'message_template_group_id' => $message_template_group->ID(),
1846 1846
         );
1847 1847
         return EEH_Template::display_template(
1848
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
1848
+            EE_MSG_TEMPLATE_PATH.'ee_msg_editor_active_context_element.template.php',
1849 1849
             $template_args,
1850 1850
             true
1851 1851
         );
@@ -1866,7 +1866,7 @@  discard block
 block discarded – undo
1866 1866
     {
1867 1867
         $success = true;
1868 1868
         // check for required data
1869
-        if (! isset(
1869
+        if ( ! isset(
1870 1870
             $this->_req_data['message_template_group_id'],
1871 1871
             $this->_req_data['context'],
1872 1872
             $this->_req_data['status']
@@ -1883,7 +1883,7 @@  discard block
 block discarded – undo
1883 1883
         $nonce = isset($this->_req_data['toggle_context_nonce'])
1884 1884
             ? sanitize_text_field($this->_req_data['toggle_context_nonce'])
1885 1885
             : '';
1886
-        $nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
1886
+        $nonce_ref = 'activate_'.$this->_req_data['context'].'_toggle_nonce';
1887 1887
         $this->_verify_nonce($nonce, $nonce_ref);
1888 1888
         $status = $this->_req_data['status'];
1889 1889
         if ($status !== 'off' && $status !== 'on') {
@@ -1901,7 +1901,7 @@  discard block
 block discarded – undo
1901 1901
         $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
1902 1902
             $this->_req_data['message_template_group_id']
1903 1903
         );
1904
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
1904
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
1905 1905
             EE_Error::add_error(
1906 1906
                 sprintf(
1907 1907
                     esc_html__(
@@ -2030,7 +2030,7 @@  discard block
 block discarded – undo
2030 2030
         $templates = array();
2031 2031
         $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2032 2032
         // we need to make sure we've got the info we need.
2033
-        if (! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
2033
+        if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
2034 2034
             EE_Error::add_error(
2035 2035
                 esc_html__(
2036 2036
                     'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
@@ -2072,7 +2072,7 @@  discard block
 block discarded – undo
2072 2072
         }
2073 2073
 
2074 2074
         // any error messages?
2075
-        if (! $success) {
2075
+        if ( ! $success) {
2076 2076
             EE_Error::add_error(
2077 2077
                 esc_html__(
2078 2078
                     'Something went wrong with deleting existing templates. Unable to reset to default',
@@ -2124,7 +2124,7 @@  discard block
 block discarded – undo
2124 2124
     public function _preview_message($send = false)
2125 2125
     {
2126 2126
         // first make sure we've got the necessary parameters
2127
-        if (! isset(
2127
+        if ( ! isset(
2128 2128
             $this->_req_data['message_type'],
2129 2129
             $this->_req_data['messenger'],
2130 2130
             $this->_req_data['messenger'],
@@ -2182,7 +2182,7 @@  discard block
 block discarded – undo
2182 2182
         $preview_title = sprintf(
2183 2183
             esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
2184 2184
             $active_messenger_label,
2185
-            ucwords($message_types[ $this->_req_data['message_type'] ]->label['singular'])
2185
+            ucwords($message_types[$this->_req_data['message_type']]->label['singular'])
2186 2186
         );
2187 2187
         if (empty($preview)) {
2188 2188
             $this->noEventsErrorMessage();
@@ -2190,7 +2190,7 @@  discard block
 block discarded – undo
2190 2190
         // setup display of preview.
2191 2191
         $this->_admin_page_title = $preview_title;
2192 2192
         $this->_template_args['admin_page_title'] = $preview_title;
2193
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
2193
+        $this->_template_args['admin_page_content'] = $preview_button.'<br />'.$preview;
2194 2194
         $this->_template_args['data']['force_json'] = true;
2195 2195
 
2196 2196
         return '';
@@ -2303,10 +2303,10 @@  discard block
 block discarded – undo
2303 2303
         foreach ($tp_collection as $tp) {
2304 2304
             // only include template packs that support this messenger and message type!
2305 2305
             $supports = $tp->get_supports();
2306
-            if (! isset($supports[ $this->_message_template_group->messenger() ])
2306
+            if ( ! isset($supports[$this->_message_template_group->messenger()])
2307 2307
                 || ! in_array(
2308 2308
                     $this->_message_template_group->message_type(),
2309
-                    $supports[ $this->_message_template_group->messenger() ],
2309
+                    $supports[$this->_message_template_group->messenger()],
2310 2310
                     true
2311 2311
                 )
2312 2312
             ) {
@@ -2359,7 +2359,7 @@  discard block
 block discarded – undo
2359 2359
         $template_args['template_pack_description'] = $template_pack_labels->template_pack_description;
2360 2360
         $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
2361 2361
 
2362
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
2362
+        $template = EE_MSG_TEMPLATE_PATH.'template_pack_and_variations_metabox.template.php';
2363 2363
 
2364 2364
         EEH_Template::display_template($template, $template_args);
2365 2365
     }
@@ -2385,10 +2385,10 @@  discard block
 block discarded – undo
2385 2385
         // first we need to see if there are any fields
2386 2386
         $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
2387 2387
 
2388
-        if (! empty($fields)) {
2388
+        if ( ! empty($fields)) {
2389 2389
             // yup there be fields
2390 2390
             foreach ($fields as $field => $config) {
2391
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
2391
+                $field_id = $this->_message_template_group->messenger().'_'.$field;
2392 2392
                 $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
2393 2393
                 $default = isset($config['default']) ? $config['default'] : '';
2394 2394
                 $default = isset($config['value']) ? $config['value'] : $default;
@@ -2396,22 +2396,22 @@  discard block
 block discarded – undo
2396 2396
                 // if type is hidden and the value is empty
2397 2397
                 // something may have gone wrong so let's correct with the defaults
2398 2398
                 $fix = $config['input'] === 'hidden'
2399
-                       && isset($existing[ $field ])
2400
-                       && empty($existing[ $field ])
2399
+                       && isset($existing[$field])
2400
+                       && empty($existing[$field])
2401 2401
                     ? $default
2402 2402
                     : '';
2403
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
2404
-                    ? $existing[ $field ]
2403
+                $existing[$field] = isset($existing[$field]) && empty($fix)
2404
+                    ? $existing[$field]
2405 2405
                     : $fix;
2406 2406
 
2407
-                $template_form_fields[ $field_id ] = array(
2408
-                    'name'       => 'test_settings_fld[' . $field . ']',
2407
+                $template_form_fields[$field_id] = array(
2408
+                    'name'       => 'test_settings_fld['.$field.']',
2409 2409
                     'label'      => $config['label'],
2410 2410
                     'input'      => $config['input'],
2411 2411
                     'type'       => $config['type'],
2412 2412
                     'required'   => $config['required'],
2413 2413
                     'validation' => $config['validation'],
2414
-                    'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
2414
+                    'value'      => isset($existing[$field]) ? $existing[$field] : $default,
2415 2415
                     'css_class'  => $config['css_class'],
2416 2416
                     'options'    => isset($config['options']) ? $config['options'] : array(),
2417 2417
                     'default'    => $default,
@@ -2426,7 +2426,7 @@  discard block
 block discarded – undo
2426 2426
 
2427 2427
         $test_settings_html = '';
2428 2428
         // print out $test_settings_fields
2429
-        if (! empty($test_settings_fields)) {
2429
+        if ( ! empty($test_settings_fields)) {
2430 2430
             echo $test_settings_fields;
2431 2431
             $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
2432 2432
             $test_settings_html .= 'name="test_button" value="';
@@ -2473,7 +2473,7 @@  discard block
 block discarded – undo
2473 2473
         );
2474 2474
 
2475 2475
         return EEH_Template::display_template(
2476
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
2476
+            EE_MSG_TEMPLATE_PATH.'shortcode_selector_skeleton.template.php',
2477 2477
             $template_args,
2478 2478
             true
2479 2479
         );
@@ -2498,7 +2498,7 @@  discard block
 block discarded – undo
2498 2498
         // $messenger = $this->_message_template_group->messenger_obj();
2499 2499
         // now let's set the content depending on the status of the shortcodes array
2500 2500
         if (empty($shortcodes)) {
2501
-            $content = '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
2501
+            $content = '<p>'.esc_html__('There are no valid shortcodes available', 'event_espresso').'</p>';
2502 2502
             echo $content;
2503 2503
         } else {
2504 2504
             // $alt = 0;
@@ -2536,7 +2536,7 @@  discard block
 block discarded – undo
2536 2536
     {
2537 2537
 
2538 2538
         // no need to run this if the property is already set
2539
-        if (! empty($this->_shortcodes)) {
2539
+        if ( ! empty($this->_shortcodes)) {
2540 2540
             return;
2541 2541
         }
2542 2542
 
@@ -2590,7 +2590,7 @@  discard block
 block discarded – undo
2590 2590
     protected function _set_message_template_group()
2591 2591
     {
2592 2592
 
2593
-        if (! empty($this->_message_template_group)) {
2593
+        if ( ! empty($this->_message_template_group)) {
2594 2594
             return;
2595 2595
         } //get out if this is already set.
2596 2596
 
@@ -2637,7 +2637,7 @@  discard block
 block discarded – undo
2637 2637
                     <?php
2638 2638
                 }
2639 2639
                 // setup nonce_url
2640
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
2640
+                wp_nonce_field($args['action'].'_nonce', $args['action'].'_nonce', false);
2641 2641
                 ?>
2642 2642
                 <select name="context">
2643 2643
                     <?php
@@ -2647,7 +2647,7 @@  discard block
 block discarded – undo
2647 2647
                             $checked = ($context === $args['context']) ? 'selected="selected"' : '';
2648 2648
                             ?>
2649 2649
                             <option value="<?php echo $context; ?>" <?php echo $checked; ?>>
2650
-                                <?php echo $context_details[ $context ]['label']; ?>
2650
+                                <?php echo $context_details[$context]['label']; ?>
2651 2651
                             </option>
2652 2652
                         <?php endforeach;
2653 2653
                     endif; ?>
@@ -2677,22 +2677,22 @@  discard block
 block discarded – undo
2677 2677
      */
2678 2678
     protected function _set_message_template_column_values($index)
2679 2679
     {
2680
-        if (is_array($this->_req_data['MTP_template_fields'][ $index ]['content'])) {
2681
-            foreach ($this->_req_data['MTP_template_fields'][ $index ]['content'] as $field => $value) {
2682
-                $this->_req_data['MTP_template_fields'][ $index ]['content'][ $field ] = $value;
2680
+        if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) {
2681
+            foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) {
2682
+                $this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value;
2683 2683
             }
2684 2684
         }
2685 2685
 
2686 2686
 
2687 2687
         $set_column_values = array(
2688
-            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][ $index ]['MTP_ID']),
2688
+            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']),
2689 2689
             'GRP_ID'             => absint($this->_req_data['GRP_ID']),
2690 2690
             'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
2691 2691
             'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
2692 2692
             'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
2693
-            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][ $index ]['name']),
2693
+            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']),
2694 2694
             'MTP_context'        => strtolower($this->_req_data['MTP_context']),
2695
-            'MTP_content'        => $this->_req_data['MTP_template_fields'][ $index ]['content'],
2695
+            'MTP_content'        => $this->_req_data['MTP_template_fields'][$index]['content'],
2696 2696
             'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
2697 2697
                 ? absint($this->_req_data['MTP_is_global'])
2698 2698
                 : 0,
@@ -2739,7 +2739,7 @@  discard block
 block discarded – undo
2739 2739
         $context = ucwords(str_replace('_', ' ', $context_slug));
2740 2740
 
2741 2741
         $item_desc = $messenger_label && $message_type_label
2742
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
2742
+            ? $messenger_label.' '.$message_type_label.' '.$context.' '
2743 2743
             : '';
2744 2744
         $item_desc .= 'Message Template';
2745 2745
         $query_args = array();
@@ -2770,7 +2770,7 @@  discard block
 block discarded – undo
2770 2770
 
2771 2771
 
2772 2772
             // run update for each template field in displayed context
2773
-            if (! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
2773
+            if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
2774 2774
                 EE_Error::add_error(
2775 2775
                     esc_html__(
2776 2776
                         'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
@@ -2832,10 +2832,10 @@  discard block
 block discarded – undo
2832 2832
                         $set_column_values = $this->_set_message_template_column_values($template_field);
2833 2833
 
2834 2834
                         $where_cols_n_values = array(
2835
-                            'MTP_ID' => $this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'],
2835
+                            'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID'],
2836 2836
                         );
2837 2837
                         // if they aren't allowed to use all JS, restrict them to just posty-y tags
2838
-                        if (! current_user_can('unfiltered_html')) {
2838
+                        if ( ! current_user_can('unfiltered_html')) {
2839 2839
                             if (is_array($set_column_values['MTP_content'])) {
2840 2840
                                 foreach ($set_column_values['MTP_content'] as $key => $value) {
2841 2841
                                     // remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
@@ -2843,7 +2843,7 @@  discard block
 block discarded – undo
2843 2843
                                     // appear invalid.) But currently the models expect slashed data, so after wp_kses
2844 2844
                                     // runs we need to re-slash the data. Sheesh. See
2845 2845
                                     // https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
2846
-                                    $set_column_values['MTP_content'][ $key ] = addslashes(
2846
+                                    $set_column_values['MTP_content'][$key] = addslashes(
2847 2847
                                         wp_kses(
2848 2848
                                             stripslashes($value),
2849 2849
                                             wp_kses_allowed_html('post')
@@ -2879,14 +2879,14 @@  discard block
 block discarded – undo
2879 2879
                             }
2880 2880
                         } else {
2881 2881
                             // only do this logic if we don't have a MTP_ID for this field
2882
-                            if (empty($this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'])) {
2882
+                            if (empty($this->_req_data['MTP_template_fields'][$template_field]['MTP_ID'])) {
2883 2883
                                 // this has already been through the template field validator and sanitized, so it will be
2884 2884
                                 // safe to insert this field.  Why insert?  This typically happens when we introduce a new
2885 2885
                                 // message template field in a messenger/message type and existing users don't have the
2886 2886
                                 // default setup for it.
2887 2887
                                 // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
2888 2888
                                 $updated = $MTP->insert($message_template_fields);
2889
-                                if (! $updated || is_wp_error($updated)) {
2889
+                                if ( ! $updated || is_wp_error($updated)) {
2890 2890
                                     EE_Error::add_error(
2891 2891
                                         sprintf(
2892 2892
                                             esc_html__('%s field could not be updated.', 'event_espresso'),
@@ -3117,7 +3117,7 @@  discard block
 block discarded – undo
3117 3117
         // incoming GRP_IDs
3118 3118
         if ($all) {
3119 3119
             // Checkboxes
3120
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3120
+            if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3121 3121
                 // if array has more than one element then success message should be plural.
3122 3122
                 // todo: what about nonce?
3123 3123
                 $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
@@ -3125,16 +3125,16 @@  discard block
 block discarded – undo
3125 3125
                 // cycle through checkboxes
3126 3126
                 while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3127 3127
                     $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3128
-                    if (! $trashed_or_restored) {
3128
+                    if ( ! $trashed_or_restored) {
3129 3129
                         $success = 0;
3130 3130
                     }
3131 3131
                 }
3132 3132
             } else {
3133 3133
                 // grab single GRP_ID and handle
3134 3134
                 $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
3135
-                if (! empty($GRP_ID)) {
3135
+                if ( ! empty($GRP_ID)) {
3136 3136
                     $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3137
-                    if (! $trashed_or_restored) {
3137
+                    if ( ! $trashed_or_restored) {
3138 3138
                         $success = 0;
3139 3139
                     }
3140 3140
                 } else {
@@ -3182,7 +3182,7 @@  discard block
 block discarded – undo
3182 3182
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3183 3183
 
3184 3184
         // checkboxes
3185
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3185
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3186 3186
             // if array has more than one element then success message should be plural
3187 3187
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3188 3188
 
@@ -3289,7 +3289,7 @@  discard block
 block discarded – undo
3289 3289
     protected function _set_m_mt_settings()
3290 3290
     {
3291 3291
         // first if this is already set then lets get out no need to regenerate data.
3292
-        if (! empty($this->_m_mt_settings)) {
3292
+        if ( ! empty($this->_m_mt_settings)) {
3293 3293
             return;
3294 3294
         }
3295 3295
 
@@ -3303,7 +3303,7 @@  discard block
 block discarded – undo
3303 3303
         // assemble the array for the _tab_text_links helper
3304 3304
 
3305 3305
         foreach ($messengers as $messenger) {
3306
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = array(
3306
+            $this->_m_mt_settings['messenger_tabs'][$messenger->name] = array(
3307 3307
                 'label' => ucwords($messenger->label['singular']),
3308 3308
                 'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
3309 3309
                     ? 'messenger-active'
@@ -3320,7 +3320,7 @@  discard block
 block discarded – undo
3320 3320
             foreach ($message_types as $message_type) {
3321 3321
                 // first we need to verify that this message type is valid with this messenger. Cause if it isn't then
3322 3322
                 // it shouldn't show in either the inactive OR active metabox.
3323
-                if (! in_array($message_type->name, $message_types_for_messenger, true)) {
3323
+                if ( ! in_array($message_type->name, $message_types_for_messenger, true)) {
3324 3324
                     continue;
3325 3325
                 }
3326 3326
 
@@ -3331,12 +3331,12 @@  discard block
 block discarded – undo
3331 3331
                     ? 'active'
3332 3332
                     : 'inactive';
3333 3333
 
3334
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = array(
3334
+                $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
3335 3335
                     'label'    => ucwords($message_type->label['singular']),
3336
-                    'class'    => 'message-type-' . $a_or_i,
3337
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
3338
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
3339
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
3336
+                    'class'    => 'message-type-'.$a_or_i,
3337
+                    'slug_id'  => $message_type->name.'-messagetype-'.$messenger->name,
3338
+                    'mt_nonce' => wp_create_nonce($message_type->name.'_nonce'),
3339
+                    'href'     => 'espresso_'.$message_type->name.'_message_type_settings',
3340 3340
                     'title'    => $a_or_i === 'active'
3341 3341
                         ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
3342 3342
                         : esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
@@ -3367,25 +3367,25 @@  discard block
 block discarded – undo
3367 3367
         $fields = $message_type->get_admin_settings_fields();
3368 3368
         $settings_template_args['template_form_fields'] = '';
3369 3369
 
3370
-        if (! empty($fields) && $active) {
3370
+        if ( ! empty($fields) && $active) {
3371 3371
             $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
3372 3372
             foreach ($fields as $fldname => $fldprops) {
3373
-                $field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname;
3374
-                $template_form_field[ $field_id ] = array(
3375
-                    'name'       => 'message_type_settings[' . $fldname . ']',
3373
+                $field_id = $messenger->name.'-'.$message_type->name.'-'.$fldname;
3374
+                $template_form_field[$field_id] = array(
3375
+                    'name'       => 'message_type_settings['.$fldname.']',
3376 3376
                     'label'      => $fldprops['label'],
3377 3377
                     'input'      => $fldprops['field_type'],
3378 3378
                     'type'       => $fldprops['value_type'],
3379 3379
                     'required'   => $fldprops['required'],
3380 3380
                     'validation' => $fldprops['validation'],
3381
-                    'value'      => isset($existing_settings[ $fldname ])
3382
-                        ? $existing_settings[ $fldname ]
3381
+                    'value'      => isset($existing_settings[$fldname])
3382
+                        ? $existing_settings[$fldname]
3383 3383
                         : $fldprops['default'],
3384 3384
                     'options'    => isset($fldprops['options'])
3385 3385
                         ? $fldprops['options']
3386 3386
                         : array(),
3387
-                    'default'    => isset($existing_settings[ $fldname ])
3388
-                        ? $existing_settings[ $fldname ]
3387
+                    'default'    => isset($existing_settings[$fldname])
3388
+                        ? $existing_settings[$fldname]
3389 3389
                         : $fldprops['default'],
3390 3390
                     'css_class'  => 'no-drag',
3391 3391
                     'format'     => $fldprops['format'],
@@ -3428,7 +3428,7 @@  discard block
 block discarded – undo
3428 3428
             : '';
3429 3429
 
3430 3430
 
3431
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
3431
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_mt_settings_content.template.php';
3432 3432
         $content = EEH_Template::display_template($template, $settings_template_args, true);
3433 3433
 
3434 3434
         return $content;
@@ -3459,20 +3459,20 @@  discard block
 block discarded – undo
3459 3459
                 // messenger meta boxes
3460 3460
                 $active = $selected_messenger === $messenger;
3461 3461
                 $active_mt_tabs = isset(
3462
-                    $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3462
+                    $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
3463 3463
                 )
3464
-                    ? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3464
+                    ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
3465 3465
                     : '';
3466
-                $m_boxes[ $messenger . '_a_box' ] = sprintf(
3466
+                $m_boxes[$messenger.'_a_box'] = sprintf(
3467 3467
                     esc_html__('%s Settings', 'event_espresso'),
3468 3468
                     $tab_array['label']
3469 3469
                 );
3470
-                $m_template_args[ $messenger . '_a_box' ] = array(
3470
+                $m_template_args[$messenger.'_a_box'] = array(
3471 3471
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3472 3472
                     'inactive_message_types' => isset(
3473
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3473
+                        $this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']
3474 3474
                     )
3475
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3475
+                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
3476 3476
                         : '',
3477 3477
                     'content'                => $this->_get_messenger_box_content($tab_array['obj']),
3478 3478
                     'hidden'                 => $active ? '' : ' hidden',
@@ -3483,13 +3483,13 @@  discard block
 block discarded – undo
3483 3483
                 // message type meta boxes
3484 3484
                 // (which is really just the inactive container for each messenger
3485 3485
                 // showing inactive message types for that messenger)
3486
-                $mt_boxes[ $messenger . '_i_box' ] = esc_html__('Inactive Message Types', 'event_espresso');
3487
-                $mt_template_args[ $messenger . '_i_box' ] = array(
3486
+                $mt_boxes[$messenger.'_i_box'] = esc_html__('Inactive Message Types', 'event_espresso');
3487
+                $mt_template_args[$messenger.'_i_box'] = array(
3488 3488
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3489 3489
                     'inactive_message_types' => isset(
3490
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3490
+                        $this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']
3491 3491
                     )
3492
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3492
+                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
3493 3493
                         : '',
3494 3494
                     'hidden'                 => $active ? '' : ' hidden',
3495 3495
                     'hide_on_message'        => $hide_on_message,
@@ -3502,14 +3502,14 @@  discard block
 block discarded – undo
3502 3502
 
3503 3503
 
3504 3504
         // register messenger metaboxes
3505
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
3505
+        $m_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_mt_meta_box.template.php';
3506 3506
         foreach ($m_boxes as $box => $label) {
3507
-            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]);
3507
+            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
3508 3508
             $msgr = str_replace('_a_box', '', $box);
3509 3509
             add_meta_box(
3510
-                'espresso_' . $msgr . '_settings',
3510
+                'espresso_'.$msgr.'_settings',
3511 3511
                 $label,
3512
-                function ($post, $metabox) {
3512
+                function($post, $metabox) {
3513 3513
                     echo EEH_Template::display_template(
3514 3514
                         $metabox["args"]["template_path"],
3515 3515
                         $metabox["args"]["template_args"],
@@ -3524,17 +3524,17 @@  discard block
 block discarded – undo
3524 3524
         }
3525 3525
 
3526 3526
         // register message type metaboxes
3527
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
3527
+        $mt_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_meta_box.template.php';
3528 3528
         foreach ($mt_boxes as $box => $label) {
3529 3529
             $callback_args = array(
3530 3530
                 'template_path' => $mt_template_path,
3531
-                'template_args' => $mt_template_args[ $box ],
3531
+                'template_args' => $mt_template_args[$box],
3532 3532
             );
3533 3533
             $mt = str_replace('_i_box', '', $box);
3534 3534
             add_meta_box(
3535
-                'espresso_' . $mt . '_inactive_mts',
3535
+                'espresso_'.$mt.'_inactive_mts',
3536 3536
                 $label,
3537
-                function ($post, $metabox) {
3537
+                function($post, $metabox) {
3538 3538
                     echo EEH_Template::display_template(
3539 3539
                         $metabox["args"]["template_path"],
3540 3540
                         $metabox["args"]["template_args"],
@@ -3680,7 +3680,7 @@  discard block
 block discarded – undo
3680 3680
             if ($form->is_valid()) {
3681 3681
                 $valid_data = $form->valid_data();
3682 3682
                 foreach ($valid_data as $property => $value) {
3683
-                    $setter = 'set_' . $property;
3683
+                    $setter = 'set_'.$property;
3684 3684
                     if (method_exists($network_config, $setter)) {
3685 3685
                         $network_config->{$setter}($value);
3686 3686
                     } elseif (property_exists($network_config, $property)
@@ -3714,7 +3714,7 @@  discard block
 block discarded – undo
3714 3714
     protected function _get_mt_tabs($tab_array)
3715 3715
     {
3716 3716
         $tab_array = (array) $tab_array;
3717
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
3717
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_details_mt_settings_tab_item.template.php';
3718 3718
         $tabs = '';
3719 3719
 
3720 3720
         foreach ($tab_array as $tab) {
@@ -3742,20 +3742,20 @@  discard block
 block discarded – undo
3742 3742
         $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
3743 3743
 
3744 3744
 
3745
-        if (! empty($fields)) {
3745
+        if ( ! empty($fields)) {
3746 3746
             $existing_settings = $messenger->get_existing_admin_settings();
3747 3747
 
3748 3748
             foreach ($fields as $fldname => $fldprops) {
3749
-                $field_id = $messenger->name . '-' . $fldname;
3750
-                $template_form_field[ $field_id ] = array(
3751
-                    'name'       => 'messenger_settings[' . $field_id . ']',
3749
+                $field_id = $messenger->name.'-'.$fldname;
3750
+                $template_form_field[$field_id] = array(
3751
+                    'name'       => 'messenger_settings['.$field_id.']',
3752 3752
                     'label'      => $fldprops['label'],
3753 3753
                     'input'      => $fldprops['field_type'],
3754 3754
                     'type'       => $fldprops['value_type'],
3755 3755
                     'required'   => $fldprops['required'],
3756 3756
                     'validation' => $fldprops['validation'],
3757
-                    'value'      => isset($existing_settings[ $field_id ])
3758
-                        ? $existing_settings[ $field_id ]
3757
+                    'value'      => isset($existing_settings[$field_id])
3758
+                        ? $existing_settings[$field_id]
3759 3759
                         : $fldprops['default'],
3760 3760
                     'css_class'  => '',
3761 3761
                     'format'     => $fldprops['format'],
@@ -3781,9 +3781,9 @@  discard block
 block discarded – undo
3781 3781
         );
3782 3782
 
3783 3783
         // make sure any active message types that are existing are included in the hidden fields
3784
-        if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
3785
-            foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
3786
-                $settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = array(
3784
+        if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
3785
+            foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
3786
+                $settings_template_args['hidden_fields']['messenger_settings[message_types]['.$mt.']'] = array(
3787 3787
                     'type'  => 'hidden',
3788 3788
                     'value' => $mt,
3789 3789
                 );
@@ -3812,9 +3812,9 @@  discard block
 block discarded – undo
3812 3812
 
3813 3813
 
3814 3814
         $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
3815
-        $settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
3815
+        $settings_template_args['nonce'] = wp_create_nonce('activate_'.$messenger->name.'_toggle_nonce');
3816 3816
         $settings_template_args['on_off_status'] = $active ? true : false;
3817
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
3817
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_m_settings_content.template.php';
3818 3818
         $content = EEH_Template::display_template(
3819 3819
             $template,
3820 3820
             $settings_template_args,
@@ -3840,7 +3840,7 @@  discard block
 block discarded – undo
3840 3840
         $success = true;
3841 3841
         $this->_prep_default_response_for_messenger_or_message_type_toggle();
3842 3842
         // let's check that we have required data
3843
-        if (! isset($this->_req_data['messenger'])) {
3843
+        if ( ! isset($this->_req_data['messenger'])) {
3844 3844
             EE_Error::add_error(
3845 3845
                 esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3846 3846
                 __FILE__,
@@ -3854,12 +3854,12 @@  discard block
 block discarded – undo
3854 3854
         $nonce = isset($this->_req_data['activate_nonce'])
3855 3855
             ? sanitize_text_field($this->_req_data['activate_nonce'])
3856 3856
             : '';
3857
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
3857
+        $nonce_ref = 'activate_'.$this->_req_data['messenger'].'_toggle_nonce';
3858 3858
 
3859 3859
         $this->_verify_nonce($nonce, $nonce_ref);
3860 3860
 
3861 3861
 
3862
-        if (! isset($this->_req_data['status'])) {
3862
+        if ( ! isset($this->_req_data['status'])) {
3863 3863
             EE_Error::add_error(
3864 3864
                 esc_html__(
3865 3865
                     'Messenger status needed to know whether activation or deactivation is happening. No status is given',
@@ -3918,7 +3918,7 @@  discard block
 block discarded – undo
3918 3918
         $this->_prep_default_response_for_messenger_or_message_type_toggle();
3919 3919
 
3920 3920
         // let's make sure we have the necessary data
3921
-        if (! isset($this->_req_data['message_type'])) {
3921
+        if ( ! isset($this->_req_data['message_type'])) {
3922 3922
             EE_Error::add_error(
3923 3923
                 esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
3924 3924
                 __FILE__,
@@ -3928,7 +3928,7 @@  discard block
 block discarded – undo
3928 3928
             $success = false;
3929 3929
         }
3930 3930
 
3931
-        if (! isset($this->_req_data['messenger'])) {
3931
+        if ( ! isset($this->_req_data['messenger'])) {
3932 3932
             EE_Error::add_error(
3933 3933
                 esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3934 3934
                 __FILE__,
@@ -3938,7 +3938,7 @@  discard block
 block discarded – undo
3938 3938
             $success = false;
3939 3939
         }
3940 3940
 
3941
-        if (! isset($this->_req_data['status'])) {
3941
+        if ( ! isset($this->_req_data['status'])) {
3942 3942
             EE_Error::add_error(
3943 3943
                 esc_html__(
3944 3944
                     'Messenger status needed to know whether activation or deactivation is happening. No status is given',
@@ -3971,7 +3971,7 @@  discard block
 block discarded – undo
3971 3971
 
3972 3972
         // do a nonce check here since we're not arriving via a normal route
3973 3973
         $nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
3974
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
3974
+        $nonce_ref = $this->_req_data['message_type'].'_nonce';
3975 3975
 
3976 3976
         $this->_verify_nonce($nonce, $nonce_ref);
3977 3977
 
@@ -4158,7 +4158,7 @@  discard block
 block discarded – undo
4158 4158
         EE_Message_Type $message_type = null
4159 4159
     ) {
4160 4160
         // if $messenger isn't a valid messenger object then get out.
4161
-        if (! $messenger instanceof EE_Messenger) {
4161
+        if ( ! $messenger instanceof EE_Messenger) {
4162 4162
             EE_Error::add_error(
4163 4163
                 esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
4164 4164
                 __FILE__,
@@ -4213,7 +4213,7 @@  discard block
 block discarded – undo
4213 4213
             // message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
4214 4214
             // in which case we just give a success message for the messenger being successfully activated.
4215 4215
         } else {
4216
-            if (! $messenger->get_default_message_types()) {
4216
+            if ( ! $messenger->get_default_message_types()) {
4217 4217
                 // messenger doesn't have any default message types so still a success.
4218 4218
                 EE_Error::add_success(
4219 4219
                     sprintf(
@@ -4269,7 +4269,7 @@  discard block
 block discarded – undo
4269 4269
         EE_Error::overwrite_success();
4270 4270
 
4271 4271
         // if $messenger isn't a valid messenger object then get out.
4272
-        if (! $messenger instanceof EE_Messenger) {
4272
+        if ( ! $messenger instanceof EE_Messenger) {
4273 4273
             EE_Error::add_error(
4274 4274
                 esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
4275 4275
                 __FILE__,
@@ -4331,7 +4331,7 @@  discard block
 block discarded – undo
4331 4331
      */
4332 4332
     public function update_mt_form()
4333 4333
     {
4334
-        if (! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
4334
+        if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
4335 4335
             EE_Error::add_error(
4336 4336
                 esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
4337 4337
                 __FILE__,
@@ -4343,7 +4343,7 @@  discard block
 block discarded – undo
4343 4343
 
4344 4344
         $message_types = $this->get_installed_message_types();
4345 4345
 
4346
-        $message_type = $message_types[ $this->_req_data['message_type'] ];
4346
+        $message_type = $message_types[$this->_req_data['message_type']];
4347 4347
         $messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
4348 4348
 
4349 4349
         $content = $this->_message_type_settings_content(
@@ -4363,7 +4363,7 @@  discard block
 block discarded – undo
4363 4363
      */
4364 4364
     public function save_settings()
4365 4365
     {
4366
-        if (! isset($this->_req_data['type'])) {
4366
+        if ( ! isset($this->_req_data['type'])) {
4367 4367
             EE_Error::add_error(
4368 4368
                 esc_html__(
4369 4369
                     'Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
@@ -4392,7 +4392,7 @@  discard block
 block discarded – undo
4392 4392
                         unset($settings['message_types']);
4393 4393
                         break;
4394 4394
                     default:
4395
-                        $settings[ $key ] = $value;
4395
+                        $settings[$key] = $value;
4396 4396
                         break;
4397 4397
                 }
4398 4398
             }
@@ -4411,7 +4411,7 @@  discard block
 block discarded – undo
4411 4411
                         unset($settings['message_type']);
4412 4412
                         break;
4413 4413
                     default:
4414
-                        $settings[ $key ] = $value;
4414
+                        $settings[$key] = $value;
4415 4415
                         break;
4416 4416
                 }
4417 4417
             }
@@ -4572,7 +4572,7 @@  discard block
 block discarded – undo
4572 4572
      */
4573 4573
     protected function _get_msg_ids_from_request()
4574 4574
     {
4575
-        if (! isset($this->_req_data['MSG_ID'])) {
4575
+        if ( ! isset($this->_req_data['MSG_ID'])) {
4576 4576
             return array();
4577 4577
         }
4578 4578
 
Please login to merge, or discard this patch.
Indentation   +4537 added lines, -4537 removed lines patch added patch discarded remove patch
@@ -19,2638 +19,2638 @@  discard block
 block discarded – undo
19 19
 class Messages_Admin_Page extends EE_Admin_Page
20 20
 {
21 21
 
22
-    /**
23
-     * @type EE_Message_Resource_Manager $_message_resource_manager
24
-     */
25
-    protected $_message_resource_manager;
26
-
27
-    /**
28
-     * @type string $_active_message_type_name
29
-     */
30
-    protected $_active_message_type_name = '';
31
-
32
-    /**
33
-     * @type EE_messenger $_active_messenger
34
-     */
35
-    protected $_active_messenger;
36
-    protected $_activate_state;
37
-    protected $_activate_meta_box_type;
38
-    protected $_current_message_meta_box;
39
-    protected $_current_message_meta_box_object;
40
-    protected $_context_switcher;
41
-    protected $_shortcodes = array();
42
-    protected $_active_messengers = array();
43
-    protected $_active_message_types = array();
44
-
45
-    /**
46
-     * @var EE_Message_Template_Group $_message_template_group
47
-     */
48
-    protected $_message_template_group;
49
-    protected $_m_mt_settings = array();
50
-
51
-
52
-    /**
53
-     * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
54
-     * IF there is no group then it gets automatically set to the Default template pack.
55
-     *
56
-     * @since 4.5.0
57
-     *
58
-     * @var EE_Messages_Template_Pack
59
-     */
60
-    protected $_template_pack;
61
-
62
-
63
-    /**
64
-     * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
65
-     * group is.  If there is no group then it automatically gets set to default.
66
-     *
67
-     * @since 4.5.0
68
-     *
69
-     * @var string
70
-     */
71
-    protected $_variation;
72
-
73
-
74
-    /**
75
-     * @param bool $routing
76
-     * @throws EE_Error
77
-     */
78
-    public function __construct($routing = true)
79
-    {
80
-        // make sure messages autoloader is running
81
-        EED_Messages::set_autoloaders();
82
-        parent::__construct($routing);
83
-    }
84
-
85
-
86
-    protected function _init_page_props()
87
-    {
88
-        $this->page_slug = EE_MSG_PG_SLUG;
89
-        $this->page_label = esc_html__('Messages Settings', 'event_espresso');
90
-        $this->_admin_base_url = EE_MSG_ADMIN_URL;
91
-        $this->_admin_base_path = EE_MSG_ADMIN;
92
-
93
-        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array) $this->_req_data['activate_state']
94
-            : array();
95
-
96
-        $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
97
-        $this->_load_message_resource_manager();
98
-    }
99
-
100
-
101
-    /**
102
-     * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
103
-     *
104
-     * @throws EE_Error
105
-     * @throws InvalidDataTypeException
106
-     * @throws InvalidInterfaceException
107
-     * @throws InvalidArgumentException
108
-     * @throws ReflectionException
109
-     */
110
-    protected function _load_message_resource_manager()
111
-    {
112
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
113
-    }
114
-
115
-
116
-    /**
117
-     * @deprecated 4.9.9.rc.014
118
-     * @return array
119
-     * @throws EE_Error
120
-     * @throws InvalidArgumentException
121
-     * @throws InvalidDataTypeException
122
-     * @throws InvalidInterfaceException
123
-     */
124
-    public function get_messengers_for_list_table()
125
-    {
126
-        EE_Error::doing_it_wrong(
127
-            __METHOD__,
128
-            sprintf(
129
-                esc_html__(
130
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a messenger filter dropdown which is now generated differently via %s',
131
-                    'event_espresso'
132
-                ),
133
-                'Messages_Admin_Page::get_messengers_select_input()'
134
-            ),
135
-            '4.9.9.rc.014'
136
-        );
137
-
138
-        $m_values = array();
139
-        $active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
140
-        // setup messengers for selects
141
-        $i = 1;
142
-        foreach ($active_messengers as $active_messenger) {
143
-            if ($active_messenger instanceof EE_Message) {
144
-                $m_values[ $i ]['id'] = $active_messenger->messenger();
145
-                $m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
146
-                $i++;
147
-            }
148
-        }
149
-
150
-        return $m_values;
151
-    }
152
-
153
-
154
-    /**
155
-     * @deprecated 4.9.9.rc.014
156
-     * @return array
157
-     * @throws EE_Error
158
-     * @throws InvalidArgumentException
159
-     * @throws InvalidDataTypeException
160
-     * @throws InvalidInterfaceException
161
-     */
162
-    public function get_message_types_for_list_table()
163
-    {
164
-        EE_Error::doing_it_wrong(
165
-            __METHOD__,
166
-            sprintf(
167
-                esc_html__(
168
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type filter dropdown which is now generated differently via %s',
169
-                    'event_espresso'
170
-                ),
171
-                'Messages_Admin_Page::get_message_types_select_input()'
172
-            ),
173
-            '4.9.9.rc.014'
174
-        );
175
-
176
-        $mt_values = array();
177
-        $active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
178
-        $i = 1;
179
-        foreach ($active_messages as $active_message) {
180
-            if ($active_message instanceof EE_Message) {
181
-                $mt_values[ $i ]['id'] = $active_message->message_type();
182
-                $mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
183
-                $i++;
184
-            }
185
-        }
186
-
187
-        return $mt_values;
188
-    }
189
-
190
-
191
-    /**
192
-     * @deprecated 4.9.9.rc.014
193
-     * @return array
194
-     * @throws EE_Error
195
-     * @throws InvalidArgumentException
196
-     * @throws InvalidDataTypeException
197
-     * @throws InvalidInterfaceException
198
-     */
199
-    public function get_contexts_for_message_types_for_list_table()
200
-    {
201
-        EE_Error::doing_it_wrong(
202
-            __METHOD__,
203
-            sprintf(
204
-                esc_html__(
205
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type context filter dropdown which is now generated differently via %s',
206
-                    'event_espresso'
207
-                ),
208
-                'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
209
-            ),
210
-            '4.9.9.rc.014'
211
-        );
212
-
213
-        $contexts = array();
214
-        $active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
215
-        foreach ($active_message_contexts as $active_message) {
216
-            if ($active_message instanceof EE_Message) {
217
-                $message_type = $active_message->message_type_object();
218
-                if ($message_type instanceof EE_message_type) {
219
-                    $message_type_contexts = $message_type->get_contexts();
220
-                    foreach ($message_type_contexts as $context => $context_details) {
221
-                        $contexts[ $context ] = $context_details['label'];
222
-                    }
223
-                }
224
-            }
225
-        }
226
-
227
-        return $contexts;
228
-    }
229
-
230
-
231
-    /**
232
-     * Generate select input with provided messenger options array.
233
-     *
234
-     * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
235
-     *                                 labels.
236
-     * @return string
237
-     * @throws EE_Error
238
-     */
239
-    public function get_messengers_select_input($messenger_options)
240
-    {
241
-        // if empty or just one value then just return an empty string
242
-        if (empty($messenger_options)
243
-            || ! is_array($messenger_options)
244
-            || count($messenger_options) === 1
245
-        ) {
246
-            return '';
247
-        }
248
-        // merge in default
249
-        $messenger_options = array_merge(
250
-            array('none_selected' => esc_html__('Show All Messengers', 'event_espresso')),
251
-            $messenger_options
252
-        );
253
-        $input = new EE_Select_Input(
254
-            $messenger_options,
255
-            array(
256
-                'html_name'  => 'ee_messenger_filter_by',
257
-                'html_id'    => 'ee_messenger_filter_by',
258
-                'html_class' => 'wide',
259
-                'default'    => isset($this->_req_data['ee_messenger_filter_by'])
260
-                    ? sanitize_title($this->_req_data['ee_messenger_filter_by'])
261
-                    : 'none_selected',
262
-            )
263
-        );
264
-
265
-        return $input->get_html_for_input();
266
-    }
267
-
268
-
269
-    /**
270
-     * Generate select input with provided message type options array.
271
-     *
272
-     * @param array $message_type_options Array of message types indexed by message type slug, and values are the
273
-     *                                    message type labels
274
-     * @return string
275
-     * @throws EE_Error
276
-     */
277
-    public function get_message_types_select_input($message_type_options)
278
-    {
279
-        // if empty or count of options is 1 then just return an empty string
280
-        if (empty($message_type_options)
281
-            || ! is_array($message_type_options)
282
-            || count($message_type_options) === 1
283
-        ) {
284
-            return '';
285
-        }
286
-        // merge in default
287
-        $message_type_options = array_merge(
288
-            array('none_selected' => esc_html__('Show All Message Types', 'event_espresso')),
289
-            $message_type_options
290
-        );
291
-        $input = new EE_Select_Input(
292
-            $message_type_options,
293
-            array(
294
-                'html_name'  => 'ee_message_type_filter_by',
295
-                'html_id'    => 'ee_message_type_filter_by',
296
-                'html_class' => 'wide',
297
-                'default'    => isset($this->_req_data['ee_message_type_filter_by'])
298
-                    ? sanitize_title($this->_req_data['ee_message_type_filter_by'])
299
-                    : 'none_selected',
300
-            )
301
-        );
302
-
303
-        return $input->get_html_for_input();
304
-    }
305
-
306
-
307
-    /**
308
-     * Generate select input with provide message type contexts array.
309
-     *
310
-     * @param array $context_options Array of message type contexts indexed by context slug, and values are the
311
-     *                               context label.
312
-     * @return string
313
-     * @throws EE_Error
314
-     */
315
-    public function get_contexts_for_message_types_select_input($context_options)
316
-    {
317
-        // if empty or count of options is one then just return empty string
318
-        if (empty($context_options)
319
-            || ! is_array($context_options)
320
-            || count($context_options) === 1
321
-        ) {
322
-            return '';
323
-        }
324
-        // merge in default
325
-        $context_options = array_merge(
326
-            array('none_selected' => esc_html__('Show all Contexts', 'event_espresso')),
327
-            $context_options
328
-        );
329
-        $input = new EE_Select_Input(
330
-            $context_options,
331
-            array(
332
-                'html_name'  => 'ee_context_filter_by',
333
-                'html_id'    => 'ee_context_filter_by',
334
-                'html_class' => 'wide',
335
-                'default'    => isset($this->_req_data['ee_context_filter_by'])
336
-                    ? sanitize_title($this->_req_data['ee_context_filter_by'])
337
-                    : 'none_selected',
338
-            )
339
-        );
340
-
341
-        return $input->get_html_for_input();
342
-    }
343
-
344
-
345
-    protected function _ajax_hooks()
346
-    {
347
-        add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
348
-        add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
349
-        add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
350
-        add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
351
-        add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
352
-        add_action('wp_ajax_toggle_context_template', array($this, 'toggle_context_template'));
353
-    }
354
-
355
-
356
-    protected function _define_page_props()
357
-    {
358
-        $this->_admin_page_title = $this->page_label;
359
-        $this->_labels = array(
360
-            'buttons'    => array(
361
-                'add'    => esc_html__('Add New Message Template', 'event_espresso'),
362
-                'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
363
-                'delete' => esc_html__('Delete Message Template', 'event_espresso'),
364
-            ),
365
-            'publishbox' => esc_html__('Update Actions', 'event_espresso'),
366
-        );
367
-    }
368
-
369
-
370
-    /**
371
-     *        an array for storing key => value pairs of request actions and their corresponding methods
372
-     *
373
-     * @access protected
374
-     * @return void
375
-     */
376
-    protected function _set_page_routes()
377
-    {
378
-        $grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
379
-            ? $this->_req_data['GRP_ID']
380
-            : 0;
381
-        $grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
382
-            ? $this->_req_data['id']
383
-            : $grp_id;
384
-        $msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
385
-            ? $this->_req_data['MSG_ID']
386
-            : 0;
387
-
388
-        $this->_page_routes = array(
389
-            'default'                          => array(
390
-                'func'       => '_message_queue_list_table',
391
-                'capability' => 'ee_read_global_messages',
392
-            ),
393
-            'global_mtps'                      => array(
394
-                'func'       => '_ee_default_messages_overview_list_table',
395
-                'capability' => 'ee_read_global_messages',
396
-            ),
397
-            'custom_mtps'                      => array(
398
-                'func'       => '_custom_mtps_preview',
399
-                'capability' => 'ee_read_messages',
400
-            ),
401
-            'add_new_message_template'         => array(
402
-                'func'       => '_add_message_template',
403
-                'capability' => 'ee_edit_messages',
404
-                'noheader'   => true,
405
-            ),
406
-            'edit_message_template'            => array(
407
-                'func'       => '_edit_message_template',
408
-                'capability' => 'ee_edit_message',
409
-                'obj_id'     => $grp_id,
410
-            ),
411
-            'preview_message'                  => array(
412
-                'func'               => '_preview_message',
413
-                'capability'         => 'ee_read_message',
414
-                'obj_id'             => $grp_id,
415
-                'noheader'           => true,
416
-                'headers_sent_route' => 'display_preview_message',
417
-            ),
418
-            'display_preview_message'          => array(
419
-                'func'       => '_display_preview_message',
420
-                'capability' => 'ee_read_message',
421
-                'obj_id'     => $grp_id,
422
-            ),
423
-            'insert_message_template'          => array(
424
-                'func'       => '_insert_or_update_message_template',
425
-                'capability' => 'ee_edit_messages',
426
-                'args'       => array('new_template' => true),
427
-                'noheader'   => true,
428
-            ),
429
-            'update_message_template'          => array(
430
-                'func'       => '_insert_or_update_message_template',
431
-                'capability' => 'ee_edit_message',
432
-                'obj_id'     => $grp_id,
433
-                'args'       => array('new_template' => false),
434
-                'noheader'   => true,
435
-            ),
436
-            'trash_message_template'           => array(
437
-                'func'       => '_trash_or_restore_message_template',
438
-                'capability' => 'ee_delete_message',
439
-                'obj_id'     => $grp_id,
440
-                'args'       => array('trash' => true, 'all' => true),
441
-                'noheader'   => true,
442
-            ),
443
-            'trash_message_template_context'   => array(
444
-                'func'       => '_trash_or_restore_message_template',
445
-                'capability' => 'ee_delete_message',
446
-                'obj_id'     => $grp_id,
447
-                'args'       => array('trash' => true),
448
-                'noheader'   => true,
449
-            ),
450
-            'restore_message_template'         => array(
451
-                'func'       => '_trash_or_restore_message_template',
452
-                'capability' => 'ee_delete_message',
453
-                'obj_id'     => $grp_id,
454
-                'args'       => array('trash' => false, 'all' => true),
455
-                'noheader'   => true,
456
-            ),
457
-            'restore_message_template_context' => array(
458
-                'func'       => '_trash_or_restore_message_template',
459
-                'capability' => 'ee_delete_message',
460
-                'obj_id'     => $grp_id,
461
-                'args'       => array('trash' => false),
462
-                'noheader'   => true,
463
-            ),
464
-            'delete_message_template'          => array(
465
-                'func'       => '_delete_message_template',
466
-                'capability' => 'ee_delete_message',
467
-                'obj_id'     => $grp_id,
468
-                'noheader'   => true,
469
-            ),
470
-            'reset_to_default'                 => array(
471
-                'func'       => '_reset_to_default_template',
472
-                'capability' => 'ee_edit_message',
473
-                'obj_id'     => $grp_id,
474
-                'noheader'   => true,
475
-            ),
476
-            'settings'                         => array(
477
-                'func'       => '_settings',
478
-                'capability' => 'manage_options',
479
-            ),
480
-            'update_global_settings'           => array(
481
-                'func'       => '_update_global_settings',
482
-                'capability' => 'manage_options',
483
-                'noheader'   => true,
484
-            ),
485
-            'generate_now'                     => array(
486
-                'func'       => '_generate_now',
487
-                'capability' => 'ee_send_message',
488
-                'noheader'   => true,
489
-            ),
490
-            'generate_and_send_now'            => array(
491
-                'func'       => '_generate_and_send_now',
492
-                'capability' => 'ee_send_message',
493
-                'noheader'   => true,
494
-            ),
495
-            'queue_for_resending'              => array(
496
-                'func'       => '_queue_for_resending',
497
-                'capability' => 'ee_send_message',
498
-                'noheader'   => true,
499
-            ),
500
-            'send_now'                         => array(
501
-                'func'       => '_send_now',
502
-                'capability' => 'ee_send_message',
503
-                'noheader'   => true,
504
-            ),
505
-            'delete_ee_message'                => array(
506
-                'func'       => '_delete_ee_messages',
507
-                'capability' => 'ee_delete_messages',
508
-                'noheader'   => true,
509
-            ),
510
-            'delete_ee_messages'               => array(
511
-                'func'       => '_delete_ee_messages',
512
-                'capability' => 'ee_delete_messages',
513
-                'noheader'   => true,
514
-                'obj_id'     => $msg_id,
515
-            ),
516
-        );
517
-    }
518
-
519
-
520
-    protected function _set_page_config()
521
-    {
522
-        $this->_page_config = array(
523
-            'default'                  => array(
524
-                'nav'           => array(
525
-                    'label' => esc_html__('Message Activity', 'event_espresso'),
526
-                    'order' => 10,
527
-                ),
528
-                'list_table'    => 'EE_Message_List_Table',
529
-                // 'qtips' => array( 'EE_Message_List_Table_Tips' ),
530
-                'require_nonce' => false,
531
-            ),
532
-            'global_mtps'              => array(
533
-                'nav'           => array(
534
-                    'label' => esc_html__('Default Message Templates', 'event_espresso'),
535
-                    'order' => 20,
536
-                ),
537
-                'list_table'    => 'Messages_Template_List_Table',
538
-                'help_tabs'     => array(
539
-                    'messages_overview_help_tab'                                => array(
540
-                        'title'    => esc_html__('Messages Overview', 'event_espresso'),
541
-                        'filename' => 'messages_overview',
542
-                    ),
543
-                    'messages_overview_messages_table_column_headings_help_tab' => array(
544
-                        'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
545
-                        'filename' => 'messages_overview_table_column_headings',
546
-                    ),
547
-                    'messages_overview_messages_filters_help_tab'               => array(
548
-                        'title'    => esc_html__('Message Filters', 'event_espresso'),
549
-                        'filename' => 'messages_overview_filters',
550
-                    ),
551
-                    'messages_overview_messages_views_help_tab'                 => array(
552
-                        'title'    => esc_html__('Message Views', 'event_espresso'),
553
-                        'filename' => 'messages_overview_views',
554
-                    ),
555
-                    'message_overview_message_types_help_tab'                   => array(
556
-                        'title'    => esc_html__('Message Types', 'event_espresso'),
557
-                        'filename' => 'messages_overview_types',
558
-                    ),
559
-                    'messages_overview_messengers_help_tab'                     => array(
560
-                        'title'    => esc_html__('Messengers', 'event_espresso'),
561
-                        'filename' => 'messages_overview_messengers',
562
-                    ),
563
-                ),
564
-                'help_tour'     => array('Messages_Overview_Help_Tour'),
565
-                'require_nonce' => false,
566
-            ),
567
-            'custom_mtps'              => array(
568
-                'nav'           => array(
569
-                    'label' => esc_html__('Custom Message Templates', 'event_espresso'),
570
-                    'order' => 30,
571
-                ),
572
-                'help_tabs'     => array(),
573
-                'help_tour'     => array(),
574
-                'require_nonce' => false,
575
-            ),
576
-            'add_new_message_template' => array(
577
-                'nav'           => array(
578
-                    'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
579
-                    'order'      => 5,
580
-                    'persistent' => false,
581
-                ),
582
-                'require_nonce' => false,
583
-            ),
584
-            'edit_message_template'    => array(
585
-                'labels'        => array(
586
-                    'buttons'    => array(
587
-                        'reset' => esc_html__('Reset Templates', 'event_espresso'),
588
-                    ),
589
-                    'publishbox' => esc_html__('Update Actions', 'event_espresso'),
590
-                ),
591
-                'nav'           => array(
592
-                    'label'      => esc_html__('Edit Message Templates', 'event_espresso'),
593
-                    'order'      => 5,
594
-                    'persistent' => false,
595
-                    'url'        => '',
596
-                ),
597
-                'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
598
-                'has_metaboxes' => true,
599
-                'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
600
-                'help_tabs'     => array(
601
-                    'edit_message_template'            => array(
602
-                        'title'    => esc_html__('Message Template Editor', 'event_espresso'),
603
-                        'callback' => 'edit_message_template_help_tab',
604
-                    ),
605
-                    'message_templates_help_tab'       => array(
606
-                        'title'    => esc_html__('Message Templates', 'event_espresso'),
607
-                        'filename' => 'messages_templates',
608
-                    ),
609
-                    'message_template_shortcodes'      => array(
610
-                        'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
611
-                        'callback' => 'message_template_shortcodes_help_tab',
612
-                    ),
613
-                    'message_preview_help_tab'         => array(
614
-                        'title'    => esc_html__('Message Preview', 'event_espresso'),
615
-                        'filename' => 'messages_preview',
616
-                    ),
617
-                    'messages_overview_other_help_tab' => array(
618
-                        'title'    => esc_html__('Messages Other', 'event_espresso'),
619
-                        'filename' => 'messages_overview_other',
620
-                    ),
621
-                ),
622
-                'require_nonce' => false,
623
-            ),
624
-            'display_preview_message'  => array(
625
-                'nav'           => array(
626
-                    'label'      => esc_html__('Message Preview', 'event_espresso'),
627
-                    'order'      => 5,
628
-                    'url'        => '',
629
-                    'persistent' => false,
630
-                ),
631
-                'help_tabs'     => array(
632
-                    'preview_message' => array(
633
-                        'title'    => esc_html__('About Previews', 'event_espresso'),
634
-                        'callback' => 'preview_message_help_tab',
635
-                    ),
636
-                ),
637
-                'require_nonce' => false,
638
-            ),
639
-            'settings'                 => array(
640
-                'nav'           => array(
641
-                    'label' => esc_html__('Settings', 'event_espresso'),
642
-                    'order' => 40,
643
-                ),
644
-                'metaboxes'     => array('_messages_settings_metaboxes'),
645
-                'help_tabs'     => array(
646
-                    'messages_settings_help_tab'               => array(
647
-                        'title'    => esc_html__('Messages Settings', 'event_espresso'),
648
-                        'filename' => 'messages_settings',
649
-                    ),
650
-                    'messages_settings_message_types_help_tab' => array(
651
-                        'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
652
-                        'filename' => 'messages_settings_message_types',
653
-                    ),
654
-                    'messages_settings_messengers_help_tab'    => array(
655
-                        'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
656
-                        'filename' => 'messages_settings_messengers',
657
-                    ),
658
-                ),
659
-                'help_tour'     => array('Messages_Settings_Help_Tour'),
660
-                'require_nonce' => false,
661
-            ),
662
-        );
663
-    }
664
-
665
-
666
-    protected function _add_screen_options()
667
-    {
668
-        // todo
669
-    }
670
-
671
-
672
-    protected function _add_screen_options_global_mtps()
673
-    {
674
-        /**
675
-         * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
676
-         * uses the $_admin_page_title property and we want different outputs in the different spots.
677
-         */
678
-        $page_title = $this->_admin_page_title;
679
-        $this->_admin_page_title = esc_html__('Global Message Templates', 'event_espresso');
680
-        $this->_per_page_screen_option();
681
-        $this->_admin_page_title = $page_title;
682
-    }
683
-
684
-
685
-    protected function _add_screen_options_default()
686
-    {
687
-        $this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
688
-        $this->_per_page_screen_option();
689
-    }
690
-
691
-
692
-    // none of the below group are currently used for Messages
693
-    protected function _add_feature_pointers()
694
-    {
695
-    }
696
-
697
-    public function admin_init()
698
-    {
699
-    }
700
-
701
-    public function admin_notices()
702
-    {
703
-    }
704
-
705
-    public function admin_footer_scripts()
706
-    {
707
-    }
708
-
709
-
710
-    public function messages_help_tab()
711
-    {
712
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
713
-    }
714
-
715
-
716
-    public function messengers_help_tab()
717
-    {
718
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
719
-    }
720
-
721
-
722
-    public function message_types_help_tab()
723
-    {
724
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
725
-    }
726
-
727
-
728
-    public function messages_overview_help_tab()
729
-    {
730
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
731
-    }
732
-
733
-
734
-    public function message_templates_help_tab()
735
-    {
736
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
737
-    }
738
-
739
-
740
-    public function edit_message_template_help_tab()
741
-    {
742
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
743
-                        . esc_attr__('Editor Title', 'event_espresso')
744
-                        . '" />';
745
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
746
-                        . esc_attr__('Context Switcher and Preview', 'event_espresso')
747
-                        . '" />';
748
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
749
-                        . esc_attr__('Message Template Form Fields', 'event_espresso')
750
-                        . '" />';
751
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
752
-                        . esc_attr__('Shortcodes Metabox', 'event_espresso')
753
-                        . '" />';
754
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
755
-                        . esc_attr__('Publish Metabox', 'event_espresso')
756
-                        . '" />';
757
-        EEH_Template::display_template(
758
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
759
-            $args
760
-        );
761
-    }
762
-
763
-
764
-    public function message_template_shortcodes_help_tab()
765
-    {
766
-        $this->_set_shortcodes();
767
-        $args['shortcodes'] = $this->_shortcodes;
768
-        EEH_Template::display_template(
769
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
770
-            $args
771
-        );
772
-    }
773
-
774
-
775
-    public function preview_message_help_tab()
776
-    {
777
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
778
-    }
779
-
780
-
781
-    public function settings_help_tab()
782
-    {
783
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
784
-                        . '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
785
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
786
-                        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
787
-        $args['img3'] = '<div class="switch">'
788
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
789
-                        . ' type="checkbox" checked="checked">'
790
-                        . '<label for="ee-on-off-toggle-on"></label>'
791
-                        . '</div>';
792
-        $args['img4'] = '<div class="switch">'
793
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
794
-                        . ' type="checkbox">'
795
-                        . '<label for="ee-on-off-toggle-on"></label>'
796
-                        . '</div>';
797
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
798
-    }
799
-
800
-
801
-    public function load_scripts_styles()
802
-    {
803
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
804
-        wp_enqueue_style('espresso_ee_msg');
805
-
806
-        wp_register_script(
807
-            'ee-messages-settings',
808
-            EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
809
-            array('jquery-ui-droppable', 'ee-serialize-full-array'),
810
-            EVENT_ESPRESSO_VERSION,
811
-            true
812
-        );
813
-        wp_register_script(
814
-            'ee-msg-list-table-js',
815
-            EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
816
-            array('ee-dialog'),
817
-            EVENT_ESPRESSO_VERSION
818
-        );
819
-    }
820
-
821
-
822
-    public function load_scripts_styles_default()
823
-    {
824
-        wp_enqueue_script('ee-msg-list-table-js');
825
-    }
826
-
827
-
828
-    public function wp_editor_css($mce_css)
829
-    {
830
-        // if we're on the edit_message_template route
831
-        if ($this->_req_action === 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
832
-            $message_type_name = $this->_active_message_type_name;
833
-
834
-            // we're going to REPLACE the existing mce css
835
-            // we need to get the css file location from the active messenger
836
-            $mce_css = $this->_active_messenger->get_variation(
837
-                $this->_template_pack,
838
-                $message_type_name,
839
-                true,
840
-                'wpeditor',
841
-                $this->_variation
842
-            );
843
-        }
844
-
845
-        return $mce_css;
846
-    }
847
-
848
-
849
-    public function load_scripts_styles_edit_message_template()
850
-    {
851
-
852
-        $this->_set_shortcodes();
853
-
854
-        EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf(
855
-            esc_html__(
856
-                'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
857
-                'event_espresso'
858
-            ),
859
-            $this->_message_template_group->messenger_obj()->label['singular'],
860
-            $this->_message_template_group->message_type_obj()->label['singular']
861
-        );
862
-        EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = esc_html__(
863
-            'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
864
-            'event_espresso'
865
-        );
866
-        EE_Registry::$i18n_js_strings['server_error'] = esc_html__(
867
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
868
-            'event_espresso'
869
-        );
870
-
871
-        wp_register_script(
872
-            'ee_msgs_edit_js',
873
-            EE_MSG_ASSETS_URL . 'ee_message_editor.js',
874
-            array('jquery'),
875
-            EVENT_ESPRESSO_VERSION
876
-        );
877
-
878
-        wp_enqueue_script('ee_admin_js');
879
-        wp_enqueue_script('ee_msgs_edit_js');
880
-
881
-        // add in special css for tiny_mce
882
-        add_filter('mce_css', array($this, 'wp_editor_css'));
883
-    }
884
-
885
-
886
-    public function load_scripts_styles_display_preview_message()
887
-    {
888
-
889
-        $this->_set_message_template_group();
890
-
891
-        if (isset($this->_req_data['messenger'])) {
892
-            $this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
893
-                $this->_req_data['messenger']
894
-            );
895
-        }
896
-
897
-        $message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
898
-
899
-
900
-        wp_enqueue_style(
901
-            'espresso_preview_css',
902
-            $this->_active_messenger->get_variation(
903
-                $this->_template_pack,
904
-                $message_type_name,
905
-                true,
906
-                'preview',
907
-                $this->_variation
908
-            )
909
-        );
910
-    }
911
-
912
-
913
-    public function load_scripts_styles_settings()
914
-    {
915
-        wp_register_style(
916
-            'ee-message-settings',
917
-            EE_MSG_ASSETS_URL . 'ee_message_settings.css',
918
-            array(),
919
-            EVENT_ESPRESSO_VERSION
920
-        );
921
-        wp_enqueue_style('ee-text-links');
922
-        wp_enqueue_style('ee-message-settings');
923
-        wp_enqueue_script('ee-messages-settings');
924
-    }
925
-
926
-
927
-    /**
928
-     * set views array for List Table
929
-     */
930
-    public function _set_list_table_views_global_mtps()
931
-    {
932
-        $this->_views = array(
933
-            'in_use' => array(
934
-                'slug'  => 'in_use',
935
-                'label' => esc_html__('In Use', 'event_espresso'),
936
-                'count' => 0,
937
-            ),
938
-        );
939
-    }
940
-
941
-
942
-    /**
943
-     * Set views array for the Custom Template List Table
944
-     */
945
-    public function _set_list_table_views_custom_mtps()
946
-    {
947
-        $this->_set_list_table_views_global_mtps();
948
-        $this->_views['in_use']['bulk_action'] = array(
949
-            'trash_message_template' => esc_html__('Move to Trash', 'event_espresso'),
950
-        );
951
-    }
952
-
953
-
954
-    /**
955
-     * set views array for message queue list table
956
-     *
957
-     * @throws InvalidDataTypeException
958
-     * @throws InvalidInterfaceException
959
-     * @throws InvalidArgumentException
960
-     * @throws EE_Error
961
-     * @throws ReflectionException
962
-     */
963
-    public function _set_list_table_views_default()
964
-    {
965
-        EE_Registry::instance()->load_helper('Template');
966
-
967
-        $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can(
968
-            'ee_send_message',
969
-            'message_list_table_bulk_actions'
970
-        )
971
-            ? array(
972
-                'generate_now'          => esc_html__('Generate Now', 'event_espresso'),
973
-                'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
974
-                'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
975
-                'send_now'              => esc_html__('Send Now', 'event_espresso'),
976
-            )
977
-            : array();
978
-
979
-        $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can(
980
-            'ee_delete_messages',
981
-            'message_list_table_bulk_actions'
982
-        )
983
-            ? array('delete_ee_messages' => esc_html__('Delete Messages', 'event_espresso'))
984
-            : array();
985
-
986
-
987
-        $this->_views = array(
988
-            'all' => array(
989
-                'slug'        => 'all',
990
-                'label'       => esc_html__('All', 'event_espresso'),
991
-                'count'       => 0,
992
-                'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action),
993
-            ),
994
-        );
995
-
996
-
997
-        foreach (EEM_Message::instance()->all_statuses() as $status) {
998
-            if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
999
-                continue;
1000
-            }
1001
-            $status_bulk_actions = $common_bulk_actions;
1002
-            // unset bulk actions not applying to status
1003
-            if (! empty($status_bulk_actions)) {
1004
-                switch ($status) {
1005
-                    case EEM_Message::status_idle:
1006
-                    case EEM_Message::status_resend:
1007
-                        $status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
1008
-                        break;
1009
-
1010
-                    case EEM_Message::status_failed:
1011
-                    case EEM_Message::status_debug_only:
1012
-                    case EEM_Message::status_messenger_executing:
1013
-                        $status_bulk_actions = array();
1014
-                        break;
1015
-
1016
-                    case EEM_Message::status_incomplete:
1017
-                        unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
1018
-                        break;
1019
-
1020
-                    case EEM_Message::status_retry:
1021
-                    case EEM_Message::status_sent:
1022
-                        unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
1023
-                        break;
1024
-                }
1025
-            }
1026
-
1027
-            // skip adding messenger executing status to views because it will be included with the Failed view.
1028
-            if ($status === EEM_Message::status_messenger_executing) {
1029
-                continue;
1030
-            }
1031
-
1032
-            $this->_views[ strtolower($status) ] = array(
1033
-                'slug'        => strtolower($status),
1034
-                'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
1035
-                'count'       => 0,
1036
-                'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action),
1037
-            );
1038
-        }
1039
-    }
1040
-
1041
-
1042
-    protected function _ee_default_messages_overview_list_table()
1043
-    {
1044
-        $this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
1045
-        $this->display_admin_list_table_page_with_no_sidebar();
1046
-    }
1047
-
1048
-
1049
-    protected function _message_queue_list_table()
1050
-    {
1051
-        $this->_search_btn_label = esc_html__('Message Activity', 'event_espresso');
1052
-        $this->_template_args['per_column'] = 6;
1053
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_message_legend_items());
1054
-        $this->_template_args['before_list_table'] = '<h3>'
1055
-                                                     . EEM_Message::instance()->get_pretty_label_for_results()
1056
-                                                     . '</h3>';
1057
-        $this->display_admin_list_table_page_with_no_sidebar();
1058
-    }
1059
-
1060
-
1061
-    protected function _message_legend_items()
1062
-    {
1063
-
1064
-        $action_css_classes = EEH_MSG_Template::get_message_action_icons();
1065
-        $action_items = array();
1066
-
1067
-        foreach ($action_css_classes as $action_item => $action_details) {
1068
-            if ($action_item === 'see_notifications_for') {
1069
-                continue;
1070
-            }
1071
-            $action_items[ $action_item ] = array(
1072
-                'class' => $action_details['css_class'],
1073
-                'desc'  => $action_details['label'],
1074
-            );
1075
-        }
1076
-
1077
-        /** @type array $status_items status legend setup */
1078
-        $status_items = array(
1079
-            'incomplete_status'          => array(
1080
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
1081
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
1082
-            ),
1083
-            'idle_status'                => array(
1084
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
1085
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
1086
-            ),
1087
-            'resend_status'              => array(
1088
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
1089
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
1090
-            ),
1091
-            'messenger_executing_status' => array(
1092
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
1093
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
1094
-            ),
1095
-            'sent_status'                => array(
1096
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
1097
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
1098
-            ),
1099
-            'retry_status'               => array(
1100
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
1101
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
1102
-            ),
1103
-            'failed_status'              => array(
1104
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
1105
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
1106
-            ),
1107
-        );
1108
-        if (EEM_Message::debug()) {
1109
-            $status_items['debug_only_status'] = array(
1110
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
1111
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
1112
-            );
1113
-        }
1114
-
1115
-        return array_merge($action_items, $status_items);
1116
-    }
1117
-
1118
-
1119
-    protected function _custom_mtps_preview()
1120
-    {
1121
-        $this->_admin_page_title = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
1122
-        $this->_template_args['preview_img'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
1123
-                                               . ' alt="' . esc_attr__(
1124
-                                                   'Preview Custom Message Templates screenshot',
1125
-                                                   'event_espresso'
1126
-                                               ) . '" />';
1127
-        $this->_template_args['preview_text'] = '<strong>'
1128
-                                                . esc_html__(
1129
-                                                    'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
1130
-                                                    'event_espresso'
1131
-                                                )
1132
-                                                . '</strong>';
1133
-
1134
-        $this->display_admin_caf_preview_page('custom_message_types', false);
1135
-    }
1136
-
1137
-
1138
-    /**
1139
-     * get_message_templates
1140
-     * This gets all the message templates for listing on the overview list.
1141
-     *
1142
-     * @access public
1143
-     * @param int    $perpage the amount of templates groups to show per page
1144
-     * @param string $type    the current _view we're getting templates for
1145
-     * @param bool   $count   return count?
1146
-     * @param bool   $all     disregard any paging info (get all data);
1147
-     * @param bool   $global  whether to return just global (true) or custom templates (false)
1148
-     * @return array
1149
-     * @throws EE_Error
1150
-     * @throws InvalidArgumentException
1151
-     * @throws InvalidDataTypeException
1152
-     * @throws InvalidInterfaceException
1153
-     */
1154
-    public function get_message_templates(
1155
-        $perpage = 10,
1156
-        $type = 'in_use',
1157
-        $count = false,
1158
-        $all = false,
1159
-        $global = true
1160
-    ) {
1161
-
1162
-        $MTP = EEM_Message_Template_Group::instance();
1163
-
1164
-        $this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
1165
-        $orderby = $this->_req_data['orderby'];
1166
-
1167
-        $order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
1168
-            ? $this->_req_data['order']
1169
-            : 'ASC';
1170
-
1171
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
1172
-            ? $this->_req_data['paged']
1173
-            : 1;
1174
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
1175
-            ? $this->_req_data['perpage']
1176
-            : $perpage;
1177
-
1178
-        $offset = ($current_page - 1) * $per_page;
1179
-        $limit = $all ? null : array($offset, $per_page);
1180
-
1181
-
1182
-        // options will match what is in the _views array property
1183
-        switch ($type) {
1184
-            case 'in_use':
1185
-                $templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
1186
-                break;
1187
-            default:
1188
-                $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
1189
-        }
1190
-
1191
-        return $templates;
1192
-    }
1193
-
1194
-
1195
-    /**
1196
-     * filters etc might need a list of installed message_types
1197
-     *
1198
-     * @return array an array of message type objects
1199
-     */
1200
-    public function get_installed_message_types()
1201
-    {
1202
-        $installed_message_types = $this->_message_resource_manager->installed_message_types();
1203
-        $installed = array();
1204
-
1205
-        foreach ($installed_message_types as $message_type) {
1206
-            $installed[ $message_type->name ] = $message_type;
1207
-        }
1208
-
1209
-        return $installed;
1210
-    }
1211
-
1212
-
1213
-    /**
1214
-     * _add_message_template
1215
-     *
1216
-     * This is used when creating a custom template. All Custom Templates start based off another template.
1217
-     *
1218
-     * @param string $message_type
1219
-     * @param string $messenger
1220
-     * @param string $GRP_ID
1221
-     *
1222
-     * @throws EE_error
1223
-     */
1224
-    protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
1225
-    {
1226
-        // set values override any request data
1227
-        $message_type = ! empty($message_type) ? $message_type : '';
1228
-        $message_type = empty($message_type) && ! empty($this->_req_data['message_type'])
1229
-            ? $this->_req_data['message_type']
1230
-            : $message_type;
1231
-
1232
-        $messenger = ! empty($messenger) ? $messenger : '';
1233
-        $messenger = empty($messenger) && ! empty($this->_req_data['messenger'])
1234
-            ? $this->_req_data['messenger']
1235
-            : $messenger;
1236
-
1237
-        $GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
1238
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
1239
-
1240
-        // we need messenger and message type.  They should be coming from the event editor. If not here then return error
1241
-        if (empty($message_type) || empty($messenger)) {
1242
-            throw new EE_Error(
1243
-                esc_html__(
1244
-                    'Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
1245
-                    'event_espresso'
1246
-                )
1247
-            );
1248
-        }
1249
-
1250
-        // we need the GRP_ID for the template being used as the base for the new template
1251
-        if (empty($GRP_ID)) {
1252
-            throw new EE_Error(
1253
-                esc_html__(
1254
-                    'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
1255
-                    'event_espresso'
1256
-                )
1257
-            );
1258
-        }
1259
-
1260
-        // let's just make sure the template gets generated!
1261
-
1262
-        // we need to reassign some variables for what the insert is expecting
1263
-        $this->_req_data['MTP_messenger'] = $messenger;
1264
-        $this->_req_data['MTP_message_type'] = $message_type;
1265
-        $this->_req_data['GRP_ID'] = $GRP_ID;
1266
-        $this->_insert_or_update_message_template(true);
1267
-    }
1268
-
1269
-
1270
-    /**
1271
-     * public wrapper for the _add_message_template method
1272
-     *
1273
-     * @param string $message_type     message type slug
1274
-     * @param string $messenger        messenger slug
1275
-     * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
1276
-     *                                 off of.
1277
-     * @throws EE_error
1278
-     */
1279
-    public function add_message_template($message_type, $messenger, $GRP_ID)
1280
-    {
1281
-        $this->_add_message_template($message_type, $messenger, $GRP_ID);
1282
-    }
1283
-
1284
-
1285
-    /**
1286
-     * _edit_message_template
1287
-     *
1288
-     * @access protected
1289
-     * @return void
1290
-     * @throws InvalidIdentifierException
1291
-     * @throws DomainException
1292
-     * @throws EE_Error
1293
-     * @throws InvalidArgumentException
1294
-     * @throws ReflectionException
1295
-     * @throws InvalidDataTypeException
1296
-     * @throws InvalidInterfaceException
1297
-     */
1298
-    protected function _edit_message_template()
1299
-    {
1300
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1301
-        $template_fields = '';
1302
-        $sidebar_fields = '';
1303
-        // we filter the tinyMCE settings to remove the validation since message templates by their nature will not have
1304
-        // valid html in the templates.
1305
-        add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
1306
-
1307
-        $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
1308
-            ? absint($this->_req_data['id'])
1309
-            : false;
1310
-
1311
-        $EVT_ID = isset($this->_req_data['evt_id']) && ! empty($this->_req_data['evt_id'])
1312
-        ? absint($this->_req_data['evt_id'])
1313
-        : false;
1314
-
1315
-        $this->_set_shortcodes(); // this also sets the _message_template property.
1316
-        $message_template_group = $this->_message_template_group;
1317
-        $c_label = $message_template_group->context_label();
1318
-        $c_config = $message_template_group->contexts_config();
1319
-
1320
-        reset($c_config);
1321
-        $context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
1322
-            ? strtolower($this->_req_data['context'])
1323
-            : key($c_config);
1324
-
1325
-
1326
-        if (empty($GRP_ID)) {
1327
-            $action = 'insert_message_template';
1328
-            $edit_message_template_form_url = add_query_arg(
1329
-                array('action' => $action, 'noheader' => true),
1330
-                EE_MSG_ADMIN_URL
1331
-            );
1332
-        } else {
1333
-            $action = 'update_message_template';
1334
-            $edit_message_template_form_url = add_query_arg(
1335
-                array('action' => $action, 'noheader' => true),
1336
-                EE_MSG_ADMIN_URL
1337
-            );
1338
-        }
1339
-
1340
-        // set active messenger for this view
1341
-        $this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
1342
-            $message_template_group->messenger()
1343
-        );
1344
-        $this->_active_message_type_name = $message_template_group->message_type();
1345
-
1346
-
1347
-        // Do we have any validation errors?
1348
-        $validators = $this->_get_transient();
1349
-        $v_fields = ! empty($validators) ? array_keys($validators) : array();
1350
-
1351
-
1352
-        // we need to assemble the title from Various details
1353
-        $context_label = sprintf(
1354
-            esc_html__('(%s %s)', 'event_espresso'),
1355
-            $c_config[ $context ]['label'],
1356
-            ucwords($c_label['label'])
1357
-        );
1358
-
1359
-        $title = sprintf(
1360
-            esc_html__(' %s %s Template %s', 'event_espresso'),
1361
-            ucwords($message_template_group->messenger_obj()->label['singular']),
1362
-            ucwords($message_template_group->message_type_obj()->label['singular']),
1363
-            $context_label
1364
-        );
1365
-
1366
-        $this->_template_args['GRP_ID'] = $GRP_ID;
1367
-        $this->_template_args['message_template'] = $message_template_group;
1368
-        $this->_template_args['is_extra_fields'] = false;
1369
-
1370
-
1371
-        // let's get EEH_MSG_Template so we can get template form fields
1372
-        $template_field_structure = EEH_MSG_Template::get_fields(
1373
-            $message_template_group->messenger(),
1374
-            $message_template_group->message_type()
1375
-        );
1376
-
1377
-        if (! $template_field_structure) {
1378
-            $template_field_structure = false;
1379
-            $template_fields = esc_html__(
1380
-                'There was an error in assembling the fields for this display (you should see an error message)',
1381
-                'event_espresso'
1382
-            );
1383
-        }
1384
-
1385
-
1386
-        $message_templates = $message_template_group->context_templates();
1387
-
1388
-
1389
-        // if we have the extra key.. then we need to remove the content index from the template_field_structure as it
1390
-        // will get handled in the "extra" array.
1391
-        if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
1392
-            foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
1393
-                unset($template_field_structure[ $context ][ $reference_field ]);
1394
-            }
1395
-        }
1396
-
1397
-        // let's loop through the template_field_structure and actually assemble the input fields!
1398
-        if (! empty($template_field_structure)) {
1399
-            foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
1400
-                // if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
1401
-                // the extra array and reset them.
1402
-                if ($template_field === 'extra') {
1403
-                    $this->_template_args['is_extra_fields'] = true;
1404
-                    foreach ($field_setup_array as $reference_field => $new_fields_array) {
1405
-                        $message_template = $message_templates[ $context ][ $reference_field ];
1406
-                        $content = $message_template instanceof EE_Message_Template
1407
-                            ? $message_template->get('MTP_content')
1408
-                            : '';
1409
-                        foreach ($new_fields_array as $extra_field => $extra_array) {
1410
-                            // let's verify if we need this extra field via the shortcodes parameter.
1411
-                            $continue = false;
1412
-                            if (isset($extra_array['shortcodes_required'])) {
1413
-                                foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
1414
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
1415
-                                        $continue = true;
1416
-                                    }
1417
-                                }
1418
-                                if ($continue) {
1419
-                                    continue;
1420
-                                }
1421
-                            }
1422
-
1423
-                            $field_id = $reference_field
1424
-                                        . '-'
1425
-                                        . $extra_field
1426
-                                        . '-content';
1427
-                            $template_form_fields[ $field_id ] = $extra_array;
1428
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
1429
-                                                                         . $reference_field
1430
-                                                                         . '][content]['
1431
-                                                                         . $extra_field . ']';
1432
-                            $css_class = isset($extra_array['css_class'])
1433
-                                ? $extra_array['css_class']
1434
-                                : '';
1435
-
1436
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1437
-                                                                              && in_array($extra_field, $v_fields, true)
1438
-                                                                              &&
1439
-                                                                              (
1440
-                                                                                  is_array($validators[ $extra_field ])
1441
-                                                                                  && isset($validators[ $extra_field ]['msg'])
1442
-                                                                              )
1443
-                                ? 'validate-error ' . $css_class
1444
-                                : $css_class;
1445
-
1446
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1447
-                                                                          && isset($content[ $extra_field ])
1448
-                                ? $content[ $extra_field ]
1449
-                                : '';
1450
-
1451
-                            // do we have a validation error?  if we do then let's use that value instead
1452
-                            $template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
1453
-                                ? $validators[ $extra_field ]['value']
1454
-                                : $template_form_fields[ $field_id ]['value'];
1455
-
1456
-
1457
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1458
-
1459
-                            // shortcode selector
1460
-                            $field_name_to_use = $extra_field === 'main'
1461
-                                ? 'content'
1462
-                                : $extra_field;
1463
-                            $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1464
-                                $field_name_to_use,
1465
-                                $field_id
1466
-                            );
1467
-
1468
-                            if (isset($extra_array['input']) && $extra_array['input'] === 'wp_editor') {
1469
-                                // we want to decode the entities
1470
-                                $template_form_fields[ $field_id ]['value'] = $template_form_fields[ $field_id ]['value'];
1471
-                            }/**/
1472
-                        }
1473
-                        $templatefield_MTP_id = $reference_field . '-MTP_ID';
1474
-                        $templatefield_templatename_id = $reference_field . '-name';
1475
-
1476
-                        $template_form_fields[ $templatefield_MTP_id ] = array(
1477
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
1478
-                            'label'      => null,
1479
-                            'input'      => 'hidden',
1480
-                            'type'       => 'int',
1481
-                            'required'   => false,
1482
-                            'validation' => false,
1483
-                            'value'      => ! empty($message_templates) ? $message_template->ID() : '',
1484
-                            'css_class'  => '',
1485
-                            'format'     => '%d',
1486
-                            'db-col'     => 'MTP_ID',
1487
-                        );
1488
-
1489
-                        $template_form_fields[ $templatefield_templatename_id ] = array(
1490
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
1491
-                            'label'      => null,
1492
-                            'input'      => 'hidden',
1493
-                            'type'       => 'string',
1494
-                            'required'   => false,
1495
-                            'validation' => true,
1496
-                            'value'      => $reference_field,
1497
-                            'css_class'  => '',
1498
-                            'format'     => '%s',
1499
-                            'db-col'     => 'MTP_template_field',
1500
-                        );
1501
-                    }
1502
-                    continue; // skip the next stuff, we got the necessary fields here for this dataset.
1503
-                } else {
1504
-                    $field_id = $template_field . '-content';
1505
-                    $template_form_fields[ $field_id ] = $field_setup_array;
1506
-                    $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields[' . $template_field . '][content]';
1507
-                    $message_template = isset($message_templates[ $context ][ $template_field ])
1508
-                        ? $message_templates[ $context ][ $template_field ]
1509
-                        : null;
1510
-                    $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1511
-                                                                  && is_array($message_templates[ $context ])
1512
-                                                                  && $message_template instanceof EE_Message_Template
1513
-                        ? $message_template->get('MTP_content')
1514
-                        : '';
1515
-
1516
-                    // do we have a validator error for this field?  if we do then we'll use that value instead
1517
-                    $template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
1518
-                        ? $validators[ $template_field ]['value']
1519
-                        : $template_form_fields[ $field_id ]['value'];
1520
-
1521
-
1522
-                    $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1523
-                    $css_class = isset($field_setup_array['css_class'])
1524
-                        ? $field_setup_array['css_class']
1525
-                        : '';
1526
-                    $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1527
-                                                                      && in_array($template_field, $v_fields, true)
1528
-                                                                      && isset($validators[ $template_field ]['msg'])
1529
-                        ? 'validate-error ' . $css_class
1530
-                        : $css_class;
1531
-
1532
-                    // shortcode selector
1533
-                    $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1534
-                        $template_field,
1535
-                        $field_id
1536
-                    );
1537
-                }
1538
-
1539
-                // k took care of content field(s) now let's take care of others.
1540
-
1541
-                $templatefield_MTP_id = $template_field . '-MTP_ID';
1542
-                $templatefield_field_templatename_id = $template_field . '-name';
1543
-
1544
-                // foreach template field there are actually two form fields created
1545
-                $template_form_fields[ $templatefield_MTP_id ] = array(
1546
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
1547
-                    'label'      => null,
1548
-                    'input'      => 'hidden',
1549
-                    'type'       => 'int',
1550
-                    'required'   => false,
1551
-                    'validation' => true,
1552
-                    'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
1553
-                    'css_class'  => '',
1554
-                    'format'     => '%d',
1555
-                    'db-col'     => 'MTP_ID',
1556
-                );
1557
-
1558
-                $template_form_fields[ $templatefield_field_templatename_id ] = array(
1559
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
1560
-                    'label'      => null,
1561
-                    'input'      => 'hidden',
1562
-                    'type'       => 'string',
1563
-                    'required'   => false,
1564
-                    'validation' => true,
1565
-                    'value'      => $template_field,
1566
-                    'css_class'  => '',
1567
-                    'format'     => '%s',
1568
-                    'db-col'     => 'MTP_template_field',
1569
-                );
1570
-            }
1571
-
1572
-            // add other fields
1573
-            $template_form_fields['ee-msg-current-context'] = array(
1574
-                'name'       => 'MTP_context',
1575
-                'label'      => null,
1576
-                'input'      => 'hidden',
1577
-                'type'       => 'string',
1578
-                'required'   => false,
1579
-                'validation' => true,
1580
-                'value'      => $context,
1581
-                'css_class'  => '',
1582
-                'format'     => '%s',
1583
-                'db-col'     => 'MTP_context',
1584
-            );
1585
-
1586
-            $template_form_fields['ee-msg-grp-id'] = array(
1587
-                'name'       => 'GRP_ID',
1588
-                'label'      => null,
1589
-                'input'      => 'hidden',
1590
-                'type'       => 'int',
1591
-                'required'   => false,
1592
-                'validation' => true,
1593
-                'value'      => $GRP_ID,
1594
-                'css_class'  => '',
1595
-                'format'     => '%d',
1596
-                'db-col'     => 'GRP_ID',
1597
-            );
1598
-
1599
-            $template_form_fields['ee-msg-messenger'] = array(
1600
-                'name'       => 'MTP_messenger',
1601
-                'label'      => null,
1602
-                'input'      => 'hidden',
1603
-                'type'       => 'string',
1604
-                'required'   => false,
1605
-                'validation' => true,
1606
-                'value'      => $message_template_group->messenger(),
1607
-                'css_class'  => '',
1608
-                'format'     => '%s',
1609
-                'db-col'     => 'MTP_messenger',
1610
-            );
1611
-
1612
-            $template_form_fields['ee-msg-message-type'] = array(
1613
-                'name'       => 'MTP_message_type',
1614
-                'label'      => null,
1615
-                'input'      => 'hidden',
1616
-                'type'       => 'string',
1617
-                'required'   => false,
1618
-                'validation' => true,
1619
-                'value'      => $message_template_group->message_type(),
1620
-                'css_class'  => '',
1621
-                'format'     => '%s',
1622
-                'db-col'     => 'MTP_message_type',
1623
-            );
1624
-
1625
-            $sidebar_form_fields['ee-msg-is-global'] = array(
1626
-                'name'       => 'MTP_is_global',
1627
-                'label'      => esc_html__('Global Template', 'event_espresso'),
1628
-                'input'      => 'hidden',
1629
-                'type'       => 'int',
1630
-                'required'   => false,
1631
-                'validation' => true,
1632
-                'value'      => $message_template_group->get('MTP_is_global'),
1633
-                'css_class'  => '',
1634
-                'format'     => '%d',
1635
-                'db-col'     => 'MTP_is_global',
1636
-            );
1637
-
1638
-            $sidebar_form_fields['ee-msg-is-override'] = array(
1639
-                'name'       => 'MTP_is_override',
1640
-                'label'      => esc_html__('Override all custom', 'event_espresso'),
1641
-                'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
1642
-                'type'       => 'int',
1643
-                'required'   => false,
1644
-                'validation' => true,
1645
-                'value'      => $message_template_group->get('MTP_is_override'),
1646
-                'css_class'  => '',
1647
-                'format'     => '%d',
1648
-                'db-col'     => 'MTP_is_override',
1649
-            );
1650
-
1651
-            $sidebar_form_fields['ee-msg-is-active'] = array(
1652
-                'name'       => 'MTP_is_active',
1653
-                'label'      => esc_html__('Active Template', 'event_espresso'),
1654
-                'input'      => 'hidden',
1655
-                'type'       => 'int',
1656
-                'required'   => false,
1657
-                'validation' => true,
1658
-                'value'      => $message_template_group->is_active(),
1659
-                'css_class'  => '',
1660
-                'format'     => '%d',
1661
-                'db-col'     => 'MTP_is_active',
1662
-            );
1663
-
1664
-            $sidebar_form_fields['ee-msg-deleted'] = array(
1665
-                'name'       => 'MTP_deleted',
1666
-                'label'      => null,
1667
-                'input'      => 'hidden',
1668
-                'type'       => 'int',
1669
-                'required'   => false,
1670
-                'validation' => true,
1671
-                'value'      => $message_template_group->get('MTP_deleted'),
1672
-                'css_class'  => '',
1673
-                'format'     => '%d',
1674
-                'db-col'     => 'MTP_deleted',
1675
-            );
1676
-            $sidebar_form_fields['ee-msg-author'] = array(
1677
-                'name'       => 'MTP_user_id',
1678
-                'label'      => esc_html__('Author', 'event_espresso'),
1679
-                'input'      => 'hidden',
1680
-                'type'       => 'int',
1681
-                'required'   => false,
1682
-                'validation' => false,
1683
-                'value'      => $message_template_group->user(),
1684
-                'format'     => '%d',
1685
-                'db-col'     => 'MTP_user_id',
1686
-            );
1687
-
1688
-            $sidebar_form_fields['ee-msg-route'] = array(
1689
-                'name'  => 'action',
1690
-                'input' => 'hidden',
1691
-                'type'  => 'string',
1692
-                'value' => $action,
1693
-            );
1694
-
1695
-            $sidebar_form_fields['ee-msg-id'] = array(
1696
-                'name'  => 'id',
1697
-                'input' => 'hidden',
1698
-                'type'  => 'int',
1699
-                'value' => $GRP_ID,
1700
-            );
1701
-            $sidebar_form_fields['ee-msg-evt-nonce'] = array(
1702
-                'name'  => $action . '_nonce',
1703
-                'input' => 'hidden',
1704
-                'type'  => 'string',
1705
-                'value' => wp_create_nonce($action . '_nonce'),
1706
-            );
1707
-
1708
-            if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
1709
-                $sidebar_form_fields['ee-msg-template-switch'] = array(
1710
-                    'name'  => 'template_switch',
1711
-                    'input' => 'hidden',
1712
-                    'type'  => 'int',
1713
-                    'value' => 1,
1714
-                );
1715
-            }
1716
-
1717
-
1718
-            $template_fields = $this->_generate_admin_form_fields($template_form_fields);
1719
-            $sidebar_fields = $this->_generate_admin_form_fields($sidebar_form_fields);
1720
-        } //end if ( !empty($template_field_structure) )
1721
-
1722
-        // set extra content for publish box
1723
-        $this->_template_args['publish_box_extra_content'] = $sidebar_fields;
1724
-        $this->_set_publish_post_box_vars(
1725
-            'id',
1726
-            $GRP_ID,
1727
-            false,
1728
-            add_query_arg(
1729
-                array('action' => 'global_mtps'),
1730
-                $this->_admin_base_url
1731
-            )
1732
-        );
1733
-
1734
-        // add preview button
1735
-        $preview_url = parent::add_query_args_and_nonce(
1736
-            array(
1737
-                'message_type' => $message_template_group->message_type(),
1738
-                'messenger'    => $message_template_group->messenger(),
1739
-                'context'      => $context,
1740
-                'GRP_ID'       => $GRP_ID,
1741
-                'evt_id'       => $EVT_ID,
1742
-                'action'       => 'preview_message',
1743
-            ),
1744
-            $this->_admin_base_url
1745
-        );
1746
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
1747
-                          . esc_html__('Preview', 'event_espresso')
1748
-                          . '</a>';
1749
-
1750
-
1751
-        // setup context switcher
1752
-        $context_switcher_args = array(
1753
-            'page'    => 'espresso_messages',
1754
-            'action'  => 'edit_message_template',
1755
-            'id'      => $GRP_ID,
1756
-            'evt_id'  => $EVT_ID,
1757
-            'context' => $context,
1758
-            'extra'   => $preview_button,
1759
-        );
1760
-        $this->_set_context_switcher($message_template_group, $context_switcher_args);
1761
-
1762
-
1763
-        // main box
1764
-        $this->_template_args['template_fields'] = $template_fields;
1765
-        $this->_template_args['sidebar_box_id'] = 'details';
1766
-        $this->_template_args['action'] = $action;
1767
-        $this->_template_args['context'] = $context;
1768
-        $this->_template_args['edit_message_template_form_url'] = $edit_message_template_form_url;
1769
-        $this->_template_args['learn_more_about_message_templates_link'] =
1770
-            $this->_learn_more_about_message_templates_link();
1771
-
1772
-
1773
-        $this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
1774
-        $this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
1775
-            $message_template_group,
1776
-            $context,
1777
-            $context_label
1778
-        );
1779
-        $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
1780
-        $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
1781
-
1782
-        $this->_template_path = $this->_template_args['GRP_ID']
1783
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
1784
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
1785
-
1786
-        // send along EE_Message_Template_Group object for further template use.
1787
-        $this->_template_args['MTP'] = $message_template_group;
1788
-
1789
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
1790
-            $this->_template_path,
1791
-            $this->_template_args,
1792
-            true
1793
-        );
1794
-
1795
-
1796
-        // finally, let's set the admin_page title
1797
-        $this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
1798
-
1799
-
1800
-        // we need to take care of setting the shortcodes property for use elsewhere.
1801
-        $this->_set_shortcodes();
1802
-
1803
-
1804
-        // final template wrapper
1805
-        $this->display_admin_page_with_sidebar();
1806
-    }
1807
-
1808
-
1809
-    public function filter_tinymce_init($mceInit, $editor_id)
1810
-    {
1811
-        return $mceInit;
1812
-    }
1813
-
1814
-
1815
-    public function add_context_switcher()
1816
-    {
1817
-        return $this->_context_switcher;
1818
-    }
1819
-
1820
-
1821
-    /**
1822
-     * Adds the activation/deactivation toggle for the message template context.
1823
-     *
1824
-     * @param EE_Message_Template_Group $message_template_group
1825
-     * @param string                    $context
1826
-     * @param string                    $context_label
1827
-     * @return string
1828
-     * @throws DomainException
1829
-     * @throws EE_Error
1830
-     * @throws InvalidIdentifierException
1831
-     */
1832
-    protected function add_active_context_element(
1833
-        EE_Message_Template_Group $message_template_group,
1834
-        $context,
1835
-        $context_label
1836
-    ) {
1837
-        $template_args = array(
1838
-            'context'                   => $context,
1839
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
1840
-            'is_active'                 => $message_template_group->is_context_active($context),
1841
-            'on_off_action'             => $message_template_group->is_context_active($context)
1842
-                ? 'context-off'
1843
-                : 'context-on',
1844
-            'context_label'             => str_replace(array('(', ')'), '', $context_label),
1845
-            'message_template_group_id' => $message_template_group->ID(),
1846
-        );
1847
-        return EEH_Template::display_template(
1848
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
1849
-            $template_args,
1850
-            true
1851
-        );
1852
-    }
1853
-
1854
-
1855
-    /**
1856
-     * Ajax callback for `toggle_context_template` ajax action.
1857
-     * Handles toggling the message context on or off.
1858
-     *
1859
-     * @throws EE_Error
1860
-     * @throws InvalidArgumentException
1861
-     * @throws InvalidDataTypeException
1862
-     * @throws InvalidIdentifierException
1863
-     * @throws InvalidInterfaceException
1864
-     */
1865
-    public function toggle_context_template()
1866
-    {
1867
-        $success = true;
1868
-        // check for required data
1869
-        if (! isset(
1870
-            $this->_req_data['message_template_group_id'],
1871
-            $this->_req_data['context'],
1872
-            $this->_req_data['status']
1873
-        )) {
1874
-            EE_Error::add_error(
1875
-                esc_html__('Required data for doing this action is not available.', 'event_espresso'),
1876
-                __FILE__,
1877
-                __FUNCTION__,
1878
-                __LINE__
1879
-            );
1880
-            $success = false;
1881
-        }
1882
-
1883
-        $nonce = isset($this->_req_data['toggle_context_nonce'])
1884
-            ? sanitize_text_field($this->_req_data['toggle_context_nonce'])
1885
-            : '';
1886
-        $nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
1887
-        $this->_verify_nonce($nonce, $nonce_ref);
1888
-        $status = $this->_req_data['status'];
1889
-        if ($status !== 'off' && $status !== 'on') {
1890
-            EE_Error::add_error(
1891
-                sprintf(
1892
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
1893
-                    $this->_req_data['status']
1894
-                ),
1895
-                __FILE__,
1896
-                __FUNCTION__,
1897
-                __LINE__
1898
-            );
1899
-            $success = false;
1900
-        }
1901
-        $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
1902
-            $this->_req_data['message_template_group_id']
1903
-        );
1904
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
1905
-            EE_Error::add_error(
1906
-                sprintf(
1907
-                    esc_html__(
1908
-                        'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
1909
-                        'event_espresso'
1910
-                    ),
1911
-                    $this->_req_data['message_template_group_id'],
1912
-                    'EE_Message_Template_Group'
1913
-                ),
1914
-                __FILE__,
1915
-                __FUNCTION__,
1916
-                __LINE__
1917
-            );
1918
-            $success = false;
1919
-        }
1920
-        if ($success) {
1921
-            $success = $status === 'off'
1922
-                ? $message_template_group->deactivate_context($this->_req_data['context'])
1923
-                : $message_template_group->activate_context($this->_req_data['context']);
1924
-        }
1925
-        $this->_template_args['success'] = $success;
1926
-        $this->_return_json();
1927
-    }
1928
-
1929
-
1930
-    public function _add_form_element_before()
1931
-    {
1932
-        return '<form method="post" action="'
1933
-               . $this->_template_args["edit_message_template_form_url"]
1934
-               . '" id="ee-msg-edit-frm">';
1935
-    }
1936
-
1937
-    public function _add_form_element_after()
1938
-    {
1939
-        return '</form>';
1940
-    }
1941
-
1942
-
1943
-    /**
1944
-     * This executes switching the template pack for a message template.
1945
-     *
1946
-     * @since 4.5.0
1947
-     * @throws EE_Error
1948
-     * @throws InvalidDataTypeException
1949
-     * @throws InvalidInterfaceException
1950
-     * @throws InvalidArgumentException
1951
-     * @throws ReflectionException
1952
-     */
1953
-    public function switch_template_pack()
1954
-    {
1955
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
1956
-        $template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
1957
-
1958
-        // verify we have needed values.
1959
-        if (empty($GRP_ID) || empty($template_pack)) {
1960
-            $this->_template_args['error'] = true;
1961
-            EE_Error::add_error(
1962
-                esc_html__('The required date for switching templates is not available.', 'event_espresso'),
1963
-                __FILE__,
1964
-                __FUNCTION__,
1965
-                __LINE__
1966
-            );
1967
-        } else {
1968
-            // get template, set the new template_pack and then reset to default
1969
-            /** @type EE_Message_Template_Group $message_template_group */
1970
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
1971
-
1972
-            $message_template_group->set_template_pack_name($template_pack);
1973
-            $this->_req_data['msgr'] = $message_template_group->messenger();
1974
-            $this->_req_data['mt'] = $message_template_group->message_type();
1975
-
1976
-            $query_args = $this->_reset_to_default_template();
1977
-
1978
-            if (empty($query_args['id'])) {
1979
-                EE_Error::add_error(
1980
-                    esc_html__(
1981
-                        'Something went wrong with switching the template pack. Please try again or contact EE support',
1982
-                        'event_espresso'
1983
-                    ),
1984
-                    __FILE__,
1985
-                    __FUNCTION__,
1986
-                    __LINE__
1987
-                );
1988
-                $this->_template_args['error'] = true;
1989
-            } else {
1990
-                $template_label = $message_template_group->get_template_pack()->label;
1991
-                $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
1992
-                EE_Error::add_success(
1993
-                    sprintf(
1994
-                        esc_html__(
1995
-                            'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
1996
-                            'event_espresso'
1997
-                        ),
1998
-                        $template_label,
1999
-                        $template_pack_labels->template_pack
2000
-                    )
2001
-                );
2002
-                // generate the redirect url for js.
2003
-                $url = self::add_query_args_and_nonce(
2004
-                    $query_args,
2005
-                    $this->_admin_base_url
2006
-                );
2007
-                $this->_template_args['data']['redirect_url'] = $url;
2008
-                $this->_template_args['success'] = true;
2009
-            }
2010
-
2011
-            $this->_return_json();
2012
-        }
2013
-    }
2014
-
2015
-
2016
-    /**
2017
-     * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
2018
-     * they want.
2019
-     *
2020
-     * @access protected
2021
-     * @return array|null
2022
-     * @throws EE_Error
2023
-     * @throws InvalidArgumentException
2024
-     * @throws InvalidDataTypeException
2025
-     * @throws InvalidInterfaceException
2026
-     */
2027
-    protected function _reset_to_default_template()
2028
-    {
2029
-
2030
-        $templates = array();
2031
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2032
-        // we need to make sure we've got the info we need.
2033
-        if (! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
2034
-            EE_Error::add_error(
2035
-                esc_html__(
2036
-                    'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
2037
-                    'event_espresso'
2038
-                ),
2039
-                __FILE__,
2040
-                __FUNCTION__,
2041
-                __LINE__
2042
-            );
2043
-        }
2044
-
2045
-        // all templates will be reset to whatever the defaults are
2046
-        // for the global template matching the messenger and message type.
2047
-        $success = ! empty($GRP_ID) ? true : false;
2048
-
2049
-        if ($success) {
2050
-            // let's first determine if the incoming template is a global template,
2051
-            // if it isn't then we need to get the global template matching messenger and message type.
2052
-            // $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
2053
-
2054
-
2055
-            // note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
2056
-            $success = $this->_delete_mtp_permanently($GRP_ID, false);
2057
-
2058
-            if ($success) {
2059
-                // if successfully deleted, lets generate the new ones.
2060
-                // Note. We set GLOBAL to true, because resets on ANY template
2061
-                // will use the related global template defaults for regeneration.
2062
-                // This means that if a custom template is reset it resets to whatever the related global template is.
2063
-                // HOWEVER, we DO keep the template pack and template variation set
2064
-                // for the current custom template when resetting.
2065
-                $templates = $this->_generate_new_templates(
2066
-                    $this->_req_data['msgr'],
2067
-                    $this->_req_data['mt'],
2068
-                    $GRP_ID,
2069
-                    true
2070
-                );
2071
-            }
2072
-        }
2073
-
2074
-        // any error messages?
2075
-        if (! $success) {
2076
-            EE_Error::add_error(
2077
-                esc_html__(
2078
-                    'Something went wrong with deleting existing templates. Unable to reset to default',
2079
-                    'event_espresso'
2080
-                ),
2081
-                __FILE__,
2082
-                __FUNCTION__,
2083
-                __LINE__
2084
-            );
2085
-        }
2086
-
2087
-        // all good, let's add a success message!
2088
-        if ($success && ! empty($templates)) {
2089
-            // the info for the template we generated is the first element in the returned array
2090
-            // $templates = $templates[0];
2091
-            EE_Error::overwrite_success();
2092
-            EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
2093
-        }
2094
-
2095
-
2096
-        $query_args = array(
2097
-            'id'      => isset($templates[0]['GRP_ID']) ? $templates[0]['GRP_ID'] : null,
2098
-            'context' => isset($templates[0]['MTP_context']) ? $templates[0]['MTP_context'] : null,
2099
-            'action'  => isset($templates[0]['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
2100
-        );
2101
-
2102
-        // if called via ajax then we return query args otherwise redirect
2103
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2104
-            return $query_args;
2105
-        } else {
2106
-            $this->_redirect_after_action(false, '', '', $query_args, true);
2107
-
2108
-            return null;
2109
-        }
2110
-    }
2111
-
2112
-
2113
-    /**
2114
-     * Retrieve and set the message preview for display.
2115
-     *
2116
-     * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
2117
-     * @return string
2118
-     * @throws ReflectionException
2119
-     * @throws EE_Error
2120
-     * @throws InvalidArgumentException
2121
-     * @throws InvalidDataTypeException
2122
-     * @throws InvalidInterfaceException
2123
-     */
2124
-    public function _preview_message($send = false)
2125
-    {
2126
-        // first make sure we've got the necessary parameters
2127
-        if (! isset(
2128
-            $this->_req_data['message_type'],
2129
-            $this->_req_data['messenger'],
2130
-            $this->_req_data['messenger'],
2131
-            $this->_req_data['GRP_ID']
2132
-        )) {
2133
-            EE_Error::add_error(
2134
-                esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
2135
-                __FILE__,
2136
-                __FUNCTION__,
2137
-                __LINE__
2138
-            );
2139
-        }
2140
-
2141
-        EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
22
+	/**
23
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
24
+	 */
25
+	protected $_message_resource_manager;
26
+
27
+	/**
28
+	 * @type string $_active_message_type_name
29
+	 */
30
+	protected $_active_message_type_name = '';
31
+
32
+	/**
33
+	 * @type EE_messenger $_active_messenger
34
+	 */
35
+	protected $_active_messenger;
36
+	protected $_activate_state;
37
+	protected $_activate_meta_box_type;
38
+	protected $_current_message_meta_box;
39
+	protected $_current_message_meta_box_object;
40
+	protected $_context_switcher;
41
+	protected $_shortcodes = array();
42
+	protected $_active_messengers = array();
43
+	protected $_active_message_types = array();
44
+
45
+	/**
46
+	 * @var EE_Message_Template_Group $_message_template_group
47
+	 */
48
+	protected $_message_template_group;
49
+	protected $_m_mt_settings = array();
50
+
51
+
52
+	/**
53
+	 * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
54
+	 * IF there is no group then it gets automatically set to the Default template pack.
55
+	 *
56
+	 * @since 4.5.0
57
+	 *
58
+	 * @var EE_Messages_Template_Pack
59
+	 */
60
+	protected $_template_pack;
61
+
62
+
63
+	/**
64
+	 * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
65
+	 * group is.  If there is no group then it automatically gets set to default.
66
+	 *
67
+	 * @since 4.5.0
68
+	 *
69
+	 * @var string
70
+	 */
71
+	protected $_variation;
72
+
73
+
74
+	/**
75
+	 * @param bool $routing
76
+	 * @throws EE_Error
77
+	 */
78
+	public function __construct($routing = true)
79
+	{
80
+		// make sure messages autoloader is running
81
+		EED_Messages::set_autoloaders();
82
+		parent::__construct($routing);
83
+	}
84
+
85
+
86
+	protected function _init_page_props()
87
+	{
88
+		$this->page_slug = EE_MSG_PG_SLUG;
89
+		$this->page_label = esc_html__('Messages Settings', 'event_espresso');
90
+		$this->_admin_base_url = EE_MSG_ADMIN_URL;
91
+		$this->_admin_base_path = EE_MSG_ADMIN;
92
+
93
+		$this->_activate_state = isset($this->_req_data['activate_state']) ? (array) $this->_req_data['activate_state']
94
+			: array();
95
+
96
+		$this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
97
+		$this->_load_message_resource_manager();
98
+	}
99
+
100
+
101
+	/**
102
+	 * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
103
+	 *
104
+	 * @throws EE_Error
105
+	 * @throws InvalidDataTypeException
106
+	 * @throws InvalidInterfaceException
107
+	 * @throws InvalidArgumentException
108
+	 * @throws ReflectionException
109
+	 */
110
+	protected function _load_message_resource_manager()
111
+	{
112
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
113
+	}
114
+
115
+
116
+	/**
117
+	 * @deprecated 4.9.9.rc.014
118
+	 * @return array
119
+	 * @throws EE_Error
120
+	 * @throws InvalidArgumentException
121
+	 * @throws InvalidDataTypeException
122
+	 * @throws InvalidInterfaceException
123
+	 */
124
+	public function get_messengers_for_list_table()
125
+	{
126
+		EE_Error::doing_it_wrong(
127
+			__METHOD__,
128
+			sprintf(
129
+				esc_html__(
130
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a messenger filter dropdown which is now generated differently via %s',
131
+					'event_espresso'
132
+				),
133
+				'Messages_Admin_Page::get_messengers_select_input()'
134
+			),
135
+			'4.9.9.rc.014'
136
+		);
137
+
138
+		$m_values = array();
139
+		$active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
140
+		// setup messengers for selects
141
+		$i = 1;
142
+		foreach ($active_messengers as $active_messenger) {
143
+			if ($active_messenger instanceof EE_Message) {
144
+				$m_values[ $i ]['id'] = $active_messenger->messenger();
145
+				$m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
146
+				$i++;
147
+			}
148
+		}
149
+
150
+		return $m_values;
151
+	}
152
+
153
+
154
+	/**
155
+	 * @deprecated 4.9.9.rc.014
156
+	 * @return array
157
+	 * @throws EE_Error
158
+	 * @throws InvalidArgumentException
159
+	 * @throws InvalidDataTypeException
160
+	 * @throws InvalidInterfaceException
161
+	 */
162
+	public function get_message_types_for_list_table()
163
+	{
164
+		EE_Error::doing_it_wrong(
165
+			__METHOD__,
166
+			sprintf(
167
+				esc_html__(
168
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type filter dropdown which is now generated differently via %s',
169
+					'event_espresso'
170
+				),
171
+				'Messages_Admin_Page::get_message_types_select_input()'
172
+			),
173
+			'4.9.9.rc.014'
174
+		);
175
+
176
+		$mt_values = array();
177
+		$active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
178
+		$i = 1;
179
+		foreach ($active_messages as $active_message) {
180
+			if ($active_message instanceof EE_Message) {
181
+				$mt_values[ $i ]['id'] = $active_message->message_type();
182
+				$mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
183
+				$i++;
184
+			}
185
+		}
186
+
187
+		return $mt_values;
188
+	}
189
+
190
+
191
+	/**
192
+	 * @deprecated 4.9.9.rc.014
193
+	 * @return array
194
+	 * @throws EE_Error
195
+	 * @throws InvalidArgumentException
196
+	 * @throws InvalidDataTypeException
197
+	 * @throws InvalidInterfaceException
198
+	 */
199
+	public function get_contexts_for_message_types_for_list_table()
200
+	{
201
+		EE_Error::doing_it_wrong(
202
+			__METHOD__,
203
+			sprintf(
204
+				esc_html__(
205
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type context filter dropdown which is now generated differently via %s',
206
+					'event_espresso'
207
+				),
208
+				'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
209
+			),
210
+			'4.9.9.rc.014'
211
+		);
212
+
213
+		$contexts = array();
214
+		$active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
215
+		foreach ($active_message_contexts as $active_message) {
216
+			if ($active_message instanceof EE_Message) {
217
+				$message_type = $active_message->message_type_object();
218
+				if ($message_type instanceof EE_message_type) {
219
+					$message_type_contexts = $message_type->get_contexts();
220
+					foreach ($message_type_contexts as $context => $context_details) {
221
+						$contexts[ $context ] = $context_details['label'];
222
+					}
223
+				}
224
+			}
225
+		}
226
+
227
+		return $contexts;
228
+	}
229
+
230
+
231
+	/**
232
+	 * Generate select input with provided messenger options array.
233
+	 *
234
+	 * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
235
+	 *                                 labels.
236
+	 * @return string
237
+	 * @throws EE_Error
238
+	 */
239
+	public function get_messengers_select_input($messenger_options)
240
+	{
241
+		// if empty or just one value then just return an empty string
242
+		if (empty($messenger_options)
243
+			|| ! is_array($messenger_options)
244
+			|| count($messenger_options) === 1
245
+		) {
246
+			return '';
247
+		}
248
+		// merge in default
249
+		$messenger_options = array_merge(
250
+			array('none_selected' => esc_html__('Show All Messengers', 'event_espresso')),
251
+			$messenger_options
252
+		);
253
+		$input = new EE_Select_Input(
254
+			$messenger_options,
255
+			array(
256
+				'html_name'  => 'ee_messenger_filter_by',
257
+				'html_id'    => 'ee_messenger_filter_by',
258
+				'html_class' => 'wide',
259
+				'default'    => isset($this->_req_data['ee_messenger_filter_by'])
260
+					? sanitize_title($this->_req_data['ee_messenger_filter_by'])
261
+					: 'none_selected',
262
+			)
263
+		);
264
+
265
+		return $input->get_html_for_input();
266
+	}
267
+
268
+
269
+	/**
270
+	 * Generate select input with provided message type options array.
271
+	 *
272
+	 * @param array $message_type_options Array of message types indexed by message type slug, and values are the
273
+	 *                                    message type labels
274
+	 * @return string
275
+	 * @throws EE_Error
276
+	 */
277
+	public function get_message_types_select_input($message_type_options)
278
+	{
279
+		// if empty or count of options is 1 then just return an empty string
280
+		if (empty($message_type_options)
281
+			|| ! is_array($message_type_options)
282
+			|| count($message_type_options) === 1
283
+		) {
284
+			return '';
285
+		}
286
+		// merge in default
287
+		$message_type_options = array_merge(
288
+			array('none_selected' => esc_html__('Show All Message Types', 'event_espresso')),
289
+			$message_type_options
290
+		);
291
+		$input = new EE_Select_Input(
292
+			$message_type_options,
293
+			array(
294
+				'html_name'  => 'ee_message_type_filter_by',
295
+				'html_id'    => 'ee_message_type_filter_by',
296
+				'html_class' => 'wide',
297
+				'default'    => isset($this->_req_data['ee_message_type_filter_by'])
298
+					? sanitize_title($this->_req_data['ee_message_type_filter_by'])
299
+					: 'none_selected',
300
+			)
301
+		);
302
+
303
+		return $input->get_html_for_input();
304
+	}
305
+
306
+
307
+	/**
308
+	 * Generate select input with provide message type contexts array.
309
+	 *
310
+	 * @param array $context_options Array of message type contexts indexed by context slug, and values are the
311
+	 *                               context label.
312
+	 * @return string
313
+	 * @throws EE_Error
314
+	 */
315
+	public function get_contexts_for_message_types_select_input($context_options)
316
+	{
317
+		// if empty or count of options is one then just return empty string
318
+		if (empty($context_options)
319
+			|| ! is_array($context_options)
320
+			|| count($context_options) === 1
321
+		) {
322
+			return '';
323
+		}
324
+		// merge in default
325
+		$context_options = array_merge(
326
+			array('none_selected' => esc_html__('Show all Contexts', 'event_espresso')),
327
+			$context_options
328
+		);
329
+		$input = new EE_Select_Input(
330
+			$context_options,
331
+			array(
332
+				'html_name'  => 'ee_context_filter_by',
333
+				'html_id'    => 'ee_context_filter_by',
334
+				'html_class' => 'wide',
335
+				'default'    => isset($this->_req_data['ee_context_filter_by'])
336
+					? sanitize_title($this->_req_data['ee_context_filter_by'])
337
+					: 'none_selected',
338
+			)
339
+		);
340
+
341
+		return $input->get_html_for_input();
342
+	}
343
+
344
+
345
+	protected function _ajax_hooks()
346
+	{
347
+		add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
348
+		add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
349
+		add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
350
+		add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
351
+		add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
352
+		add_action('wp_ajax_toggle_context_template', array($this, 'toggle_context_template'));
353
+	}
354
+
355
+
356
+	protected function _define_page_props()
357
+	{
358
+		$this->_admin_page_title = $this->page_label;
359
+		$this->_labels = array(
360
+			'buttons'    => array(
361
+				'add'    => esc_html__('Add New Message Template', 'event_espresso'),
362
+				'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
363
+				'delete' => esc_html__('Delete Message Template', 'event_espresso'),
364
+			),
365
+			'publishbox' => esc_html__('Update Actions', 'event_espresso'),
366
+		);
367
+	}
368
+
369
+
370
+	/**
371
+	 *        an array for storing key => value pairs of request actions and their corresponding methods
372
+	 *
373
+	 * @access protected
374
+	 * @return void
375
+	 */
376
+	protected function _set_page_routes()
377
+	{
378
+		$grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
379
+			? $this->_req_data['GRP_ID']
380
+			: 0;
381
+		$grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
382
+			? $this->_req_data['id']
383
+			: $grp_id;
384
+		$msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
385
+			? $this->_req_data['MSG_ID']
386
+			: 0;
387
+
388
+		$this->_page_routes = array(
389
+			'default'                          => array(
390
+				'func'       => '_message_queue_list_table',
391
+				'capability' => 'ee_read_global_messages',
392
+			),
393
+			'global_mtps'                      => array(
394
+				'func'       => '_ee_default_messages_overview_list_table',
395
+				'capability' => 'ee_read_global_messages',
396
+			),
397
+			'custom_mtps'                      => array(
398
+				'func'       => '_custom_mtps_preview',
399
+				'capability' => 'ee_read_messages',
400
+			),
401
+			'add_new_message_template'         => array(
402
+				'func'       => '_add_message_template',
403
+				'capability' => 'ee_edit_messages',
404
+				'noheader'   => true,
405
+			),
406
+			'edit_message_template'            => array(
407
+				'func'       => '_edit_message_template',
408
+				'capability' => 'ee_edit_message',
409
+				'obj_id'     => $grp_id,
410
+			),
411
+			'preview_message'                  => array(
412
+				'func'               => '_preview_message',
413
+				'capability'         => 'ee_read_message',
414
+				'obj_id'             => $grp_id,
415
+				'noheader'           => true,
416
+				'headers_sent_route' => 'display_preview_message',
417
+			),
418
+			'display_preview_message'          => array(
419
+				'func'       => '_display_preview_message',
420
+				'capability' => 'ee_read_message',
421
+				'obj_id'     => $grp_id,
422
+			),
423
+			'insert_message_template'          => array(
424
+				'func'       => '_insert_or_update_message_template',
425
+				'capability' => 'ee_edit_messages',
426
+				'args'       => array('new_template' => true),
427
+				'noheader'   => true,
428
+			),
429
+			'update_message_template'          => array(
430
+				'func'       => '_insert_or_update_message_template',
431
+				'capability' => 'ee_edit_message',
432
+				'obj_id'     => $grp_id,
433
+				'args'       => array('new_template' => false),
434
+				'noheader'   => true,
435
+			),
436
+			'trash_message_template'           => array(
437
+				'func'       => '_trash_or_restore_message_template',
438
+				'capability' => 'ee_delete_message',
439
+				'obj_id'     => $grp_id,
440
+				'args'       => array('trash' => true, 'all' => true),
441
+				'noheader'   => true,
442
+			),
443
+			'trash_message_template_context'   => array(
444
+				'func'       => '_trash_or_restore_message_template',
445
+				'capability' => 'ee_delete_message',
446
+				'obj_id'     => $grp_id,
447
+				'args'       => array('trash' => true),
448
+				'noheader'   => true,
449
+			),
450
+			'restore_message_template'         => array(
451
+				'func'       => '_trash_or_restore_message_template',
452
+				'capability' => 'ee_delete_message',
453
+				'obj_id'     => $grp_id,
454
+				'args'       => array('trash' => false, 'all' => true),
455
+				'noheader'   => true,
456
+			),
457
+			'restore_message_template_context' => array(
458
+				'func'       => '_trash_or_restore_message_template',
459
+				'capability' => 'ee_delete_message',
460
+				'obj_id'     => $grp_id,
461
+				'args'       => array('trash' => false),
462
+				'noheader'   => true,
463
+			),
464
+			'delete_message_template'          => array(
465
+				'func'       => '_delete_message_template',
466
+				'capability' => 'ee_delete_message',
467
+				'obj_id'     => $grp_id,
468
+				'noheader'   => true,
469
+			),
470
+			'reset_to_default'                 => array(
471
+				'func'       => '_reset_to_default_template',
472
+				'capability' => 'ee_edit_message',
473
+				'obj_id'     => $grp_id,
474
+				'noheader'   => true,
475
+			),
476
+			'settings'                         => array(
477
+				'func'       => '_settings',
478
+				'capability' => 'manage_options',
479
+			),
480
+			'update_global_settings'           => array(
481
+				'func'       => '_update_global_settings',
482
+				'capability' => 'manage_options',
483
+				'noheader'   => true,
484
+			),
485
+			'generate_now'                     => array(
486
+				'func'       => '_generate_now',
487
+				'capability' => 'ee_send_message',
488
+				'noheader'   => true,
489
+			),
490
+			'generate_and_send_now'            => array(
491
+				'func'       => '_generate_and_send_now',
492
+				'capability' => 'ee_send_message',
493
+				'noheader'   => true,
494
+			),
495
+			'queue_for_resending'              => array(
496
+				'func'       => '_queue_for_resending',
497
+				'capability' => 'ee_send_message',
498
+				'noheader'   => true,
499
+			),
500
+			'send_now'                         => array(
501
+				'func'       => '_send_now',
502
+				'capability' => 'ee_send_message',
503
+				'noheader'   => true,
504
+			),
505
+			'delete_ee_message'                => array(
506
+				'func'       => '_delete_ee_messages',
507
+				'capability' => 'ee_delete_messages',
508
+				'noheader'   => true,
509
+			),
510
+			'delete_ee_messages'               => array(
511
+				'func'       => '_delete_ee_messages',
512
+				'capability' => 'ee_delete_messages',
513
+				'noheader'   => true,
514
+				'obj_id'     => $msg_id,
515
+			),
516
+		);
517
+	}
518
+
519
+
520
+	protected function _set_page_config()
521
+	{
522
+		$this->_page_config = array(
523
+			'default'                  => array(
524
+				'nav'           => array(
525
+					'label' => esc_html__('Message Activity', 'event_espresso'),
526
+					'order' => 10,
527
+				),
528
+				'list_table'    => 'EE_Message_List_Table',
529
+				// 'qtips' => array( 'EE_Message_List_Table_Tips' ),
530
+				'require_nonce' => false,
531
+			),
532
+			'global_mtps'              => array(
533
+				'nav'           => array(
534
+					'label' => esc_html__('Default Message Templates', 'event_espresso'),
535
+					'order' => 20,
536
+				),
537
+				'list_table'    => 'Messages_Template_List_Table',
538
+				'help_tabs'     => array(
539
+					'messages_overview_help_tab'                                => array(
540
+						'title'    => esc_html__('Messages Overview', 'event_espresso'),
541
+						'filename' => 'messages_overview',
542
+					),
543
+					'messages_overview_messages_table_column_headings_help_tab' => array(
544
+						'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
545
+						'filename' => 'messages_overview_table_column_headings',
546
+					),
547
+					'messages_overview_messages_filters_help_tab'               => array(
548
+						'title'    => esc_html__('Message Filters', 'event_espresso'),
549
+						'filename' => 'messages_overview_filters',
550
+					),
551
+					'messages_overview_messages_views_help_tab'                 => array(
552
+						'title'    => esc_html__('Message Views', 'event_espresso'),
553
+						'filename' => 'messages_overview_views',
554
+					),
555
+					'message_overview_message_types_help_tab'                   => array(
556
+						'title'    => esc_html__('Message Types', 'event_espresso'),
557
+						'filename' => 'messages_overview_types',
558
+					),
559
+					'messages_overview_messengers_help_tab'                     => array(
560
+						'title'    => esc_html__('Messengers', 'event_espresso'),
561
+						'filename' => 'messages_overview_messengers',
562
+					),
563
+				),
564
+				'help_tour'     => array('Messages_Overview_Help_Tour'),
565
+				'require_nonce' => false,
566
+			),
567
+			'custom_mtps'              => array(
568
+				'nav'           => array(
569
+					'label' => esc_html__('Custom Message Templates', 'event_espresso'),
570
+					'order' => 30,
571
+				),
572
+				'help_tabs'     => array(),
573
+				'help_tour'     => array(),
574
+				'require_nonce' => false,
575
+			),
576
+			'add_new_message_template' => array(
577
+				'nav'           => array(
578
+					'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
579
+					'order'      => 5,
580
+					'persistent' => false,
581
+				),
582
+				'require_nonce' => false,
583
+			),
584
+			'edit_message_template'    => array(
585
+				'labels'        => array(
586
+					'buttons'    => array(
587
+						'reset' => esc_html__('Reset Templates', 'event_espresso'),
588
+					),
589
+					'publishbox' => esc_html__('Update Actions', 'event_espresso'),
590
+				),
591
+				'nav'           => array(
592
+					'label'      => esc_html__('Edit Message Templates', 'event_espresso'),
593
+					'order'      => 5,
594
+					'persistent' => false,
595
+					'url'        => '',
596
+				),
597
+				'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
598
+				'has_metaboxes' => true,
599
+				'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
600
+				'help_tabs'     => array(
601
+					'edit_message_template'            => array(
602
+						'title'    => esc_html__('Message Template Editor', 'event_espresso'),
603
+						'callback' => 'edit_message_template_help_tab',
604
+					),
605
+					'message_templates_help_tab'       => array(
606
+						'title'    => esc_html__('Message Templates', 'event_espresso'),
607
+						'filename' => 'messages_templates',
608
+					),
609
+					'message_template_shortcodes'      => array(
610
+						'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
611
+						'callback' => 'message_template_shortcodes_help_tab',
612
+					),
613
+					'message_preview_help_tab'         => array(
614
+						'title'    => esc_html__('Message Preview', 'event_espresso'),
615
+						'filename' => 'messages_preview',
616
+					),
617
+					'messages_overview_other_help_tab' => array(
618
+						'title'    => esc_html__('Messages Other', 'event_espresso'),
619
+						'filename' => 'messages_overview_other',
620
+					),
621
+				),
622
+				'require_nonce' => false,
623
+			),
624
+			'display_preview_message'  => array(
625
+				'nav'           => array(
626
+					'label'      => esc_html__('Message Preview', 'event_espresso'),
627
+					'order'      => 5,
628
+					'url'        => '',
629
+					'persistent' => false,
630
+				),
631
+				'help_tabs'     => array(
632
+					'preview_message' => array(
633
+						'title'    => esc_html__('About Previews', 'event_espresso'),
634
+						'callback' => 'preview_message_help_tab',
635
+					),
636
+				),
637
+				'require_nonce' => false,
638
+			),
639
+			'settings'                 => array(
640
+				'nav'           => array(
641
+					'label' => esc_html__('Settings', 'event_espresso'),
642
+					'order' => 40,
643
+				),
644
+				'metaboxes'     => array('_messages_settings_metaboxes'),
645
+				'help_tabs'     => array(
646
+					'messages_settings_help_tab'               => array(
647
+						'title'    => esc_html__('Messages Settings', 'event_espresso'),
648
+						'filename' => 'messages_settings',
649
+					),
650
+					'messages_settings_message_types_help_tab' => array(
651
+						'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
652
+						'filename' => 'messages_settings_message_types',
653
+					),
654
+					'messages_settings_messengers_help_tab'    => array(
655
+						'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
656
+						'filename' => 'messages_settings_messengers',
657
+					),
658
+				),
659
+				'help_tour'     => array('Messages_Settings_Help_Tour'),
660
+				'require_nonce' => false,
661
+			),
662
+		);
663
+	}
664
+
665
+
666
+	protected function _add_screen_options()
667
+	{
668
+		// todo
669
+	}
670
+
671
+
672
+	protected function _add_screen_options_global_mtps()
673
+	{
674
+		/**
675
+		 * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
676
+		 * uses the $_admin_page_title property and we want different outputs in the different spots.
677
+		 */
678
+		$page_title = $this->_admin_page_title;
679
+		$this->_admin_page_title = esc_html__('Global Message Templates', 'event_espresso');
680
+		$this->_per_page_screen_option();
681
+		$this->_admin_page_title = $page_title;
682
+	}
683
+
684
+
685
+	protected function _add_screen_options_default()
686
+	{
687
+		$this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
688
+		$this->_per_page_screen_option();
689
+	}
690
+
691
+
692
+	// none of the below group are currently used for Messages
693
+	protected function _add_feature_pointers()
694
+	{
695
+	}
696
+
697
+	public function admin_init()
698
+	{
699
+	}
700
+
701
+	public function admin_notices()
702
+	{
703
+	}
704
+
705
+	public function admin_footer_scripts()
706
+	{
707
+	}
708
+
709
+
710
+	public function messages_help_tab()
711
+	{
712
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
713
+	}
714
+
715
+
716
+	public function messengers_help_tab()
717
+	{
718
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
719
+	}
720
+
721
+
722
+	public function message_types_help_tab()
723
+	{
724
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
725
+	}
726
+
727
+
728
+	public function messages_overview_help_tab()
729
+	{
730
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
731
+	}
732
+
733
+
734
+	public function message_templates_help_tab()
735
+	{
736
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
737
+	}
738
+
739
+
740
+	public function edit_message_template_help_tab()
741
+	{
742
+		$args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
743
+						. esc_attr__('Editor Title', 'event_espresso')
744
+						. '" />';
745
+		$args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
746
+						. esc_attr__('Context Switcher and Preview', 'event_espresso')
747
+						. '" />';
748
+		$args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
749
+						. esc_attr__('Message Template Form Fields', 'event_espresso')
750
+						. '" />';
751
+		$args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
752
+						. esc_attr__('Shortcodes Metabox', 'event_espresso')
753
+						. '" />';
754
+		$args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
755
+						. esc_attr__('Publish Metabox', 'event_espresso')
756
+						. '" />';
757
+		EEH_Template::display_template(
758
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
759
+			$args
760
+		);
761
+	}
762
+
763
+
764
+	public function message_template_shortcodes_help_tab()
765
+	{
766
+		$this->_set_shortcodes();
767
+		$args['shortcodes'] = $this->_shortcodes;
768
+		EEH_Template::display_template(
769
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
770
+			$args
771
+		);
772
+	}
773
+
774
+
775
+	public function preview_message_help_tab()
776
+	{
777
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
778
+	}
779
+
780
+
781
+	public function settings_help_tab()
782
+	{
783
+		$args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
784
+						. '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
785
+		$args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
786
+						. '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
787
+		$args['img3'] = '<div class="switch">'
788
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
789
+						. ' type="checkbox" checked="checked">'
790
+						. '<label for="ee-on-off-toggle-on"></label>'
791
+						. '</div>';
792
+		$args['img4'] = '<div class="switch">'
793
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
794
+						. ' type="checkbox">'
795
+						. '<label for="ee-on-off-toggle-on"></label>'
796
+						. '</div>';
797
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
798
+	}
799
+
800
+
801
+	public function load_scripts_styles()
802
+	{
803
+		wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
804
+		wp_enqueue_style('espresso_ee_msg');
805
+
806
+		wp_register_script(
807
+			'ee-messages-settings',
808
+			EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
809
+			array('jquery-ui-droppable', 'ee-serialize-full-array'),
810
+			EVENT_ESPRESSO_VERSION,
811
+			true
812
+		);
813
+		wp_register_script(
814
+			'ee-msg-list-table-js',
815
+			EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
816
+			array('ee-dialog'),
817
+			EVENT_ESPRESSO_VERSION
818
+		);
819
+	}
820
+
821
+
822
+	public function load_scripts_styles_default()
823
+	{
824
+		wp_enqueue_script('ee-msg-list-table-js');
825
+	}
826
+
827
+
828
+	public function wp_editor_css($mce_css)
829
+	{
830
+		// if we're on the edit_message_template route
831
+		if ($this->_req_action === 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
832
+			$message_type_name = $this->_active_message_type_name;
833
+
834
+			// we're going to REPLACE the existing mce css
835
+			// we need to get the css file location from the active messenger
836
+			$mce_css = $this->_active_messenger->get_variation(
837
+				$this->_template_pack,
838
+				$message_type_name,
839
+				true,
840
+				'wpeditor',
841
+				$this->_variation
842
+			);
843
+		}
844
+
845
+		return $mce_css;
846
+	}
847
+
848
+
849
+	public function load_scripts_styles_edit_message_template()
850
+	{
851
+
852
+		$this->_set_shortcodes();
853
+
854
+		EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf(
855
+			esc_html__(
856
+				'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
857
+				'event_espresso'
858
+			),
859
+			$this->_message_template_group->messenger_obj()->label['singular'],
860
+			$this->_message_template_group->message_type_obj()->label['singular']
861
+		);
862
+		EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = esc_html__(
863
+			'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
864
+			'event_espresso'
865
+		);
866
+		EE_Registry::$i18n_js_strings['server_error'] = esc_html__(
867
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
868
+			'event_espresso'
869
+		);
870
+
871
+		wp_register_script(
872
+			'ee_msgs_edit_js',
873
+			EE_MSG_ASSETS_URL . 'ee_message_editor.js',
874
+			array('jquery'),
875
+			EVENT_ESPRESSO_VERSION
876
+		);
877
+
878
+		wp_enqueue_script('ee_admin_js');
879
+		wp_enqueue_script('ee_msgs_edit_js');
880
+
881
+		// add in special css for tiny_mce
882
+		add_filter('mce_css', array($this, 'wp_editor_css'));
883
+	}
884
+
885
+
886
+	public function load_scripts_styles_display_preview_message()
887
+	{
888
+
889
+		$this->_set_message_template_group();
890
+
891
+		if (isset($this->_req_data['messenger'])) {
892
+			$this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
893
+				$this->_req_data['messenger']
894
+			);
895
+		}
896
+
897
+		$message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
898
+
899
+
900
+		wp_enqueue_style(
901
+			'espresso_preview_css',
902
+			$this->_active_messenger->get_variation(
903
+				$this->_template_pack,
904
+				$message_type_name,
905
+				true,
906
+				'preview',
907
+				$this->_variation
908
+			)
909
+		);
910
+	}
911
+
912
+
913
+	public function load_scripts_styles_settings()
914
+	{
915
+		wp_register_style(
916
+			'ee-message-settings',
917
+			EE_MSG_ASSETS_URL . 'ee_message_settings.css',
918
+			array(),
919
+			EVENT_ESPRESSO_VERSION
920
+		);
921
+		wp_enqueue_style('ee-text-links');
922
+		wp_enqueue_style('ee-message-settings');
923
+		wp_enqueue_script('ee-messages-settings');
924
+	}
925
+
926
+
927
+	/**
928
+	 * set views array for List Table
929
+	 */
930
+	public function _set_list_table_views_global_mtps()
931
+	{
932
+		$this->_views = array(
933
+			'in_use' => array(
934
+				'slug'  => 'in_use',
935
+				'label' => esc_html__('In Use', 'event_espresso'),
936
+				'count' => 0,
937
+			),
938
+		);
939
+	}
940
+
941
+
942
+	/**
943
+	 * Set views array for the Custom Template List Table
944
+	 */
945
+	public function _set_list_table_views_custom_mtps()
946
+	{
947
+		$this->_set_list_table_views_global_mtps();
948
+		$this->_views['in_use']['bulk_action'] = array(
949
+			'trash_message_template' => esc_html__('Move to Trash', 'event_espresso'),
950
+		);
951
+	}
952
+
953
+
954
+	/**
955
+	 * set views array for message queue list table
956
+	 *
957
+	 * @throws InvalidDataTypeException
958
+	 * @throws InvalidInterfaceException
959
+	 * @throws InvalidArgumentException
960
+	 * @throws EE_Error
961
+	 * @throws ReflectionException
962
+	 */
963
+	public function _set_list_table_views_default()
964
+	{
965
+		EE_Registry::instance()->load_helper('Template');
966
+
967
+		$common_bulk_actions = EE_Registry::instance()->CAP->current_user_can(
968
+			'ee_send_message',
969
+			'message_list_table_bulk_actions'
970
+		)
971
+			? array(
972
+				'generate_now'          => esc_html__('Generate Now', 'event_espresso'),
973
+				'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
974
+				'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
975
+				'send_now'              => esc_html__('Send Now', 'event_espresso'),
976
+			)
977
+			: array();
978
+
979
+		$delete_bulk_action = EE_Registry::instance()->CAP->current_user_can(
980
+			'ee_delete_messages',
981
+			'message_list_table_bulk_actions'
982
+		)
983
+			? array('delete_ee_messages' => esc_html__('Delete Messages', 'event_espresso'))
984
+			: array();
985
+
986
+
987
+		$this->_views = array(
988
+			'all' => array(
989
+				'slug'        => 'all',
990
+				'label'       => esc_html__('All', 'event_espresso'),
991
+				'count'       => 0,
992
+				'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action),
993
+			),
994
+		);
995
+
996
+
997
+		foreach (EEM_Message::instance()->all_statuses() as $status) {
998
+			if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
999
+				continue;
1000
+			}
1001
+			$status_bulk_actions = $common_bulk_actions;
1002
+			// unset bulk actions not applying to status
1003
+			if (! empty($status_bulk_actions)) {
1004
+				switch ($status) {
1005
+					case EEM_Message::status_idle:
1006
+					case EEM_Message::status_resend:
1007
+						$status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
1008
+						break;
1009
+
1010
+					case EEM_Message::status_failed:
1011
+					case EEM_Message::status_debug_only:
1012
+					case EEM_Message::status_messenger_executing:
1013
+						$status_bulk_actions = array();
1014
+						break;
1015
+
1016
+					case EEM_Message::status_incomplete:
1017
+						unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
1018
+						break;
1019
+
1020
+					case EEM_Message::status_retry:
1021
+					case EEM_Message::status_sent:
1022
+						unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
1023
+						break;
1024
+				}
1025
+			}
1026
+
1027
+			// skip adding messenger executing status to views because it will be included with the Failed view.
1028
+			if ($status === EEM_Message::status_messenger_executing) {
1029
+				continue;
1030
+			}
1031
+
1032
+			$this->_views[ strtolower($status) ] = array(
1033
+				'slug'        => strtolower($status),
1034
+				'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
1035
+				'count'       => 0,
1036
+				'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action),
1037
+			);
1038
+		}
1039
+	}
1040
+
1041
+
1042
+	protected function _ee_default_messages_overview_list_table()
1043
+	{
1044
+		$this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
1045
+		$this->display_admin_list_table_page_with_no_sidebar();
1046
+	}
1047
+
1048
+
1049
+	protected function _message_queue_list_table()
1050
+	{
1051
+		$this->_search_btn_label = esc_html__('Message Activity', 'event_espresso');
1052
+		$this->_template_args['per_column'] = 6;
1053
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_message_legend_items());
1054
+		$this->_template_args['before_list_table'] = '<h3>'
1055
+													 . EEM_Message::instance()->get_pretty_label_for_results()
1056
+													 . '</h3>';
1057
+		$this->display_admin_list_table_page_with_no_sidebar();
1058
+	}
1059
+
1060
+
1061
+	protected function _message_legend_items()
1062
+	{
1063
+
1064
+		$action_css_classes = EEH_MSG_Template::get_message_action_icons();
1065
+		$action_items = array();
1066
+
1067
+		foreach ($action_css_classes as $action_item => $action_details) {
1068
+			if ($action_item === 'see_notifications_for') {
1069
+				continue;
1070
+			}
1071
+			$action_items[ $action_item ] = array(
1072
+				'class' => $action_details['css_class'],
1073
+				'desc'  => $action_details['label'],
1074
+			);
1075
+		}
1076
+
1077
+		/** @type array $status_items status legend setup */
1078
+		$status_items = array(
1079
+			'incomplete_status'          => array(
1080
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
1081
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
1082
+			),
1083
+			'idle_status'                => array(
1084
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
1085
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
1086
+			),
1087
+			'resend_status'              => array(
1088
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
1089
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
1090
+			),
1091
+			'messenger_executing_status' => array(
1092
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
1093
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
1094
+			),
1095
+			'sent_status'                => array(
1096
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
1097
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
1098
+			),
1099
+			'retry_status'               => array(
1100
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
1101
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
1102
+			),
1103
+			'failed_status'              => array(
1104
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
1105
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
1106
+			),
1107
+		);
1108
+		if (EEM_Message::debug()) {
1109
+			$status_items['debug_only_status'] = array(
1110
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
1111
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
1112
+			);
1113
+		}
1114
+
1115
+		return array_merge($action_items, $status_items);
1116
+	}
1117
+
1118
+
1119
+	protected function _custom_mtps_preview()
1120
+	{
1121
+		$this->_admin_page_title = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
1122
+		$this->_template_args['preview_img'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
1123
+											   . ' alt="' . esc_attr__(
1124
+												   'Preview Custom Message Templates screenshot',
1125
+												   'event_espresso'
1126
+											   ) . '" />';
1127
+		$this->_template_args['preview_text'] = '<strong>'
1128
+												. esc_html__(
1129
+													'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
1130
+													'event_espresso'
1131
+												)
1132
+												. '</strong>';
1133
+
1134
+		$this->display_admin_caf_preview_page('custom_message_types', false);
1135
+	}
1136
+
1137
+
1138
+	/**
1139
+	 * get_message_templates
1140
+	 * This gets all the message templates for listing on the overview list.
1141
+	 *
1142
+	 * @access public
1143
+	 * @param int    $perpage the amount of templates groups to show per page
1144
+	 * @param string $type    the current _view we're getting templates for
1145
+	 * @param bool   $count   return count?
1146
+	 * @param bool   $all     disregard any paging info (get all data);
1147
+	 * @param bool   $global  whether to return just global (true) or custom templates (false)
1148
+	 * @return array
1149
+	 * @throws EE_Error
1150
+	 * @throws InvalidArgumentException
1151
+	 * @throws InvalidDataTypeException
1152
+	 * @throws InvalidInterfaceException
1153
+	 */
1154
+	public function get_message_templates(
1155
+		$perpage = 10,
1156
+		$type = 'in_use',
1157
+		$count = false,
1158
+		$all = false,
1159
+		$global = true
1160
+	) {
1161
+
1162
+		$MTP = EEM_Message_Template_Group::instance();
1163
+
1164
+		$this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
1165
+		$orderby = $this->_req_data['orderby'];
1166
+
1167
+		$order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
1168
+			? $this->_req_data['order']
1169
+			: 'ASC';
1170
+
1171
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
1172
+			? $this->_req_data['paged']
1173
+			: 1;
1174
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
1175
+			? $this->_req_data['perpage']
1176
+			: $perpage;
1177
+
1178
+		$offset = ($current_page - 1) * $per_page;
1179
+		$limit = $all ? null : array($offset, $per_page);
1180
+
1181
+
1182
+		// options will match what is in the _views array property
1183
+		switch ($type) {
1184
+			case 'in_use':
1185
+				$templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
1186
+				break;
1187
+			default:
1188
+				$templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
1189
+		}
1190
+
1191
+		return $templates;
1192
+	}
1193
+
1194
+
1195
+	/**
1196
+	 * filters etc might need a list of installed message_types
1197
+	 *
1198
+	 * @return array an array of message type objects
1199
+	 */
1200
+	public function get_installed_message_types()
1201
+	{
1202
+		$installed_message_types = $this->_message_resource_manager->installed_message_types();
1203
+		$installed = array();
1204
+
1205
+		foreach ($installed_message_types as $message_type) {
1206
+			$installed[ $message_type->name ] = $message_type;
1207
+		}
1208
+
1209
+		return $installed;
1210
+	}
1211
+
1212
+
1213
+	/**
1214
+	 * _add_message_template
1215
+	 *
1216
+	 * This is used when creating a custom template. All Custom Templates start based off another template.
1217
+	 *
1218
+	 * @param string $message_type
1219
+	 * @param string $messenger
1220
+	 * @param string $GRP_ID
1221
+	 *
1222
+	 * @throws EE_error
1223
+	 */
1224
+	protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
1225
+	{
1226
+		// set values override any request data
1227
+		$message_type = ! empty($message_type) ? $message_type : '';
1228
+		$message_type = empty($message_type) && ! empty($this->_req_data['message_type'])
1229
+			? $this->_req_data['message_type']
1230
+			: $message_type;
1231
+
1232
+		$messenger = ! empty($messenger) ? $messenger : '';
1233
+		$messenger = empty($messenger) && ! empty($this->_req_data['messenger'])
1234
+			? $this->_req_data['messenger']
1235
+			: $messenger;
1236
+
1237
+		$GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
1238
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
1239
+
1240
+		// we need messenger and message type.  They should be coming from the event editor. If not here then return error
1241
+		if (empty($message_type) || empty($messenger)) {
1242
+			throw new EE_Error(
1243
+				esc_html__(
1244
+					'Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
1245
+					'event_espresso'
1246
+				)
1247
+			);
1248
+		}
1249
+
1250
+		// we need the GRP_ID for the template being used as the base for the new template
1251
+		if (empty($GRP_ID)) {
1252
+			throw new EE_Error(
1253
+				esc_html__(
1254
+					'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
1255
+					'event_espresso'
1256
+				)
1257
+			);
1258
+		}
1259
+
1260
+		// let's just make sure the template gets generated!
1261
+
1262
+		// we need to reassign some variables for what the insert is expecting
1263
+		$this->_req_data['MTP_messenger'] = $messenger;
1264
+		$this->_req_data['MTP_message_type'] = $message_type;
1265
+		$this->_req_data['GRP_ID'] = $GRP_ID;
1266
+		$this->_insert_or_update_message_template(true);
1267
+	}
1268
+
1269
+
1270
+	/**
1271
+	 * public wrapper for the _add_message_template method
1272
+	 *
1273
+	 * @param string $message_type     message type slug
1274
+	 * @param string $messenger        messenger slug
1275
+	 * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
1276
+	 *                                 off of.
1277
+	 * @throws EE_error
1278
+	 */
1279
+	public function add_message_template($message_type, $messenger, $GRP_ID)
1280
+	{
1281
+		$this->_add_message_template($message_type, $messenger, $GRP_ID);
1282
+	}
1283
+
1284
+
1285
+	/**
1286
+	 * _edit_message_template
1287
+	 *
1288
+	 * @access protected
1289
+	 * @return void
1290
+	 * @throws InvalidIdentifierException
1291
+	 * @throws DomainException
1292
+	 * @throws EE_Error
1293
+	 * @throws InvalidArgumentException
1294
+	 * @throws ReflectionException
1295
+	 * @throws InvalidDataTypeException
1296
+	 * @throws InvalidInterfaceException
1297
+	 */
1298
+	protected function _edit_message_template()
1299
+	{
1300
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
1301
+		$template_fields = '';
1302
+		$sidebar_fields = '';
1303
+		// we filter the tinyMCE settings to remove the validation since message templates by their nature will not have
1304
+		// valid html in the templates.
1305
+		add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
1306
+
1307
+		$GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
1308
+			? absint($this->_req_data['id'])
1309
+			: false;
1310
+
1311
+		$EVT_ID = isset($this->_req_data['evt_id']) && ! empty($this->_req_data['evt_id'])
1312
+		? absint($this->_req_data['evt_id'])
1313
+		: false;
1314
+
1315
+		$this->_set_shortcodes(); // this also sets the _message_template property.
1316
+		$message_template_group = $this->_message_template_group;
1317
+		$c_label = $message_template_group->context_label();
1318
+		$c_config = $message_template_group->contexts_config();
1319
+
1320
+		reset($c_config);
1321
+		$context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
1322
+			? strtolower($this->_req_data['context'])
1323
+			: key($c_config);
1324
+
1325
+
1326
+		if (empty($GRP_ID)) {
1327
+			$action = 'insert_message_template';
1328
+			$edit_message_template_form_url = add_query_arg(
1329
+				array('action' => $action, 'noheader' => true),
1330
+				EE_MSG_ADMIN_URL
1331
+			);
1332
+		} else {
1333
+			$action = 'update_message_template';
1334
+			$edit_message_template_form_url = add_query_arg(
1335
+				array('action' => $action, 'noheader' => true),
1336
+				EE_MSG_ADMIN_URL
1337
+			);
1338
+		}
1339
+
1340
+		// set active messenger for this view
1341
+		$this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
1342
+			$message_template_group->messenger()
1343
+		);
1344
+		$this->_active_message_type_name = $message_template_group->message_type();
1345
+
1346
+
1347
+		// Do we have any validation errors?
1348
+		$validators = $this->_get_transient();
1349
+		$v_fields = ! empty($validators) ? array_keys($validators) : array();
1350
+
1351
+
1352
+		// we need to assemble the title from Various details
1353
+		$context_label = sprintf(
1354
+			esc_html__('(%s %s)', 'event_espresso'),
1355
+			$c_config[ $context ]['label'],
1356
+			ucwords($c_label['label'])
1357
+		);
1358
+
1359
+		$title = sprintf(
1360
+			esc_html__(' %s %s Template %s', 'event_espresso'),
1361
+			ucwords($message_template_group->messenger_obj()->label['singular']),
1362
+			ucwords($message_template_group->message_type_obj()->label['singular']),
1363
+			$context_label
1364
+		);
1365
+
1366
+		$this->_template_args['GRP_ID'] = $GRP_ID;
1367
+		$this->_template_args['message_template'] = $message_template_group;
1368
+		$this->_template_args['is_extra_fields'] = false;
1369
+
1370
+
1371
+		// let's get EEH_MSG_Template so we can get template form fields
1372
+		$template_field_structure = EEH_MSG_Template::get_fields(
1373
+			$message_template_group->messenger(),
1374
+			$message_template_group->message_type()
1375
+		);
1376
+
1377
+		if (! $template_field_structure) {
1378
+			$template_field_structure = false;
1379
+			$template_fields = esc_html__(
1380
+				'There was an error in assembling the fields for this display (you should see an error message)',
1381
+				'event_espresso'
1382
+			);
1383
+		}
1384
+
1385
+
1386
+		$message_templates = $message_template_group->context_templates();
1387
+
1388
+
1389
+		// if we have the extra key.. then we need to remove the content index from the template_field_structure as it
1390
+		// will get handled in the "extra" array.
1391
+		if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
1392
+			foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
1393
+				unset($template_field_structure[ $context ][ $reference_field ]);
1394
+			}
1395
+		}
1396
+
1397
+		// let's loop through the template_field_structure and actually assemble the input fields!
1398
+		if (! empty($template_field_structure)) {
1399
+			foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
1400
+				// if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
1401
+				// the extra array and reset them.
1402
+				if ($template_field === 'extra') {
1403
+					$this->_template_args['is_extra_fields'] = true;
1404
+					foreach ($field_setup_array as $reference_field => $new_fields_array) {
1405
+						$message_template = $message_templates[ $context ][ $reference_field ];
1406
+						$content = $message_template instanceof EE_Message_Template
1407
+							? $message_template->get('MTP_content')
1408
+							: '';
1409
+						foreach ($new_fields_array as $extra_field => $extra_array) {
1410
+							// let's verify if we need this extra field via the shortcodes parameter.
1411
+							$continue = false;
1412
+							if (isset($extra_array['shortcodes_required'])) {
1413
+								foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
1414
+									if (! array_key_exists($shortcode, $this->_shortcodes)) {
1415
+										$continue = true;
1416
+									}
1417
+								}
1418
+								if ($continue) {
1419
+									continue;
1420
+								}
1421
+							}
1422
+
1423
+							$field_id = $reference_field
1424
+										. '-'
1425
+										. $extra_field
1426
+										. '-content';
1427
+							$template_form_fields[ $field_id ] = $extra_array;
1428
+							$template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
1429
+																		 . $reference_field
1430
+																		 . '][content]['
1431
+																		 . $extra_field . ']';
1432
+							$css_class = isset($extra_array['css_class'])
1433
+								? $extra_array['css_class']
1434
+								: '';
1435
+
1436
+							$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1437
+																			  && in_array($extra_field, $v_fields, true)
1438
+																			  &&
1439
+																			  (
1440
+																				  is_array($validators[ $extra_field ])
1441
+																				  && isset($validators[ $extra_field ]['msg'])
1442
+																			  )
1443
+								? 'validate-error ' . $css_class
1444
+								: $css_class;
1445
+
1446
+							$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1447
+																		  && isset($content[ $extra_field ])
1448
+								? $content[ $extra_field ]
1449
+								: '';
1450
+
1451
+							// do we have a validation error?  if we do then let's use that value instead
1452
+							$template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
1453
+								? $validators[ $extra_field ]['value']
1454
+								: $template_form_fields[ $field_id ]['value'];
1455
+
1456
+
1457
+							$template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1458
+
1459
+							// shortcode selector
1460
+							$field_name_to_use = $extra_field === 'main'
1461
+								? 'content'
1462
+								: $extra_field;
1463
+							$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1464
+								$field_name_to_use,
1465
+								$field_id
1466
+							);
1467
+
1468
+							if (isset($extra_array['input']) && $extra_array['input'] === 'wp_editor') {
1469
+								// we want to decode the entities
1470
+								$template_form_fields[ $field_id ]['value'] = $template_form_fields[ $field_id ]['value'];
1471
+							}/**/
1472
+						}
1473
+						$templatefield_MTP_id = $reference_field . '-MTP_ID';
1474
+						$templatefield_templatename_id = $reference_field . '-name';
1475
+
1476
+						$template_form_fields[ $templatefield_MTP_id ] = array(
1477
+							'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
1478
+							'label'      => null,
1479
+							'input'      => 'hidden',
1480
+							'type'       => 'int',
1481
+							'required'   => false,
1482
+							'validation' => false,
1483
+							'value'      => ! empty($message_templates) ? $message_template->ID() : '',
1484
+							'css_class'  => '',
1485
+							'format'     => '%d',
1486
+							'db-col'     => 'MTP_ID',
1487
+						);
1488
+
1489
+						$template_form_fields[ $templatefield_templatename_id ] = array(
1490
+							'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
1491
+							'label'      => null,
1492
+							'input'      => 'hidden',
1493
+							'type'       => 'string',
1494
+							'required'   => false,
1495
+							'validation' => true,
1496
+							'value'      => $reference_field,
1497
+							'css_class'  => '',
1498
+							'format'     => '%s',
1499
+							'db-col'     => 'MTP_template_field',
1500
+						);
1501
+					}
1502
+					continue; // skip the next stuff, we got the necessary fields here for this dataset.
1503
+				} else {
1504
+					$field_id = $template_field . '-content';
1505
+					$template_form_fields[ $field_id ] = $field_setup_array;
1506
+					$template_form_fields[ $field_id ]['name'] = 'MTP_template_fields[' . $template_field . '][content]';
1507
+					$message_template = isset($message_templates[ $context ][ $template_field ])
1508
+						? $message_templates[ $context ][ $template_field ]
1509
+						: null;
1510
+					$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
1511
+																  && is_array($message_templates[ $context ])
1512
+																  && $message_template instanceof EE_Message_Template
1513
+						? $message_template->get('MTP_content')
1514
+						: '';
1515
+
1516
+					// do we have a validator error for this field?  if we do then we'll use that value instead
1517
+					$template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
1518
+						? $validators[ $template_field ]['value']
1519
+						: $template_form_fields[ $field_id ]['value'];
1520
+
1521
+
1522
+					$template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
1523
+					$css_class = isset($field_setup_array['css_class'])
1524
+						? $field_setup_array['css_class']
1525
+						: '';
1526
+					$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
1527
+																	  && in_array($template_field, $v_fields, true)
1528
+																	  && isset($validators[ $template_field ]['msg'])
1529
+						? 'validate-error ' . $css_class
1530
+						: $css_class;
1531
+
1532
+					// shortcode selector
1533
+					$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
1534
+						$template_field,
1535
+						$field_id
1536
+					);
1537
+				}
1538
+
1539
+				// k took care of content field(s) now let's take care of others.
1540
+
1541
+				$templatefield_MTP_id = $template_field . '-MTP_ID';
1542
+				$templatefield_field_templatename_id = $template_field . '-name';
1543
+
1544
+				// foreach template field there are actually two form fields created
1545
+				$template_form_fields[ $templatefield_MTP_id ] = array(
1546
+					'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
1547
+					'label'      => null,
1548
+					'input'      => 'hidden',
1549
+					'type'       => 'int',
1550
+					'required'   => false,
1551
+					'validation' => true,
1552
+					'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
1553
+					'css_class'  => '',
1554
+					'format'     => '%d',
1555
+					'db-col'     => 'MTP_ID',
1556
+				);
1557
+
1558
+				$template_form_fields[ $templatefield_field_templatename_id ] = array(
1559
+					'name'       => 'MTP_template_fields[' . $template_field . '][name]',
1560
+					'label'      => null,
1561
+					'input'      => 'hidden',
1562
+					'type'       => 'string',
1563
+					'required'   => false,
1564
+					'validation' => true,
1565
+					'value'      => $template_field,
1566
+					'css_class'  => '',
1567
+					'format'     => '%s',
1568
+					'db-col'     => 'MTP_template_field',
1569
+				);
1570
+			}
1571
+
1572
+			// add other fields
1573
+			$template_form_fields['ee-msg-current-context'] = array(
1574
+				'name'       => 'MTP_context',
1575
+				'label'      => null,
1576
+				'input'      => 'hidden',
1577
+				'type'       => 'string',
1578
+				'required'   => false,
1579
+				'validation' => true,
1580
+				'value'      => $context,
1581
+				'css_class'  => '',
1582
+				'format'     => '%s',
1583
+				'db-col'     => 'MTP_context',
1584
+			);
1585
+
1586
+			$template_form_fields['ee-msg-grp-id'] = array(
1587
+				'name'       => 'GRP_ID',
1588
+				'label'      => null,
1589
+				'input'      => 'hidden',
1590
+				'type'       => 'int',
1591
+				'required'   => false,
1592
+				'validation' => true,
1593
+				'value'      => $GRP_ID,
1594
+				'css_class'  => '',
1595
+				'format'     => '%d',
1596
+				'db-col'     => 'GRP_ID',
1597
+			);
1598
+
1599
+			$template_form_fields['ee-msg-messenger'] = array(
1600
+				'name'       => 'MTP_messenger',
1601
+				'label'      => null,
1602
+				'input'      => 'hidden',
1603
+				'type'       => 'string',
1604
+				'required'   => false,
1605
+				'validation' => true,
1606
+				'value'      => $message_template_group->messenger(),
1607
+				'css_class'  => '',
1608
+				'format'     => '%s',
1609
+				'db-col'     => 'MTP_messenger',
1610
+			);
1611
+
1612
+			$template_form_fields['ee-msg-message-type'] = array(
1613
+				'name'       => 'MTP_message_type',
1614
+				'label'      => null,
1615
+				'input'      => 'hidden',
1616
+				'type'       => 'string',
1617
+				'required'   => false,
1618
+				'validation' => true,
1619
+				'value'      => $message_template_group->message_type(),
1620
+				'css_class'  => '',
1621
+				'format'     => '%s',
1622
+				'db-col'     => 'MTP_message_type',
1623
+			);
1624
+
1625
+			$sidebar_form_fields['ee-msg-is-global'] = array(
1626
+				'name'       => 'MTP_is_global',
1627
+				'label'      => esc_html__('Global Template', 'event_espresso'),
1628
+				'input'      => 'hidden',
1629
+				'type'       => 'int',
1630
+				'required'   => false,
1631
+				'validation' => true,
1632
+				'value'      => $message_template_group->get('MTP_is_global'),
1633
+				'css_class'  => '',
1634
+				'format'     => '%d',
1635
+				'db-col'     => 'MTP_is_global',
1636
+			);
1637
+
1638
+			$sidebar_form_fields['ee-msg-is-override'] = array(
1639
+				'name'       => 'MTP_is_override',
1640
+				'label'      => esc_html__('Override all custom', 'event_espresso'),
1641
+				'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
1642
+				'type'       => 'int',
1643
+				'required'   => false,
1644
+				'validation' => true,
1645
+				'value'      => $message_template_group->get('MTP_is_override'),
1646
+				'css_class'  => '',
1647
+				'format'     => '%d',
1648
+				'db-col'     => 'MTP_is_override',
1649
+			);
1650
+
1651
+			$sidebar_form_fields['ee-msg-is-active'] = array(
1652
+				'name'       => 'MTP_is_active',
1653
+				'label'      => esc_html__('Active Template', 'event_espresso'),
1654
+				'input'      => 'hidden',
1655
+				'type'       => 'int',
1656
+				'required'   => false,
1657
+				'validation' => true,
1658
+				'value'      => $message_template_group->is_active(),
1659
+				'css_class'  => '',
1660
+				'format'     => '%d',
1661
+				'db-col'     => 'MTP_is_active',
1662
+			);
1663
+
1664
+			$sidebar_form_fields['ee-msg-deleted'] = array(
1665
+				'name'       => 'MTP_deleted',
1666
+				'label'      => null,
1667
+				'input'      => 'hidden',
1668
+				'type'       => 'int',
1669
+				'required'   => false,
1670
+				'validation' => true,
1671
+				'value'      => $message_template_group->get('MTP_deleted'),
1672
+				'css_class'  => '',
1673
+				'format'     => '%d',
1674
+				'db-col'     => 'MTP_deleted',
1675
+			);
1676
+			$sidebar_form_fields['ee-msg-author'] = array(
1677
+				'name'       => 'MTP_user_id',
1678
+				'label'      => esc_html__('Author', 'event_espresso'),
1679
+				'input'      => 'hidden',
1680
+				'type'       => 'int',
1681
+				'required'   => false,
1682
+				'validation' => false,
1683
+				'value'      => $message_template_group->user(),
1684
+				'format'     => '%d',
1685
+				'db-col'     => 'MTP_user_id',
1686
+			);
1687
+
1688
+			$sidebar_form_fields['ee-msg-route'] = array(
1689
+				'name'  => 'action',
1690
+				'input' => 'hidden',
1691
+				'type'  => 'string',
1692
+				'value' => $action,
1693
+			);
1694
+
1695
+			$sidebar_form_fields['ee-msg-id'] = array(
1696
+				'name'  => 'id',
1697
+				'input' => 'hidden',
1698
+				'type'  => 'int',
1699
+				'value' => $GRP_ID,
1700
+			);
1701
+			$sidebar_form_fields['ee-msg-evt-nonce'] = array(
1702
+				'name'  => $action . '_nonce',
1703
+				'input' => 'hidden',
1704
+				'type'  => 'string',
1705
+				'value' => wp_create_nonce($action . '_nonce'),
1706
+			);
1707
+
1708
+			if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
1709
+				$sidebar_form_fields['ee-msg-template-switch'] = array(
1710
+					'name'  => 'template_switch',
1711
+					'input' => 'hidden',
1712
+					'type'  => 'int',
1713
+					'value' => 1,
1714
+				);
1715
+			}
1716
+
1717
+
1718
+			$template_fields = $this->_generate_admin_form_fields($template_form_fields);
1719
+			$sidebar_fields = $this->_generate_admin_form_fields($sidebar_form_fields);
1720
+		} //end if ( !empty($template_field_structure) )
1721
+
1722
+		// set extra content for publish box
1723
+		$this->_template_args['publish_box_extra_content'] = $sidebar_fields;
1724
+		$this->_set_publish_post_box_vars(
1725
+			'id',
1726
+			$GRP_ID,
1727
+			false,
1728
+			add_query_arg(
1729
+				array('action' => 'global_mtps'),
1730
+				$this->_admin_base_url
1731
+			)
1732
+		);
1733
+
1734
+		// add preview button
1735
+		$preview_url = parent::add_query_args_and_nonce(
1736
+			array(
1737
+				'message_type' => $message_template_group->message_type(),
1738
+				'messenger'    => $message_template_group->messenger(),
1739
+				'context'      => $context,
1740
+				'GRP_ID'       => $GRP_ID,
1741
+				'evt_id'       => $EVT_ID,
1742
+				'action'       => 'preview_message',
1743
+			),
1744
+			$this->_admin_base_url
1745
+		);
1746
+		$preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
1747
+						  . esc_html__('Preview', 'event_espresso')
1748
+						  . '</a>';
1749
+
1750
+
1751
+		// setup context switcher
1752
+		$context_switcher_args = array(
1753
+			'page'    => 'espresso_messages',
1754
+			'action'  => 'edit_message_template',
1755
+			'id'      => $GRP_ID,
1756
+			'evt_id'  => $EVT_ID,
1757
+			'context' => $context,
1758
+			'extra'   => $preview_button,
1759
+		);
1760
+		$this->_set_context_switcher($message_template_group, $context_switcher_args);
1761
+
1762
+
1763
+		// main box
1764
+		$this->_template_args['template_fields'] = $template_fields;
1765
+		$this->_template_args['sidebar_box_id'] = 'details';
1766
+		$this->_template_args['action'] = $action;
1767
+		$this->_template_args['context'] = $context;
1768
+		$this->_template_args['edit_message_template_form_url'] = $edit_message_template_form_url;
1769
+		$this->_template_args['learn_more_about_message_templates_link'] =
1770
+			$this->_learn_more_about_message_templates_link();
1771
+
1772
+
1773
+		$this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
1774
+		$this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
1775
+			$message_template_group,
1776
+			$context,
1777
+			$context_label
1778
+		);
1779
+		$this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
1780
+		$this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
1781
+
1782
+		$this->_template_path = $this->_template_args['GRP_ID']
1783
+			? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
1784
+			: EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
1785
+
1786
+		// send along EE_Message_Template_Group object for further template use.
1787
+		$this->_template_args['MTP'] = $message_template_group;
1788
+
1789
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
1790
+			$this->_template_path,
1791
+			$this->_template_args,
1792
+			true
1793
+		);
1794
+
1795
+
1796
+		// finally, let's set the admin_page title
1797
+		$this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
1798
+
1799
+
1800
+		// we need to take care of setting the shortcodes property for use elsewhere.
1801
+		$this->_set_shortcodes();
1802
+
1803
+
1804
+		// final template wrapper
1805
+		$this->display_admin_page_with_sidebar();
1806
+	}
1807
+
1808
+
1809
+	public function filter_tinymce_init($mceInit, $editor_id)
1810
+	{
1811
+		return $mceInit;
1812
+	}
1813
+
1814
+
1815
+	public function add_context_switcher()
1816
+	{
1817
+		return $this->_context_switcher;
1818
+	}
1819
+
1820
+
1821
+	/**
1822
+	 * Adds the activation/deactivation toggle for the message template context.
1823
+	 *
1824
+	 * @param EE_Message_Template_Group $message_template_group
1825
+	 * @param string                    $context
1826
+	 * @param string                    $context_label
1827
+	 * @return string
1828
+	 * @throws DomainException
1829
+	 * @throws EE_Error
1830
+	 * @throws InvalidIdentifierException
1831
+	 */
1832
+	protected function add_active_context_element(
1833
+		EE_Message_Template_Group $message_template_group,
1834
+		$context,
1835
+		$context_label
1836
+	) {
1837
+		$template_args = array(
1838
+			'context'                   => $context,
1839
+			'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
1840
+			'is_active'                 => $message_template_group->is_context_active($context),
1841
+			'on_off_action'             => $message_template_group->is_context_active($context)
1842
+				? 'context-off'
1843
+				: 'context-on',
1844
+			'context_label'             => str_replace(array('(', ')'), '', $context_label),
1845
+			'message_template_group_id' => $message_template_group->ID(),
1846
+		);
1847
+		return EEH_Template::display_template(
1848
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
1849
+			$template_args,
1850
+			true
1851
+		);
1852
+	}
1853
+
1854
+
1855
+	/**
1856
+	 * Ajax callback for `toggle_context_template` ajax action.
1857
+	 * Handles toggling the message context on or off.
1858
+	 *
1859
+	 * @throws EE_Error
1860
+	 * @throws InvalidArgumentException
1861
+	 * @throws InvalidDataTypeException
1862
+	 * @throws InvalidIdentifierException
1863
+	 * @throws InvalidInterfaceException
1864
+	 */
1865
+	public function toggle_context_template()
1866
+	{
1867
+		$success = true;
1868
+		// check for required data
1869
+		if (! isset(
1870
+			$this->_req_data['message_template_group_id'],
1871
+			$this->_req_data['context'],
1872
+			$this->_req_data['status']
1873
+		)) {
1874
+			EE_Error::add_error(
1875
+				esc_html__('Required data for doing this action is not available.', 'event_espresso'),
1876
+				__FILE__,
1877
+				__FUNCTION__,
1878
+				__LINE__
1879
+			);
1880
+			$success = false;
1881
+		}
1882
+
1883
+		$nonce = isset($this->_req_data['toggle_context_nonce'])
1884
+			? sanitize_text_field($this->_req_data['toggle_context_nonce'])
1885
+			: '';
1886
+		$nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
1887
+		$this->_verify_nonce($nonce, $nonce_ref);
1888
+		$status = $this->_req_data['status'];
1889
+		if ($status !== 'off' && $status !== 'on') {
1890
+			EE_Error::add_error(
1891
+				sprintf(
1892
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
1893
+					$this->_req_data['status']
1894
+				),
1895
+				__FILE__,
1896
+				__FUNCTION__,
1897
+				__LINE__
1898
+			);
1899
+			$success = false;
1900
+		}
1901
+		$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
1902
+			$this->_req_data['message_template_group_id']
1903
+		);
1904
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
1905
+			EE_Error::add_error(
1906
+				sprintf(
1907
+					esc_html__(
1908
+						'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
1909
+						'event_espresso'
1910
+					),
1911
+					$this->_req_data['message_template_group_id'],
1912
+					'EE_Message_Template_Group'
1913
+				),
1914
+				__FILE__,
1915
+				__FUNCTION__,
1916
+				__LINE__
1917
+			);
1918
+			$success = false;
1919
+		}
1920
+		if ($success) {
1921
+			$success = $status === 'off'
1922
+				? $message_template_group->deactivate_context($this->_req_data['context'])
1923
+				: $message_template_group->activate_context($this->_req_data['context']);
1924
+		}
1925
+		$this->_template_args['success'] = $success;
1926
+		$this->_return_json();
1927
+	}
1928
+
1929
+
1930
+	public function _add_form_element_before()
1931
+	{
1932
+		return '<form method="post" action="'
1933
+			   . $this->_template_args["edit_message_template_form_url"]
1934
+			   . '" id="ee-msg-edit-frm">';
1935
+	}
1936
+
1937
+	public function _add_form_element_after()
1938
+	{
1939
+		return '</form>';
1940
+	}
1941
+
1942
+
1943
+	/**
1944
+	 * This executes switching the template pack for a message template.
1945
+	 *
1946
+	 * @since 4.5.0
1947
+	 * @throws EE_Error
1948
+	 * @throws InvalidDataTypeException
1949
+	 * @throws InvalidInterfaceException
1950
+	 * @throws InvalidArgumentException
1951
+	 * @throws ReflectionException
1952
+	 */
1953
+	public function switch_template_pack()
1954
+	{
1955
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
1956
+		$template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
1957
+
1958
+		// verify we have needed values.
1959
+		if (empty($GRP_ID) || empty($template_pack)) {
1960
+			$this->_template_args['error'] = true;
1961
+			EE_Error::add_error(
1962
+				esc_html__('The required date for switching templates is not available.', 'event_espresso'),
1963
+				__FILE__,
1964
+				__FUNCTION__,
1965
+				__LINE__
1966
+			);
1967
+		} else {
1968
+			// get template, set the new template_pack and then reset to default
1969
+			/** @type EE_Message_Template_Group $message_template_group */
1970
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
1971
+
1972
+			$message_template_group->set_template_pack_name($template_pack);
1973
+			$this->_req_data['msgr'] = $message_template_group->messenger();
1974
+			$this->_req_data['mt'] = $message_template_group->message_type();
1975
+
1976
+			$query_args = $this->_reset_to_default_template();
1977
+
1978
+			if (empty($query_args['id'])) {
1979
+				EE_Error::add_error(
1980
+					esc_html__(
1981
+						'Something went wrong with switching the template pack. Please try again or contact EE support',
1982
+						'event_espresso'
1983
+					),
1984
+					__FILE__,
1985
+					__FUNCTION__,
1986
+					__LINE__
1987
+				);
1988
+				$this->_template_args['error'] = true;
1989
+			} else {
1990
+				$template_label = $message_template_group->get_template_pack()->label;
1991
+				$template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
1992
+				EE_Error::add_success(
1993
+					sprintf(
1994
+						esc_html__(
1995
+							'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
1996
+							'event_espresso'
1997
+						),
1998
+						$template_label,
1999
+						$template_pack_labels->template_pack
2000
+					)
2001
+				);
2002
+				// generate the redirect url for js.
2003
+				$url = self::add_query_args_and_nonce(
2004
+					$query_args,
2005
+					$this->_admin_base_url
2006
+				);
2007
+				$this->_template_args['data']['redirect_url'] = $url;
2008
+				$this->_template_args['success'] = true;
2009
+			}
2010
+
2011
+			$this->_return_json();
2012
+		}
2013
+	}
2014
+
2015
+
2016
+	/**
2017
+	 * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
2018
+	 * they want.
2019
+	 *
2020
+	 * @access protected
2021
+	 * @return array|null
2022
+	 * @throws EE_Error
2023
+	 * @throws InvalidArgumentException
2024
+	 * @throws InvalidDataTypeException
2025
+	 * @throws InvalidInterfaceException
2026
+	 */
2027
+	protected function _reset_to_default_template()
2028
+	{
2029
+
2030
+		$templates = array();
2031
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2032
+		// we need to make sure we've got the info we need.
2033
+		if (! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
2034
+			EE_Error::add_error(
2035
+				esc_html__(
2036
+					'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
2037
+					'event_espresso'
2038
+				),
2039
+				__FILE__,
2040
+				__FUNCTION__,
2041
+				__LINE__
2042
+			);
2043
+		}
2044
+
2045
+		// all templates will be reset to whatever the defaults are
2046
+		// for the global template matching the messenger and message type.
2047
+		$success = ! empty($GRP_ID) ? true : false;
2048
+
2049
+		if ($success) {
2050
+			// let's first determine if the incoming template is a global template,
2051
+			// if it isn't then we need to get the global template matching messenger and message type.
2052
+			// $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
2053
+
2054
+
2055
+			// note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
2056
+			$success = $this->_delete_mtp_permanently($GRP_ID, false);
2057
+
2058
+			if ($success) {
2059
+				// if successfully deleted, lets generate the new ones.
2060
+				// Note. We set GLOBAL to true, because resets on ANY template
2061
+				// will use the related global template defaults for regeneration.
2062
+				// This means that if a custom template is reset it resets to whatever the related global template is.
2063
+				// HOWEVER, we DO keep the template pack and template variation set
2064
+				// for the current custom template when resetting.
2065
+				$templates = $this->_generate_new_templates(
2066
+					$this->_req_data['msgr'],
2067
+					$this->_req_data['mt'],
2068
+					$GRP_ID,
2069
+					true
2070
+				);
2071
+			}
2072
+		}
2073
+
2074
+		// any error messages?
2075
+		if (! $success) {
2076
+			EE_Error::add_error(
2077
+				esc_html__(
2078
+					'Something went wrong with deleting existing templates. Unable to reset to default',
2079
+					'event_espresso'
2080
+				),
2081
+				__FILE__,
2082
+				__FUNCTION__,
2083
+				__LINE__
2084
+			);
2085
+		}
2086
+
2087
+		// all good, let's add a success message!
2088
+		if ($success && ! empty($templates)) {
2089
+			// the info for the template we generated is the first element in the returned array
2090
+			// $templates = $templates[0];
2091
+			EE_Error::overwrite_success();
2092
+			EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
2093
+		}
2094
+
2095
+
2096
+		$query_args = array(
2097
+			'id'      => isset($templates[0]['GRP_ID']) ? $templates[0]['GRP_ID'] : null,
2098
+			'context' => isset($templates[0]['MTP_context']) ? $templates[0]['MTP_context'] : null,
2099
+			'action'  => isset($templates[0]['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
2100
+		);
2101
+
2102
+		// if called via ajax then we return query args otherwise redirect
2103
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2104
+			return $query_args;
2105
+		} else {
2106
+			$this->_redirect_after_action(false, '', '', $query_args, true);
2107
+
2108
+			return null;
2109
+		}
2110
+	}
2111
+
2112
+
2113
+	/**
2114
+	 * Retrieve and set the message preview for display.
2115
+	 *
2116
+	 * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
2117
+	 * @return string
2118
+	 * @throws ReflectionException
2119
+	 * @throws EE_Error
2120
+	 * @throws InvalidArgumentException
2121
+	 * @throws InvalidDataTypeException
2122
+	 * @throws InvalidInterfaceException
2123
+	 */
2124
+	public function _preview_message($send = false)
2125
+	{
2126
+		// first make sure we've got the necessary parameters
2127
+		if (! isset(
2128
+			$this->_req_data['message_type'],
2129
+			$this->_req_data['messenger'],
2130
+			$this->_req_data['messenger'],
2131
+			$this->_req_data['GRP_ID']
2132
+		)) {
2133
+			EE_Error::add_error(
2134
+				esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
2135
+				__FILE__,
2136
+				__FUNCTION__,
2137
+				__LINE__
2138
+			);
2139
+		}
2140
+
2141
+		EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
2142 2142
         
2143
-        // if we have an evt_id set on the request, use it.
2144
-        $EVT_ID = isset($this->_req_data['evt_id']) && ! empty($this->_req_data['evt_id'])
2145
-        ? absint($this->_req_data['evt_id'])
2146
-        : false;
2147
-
2148
-
2149
-        // get the preview!
2150
-        $preview = EED_Messages::preview_message(
2151
-            $this->_req_data['message_type'],
2152
-            $this->_req_data['context'],
2153
-            $this->_req_data['messenger'],
2154
-            $send
2155
-        );
2156
-
2157
-        if ($send) {
2158
-            return $preview;
2159
-        }
2160
-
2161
-        // let's add a button to go back to the edit view
2162
-        $query_args = array(
2163
-            'id'      => $this->_req_data['GRP_ID'],
2164
-            'evt_id'  => $EVT_ID,
2165
-            'context' => $this->_req_data['context'],
2166
-            'action'  => 'edit_message_template',
2167
-        );
2168
-        $go_back_url = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
2169
-        $preview_button = '<a href="'
2170
-                          . $go_back_url
2171
-                          . '" class="button-secondary messages-preview-go-back-button">'
2172
-                          . esc_html__('Go Back to Edit', 'event_espresso')
2173
-                          . '</a>';
2174
-        $message_types = $this->get_installed_message_types();
2175
-        $active_messenger = $this->_message_resource_manager->get_active_messenger(
2176
-            $this->_req_data['messenger']
2177
-        );
2178
-        $active_messenger_label = $active_messenger instanceof EE_messenger
2179
-            ? ucwords($active_messenger->label['singular'])
2180
-            : esc_html__('Unknown Messenger', 'event_espresso');
2181
-        // let's provide a helpful title for context
2182
-        $preview_title = sprintf(
2183
-            esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
2184
-            $active_messenger_label,
2185
-            ucwords($message_types[ $this->_req_data['message_type'] ]->label['singular'])
2186
-        );
2187
-        if (empty($preview)) {
2188
-            $this->noEventsErrorMessage();
2189
-        }
2190
-        // setup display of preview.
2191
-        $this->_admin_page_title = $preview_title;
2192
-        $this->_template_args['admin_page_title'] = $preview_title;
2193
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
2194
-        $this->_template_args['data']['force_json'] = true;
2195
-
2196
-        return '';
2197
-    }
2198
-
2199
-
2200
-    /**
2201
-     * Used to set an error if there are no events available for generating a preview/test send.
2202
-     *
2203
-     * @param bool $test_send  Whether the error should be generated for the context of a test send.
2204
-     */
2205
-    protected function noEventsErrorMessage($test_send = false)
2206
-    {
2207
-        $events_url = parent::add_query_args_and_nonce(
2208
-            array(
2209
-                'action' => 'default',
2210
-                'page'   => 'espresso_events',
2211
-            ),
2212
-            admin_url('admin.php')
2213
-        );
2214
-        $message = $test_send
2215
-            ? __(
2216
-                'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
2217
-                'event_espresso'
2218
-            )
2219
-            : __(
2220
-                'There is no preview for this message template available because there are no events created yet. The preview system uses actual events for generating the preview. %1$sGo see your events%2$s!',
2221
-                'event_espresso'
2222
-            );
2223
-
2224
-        EE_Error::add_attention(
2225
-            sprintf(
2226
-                $message,
2227
-                "<a href='{$events_url}'>",
2228
-                '</a>'
2229
-            )
2230
-        );
2231
-    }
2232
-
2233
-
2234
-    /**
2235
-     * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
2236
-     * gets called automatically.
2237
-     *
2238
-     * @since 4.5.0
2239
-     *
2240
-     * @return string
2241
-     */
2242
-    protected function _display_preview_message()
2243
-    {
2244
-        $this->display_admin_page_with_no_sidebar();
2245
-    }
2246
-
2247
-
2248
-    /**
2249
-     * registers metaboxes that should show up on the "edit_message_template" page
2250
-     *
2251
-     * @access protected
2252
-     * @return void
2253
-     */
2254
-    protected function _register_edit_meta_boxes()
2255
-    {
2256
-        add_meta_box(
2257
-            'mtp_valid_shortcodes',
2258
-            esc_html__('Valid Shortcodes', 'event_espresso'),
2259
-            array($this, 'shortcode_meta_box'),
2260
-            $this->_current_screen->id,
2261
-            'side',
2262
-            'default'
2263
-        );
2264
-        add_meta_box(
2265
-            'mtp_extra_actions',
2266
-            esc_html__('Extra Actions', 'event_espresso'),
2267
-            array($this, 'extra_actions_meta_box'),
2268
-            $this->_current_screen->id,
2269
-            'side',
2270
-            'high'
2271
-        );
2272
-        add_meta_box(
2273
-            'mtp_templates',
2274
-            esc_html__('Template Styles', 'event_espresso'),
2275
-            array($this, 'template_pack_meta_box'),
2276
-            $this->_current_screen->id,
2277
-            'side',
2278
-            'high'
2279
-        );
2280
-    }
2281
-
2282
-
2283
-    /**
2284
-     * metabox content for all template pack and variation selection.
2285
-     *
2286
-     * @since 4.5.0
2287
-     * @return string
2288
-     * @throws DomainException
2289
-     * @throws EE_Error
2290
-     * @throws InvalidArgumentException
2291
-     * @throws ReflectionException
2292
-     * @throws InvalidDataTypeException
2293
-     * @throws InvalidInterfaceException
2294
-     */
2295
-    public function template_pack_meta_box()
2296
-    {
2297
-        $this->_set_message_template_group();
2298
-
2299
-        $tp_collection = EEH_MSG_Template::get_template_pack_collection();
2300
-
2301
-        $tp_select_values = array();
2302
-
2303
-        foreach ($tp_collection as $tp) {
2304
-            // only include template packs that support this messenger and message type!
2305
-            $supports = $tp->get_supports();
2306
-            if (! isset($supports[ $this->_message_template_group->messenger() ])
2307
-                || ! in_array(
2308
-                    $this->_message_template_group->message_type(),
2309
-                    $supports[ $this->_message_template_group->messenger() ],
2310
-                    true
2311
-                )
2312
-            ) {
2313
-                // not supported
2314
-                continue;
2315
-            }
2316
-
2317
-            $tp_select_values[] = array(
2318
-                'text' => $tp->label,
2319
-                'id'   => $tp->dbref,
2320
-            );
2321
-        }
2322
-
2323
-        // if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
2324
-        // the default template pack.  This still allows for the odd template pack to override.
2325
-        if (empty($tp_select_values)) {
2326
-            $tp_select_values[] = array(
2327
-                'text' => esc_html__('Default', 'event_espresso'),
2328
-                'id'   => 'default',
2329
-            );
2330
-        }
2331
-
2332
-        // setup variation select values for the currently selected template.
2333
-        $variations = $this->_message_template_group->get_template_pack()->get_variations(
2334
-            $this->_message_template_group->messenger(),
2335
-            $this->_message_template_group->message_type()
2336
-        );
2337
-        $variations_select_values = array();
2338
-        foreach ($variations as $variation => $label) {
2339
-            $variations_select_values[] = array(
2340
-                'text' => $label,
2341
-                'id'   => $variation,
2342
-            );
2343
-        }
2344
-
2345
-        $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
2346
-
2347
-        $template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
2348
-            'MTP_template_pack',
2349
-            $tp_select_values,
2350
-            $this->_message_template_group->get_template_pack_name()
2351
-        );
2352
-        $template_args['variations_selector'] = EEH_Form_Fields::select_input(
2353
-            'MTP_template_variation',
2354
-            $variations_select_values,
2355
-            $this->_message_template_group->get_template_pack_variation()
2356
-        );
2357
-        $template_args['template_pack_label'] = $template_pack_labels->template_pack;
2358
-        $template_args['template_variation_label'] = $template_pack_labels->template_variation;
2359
-        $template_args['template_pack_description'] = $template_pack_labels->template_pack_description;
2360
-        $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
2361
-
2362
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
2363
-
2364
-        EEH_Template::display_template($template, $template_args);
2365
-    }
2366
-
2367
-
2368
-    /**
2369
-     * This meta box holds any extra actions related to Message Templates
2370
-     * For now, this includes Resetting templates to defaults and sending a test email.
2371
-     *
2372
-     * @access  public
2373
-     * @return void
2374
-     * @throws EE_Error
2375
-     */
2376
-    public function extra_actions_meta_box()
2377
-    {
2378
-        $template_form_fields = array();
2379
-
2380
-        $extra_args = array(
2381
-            'msgr'   => $this->_message_template_group->messenger(),
2382
-            'mt'     => $this->_message_template_group->message_type(),
2383
-            'GRP_ID' => $this->_message_template_group->GRP_ID(),
2384
-        );
2385
-        // first we need to see if there are any fields
2386
-        $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
2387
-
2388
-        if (! empty($fields)) {
2389
-            // yup there be fields
2390
-            foreach ($fields as $field => $config) {
2391
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
2392
-                $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
2393
-                $default = isset($config['default']) ? $config['default'] : '';
2394
-                $default = isset($config['value']) ? $config['value'] : $default;
2395
-
2396
-                // if type is hidden and the value is empty
2397
-                // something may have gone wrong so let's correct with the defaults
2398
-                $fix = $config['input'] === 'hidden'
2399
-                       && isset($existing[ $field ])
2400
-                       && empty($existing[ $field ])
2401
-                    ? $default
2402
-                    : '';
2403
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
2404
-                    ? $existing[ $field ]
2405
-                    : $fix;
2406
-
2407
-                $template_form_fields[ $field_id ] = array(
2408
-                    'name'       => 'test_settings_fld[' . $field . ']',
2409
-                    'label'      => $config['label'],
2410
-                    'input'      => $config['input'],
2411
-                    'type'       => $config['type'],
2412
-                    'required'   => $config['required'],
2413
-                    'validation' => $config['validation'],
2414
-                    'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
2415
-                    'css_class'  => $config['css_class'],
2416
-                    'options'    => isset($config['options']) ? $config['options'] : array(),
2417
-                    'default'    => $default,
2418
-                    'format'     => $config['format'],
2419
-                );
2420
-            }
2421
-        }
2422
-
2423
-        $test_settings_fields = ! empty($template_form_fields)
2424
-            ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
2425
-            : '';
2426
-
2427
-        $test_settings_html = '';
2428
-        // print out $test_settings_fields
2429
-        if (! empty($test_settings_fields)) {
2430
-            echo $test_settings_fields;
2431
-            $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
2432
-            $test_settings_html .= 'name="test_button" value="';
2433
-            $test_settings_html .= esc_html__('Test Send', 'event_espresso');
2434
-            $test_settings_html .= '" /><div style="clear:both"></div>';
2435
-        }
2436
-
2437
-        // and button
2438
-        $test_settings_html .= '<p>'
2439
-                               . esc_html__('Need to reset this message type and start over?', 'event_espresso')
2440
-                               . '</p>';
2441
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
2442
-        $test_settings_html .= $this->get_action_link_or_button(
2443
-            'reset_to_default',
2444
-            'reset',
2445
-            $extra_args,
2446
-            'button-primary reset-default-button'
2447
-        );
2448
-        $test_settings_html .= '</div><div style="clear:both"></div>';
2449
-        echo $test_settings_html;
2450
-    }
2451
-
2452
-
2453
-    /**
2454
-     * This returns the shortcode selector skeleton for a given context and field.
2455
-     *
2456
-     * @since 4.9.rc.000
2457
-     * @param string $field           The name of the field retrieving shortcodes for.
2458
-     * @param string $linked_input_id The css id of the input that the shortcodes get added to.
2459
-     * @return string
2460
-     * @throws DomainException
2461
-     * @throws EE_Error
2462
-     * @throws InvalidArgumentException
2463
-     * @throws ReflectionException
2464
-     * @throws InvalidDataTypeException
2465
-     * @throws InvalidInterfaceException
2466
-     */
2467
-    protected function _get_shortcode_selector($field, $linked_input_id)
2468
-    {
2469
-        $template_args = array(
2470
-            'shortcodes'      => $this->_get_shortcodes(array($field), true),
2471
-            'fieldname'       => $field,
2472
-            'linked_input_id' => $linked_input_id,
2473
-        );
2474
-
2475
-        return EEH_Template::display_template(
2476
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
2477
-            $template_args,
2478
-            true
2479
-        );
2480
-    }
2481
-
2482
-
2483
-    /**
2484
-     * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
2485
-     * page)
2486
-     *
2487
-     * @access public
2488
-     * @return void
2489
-     * @throws EE_Error
2490
-     * @throws InvalidArgumentException
2491
-     * @throws ReflectionException
2492
-     * @throws InvalidDataTypeException
2493
-     * @throws InvalidInterfaceException
2494
-     */
2495
-    public function shortcode_meta_box()
2496
-    {
2497
-        $shortcodes = $this->_get_shortcodes(array(), false); // just make sure shortcodes property is set
2498
-        // $messenger = $this->_message_template_group->messenger_obj();
2499
-        // now let's set the content depending on the status of the shortcodes array
2500
-        if (empty($shortcodes)) {
2501
-            $content = '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
2502
-            echo $content;
2503
-        } else {
2504
-            // $alt = 0;
2505
-            ?>
2143
+		// if we have an evt_id set on the request, use it.
2144
+		$EVT_ID = isset($this->_req_data['evt_id']) && ! empty($this->_req_data['evt_id'])
2145
+		? absint($this->_req_data['evt_id'])
2146
+		: false;
2147
+
2148
+
2149
+		// get the preview!
2150
+		$preview = EED_Messages::preview_message(
2151
+			$this->_req_data['message_type'],
2152
+			$this->_req_data['context'],
2153
+			$this->_req_data['messenger'],
2154
+			$send
2155
+		);
2156
+
2157
+		if ($send) {
2158
+			return $preview;
2159
+		}
2160
+
2161
+		// let's add a button to go back to the edit view
2162
+		$query_args = array(
2163
+			'id'      => $this->_req_data['GRP_ID'],
2164
+			'evt_id'  => $EVT_ID,
2165
+			'context' => $this->_req_data['context'],
2166
+			'action'  => 'edit_message_template',
2167
+		);
2168
+		$go_back_url = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
2169
+		$preview_button = '<a href="'
2170
+						  . $go_back_url
2171
+						  . '" class="button-secondary messages-preview-go-back-button">'
2172
+						  . esc_html__('Go Back to Edit', 'event_espresso')
2173
+						  . '</a>';
2174
+		$message_types = $this->get_installed_message_types();
2175
+		$active_messenger = $this->_message_resource_manager->get_active_messenger(
2176
+			$this->_req_data['messenger']
2177
+		);
2178
+		$active_messenger_label = $active_messenger instanceof EE_messenger
2179
+			? ucwords($active_messenger->label['singular'])
2180
+			: esc_html__('Unknown Messenger', 'event_espresso');
2181
+		// let's provide a helpful title for context
2182
+		$preview_title = sprintf(
2183
+			esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
2184
+			$active_messenger_label,
2185
+			ucwords($message_types[ $this->_req_data['message_type'] ]->label['singular'])
2186
+		);
2187
+		if (empty($preview)) {
2188
+			$this->noEventsErrorMessage();
2189
+		}
2190
+		// setup display of preview.
2191
+		$this->_admin_page_title = $preview_title;
2192
+		$this->_template_args['admin_page_title'] = $preview_title;
2193
+		$this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
2194
+		$this->_template_args['data']['force_json'] = true;
2195
+
2196
+		return '';
2197
+	}
2198
+
2199
+
2200
+	/**
2201
+	 * Used to set an error if there are no events available for generating a preview/test send.
2202
+	 *
2203
+	 * @param bool $test_send  Whether the error should be generated for the context of a test send.
2204
+	 */
2205
+	protected function noEventsErrorMessage($test_send = false)
2206
+	{
2207
+		$events_url = parent::add_query_args_and_nonce(
2208
+			array(
2209
+				'action' => 'default',
2210
+				'page'   => 'espresso_events',
2211
+			),
2212
+			admin_url('admin.php')
2213
+		);
2214
+		$message = $test_send
2215
+			? __(
2216
+				'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
2217
+				'event_espresso'
2218
+			)
2219
+			: __(
2220
+				'There is no preview for this message template available because there are no events created yet. The preview system uses actual events for generating the preview. %1$sGo see your events%2$s!',
2221
+				'event_espresso'
2222
+			);
2223
+
2224
+		EE_Error::add_attention(
2225
+			sprintf(
2226
+				$message,
2227
+				"<a href='{$events_url}'>",
2228
+				'</a>'
2229
+			)
2230
+		);
2231
+	}
2232
+
2233
+
2234
+	/**
2235
+	 * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
2236
+	 * gets called automatically.
2237
+	 *
2238
+	 * @since 4.5.0
2239
+	 *
2240
+	 * @return string
2241
+	 */
2242
+	protected function _display_preview_message()
2243
+	{
2244
+		$this->display_admin_page_with_no_sidebar();
2245
+	}
2246
+
2247
+
2248
+	/**
2249
+	 * registers metaboxes that should show up on the "edit_message_template" page
2250
+	 *
2251
+	 * @access protected
2252
+	 * @return void
2253
+	 */
2254
+	protected function _register_edit_meta_boxes()
2255
+	{
2256
+		add_meta_box(
2257
+			'mtp_valid_shortcodes',
2258
+			esc_html__('Valid Shortcodes', 'event_espresso'),
2259
+			array($this, 'shortcode_meta_box'),
2260
+			$this->_current_screen->id,
2261
+			'side',
2262
+			'default'
2263
+		);
2264
+		add_meta_box(
2265
+			'mtp_extra_actions',
2266
+			esc_html__('Extra Actions', 'event_espresso'),
2267
+			array($this, 'extra_actions_meta_box'),
2268
+			$this->_current_screen->id,
2269
+			'side',
2270
+			'high'
2271
+		);
2272
+		add_meta_box(
2273
+			'mtp_templates',
2274
+			esc_html__('Template Styles', 'event_espresso'),
2275
+			array($this, 'template_pack_meta_box'),
2276
+			$this->_current_screen->id,
2277
+			'side',
2278
+			'high'
2279
+		);
2280
+	}
2281
+
2282
+
2283
+	/**
2284
+	 * metabox content for all template pack and variation selection.
2285
+	 *
2286
+	 * @since 4.5.0
2287
+	 * @return string
2288
+	 * @throws DomainException
2289
+	 * @throws EE_Error
2290
+	 * @throws InvalidArgumentException
2291
+	 * @throws ReflectionException
2292
+	 * @throws InvalidDataTypeException
2293
+	 * @throws InvalidInterfaceException
2294
+	 */
2295
+	public function template_pack_meta_box()
2296
+	{
2297
+		$this->_set_message_template_group();
2298
+
2299
+		$tp_collection = EEH_MSG_Template::get_template_pack_collection();
2300
+
2301
+		$tp_select_values = array();
2302
+
2303
+		foreach ($tp_collection as $tp) {
2304
+			// only include template packs that support this messenger and message type!
2305
+			$supports = $tp->get_supports();
2306
+			if (! isset($supports[ $this->_message_template_group->messenger() ])
2307
+				|| ! in_array(
2308
+					$this->_message_template_group->message_type(),
2309
+					$supports[ $this->_message_template_group->messenger() ],
2310
+					true
2311
+				)
2312
+			) {
2313
+				// not supported
2314
+				continue;
2315
+			}
2316
+
2317
+			$tp_select_values[] = array(
2318
+				'text' => $tp->label,
2319
+				'id'   => $tp->dbref,
2320
+			);
2321
+		}
2322
+
2323
+		// if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
2324
+		// the default template pack.  This still allows for the odd template pack to override.
2325
+		if (empty($tp_select_values)) {
2326
+			$tp_select_values[] = array(
2327
+				'text' => esc_html__('Default', 'event_espresso'),
2328
+				'id'   => 'default',
2329
+			);
2330
+		}
2331
+
2332
+		// setup variation select values for the currently selected template.
2333
+		$variations = $this->_message_template_group->get_template_pack()->get_variations(
2334
+			$this->_message_template_group->messenger(),
2335
+			$this->_message_template_group->message_type()
2336
+		);
2337
+		$variations_select_values = array();
2338
+		foreach ($variations as $variation => $label) {
2339
+			$variations_select_values[] = array(
2340
+				'text' => $label,
2341
+				'id'   => $variation,
2342
+			);
2343
+		}
2344
+
2345
+		$template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
2346
+
2347
+		$template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
2348
+			'MTP_template_pack',
2349
+			$tp_select_values,
2350
+			$this->_message_template_group->get_template_pack_name()
2351
+		);
2352
+		$template_args['variations_selector'] = EEH_Form_Fields::select_input(
2353
+			'MTP_template_variation',
2354
+			$variations_select_values,
2355
+			$this->_message_template_group->get_template_pack_variation()
2356
+		);
2357
+		$template_args['template_pack_label'] = $template_pack_labels->template_pack;
2358
+		$template_args['template_variation_label'] = $template_pack_labels->template_variation;
2359
+		$template_args['template_pack_description'] = $template_pack_labels->template_pack_description;
2360
+		$template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
2361
+
2362
+		$template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
2363
+
2364
+		EEH_Template::display_template($template, $template_args);
2365
+	}
2366
+
2367
+
2368
+	/**
2369
+	 * This meta box holds any extra actions related to Message Templates
2370
+	 * For now, this includes Resetting templates to defaults and sending a test email.
2371
+	 *
2372
+	 * @access  public
2373
+	 * @return void
2374
+	 * @throws EE_Error
2375
+	 */
2376
+	public function extra_actions_meta_box()
2377
+	{
2378
+		$template_form_fields = array();
2379
+
2380
+		$extra_args = array(
2381
+			'msgr'   => $this->_message_template_group->messenger(),
2382
+			'mt'     => $this->_message_template_group->message_type(),
2383
+			'GRP_ID' => $this->_message_template_group->GRP_ID(),
2384
+		);
2385
+		// first we need to see if there are any fields
2386
+		$fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
2387
+
2388
+		if (! empty($fields)) {
2389
+			// yup there be fields
2390
+			foreach ($fields as $field => $config) {
2391
+				$field_id = $this->_message_template_group->messenger() . '_' . $field;
2392
+				$existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
2393
+				$default = isset($config['default']) ? $config['default'] : '';
2394
+				$default = isset($config['value']) ? $config['value'] : $default;
2395
+
2396
+				// if type is hidden and the value is empty
2397
+				// something may have gone wrong so let's correct with the defaults
2398
+				$fix = $config['input'] === 'hidden'
2399
+					   && isset($existing[ $field ])
2400
+					   && empty($existing[ $field ])
2401
+					? $default
2402
+					: '';
2403
+				$existing[ $field ] = isset($existing[ $field ]) && empty($fix)
2404
+					? $existing[ $field ]
2405
+					: $fix;
2406
+
2407
+				$template_form_fields[ $field_id ] = array(
2408
+					'name'       => 'test_settings_fld[' . $field . ']',
2409
+					'label'      => $config['label'],
2410
+					'input'      => $config['input'],
2411
+					'type'       => $config['type'],
2412
+					'required'   => $config['required'],
2413
+					'validation' => $config['validation'],
2414
+					'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
2415
+					'css_class'  => $config['css_class'],
2416
+					'options'    => isset($config['options']) ? $config['options'] : array(),
2417
+					'default'    => $default,
2418
+					'format'     => $config['format'],
2419
+				);
2420
+			}
2421
+		}
2422
+
2423
+		$test_settings_fields = ! empty($template_form_fields)
2424
+			? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
2425
+			: '';
2426
+
2427
+		$test_settings_html = '';
2428
+		// print out $test_settings_fields
2429
+		if (! empty($test_settings_fields)) {
2430
+			echo $test_settings_fields;
2431
+			$test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
2432
+			$test_settings_html .= 'name="test_button" value="';
2433
+			$test_settings_html .= esc_html__('Test Send', 'event_espresso');
2434
+			$test_settings_html .= '" /><div style="clear:both"></div>';
2435
+		}
2436
+
2437
+		// and button
2438
+		$test_settings_html .= '<p>'
2439
+							   . esc_html__('Need to reset this message type and start over?', 'event_espresso')
2440
+							   . '</p>';
2441
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
2442
+		$test_settings_html .= $this->get_action_link_or_button(
2443
+			'reset_to_default',
2444
+			'reset',
2445
+			$extra_args,
2446
+			'button-primary reset-default-button'
2447
+		);
2448
+		$test_settings_html .= '</div><div style="clear:both"></div>';
2449
+		echo $test_settings_html;
2450
+	}
2451
+
2452
+
2453
+	/**
2454
+	 * This returns the shortcode selector skeleton for a given context and field.
2455
+	 *
2456
+	 * @since 4.9.rc.000
2457
+	 * @param string $field           The name of the field retrieving shortcodes for.
2458
+	 * @param string $linked_input_id The css id of the input that the shortcodes get added to.
2459
+	 * @return string
2460
+	 * @throws DomainException
2461
+	 * @throws EE_Error
2462
+	 * @throws InvalidArgumentException
2463
+	 * @throws ReflectionException
2464
+	 * @throws InvalidDataTypeException
2465
+	 * @throws InvalidInterfaceException
2466
+	 */
2467
+	protected function _get_shortcode_selector($field, $linked_input_id)
2468
+	{
2469
+		$template_args = array(
2470
+			'shortcodes'      => $this->_get_shortcodes(array($field), true),
2471
+			'fieldname'       => $field,
2472
+			'linked_input_id' => $linked_input_id,
2473
+		);
2474
+
2475
+		return EEH_Template::display_template(
2476
+			EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
2477
+			$template_args,
2478
+			true
2479
+		);
2480
+	}
2481
+
2482
+
2483
+	/**
2484
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
2485
+	 * page)
2486
+	 *
2487
+	 * @access public
2488
+	 * @return void
2489
+	 * @throws EE_Error
2490
+	 * @throws InvalidArgumentException
2491
+	 * @throws ReflectionException
2492
+	 * @throws InvalidDataTypeException
2493
+	 * @throws InvalidInterfaceException
2494
+	 */
2495
+	public function shortcode_meta_box()
2496
+	{
2497
+		$shortcodes = $this->_get_shortcodes(array(), false); // just make sure shortcodes property is set
2498
+		// $messenger = $this->_message_template_group->messenger_obj();
2499
+		// now let's set the content depending on the status of the shortcodes array
2500
+		if (empty($shortcodes)) {
2501
+			$content = '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
2502
+			echo $content;
2503
+		} else {
2504
+			// $alt = 0;
2505
+			?>
2506 2506
             <div style="float:right; margin-top:10px"><?php
2507
-                            echo $this->_get_help_tab_link('message_template_shortcodes');
2508
-            ?></div>
2507
+							echo $this->_get_help_tab_link('message_template_shortcodes');
2508
+			?></div>
2509 2509
             <p class="small-text"><?php
2510
-                                  printf(
2511
-                                      esc_html__(
2512
-                                          'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
2513
-                                          'event_espresso'
2514
-                                      ),
2515
-                                      '<span class="dashicons dashicons-menu"></span>'
2516
-                                  );
2517
-                                    ?>
2510
+								  printf(
2511
+									  esc_html__(
2512
+										  'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
2513
+										  'event_espresso'
2514
+									  ),
2515
+									  '<span class="dashicons dashicons-menu"></span>'
2516
+								  );
2517
+									?>
2518 2518
             </p>
2519 2519
             <?php
2520
-        }
2521
-    }
2522
-
2523
-
2524
-    /**
2525
-     * used to set the $_shortcodes property for when its needed elsewhere.
2526
-     *
2527
-     * @access protected
2528
-     * @return void
2529
-     * @throws EE_Error
2530
-     * @throws InvalidArgumentException
2531
-     * @throws ReflectionException
2532
-     * @throws InvalidDataTypeException
2533
-     * @throws InvalidInterfaceException
2534
-     */
2535
-    protected function _set_shortcodes()
2536
-    {
2537
-
2538
-        // no need to run this if the property is already set
2539
-        if (! empty($this->_shortcodes)) {
2540
-            return;
2541
-        }
2542
-
2543
-        $this->_shortcodes = $this->_get_shortcodes();
2544
-    }
2545
-
2546
-
2547
-    /**
2548
-     * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
2549
-     * property)
2550
-     *
2551
-     * @access  protected
2552
-     * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
2553
-     *                         for. Defaults to all (for the given context)
2554
-     * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
2555
-     * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
2556
-     *                         true just an array of shortcode/label pairs.
2557
-     * @throws EE_Error
2558
-     * @throws InvalidArgumentException
2559
-     * @throws ReflectionException
2560
-     * @throws InvalidDataTypeException
2561
-     * @throws InvalidInterfaceException
2562
-     */
2563
-    protected function _get_shortcodes($fields = array(), $merged = true)
2564
-    {
2565
-        $this->_set_message_template_group();
2566
-
2567
-        // we need the messenger and message template to retrieve the valid shortcodes array.
2568
-        $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
2569
-            ? absint($this->_req_data['id'])
2570
-            : false;
2571
-        $context = isset($this->_req_data['context'])
2572
-            ? $this->_req_data['context']
2573
-            : key($this->_message_template_group->contexts_config());
2574
-
2575
-        return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
2576
-    }
2577
-
2578
-
2579
-    /**
2580
-     * This sets the _message_template property (containing the called message_template object)
2581
-     *
2582
-     * @access protected
2583
-     * @return void
2584
-     * @throws EE_Error
2585
-     * @throws InvalidArgumentException
2586
-     * @throws ReflectionException
2587
-     * @throws InvalidDataTypeException
2588
-     * @throws InvalidInterfaceException
2589
-     */
2590
-    protected function _set_message_template_group()
2591
-    {
2592
-
2593
-        if (! empty($this->_message_template_group)) {
2594
-            return;
2595
-        } //get out if this is already set.
2596
-
2597
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
2598
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
2599
-
2600
-        // let's get the message templates
2601
-        $MTP = EEM_Message_Template_Group::instance();
2602
-
2603
-        if (empty($GRP_ID)) {
2604
-            $this->_message_template_group = $MTP->create_default_object();
2605
-        } else {
2606
-            $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
2607
-        }
2608
-
2609
-        $this->_template_pack = $this->_message_template_group->get_template_pack();
2610
-        $this->_variation = $this->_message_template_group->get_template_pack_variation();
2611
-    }
2612
-
2613
-
2614
-    /**
2615
-     * sets up a context switcher for edit forms
2616
-     *
2617
-     * @access  protected
2618
-     * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
2619
-     * @param array                      $args                  various things the context switcher needs.
2620
-     * @throws EE_Error
2621
-     */
2622
-    protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
2623
-    {
2624
-        $context_details = $template_group_object->contexts_config();
2625
-        $context_label = $template_group_object->context_label();
2626
-        ob_start();
2627
-        ?>
2520
+		}
2521
+	}
2522
+
2523
+
2524
+	/**
2525
+	 * used to set the $_shortcodes property for when its needed elsewhere.
2526
+	 *
2527
+	 * @access protected
2528
+	 * @return void
2529
+	 * @throws EE_Error
2530
+	 * @throws InvalidArgumentException
2531
+	 * @throws ReflectionException
2532
+	 * @throws InvalidDataTypeException
2533
+	 * @throws InvalidInterfaceException
2534
+	 */
2535
+	protected function _set_shortcodes()
2536
+	{
2537
+
2538
+		// no need to run this if the property is already set
2539
+		if (! empty($this->_shortcodes)) {
2540
+			return;
2541
+		}
2542
+
2543
+		$this->_shortcodes = $this->_get_shortcodes();
2544
+	}
2545
+
2546
+
2547
+	/**
2548
+	 * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
2549
+	 * property)
2550
+	 *
2551
+	 * @access  protected
2552
+	 * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
2553
+	 *                         for. Defaults to all (for the given context)
2554
+	 * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
2555
+	 * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
2556
+	 *                         true just an array of shortcode/label pairs.
2557
+	 * @throws EE_Error
2558
+	 * @throws InvalidArgumentException
2559
+	 * @throws ReflectionException
2560
+	 * @throws InvalidDataTypeException
2561
+	 * @throws InvalidInterfaceException
2562
+	 */
2563
+	protected function _get_shortcodes($fields = array(), $merged = true)
2564
+	{
2565
+		$this->_set_message_template_group();
2566
+
2567
+		// we need the messenger and message template to retrieve the valid shortcodes array.
2568
+		$GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
2569
+			? absint($this->_req_data['id'])
2570
+			: false;
2571
+		$context = isset($this->_req_data['context'])
2572
+			? $this->_req_data['context']
2573
+			: key($this->_message_template_group->contexts_config());
2574
+
2575
+		return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
2576
+	}
2577
+
2578
+
2579
+	/**
2580
+	 * This sets the _message_template property (containing the called message_template object)
2581
+	 *
2582
+	 * @access protected
2583
+	 * @return void
2584
+	 * @throws EE_Error
2585
+	 * @throws InvalidArgumentException
2586
+	 * @throws ReflectionException
2587
+	 * @throws InvalidDataTypeException
2588
+	 * @throws InvalidInterfaceException
2589
+	 */
2590
+	protected function _set_message_template_group()
2591
+	{
2592
+
2593
+		if (! empty($this->_message_template_group)) {
2594
+			return;
2595
+		} //get out if this is already set.
2596
+
2597
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
2598
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
2599
+
2600
+		// let's get the message templates
2601
+		$MTP = EEM_Message_Template_Group::instance();
2602
+
2603
+		if (empty($GRP_ID)) {
2604
+			$this->_message_template_group = $MTP->create_default_object();
2605
+		} else {
2606
+			$this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
2607
+		}
2608
+
2609
+		$this->_template_pack = $this->_message_template_group->get_template_pack();
2610
+		$this->_variation = $this->_message_template_group->get_template_pack_variation();
2611
+	}
2612
+
2613
+
2614
+	/**
2615
+	 * sets up a context switcher for edit forms
2616
+	 *
2617
+	 * @access  protected
2618
+	 * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
2619
+	 * @param array                      $args                  various things the context switcher needs.
2620
+	 * @throws EE_Error
2621
+	 */
2622
+	protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
2623
+	{
2624
+		$context_details = $template_group_object->contexts_config();
2625
+		$context_label = $template_group_object->context_label();
2626
+		ob_start();
2627
+		?>
2628 2628
         <div class="ee-msg-switcher-container">
2629 2629
             <form method="get" action="<?php echo EE_MSG_ADMIN_URL; ?>" id="ee-msg-context-switcher-frm">
2630 2630
                 <?php
2631
-                foreach ($args as $name => $value) {
2632
-                    if ($name === 'context' || empty($value) || $name === 'extra') {
2633
-                        continue;
2634
-                    }
2635
-                    ?>
2631
+				foreach ($args as $name => $value) {
2632
+					if ($name === 'context' || empty($value) || $name === 'extra') {
2633
+						continue;
2634
+					}
2635
+					?>
2636 2636
                     <input type="hidden" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/>
2637 2637
                     <?php
2638
-                }
2639
-                // setup nonce_url
2640
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
2641
-                ?>
2638
+				}
2639
+				// setup nonce_url
2640
+				wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
2641
+				?>
2642 2642
                 <select name="context">
2643 2643
                     <?php
2644
-                    $context_templates = $template_group_object->context_templates();
2645
-                    if (is_array($context_templates)) :
2646
-                        foreach ($context_templates as $context => $template_fields) :
2647
-                            $checked = ($context === $args['context']) ? 'selected="selected"' : '';
2648
-                            ?>
2644
+					$context_templates = $template_group_object->context_templates();
2645
+					if (is_array($context_templates)) :
2646
+						foreach ($context_templates as $context => $template_fields) :
2647
+							$checked = ($context === $args['context']) ? 'selected="selected"' : '';
2648
+							?>
2649 2649
                             <option value="<?php echo $context; ?>" <?php echo $checked; ?>>
2650 2650
                                 <?php echo $context_details[ $context ]['label']; ?>
2651 2651
                             </option>
2652 2652
                         <?php endforeach;
2653
-                    endif; ?>
2653
+					endif; ?>
2654 2654
                 </select>
2655 2655
                 <?php $button_text = sprintf(__('Switch %s', 'event_espresso'), ucwords($context_label['label'])); ?>
2656 2656
                 <input id="submit-msg-context-switcher-sbmt" class="button-secondary" type="submit"
@@ -2659,1925 +2659,1925 @@  discard block
 block discarded – undo
2659 2659
             <?php echo $args['extra']; ?>
2660 2660
         </div> <!-- end .ee-msg-switcher-container -->
2661 2661
         <?php
2662
-        $output = ob_get_contents();
2663
-        ob_clean();
2664
-        $this->_context_switcher = $output;
2665
-    }
2666
-
2667
-
2668
-    /**
2669
-     * utility for sanitizing new values coming in.
2670
-     * Note: this is only used when updating a context.
2671
-     *
2672
-     * @access protected
2673
-     *
2674
-     * @param int $index This helps us know which template field to select from the request array.
2675
-     *
2676
-     * @return array
2677
-     */
2678
-    protected function _set_message_template_column_values($index)
2679
-    {
2680
-        if (is_array($this->_req_data['MTP_template_fields'][ $index ]['content'])) {
2681
-            foreach ($this->_req_data['MTP_template_fields'][ $index ]['content'] as $field => $value) {
2682
-                $this->_req_data['MTP_template_fields'][ $index ]['content'][ $field ] = $value;
2683
-            }
2684
-        }
2685
-
2686
-
2687
-        $set_column_values = array(
2688
-            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][ $index ]['MTP_ID']),
2689
-            'GRP_ID'             => absint($this->_req_data['GRP_ID']),
2690
-            'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
2691
-            'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
2692
-            'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
2693
-            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][ $index ]['name']),
2694
-            'MTP_context'        => strtolower($this->_req_data['MTP_context']),
2695
-            'MTP_content'        => $this->_req_data['MTP_template_fields'][ $index ]['content'],
2696
-            'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
2697
-                ? absint($this->_req_data['MTP_is_global'])
2698
-                : 0,
2699
-            'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
2700
-                ? absint($this->_req_data['MTP_is_override'])
2701
-                : 0,
2702
-            'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
2703
-            'MTP_is_active'      => absint($this->_req_data['MTP_is_active']),
2704
-        );
2705
-
2706
-
2707
-        return $set_column_values;
2708
-    }
2709
-
2710
-
2711
-    protected function _insert_or_update_message_template($new = false)
2712
-    {
2713
-
2714
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2715
-        $success = 0;
2716
-        $override = false;
2717
-
2718
-        // setup notices description
2719
-        $messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
2720
-
2721
-        // need the message type and messenger objects to be able to use the labels for the notices
2722
-        $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
2723
-        $messenger_label = $messenger_object instanceof EE_messenger
2724
-            ? ucwords($messenger_object->label['singular'])
2725
-            : '';
2726
-
2727
-        $message_type_slug = ! empty($this->_req_data['MTP_message_type'])
2728
-            ? $this->_req_data['MTP_message_type']
2729
-            : '';
2730
-        $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
2731
-
2732
-        $message_type_label = $message_type_object instanceof EE_message_type
2733
-            ? ucwords($message_type_object->label['singular'])
2734
-            : '';
2735
-
2736
-        $context_slug = ! empty($this->_req_data['MTP_context'])
2737
-            ? $this->_req_data['MTP_context']
2738
-            : '';
2739
-        $context = ucwords(str_replace('_', ' ', $context_slug));
2740
-
2741
-        $item_desc = $messenger_label && $message_type_label
2742
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
2743
-            : '';
2744
-        $item_desc .= 'Message Template';
2745
-        $query_args = array();
2746
-        $edit_array = array();
2747
-        $action_desc = '';
2748
-
2749
-        // if this is "new" then we need to generate the default contexts for the selected messenger/message_type for
2750
-        // user to edit.
2751
-        if ($new) {
2752
-            $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2753
-            if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
2754
-                if (empty($edit_array)) {
2755
-                    $success = 0;
2756
-                } else {
2757
-                    $success = 1;
2758
-                    $edit_array = $edit_array[0];
2759
-                    $query_args = array(
2760
-                        'id'      => $edit_array['GRP_ID'],
2761
-                        'context' => $edit_array['MTP_context'],
2762
-                        'action'  => 'edit_message_template',
2763
-                    );
2764
-                }
2765
-            }
2766
-            $action_desc = 'created';
2767
-        } else {
2768
-            $MTPG = EEM_Message_Template_Group::instance();
2769
-            $MTP = EEM_Message_Template::instance();
2770
-
2771
-
2772
-            // run update for each template field in displayed context
2773
-            if (! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
2774
-                EE_Error::add_error(
2775
-                    esc_html__(
2776
-                        'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
2777
-                        'event_espresso'
2778
-                    ),
2779
-                    __FILE__,
2780
-                    __FUNCTION__,
2781
-                    __LINE__
2782
-                );
2783
-                $success = 0;
2784
-            } else {
2785
-                // first validate all fields!
2786
-                // this filter allows client code to add its own validation to the template fields as well.
2787
-                // returning an empty array means everything passed validation.
2788
-                // errors in validation should be represented in an array with the following shape:
2789
-                // array(
2790
-                //   'fieldname' => array(
2791
-                //          'msg' => 'error message'
2792
-                //          'value' => 'value for field producing error'
2793
-                // )
2794
-                $custom_validation = (array) apply_filters(
2795
-                    'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
2796
-                    array(),
2797
-                    $this->_req_data['MTP_template_fields'],
2798
-                    $context_slug,
2799
-                    $messenger_slug,
2800
-                    $message_type_slug
2801
-                );
2802
-
2803
-                $system_validation = $MTPG->validate(
2804
-                    $this->_req_data['MTP_template_fields'],
2805
-                    $context_slug,
2806
-                    $messenger_slug,
2807
-                    $message_type_slug
2808
-                );
2809
-
2810
-                $system_validation = ! is_array($system_validation) && $system_validation ? array()
2811
-                    : $system_validation;
2812
-                $validates = array_merge($custom_validation, $system_validation);
2813
-
2814
-                // if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
2815
-                // appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
2816
-                //  WE need to make sure there is no actual error messages in validates.
2817
-                if (is_array($validates) && ! empty($validates)) {
2818
-                    // add the transient so when the form loads we know which fields to highlight
2819
-                    $this->_add_transient('edit_message_template', $validates);
2820
-
2821
-                    $success = 0;
2822
-
2823
-                    // setup notices
2824
-                    foreach ($validates as $field => $error) {
2825
-                        if (isset($error['msg'])) {
2826
-                            EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
2827
-                        }
2828
-                    }
2829
-                } else {
2830
-                    $set_column_values = array();
2831
-                    foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
2832
-                        $set_column_values = $this->_set_message_template_column_values($template_field);
2833
-
2834
-                        $where_cols_n_values = array(
2835
-                            'MTP_ID' => $this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'],
2836
-                        );
2837
-                        // if they aren't allowed to use all JS, restrict them to just posty-y tags
2838
-                        if (! current_user_can('unfiltered_html')) {
2839
-                            if (is_array($set_column_values['MTP_content'])) {
2840
-                                foreach ($set_column_values['MTP_content'] as $key => $value) {
2841
-                                    // remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
2842
-                                    // only removes slashes from double-quotes, so attributes using single quotes always
2843
-                                    // appear invalid.) But currently the models expect slashed data, so after wp_kses
2844
-                                    // runs we need to re-slash the data. Sheesh. See
2845
-                                    // https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
2846
-                                    $set_column_values['MTP_content'][ $key ] = addslashes(
2847
-                                        wp_kses(
2848
-                                            stripslashes($value),
2849
-                                            wp_kses_allowed_html('post')
2850
-                                        )
2851
-                                    );
2852
-                                }
2853
-                            } else {
2854
-                                $set_column_values['MTP_content'] = wp_kses(
2855
-                                    $set_column_values['MTP_content'],
2856
-                                    wp_kses_allowed_html('post')
2857
-                                );
2858
-                            }
2859
-                        }
2860
-                        $message_template_fields = array(
2861
-                            'GRP_ID'             => $set_column_values['GRP_ID'],
2862
-                            'MTP_template_field' => $set_column_values['MTP_template_field'],
2863
-                            'MTP_context'        => $set_column_values['MTP_context'],
2864
-                            'MTP_content'        => $set_column_values['MTP_content'],
2865
-                        );
2866
-                        if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
2867
-                            if ($updated === false) {
2868
-                                EE_Error::add_error(
2869
-                                    sprintf(
2870
-                                        esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
2871
-                                        $template_field
2872
-                                    ),
2873
-                                    __FILE__,
2874
-                                    __FUNCTION__,
2875
-                                    __LINE__
2876
-                                );
2877
-                            } else {
2878
-                                $success = 1;
2879
-                            }
2880
-                        } else {
2881
-                            // only do this logic if we don't have a MTP_ID for this field
2882
-                            if (empty($this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'])) {
2883
-                                // this has already been through the template field validator and sanitized, so it will be
2884
-                                // safe to insert this field.  Why insert?  This typically happens when we introduce a new
2885
-                                // message template field in a messenger/message type and existing users don't have the
2886
-                                // default setup for it.
2887
-                                // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
2888
-                                $updated = $MTP->insert($message_template_fields);
2889
-                                if (! $updated || is_wp_error($updated)) {
2890
-                                    EE_Error::add_error(
2891
-                                        sprintf(
2892
-                                            esc_html__('%s field could not be updated.', 'event_espresso'),
2893
-                                            $template_field
2894
-                                        ),
2895
-                                        __FILE__,
2896
-                                        __FUNCTION__,
2897
-                                        __LINE__
2898
-                                    );
2899
-                                    $success = 0;
2900
-                                } else {
2901
-                                    $success = 1;
2902
-                                }
2903
-                            }
2904
-                        }
2905
-                        $action_desc = 'updated';
2906
-                    }
2907
-
2908
-                    // we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
2909
-                    $mtpg_fields = array(
2910
-                        'MTP_user_id'      => $set_column_values['MTP_user_id'],
2911
-                        'MTP_messenger'    => $set_column_values['MTP_messenger'],
2912
-                        'MTP_message_type' => $set_column_values['MTP_message_type'],
2913
-                        'MTP_is_global'    => $set_column_values['MTP_is_global'],
2914
-                        'MTP_is_override'  => $set_column_values['MTP_is_override'],
2915
-                        'MTP_deleted'      => $set_column_values['MTP_deleted'],
2916
-                        'MTP_is_active'    => $set_column_values['MTP_is_active'],
2917
-                        'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
2918
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
2919
-                            : '',
2920
-                        'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
2921
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
2922
-                            : '',
2923
-                    );
2924
-
2925
-                    $mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
2926
-                    $updated = $MTPG->update($mtpg_fields, array($mtpg_where));
2927
-
2928
-                    if ($updated === false) {
2929
-                        EE_Error::add_error(
2930
-                            sprintf(
2931
-                                esc_html__(
2932
-                                    'The Message Template Group (%d) was NOT updated for some reason',
2933
-                                    'event_espresso'
2934
-                                ),
2935
-                                $set_column_values['GRP_ID']
2936
-                            ),
2937
-                            __FILE__,
2938
-                            __FUNCTION__,
2939
-                            __LINE__
2940
-                        );
2941
-                    } else {
2942
-                        // k now we need to ensure the template_pack and template_variation fields are set.
2943
-                        $template_pack = ! empty($this->_req_data['MTP_template_pack'])
2944
-                            ? $this->_req_data['MTP_template_pack']
2945
-                            : 'default';
2946
-
2947
-                        $template_variation = ! empty($this->_req_data['MTP_template_variation'])
2948
-                            ? $this->_req_data['MTP_template_variation']
2949
-                            : 'default';
2950
-
2951
-                        $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
2952
-                        if ($mtpg_obj instanceof EE_Message_Template_Group) {
2953
-                            $mtpg_obj->set_template_pack_name($template_pack);
2954
-                            $mtpg_obj->set_template_pack_variation($template_variation);
2955
-                        }
2956
-                        $success = 1;
2957
-                    }
2958
-                }
2959
-            }
2960
-        }
2961
-
2962
-        // we return things differently if doing ajax
2963
-        if (defined('DOING_AJAX') && DOING_AJAX) {
2964
-            $this->_template_args['success'] = $success;
2965
-            $this->_template_args['error'] = ! $success ? true : false;
2966
-            $this->_template_args['content'] = '';
2967
-            $this->_template_args['data'] = array(
2968
-                'grpID'        => $edit_array['GRP_ID'],
2969
-                'templateName' => $edit_array['template_name'],
2970
-            );
2971
-            if ($success) {
2972
-                EE_Error::overwrite_success();
2973
-                EE_Error::add_success(
2974
-                    esc_html__(
2975
-                        'The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
2976
-                        'event_espresso'
2977
-                    )
2978
-                );
2979
-            }
2980
-
2981
-            $this->_return_json();
2982
-        }
2983
-
2984
-
2985
-        // was a test send triggered?
2986
-        if (isset($this->_req_data['test_button'])) {
2987
-            EE_Error::overwrite_success();
2988
-            $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
2989
-            $override = true;
2990
-        }
2991
-
2992
-        if (empty($query_args)) {
2993
-            $query_args = array(
2994
-                'id'      => $this->_req_data['GRP_ID'],
2995
-                'context' => $context_slug,
2996
-                'action'  => 'edit_message_template',
2997
-            );
2998
-        }
2999
-
3000
-        $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
3001
-    }
3002
-
3003
-
3004
-    /**
3005
-     * processes a test send request to do an actual messenger delivery test for the given message template being tested
3006
-     *
3007
-     * @param  string $context      what context being tested
3008
-     * @param  string $messenger    messenger being tested
3009
-     * @param  string $message_type message type being tested
3010
-     * @throws EE_Error
3011
-     * @throws InvalidArgumentException
3012
-     * @throws InvalidDataTypeException
3013
-     * @throws InvalidInterfaceException
3014
-     */
3015
-    protected function _do_test_send($context, $messenger, $message_type)
3016
-    {
3017
-        // set things up for preview
3018
-        $this->_req_data['messenger'] = $messenger;
3019
-        $this->_req_data['message_type'] = $message_type;
3020
-        $this->_req_data['context'] = $context;
3021
-        $this->_req_data['GRP_ID'] = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
3022
-        $active_messenger = $this->_message_resource_manager->get_active_messenger($messenger);
3023
-
3024
-        // let's save any existing fields that might be required by the messenger
3025
-        if (isset($this->_req_data['test_settings_fld'])
3026
-            && $active_messenger instanceof EE_messenger
3027
-            && apply_filters(
3028
-                'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
3029
-                true,
3030
-                $this->_req_data['test_settings_fld'],
3031
-                $active_messenger
3032
-            )
3033
-        ) {
3034
-            $active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
3035
-        }
3036
-
3037
-        /**
3038
-         * Use filter to add additional controls on whether message can send or not
3039
-         */
3040
-        if (apply_filters(
3041
-            'FHEE__Messages_Admin_Page__do_test_send__can_send',
3042
-            true,
3043
-            $context,
3044
-            $this->_req_data,
3045
-            $messenger,
3046
-            $message_type
3047
-        )) {
3048
-            if (EEM_Event::instance()->count() > 0) {
3049
-                $success = $this->_preview_message(true);
3050
-                if ($success) {
3051
-                    EE_Error::add_success(__('Test message sent', 'event_espresso'));
3052
-                } else {
3053
-                    EE_Error::add_error(
3054
-                        esc_html__('The test message was not sent', 'event_espresso'),
3055
-                        __FILE__,
3056
-                        __FUNCTION__,
3057
-                        __LINE__
3058
-                    );
3059
-                }
3060
-            } else {
3061
-                $this->noEventsErrorMessage(true);
3062
-            }
3063
-        }
3064
-    }
3065
-
3066
-
3067
-    /**
3068
-     * _generate_new_templates
3069
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
3070
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
3071
-     * for the event.
3072
-     *
3073
-     *
3074
-     * @param  string $messenger     the messenger we are generating templates for
3075
-     * @param array   $message_types array of message types that the templates are generated for.
3076
-     * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
3077
-     *                               indicate the message_template_group being used as the base.
3078
-     *
3079
-     * @param bool    $global
3080
-     *
3081
-     * @return array|bool array of data required for the redirect to the correct edit page or bool if
3082
-     *                               encountering problems.
3083
-     * @throws EE_Error
3084
-     */
3085
-    protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
3086
-    {
3087
-
3088
-        // if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
3089
-        // just don't generate any templates.
3090
-        if (empty($message_types)) {
3091
-            return true;
3092
-        }
3093
-
3094
-        return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
3095
-    }
3096
-
3097
-
3098
-    /**
3099
-     * [_trash_or_restore_message_template]
3100
-     *
3101
-     * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
3102
-     * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
3103
-     *                        an individual context (FALSE).
3104
-     * @return void
3105
-     * @throws EE_Error
3106
-     * @throws InvalidArgumentException
3107
-     * @throws InvalidDataTypeException
3108
-     * @throws InvalidInterfaceException
3109
-     */
3110
-    protected function _trash_or_restore_message_template($trash = true, $all = false)
3111
-    {
3112
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3113
-        $MTP = EEM_Message_Template_Group::instance();
3114
-
3115
-        $success = 1;
3116
-
3117
-        // incoming GRP_IDs
3118
-        if ($all) {
3119
-            // Checkboxes
3120
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3121
-                // if array has more than one element then success message should be plural.
3122
-                // todo: what about nonce?
3123
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3124
-
3125
-                // cycle through checkboxes
3126
-                while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3127
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3128
-                    if (! $trashed_or_restored) {
3129
-                        $success = 0;
3130
-                    }
3131
-                }
3132
-            } else {
3133
-                // grab single GRP_ID and handle
3134
-                $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
3135
-                if (! empty($GRP_ID)) {
3136
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3137
-                    if (! $trashed_or_restored) {
3138
-                        $success = 0;
3139
-                    }
3140
-                } else {
3141
-                    $success = 0;
3142
-                }
3143
-            }
3144
-        }
3145
-
3146
-        $action_desc = $trash
3147
-            ? esc_html__('moved to the trash', 'event_espresso')
3148
-            : esc_html__('restored', 'event_espresso');
3149
-
3150
-        $action_desc = ! empty($this->_req_data['template_switch']) ? esc_html__('switched', 'event_espresso') : $action_desc;
3151
-
3152
-        $item_desc = $all ? _n(
3153
-            'Message Template Group',
3154
-            'Message Template Groups',
3155
-            $success,
3156
-            'event_espresso'
3157
-        ) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
3158
-
3159
-        $item_desc = ! empty($this->_req_data['template_switch']) ? _n(
3160
-            'template',
3161
-            'templates',
3162
-            $success,
3163
-            'event_espresso'
3164
-        ) : $item_desc;
3165
-
3166
-        $this->_redirect_after_action($success, $item_desc, $action_desc, array());
3167
-    }
3168
-
3169
-
3170
-    /**
3171
-     * [_delete_message_template]
3172
-     * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
3173
-     *
3174
-     * @return void
3175
-     * @throws EE_Error
3176
-     * @throws InvalidArgumentException
3177
-     * @throws InvalidDataTypeException
3178
-     * @throws InvalidInterfaceException
3179
-     */
3180
-    protected function _delete_message_template()
3181
-    {
3182
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3183
-
3184
-        // checkboxes
3185
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3186
-            // if array has more than one element then success message should be plural
3187
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3188
-
3189
-            // cycle through bulk action checkboxes
3190
-            while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3191
-                $success = $this->_delete_mtp_permanently($GRP_ID);
3192
-            }
3193
-        } else {
3194
-            // grab single grp_id and delete
3195
-            $GRP_ID = absint($this->_req_data['id']);
3196
-            $success = $this->_delete_mtp_permanently($GRP_ID);
3197
-        }
3198
-
3199
-        $this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
3200
-    }
3201
-
3202
-
3203
-    /**
3204
-     * helper for permanently deleting a mtP group and all related message_templates
3205
-     *
3206
-     * @param  int  $GRP_ID        The group being deleted
3207
-     * @param  bool $include_group whether to delete the Message Template Group as well.
3208
-     * @return bool boolean to indicate the success of the deletes or not.
3209
-     * @throws EE_Error
3210
-     * @throws InvalidArgumentException
3211
-     * @throws InvalidDataTypeException
3212
-     * @throws InvalidInterfaceException
3213
-     */
3214
-    private function _delete_mtp_permanently($GRP_ID, $include_group = true)
3215
-    {
3216
-        $success = 1;
3217
-        $MTPG = EEM_Message_Template_Group::instance();
3218
-        // first let's GET this group
3219
-        $MTG = $MTPG->get_one_by_ID($GRP_ID);
3220
-        // then delete permanently all the related Message Templates
3221
-        $deleted = $MTG->delete_related_permanently('Message_Template');
3222
-
3223
-        if ($deleted === 0) {
3224
-            $success = 0;
3225
-        }
3226
-
3227
-        // now delete permanently this particular group
3228
-
3229
-        if ($include_group && ! $MTG->delete_permanently()) {
3230
-            $success = 0;
3231
-        }
3232
-
3233
-        return $success;
3234
-    }
3235
-
3236
-
3237
-    /**
3238
-     *    _learn_more_about_message_templates_link
3239
-     *
3240
-     * @access protected
3241
-     * @return string
3242
-     */
3243
-    protected function _learn_more_about_message_templates_link()
3244
-    {
3245
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
3246
-               . esc_html__('learn more about how message templates works', 'event_espresso')
3247
-               . '</a>';
3248
-    }
3249
-
3250
-
3251
-    /**
3252
-     * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
3253
-     * ajax and other routes.
3254
-     *
3255
-     * @return void
3256
-     * @throws DomainException
3257
-     */
3258
-    protected function _settings()
3259
-    {
3260
-
3261
-
3262
-        $this->_set_m_mt_settings();
3263
-
3264
-        $selected_messenger = isset($this->_req_data['selected_messenger'])
3265
-            ? $this->_req_data['selected_messenger']
3266
-            : 'email';
3267
-
3268
-        // let's setup the messenger tabs
3269
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
3270
-            $this->_m_mt_settings['messenger_tabs'],
3271
-            'messenger_links',
3272
-            '|',
3273
-            $selected_messenger
3274
-        );
3275
-        $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
3276
-        $this->_template_args['after_admin_page_content'] = '</div><!-- end .ui-widget -->';
3277
-
3278
-        $this->display_admin_page_with_sidebar();
3279
-    }
3280
-
3281
-
3282
-    /**
3283
-     * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
3284
-     *
3285
-     * @access protected
3286
-     * @return void
3287
-     * @throws DomainException
3288
-     */
3289
-    protected function _set_m_mt_settings()
3290
-    {
3291
-        // first if this is already set then lets get out no need to regenerate data.
3292
-        if (! empty($this->_m_mt_settings)) {
3293
-            return;
3294
-        }
3295
-
3296
-        // get all installed messengers and message_types
3297
-        /** @type EE_messenger[] $messengers */
3298
-        $messengers = $this->_message_resource_manager->installed_messengers();
3299
-        /** @type EE_message_type[] $message_types */
3300
-        $message_types = $this->_message_resource_manager->installed_message_types();
3301
-
3302
-
3303
-        // assemble the array for the _tab_text_links helper
3304
-
3305
-        foreach ($messengers as $messenger) {
3306
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = array(
3307
-                'label' => ucwords($messenger->label['singular']),
3308
-                'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
3309
-                    ? 'messenger-active'
3310
-                    : '',
3311
-                'href'  => $messenger->name,
3312
-                'title' => esc_html__('Modify this Messenger', 'event_espresso'),
3313
-                'slug'  => $messenger->name,
3314
-                'obj'   => $messenger,
3315
-            );
3316
-
3317
-
3318
-            $message_types_for_messenger = $messenger->get_valid_message_types();
3319
-
3320
-            foreach ($message_types as $message_type) {
3321
-                // first we need to verify that this message type is valid with this messenger. Cause if it isn't then
3322
-                // it shouldn't show in either the inactive OR active metabox.
3323
-                if (! in_array($message_type->name, $message_types_for_messenger, true)) {
3324
-                    continue;
3325
-                }
3326
-
3327
-                $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
3328
-                    $messenger->name,
3329
-                    $message_type->name
3330
-                )
3331
-                    ? 'active'
3332
-                    : 'inactive';
3333
-
3334
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = array(
3335
-                    'label'    => ucwords($message_type->label['singular']),
3336
-                    'class'    => 'message-type-' . $a_or_i,
3337
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
3338
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
3339
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
3340
-                    'title'    => $a_or_i === 'active'
3341
-                        ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
3342
-                        : esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
3343
-                    'content'  => $a_or_i === 'active'
3344
-                        ? $this->_message_type_settings_content($message_type, $messenger, true)
3345
-                        : $this->_message_type_settings_content($message_type, $messenger),
3346
-                    'slug'     => $message_type->name,
3347
-                    'active'   => $a_or_i === 'active',
3348
-                    'obj'      => $message_type,
3349
-                );
3350
-            }
3351
-        }
3352
-    }
3353
-
3354
-
3355
-    /**
3356
-     * This just prepares the content for the message type settings
3357
-     *
3358
-     * @param  EE_message_type $message_type The message type object
3359
-     * @param  EE_messenger    $messenger    The messenger object
3360
-     * @param  boolean         $active       Whether the message type is active or not
3361
-     * @return string html output for the content
3362
-     * @throws DomainException
3363
-     */
3364
-    protected function _message_type_settings_content($message_type, $messenger, $active = false)
3365
-    {
3366
-        // get message type fields
3367
-        $fields = $message_type->get_admin_settings_fields();
3368
-        $settings_template_args['template_form_fields'] = '';
3369
-
3370
-        if (! empty($fields) && $active) {
3371
-            $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
3372
-            foreach ($fields as $fldname => $fldprops) {
3373
-                $field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname;
3374
-                $template_form_field[ $field_id ] = array(
3375
-                    'name'       => 'message_type_settings[' . $fldname . ']',
3376
-                    'label'      => $fldprops['label'],
3377
-                    'input'      => $fldprops['field_type'],
3378
-                    'type'       => $fldprops['value_type'],
3379
-                    'required'   => $fldprops['required'],
3380
-                    'validation' => $fldprops['validation'],
3381
-                    'value'      => isset($existing_settings[ $fldname ])
3382
-                        ? $existing_settings[ $fldname ]
3383
-                        : $fldprops['default'],
3384
-                    'options'    => isset($fldprops['options'])
3385
-                        ? $fldprops['options']
3386
-                        : array(),
3387
-                    'default'    => isset($existing_settings[ $fldname ])
3388
-                        ? $existing_settings[ $fldname ]
3389
-                        : $fldprops['default'],
3390
-                    'css_class'  => 'no-drag',
3391
-                    'format'     => $fldprops['format'],
3392
-                );
3393
-            }
3394
-
3395
-
3396
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
3397
-                ? $this->_generate_admin_form_fields(
3398
-                    $template_form_field,
3399
-                    'string',
3400
-                    'ee_mt_activate_form'
3401
-                )
3402
-                : '';
3403
-        }
3404
-
3405
-        $settings_template_args['description'] = $message_type->description;
3406
-        // we also need some hidden fields
3407
-        $settings_template_args['hidden_fields'] = array(
3408
-            'message_type_settings[messenger]'    => array(
3409
-                'type'  => 'hidden',
3410
-                'value' => $messenger->name,
3411
-            ),
3412
-            'message_type_settings[message_type]' => array(
3413
-                'type'  => 'hidden',
3414
-                'value' => $message_type->name,
3415
-            ),
3416
-            'type'                                => array(
3417
-                'type'  => 'hidden',
3418
-                'value' => 'message_type',
3419
-            ),
3420
-        );
3421
-
3422
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
3423
-            $settings_template_args['hidden_fields'],
3424
-            'array'
3425
-        );
3426
-        $settings_template_args['show_form'] = empty($settings_template_args['template_form_fields'])
3427
-            ? ' hidden'
3428
-            : '';
3429
-
3430
-
3431
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
3432
-        $content = EEH_Template::display_template($template, $settings_template_args, true);
3433
-
3434
-        return $content;
3435
-    }
3436
-
3437
-
3438
-    /**
3439
-     * Generate all the metaboxes for the message types and register them for the messages settings page.
3440
-     *
3441
-     * @access protected
3442
-     * @return void
3443
-     * @throws DomainException
3444
-     */
3445
-    protected function _messages_settings_metaboxes()
3446
-    {
3447
-        $this->_set_m_mt_settings();
3448
-        $m_boxes = $mt_boxes = array();
3449
-        $m_template_args = $mt_template_args = array();
3450
-
3451
-        $selected_messenger = isset($this->_req_data['selected_messenger'])
3452
-            ? $this->_req_data['selected_messenger']
3453
-            : 'email';
3454
-
3455
-        if (isset($this->_m_mt_settings['messenger_tabs'])) {
3456
-            foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
3457
-                $hide_on_message = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
3458
-                $hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
3459
-                // messenger meta boxes
3460
-                $active = $selected_messenger === $messenger;
3461
-                $active_mt_tabs = isset(
3462
-                    $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3463
-                )
3464
-                    ? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3465
-                    : '';
3466
-                $m_boxes[ $messenger . '_a_box' ] = sprintf(
3467
-                    esc_html__('%s Settings', 'event_espresso'),
3468
-                    $tab_array['label']
3469
-                );
3470
-                $m_template_args[ $messenger . '_a_box' ] = array(
3471
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3472
-                    'inactive_message_types' => isset(
3473
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3474
-                    )
3475
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3476
-                        : '',
3477
-                    'content'                => $this->_get_messenger_box_content($tab_array['obj']),
3478
-                    'hidden'                 => $active ? '' : ' hidden',
3479
-                    'hide_on_message'        => $hide_on_message,
3480
-                    'messenger'              => $messenger,
3481
-                    'active'                 => $active,
3482
-                );
3483
-                // message type meta boxes
3484
-                // (which is really just the inactive container for each messenger
3485
-                // showing inactive message types for that messenger)
3486
-                $mt_boxes[ $messenger . '_i_box' ] = esc_html__('Inactive Message Types', 'event_espresso');
3487
-                $mt_template_args[ $messenger . '_i_box' ] = array(
3488
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3489
-                    'inactive_message_types' => isset(
3490
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3491
-                    )
3492
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3493
-                        : '',
3494
-                    'hidden'                 => $active ? '' : ' hidden',
3495
-                    'hide_on_message'        => $hide_on_message,
3496
-                    'hide_off_message'       => $hide_off_message,
3497
-                    'messenger'              => $messenger,
3498
-                    'active'                 => $active,
3499
-                );
3500
-            }
3501
-        }
3502
-
3503
-
3504
-        // register messenger metaboxes
3505
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
3506
-        foreach ($m_boxes as $box => $label) {
3507
-            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]);
3508
-            $msgr = str_replace('_a_box', '', $box);
3509
-            add_meta_box(
3510
-                'espresso_' . $msgr . '_settings',
3511
-                $label,
3512
-                function ($post, $metabox) {
3513
-                    echo EEH_Template::display_template(
3514
-                        $metabox["args"]["template_path"],
3515
-                        $metabox["args"]["template_args"],
3516
-                        true
3517
-                    );
3518
-                },
3519
-                $this->_current_screen->id,
3520
-                'normal',
3521
-                'high',
3522
-                $callback_args
3523
-            );
3524
-        }
3525
-
3526
-        // register message type metaboxes
3527
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
3528
-        foreach ($mt_boxes as $box => $label) {
3529
-            $callback_args = array(
3530
-                'template_path' => $mt_template_path,
3531
-                'template_args' => $mt_template_args[ $box ],
3532
-            );
3533
-            $mt = str_replace('_i_box', '', $box);
3534
-            add_meta_box(
3535
-                'espresso_' . $mt . '_inactive_mts',
3536
-                $label,
3537
-                function ($post, $metabox) {
3538
-                    echo EEH_Template::display_template(
3539
-                        $metabox["args"]["template_path"],
3540
-                        $metabox["args"]["template_args"],
3541
-                        true
3542
-                    );
3543
-                },
3544
-                $this->_current_screen->id,
3545
-                'side',
3546
-                'high',
3547
-                $callback_args
3548
-            );
3549
-        }
3550
-
3551
-        // register metabox for global messages settings but only when on the main site.  On single site installs this
3552
-        // will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
3553
-        if (is_main_site()) {
3554
-            add_meta_box(
3555
-                'espresso_global_message_settings',
3556
-                esc_html__('Global Message Settings', 'event_espresso'),
3557
-                array($this, 'global_messages_settings_metabox_content'),
3558
-                $this->_current_screen->id,
3559
-                'normal',
3560
-                'low',
3561
-                array()
3562
-            );
3563
-        }
3564
-    }
3565
-
3566
-
3567
-    /**
3568
-     *  This generates the content for the global messages settings metabox.
3569
-     *
3570
-     * @return string
3571
-     * @throws EE_Error
3572
-     * @throws InvalidArgumentException
3573
-     * @throws ReflectionException
3574
-     * @throws InvalidDataTypeException
3575
-     * @throws InvalidInterfaceException
3576
-     */
3577
-    public function global_messages_settings_metabox_content()
3578
-    {
3579
-        $form = $this->_generate_global_settings_form();
3580
-        echo $form->form_open(
3581
-            $this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
3582
-            'POST'
3583
-        )
3584
-             . $form->get_html()
3585
-             . $form->form_close();
3586
-    }
3587
-
3588
-
3589
-    /**
3590
-     * This generates and returns the form object for the global messages settings.
3591
-     *
3592
-     * @return EE_Form_Section_Proper
3593
-     * @throws EE_Error
3594
-     * @throws InvalidArgumentException
3595
-     * @throws ReflectionException
3596
-     * @throws InvalidDataTypeException
3597
-     * @throws InvalidInterfaceException
3598
-     */
3599
-    protected function _generate_global_settings_form()
3600
-    {
3601
-        EE_Registry::instance()->load_helper('HTML');
3602
-        /** @var EE_Network_Core_Config $network_config */
3603
-        $network_config = EE_Registry::instance()->NET_CFG->core;
3604
-
3605
-        return new EE_Form_Section_Proper(
3606
-            array(
3607
-                'name'            => 'global_messages_settings',
3608
-                'html_id'         => 'global_messages_settings',
3609
-                'html_class'      => 'form-table',
3610
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
3611
-                'subsections'     => apply_filters(
3612
-                    'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
3613
-                    array(
3614
-                        'do_messages_on_same_request' => new EE_Select_Input(
3615
-                            array(
3616
-                                true  => esc_html__("On the same request", "event_espresso"),
3617
-                                false => esc_html__("On a separate request", "event_espresso"),
3618
-                            ),
3619
-                            array(
3620
-                                'default'         => $network_config->do_messages_on_same_request,
3621
-                                'html_label_text' => esc_html__(
3622
-                                    'Generate and send all messages:',
3623
-                                    'event_espresso'
3624
-                                ),
3625
-                                'html_help_text'  => esc_html__(
3626
-                                    'By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
3627
-                                    'event_espresso'
3628
-                                ),
3629
-                            )
3630
-                        ),
3631
-                        'delete_threshold'            => new EE_Select_Input(
3632
-                            array(
3633
-                                0  => esc_html__('Forever', 'event_espresso'),
3634
-                                3  => esc_html__('3 Months', 'event_espresso'),
3635
-                                6  => esc_html__('6 Months', 'event_espresso'),
3636
-                                9  => esc_html__('9 Months', 'event_espresso'),
3637
-                                12 => esc_html__('12 Months', 'event_espresso'),
3638
-                                24 => esc_html__('24 Months', 'event_espresso'),
3639
-                                36 => esc_html__('36 Months', 'event_espresso'),
3640
-                            ),
3641
-                            array(
3642
-                                'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
3643
-                                'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
3644
-                                'html_help_text'  => esc_html__(
3645
-                                    'You can control how long a record of processed messages is kept via this option.',
3646
-                                    'event_espresso'
3647
-                                ),
3648
-                            )
3649
-                        ),
3650
-                        'update_settings'             => new EE_Submit_Input(
3651
-                            array(
3652
-                                'default'         => esc_html__('Update', 'event_espresso'),
3653
-                                'html_label_text' => '&nbsp',
3654
-                            )
3655
-                        ),
3656
-                    )
3657
-                ),
3658
-            )
3659
-        );
3660
-    }
3661
-
3662
-
3663
-    /**
3664
-     * This handles updating the global settings set on the admin page.
3665
-     *
3666
-     * @throws EE_Error
3667
-     * @throws InvalidDataTypeException
3668
-     * @throws InvalidInterfaceException
3669
-     * @throws InvalidArgumentException
3670
-     * @throws ReflectionException
3671
-     */
3672
-    protected function _update_global_settings()
3673
-    {
3674
-        /** @var EE_Network_Core_Config $network_config */
3675
-        $network_config = EE_Registry::instance()->NET_CFG->core;
3676
-        $messages_config = EE_Registry::instance()->CFG->messages;
3677
-        $form = $this->_generate_global_settings_form();
3678
-        if ($form->was_submitted()) {
3679
-            $form->receive_form_submission();
3680
-            if ($form->is_valid()) {
3681
-                $valid_data = $form->valid_data();
3682
-                foreach ($valid_data as $property => $value) {
3683
-                    $setter = 'set_' . $property;
3684
-                    if (method_exists($network_config, $setter)) {
3685
-                        $network_config->{$setter}($value);
3686
-                    } elseif (property_exists($network_config, $property)
3687
-                        && $network_config->{$property} !== $value
3688
-                    ) {
3689
-                        $network_config->{$property} = $value;
3690
-                    } elseif (property_exists($messages_config, $property)
3691
-                        && $messages_config->{$property} !== $value
3692
-                    ) {
3693
-                        $messages_config->{$property} = $value;
3694
-                    }
3695
-                }
3696
-                // only update if the form submission was valid!
3697
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
3698
-                EE_Registry::instance()->CFG->update_espresso_config();
3699
-                EE_Error::overwrite_success();
3700
-                EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
3701
-            }
3702
-        }
3703
-        $this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
3704
-    }
3705
-
3706
-
3707
-    /**
3708
-     * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
3709
-     *
3710
-     * @param  array $tab_array This is an array of message type tab details used to generate the tabs
3711
-     * @return string html formatted tabs
3712
-     * @throws DomainException
3713
-     */
3714
-    protected function _get_mt_tabs($tab_array)
3715
-    {
3716
-        $tab_array = (array) $tab_array;
3717
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
3718
-        $tabs = '';
3719
-
3720
-        foreach ($tab_array as $tab) {
3721
-            $tabs .= EEH_Template::display_template($template, $tab, true);
3722
-        }
3723
-
3724
-        return $tabs;
3725
-    }
3726
-
3727
-
3728
-    /**
3729
-     * This prepares the content of the messenger meta box admin settings
3730
-     *
3731
-     * @param  EE_messenger $messenger The messenger we're setting up content for
3732
-     * @return string html formatted content
3733
-     * @throws DomainException
3734
-     */
3735
-    protected function _get_messenger_box_content(EE_messenger $messenger)
3736
-    {
3737
-
3738
-        $fields = $messenger->get_admin_settings_fields();
3739
-        $settings_template_args['template_form_fields'] = '';
3740
-
3741
-        // is $messenger active?
3742
-        $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
3743
-
3744
-
3745
-        if (! empty($fields)) {
3746
-            $existing_settings = $messenger->get_existing_admin_settings();
3747
-
3748
-            foreach ($fields as $fldname => $fldprops) {
3749
-                $field_id = $messenger->name . '-' . $fldname;
3750
-                $template_form_field[ $field_id ] = array(
3751
-                    'name'       => 'messenger_settings[' . $field_id . ']',
3752
-                    'label'      => $fldprops['label'],
3753
-                    'input'      => $fldprops['field_type'],
3754
-                    'type'       => $fldprops['value_type'],
3755
-                    'required'   => $fldprops['required'],
3756
-                    'validation' => $fldprops['validation'],
3757
-                    'value'      => isset($existing_settings[ $field_id ])
3758
-                        ? $existing_settings[ $field_id ]
3759
-                        : $fldprops['default'],
3760
-                    'css_class'  => '',
3761
-                    'format'     => $fldprops['format'],
3762
-                );
3763
-            }
3764
-
3765
-
3766
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
3767
-                ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
3768
-                : '';
3769
-        }
3770
-
3771
-        // we also need some hidden fields
3772
-        $settings_template_args['hidden_fields'] = array(
3773
-            'messenger_settings[messenger]' => array(
3774
-                'type'  => 'hidden',
3775
-                'value' => $messenger->name,
3776
-            ),
3777
-            'type'                          => array(
3778
-                'type'  => 'hidden',
3779
-                'value' => 'messenger',
3780
-            ),
3781
-        );
3782
-
3783
-        // make sure any active message types that are existing are included in the hidden fields
3784
-        if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
3785
-            foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
3786
-                $settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = array(
3787
-                    'type'  => 'hidden',
3788
-                    'value' => $mt,
3789
-                );
3790
-            }
3791
-        }
3792
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
3793
-            $settings_template_args['hidden_fields'],
3794
-            'array'
3795
-        );
3796
-        $active = $this->_message_resource_manager->is_messenger_active($messenger->name);
3797
-
3798
-        $settings_template_args['messenger'] = $messenger->name;
3799
-        $settings_template_args['description'] = $messenger->description;
3800
-        $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
3801
-
3802
-
3803
-        $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
3804
-            $messenger->name
3805
-        )
3806
-            ? $settings_template_args['show_hide_edit_form']
3807
-            : ' hidden';
3808
-
3809
-        $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
3810
-            ? ' hidden'
3811
-            : $settings_template_args['show_hide_edit_form'];
3812
-
3813
-
3814
-        $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
3815
-        $settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
3816
-        $settings_template_args['on_off_status'] = $active ? true : false;
3817
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
3818
-        $content = EEH_Template::display_template(
3819
-            $template,
3820
-            $settings_template_args,
3821
-            true
3822
-        );
3823
-
3824
-        return $content;
3825
-    }
3826
-
3827
-
3828
-    /**
3829
-     * used by ajax on the messages settings page to activate|deactivate the messenger
3830
-     *
3831
-     * @throws DomainException
3832
-     * @throws EE_Error
3833
-     * @throws InvalidDataTypeException
3834
-     * @throws InvalidInterfaceException
3835
-     * @throws InvalidArgumentException
3836
-     * @throws ReflectionException
3837
-     */
3838
-    public function activate_messenger_toggle()
3839
-    {
3840
-        $success = true;
3841
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
3842
-        // let's check that we have required data
3843
-        if (! isset($this->_req_data['messenger'])) {
3844
-            EE_Error::add_error(
3845
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3846
-                __FILE__,
3847
-                __FUNCTION__,
3848
-                __LINE__
3849
-            );
3850
-            $success = false;
3851
-        }
3852
-
3853
-        // do a nonce check here since we're not arriving via a normal route
3854
-        $nonce = isset($this->_req_data['activate_nonce'])
3855
-            ? sanitize_text_field($this->_req_data['activate_nonce'])
3856
-            : '';
3857
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
3858
-
3859
-        $this->_verify_nonce($nonce, $nonce_ref);
3860
-
3861
-
3862
-        if (! isset($this->_req_data['status'])) {
3863
-            EE_Error::add_error(
3864
-                esc_html__(
3865
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
3866
-                    'event_espresso'
3867
-                ),
3868
-                __FILE__,
3869
-                __FUNCTION__,
3870
-                __LINE__
3871
-            );
3872
-            $success = false;
3873
-        }
3874
-
3875
-        // do check to verify we have a valid status.
3876
-        $status = $this->_req_data['status'];
3877
-
3878
-        if ($status !== 'off' && $status !== 'on') {
3879
-            EE_Error::add_error(
3880
-                sprintf(
3881
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
3882
-                    $this->_req_data['status']
3883
-                ),
3884
-                __FILE__,
3885
-                __FUNCTION__,
3886
-                __LINE__
3887
-            );
3888
-            $success = false;
3889
-        }
3890
-
3891
-        if ($success) {
3892
-            // made it here?  Stop dawdling then!!
3893
-            $success = $status === 'off'
3894
-                ? $this->_deactivate_messenger($this->_req_data['messenger'])
3895
-                : $this->_activate_messenger($this->_req_data['messenger']);
3896
-        }
3897
-
3898
-        $this->_template_args['success'] = $success;
3899
-
3900
-        // no special instructions so let's just do the json return (which should automatically do all the special stuff).
3901
-        $this->_return_json();
3902
-    }
3903
-
3904
-
3905
-    /**
3906
-     * used by ajax from the messages settings page to activate|deactivate a message type
3907
-     *
3908
-     * @throws DomainException
3909
-     * @throws EE_Error
3910
-     * @throws ReflectionException
3911
-     * @throws InvalidDataTypeException
3912
-     * @throws InvalidInterfaceException
3913
-     * @throws InvalidArgumentException
3914
-     */
3915
-    public function activate_mt_toggle()
3916
-    {
3917
-        $success = true;
3918
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
3919
-
3920
-        // let's make sure we have the necessary data
3921
-        if (! isset($this->_req_data['message_type'])) {
3922
-            EE_Error::add_error(
3923
-                esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
3924
-                __FILE__,
3925
-                __FUNCTION__,
3926
-                __LINE__
3927
-            );
3928
-            $success = false;
3929
-        }
3930
-
3931
-        if (! isset($this->_req_data['messenger'])) {
3932
-            EE_Error::add_error(
3933
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3934
-                __FILE__,
3935
-                __FUNCTION__,
3936
-                __LINE__
3937
-            );
3938
-            $success = false;
3939
-        }
3940
-
3941
-        if (! isset($this->_req_data['status'])) {
3942
-            EE_Error::add_error(
3943
-                esc_html__(
3944
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
3945
-                    'event_espresso'
3946
-                ),
3947
-                __FILE__,
3948
-                __FUNCTION__,
3949
-                __LINE__
3950
-            );
3951
-            $success = false;
3952
-        }
3953
-
3954
-
3955
-        // do check to verify we have a valid status.
3956
-        $status = $this->_req_data['status'];
3957
-
3958
-        if ($status !== 'activate' && $status !== 'deactivate') {
3959
-            EE_Error::add_error(
3960
-                sprintf(
3961
-                    esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
3962
-                    $this->_req_data['status']
3963
-                ),
3964
-                __FILE__,
3965
-                __FUNCTION__,
3966
-                __LINE__
3967
-            );
3968
-            $success = false;
3969
-        }
3970
-
3971
-
3972
-        // do a nonce check here since we're not arriving via a normal route
3973
-        $nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
3974
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
3975
-
3976
-        $this->_verify_nonce($nonce, $nonce_ref);
3977
-
3978
-        if ($success) {
3979
-            // made it here? um, what are you waiting for then?
3980
-            $success = $status === 'deactivate'
3981
-                ? $this->_deactivate_message_type_for_messenger(
3982
-                    $this->_req_data['messenger'],
3983
-                    $this->_req_data['message_type']
3984
-                )
3985
-                : $this->_activate_message_type_for_messenger(
3986
-                    $this->_req_data['messenger'],
3987
-                    $this->_req_data['message_type']
3988
-                );
3989
-        }
3990
-
3991
-        $this->_template_args['success'] = $success;
3992
-        $this->_return_json();
3993
-    }
3994
-
3995
-
3996
-    /**
3997
-     * Takes care of processing activating a messenger and preparing the appropriate response.
3998
-     *
3999
-     * @param string $messenger_name The name of the messenger being activated
4000
-     * @return bool
4001
-     * @throws DomainException
4002
-     * @throws EE_Error
4003
-     * @throws InvalidArgumentException
4004
-     * @throws ReflectionException
4005
-     * @throws InvalidDataTypeException
4006
-     * @throws InvalidInterfaceException
4007
-     */
4008
-    protected function _activate_messenger($messenger_name)
4009
-    {
4010
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4011
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4012
-        $message_types_to_activate = $active_messenger instanceof EE_Messenger
4013
-            ? $active_messenger->get_default_message_types()
4014
-            : array();
4015
-
4016
-        // ensure is active
4017
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
4018
-
4019
-        // set response_data for reload
4020
-        foreach ($message_types_to_activate as $message_type_name) {
4021
-            /** @var EE_message_type $message_type */
4022
-            $message_type = $this->_message_resource_manager->get_message_type($message_type_name);
4023
-            if ($this->_message_resource_manager->is_message_type_active_for_messenger(
4024
-                $messenger_name,
4025
-                $message_type_name
4026
-            )
4027
-                && $message_type instanceof EE_message_type
4028
-            ) {
4029
-                $this->_template_args['data']['active_mts'][] = $message_type_name;
4030
-                if ($message_type->get_admin_settings_fields()) {
4031
-                    $this->_template_args['data']['mt_reload'][] = $message_type_name;
4032
-                }
4033
-            }
4034
-        }
4035
-
4036
-        // add success message for activating messenger
4037
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
4038
-    }
4039
-
4040
-
4041
-    /**
4042
-     * Takes care of processing deactivating a messenger and preparing the appropriate response.
4043
-     *
4044
-     * @param string $messenger_name The name of the messenger being activated
4045
-     * @return bool
4046
-     * @throws DomainException
4047
-     * @throws EE_Error
4048
-     * @throws InvalidArgumentException
4049
-     * @throws ReflectionException
4050
-     * @throws InvalidDataTypeException
4051
-     * @throws InvalidInterfaceException
4052
-     */
4053
-    protected function _deactivate_messenger($messenger_name)
4054
-    {
4055
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4056
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4057
-        $this->_message_resource_manager->deactivate_messenger($messenger_name);
4058
-
4059
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
4060
-    }
4061
-
4062
-
4063
-    /**
4064
-     * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
4065
-     *
4066
-     * @param string $messenger_name    The name of the messenger the message type is being activated for.
4067
-     * @param string $message_type_name The name of the message type being activated for the messenger
4068
-     * @return bool
4069
-     * @throws DomainException
4070
-     * @throws EE_Error
4071
-     * @throws InvalidArgumentException
4072
-     * @throws ReflectionException
4073
-     * @throws InvalidDataTypeException
4074
-     * @throws InvalidInterfaceException
4075
-     */
4076
-    protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
4077
-    {
4078
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4079
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4080
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
4081
-        $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
4082
-
4083
-        // ensure is active
4084
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
4085
-
4086
-        // set response for load
4087
-        if ($this->_message_resource_manager->is_message_type_active_for_messenger(
4088
-            $messenger_name,
4089
-            $message_type_name
4090
-        )
4091
-        ) {
4092
-            $this->_template_args['data']['active_mts'][] = $message_type_name;
4093
-            if ($message_type_to_activate->get_admin_settings_fields()) {
4094
-                $this->_template_args['data']['mt_reload'][] = $message_type_name;
4095
-            }
4096
-        }
4097
-
4098
-        return $this->_setup_response_message_for_activating_messenger_with_message_types(
4099
-            $active_messenger,
4100
-            $message_type_to_activate
4101
-        );
4102
-    }
4103
-
4104
-
4105
-    /**
4106
-     * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
4107
-     *
4108
-     * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
4109
-     * @param string $message_type_name The name of the message type being deactivated for the messenger
4110
-     * @return bool
4111
-     * @throws DomainException
4112
-     * @throws EE_Error
4113
-     * @throws InvalidArgumentException
4114
-     * @throws ReflectionException
4115
-     * @throws InvalidDataTypeException
4116
-     * @throws InvalidInterfaceException
4117
-     */
4118
-    protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
4119
-    {
4120
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4121
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4122
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
4123
-        $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
4124
-        $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
4125
-
4126
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
4127
-            $active_messenger,
4128
-            $message_type_to_deactivate
4129
-        );
4130
-    }
4131
-
4132
-
4133
-    /**
4134
-     * This just initializes the defaults for activating messenger and message type responses.
4135
-     */
4136
-    protected function _prep_default_response_for_messenger_or_message_type_toggle()
4137
-    {
4138
-        $this->_template_args['data']['active_mts'] = array();
4139
-        $this->_template_args['data']['mt_reload'] = array();
4140
-    }
4141
-
4142
-
4143
-    /**
4144
-     * Setup appropriate response for activating a messenger and/or message types
4145
-     *
4146
-     * @param EE_messenger         $messenger
4147
-     * @param EE_message_type|null $message_type
4148
-     * @return bool
4149
-     * @throws DomainException
4150
-     * @throws EE_Error
4151
-     * @throws InvalidArgumentException
4152
-     * @throws ReflectionException
4153
-     * @throws InvalidDataTypeException
4154
-     * @throws InvalidInterfaceException
4155
-     */
4156
-    protected function _setup_response_message_for_activating_messenger_with_message_types(
4157
-        $messenger,
4158
-        EE_Message_Type $message_type = null
4159
-    ) {
4160
-        // if $messenger isn't a valid messenger object then get out.
4161
-        if (! $messenger instanceof EE_Messenger) {
4162
-            EE_Error::add_error(
4163
-                esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
4164
-                __FILE__,
4165
-                __FUNCTION__,
4166
-                __LINE__
4167
-            );
4168
-
4169
-            return false;
4170
-        }
4171
-        // activated
4172
-        if ($this->_template_args['data']['active_mts']) {
4173
-            EE_Error::overwrite_success();
4174
-            // activated a message type with the messenger
4175
-            if ($message_type instanceof EE_message_type) {
4176
-                EE_Error::add_success(
4177
-                    sprintf(
4178
-                        esc_html__(
4179
-                            '%s message type has been successfully activated with the %s messenger',
4180
-                            'event_espresso'
4181
-                        ),
4182
-                        ucwords($message_type->label['singular']),
4183
-                        ucwords($messenger->label['singular'])
4184
-                    )
4185
-                );
4186
-
4187
-                // if message type was invoice then let's make sure we activate the invoice payment method.
4188
-                if ($message_type->name === 'invoice') {
4189
-                    EE_Registry::instance()->load_lib('Payment_Method_Manager');
4190
-                    $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
4191
-                    if ($pm instanceof EE_Payment_Method) {
4192
-                        EE_Error::add_attention(
4193
-                            esc_html__(
4194
-                                'Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
4195
-                                'event_espresso'
4196
-                            )
4197
-                        );
4198
-                    }
4199
-                }
4200
-                // just toggles the entire messenger
4201
-            } else {
4202
-                EE_Error::add_success(
4203
-                    sprintf(
4204
-                        esc_html__('%s messenger has been successfully activated', 'event_espresso'),
4205
-                        ucwords($messenger->label['singular'])
4206
-                    )
4207
-                );
4208
-            }
4209
-
4210
-            return true;
4211
-
4212
-            // possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
4213
-            // message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
4214
-            // in which case we just give a success message for the messenger being successfully activated.
4215
-        } else {
4216
-            if (! $messenger->get_default_message_types()) {
4217
-                // messenger doesn't have any default message types so still a success.
4218
-                EE_Error::add_success(
4219
-                    sprintf(
4220
-                        esc_html__('%s messenger was successfully activated.', 'event_espresso'),
4221
-                        ucwords($messenger->label['singular'])
4222
-                    )
4223
-                );
4224
-
4225
-                return true;
4226
-            } else {
4227
-                EE_Error::add_error(
4228
-                    $message_type instanceof EE_message_type
4229
-                        ? sprintf(
4230
-                            esc_html__(
4231
-                                '%s message type was not successfully activated with the %s messenger',
4232
-                                'event_espresso'
4233
-                            ),
4234
-                            ucwords($message_type->label['singular']),
4235
-                            ucwords($messenger->label['singular'])
4236
-                        )
4237
-                        : sprintf(
4238
-                            esc_html__('%s messenger was not successfully activated', 'event_espresso'),
4239
-                            ucwords($messenger->label['singular'])
4240
-                        ),
4241
-                    __FILE__,
4242
-                    __FUNCTION__,
4243
-                    __LINE__
4244
-                );
4245
-
4246
-                return false;
4247
-            }
4248
-        }
4249
-    }
4250
-
4251
-
4252
-    /**
4253
-     * This sets up the appropriate response for deactivating a messenger and/or message type.
4254
-     *
4255
-     * @param EE_messenger         $messenger
4256
-     * @param EE_message_type|null $message_type
4257
-     * @return bool
4258
-     * @throws DomainException
4259
-     * @throws EE_Error
4260
-     * @throws InvalidArgumentException
4261
-     * @throws ReflectionException
4262
-     * @throws InvalidDataTypeException
4263
-     * @throws InvalidInterfaceException
4264
-     */
4265
-    protected function _setup_response_message_for_deactivating_messenger_with_message_types(
4266
-        $messenger,
4267
-        EE_message_type $message_type = null
4268
-    ) {
4269
-        EE_Error::overwrite_success();
4270
-
4271
-        // if $messenger isn't a valid messenger object then get out.
4272
-        if (! $messenger instanceof EE_Messenger) {
4273
-            EE_Error::add_error(
4274
-                esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
4275
-                __FILE__,
4276
-                __FUNCTION__,
4277
-                __LINE__
4278
-            );
4279
-
4280
-            return false;
4281
-        }
4282
-
4283
-        if ($message_type instanceof EE_message_type) {
4284
-            $message_type_name = $message_type->name;
4285
-            EE_Error::add_success(
4286
-                sprintf(
4287
-                    esc_html__(
4288
-                        '%s message type has been successfully deactivated for the %s messenger.',
4289
-                        'event_espresso'
4290
-                    ),
4291
-                    ucwords($message_type->label['singular']),
4292
-                    ucwords($messenger->label['singular'])
4293
-                )
4294
-            );
4295
-        } else {
4296
-            $message_type_name = '';
4297
-            EE_Error::add_success(
4298
-                sprintf(
4299
-                    esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
4300
-                    ucwords($messenger->label['singular'])
4301
-                )
4302
-            );
4303
-        }
4304
-
4305
-        // if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
4306
-        if ($messenger->name === 'html' || $message_type_name === 'invoice') {
4307
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
4308
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
4309
-            if ($count_updated > 0) {
4310
-                $msg = $message_type_name === 'invoice'
4311
-                    ? esc_html__(
4312
-                        'Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
4313
-                        'event_espresso'
4314
-                    )
4315
-                    : esc_html__(
4316
-                        'Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
4317
-                        'event_espresso'
4318
-                    );
4319
-                EE_Error::add_attention($msg);
4320
-            }
4321
-        }
4322
-
4323
-        return true;
4324
-    }
4325
-
4326
-
4327
-    /**
4328
-     * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
4329
-     *
4330
-     * @throws DomainException
4331
-     */
4332
-    public function update_mt_form()
4333
-    {
4334
-        if (! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
4335
-            EE_Error::add_error(
4336
-                esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
4337
-                __FILE__,
4338
-                __FUNCTION__,
4339
-                __LINE__
4340
-            );
4341
-            $this->_return_json();
4342
-        }
4343
-
4344
-        $message_types = $this->get_installed_message_types();
4345
-
4346
-        $message_type = $message_types[ $this->_req_data['message_type'] ];
4347
-        $messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
4348
-
4349
-        $content = $this->_message_type_settings_content(
4350
-            $message_type,
4351
-            $messenger,
4352
-            true
4353
-        );
4354
-        $this->_template_args['success'] = true;
4355
-        $this->_template_args['content'] = $content;
4356
-        $this->_return_json();
4357
-    }
4358
-
4359
-
4360
-    /**
4361
-     * this handles saving the settings for a messenger or message type
4362
-     *
4363
-     */
4364
-    public function save_settings()
4365
-    {
4366
-        if (! isset($this->_req_data['type'])) {
4367
-            EE_Error::add_error(
4368
-                esc_html__(
4369
-                    'Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
4370
-                    'event_espresso'
4371
-                ),
4372
-                __FILE__,
4373
-                __FUNCTION__,
4374
-                __LINE__
4375
-            );
4376
-            $this->_template_args['error'] = true;
4377
-            $this->_return_json();
4378
-        }
4379
-
4380
-
4381
-        if ($this->_req_data['type'] === 'messenger') {
4382
-            // this should be an array.
4383
-            $settings = $this->_req_data['messenger_settings'];
4384
-            $messenger = $settings['messenger'];
4385
-            // let's setup the settings data
4386
-            foreach ($settings as $key => $value) {
4387
-                switch ($key) {
4388
-                    case 'messenger':
4389
-                        unset($settings['messenger']);
4390
-                        break;
4391
-                    case 'message_types':
4392
-                        unset($settings['message_types']);
4393
-                        break;
4394
-                    default:
4395
-                        $settings[ $key ] = $value;
4396
-                        break;
4397
-                }
4398
-            }
4399
-            $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
4400
-        } elseif ($this->_req_data['type'] === 'message_type') {
4401
-            $settings = $this->_req_data['message_type_settings'];
4402
-            $messenger = $settings['messenger'];
4403
-            $message_type = $settings['message_type'];
4404
-
4405
-            foreach ($settings as $key => $value) {
4406
-                switch ($key) {
4407
-                    case 'messenger':
4408
-                        unset($settings['messenger']);
4409
-                        break;
4410
-                    case 'message_type':
4411
-                        unset($settings['message_type']);
4412
-                        break;
4413
-                    default:
4414
-                        $settings[ $key ] = $value;
4415
-                        break;
4416
-                }
4417
-            }
4418
-
4419
-            $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
4420
-        }
4421
-
4422
-        // okay we should have the data all setup.  Now we just update!
4423
-        $success = $this->_message_resource_manager->update_active_messengers_option();
4424
-
4425
-        if ($success) {
4426
-            EE_Error::add_success(__('Settings updated', 'event_espresso'));
4427
-        } else {
4428
-            EE_Error::add_error(
4429
-                esc_html__(
4430
-                    'Settings did not get updated',
4431
-                    'event_espresso'
4432
-                ),
4433
-                __FILE__,
4434
-                __FUNCTION__,
4435
-                __LINE__
4436
-            );
4437
-        }
4438
-
4439
-        $this->_template_args['success'] = $success;
4440
-        $this->_return_json();
4441
-    }
4442
-
4443
-
4444
-
4445
-
4446
-    /**  EE MESSAGE PROCESSING ACTIONS **/
4447
-
4448
-
4449
-    /**
4450
-     * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
4451
-     * However, this does not send immediately, it just queues for sending.
4452
-     *
4453
-     * @since 4.9.0
4454
-     * @throws EE_Error
4455
-     * @throws InvalidDataTypeException
4456
-     * @throws InvalidInterfaceException
4457
-     * @throws InvalidArgumentException
4458
-     * @throws ReflectionException
4459
-     */
4460
-    protected function _generate_now()
4461
-    {
4462
-        EED_Messages::generate_now($this->_get_msg_ids_from_request());
4463
-        $this->_redirect_after_action(false, '', '', array(), true);
4464
-    }
4465
-
4466
-
4467
-    /**
4468
-     * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
4469
-     * are EEM_Message::status_resend or EEM_Message::status_idle
4470
-     *
4471
-     * @since 4.9.0
4472
-     * @throws EE_Error
4473
-     * @throws InvalidDataTypeException
4474
-     * @throws InvalidInterfaceException
4475
-     * @throws InvalidArgumentException
4476
-     * @throws ReflectionException
4477
-     */
4478
-    protected function _generate_and_send_now()
4479
-    {
4480
-        EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
4481
-        $this->_redirect_after_action(false, '', '', array(), true);
4482
-    }
4483
-
4484
-
4485
-    /**
4486
-     * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
4487
-     *
4488
-     * @since 4.9.0
4489
-     * @throws EE_Error
4490
-     * @throws InvalidDataTypeException
4491
-     * @throws InvalidInterfaceException
4492
-     * @throws InvalidArgumentException
4493
-     * @throws ReflectionException
4494
-     */
4495
-    protected function _queue_for_resending()
4496
-    {
4497
-        EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
4498
-        $this->_redirect_after_action(false, '', '', array(), true);
4499
-    }
4500
-
4501
-
4502
-    /**
4503
-     *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
4504
-     *
4505
-     * @since 4.9.0
4506
-     * @throws EE_Error
4507
-     * @throws InvalidDataTypeException
4508
-     * @throws InvalidInterfaceException
4509
-     * @throws InvalidArgumentException
4510
-     * @throws ReflectionException
4511
-     */
4512
-    protected function _send_now()
4513
-    {
4514
-        EED_Messages::send_now($this->_get_msg_ids_from_request());
4515
-        $this->_redirect_after_action(false, '', '', array(), true);
4516
-    }
4517
-
4518
-
4519
-    /**
4520
-     * Deletes EE_messages for IDs in the request.
4521
-     *
4522
-     * @since 4.9.0
4523
-     * @throws EE_Error
4524
-     * @throws InvalidDataTypeException
4525
-     * @throws InvalidInterfaceException
4526
-     * @throws InvalidArgumentException
4527
-     */
4528
-    protected function _delete_ee_messages()
4529
-    {
4530
-        $msg_ids = $this->_get_msg_ids_from_request();
4531
-        $deleted_count = 0;
4532
-        foreach ($msg_ids as $msg_id) {
4533
-            if (EEM_Message::instance()->delete_by_ID($msg_id)) {
4534
-                $deleted_count++;
4535
-            }
4536
-        }
4537
-        if ($deleted_count) {
4538
-            EE_Error::add_success(
4539
-                esc_html(
4540
-                    _n(
4541
-                        'Message successfully deleted',
4542
-                        'Messages successfully deleted',
4543
-                        $deleted_count,
4544
-                        'event_espresso'
4545
-                    )
4546
-                )
4547
-            );
4548
-            $this->_redirect_after_action(
4549
-                false,
4550
-                '',
4551
-                '',
4552
-                array(),
4553
-                true
4554
-            );
4555
-        } else {
4556
-            EE_Error::add_error(
4557
-                _n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
4558
-                __FILE__,
4559
-                __FUNCTION__,
4560
-                __LINE__
4561
-            );
4562
-            $this->_redirect_after_action(false, '', '', array(), true);
4563
-        }
4564
-    }
4565
-
4566
-
4567
-    /**
4568
-     *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
4569
-     *
4570
-     * @since 4.9.0
4571
-     * @return array
4572
-     */
4573
-    protected function _get_msg_ids_from_request()
4574
-    {
4575
-        if (! isset($this->_req_data['MSG_ID'])) {
4576
-            return array();
4577
-        }
4578
-
4579
-        return is_array($this->_req_data['MSG_ID'])
4580
-            ? array_keys($this->_req_data['MSG_ID'])
4581
-            : array($this->_req_data['MSG_ID']);
4582
-    }
2662
+		$output = ob_get_contents();
2663
+		ob_clean();
2664
+		$this->_context_switcher = $output;
2665
+	}
2666
+
2667
+
2668
+	/**
2669
+	 * utility for sanitizing new values coming in.
2670
+	 * Note: this is only used when updating a context.
2671
+	 *
2672
+	 * @access protected
2673
+	 *
2674
+	 * @param int $index This helps us know which template field to select from the request array.
2675
+	 *
2676
+	 * @return array
2677
+	 */
2678
+	protected function _set_message_template_column_values($index)
2679
+	{
2680
+		if (is_array($this->_req_data['MTP_template_fields'][ $index ]['content'])) {
2681
+			foreach ($this->_req_data['MTP_template_fields'][ $index ]['content'] as $field => $value) {
2682
+				$this->_req_data['MTP_template_fields'][ $index ]['content'][ $field ] = $value;
2683
+			}
2684
+		}
2685
+
2686
+
2687
+		$set_column_values = array(
2688
+			'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][ $index ]['MTP_ID']),
2689
+			'GRP_ID'             => absint($this->_req_data['GRP_ID']),
2690
+			'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
2691
+			'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
2692
+			'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
2693
+			'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][ $index ]['name']),
2694
+			'MTP_context'        => strtolower($this->_req_data['MTP_context']),
2695
+			'MTP_content'        => $this->_req_data['MTP_template_fields'][ $index ]['content'],
2696
+			'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
2697
+				? absint($this->_req_data['MTP_is_global'])
2698
+				: 0,
2699
+			'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
2700
+				? absint($this->_req_data['MTP_is_override'])
2701
+				: 0,
2702
+			'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
2703
+			'MTP_is_active'      => absint($this->_req_data['MTP_is_active']),
2704
+		);
2705
+
2706
+
2707
+		return $set_column_values;
2708
+	}
2709
+
2710
+
2711
+	protected function _insert_or_update_message_template($new = false)
2712
+	{
2713
+
2714
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
2715
+		$success = 0;
2716
+		$override = false;
2717
+
2718
+		// setup notices description
2719
+		$messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
2720
+
2721
+		// need the message type and messenger objects to be able to use the labels for the notices
2722
+		$messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
2723
+		$messenger_label = $messenger_object instanceof EE_messenger
2724
+			? ucwords($messenger_object->label['singular'])
2725
+			: '';
2726
+
2727
+		$message_type_slug = ! empty($this->_req_data['MTP_message_type'])
2728
+			? $this->_req_data['MTP_message_type']
2729
+			: '';
2730
+		$message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
2731
+
2732
+		$message_type_label = $message_type_object instanceof EE_message_type
2733
+			? ucwords($message_type_object->label['singular'])
2734
+			: '';
2735
+
2736
+		$context_slug = ! empty($this->_req_data['MTP_context'])
2737
+			? $this->_req_data['MTP_context']
2738
+			: '';
2739
+		$context = ucwords(str_replace('_', ' ', $context_slug));
2740
+
2741
+		$item_desc = $messenger_label && $message_type_label
2742
+			? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
2743
+			: '';
2744
+		$item_desc .= 'Message Template';
2745
+		$query_args = array();
2746
+		$edit_array = array();
2747
+		$action_desc = '';
2748
+
2749
+		// if this is "new" then we need to generate the default contexts for the selected messenger/message_type for
2750
+		// user to edit.
2751
+		if ($new) {
2752
+			$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
2753
+			if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
2754
+				if (empty($edit_array)) {
2755
+					$success = 0;
2756
+				} else {
2757
+					$success = 1;
2758
+					$edit_array = $edit_array[0];
2759
+					$query_args = array(
2760
+						'id'      => $edit_array['GRP_ID'],
2761
+						'context' => $edit_array['MTP_context'],
2762
+						'action'  => 'edit_message_template',
2763
+					);
2764
+				}
2765
+			}
2766
+			$action_desc = 'created';
2767
+		} else {
2768
+			$MTPG = EEM_Message_Template_Group::instance();
2769
+			$MTP = EEM_Message_Template::instance();
2770
+
2771
+
2772
+			// run update for each template field in displayed context
2773
+			if (! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
2774
+				EE_Error::add_error(
2775
+					esc_html__(
2776
+						'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
2777
+						'event_espresso'
2778
+					),
2779
+					__FILE__,
2780
+					__FUNCTION__,
2781
+					__LINE__
2782
+				);
2783
+				$success = 0;
2784
+			} else {
2785
+				// first validate all fields!
2786
+				// this filter allows client code to add its own validation to the template fields as well.
2787
+				// returning an empty array means everything passed validation.
2788
+				// errors in validation should be represented in an array with the following shape:
2789
+				// array(
2790
+				//   'fieldname' => array(
2791
+				//          'msg' => 'error message'
2792
+				//          'value' => 'value for field producing error'
2793
+				// )
2794
+				$custom_validation = (array) apply_filters(
2795
+					'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
2796
+					array(),
2797
+					$this->_req_data['MTP_template_fields'],
2798
+					$context_slug,
2799
+					$messenger_slug,
2800
+					$message_type_slug
2801
+				);
2802
+
2803
+				$system_validation = $MTPG->validate(
2804
+					$this->_req_data['MTP_template_fields'],
2805
+					$context_slug,
2806
+					$messenger_slug,
2807
+					$message_type_slug
2808
+				);
2809
+
2810
+				$system_validation = ! is_array($system_validation) && $system_validation ? array()
2811
+					: $system_validation;
2812
+				$validates = array_merge($custom_validation, $system_validation);
2813
+
2814
+				// if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
2815
+				// appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
2816
+				//  WE need to make sure there is no actual error messages in validates.
2817
+				if (is_array($validates) && ! empty($validates)) {
2818
+					// add the transient so when the form loads we know which fields to highlight
2819
+					$this->_add_transient('edit_message_template', $validates);
2820
+
2821
+					$success = 0;
2822
+
2823
+					// setup notices
2824
+					foreach ($validates as $field => $error) {
2825
+						if (isset($error['msg'])) {
2826
+							EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
2827
+						}
2828
+					}
2829
+				} else {
2830
+					$set_column_values = array();
2831
+					foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
2832
+						$set_column_values = $this->_set_message_template_column_values($template_field);
2833
+
2834
+						$where_cols_n_values = array(
2835
+							'MTP_ID' => $this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'],
2836
+						);
2837
+						// if they aren't allowed to use all JS, restrict them to just posty-y tags
2838
+						if (! current_user_can('unfiltered_html')) {
2839
+							if (is_array($set_column_values['MTP_content'])) {
2840
+								foreach ($set_column_values['MTP_content'] as $key => $value) {
2841
+									// remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
2842
+									// only removes slashes from double-quotes, so attributes using single quotes always
2843
+									// appear invalid.) But currently the models expect slashed data, so after wp_kses
2844
+									// runs we need to re-slash the data. Sheesh. See
2845
+									// https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
2846
+									$set_column_values['MTP_content'][ $key ] = addslashes(
2847
+										wp_kses(
2848
+											stripslashes($value),
2849
+											wp_kses_allowed_html('post')
2850
+										)
2851
+									);
2852
+								}
2853
+							} else {
2854
+								$set_column_values['MTP_content'] = wp_kses(
2855
+									$set_column_values['MTP_content'],
2856
+									wp_kses_allowed_html('post')
2857
+								);
2858
+							}
2859
+						}
2860
+						$message_template_fields = array(
2861
+							'GRP_ID'             => $set_column_values['GRP_ID'],
2862
+							'MTP_template_field' => $set_column_values['MTP_template_field'],
2863
+							'MTP_context'        => $set_column_values['MTP_context'],
2864
+							'MTP_content'        => $set_column_values['MTP_content'],
2865
+						);
2866
+						if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
2867
+							if ($updated === false) {
2868
+								EE_Error::add_error(
2869
+									sprintf(
2870
+										esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
2871
+										$template_field
2872
+									),
2873
+									__FILE__,
2874
+									__FUNCTION__,
2875
+									__LINE__
2876
+								);
2877
+							} else {
2878
+								$success = 1;
2879
+							}
2880
+						} else {
2881
+							// only do this logic if we don't have a MTP_ID for this field
2882
+							if (empty($this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'])) {
2883
+								// this has already been through the template field validator and sanitized, so it will be
2884
+								// safe to insert this field.  Why insert?  This typically happens when we introduce a new
2885
+								// message template field in a messenger/message type and existing users don't have the
2886
+								// default setup for it.
2887
+								// @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
2888
+								$updated = $MTP->insert($message_template_fields);
2889
+								if (! $updated || is_wp_error($updated)) {
2890
+									EE_Error::add_error(
2891
+										sprintf(
2892
+											esc_html__('%s field could not be updated.', 'event_espresso'),
2893
+											$template_field
2894
+										),
2895
+										__FILE__,
2896
+										__FUNCTION__,
2897
+										__LINE__
2898
+									);
2899
+									$success = 0;
2900
+								} else {
2901
+									$success = 1;
2902
+								}
2903
+							}
2904
+						}
2905
+						$action_desc = 'updated';
2906
+					}
2907
+
2908
+					// we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
2909
+					$mtpg_fields = array(
2910
+						'MTP_user_id'      => $set_column_values['MTP_user_id'],
2911
+						'MTP_messenger'    => $set_column_values['MTP_messenger'],
2912
+						'MTP_message_type' => $set_column_values['MTP_message_type'],
2913
+						'MTP_is_global'    => $set_column_values['MTP_is_global'],
2914
+						'MTP_is_override'  => $set_column_values['MTP_is_override'],
2915
+						'MTP_deleted'      => $set_column_values['MTP_deleted'],
2916
+						'MTP_is_active'    => $set_column_values['MTP_is_active'],
2917
+						'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
2918
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
2919
+							: '',
2920
+						'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
2921
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
2922
+							: '',
2923
+					);
2924
+
2925
+					$mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
2926
+					$updated = $MTPG->update($mtpg_fields, array($mtpg_where));
2927
+
2928
+					if ($updated === false) {
2929
+						EE_Error::add_error(
2930
+							sprintf(
2931
+								esc_html__(
2932
+									'The Message Template Group (%d) was NOT updated for some reason',
2933
+									'event_espresso'
2934
+								),
2935
+								$set_column_values['GRP_ID']
2936
+							),
2937
+							__FILE__,
2938
+							__FUNCTION__,
2939
+							__LINE__
2940
+						);
2941
+					} else {
2942
+						// k now we need to ensure the template_pack and template_variation fields are set.
2943
+						$template_pack = ! empty($this->_req_data['MTP_template_pack'])
2944
+							? $this->_req_data['MTP_template_pack']
2945
+							: 'default';
2946
+
2947
+						$template_variation = ! empty($this->_req_data['MTP_template_variation'])
2948
+							? $this->_req_data['MTP_template_variation']
2949
+							: 'default';
2950
+
2951
+						$mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
2952
+						if ($mtpg_obj instanceof EE_Message_Template_Group) {
2953
+							$mtpg_obj->set_template_pack_name($template_pack);
2954
+							$mtpg_obj->set_template_pack_variation($template_variation);
2955
+						}
2956
+						$success = 1;
2957
+					}
2958
+				}
2959
+			}
2960
+		}
2961
+
2962
+		// we return things differently if doing ajax
2963
+		if (defined('DOING_AJAX') && DOING_AJAX) {
2964
+			$this->_template_args['success'] = $success;
2965
+			$this->_template_args['error'] = ! $success ? true : false;
2966
+			$this->_template_args['content'] = '';
2967
+			$this->_template_args['data'] = array(
2968
+				'grpID'        => $edit_array['GRP_ID'],
2969
+				'templateName' => $edit_array['template_name'],
2970
+			);
2971
+			if ($success) {
2972
+				EE_Error::overwrite_success();
2973
+				EE_Error::add_success(
2974
+					esc_html__(
2975
+						'The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
2976
+						'event_espresso'
2977
+					)
2978
+				);
2979
+			}
2980
+
2981
+			$this->_return_json();
2982
+		}
2983
+
2984
+
2985
+		// was a test send triggered?
2986
+		if (isset($this->_req_data['test_button'])) {
2987
+			EE_Error::overwrite_success();
2988
+			$this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
2989
+			$override = true;
2990
+		}
2991
+
2992
+		if (empty($query_args)) {
2993
+			$query_args = array(
2994
+				'id'      => $this->_req_data['GRP_ID'],
2995
+				'context' => $context_slug,
2996
+				'action'  => 'edit_message_template',
2997
+			);
2998
+		}
2999
+
3000
+		$this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
3001
+	}
3002
+
3003
+
3004
+	/**
3005
+	 * processes a test send request to do an actual messenger delivery test for the given message template being tested
3006
+	 *
3007
+	 * @param  string $context      what context being tested
3008
+	 * @param  string $messenger    messenger being tested
3009
+	 * @param  string $message_type message type being tested
3010
+	 * @throws EE_Error
3011
+	 * @throws InvalidArgumentException
3012
+	 * @throws InvalidDataTypeException
3013
+	 * @throws InvalidInterfaceException
3014
+	 */
3015
+	protected function _do_test_send($context, $messenger, $message_type)
3016
+	{
3017
+		// set things up for preview
3018
+		$this->_req_data['messenger'] = $messenger;
3019
+		$this->_req_data['message_type'] = $message_type;
3020
+		$this->_req_data['context'] = $context;
3021
+		$this->_req_data['GRP_ID'] = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
3022
+		$active_messenger = $this->_message_resource_manager->get_active_messenger($messenger);
3023
+
3024
+		// let's save any existing fields that might be required by the messenger
3025
+		if (isset($this->_req_data['test_settings_fld'])
3026
+			&& $active_messenger instanceof EE_messenger
3027
+			&& apply_filters(
3028
+				'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
3029
+				true,
3030
+				$this->_req_data['test_settings_fld'],
3031
+				$active_messenger
3032
+			)
3033
+		) {
3034
+			$active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
3035
+		}
3036
+
3037
+		/**
3038
+		 * Use filter to add additional controls on whether message can send or not
3039
+		 */
3040
+		if (apply_filters(
3041
+			'FHEE__Messages_Admin_Page__do_test_send__can_send',
3042
+			true,
3043
+			$context,
3044
+			$this->_req_data,
3045
+			$messenger,
3046
+			$message_type
3047
+		)) {
3048
+			if (EEM_Event::instance()->count() > 0) {
3049
+				$success = $this->_preview_message(true);
3050
+				if ($success) {
3051
+					EE_Error::add_success(__('Test message sent', 'event_espresso'));
3052
+				} else {
3053
+					EE_Error::add_error(
3054
+						esc_html__('The test message was not sent', 'event_espresso'),
3055
+						__FILE__,
3056
+						__FUNCTION__,
3057
+						__LINE__
3058
+					);
3059
+				}
3060
+			} else {
3061
+				$this->noEventsErrorMessage(true);
3062
+			}
3063
+		}
3064
+	}
3065
+
3066
+
3067
+	/**
3068
+	 * _generate_new_templates
3069
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
3070
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
3071
+	 * for the event.
3072
+	 *
3073
+	 *
3074
+	 * @param  string $messenger     the messenger we are generating templates for
3075
+	 * @param array   $message_types array of message types that the templates are generated for.
3076
+	 * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
3077
+	 *                               indicate the message_template_group being used as the base.
3078
+	 *
3079
+	 * @param bool    $global
3080
+	 *
3081
+	 * @return array|bool array of data required for the redirect to the correct edit page or bool if
3082
+	 *                               encountering problems.
3083
+	 * @throws EE_Error
3084
+	 */
3085
+	protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
3086
+	{
3087
+
3088
+		// if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
3089
+		// just don't generate any templates.
3090
+		if (empty($message_types)) {
3091
+			return true;
3092
+		}
3093
+
3094
+		return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
3095
+	}
3096
+
3097
+
3098
+	/**
3099
+	 * [_trash_or_restore_message_template]
3100
+	 *
3101
+	 * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
3102
+	 * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
3103
+	 *                        an individual context (FALSE).
3104
+	 * @return void
3105
+	 * @throws EE_Error
3106
+	 * @throws InvalidArgumentException
3107
+	 * @throws InvalidDataTypeException
3108
+	 * @throws InvalidInterfaceException
3109
+	 */
3110
+	protected function _trash_or_restore_message_template($trash = true, $all = false)
3111
+	{
3112
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3113
+		$MTP = EEM_Message_Template_Group::instance();
3114
+
3115
+		$success = 1;
3116
+
3117
+		// incoming GRP_IDs
3118
+		if ($all) {
3119
+			// Checkboxes
3120
+			if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3121
+				// if array has more than one element then success message should be plural.
3122
+				// todo: what about nonce?
3123
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3124
+
3125
+				// cycle through checkboxes
3126
+				while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3127
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3128
+					if (! $trashed_or_restored) {
3129
+						$success = 0;
3130
+					}
3131
+				}
3132
+			} else {
3133
+				// grab single GRP_ID and handle
3134
+				$GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
3135
+				if (! empty($GRP_ID)) {
3136
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
3137
+					if (! $trashed_or_restored) {
3138
+						$success = 0;
3139
+					}
3140
+				} else {
3141
+					$success = 0;
3142
+				}
3143
+			}
3144
+		}
3145
+
3146
+		$action_desc = $trash
3147
+			? esc_html__('moved to the trash', 'event_espresso')
3148
+			: esc_html__('restored', 'event_espresso');
3149
+
3150
+		$action_desc = ! empty($this->_req_data['template_switch']) ? esc_html__('switched', 'event_espresso') : $action_desc;
3151
+
3152
+		$item_desc = $all ? _n(
3153
+			'Message Template Group',
3154
+			'Message Template Groups',
3155
+			$success,
3156
+			'event_espresso'
3157
+		) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
3158
+
3159
+		$item_desc = ! empty($this->_req_data['template_switch']) ? _n(
3160
+			'template',
3161
+			'templates',
3162
+			$success,
3163
+			'event_espresso'
3164
+		) : $item_desc;
3165
+
3166
+		$this->_redirect_after_action($success, $item_desc, $action_desc, array());
3167
+	}
3168
+
3169
+
3170
+	/**
3171
+	 * [_delete_message_template]
3172
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
3173
+	 *
3174
+	 * @return void
3175
+	 * @throws EE_Error
3176
+	 * @throws InvalidArgumentException
3177
+	 * @throws InvalidDataTypeException
3178
+	 * @throws InvalidInterfaceException
3179
+	 */
3180
+	protected function _delete_message_template()
3181
+	{
3182
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
3183
+
3184
+		// checkboxes
3185
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
3186
+			// if array has more than one element then success message should be plural
3187
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
3188
+
3189
+			// cycle through bulk action checkboxes
3190
+			while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
3191
+				$success = $this->_delete_mtp_permanently($GRP_ID);
3192
+			}
3193
+		} else {
3194
+			// grab single grp_id and delete
3195
+			$GRP_ID = absint($this->_req_data['id']);
3196
+			$success = $this->_delete_mtp_permanently($GRP_ID);
3197
+		}
3198
+
3199
+		$this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
3200
+	}
3201
+
3202
+
3203
+	/**
3204
+	 * helper for permanently deleting a mtP group and all related message_templates
3205
+	 *
3206
+	 * @param  int  $GRP_ID        The group being deleted
3207
+	 * @param  bool $include_group whether to delete the Message Template Group as well.
3208
+	 * @return bool boolean to indicate the success of the deletes or not.
3209
+	 * @throws EE_Error
3210
+	 * @throws InvalidArgumentException
3211
+	 * @throws InvalidDataTypeException
3212
+	 * @throws InvalidInterfaceException
3213
+	 */
3214
+	private function _delete_mtp_permanently($GRP_ID, $include_group = true)
3215
+	{
3216
+		$success = 1;
3217
+		$MTPG = EEM_Message_Template_Group::instance();
3218
+		// first let's GET this group
3219
+		$MTG = $MTPG->get_one_by_ID($GRP_ID);
3220
+		// then delete permanently all the related Message Templates
3221
+		$deleted = $MTG->delete_related_permanently('Message_Template');
3222
+
3223
+		if ($deleted === 0) {
3224
+			$success = 0;
3225
+		}
3226
+
3227
+		// now delete permanently this particular group
3228
+
3229
+		if ($include_group && ! $MTG->delete_permanently()) {
3230
+			$success = 0;
3231
+		}
3232
+
3233
+		return $success;
3234
+	}
3235
+
3236
+
3237
+	/**
3238
+	 *    _learn_more_about_message_templates_link
3239
+	 *
3240
+	 * @access protected
3241
+	 * @return string
3242
+	 */
3243
+	protected function _learn_more_about_message_templates_link()
3244
+	{
3245
+		return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
3246
+			   . esc_html__('learn more about how message templates works', 'event_espresso')
3247
+			   . '</a>';
3248
+	}
3249
+
3250
+
3251
+	/**
3252
+	 * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
3253
+	 * ajax and other routes.
3254
+	 *
3255
+	 * @return void
3256
+	 * @throws DomainException
3257
+	 */
3258
+	protected function _settings()
3259
+	{
3260
+
3261
+
3262
+		$this->_set_m_mt_settings();
3263
+
3264
+		$selected_messenger = isset($this->_req_data['selected_messenger'])
3265
+			? $this->_req_data['selected_messenger']
3266
+			: 'email';
3267
+
3268
+		// let's setup the messenger tabs
3269
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
3270
+			$this->_m_mt_settings['messenger_tabs'],
3271
+			'messenger_links',
3272
+			'|',
3273
+			$selected_messenger
3274
+		);
3275
+		$this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
3276
+		$this->_template_args['after_admin_page_content'] = '</div><!-- end .ui-widget -->';
3277
+
3278
+		$this->display_admin_page_with_sidebar();
3279
+	}
3280
+
3281
+
3282
+	/**
3283
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
3284
+	 *
3285
+	 * @access protected
3286
+	 * @return void
3287
+	 * @throws DomainException
3288
+	 */
3289
+	protected function _set_m_mt_settings()
3290
+	{
3291
+		// first if this is already set then lets get out no need to regenerate data.
3292
+		if (! empty($this->_m_mt_settings)) {
3293
+			return;
3294
+		}
3295
+
3296
+		// get all installed messengers and message_types
3297
+		/** @type EE_messenger[] $messengers */
3298
+		$messengers = $this->_message_resource_manager->installed_messengers();
3299
+		/** @type EE_message_type[] $message_types */
3300
+		$message_types = $this->_message_resource_manager->installed_message_types();
3301
+
3302
+
3303
+		// assemble the array for the _tab_text_links helper
3304
+
3305
+		foreach ($messengers as $messenger) {
3306
+			$this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = array(
3307
+				'label' => ucwords($messenger->label['singular']),
3308
+				'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
3309
+					? 'messenger-active'
3310
+					: '',
3311
+				'href'  => $messenger->name,
3312
+				'title' => esc_html__('Modify this Messenger', 'event_espresso'),
3313
+				'slug'  => $messenger->name,
3314
+				'obj'   => $messenger,
3315
+			);
3316
+
3317
+
3318
+			$message_types_for_messenger = $messenger->get_valid_message_types();
3319
+
3320
+			foreach ($message_types as $message_type) {
3321
+				// first we need to verify that this message type is valid with this messenger. Cause if it isn't then
3322
+				// it shouldn't show in either the inactive OR active metabox.
3323
+				if (! in_array($message_type->name, $message_types_for_messenger, true)) {
3324
+					continue;
3325
+				}
3326
+
3327
+				$a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
3328
+					$messenger->name,
3329
+					$message_type->name
3330
+				)
3331
+					? 'active'
3332
+					: 'inactive';
3333
+
3334
+				$this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = array(
3335
+					'label'    => ucwords($message_type->label['singular']),
3336
+					'class'    => 'message-type-' . $a_or_i,
3337
+					'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
3338
+					'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
3339
+					'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
3340
+					'title'    => $a_or_i === 'active'
3341
+						? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
3342
+						: esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
3343
+					'content'  => $a_or_i === 'active'
3344
+						? $this->_message_type_settings_content($message_type, $messenger, true)
3345
+						: $this->_message_type_settings_content($message_type, $messenger),
3346
+					'slug'     => $message_type->name,
3347
+					'active'   => $a_or_i === 'active',
3348
+					'obj'      => $message_type,
3349
+				);
3350
+			}
3351
+		}
3352
+	}
3353
+
3354
+
3355
+	/**
3356
+	 * This just prepares the content for the message type settings
3357
+	 *
3358
+	 * @param  EE_message_type $message_type The message type object
3359
+	 * @param  EE_messenger    $messenger    The messenger object
3360
+	 * @param  boolean         $active       Whether the message type is active or not
3361
+	 * @return string html output for the content
3362
+	 * @throws DomainException
3363
+	 */
3364
+	protected function _message_type_settings_content($message_type, $messenger, $active = false)
3365
+	{
3366
+		// get message type fields
3367
+		$fields = $message_type->get_admin_settings_fields();
3368
+		$settings_template_args['template_form_fields'] = '';
3369
+
3370
+		if (! empty($fields) && $active) {
3371
+			$existing_settings = $message_type->get_existing_admin_settings($messenger->name);
3372
+			foreach ($fields as $fldname => $fldprops) {
3373
+				$field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname;
3374
+				$template_form_field[ $field_id ] = array(
3375
+					'name'       => 'message_type_settings[' . $fldname . ']',
3376
+					'label'      => $fldprops['label'],
3377
+					'input'      => $fldprops['field_type'],
3378
+					'type'       => $fldprops['value_type'],
3379
+					'required'   => $fldprops['required'],
3380
+					'validation' => $fldprops['validation'],
3381
+					'value'      => isset($existing_settings[ $fldname ])
3382
+						? $existing_settings[ $fldname ]
3383
+						: $fldprops['default'],
3384
+					'options'    => isset($fldprops['options'])
3385
+						? $fldprops['options']
3386
+						: array(),
3387
+					'default'    => isset($existing_settings[ $fldname ])
3388
+						? $existing_settings[ $fldname ]
3389
+						: $fldprops['default'],
3390
+					'css_class'  => 'no-drag',
3391
+					'format'     => $fldprops['format'],
3392
+				);
3393
+			}
3394
+
3395
+
3396
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
3397
+				? $this->_generate_admin_form_fields(
3398
+					$template_form_field,
3399
+					'string',
3400
+					'ee_mt_activate_form'
3401
+				)
3402
+				: '';
3403
+		}
3404
+
3405
+		$settings_template_args['description'] = $message_type->description;
3406
+		// we also need some hidden fields
3407
+		$settings_template_args['hidden_fields'] = array(
3408
+			'message_type_settings[messenger]'    => array(
3409
+				'type'  => 'hidden',
3410
+				'value' => $messenger->name,
3411
+			),
3412
+			'message_type_settings[message_type]' => array(
3413
+				'type'  => 'hidden',
3414
+				'value' => $message_type->name,
3415
+			),
3416
+			'type'                                => array(
3417
+				'type'  => 'hidden',
3418
+				'value' => 'message_type',
3419
+			),
3420
+		);
3421
+
3422
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
3423
+			$settings_template_args['hidden_fields'],
3424
+			'array'
3425
+		);
3426
+		$settings_template_args['show_form'] = empty($settings_template_args['template_form_fields'])
3427
+			? ' hidden'
3428
+			: '';
3429
+
3430
+
3431
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
3432
+		$content = EEH_Template::display_template($template, $settings_template_args, true);
3433
+
3434
+		return $content;
3435
+	}
3436
+
3437
+
3438
+	/**
3439
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
3440
+	 *
3441
+	 * @access protected
3442
+	 * @return void
3443
+	 * @throws DomainException
3444
+	 */
3445
+	protected function _messages_settings_metaboxes()
3446
+	{
3447
+		$this->_set_m_mt_settings();
3448
+		$m_boxes = $mt_boxes = array();
3449
+		$m_template_args = $mt_template_args = array();
3450
+
3451
+		$selected_messenger = isset($this->_req_data['selected_messenger'])
3452
+			? $this->_req_data['selected_messenger']
3453
+			: 'email';
3454
+
3455
+		if (isset($this->_m_mt_settings['messenger_tabs'])) {
3456
+			foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
3457
+				$hide_on_message = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
3458
+				$hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
3459
+				// messenger meta boxes
3460
+				$active = $selected_messenger === $messenger;
3461
+				$active_mt_tabs = isset(
3462
+					$this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3463
+				)
3464
+					? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
3465
+					: '';
3466
+				$m_boxes[ $messenger . '_a_box' ] = sprintf(
3467
+					esc_html__('%s Settings', 'event_espresso'),
3468
+					$tab_array['label']
3469
+				);
3470
+				$m_template_args[ $messenger . '_a_box' ] = array(
3471
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3472
+					'inactive_message_types' => isset(
3473
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3474
+					)
3475
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3476
+						: '',
3477
+					'content'                => $this->_get_messenger_box_content($tab_array['obj']),
3478
+					'hidden'                 => $active ? '' : ' hidden',
3479
+					'hide_on_message'        => $hide_on_message,
3480
+					'messenger'              => $messenger,
3481
+					'active'                 => $active,
3482
+				);
3483
+				// message type meta boxes
3484
+				// (which is really just the inactive container for each messenger
3485
+				// showing inactive message types for that messenger)
3486
+				$mt_boxes[ $messenger . '_i_box' ] = esc_html__('Inactive Message Types', 'event_espresso');
3487
+				$mt_template_args[ $messenger . '_i_box' ] = array(
3488
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
3489
+					'inactive_message_types' => isset(
3490
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
3491
+					)
3492
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
3493
+						: '',
3494
+					'hidden'                 => $active ? '' : ' hidden',
3495
+					'hide_on_message'        => $hide_on_message,
3496
+					'hide_off_message'       => $hide_off_message,
3497
+					'messenger'              => $messenger,
3498
+					'active'                 => $active,
3499
+				);
3500
+			}
3501
+		}
3502
+
3503
+
3504
+		// register messenger metaboxes
3505
+		$m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
3506
+		foreach ($m_boxes as $box => $label) {
3507
+			$callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]);
3508
+			$msgr = str_replace('_a_box', '', $box);
3509
+			add_meta_box(
3510
+				'espresso_' . $msgr . '_settings',
3511
+				$label,
3512
+				function ($post, $metabox) {
3513
+					echo EEH_Template::display_template(
3514
+						$metabox["args"]["template_path"],
3515
+						$metabox["args"]["template_args"],
3516
+						true
3517
+					);
3518
+				},
3519
+				$this->_current_screen->id,
3520
+				'normal',
3521
+				'high',
3522
+				$callback_args
3523
+			);
3524
+		}
3525
+
3526
+		// register message type metaboxes
3527
+		$mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
3528
+		foreach ($mt_boxes as $box => $label) {
3529
+			$callback_args = array(
3530
+				'template_path' => $mt_template_path,
3531
+				'template_args' => $mt_template_args[ $box ],
3532
+			);
3533
+			$mt = str_replace('_i_box', '', $box);
3534
+			add_meta_box(
3535
+				'espresso_' . $mt . '_inactive_mts',
3536
+				$label,
3537
+				function ($post, $metabox) {
3538
+					echo EEH_Template::display_template(
3539
+						$metabox["args"]["template_path"],
3540
+						$metabox["args"]["template_args"],
3541
+						true
3542
+					);
3543
+				},
3544
+				$this->_current_screen->id,
3545
+				'side',
3546
+				'high',
3547
+				$callback_args
3548
+			);
3549
+		}
3550
+
3551
+		// register metabox for global messages settings but only when on the main site.  On single site installs this
3552
+		// will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
3553
+		if (is_main_site()) {
3554
+			add_meta_box(
3555
+				'espresso_global_message_settings',
3556
+				esc_html__('Global Message Settings', 'event_espresso'),
3557
+				array($this, 'global_messages_settings_metabox_content'),
3558
+				$this->_current_screen->id,
3559
+				'normal',
3560
+				'low',
3561
+				array()
3562
+			);
3563
+		}
3564
+	}
3565
+
3566
+
3567
+	/**
3568
+	 *  This generates the content for the global messages settings metabox.
3569
+	 *
3570
+	 * @return string
3571
+	 * @throws EE_Error
3572
+	 * @throws InvalidArgumentException
3573
+	 * @throws ReflectionException
3574
+	 * @throws InvalidDataTypeException
3575
+	 * @throws InvalidInterfaceException
3576
+	 */
3577
+	public function global_messages_settings_metabox_content()
3578
+	{
3579
+		$form = $this->_generate_global_settings_form();
3580
+		echo $form->form_open(
3581
+			$this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
3582
+			'POST'
3583
+		)
3584
+			 . $form->get_html()
3585
+			 . $form->form_close();
3586
+	}
3587
+
3588
+
3589
+	/**
3590
+	 * This generates and returns the form object for the global messages settings.
3591
+	 *
3592
+	 * @return EE_Form_Section_Proper
3593
+	 * @throws EE_Error
3594
+	 * @throws InvalidArgumentException
3595
+	 * @throws ReflectionException
3596
+	 * @throws InvalidDataTypeException
3597
+	 * @throws InvalidInterfaceException
3598
+	 */
3599
+	protected function _generate_global_settings_form()
3600
+	{
3601
+		EE_Registry::instance()->load_helper('HTML');
3602
+		/** @var EE_Network_Core_Config $network_config */
3603
+		$network_config = EE_Registry::instance()->NET_CFG->core;
3604
+
3605
+		return new EE_Form_Section_Proper(
3606
+			array(
3607
+				'name'            => 'global_messages_settings',
3608
+				'html_id'         => 'global_messages_settings',
3609
+				'html_class'      => 'form-table',
3610
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
3611
+				'subsections'     => apply_filters(
3612
+					'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
3613
+					array(
3614
+						'do_messages_on_same_request' => new EE_Select_Input(
3615
+							array(
3616
+								true  => esc_html__("On the same request", "event_espresso"),
3617
+								false => esc_html__("On a separate request", "event_espresso"),
3618
+							),
3619
+							array(
3620
+								'default'         => $network_config->do_messages_on_same_request,
3621
+								'html_label_text' => esc_html__(
3622
+									'Generate and send all messages:',
3623
+									'event_espresso'
3624
+								),
3625
+								'html_help_text'  => esc_html__(
3626
+									'By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
3627
+									'event_espresso'
3628
+								),
3629
+							)
3630
+						),
3631
+						'delete_threshold'            => new EE_Select_Input(
3632
+							array(
3633
+								0  => esc_html__('Forever', 'event_espresso'),
3634
+								3  => esc_html__('3 Months', 'event_espresso'),
3635
+								6  => esc_html__('6 Months', 'event_espresso'),
3636
+								9  => esc_html__('9 Months', 'event_espresso'),
3637
+								12 => esc_html__('12 Months', 'event_espresso'),
3638
+								24 => esc_html__('24 Months', 'event_espresso'),
3639
+								36 => esc_html__('36 Months', 'event_espresso'),
3640
+							),
3641
+							array(
3642
+								'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
3643
+								'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
3644
+								'html_help_text'  => esc_html__(
3645
+									'You can control how long a record of processed messages is kept via this option.',
3646
+									'event_espresso'
3647
+								),
3648
+							)
3649
+						),
3650
+						'update_settings'             => new EE_Submit_Input(
3651
+							array(
3652
+								'default'         => esc_html__('Update', 'event_espresso'),
3653
+								'html_label_text' => '&nbsp',
3654
+							)
3655
+						),
3656
+					)
3657
+				),
3658
+			)
3659
+		);
3660
+	}
3661
+
3662
+
3663
+	/**
3664
+	 * This handles updating the global settings set on the admin page.
3665
+	 *
3666
+	 * @throws EE_Error
3667
+	 * @throws InvalidDataTypeException
3668
+	 * @throws InvalidInterfaceException
3669
+	 * @throws InvalidArgumentException
3670
+	 * @throws ReflectionException
3671
+	 */
3672
+	protected function _update_global_settings()
3673
+	{
3674
+		/** @var EE_Network_Core_Config $network_config */
3675
+		$network_config = EE_Registry::instance()->NET_CFG->core;
3676
+		$messages_config = EE_Registry::instance()->CFG->messages;
3677
+		$form = $this->_generate_global_settings_form();
3678
+		if ($form->was_submitted()) {
3679
+			$form->receive_form_submission();
3680
+			if ($form->is_valid()) {
3681
+				$valid_data = $form->valid_data();
3682
+				foreach ($valid_data as $property => $value) {
3683
+					$setter = 'set_' . $property;
3684
+					if (method_exists($network_config, $setter)) {
3685
+						$network_config->{$setter}($value);
3686
+					} elseif (property_exists($network_config, $property)
3687
+						&& $network_config->{$property} !== $value
3688
+					) {
3689
+						$network_config->{$property} = $value;
3690
+					} elseif (property_exists($messages_config, $property)
3691
+						&& $messages_config->{$property} !== $value
3692
+					) {
3693
+						$messages_config->{$property} = $value;
3694
+					}
3695
+				}
3696
+				// only update if the form submission was valid!
3697
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
3698
+				EE_Registry::instance()->CFG->update_espresso_config();
3699
+				EE_Error::overwrite_success();
3700
+				EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
3701
+			}
3702
+		}
3703
+		$this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
3704
+	}
3705
+
3706
+
3707
+	/**
3708
+	 * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
3709
+	 *
3710
+	 * @param  array $tab_array This is an array of message type tab details used to generate the tabs
3711
+	 * @return string html formatted tabs
3712
+	 * @throws DomainException
3713
+	 */
3714
+	protected function _get_mt_tabs($tab_array)
3715
+	{
3716
+		$tab_array = (array) $tab_array;
3717
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
3718
+		$tabs = '';
3719
+
3720
+		foreach ($tab_array as $tab) {
3721
+			$tabs .= EEH_Template::display_template($template, $tab, true);
3722
+		}
3723
+
3724
+		return $tabs;
3725
+	}
3726
+
3727
+
3728
+	/**
3729
+	 * This prepares the content of the messenger meta box admin settings
3730
+	 *
3731
+	 * @param  EE_messenger $messenger The messenger we're setting up content for
3732
+	 * @return string html formatted content
3733
+	 * @throws DomainException
3734
+	 */
3735
+	protected function _get_messenger_box_content(EE_messenger $messenger)
3736
+	{
3737
+
3738
+		$fields = $messenger->get_admin_settings_fields();
3739
+		$settings_template_args['template_form_fields'] = '';
3740
+
3741
+		// is $messenger active?
3742
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
3743
+
3744
+
3745
+		if (! empty($fields)) {
3746
+			$existing_settings = $messenger->get_existing_admin_settings();
3747
+
3748
+			foreach ($fields as $fldname => $fldprops) {
3749
+				$field_id = $messenger->name . '-' . $fldname;
3750
+				$template_form_field[ $field_id ] = array(
3751
+					'name'       => 'messenger_settings[' . $field_id . ']',
3752
+					'label'      => $fldprops['label'],
3753
+					'input'      => $fldprops['field_type'],
3754
+					'type'       => $fldprops['value_type'],
3755
+					'required'   => $fldprops['required'],
3756
+					'validation' => $fldprops['validation'],
3757
+					'value'      => isset($existing_settings[ $field_id ])
3758
+						? $existing_settings[ $field_id ]
3759
+						: $fldprops['default'],
3760
+					'css_class'  => '',
3761
+					'format'     => $fldprops['format'],
3762
+				);
3763
+			}
3764
+
3765
+
3766
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
3767
+				? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
3768
+				: '';
3769
+		}
3770
+
3771
+		// we also need some hidden fields
3772
+		$settings_template_args['hidden_fields'] = array(
3773
+			'messenger_settings[messenger]' => array(
3774
+				'type'  => 'hidden',
3775
+				'value' => $messenger->name,
3776
+			),
3777
+			'type'                          => array(
3778
+				'type'  => 'hidden',
3779
+				'value' => 'messenger',
3780
+			),
3781
+		);
3782
+
3783
+		// make sure any active message types that are existing are included in the hidden fields
3784
+		if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
3785
+			foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
3786
+				$settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = array(
3787
+					'type'  => 'hidden',
3788
+					'value' => $mt,
3789
+				);
3790
+			}
3791
+		}
3792
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
3793
+			$settings_template_args['hidden_fields'],
3794
+			'array'
3795
+		);
3796
+		$active = $this->_message_resource_manager->is_messenger_active($messenger->name);
3797
+
3798
+		$settings_template_args['messenger'] = $messenger->name;
3799
+		$settings_template_args['description'] = $messenger->description;
3800
+		$settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
3801
+
3802
+
3803
+		$settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
3804
+			$messenger->name
3805
+		)
3806
+			? $settings_template_args['show_hide_edit_form']
3807
+			: ' hidden';
3808
+
3809
+		$settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
3810
+			? ' hidden'
3811
+			: $settings_template_args['show_hide_edit_form'];
3812
+
3813
+
3814
+		$settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
3815
+		$settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
3816
+		$settings_template_args['on_off_status'] = $active ? true : false;
3817
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
3818
+		$content = EEH_Template::display_template(
3819
+			$template,
3820
+			$settings_template_args,
3821
+			true
3822
+		);
3823
+
3824
+		return $content;
3825
+	}
3826
+
3827
+
3828
+	/**
3829
+	 * used by ajax on the messages settings page to activate|deactivate the messenger
3830
+	 *
3831
+	 * @throws DomainException
3832
+	 * @throws EE_Error
3833
+	 * @throws InvalidDataTypeException
3834
+	 * @throws InvalidInterfaceException
3835
+	 * @throws InvalidArgumentException
3836
+	 * @throws ReflectionException
3837
+	 */
3838
+	public function activate_messenger_toggle()
3839
+	{
3840
+		$success = true;
3841
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
3842
+		// let's check that we have required data
3843
+		if (! isset($this->_req_data['messenger'])) {
3844
+			EE_Error::add_error(
3845
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3846
+				__FILE__,
3847
+				__FUNCTION__,
3848
+				__LINE__
3849
+			);
3850
+			$success = false;
3851
+		}
3852
+
3853
+		// do a nonce check here since we're not arriving via a normal route
3854
+		$nonce = isset($this->_req_data['activate_nonce'])
3855
+			? sanitize_text_field($this->_req_data['activate_nonce'])
3856
+			: '';
3857
+		$nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
3858
+
3859
+		$this->_verify_nonce($nonce, $nonce_ref);
3860
+
3861
+
3862
+		if (! isset($this->_req_data['status'])) {
3863
+			EE_Error::add_error(
3864
+				esc_html__(
3865
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
3866
+					'event_espresso'
3867
+				),
3868
+				__FILE__,
3869
+				__FUNCTION__,
3870
+				__LINE__
3871
+			);
3872
+			$success = false;
3873
+		}
3874
+
3875
+		// do check to verify we have a valid status.
3876
+		$status = $this->_req_data['status'];
3877
+
3878
+		if ($status !== 'off' && $status !== 'on') {
3879
+			EE_Error::add_error(
3880
+				sprintf(
3881
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
3882
+					$this->_req_data['status']
3883
+				),
3884
+				__FILE__,
3885
+				__FUNCTION__,
3886
+				__LINE__
3887
+			);
3888
+			$success = false;
3889
+		}
3890
+
3891
+		if ($success) {
3892
+			// made it here?  Stop dawdling then!!
3893
+			$success = $status === 'off'
3894
+				? $this->_deactivate_messenger($this->_req_data['messenger'])
3895
+				: $this->_activate_messenger($this->_req_data['messenger']);
3896
+		}
3897
+
3898
+		$this->_template_args['success'] = $success;
3899
+
3900
+		// no special instructions so let's just do the json return (which should automatically do all the special stuff).
3901
+		$this->_return_json();
3902
+	}
3903
+
3904
+
3905
+	/**
3906
+	 * used by ajax from the messages settings page to activate|deactivate a message type
3907
+	 *
3908
+	 * @throws DomainException
3909
+	 * @throws EE_Error
3910
+	 * @throws ReflectionException
3911
+	 * @throws InvalidDataTypeException
3912
+	 * @throws InvalidInterfaceException
3913
+	 * @throws InvalidArgumentException
3914
+	 */
3915
+	public function activate_mt_toggle()
3916
+	{
3917
+		$success = true;
3918
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
3919
+
3920
+		// let's make sure we have the necessary data
3921
+		if (! isset($this->_req_data['message_type'])) {
3922
+			EE_Error::add_error(
3923
+				esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
3924
+				__FILE__,
3925
+				__FUNCTION__,
3926
+				__LINE__
3927
+			);
3928
+			$success = false;
3929
+		}
3930
+
3931
+		if (! isset($this->_req_data['messenger'])) {
3932
+			EE_Error::add_error(
3933
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
3934
+				__FILE__,
3935
+				__FUNCTION__,
3936
+				__LINE__
3937
+			);
3938
+			$success = false;
3939
+		}
3940
+
3941
+		if (! isset($this->_req_data['status'])) {
3942
+			EE_Error::add_error(
3943
+				esc_html__(
3944
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
3945
+					'event_espresso'
3946
+				),
3947
+				__FILE__,
3948
+				__FUNCTION__,
3949
+				__LINE__
3950
+			);
3951
+			$success = false;
3952
+		}
3953
+
3954
+
3955
+		// do check to verify we have a valid status.
3956
+		$status = $this->_req_data['status'];
3957
+
3958
+		if ($status !== 'activate' && $status !== 'deactivate') {
3959
+			EE_Error::add_error(
3960
+				sprintf(
3961
+					esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
3962
+					$this->_req_data['status']
3963
+				),
3964
+				__FILE__,
3965
+				__FUNCTION__,
3966
+				__LINE__
3967
+			);
3968
+			$success = false;
3969
+		}
3970
+
3971
+
3972
+		// do a nonce check here since we're not arriving via a normal route
3973
+		$nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
3974
+		$nonce_ref = $this->_req_data['message_type'] . '_nonce';
3975
+
3976
+		$this->_verify_nonce($nonce, $nonce_ref);
3977
+
3978
+		if ($success) {
3979
+			// made it here? um, what are you waiting for then?
3980
+			$success = $status === 'deactivate'
3981
+				? $this->_deactivate_message_type_for_messenger(
3982
+					$this->_req_data['messenger'],
3983
+					$this->_req_data['message_type']
3984
+				)
3985
+				: $this->_activate_message_type_for_messenger(
3986
+					$this->_req_data['messenger'],
3987
+					$this->_req_data['message_type']
3988
+				);
3989
+		}
3990
+
3991
+		$this->_template_args['success'] = $success;
3992
+		$this->_return_json();
3993
+	}
3994
+
3995
+
3996
+	/**
3997
+	 * Takes care of processing activating a messenger and preparing the appropriate response.
3998
+	 *
3999
+	 * @param string $messenger_name The name of the messenger being activated
4000
+	 * @return bool
4001
+	 * @throws DomainException
4002
+	 * @throws EE_Error
4003
+	 * @throws InvalidArgumentException
4004
+	 * @throws ReflectionException
4005
+	 * @throws InvalidDataTypeException
4006
+	 * @throws InvalidInterfaceException
4007
+	 */
4008
+	protected function _activate_messenger($messenger_name)
4009
+	{
4010
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4011
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4012
+		$message_types_to_activate = $active_messenger instanceof EE_Messenger
4013
+			? $active_messenger->get_default_message_types()
4014
+			: array();
4015
+
4016
+		// ensure is active
4017
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
4018
+
4019
+		// set response_data for reload
4020
+		foreach ($message_types_to_activate as $message_type_name) {
4021
+			/** @var EE_message_type $message_type */
4022
+			$message_type = $this->_message_resource_manager->get_message_type($message_type_name);
4023
+			if ($this->_message_resource_manager->is_message_type_active_for_messenger(
4024
+				$messenger_name,
4025
+				$message_type_name
4026
+			)
4027
+				&& $message_type instanceof EE_message_type
4028
+			) {
4029
+				$this->_template_args['data']['active_mts'][] = $message_type_name;
4030
+				if ($message_type->get_admin_settings_fields()) {
4031
+					$this->_template_args['data']['mt_reload'][] = $message_type_name;
4032
+				}
4033
+			}
4034
+		}
4035
+
4036
+		// add success message for activating messenger
4037
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
4038
+	}
4039
+
4040
+
4041
+	/**
4042
+	 * Takes care of processing deactivating a messenger and preparing the appropriate response.
4043
+	 *
4044
+	 * @param string $messenger_name The name of the messenger being activated
4045
+	 * @return bool
4046
+	 * @throws DomainException
4047
+	 * @throws EE_Error
4048
+	 * @throws InvalidArgumentException
4049
+	 * @throws ReflectionException
4050
+	 * @throws InvalidDataTypeException
4051
+	 * @throws InvalidInterfaceException
4052
+	 */
4053
+	protected function _deactivate_messenger($messenger_name)
4054
+	{
4055
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4056
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4057
+		$this->_message_resource_manager->deactivate_messenger($messenger_name);
4058
+
4059
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
4060
+	}
4061
+
4062
+
4063
+	/**
4064
+	 * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
4065
+	 *
4066
+	 * @param string $messenger_name    The name of the messenger the message type is being activated for.
4067
+	 * @param string $message_type_name The name of the message type being activated for the messenger
4068
+	 * @return bool
4069
+	 * @throws DomainException
4070
+	 * @throws EE_Error
4071
+	 * @throws InvalidArgumentException
4072
+	 * @throws ReflectionException
4073
+	 * @throws InvalidDataTypeException
4074
+	 * @throws InvalidInterfaceException
4075
+	 */
4076
+	protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
4077
+	{
4078
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4079
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4080
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
4081
+		$message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
4082
+
4083
+		// ensure is active
4084
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
4085
+
4086
+		// set response for load
4087
+		if ($this->_message_resource_manager->is_message_type_active_for_messenger(
4088
+			$messenger_name,
4089
+			$message_type_name
4090
+		)
4091
+		) {
4092
+			$this->_template_args['data']['active_mts'][] = $message_type_name;
4093
+			if ($message_type_to_activate->get_admin_settings_fields()) {
4094
+				$this->_template_args['data']['mt_reload'][] = $message_type_name;
4095
+			}
4096
+		}
4097
+
4098
+		return $this->_setup_response_message_for_activating_messenger_with_message_types(
4099
+			$active_messenger,
4100
+			$message_type_to_activate
4101
+		);
4102
+	}
4103
+
4104
+
4105
+	/**
4106
+	 * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
4107
+	 *
4108
+	 * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
4109
+	 * @param string $message_type_name The name of the message type being deactivated for the messenger
4110
+	 * @return bool
4111
+	 * @throws DomainException
4112
+	 * @throws EE_Error
4113
+	 * @throws InvalidArgumentException
4114
+	 * @throws ReflectionException
4115
+	 * @throws InvalidDataTypeException
4116
+	 * @throws InvalidInterfaceException
4117
+	 */
4118
+	protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
4119
+	{
4120
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
4121
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
4122
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
4123
+		$message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
4124
+		$this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
4125
+
4126
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
4127
+			$active_messenger,
4128
+			$message_type_to_deactivate
4129
+		);
4130
+	}
4131
+
4132
+
4133
+	/**
4134
+	 * This just initializes the defaults for activating messenger and message type responses.
4135
+	 */
4136
+	protected function _prep_default_response_for_messenger_or_message_type_toggle()
4137
+	{
4138
+		$this->_template_args['data']['active_mts'] = array();
4139
+		$this->_template_args['data']['mt_reload'] = array();
4140
+	}
4141
+
4142
+
4143
+	/**
4144
+	 * Setup appropriate response for activating a messenger and/or message types
4145
+	 *
4146
+	 * @param EE_messenger         $messenger
4147
+	 * @param EE_message_type|null $message_type
4148
+	 * @return bool
4149
+	 * @throws DomainException
4150
+	 * @throws EE_Error
4151
+	 * @throws InvalidArgumentException
4152
+	 * @throws ReflectionException
4153
+	 * @throws InvalidDataTypeException
4154
+	 * @throws InvalidInterfaceException
4155
+	 */
4156
+	protected function _setup_response_message_for_activating_messenger_with_message_types(
4157
+		$messenger,
4158
+		EE_Message_Type $message_type = null
4159
+	) {
4160
+		// if $messenger isn't a valid messenger object then get out.
4161
+		if (! $messenger instanceof EE_Messenger) {
4162
+			EE_Error::add_error(
4163
+				esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
4164
+				__FILE__,
4165
+				__FUNCTION__,
4166
+				__LINE__
4167
+			);
4168
+
4169
+			return false;
4170
+		}
4171
+		// activated
4172
+		if ($this->_template_args['data']['active_mts']) {
4173
+			EE_Error::overwrite_success();
4174
+			// activated a message type with the messenger
4175
+			if ($message_type instanceof EE_message_type) {
4176
+				EE_Error::add_success(
4177
+					sprintf(
4178
+						esc_html__(
4179
+							'%s message type has been successfully activated with the %s messenger',
4180
+							'event_espresso'
4181
+						),
4182
+						ucwords($message_type->label['singular']),
4183
+						ucwords($messenger->label['singular'])
4184
+					)
4185
+				);
4186
+
4187
+				// if message type was invoice then let's make sure we activate the invoice payment method.
4188
+				if ($message_type->name === 'invoice') {
4189
+					EE_Registry::instance()->load_lib('Payment_Method_Manager');
4190
+					$pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
4191
+					if ($pm instanceof EE_Payment_Method) {
4192
+						EE_Error::add_attention(
4193
+							esc_html__(
4194
+								'Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
4195
+								'event_espresso'
4196
+							)
4197
+						);
4198
+					}
4199
+				}
4200
+				// just toggles the entire messenger
4201
+			} else {
4202
+				EE_Error::add_success(
4203
+					sprintf(
4204
+						esc_html__('%s messenger has been successfully activated', 'event_espresso'),
4205
+						ucwords($messenger->label['singular'])
4206
+					)
4207
+				);
4208
+			}
4209
+
4210
+			return true;
4211
+
4212
+			// possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
4213
+			// message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
4214
+			// in which case we just give a success message for the messenger being successfully activated.
4215
+		} else {
4216
+			if (! $messenger->get_default_message_types()) {
4217
+				// messenger doesn't have any default message types so still a success.
4218
+				EE_Error::add_success(
4219
+					sprintf(
4220
+						esc_html__('%s messenger was successfully activated.', 'event_espresso'),
4221
+						ucwords($messenger->label['singular'])
4222
+					)
4223
+				);
4224
+
4225
+				return true;
4226
+			} else {
4227
+				EE_Error::add_error(
4228
+					$message_type instanceof EE_message_type
4229
+						? sprintf(
4230
+							esc_html__(
4231
+								'%s message type was not successfully activated with the %s messenger',
4232
+								'event_espresso'
4233
+							),
4234
+							ucwords($message_type->label['singular']),
4235
+							ucwords($messenger->label['singular'])
4236
+						)
4237
+						: sprintf(
4238
+							esc_html__('%s messenger was not successfully activated', 'event_espresso'),
4239
+							ucwords($messenger->label['singular'])
4240
+						),
4241
+					__FILE__,
4242
+					__FUNCTION__,
4243
+					__LINE__
4244
+				);
4245
+
4246
+				return false;
4247
+			}
4248
+		}
4249
+	}
4250
+
4251
+
4252
+	/**
4253
+	 * This sets up the appropriate response for deactivating a messenger and/or message type.
4254
+	 *
4255
+	 * @param EE_messenger         $messenger
4256
+	 * @param EE_message_type|null $message_type
4257
+	 * @return bool
4258
+	 * @throws DomainException
4259
+	 * @throws EE_Error
4260
+	 * @throws InvalidArgumentException
4261
+	 * @throws ReflectionException
4262
+	 * @throws InvalidDataTypeException
4263
+	 * @throws InvalidInterfaceException
4264
+	 */
4265
+	protected function _setup_response_message_for_deactivating_messenger_with_message_types(
4266
+		$messenger,
4267
+		EE_message_type $message_type = null
4268
+	) {
4269
+		EE_Error::overwrite_success();
4270
+
4271
+		// if $messenger isn't a valid messenger object then get out.
4272
+		if (! $messenger instanceof EE_Messenger) {
4273
+			EE_Error::add_error(
4274
+				esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
4275
+				__FILE__,
4276
+				__FUNCTION__,
4277
+				__LINE__
4278
+			);
4279
+
4280
+			return false;
4281
+		}
4282
+
4283
+		if ($message_type instanceof EE_message_type) {
4284
+			$message_type_name = $message_type->name;
4285
+			EE_Error::add_success(
4286
+				sprintf(
4287
+					esc_html__(
4288
+						'%s message type has been successfully deactivated for the %s messenger.',
4289
+						'event_espresso'
4290
+					),
4291
+					ucwords($message_type->label['singular']),
4292
+					ucwords($messenger->label['singular'])
4293
+				)
4294
+			);
4295
+		} else {
4296
+			$message_type_name = '';
4297
+			EE_Error::add_success(
4298
+				sprintf(
4299
+					esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
4300
+					ucwords($messenger->label['singular'])
4301
+				)
4302
+			);
4303
+		}
4304
+
4305
+		// if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
4306
+		if ($messenger->name === 'html' || $message_type_name === 'invoice') {
4307
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
4308
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
4309
+			if ($count_updated > 0) {
4310
+				$msg = $message_type_name === 'invoice'
4311
+					? esc_html__(
4312
+						'Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
4313
+						'event_espresso'
4314
+					)
4315
+					: esc_html__(
4316
+						'Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
4317
+						'event_espresso'
4318
+					);
4319
+				EE_Error::add_attention($msg);
4320
+			}
4321
+		}
4322
+
4323
+		return true;
4324
+	}
4325
+
4326
+
4327
+	/**
4328
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
4329
+	 *
4330
+	 * @throws DomainException
4331
+	 */
4332
+	public function update_mt_form()
4333
+	{
4334
+		if (! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
4335
+			EE_Error::add_error(
4336
+				esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
4337
+				__FILE__,
4338
+				__FUNCTION__,
4339
+				__LINE__
4340
+			);
4341
+			$this->_return_json();
4342
+		}
4343
+
4344
+		$message_types = $this->get_installed_message_types();
4345
+
4346
+		$message_type = $message_types[ $this->_req_data['message_type'] ];
4347
+		$messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
4348
+
4349
+		$content = $this->_message_type_settings_content(
4350
+			$message_type,
4351
+			$messenger,
4352
+			true
4353
+		);
4354
+		$this->_template_args['success'] = true;
4355
+		$this->_template_args['content'] = $content;
4356
+		$this->_return_json();
4357
+	}
4358
+
4359
+
4360
+	/**
4361
+	 * this handles saving the settings for a messenger or message type
4362
+	 *
4363
+	 */
4364
+	public function save_settings()
4365
+	{
4366
+		if (! isset($this->_req_data['type'])) {
4367
+			EE_Error::add_error(
4368
+				esc_html__(
4369
+					'Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
4370
+					'event_espresso'
4371
+				),
4372
+				__FILE__,
4373
+				__FUNCTION__,
4374
+				__LINE__
4375
+			);
4376
+			$this->_template_args['error'] = true;
4377
+			$this->_return_json();
4378
+		}
4379
+
4380
+
4381
+		if ($this->_req_data['type'] === 'messenger') {
4382
+			// this should be an array.
4383
+			$settings = $this->_req_data['messenger_settings'];
4384
+			$messenger = $settings['messenger'];
4385
+			// let's setup the settings data
4386
+			foreach ($settings as $key => $value) {
4387
+				switch ($key) {
4388
+					case 'messenger':
4389
+						unset($settings['messenger']);
4390
+						break;
4391
+					case 'message_types':
4392
+						unset($settings['message_types']);
4393
+						break;
4394
+					default:
4395
+						$settings[ $key ] = $value;
4396
+						break;
4397
+				}
4398
+			}
4399
+			$this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
4400
+		} elseif ($this->_req_data['type'] === 'message_type') {
4401
+			$settings = $this->_req_data['message_type_settings'];
4402
+			$messenger = $settings['messenger'];
4403
+			$message_type = $settings['message_type'];
4404
+
4405
+			foreach ($settings as $key => $value) {
4406
+				switch ($key) {
4407
+					case 'messenger':
4408
+						unset($settings['messenger']);
4409
+						break;
4410
+					case 'message_type':
4411
+						unset($settings['message_type']);
4412
+						break;
4413
+					default:
4414
+						$settings[ $key ] = $value;
4415
+						break;
4416
+				}
4417
+			}
4418
+
4419
+			$this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
4420
+		}
4421
+
4422
+		// okay we should have the data all setup.  Now we just update!
4423
+		$success = $this->_message_resource_manager->update_active_messengers_option();
4424
+
4425
+		if ($success) {
4426
+			EE_Error::add_success(__('Settings updated', 'event_espresso'));
4427
+		} else {
4428
+			EE_Error::add_error(
4429
+				esc_html__(
4430
+					'Settings did not get updated',
4431
+					'event_espresso'
4432
+				),
4433
+				__FILE__,
4434
+				__FUNCTION__,
4435
+				__LINE__
4436
+			);
4437
+		}
4438
+
4439
+		$this->_template_args['success'] = $success;
4440
+		$this->_return_json();
4441
+	}
4442
+
4443
+
4444
+
4445
+
4446
+	/**  EE MESSAGE PROCESSING ACTIONS **/
4447
+
4448
+
4449
+	/**
4450
+	 * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
4451
+	 * However, this does not send immediately, it just queues for sending.
4452
+	 *
4453
+	 * @since 4.9.0
4454
+	 * @throws EE_Error
4455
+	 * @throws InvalidDataTypeException
4456
+	 * @throws InvalidInterfaceException
4457
+	 * @throws InvalidArgumentException
4458
+	 * @throws ReflectionException
4459
+	 */
4460
+	protected function _generate_now()
4461
+	{
4462
+		EED_Messages::generate_now($this->_get_msg_ids_from_request());
4463
+		$this->_redirect_after_action(false, '', '', array(), true);
4464
+	}
4465
+
4466
+
4467
+	/**
4468
+	 * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
4469
+	 * are EEM_Message::status_resend or EEM_Message::status_idle
4470
+	 *
4471
+	 * @since 4.9.0
4472
+	 * @throws EE_Error
4473
+	 * @throws InvalidDataTypeException
4474
+	 * @throws InvalidInterfaceException
4475
+	 * @throws InvalidArgumentException
4476
+	 * @throws ReflectionException
4477
+	 */
4478
+	protected function _generate_and_send_now()
4479
+	{
4480
+		EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
4481
+		$this->_redirect_after_action(false, '', '', array(), true);
4482
+	}
4483
+
4484
+
4485
+	/**
4486
+	 * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
4487
+	 *
4488
+	 * @since 4.9.0
4489
+	 * @throws EE_Error
4490
+	 * @throws InvalidDataTypeException
4491
+	 * @throws InvalidInterfaceException
4492
+	 * @throws InvalidArgumentException
4493
+	 * @throws ReflectionException
4494
+	 */
4495
+	protected function _queue_for_resending()
4496
+	{
4497
+		EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
4498
+		$this->_redirect_after_action(false, '', '', array(), true);
4499
+	}
4500
+
4501
+
4502
+	/**
4503
+	 *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
4504
+	 *
4505
+	 * @since 4.9.0
4506
+	 * @throws EE_Error
4507
+	 * @throws InvalidDataTypeException
4508
+	 * @throws InvalidInterfaceException
4509
+	 * @throws InvalidArgumentException
4510
+	 * @throws ReflectionException
4511
+	 */
4512
+	protected function _send_now()
4513
+	{
4514
+		EED_Messages::send_now($this->_get_msg_ids_from_request());
4515
+		$this->_redirect_after_action(false, '', '', array(), true);
4516
+	}
4517
+
4518
+
4519
+	/**
4520
+	 * Deletes EE_messages for IDs in the request.
4521
+	 *
4522
+	 * @since 4.9.0
4523
+	 * @throws EE_Error
4524
+	 * @throws InvalidDataTypeException
4525
+	 * @throws InvalidInterfaceException
4526
+	 * @throws InvalidArgumentException
4527
+	 */
4528
+	protected function _delete_ee_messages()
4529
+	{
4530
+		$msg_ids = $this->_get_msg_ids_from_request();
4531
+		$deleted_count = 0;
4532
+		foreach ($msg_ids as $msg_id) {
4533
+			if (EEM_Message::instance()->delete_by_ID($msg_id)) {
4534
+				$deleted_count++;
4535
+			}
4536
+		}
4537
+		if ($deleted_count) {
4538
+			EE_Error::add_success(
4539
+				esc_html(
4540
+					_n(
4541
+						'Message successfully deleted',
4542
+						'Messages successfully deleted',
4543
+						$deleted_count,
4544
+						'event_espresso'
4545
+					)
4546
+				)
4547
+			);
4548
+			$this->_redirect_after_action(
4549
+				false,
4550
+				'',
4551
+				'',
4552
+				array(),
4553
+				true
4554
+			);
4555
+		} else {
4556
+			EE_Error::add_error(
4557
+				_n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
4558
+				__FILE__,
4559
+				__FUNCTION__,
4560
+				__LINE__
4561
+			);
4562
+			$this->_redirect_after_action(false, '', '', array(), true);
4563
+		}
4564
+	}
4565
+
4566
+
4567
+	/**
4568
+	 *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
4569
+	 *
4570
+	 * @since 4.9.0
4571
+	 * @return array
4572
+	 */
4573
+	protected function _get_msg_ids_from_request()
4574
+	{
4575
+		if (! isset($this->_req_data['MSG_ID'])) {
4576
+			return array();
4577
+		}
4578
+
4579
+		return is_array($this->_req_data['MSG_ID'])
4580
+			? array_keys($this->_req_data['MSG_ID'])
4581
+			: array($this->_req_data['MSG_ID']);
4582
+	}
4583 4583
 }
Please login to merge, or discard this patch.